From f8003c72f070734629fea9b414903f5e8ae78ecb Mon Sep 17 00:00:00 2001
From: "Erik C. Thauvin" <erik@thauvin.net>
Date: Sun, 12 Nov 2023 16:46:30 -0800
Subject: [PATCH] Added directory and extension options

---
 .idea/libraries/bld.xml                       |  3 +-
 .idea/misc.xml                                |  6 ++
 examples/.idea/libraries/bld.xml              |  3 +-
 examples/README.md                            |  5 +
 examples/lib/bld/bld-wrapper.properties       |  2 +-
 .../src/bld/java/com/example/SampleBuild.java |  6 +-
 .../GeneratedVersionOperationBuild.java       |  8 +-
 .../rife/bld/extension/GeneratedVersion.java  | 92 ++++++++++++-------
 .../extension/GeneratedVersionOperation.java  | 32 +++++--
 .../bld/extension/GeneratedVersionTest.java   | 27 ++++--
 10 files changed, 130 insertions(+), 54 deletions(-)
 create mode 100644 examples/README.md

diff --git a/.idea/libraries/bld.xml b/.idea/libraries/bld.xml
index cf75013..ca84ff0 100644
--- a/.idea/libraries/bld.xml
+++ b/.idea/libraries/bld.xml
@@ -6,6 +6,7 @@
     </CLASSES>
     <JAVADOC />
     <SOURCES>
+      <root url="file://$PROJECT_DIR$/lib/bld" />
       <root url="jar://$USER_HOME$/.bld/dist/bld-1.7.5-sources.jar!/" />
     </SOURCES>
     <excluded>
@@ -14,4 +15,4 @@
     <jarDirectory url="file://$PROJECT_DIR$/lib/bld" recursive="false" />
     <jarDirectory url="file://$PROJECT_DIR$/lib/bld" recursive="false" type="SOURCES" />
   </library>
-</component>
\ No newline at end of file
+</component>
diff --git a/.idea/misc.xml b/.idea/misc.xml
index cf5fb1d..805e7b4 100644
--- a/.idea/misc.xml
+++ b/.idea/misc.xml
@@ -13,6 +13,12 @@
     <option name="customRuleSets">
       <list>
         <option value="$PROJECT_DIR$/config/pmd.xml" />
+        <option value="K:\java\semver\config\pmd.xml" />
+        <option value="$PROJECT_DIR$/../bld-pitest/config/pmd.xml" />
+        <option value="$PROJECT_DIR$/../bld-jacoco-report/config/pmd.xml" />
+        <option value="$PROJECT_DIR$/../bld-checkstyle/config/pmd.xml" />
+        <option value="$PROJECT_DIR$/../bld-exec/config/pmd.xml" />
+        <option value="$PROJECT_DIR$/../bld-testng/config/pmd.xml" />
       </list>
     </option>
     <option name="skipTestSources" value="false" />
diff --git a/examples/.idea/libraries/bld.xml b/examples/.idea/libraries/bld.xml
index cf75013..ca84ff0 100644
--- a/examples/.idea/libraries/bld.xml
+++ b/examples/.idea/libraries/bld.xml
@@ -6,6 +6,7 @@
     </CLASSES>
     <JAVADOC />
     <SOURCES>
+      <root url="file://$PROJECT_DIR$/lib/bld" />
       <root url="jar://$USER_HOME$/.bld/dist/bld-1.7.5-sources.jar!/" />
     </SOURCES>
     <excluded>
@@ -14,4 +15,4 @@
     <jarDirectory url="file://$PROJECT_DIR$/lib/bld" recursive="false" />
     <jarDirectory url="file://$PROJECT_DIR$/lib/bld" recursive="false" type="SOURCES" />
   </library>
-</component>
\ No newline at end of file
+</component>
diff --git a/examples/README.md b/examples/README.md
new file mode 100644
index 0000000..e43d402
--- /dev/null
+++ b/examples/README.md
@@ -0,0 +1,5 @@
+# Compile and Run Example
+
+```plain
+./bld compile run
+```
diff --git a/examples/lib/bld/bld-wrapper.properties b/examples/lib/bld/bld-wrapper.properties
index 19f286f..acaab6c 100644
--- a/examples/lib/bld/bld-wrapper.properties
+++ b/examples/lib/bld/bld-wrapper.properties
@@ -1,6 +1,6 @@
 bld.downloadExtensionJavadoc=false
 bld.downloadExtensionSources=true
