the getGenerateGitPropertiesFilename should be a File already and not some string

Author: TheSnoozer

src/main/java/pl/project13/core/GitCommitIdPlugin.java

@@ -268,9 +268,9 @@ default Map<String, String> getSystemEnv() {
     File getProjectBaseDir();
 
     /**
-     * @return The optional name of the properties filename where properties should be dumped into
+     * @return The optional properties file where properties should be dumped into
      */
-    String getGenerateGitPropertiesFilename();
+    File getGenerateGitPropertiesFilename();
 
     /**
      * @return The Charset in which format the properties should be dumped (e.g. 'UTF-8')
@@ -306,7 +306,6 @@ public static void runPlugin(@Nonnull Callback cb, @Nullable Properties contextP
               cb.getProjectName()
       ).maybeGeneratePropertiesFile(
               properties,
-              cb.getProjectBaseDir(),
               cb.getGenerateGitPropertiesFilename(),
               cb.getPropertiesSourceCharset(),
               cb.shouldPropertiesEscapeUnicode()

src/main/java/pl/project13/core/PropertiesFileGenerator.java

@@ -46,9 +46,8 @@ public PropertiesFileGenerator(LogInterface log, BuildFileChangeListener buildFi
     this.projectName = projectName;
   }
 
-  public void maybeGeneratePropertiesFile(@Nonnull Properties localProperties, File base, String propertiesFilename, Charset sourceCharset, boolean escapeUnicode) throws GitCommitIdExecutionException {
+  public void maybeGeneratePropertiesFile(@Nonnull Properties localProperties, File gitPropsFile, Charset sourceCharset, boolean escapeUnicode) throws GitCommitIdExecutionException {
     try {
-      final File gitPropsFile = craftPropertiesOutputFile(base, propertiesFilename);
       final boolean isJsonFormat = CommitIdPropertiesOutputFormat.JSON.equals(propertiesOutputFormat);
 
       boolean shouldGenerate = true;
@@ -115,15 +114,4 @@ public static OrderedProperties createOrderedProperties() {
             .withOrdering(Comparator.nullsLast(Comparator.naturalOrder()))
             .build();
   }
-
-  public static File craftPropertiesOutputFile(File base, String propertiesFilename) {
-    File returnPath = new File(base, propertiesFilename);
-
-    File currentPropertiesFilepath = new File(propertiesFilename);
-    if (currentPropertiesFilepath.isAbsolute()) {
-      returnPath = currentPropertiesFilepath;
-    }
-
-    return returnPath;
-  }
 }

src/test/java/pl/project13/core/GitCommitIdPluginIntegrationTest.java

@@ -421,7 +421,7 @@ public void shouldGenerateCustomPropertiesFileProperties(boolean useNativeGit) t
                     .setDotGitDirectory(dotGitDirectory)
                     .setUseNativeGit(useNativeGit)
                     .setShouldGenerateGitPropertiesFile(true)
-                    .setGenerateGitPropertiesFilename(targetFilePath.getCanonicalPath())
+                    .setGenerateGitPropertiesFilename(targetFilePath)
                     .build();
     Properties properties = new Properties();
 
@@ -449,7 +449,7 @@ public void shouldGenerateCustomPropertiesFileJson(boolean useNativeGit) throws
                     .setDotGitDirectory(dotGitDirectory)
                     .setUseNativeGit(useNativeGit)
                     .setShouldGenerateGitPropertiesFile(true)
-                    .setGenerateGitPropertiesFilename(targetFilePath.getCanonicalPath())
+                    .setGenerateGitPropertiesFilename(targetFilePath)
                     .setPropertiesOutputFormat(CommitIdPropertiesOutputFormat.JSON)
                     .build();
     Properties properties = new Properties();

src/test/java/pl/project13/core/GitCommitIdTestCallback.java

@@ -54,13 +54,14 @@ public class GitCommitIdTestCallback {
   private CommitIdPropertiesOutputFormat propertiesOutputFormat = CommitIdPropertiesOutputFormat.PROPERTIES;
   private String projectName = "dummy-project";
   private File projectBaseDir;
-  private String generateGitPropertiesFilename = "src/main/resources/git.properties";
+  private File generateGitPropertiesFilename;
   private Charset propertiesSourceCharset = StandardCharsets.UTF_8;
   private boolean shouldPropertiesEscapeUnicode = false;
 
   public GitCommitIdTestCallback() {
     try {
       this.projectBaseDir = Files.createTempDirectory("dummy-project-dir").toFile();
+      this.generateGitPropertiesFilename = projectBaseDir.toPath().resolve("src/main/resources/git.properties").toFile();
     } catch (IOException e) {
       throw new RuntimeException(e);
     }
@@ -176,7 +177,7 @@ public GitCommitIdTestCallback setProjectBaseDir(File projectBaseDir) {
     return this;
   }
 
-  public GitCommitIdTestCallback setGenerateGitPropertiesFilename(String generateGitPropertiesFilename) {
+  public GitCommitIdTestCallback setGenerateGitPropertiesFilename(File generateGitPropertiesFilename) {
     this.generateGitPropertiesFilename = generateGitPropertiesFilename;
     return this;
   }
@@ -326,7 +327,7 @@ public File getProjectBaseDir() {
       }
 
       @Override
-      public String getGenerateGitPropertiesFilename() {
+      public File getGenerateGitPropertiesFilename() {
         return generateGitPropertiesFilename;
       }
 

src/test/java/pl/project13/core/PropertiesFileGeneratorTest.java

@@ -57,7 +57,7 @@ public void generatedPropertiesFileDoesNotEscapeUnicode() throws GitCommitIdExec
     properties.put(GitCommitPropertyConstant.COMMIT_MESSAGE_SHORT, "測試中文");
 
     Path propertiesPath = temporaryFolder.getRoot().toPath().resolve("git.properties");
-    propertiesFileGenerator.maybeGeneratePropertiesFile(properties, temporaryFolder.getRoot(), propertiesPath.getFileName().toString(), UTF_8, false);
+    propertiesFileGenerator.maybeGeneratePropertiesFile(properties, propertiesPath.toFile(), UTF_8, false);
 
     byte[] bytes = Files.readAllBytes(propertiesPath);
     String actualContent = new String(bytes, UTF_8);
@@ -76,7 +76,7 @@ public void generatedPropertiesFileEscapeUnicode() throws GitCommitIdExecutionEx
     properties.put(GitCommitPropertyConstant.COMMIT_MESSAGE_SHORT, "測試中文");
 
     Path propertiesPath = temporaryFolder.getRoot().toPath().resolve("git.properties");
-    propertiesFileGenerator.maybeGeneratePropertiesFile(properties, temporaryFolder.getRoot(), propertiesPath.getFileName().toString(), UTF_8, true);
+    propertiesFileGenerator.maybeGeneratePropertiesFile(properties, propertiesPath.toFile(), UTF_8, true);
 
     byte[] bytes = Files.readAllBytes(propertiesPath);
     String actualContent = new String(bytes, UTF_8);
@@ -94,7 +94,7 @@ public void generatedPropertiesFileDoesNotContainDateComment() throws GitCommitI
     properties.put(GitCommitPropertyConstant.BRANCH, "develop");
 
     Path propertiesPath = temporaryFolder.getRoot().toPath().resolve("git.properties");
-    propertiesFileGenerator.maybeGeneratePropertiesFile(properties, temporaryFolder.getRoot(), propertiesPath.getFileName().toString(), UTF_8, true);
+    propertiesFileGenerator.maybeGeneratePropertiesFile(properties, propertiesPath.toFile(), UTF_8, true);
 
     byte[] bytes = Files.readAllBytes(propertiesPath);
     String actualContent = new String(bytes, UTF_8);
@@ -111,10 +111,10 @@ public void rereadGeneratedPropertiesFile() throws GitCommitIdExecutionException
     properties.put(GitCommitPropertyConstant.BRANCH, "develop");
 
     Path propertiesPath = temporaryFolder.getRoot().toPath().resolve("git.properties");
-    propertiesFileGenerator.maybeGeneratePropertiesFile(properties, temporaryFolder.getRoot(), propertiesPath.getFileName().toString(), UTF_8, true);
+    propertiesFileGenerator.maybeGeneratePropertiesFile(properties, propertiesPath.toFile(), UTF_8, true);
 
     // Re-read the generated properties file.
-    propertiesFileGenerator.maybeGeneratePropertiesFile(properties, temporaryFolder.getRoot(), propertiesPath.getFileName().toString(), UTF_8, true);
+    propertiesFileGenerator.maybeGeneratePropertiesFile(properties, propertiesPath.toFile(), UTF_8, true);
 
     byte[] bytes = Files.readAllBytes(propertiesPath);
     String actualContent = new String(bytes, UTF_8);