Merge pull request #5 from alberlau/feature/add-generation-info

Add support for generation info
alberlau · Dec 21, 2023 · f10da58 · f10da58
2 parents a2a83b0 + 6916186
commit f10da58
Show file tree

Hide file tree

Showing 9 changed files with 53 additions and 9 deletions.
diff --git a/java-pojo-generator-mojo-example/pom.xml b/java-pojo-generator-mojo-example/pom.xml
@@ -70,6 +70,7 @@
                             <goal>generatePojo</goal>
                         </goals>
                         <configuration>
+                            <includeGenerationInfo>true</includeGenerationInfo>
                             <jdbcUrl>jdbc:h2:mem:test;DB_CLOSE_DELAY=-1;INIT=RUNSCRIPT FROM '${project.basedir}/init.sql'</jdbcUrl>
                             <jdbcClassName>org.h2.Driver</jdbcClassName>
                             <extractionParameters>

diff --git a/java-pojo-generator-mojo/src/main/java/org/db2code/generator/java/pojo/mojo/PojoMojo.java b/java-pojo-generator-mojo/src/main/java/org/db2code/generator/java/pojo/mojo/PojoMojo.java
@@ -38,6 +38,7 @@ public class PojoMojo extends AbstractMojo {
     @Parameter private String ext;
 
     @Parameter private DateImpl dateImpl;
+    @Parameter private boolean includeGenerationInfo;
 
     public void execute() {
         if (isWindows()) {
@@ -66,7 +67,8 @@ public void execute() {
                         this.targetFolder,
                         this.baseDir,
                         ext,
-                        dateImpl));
+                        dateImpl,
+                        includeGenerationInfo));
     }
 
     public static boolean isWindows() {

diff --git a/java-pojo-generator/src/main/java/org/db2code/generator/java/pojo/ExecutorParams.java b/java-pojo-generator/src/main/java/org/db2code/generator/java/pojo/ExecutorParams.java
@@ -12,6 +12,7 @@ public class ExecutorParams {
     private final String baseDir;
     private final String ext;
     private final DateImpl dateImpl;
+    private final boolean includeGenerationInfo;
 
     public ExecutorParams(
             Collection<ExtractionParameters> extractionParameters,
@@ -20,14 +21,16 @@ public ExecutorParams(
             String targetFolder,
             String baseDir,
             String ext,
-            DateImpl dateImpl) {
+            DateImpl dateImpl,
+            boolean includeGenerationInfo) {
         this.extractionParameters = extractionParameters;
         this.templates = templates;
         this.targetPackage = targetPackage;
         this.targetFolder = targetFolder;
         this.baseDir = baseDir;
         this.ext = ext;
         this.dateImpl = dateImpl;
+        this.includeGenerationInfo = includeGenerationInfo;
     }
 
     public Collection<ExtractionParameters> getExtractionParameters() {
@@ -57,4 +60,8 @@ public String getExt() {
     public DateImpl getDateImpl() {
         return dateImpl;
     }
+
+    public boolean isIncludeGenerationInfo() {
+        return includeGenerationInfo;
+    }
 }
diff --git a/java-pojo-generator/src/main/java/org/db2code/generator/java/pojo/GeneratorExecutor.java b/java-pojo-generator/src/main/java/org/db2code/generator/java/pojo/GeneratorExecutor.java
@@ -30,7 +30,11 @@ public void execute(ExecutorParams params) {
                                 dateImpl = DateImpl.UTIL_DATE;
                             }
 
-                            new JavaDatabaseAdapter(metadata, params.getTargetPackage(), dateImpl)
+                            new JavaDatabaseAdapter(
+                                            metadata,
+                                            params.getTargetPackage(),
+                                            dateImpl,
+                                            params.isIncludeGenerationInfo())
                                     .getClasses()
                                     .forEach(
                                             javaClass ->

diff --git a/...ojo-generator/src/main/java/org/db2code/generator/java/pojo/adapter/JavaClassAdapter.java b/...ojo-generator/src/main/java/org/db2code/generator/java/pojo/adapter/JavaClassAdapter.java
@@ -1,5 +1,7 @@
 package org.db2code.generator.java.pojo.adapter;
 
+import java.time.LocalDateTime;
+import java.time.ZoneId;
 import java.util.Collection;
 import java.util.stream.Collectors;
 import org.db2code.convert.JavaPropertyConverter;
@@ -9,11 +11,17 @@ public class JavaClassAdapter {
     private final RawTable rawTable;
     private final String targetPackage;
     private final DateImpl dateImpl;
+    private final boolean includeGenerationInfo;
 
-    public JavaClassAdapter(RawTable rawTable, String targetPackage, DateImpl dateImpl) {
+    public JavaClassAdapter(
+            RawTable rawTable,
+            String targetPackage,
+            DateImpl dateImpl,
+            boolean includeGenerationInfo) {
         this.rawTable = rawTable;
         this.targetPackage = targetPackage;
         this.dateImpl = dateImpl;
+        this.includeGenerationInfo = includeGenerationInfo;
     }
 
     public String getClassName() {
@@ -33,4 +41,13 @@ public Collection<JavaPropertyAdapter> getProperties() {
                 .map(rawColumn -> new JavaPropertyAdapter(rawTable, rawColumn, dateImpl))
                 .collect(Collectors.toList());
     }
+
+    public String getGenerationInfo() {
+        if (includeGenerationInfo) {
+            return "Generated by DB2Code at: "
+                    + LocalDateTime.now(ZoneId.systemDefault()).toString();
+        } else {
+            return null;
+        }
+    }
 }
diff --git a/...-generator/src/main/java/org/db2code/generator/java/pojo/adapter/JavaDatabaseAdapter.java b/...-generator/src/main/java/org/db2code/generator/java/pojo/adapter/JavaDatabaseAdapter.java
@@ -9,17 +9,25 @@ public class JavaDatabaseAdapter {
     private final RawDatabaseMetadata rawDatabaseMetadata;
     private final String targetPackage;
     private final DateImpl dateImpl;
+    private final boolean includeGenerationInfo;
 
     public JavaDatabaseAdapter(
-            RawDatabaseMetadata rawDatabaseMetadata, String targetPackage, DateImpl dateImpl) {
+            RawDatabaseMetadata rawDatabaseMetadata,
+            String targetPackage,
+            DateImpl dateImpl,
+            boolean includeGenerationInfo) {
         this.rawDatabaseMetadata = rawDatabaseMetadata;
         this.targetPackage = targetPackage;
         this.dateImpl = dateImpl;
+        this.includeGenerationInfo = includeGenerationInfo;
     }
 
     public Collection<JavaClassAdapter> getClasses() {
         return rawDatabaseMetadata.getTables().stream()
-                .map((RawTable rawTable) -> new JavaClassAdapter(rawTable, targetPackage, dateImpl))
+                .map(
+                        (RawTable rawTable) ->
+                                new JavaClassAdapter(
+                                        rawTable, targetPackage, dateImpl, includeGenerationInfo))
                 .collect(Collectors.toList());
     }
 }
diff --git a/java-pojo-generator/src/main/resources/pojo.mustache b/java-pojo-generator/src/main/resources/pojo.mustache
@@ -1,7 +1,9 @@
 package {{package}};
 
 /** {{rawTable.remarks}}
-    {{rawTable.tableCat}}.{{rawTable.tableSchem}}.{{rawTable.tableName}}
+    {{rawTable.tableCat}}.{{rawTable.tableSchem}}.{{rawTable.tableName}}{{#generationInfo}}
+
+    {{generationInfo}}{{/generationInfo}}
 */
 public class {{className}} {
     {{#properties}}

diff --git a/java-pojo-generator/src/main/resources/spring-data.mustache b/java-pojo-generator/src/main/resources/spring-data.mustache
@@ -5,7 +5,9 @@ import org.springframework.data.relational.core.mapping.Column;
 import org.springframework.data.relational.core.mapping.Table;
 
 /** {{rawTable.remarks}}
-    {{rawTable.tableCat}}.{{rawTable.tableSchem}}.{{rawTable.tableName}}
+    {{rawTable.tableCat}}.{{rawTable.tableSchem}}.{{rawTable.tableName}}{{#generationInfo}}
+
+    {{generationInfo}}{{/generationInfo}}
 */
 @Table("{{rawTable.tableName}}")
 public class {{className}} {

diff --git a/java-pojo-generator/src/test/java/org/db2code/generator/java/pojo/GeneratorExecutorTest.java b/java-pojo-generator/src/test/java/org/db2code/generator/java/pojo/GeneratorExecutorTest.java
@@ -71,7 +71,8 @@ public void test() throws IOException {
                         TARGET_FOLDER,
                         dir,
                         null,
-                        DateImpl.UTIL_DATE));
+                        DateImpl.UTIL_DATE,
+                        false));
 
         Arrays.stream(
                         Objects.requireNonNull(