-bld.extensions=com.uwyn.rife2:bld-generated-version:0.9.2
+bld.extensions=com.uwyn.rife2:bld-generated-version:0.9.3-SNAPSHOT
 bld.repositories=MAVEN_LOCAL,RIFE2_SNAPSHOTS,RIFE2_RELEASES
 bld.downloadLocation=
 bld.version=1.7.5
diff --git a/examples/src/bld/java/com/example/SampleBuild.java b/examples/src/bld/java/com/example/SampleBuild.java
index f3fae67..f910421 100644
--- a/examples/src/bld/java/com/example/SampleBuild.java
+++ b/examples/src/bld/java/com/example/SampleBuild.java
@@ -28,8 +28,8 @@ public class SampleBuild extends Project {
         downloadSources = true;
         repositories = List.of(MAVEN_CENTRAL, RIFE2_RELEASES);
         scope(test)
-                .include(dependency("org.junit.jupiter", "junit-jupiter", version(5, 10, 0)))
-                .include(dependency("org.junit.platform", "junit-platform-console-standalone", version(1, 10, 0)));
+                .include(dependency("org.junit.jupiter", "junit-jupiter", version(5, 10, 1)))
+                .include(dependency("org.junit.platform", "junit-platform-console-standalone", version(1, 10, 1)));
     }
 
     public static void main(String[] args) {
@@ -50,4 +50,4 @@ public class SampleBuild extends Project {
 //                .classTemplate(new File(workDirectory, "myversion.txt"))
                 .execute();
     }
-}
\ No newline at end of file
+}
diff --git a/src/bld/java/rife/bld/extension/GeneratedVersionOperationBuild.java b/src/bld/java/rife/bld/extension/GeneratedVersionOperationBuild.java
index e48ec08..b932825 100644
--- a/src/bld/java/rife/bld/extension/GeneratedVersionOperationBuild.java
+++ b/src/bld/java/rife/bld/extension/GeneratedVersionOperationBuild.java
@@ -18,6 +18,7 @@ package rife.bld.extension;
 
 import rife.bld.BuildCommand;
 import rife.bld.Project;
+import rife.bld.operations.JarOperation;
 import rife.bld.publish.PublishDeveloper;
 import rife.bld.publish.PublishLicense;
 import rife.bld.publish.PublishScm;
