From 20d5adcdd5aa8865845000b28ff11c1a2f1d60d4 Mon Sep 17 00:00:00 2001 From: William Cheng Date: Sun, 10 Feb 2019 08:25:20 +0800 Subject: [PATCH] [PHP] remove deprecated options (#2083) * php remove deprecated options * update php doc * clean up composerVendorName in code, templates * update samples --- docs/generators/php.md | 2 -- .../codegen/languages/AbstractPhpCodegen.java | 27 ------------------- .../codegen/languages/PhpClientCodegen.java | 27 ------------------- .../main/resources/lumen/composer.mustache | 2 +- .../resources/php-laravel/composer.mustache | 2 +- .../resources/php-symfony/README.mustache | 2 +- .../resources/php-symfony/composer.mustache | 2 +- .../src/main/resources/php/README.mustache | 4 +-- .../src/main/resources/php/composer.mustache | 5 ++-- .../options/PhpClientOptionsProvider.java | 4 --- .../codegen/php/PhpClientOptionsTest.java | 4 --- .../php/OpenAPIClient-php/composer.json | 3 ++- .../php/OpenAPIClient-php/composer.json | 3 ++- .../php-symfony/SymfonyBundle-php/README.md | 2 +- .../SymfonyBundle-php/composer.json | 2 +- 15 files changed, 15 insertions(+), 76 deletions(-) diff --git a/docs/generators/php.md b/docs/generators/php.md index 0172100d360..860334e1d3e 100644 --- a/docs/generators/php.md +++ b/docs/generators/php.md @@ -20,6 +20,4 @@ sidebar_label: php |gitUserId|Git user ID, e.g. openapitools.| |null| |gitRepoId|Git repo ID, e.g. openapi-generator.| |null| |artifactVersion|The version to use in the composer package version field. e.g. 1.2.3| |null| -|composerVendorName|The vendor name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. yaypets. IMPORTANT NOTE (2016/03): composerVendorName will be deprecated and replaced by gitUserId in the next openapi-generator release| |null| -|composerProjectName|The project name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. petstore-client. IMPORTANT NOTE (2016/03): composerProjectName will be deprecated and replaced by gitRepoId in the next openapi-generator release| |null| |hideGenerationTimestamp|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |true| diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractPhpCodegen.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractPhpCodegen.java index 79f0256fdfe..bd56bcc9143 100644 --- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractPhpCodegen.java +++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractPhpCodegen.java @@ -40,11 +40,6 @@ public abstract class AbstractPhpCodegen extends DefaultCodegen implements Codeg public static final String VARIABLE_NAMING_CONVENTION = "variableNamingConvention"; public static final String PACKAGE_NAME = "packageName"; public static final String SRC_BASE_PATH = "srcBasePath"; - // composerVendorName/composerProjectName has be replaced by gitUserId/gitRepoId. prepare to remove these. - // public static final String COMPOSER_VENDOR_NAME = "composerVendorName"; - // public static final String COMPOSER_PROJECT_NAME = "composerProjectName"; - // protected String composerVendorName = null; - // protected String composerProjectName = null; protected String invokerPackage = "php"; protected String packageName = "php-base"; protected String artifactVersion = null; @@ -137,9 +132,7 @@ public abstract class AbstractPhpCodegen extends DefaultCodegen implements Codeg cliOptions.add(new CliOption(CodegenConstants.INVOKER_PACKAGE, "The main namespace to use for all classes. e.g. Yay\\Pets")); cliOptions.add(new CliOption(PACKAGE_NAME, "The main package name for classes. e.g. GeneratedPetstore")); cliOptions.add(new CliOption(SRC_BASE_PATH, "The directory to serve as source root.")); - // cliOptions.add(new CliOption(COMPOSER_VENDOR_NAME, "The vendor name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. yaypets. IMPORTANT NOTE (2016/03): composerVendorName will be deprecated and replaced by gitUserId in the next openapi-generator release")); cliOptions.add(new CliOption(CodegenConstants.GIT_USER_ID, CodegenConstants.GIT_USER_ID_DESC)); - // cliOptions.add(new CliOption(COMPOSER_PROJECT_NAME, "The project name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. petstore-client. IMPORTANT NOTE (2016/03): composerProjectName will be deprecated and replaced by gitRepoId in the next openapi-generator release")); cliOptions.add(new CliOption(CodegenConstants.GIT_REPO_ID, CodegenConstants.GIT_REPO_ID_DESC)); cliOptions.add(new CliOption(CodegenConstants.ARTIFACT_VERSION, "The version to use in the composer package version field. e.g. 1.2.3")); } @@ -187,24 +180,12 @@ public abstract class AbstractPhpCodegen extends DefaultCodegen implements Codeg } additionalProperties.put(CodegenConstants.API_PACKAGE, apiPackage); - // if (additionalProperties.containsKey(COMPOSER_PROJECT_NAME)) { - // this.setComposerProjectName((String) additionalProperties.get(COMPOSER_PROJECT_NAME)); - // } else { - // additionalProperties.put(COMPOSER_PROJECT_NAME, composerProjectName); - // } - if (additionalProperties.containsKey(CodegenConstants.GIT_USER_ID)) { this.setGitUserId((String) additionalProperties.get(CodegenConstants.GIT_USER_ID)); } else { additionalProperties.put(CodegenConstants.GIT_USER_ID, gitUserId); } - // if (additionalProperties.containsKey(COMPOSER_VENDOR_NAME)) { - // this.setComposerVendorName((String) additionalProperties.get(COMPOSER_VENDOR_NAME)); - // } else { - // additionalProperties.put(COMPOSER_VENDOR_NAME, composerVendorName); - // } - if (additionalProperties.containsKey(CodegenConstants.GIT_REPO_ID)) { this.setGitRepoId((String) additionalProperties.get(CodegenConstants.GIT_REPO_ID)); } else { @@ -409,14 +390,6 @@ public abstract class AbstractPhpCodegen extends DefaultCodegen implements Codeg this.variableNamingConvention = variableNamingConvention; } - // public void setComposerVendorName(String composerVendorName) { - // this.composerVendorName = composerVendorName; - // } - - // public void setComposerProjectName(String composerProjectName) { - // this.composerProjectName = composerProjectName; - // } - @Override public String toVarName(String name) { // sanitize name diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PhpClientCodegen.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PhpClientCodegen.java index 71b1c7b3186..d871b1cf398 100644 --- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PhpClientCodegen.java +++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PhpClientCodegen.java @@ -34,11 +34,6 @@ public class PhpClientCodegen extends AbstractPhpCodegen { @SuppressWarnings("hiding") private static final Logger LOGGER = LoggerFactory.getLogger(PhpClientCodegen.class); - public static final String COMPOSER_VENDOR_NAME = "composerVendorName"; - public static final String COMPOSER_PROJECT_NAME = "composerProjectName"; - protected String composerVendorName = null; - protected String composerProjectName = null; - public PhpClientCodegen() { super(); @@ -64,8 +59,6 @@ public class PhpClientCodegen extends AbstractPhpCodegen { String primitives = "'" + StringUtils.join(sortedLanguageSpecificPrimitives, "', '") + "'"; additionalProperties.put("primitives", primitives); - cliOptions.add(new CliOption(COMPOSER_VENDOR_NAME, "The vendor name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. yaypets. IMPORTANT NOTE (2016/03): composerVendorName will be deprecated and replaced by gitUserId in the next openapi-generator release")); - cliOptions.add(new CliOption(COMPOSER_PROJECT_NAME, "The project name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. petstore-client. IMPORTANT NOTE (2016/03): composerProjectName will be deprecated and replaced by gitRepoId in the next openapi-generator release")); cliOptions.add(new CliOption(CodegenConstants.HIDE_GENERATION_TIMESTAMP, CodegenConstants.ALLOW_UNICODE_IDENTIFIERS_DESC) .defaultValue(Boolean.TRUE.toString())); } @@ -89,18 +82,6 @@ public class PhpClientCodegen extends AbstractPhpCodegen { public void processOpts() { super.processOpts(); - if (additionalProperties.containsKey(COMPOSER_PROJECT_NAME)) { - this.setComposerProjectName((String) additionalProperties.get(COMPOSER_PROJECT_NAME)); - } else { - additionalProperties.put(COMPOSER_PROJECT_NAME, composerProjectName); - } - - if (additionalProperties.containsKey(COMPOSER_VENDOR_NAME)) { - this.setComposerVendorName((String) additionalProperties.get(COMPOSER_VENDOR_NAME)); - } else { - additionalProperties.put(COMPOSER_VENDOR_NAME, composerVendorName); - } - supportingFiles.add(new SupportingFile("ApiException.mustache", toSrcPath(invokerPackage, srcBasePath), "ApiException.php")); supportingFiles.add(new SupportingFile("Configuration.mustache", toSrcPath(invokerPackage, srcBasePath), "Configuration.php")); supportingFiles.add(new SupportingFile("ObjectSerializer.mustache", toSrcPath(invokerPackage, srcBasePath), "ObjectSerializer.php")); @@ -113,12 +94,4 @@ public class PhpClientCodegen extends AbstractPhpCodegen { supportingFiles.add(new SupportingFile(".php_cs", "", ".php_cs")); supportingFiles.add(new SupportingFile("git_push.sh.mustache", "", "git_push.sh")); } - - public void setComposerVendorName(String composerVendorName) { - this.composerVendorName = composerVendorName; - } - - public void setComposerProjectName(String composerProjectName) { - this.composerProjectName = composerProjectName; - } } diff --git a/modules/openapi-generator/src/main/resources/lumen/composer.mustache b/modules/openapi-generator/src/main/resources/lumen/composer.mustache index e1fb93758ae..a9e84359a31 100644 --- a/modules/openapi-generator/src/main/resources/lumen/composer.mustache +++ b/modules/openapi-generator/src/main/resources/lumen/composer.mustache @@ -1,5 +1,5 @@ { - "name": "{{#composerVendorName}}{{.}}{{/composerVendorName}}{{^composerVendorName}}{{gitUserId}}{{/composerVendorName}}/{{#composerProjectName}}{{.}}{{/composerProjectName}}{{^composerProjectName}}{{gitRepoId}}{{/composerProjectName}}", + "name": "{{gitUserId}}/{{gitRepoId}}", {{#artifactVersion}} "version": "{{artifactVersion}}", {{/artifactVersion}} diff --git a/modules/openapi-generator/src/main/resources/php-laravel/composer.mustache b/modules/openapi-generator/src/main/resources/php-laravel/composer.mustache index 9844a2f875b..cdffe692e0b 100644 --- a/modules/openapi-generator/src/main/resources/php-laravel/composer.mustache +++ b/modules/openapi-generator/src/main/resources/php-laravel/composer.mustache @@ -1,5 +1,5 @@ { - "name": "{{#composerVendorName}}{{.}}{{/composerVendorName}}{{^composerVendorName}}{{gitUserId}}{{/composerVendorName}}/{{#composerProjectName}}{{.}}{{/composerProjectName}}{{^composerProjectName}}{{gitRepoId}}{{/composerProjectName}}", + "name": "{{gitUserId}}/{{gitRepoId}}", "description": "{{description}}.", "keywords": ["framework", "laravel"], {{#artifactVersion}} diff --git a/modules/openapi-generator/src/main/resources/php-symfony/README.mustache b/modules/openapi-generator/src/main/resources/php-symfony/README.mustache index 139f62cab74..f107aa4b30c 100644 --- a/modules/openapi-generator/src/main/resources/php-symfony/README.mustache +++ b/modules/openapi-generator/src/main/resources/php-symfony/README.mustache @@ -37,7 +37,7 @@ To install the dependencies via [Composer](http://getcomposer.org/), add the fol Then run: ``` -composer require {{#composerVendorName}}{{.}}{{/composerVendorName}}{{^composerVendorName}}{{gitUserId}}{{/composerVendorName}}/{{#composerProjectName}}{{.}}{{/composerProjectName}}{{^composerProjectName}}{{gitRepoId}}{{/composerProjectName}}:dev-master +composer require {{gitUserId}}/{{gitRepoId}}:dev-master ``` to add the generated openapi bundle as a dependency. diff --git a/modules/openapi-generator/src/main/resources/php-symfony/composer.mustache b/modules/openapi-generator/src/main/resources/php-symfony/composer.mustache index 3c623d307b5..0683e3b1b06 100644 --- a/modules/openapi-generator/src/main/resources/php-symfony/composer.mustache +++ b/modules/openapi-generator/src/main/resources/php-symfony/composer.mustache @@ -1,5 +1,5 @@ { - "name": "{{#composerVendorName}}{{.}}{{/composerVendorName}}{{^composerVendorName}}{{gitUserId}}{{/composerVendorName}}/{{#composerProjectName}}{{.}}{{/composerProjectName}}{{^composerProjectName}}{{gitRepoId}}{{/composerProjectName}}", + "name": "{{gitUserId}}/{{gitRepoId}}", {{#artifactVersion}} "version": "{{artifactVersion}}", {{/artifactVersion}} diff --git a/modules/openapi-generator/src/main/resources/php/README.mustache b/modules/openapi-generator/src/main/resources/php/README.mustache index 573e02aa262..0d800d844de 100644 --- a/modules/openapi-generator/src/main/resources/php/README.mustache +++ b/modules/openapi-generator/src/main/resources/php/README.mustache @@ -31,11 +31,11 @@ To install the bindings via [Composer](http://getcomposer.org/), add the followi "repositories": [ { "type": "vcs", - "url": "https://github.com/{{#composerVendorName}}{{.}}{{/composerVendorName}}{{^composerVendorName}}{{gitUserId}}{{/composerVendorName}}/{{#composerProjectName}}{{.}}{{/composerProjectName}}{{^composerProjectName}}{{gitRepoId}}{{/composerProjectName}}.git" + "url": "https://github.com/{{gitUserId}}/{{gitRepoId}}.git" } ], "require": { - "{{#composerVendorName}}{{.}}{{/composerVendorName}}{{^composerVendorName}}{{gitUserId}}{{/composerVendorName}}/{{#composerProjectName}}{{.}}{{/composerProjectName}}{{^composerProjectName}}{{gitRepoId}}{{/composerProjectName}}": "*@dev" + "{{gitUserId}}/{{gitRepoId}}": "*@dev" } } ``` diff --git a/modules/openapi-generator/src/main/resources/php/composer.mustache b/modules/openapi-generator/src/main/resources/php/composer.mustache index 0369610b823..4bd76d6a1be 100644 --- a/modules/openapi-generator/src/main/resources/php/composer.mustache +++ b/modules/openapi-generator/src/main/resources/php/composer.mustache @@ -1,5 +1,5 @@ { - "name": "{{#composerVendorName}}{{.}}{{/composerVendorName}}{{^composerVendorName}}{{gitUserId}}{{/composerVendorName}}/{{#composerProjectName}}{{.}}{{/composerProjectName}}{{^composerProjectName}}{{gitRepoId}}{{/composerProjectName}}", + "name": "{{gitUserId}}/{{gitRepoId}}", {{#artifactVersion}} "version": "{{artifactVersion}}", {{/artifactVersion}} @@ -7,12 +7,13 @@ "keywords": [ "openapitools", "openapi-generator", + "openapi", "php", "sdk", "rest", "api" ], - "homepage": "http://openapi-generator.tech", + "homepage": "https://openapi-generator.tech", "license": "proprietary", "authors": [ { diff --git a/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/PhpClientOptionsProvider.java b/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/PhpClientOptionsProvider.java index 4e206a3871e..69c97710eea 100644 --- a/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/PhpClientOptionsProvider.java +++ b/modules/openapi-generator/src/test/java/org/openapitools/codegen/options/PhpClientOptionsProvider.java @@ -32,8 +32,6 @@ public class PhpClientOptionsProvider implements OptionsProvider { public static final String INVOKER_PACKAGE_VALUE = "OpenAPITools\\Client\\Php"; public static final String PACKAGE_NAME_VALUE = "OpenAPIToolsClient-php"; public static final String SRC_BASE_PATH_VALUE = "libPhp"; - public static final String COMPOSER_VENDOR_NAME_VALUE = "openAPIToolsPhp"; - public static final String COMPOSER_PROJECT_NAME_VALUE = "openapi-tools-client-php"; public static final String GIT_USER_ID_VALUE = "gitOpenAPIToolsPhp"; public static final String GIT_REPO_ID_VALUE = "git-openapi-tools-client-php"; public static final String ARTIFACT_VERSION_VALUE = "1.0.0-SNAPSHOT"; @@ -56,9 +54,7 @@ public class PhpClientOptionsProvider implements OptionsProvider { .put(CodegenConstants.INVOKER_PACKAGE, INVOKER_PACKAGE_VALUE) .put(PhpClientCodegen.PACKAGE_NAME, PACKAGE_NAME_VALUE) .put(PhpClientCodegen.SRC_BASE_PATH, SRC_BASE_PATH_VALUE) - .put(PhpClientCodegen.COMPOSER_VENDOR_NAME, COMPOSER_VENDOR_NAME_VALUE) .put(CodegenConstants.GIT_USER_ID, GIT_USER_ID_VALUE) - .put(PhpClientCodegen.COMPOSER_PROJECT_NAME, COMPOSER_PROJECT_NAME_VALUE) .put(CodegenConstants.GIT_REPO_ID, GIT_REPO_ID_VALUE) .put(CodegenConstants.ARTIFACT_VERSION, ARTIFACT_VERSION_VALUE) .put(CodegenConstants.HIDE_GENERATION_TIMESTAMP, "true") diff --git a/modules/openapi-generator/src/test/java/org/openapitools/codegen/php/PhpClientOptionsTest.java b/modules/openapi-generator/src/test/java/org/openapitools/codegen/php/PhpClientOptionsTest.java index 29112c3ca0e..d8ed757253c 100644 --- a/modules/openapi-generator/src/test/java/org/openapitools/codegen/php/PhpClientOptionsTest.java +++ b/modules/openapi-generator/src/test/java/org/openapitools/codegen/php/PhpClientOptionsTest.java @@ -56,12 +56,8 @@ public class PhpClientOptionsTest extends AbstractOptionsTest { times = 1; clientCodegen.setSrcBasePath(PhpClientOptionsProvider.SRC_BASE_PATH_VALUE); times = 1; - clientCodegen.setComposerVendorName(PhpClientOptionsProvider.COMPOSER_VENDOR_NAME_VALUE); - times = 1; clientCodegen.setGitUserId(PhpClientOptionsProvider.GIT_USER_ID_VALUE); times = 1; - clientCodegen.setComposerProjectName(PhpClientOptionsProvider.COMPOSER_PROJECT_NAME_VALUE); - times = 1; clientCodegen.setGitRepoId(PhpClientOptionsProvider.GIT_REPO_ID_VALUE); times = 1; clientCodegen.setArtifactVersion(PhpClientOptionsProvider.ARTIFACT_VERSION_VALUE); diff --git a/samples/client/petstore/php/OpenAPIClient-php/composer.json b/samples/client/petstore/php/OpenAPIClient-php/composer.json index 4d13dc6a249..d8c4603f9ca 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/composer.json +++ b/samples/client/petstore/php/OpenAPIClient-php/composer.json @@ -4,12 +4,13 @@ "keywords": [ "openapitools", "openapi-generator", + "openapi", "php", "sdk", "rest", "api" ], - "homepage": "http://openapi-generator.tech", + "homepage": "https://openapi-generator.tech", "license": "proprietary", "authors": [ { diff --git a/samples/openapi3/client/petstore/php/OpenAPIClient-php/composer.json b/samples/openapi3/client/petstore/php/OpenAPIClient-php/composer.json index 4d13dc6a249..d8c4603f9ca 100644 --- a/samples/openapi3/client/petstore/php/OpenAPIClient-php/composer.json +++ b/samples/openapi3/client/petstore/php/OpenAPIClient-php/composer.json @@ -4,12 +4,13 @@ "keywords": [ "openapitools", "openapi-generator", + "openapi", "php", "sdk", "rest", "api" ], - "homepage": "http://openapi-generator.tech", + "homepage": "https://openapi-generator.tech", "license": "proprietary", "authors": [ { diff --git a/samples/server/petstore/php-symfony/SymfonyBundle-php/README.md b/samples/server/petstore/php-symfony/SymfonyBundle-php/README.md index e6d35805bc3..c5062648614 100644 --- a/samples/server/petstore/php-symfony/SymfonyBundle-php/README.md +++ b/samples/server/petstore/php-symfony/SymfonyBundle-php/README.md @@ -26,7 +26,7 @@ To install the dependencies via [Composer](http://getcomposer.org/), add the fol Then run: ``` -composer require openapi/server-bundle:dev-master +composer require GIT_USER_ID/GIT_REPO_ID:dev-master ``` to add the generated openapi bundle as a dependency. diff --git a/samples/server/petstore/php-symfony/SymfonyBundle-php/composer.json b/samples/server/petstore/php-symfony/SymfonyBundle-php/composer.json index 51c7a53bbc3..248a0f3747f 100644 --- a/samples/server/petstore/php-symfony/SymfonyBundle-php/composer.json +++ b/samples/server/petstore/php-symfony/SymfonyBundle-php/composer.json @@ -1,5 +1,5 @@ { - "name": "openapi/server-bundle", + "name": "GIT_USER_ID/GIT_REPO_ID", "description": "", "keywords": [ "openapi",