Adds hide genration timestamp option

Author: spacether

src/main/java/org/openapijsonschematools/codegen/clicommands/Generate.java

@@ -192,6 +192,10 @@ public class Generate extends AbstractCommand {
         description = "Only write output files that have changed.")
     private Boolean minimalUpdate;
 
+    @Option(name = {"--hide-generation-timestamp"}, title = "hides the generation timestamp in the generated files",
+        description = CodegenConstants.HIDE_GENERATION_TIMESTAMP_DESC)
+    private Boolean hideGenerationTimestamp;
+
     @Override
     public void execute() {
         // this initial check allows for field-level package private injection (for unit testing)
@@ -320,7 +324,11 @@ public void execute() {
         }
 
         if (removeEnumValuePrefix != null) {
-            configurator.setRemoveOperationIdPrefix(removeOperationIdPrefix);
+            configurator.setRemoveEnumValuePrefix(removeEnumValuePrefix);
+        }
+
+        if (hideGenerationTimestamp != null) {
+            configurator.setHideGenerationTimestamp(hideGenerationTimestamp);
         }
 
         if (skipOperationExample != null) {

src/main/java/org/openapijsonschematools/codegen/config/CodegenConfigurator.java

@@ -324,6 +324,11 @@ public CodegenConfigurator setRemoveEnumValuePrefix(boolean removeEnumValuePrefi
         return this;
     }
 
+    public CodegenConfigurator setHideGenerationTimestamp(boolean hideGenerationTimestamp) {
+        workflowSettingsBuilder.withHideGenerationTimestamp(hideGenerationTimestamp);
+        return this;
+    }
+
     public CodegenConfigurator setSkipOperationExample(boolean skipOperationExample) {
         workflowSettingsBuilder.withSkipOperationExample(skipOperationExample);
         return this;

src/main/java/org/openapijsonschematools/codegen/config/WorkflowSettings.java

@@ -47,6 +47,8 @@ public class WorkflowSettings {
     public static final boolean DEFAULT_ENABLE_MINIMAL_UPDATE = false;
     public static final boolean DEFAULT_STRICT_SPEC_BEHAVIOR = true;
     public static final String DEFAULT_TEMPLATING_ENGINE_NAME = "handlebars";
+
+    public static final boolean DEFAULT_HIDE_GENERATION_TIMESTAMP = true;
     public static final Map<String, String> DEFAULT_GLOBAL_PROPERTIES = Collections.unmodifiableMap(new HashMap<>());
 
     private String inputSpec;
@@ -65,6 +67,7 @@ public class WorkflowSettings {
     private String ignoreFileOverride;
     private Map<String, ?> globalProperties = DEFAULT_GLOBAL_PROPERTIES;
     private boolean removeEnumValuePrefix = DEFAULT_REMOVE_ENUM_VALUE_PREFIX;
+    private boolean hideGenerationTimestamp = DEFAULT_HIDE_GENERATION_TIMESTAMP;
 
     private WorkflowSettings(Builder builder) {
         this.inputSpec = builder.inputSpec;
@@ -83,6 +86,7 @@ private WorkflowSettings(Builder builder) {
         this.ignoreFileOverride = builder.ignoreFileOverride;
         this.globalProperties = Collections.unmodifiableMap(builder.globalProperties);
         this.removeEnumValuePrefix = builder.removeEnumValuePrefix;
+        this.hideGenerationTimestamp = builder.hideGenerationTimestamp;
     }
 
     /**
@@ -116,6 +120,7 @@ public static Builder newBuilder(WorkflowSettings copy) {
         // this, and any other collections, must be mutable in the builder.
         builder.globalProperties = new HashMap<>(copy.getGlobalProperties());
         builder.removeEnumValuePrefix = copy.isRemoveEnumValuePrefix();
+        builder.hideGenerationTimestamp = copy.isHideGenerationTimestamp();
 
         // force builder "with" methods to invoke side effects
         builder.withTemplateDir(copy.getTemplateDir());
@@ -173,6 +178,8 @@ public boolean isRemoveOperationIdPrefix() {
     public boolean isRemoveEnumValuePrefix() {
         return removeEnumValuePrefix;
     }
+
+    public boolean isHideGenerationTimestamp() { return hideGenerationTimestamp; }
     /**
      * Indicates whether or not to skip examples defined in the operation.
      *
@@ -307,6 +314,7 @@ public static final class Builder {
         private String templateDir;
         private String templatingEngineName = DEFAULT_TEMPLATING_ENGINE_NAME;
         private String ignoreFileOverride;
+        private boolean hideGenerationTimestamp = DEFAULT_HIDE_GENERATION_TIMESTAMP;
 
         // NOTE: All collections must be mutable in the builder, and copied to a new immutable collection in .build()
         private Map<String, String> globalProperties = new HashMap<>();
@@ -380,6 +388,7 @@ public Builder withRemoveEnumValuePrefix(Boolean removeEnumValuePrefix) {
             this.removeEnumValuePrefix = removeEnumValuePrefix != null ? removeEnumValuePrefix : Boolean.valueOf(DEFAULT_REMOVE_ENUM_VALUE_PREFIX);
             return this;
         }
+
         /**
          * Sets the {@code skipOperationExample} and returns a reference to this Builder so that the methods can be chained together.
          *
@@ -514,6 +523,11 @@ public Builder withIgnoreFileOverride(String ignoreFileOverride) {
             return this;
         }
 
+        public Builder withHideGenerationTimestamp(boolean hideGenerationTimestamp) {
+            this.hideGenerationTimestamp = hideGenerationTimestamp;
+            return this;
+        }
+
         /**
          * Sets the {@code globalProperties} and returns a reference to this Builder so that the methods can be chained together.
          *

src/main/java/org/openapijsonschematools/codegen/generators/DefaultGenerator.java

@@ -182,6 +182,7 @@ public DefaultGenerator(GeneratorSettings generatorSettings, WorkflowSettings wo
             "openapiclient",
             "generated-code" + File.separator + "java"
         );
+        additionalProperties.put(CodegenConstants.HIDE_GENERATION_TIMESTAMP, this.generatorSettings.hideGenerationTimestamp);
     }
 
     private final Logger LOGGER = LoggerFactory.getLogger(DefaultGenerator.class);
@@ -312,7 +313,6 @@ public DefaultGenerator(GeneratorSettings generatorSettings, WorkflowSettings wo
      */
     protected boolean supportsAdditionalPropertiesWithComposedSchema = true;
     protected Boolean allowUnicodeIdentifiers = false;
-    protected Boolean hideGenerationTimestamp = true;
     // How to encode special characters like $
     // They are translated to words like "Dollar" and prefixed with '
     // Then translated back during JSON encoding and decoding
@@ -355,12 +355,6 @@ public List<CliOption> cliOptions() {
 
     @Override
     public void processOpts() {
-        if (additionalProperties.containsKey(CodegenConstants.HIDE_GENERATION_TIMESTAMP)) {
-            setHideGenerationTimestamp(convertPropertyToBooleanAndWriteBack(CodegenConstants.HIDE_GENERATION_TIMESTAMP));
-        } else {
-            additionalProperties.put(CodegenConstants.HIDE_GENERATION_TIMESTAMP, hideGenerationTimestamp);
-        }
-
         if (additionalProperties.containsKey(CodegenConstants.ALLOW_UNICODE_IDENTIFIERS)) {
             this.setAllowUnicodeIdentifiers(Boolean.valueOf(additionalProperties
                     .get(CodegenConstants.ALLOW_UNICODE_IDENTIFIERS).toString()));
@@ -4013,16 +4007,6 @@ public void setRemoveOperationIdPrefixCount(int removeOperationIdPrefixCount) {
         this.removeOperationIdPrefixCount = removeOperationIdPrefixCount;
     }
 
-    @Override
-    public boolean isHideGenerationTimestamp() {
-        return hideGenerationTimestamp;
-    }
-
-    @Override
-    public void setHideGenerationTimestamp(boolean hideGenerationTimestamp) {
-        this.hideGenerationTimestamp = hideGenerationTimestamp;
-    }
-
     /**
      * Set Documentation files extension
      *

src/main/java/org/openapijsonschematools/codegen/generators/Generator.java

@@ -107,10 +107,6 @@ public interface Generator extends OpenApiProcessor, Comparable<Generator> {
 
     String getFilePath(GeneratedFileType type, String jsonPath);
 
-    boolean isHideGenerationTimestamp();
-
-    void setHideGenerationTimestamp(boolean hideGenerationTimestamp);
-
     void setDocExtension(String docExtension);
 
     String sanitizeName(String name);
@@ -362,5 +358,10 @@ default Map<String, String> instantiationTypes() {
     default Set<String> languageSpecificPrimitives() {
         return getGeneratorMetadata().getLanguageSpecificPrimitives();
     }
-    // 93 - 42 -> 51
+
+    @Deprecated
+    default boolean isHideGenerationTimestamp() {
+        return generatorSettings().hideGenerationTimestamp;
+    }
+    // 93 - 45 -> 48
 }

src/main/java/org/openapijsonschematools/codegen/generators/JavaClientGenerator.java

@@ -97,7 +97,6 @@ public JavaClientGenerator(GeneratorSettings generatorSettings, WorkflowSettings
         }
         headersSchemaFragment = "HeadersSchema";
         supportsInheritance = true;
-        hideGenerationTimestamp = false;
 
 
         cliOptions.add(new CliOption(CodegenConstants.API_PACKAGE, CodegenConstants.API_PACKAGE_DESC));
@@ -117,7 +116,6 @@ public JavaClientGenerator(GeneratorSettings generatorSettings, WorkflowSettings
         cliOptions.add(new CliOption(CodegenConstants.LICENSE_NAME, CodegenConstants.LICENSE_NAME_DESC).defaultValue(this.getLicenseName()));
         cliOptions.add(new CliOption(CodegenConstants.LICENSE_URL, CodegenConstants.LICENSE_URL_DESC).defaultValue(this.getLicenseUrl()));
         cliOptions.add(new CliOption(CodegenConstants.SOURCE_FOLDER, CodegenConstants.SOURCE_FOLDER_DESC).defaultValue(this.getSourceFolder()));
-        cliOptions.add(CliOption.newBoolean(CodegenConstants.HIDE_GENERATION_TIMESTAMP, CodegenConstants.HIDE_GENERATION_TIMESTAMP_DESC, this.isHideGenerationTimestamp()));
 
         cliOptions.add(CliOption.newString(CodegenConstants.PARENT_GROUP_ID, CodegenConstants.PARENT_GROUP_ID_DESC));
         cliOptions.add(CliOption.newString(CodegenConstants.PARENT_ARTIFACT_ID, CodegenConstants.PARENT_ARTIFACT_ID_DESC));

src/main/java/org/openapijsonschematools/codegen/generators/PythonClientGenerator.java

@@ -326,9 +326,6 @@ public PythonClientGenerator(GeneratorSettings generatorSettings, WorkflowSettin
 
         modelPackage = "components.schema";
 
-        // default HIDE_GENERATION_TIMESTAMP to true
-        hideGenerationTimestamp = Boolean.TRUE;
-
         regexModifiers = new HashMap<>();
         regexModifiers.put('i', "IGNORECASE");
         regexModifiers.put('l', "LOCALE");

src/main/java/org/openapijsonschematools/codegen/generators/models/CodeGeneratorSettings.java

@@ -21,6 +21,7 @@ public class CodeGeneratorSettings {
     public final String templateEngineName;
     public final String inputSpecLocation;  // input spec's location, as URL or file
     public final boolean removeEnumValuePrefix;
+    public final boolean hideGenerationTimestamp;
     public CodeGeneratorSettings(
         String apiPackage,
         String outputFolder,
@@ -36,7 +37,8 @@ public CodeGeneratorSettings(
         boolean enablePostProcessFile,
         String templateEngineName,
         String inputSpecLocation,
-        boolean removeEnumValuePrefix
+        boolean removeEnumValuePrefix,
+        boolean hideGenerationTimestamp
     ) {
         this.apiPackage = apiPackage;
         this.outputFolder = outputFolder;
@@ -53,6 +55,7 @@ public CodeGeneratorSettings(
         this.templateEngineName = templateEngineName;
         this.inputSpecLocation = inputSpecLocation;
         this.removeEnumValuePrefix = removeEnumValuePrefix;
+        this.hideGenerationTimestamp = hideGenerationTimestamp;
     }
 
     public static CodeGeneratorSettings of(GeneratorSettings generatorSettings, WorkflowSettings workflowSettings, String embeddedTemplateDir, String packageNameDefault, String outputFolderDefault) {
@@ -71,6 +74,7 @@ public static CodeGeneratorSettings of(GeneratorSettings generatorSettings, Work
         String templateEnginName = workflowSettings != null ? workflowSettings.getTemplatingEngineName() : WorkflowSettings.DEFAULT_TEMPLATING_ENGINE_NAME;
         String inputSpecLocation = workflowSettings != null ? workflowSettings.getInputSpec() : null;
         boolean removeEnumValuePrefix = workflowSettings != null ? workflowSettings.isRemoveEnumValuePrefix() : WorkflowSettings.DEFAULT_REMOVE_ENUM_VALUE_PREFIX;
+        boolean hideGenerationTimestamp = workflowSettings != null ? workflowSettings.isHideGenerationTimestamp() : WorkflowSettings.DEFAULT_HIDE_GENERATION_TIMESTAMP;
         return new CodeGeneratorSettings(
             apiPackage,
             outputDir,
@@ -86,7 +90,8 @@ public static CodeGeneratorSettings of(GeneratorSettings generatorSettings, Work
             enablePostProcessingFile,
             templateEnginName,
             inputSpecLocation,
-            removeEnumValuePrefix
+            removeEnumValuePrefix,
+            hideGenerationTimestamp
         );
     }
 }

src/test/java/org/openapijsonschematools/codegen/generators/DefaultGeneratorTest.java

@@ -250,27 +250,27 @@ public void testInitialConfigValues() throws Exception {
         codegen.processOpts();
 
         Assert.assertEquals(codegen.additionalProperties().get(CodegenConstants.HIDE_GENERATION_TIMESTAMP), Boolean.TRUE);
-        Assert.assertTrue(codegen.isHideGenerationTimestamp());
+        Assert.assertTrue(codegen.generatorSettings.hideGenerationTimestamp);
     }
 
     @Test
     public void testSettersForConfigValues() throws Exception {
-        final DefaultGenerator codegen = new ThisDefaultGenerator();
-        codegen.setHideGenerationTimestamp(false);
+        WorkflowSettings ws = WorkflowSettings.newBuilder().withHideGenerationTimestamp(false).build();
+        final DefaultGenerator codegen = new ThisDefaultGenerator(ws);
         codegen.processOpts();
 
         Assert.assertEquals(codegen.additionalProperties().get(CodegenConstants.HIDE_GENERATION_TIMESTAMP), Boolean.FALSE);
-        Assert.assertFalse(codegen.isHideGenerationTimestamp());
+        Assert.assertFalse(codegen.generatorSettings.hideGenerationTimestamp);
     }
 
     @Test
-    public void testAdditionalPropertiesPutForConfigValues() throws Exception {
-        final DefaultGenerator codegen = new ThisDefaultGenerator();
-        codegen.additionalProperties().put(CodegenConstants.HIDE_GENERATION_TIMESTAMP, false);
+    public void testAdditionalPropertiesPutForConfigValues() {
+        WorkflowSettings ws = WorkflowSettings.newBuilder().withHideGenerationTimestamp(false).build();
+        final DefaultGenerator codegen = new ThisDefaultGenerator(ws);
         codegen.processOpts();
 
         Assert.assertEquals(codegen.additionalProperties().get(CodegenConstants.HIDE_GENERATION_TIMESTAMP), Boolean.FALSE);
-        Assert.assertFalse(codegen.isHideGenerationTimestamp());
+        Assert.assertFalse(codegen.generatorSettings.hideGenerationTimestamp);
     }
 
     @Test