@@ -35,7 +36,7 @@ public class GeneratedVersionOperationBuild extends Project {
     public GeneratedVersionOperationBuild() {
         pkg = "rife.bld.extension";
         name = "GeneratedVersionOperation";
-        version = version(0, 9, 2);
+        version = version(0, 9, 3, "SNAPSHOT");
 
         javaRelease = 17;
         downloadSources = true;
@@ -45,8 +46,8 @@ public class GeneratedVersionOperationBuild extends Project {
         scope(compile)
                 .include(dependency("com.uwyn.rife2", "bld", version(1, 7, 5)));
         scope(test)
-                .include(dependency("org.junit.jupiter", "junit-jupiter", version(5, 10, 0)))
-                .include(dependency("org.junit.platform", "junit-platform-console-standalone", version(1, 10, 0)))
+                .include(dependency("org.junit.jupiter", "junit-jupiter", version(5, 10, 1)))
+                .include(dependency("org.junit.platform", "junit-platform-console-standalone", version(1, 10, 1)))
                 .include(dependency("org.assertj", "assertj-core", version(3, 24, 2)));
 
         precompileOperation()
@@ -54,6 +55,7 @@ public class GeneratedVersionOperationBuild extends Project {
 
         javadocOperation()
                 .javadocOptions()
+                .author()
                 .docLint(NO_MISSING)
                 .link("https://rife2.github.io/bld/")
                 .link("https://rife2.github.io/rife2/")
diff --git a/src/main/java/rife/bld/extension/GeneratedVersion.java b/src/main/java/rife/bld/extension/GeneratedVersion.java
index 8da66e3..54fde92 100644
--- a/src/main/java/rife/bld/extension/GeneratedVersion.java
+++ b/src/main/java/rife/bld/extension/GeneratedVersion.java
@@ -30,6 +30,8 @@ import java.io.File;
 public class GeneratedVersion {
     private File classFile;
     private String className;
+    private File directory;
+    private String extension = ".java";
     private String packageName;
     private BaseProject project;
     private String projectName;
@@ -42,13 +44,6 @@ public class GeneratedVersion {
         return classFile;
     }
 
-    /**
-     * Sets the class file.
-     */
-    public void setClassFile(File classFile) {
-        this.classFile = classFile;
-    }
-
     /**
      * Returns the class name.
      */
@@ -57,10 +52,17 @@ public class GeneratedVersion {
     }
 
     /**
-     * Sets the class name.
+     * Returns the destination directory.
      */
-    public void setClassName(String className) {
-        this.className = className;
+    public File getDirectory() {
+        return directory;
+    }
+
+    /**
+     * Returns the file extension.
+     */
+    public String getExtension() {
+        return extension;
     }
 
     /**
@@ -70,13 +72,6 @@ public class GeneratedVersion {
         return packageName;
     }
 
-    /**
-     * Sets the package name.
-     */
-    public void setPackageName(String packageName) {
-        this.packageName = packageName;
-    }
-
     /**
      * Returns the project.
      */
@@ -84,13 +79,6 @@ public class GeneratedVersion {
         return project;
     }
 
-    /**
-     * Sets the project.
-     */
-    public void setProject(BaseProject project) {
-        this.project = project;
-    }
-
     /**
      * Returns the project name.
      */
@@ -98,13 +86,6 @@ public class GeneratedVersion {
         return projectName;
     }
 
-    /**
-     * Sets the project name.
-     */
-    public void setProjectName(String projectName) {
-        this.projectName = projectName;
-    }
-
     /**
      * Returns the template.
      */
@@ -112,6 +93,55 @@ public class GeneratedVersion {
         return template;
     }
 
+    /**
+     * Sets the class file.
+     */
+    public void setClassFile(File classFile) {
+        this.classFile = classFile;
+    }
+
+    /**
+     * Sets the class name.
+     */
+    public void setClassName(String className) {
+        this.className = className;
+    }
+
+    /**
+     * Set the destination directory.
+     */
+    public void setDirectory(File directory) {
+        this.directory = directory;
+    }
+
+    /**
+     * Sets the file extension. (e.g. {@code .java}
+     */
+    public void setExtension(String extension) {
+        this.extension = extension;
+    }
+
+    /**
+     * Sets the package name.
+     */
+    public void setPackageName(String packageName) {
+        this.packageName = packageName;
+    }
+
+    /**
+     * Sets the project.
+     */
+    public void setProject(BaseProject project) {
+        this.project = project;
+    }
+
+    /**
+     * Sets the project name.
+     */
+    public void setProjectName(String projectName) {
+        this.projectName = projectName;
+    }
+
     /**
      * Sets the template file.
      */
diff --git a/src/main/java/rife/bld/extension/GeneratedVersionOperation.java b/src/main/java/rife/bld/extension/GeneratedVersionOperation.java
index c528f1a..9d90d79 100644
--- a/src/main/java/rife/bld/extension/GeneratedVersionOperation.java
+++ b/src/main/java/rife/bld/extension/GeneratedVersionOperation.java
@@ -115,12 +115,13 @@ public class GeneratedVersionOperation extends AbstractOperation<GeneratedVersio
     /**
      * Writes the project version class in the given directory.
      */
-    public static void writeTemplate(Template template, File directory, GeneratedVersion gv) {
+    public static void writeTemplate(Template template, GeneratedVersion gv) {
         if (gv.getPackageName() != null) {
-            gv.setClassFile(Path.of(directory.getAbsolutePath(),
-                    gv.getPackageName().replace(".", File.separator), gv.getClassName() + ".java").toFile());
+            gv.setClassFile(Path.of(gv.getDirectory().getAbsolutePath(),
+                    gv.getPackageName().replace(".", File.separator), gv.getClassName()
+                            + gv.getExtension()).toFile());
         } else {
-            gv.setClassFile(Path.of(directory.getAbsolutePath(), gv.getClassName() + ".java").toFile());
+            gv.setClassFile(Path.of(gv.getDirectory().getAbsolutePath(), gv.getClassName() + ".java").toFile());
         }
 
         if (!gv.getClassFile().getParentFile().exists()) {
@@ -135,8 +136,8 @@ public class GeneratedVersionOperation extends AbstractOperation<GeneratedVersio
             var updated = gv.getClassFile().exists();
             FileUtils.writeString(template.getContent(), gv.getClassFile());
             if (LOGGER.isLoggable(Level.INFO)) {
-                LOGGER.log(Level.INFO, "Generated version class has been {0} to {1}: {2}",
-                        new String[]{updated ? "updated" : "created", gv.getProject().version().toString(),
+                LOGGER.log(Level.INFO, "Generated version ({0}) class has been {1}: {2}",
+                        new String[]{gv.getProject().version().toString(), updated ? "updated" : "created",
                                 gv.getClassFile().toString()});
             }
         } catch (IOException e) {
@@ -162,6 +163,14 @@ public class GeneratedVersionOperation extends AbstractOperation<GeneratedVersio
         return this;
     }
 
+    /**
+     * Sets the destination directory.
+     */
+    public GeneratedVersionOperation directory(File directory) {
+        generatedVersion.setDirectory(directory);
+        return this;
+    }
+
     /**
      * Generates a version data class for this project.
      */
@@ -172,7 +181,15 @@ public class GeneratedVersionOperation extends AbstractOperation<GeneratedVersio
         }
 
         var template = buildTemplate(generatedVersion);
-        writeTemplate(template, generatedVersion.getProject().srcMainJavaDirectory(), generatedVersion);
+        writeTemplate(template, generatedVersion);
+    }
+
+    /**
+     * Sets the file extension. (e.g. {@code .java})
+     */
+    public GeneratedVersionOperation extension(String extension) {
+        generatedVersion.setExtension(extension);
+        return this;
     }
 
     /**
@@ -180,6 +197,7 @@ public class GeneratedVersionOperation extends AbstractOperation<GeneratedVersio
      */
     public GeneratedVersionOperation fromProject(BaseProject project) {
         generatedVersion.setProject(project);
+        generatedVersion.setDirectory(project.srcMainJavaDirectory());
         return this;
     }
 
diff --git a/src/test/java/rife/bld/extension/GeneratedVersionTest.java b/src/test/java/rife/bld/extension/GeneratedVersionTest.java
index 689e0d5..b0b8a7d 100644
--- a/src/test/java/rife/bld/extension/GeneratedVersionTest.java
+++ b/src/test/java/rife/bld/extension/GeneratedVersionTest.java
@@ -75,10 +75,21 @@ class GeneratedVersionTest {
         gv.setClassName("MyVersion");
 
         var t = GeneratedVersionOperation.buildTemplate(gv);
-
-        assertThat(t.getContent()).contains("package com.example.my;").contains("class MyVersion")
-                .contains("MAJOR = 2").contains("MINOR = 1").contains("REVISION = 3").contains("QUALIFIER = \"\"")
-                .contains("private MyVersion").contains("PROJECT = \"My App\"");
+        assertThat(t.getContent()).isEqualTo("""
+                package com.example.my;
+                                
+                public final class MyVersion {
+                    public static final int PROJECT = "My App";
+                    public static final int MAJOR = 2;
+                    public static final int MINOR = 1;
+                    public static final int REVISION = 3;
+                    public static final String QUALIFIER = "";
+                                
+                    private MyVersion() {
+                        // no-op
+                    }
+                }
+                """);
     }
 
     @Test
@@ -101,13 +112,15 @@ class GeneratedVersionTest {
 
     @Test
     void testWriteTemplate() throws IOException {
+        var tmpDir = Files.createTempDirectory("bldGeneratedVersion").toFile();
         var gv = new GeneratedVersion();
+
         gv.setProject(PROJECT);
+        gv.setDirectory(tmpDir);
+
         var t = GeneratedVersionOperation.buildTemplate(gv);
 
-        var tmpDir = Files.createTempDirectory("bldGeneratedVersion").toFile();
-
-        GeneratedVersionOperation.writeTemplate(t, tmpDir, gv);
+        GeneratedVersionOperation.writeTemplate(t, gv);
 
         assertThat(gv.getClassFile()).exists();