make the PropertiesOutputFormat an Enum

Author: TheSnoozer

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

@@ -0,0 +1,33 @@
+/*
+ * This file is part of git-commit-id-plugin-core by Konrad 'ktoso' Malawski <konrad.malawski@java.pl>
+ *
+ * git-commit-id-plugin-core is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * git-commit-id-plugin-core is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with git-commit-id-plugin-core.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package pl.project13.core;
+
+/**
+ * An enum to indicate in what format the {@code generateGitPropertiesFilename} should be generated.
+ */
+public enum CommitIdPropertiesOutputFormat {
+  /**
+   * Indicator to generate a properties file.
+   *
+   */
+  PROPERTIES,
+  /**
+   * Indicator to generate a json file.
+   */
+  JSON,
+}

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

@@ -248,10 +248,9 @@ default Map<String, String> getSystemEnv() {
     void performPropertiesReplacement(Properties properties);
 
     /**
-     * @return The output format of the generated properties file. Can either be "properties" or "json".
+     * @return The output format of the generated properties file.
      */
-    // TODO: Why is this a String and not an enum?
-    String getPropertiesOutputFormat();
+    CommitIdPropertiesOutputFormat getPropertiesOutputFormat();
 
     /**
      * @return The BuildFileChangeListener that will be called when an output file of the plugin has changed

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

@@ -34,22 +34,22 @@ public class PropertiesFileGenerator {
 
   private LogInterface log;
   private BuildFileChangeListener buildFileChangeListener;
-  private String format;
+  private CommitIdPropertiesOutputFormat propertiesOutputFormat;
   private String prefixDot;
   private String projectName;
 
-  public PropertiesFileGenerator(LogInterface log, BuildFileChangeListener buildFileChangeListener, String format, String prefixDot, String projectName) {
+  public PropertiesFileGenerator(LogInterface log, BuildFileChangeListener buildFileChangeListener, CommitIdPropertiesOutputFormat propertiesOutputFormat, String prefixDot, String projectName) {
     this.log = log;
     this.buildFileChangeListener = buildFileChangeListener;
-    this.format = format;
+    this.propertiesOutputFormat = propertiesOutputFormat;
     this.prefixDot = prefixDot;
     this.projectName = projectName;
   }
 
   public void maybeGeneratePropertiesFile(@Nonnull Properties localProperties, File base, String propertiesFilename, Charset sourceCharset, boolean escapeUnicode) throws GitCommitIdExecutionException {
     try {
       final File gitPropsFile = craftPropertiesOutputFile(base, propertiesFilename);
-      final boolean isJsonFormat = "json".equalsIgnoreCase(format);
+      final boolean isJsonFormat = CommitIdPropertiesOutputFormat.JSON.equals(propertiesOutputFormat);
 
       boolean shouldGenerate = true;
 

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

@@ -450,7 +450,7 @@ public void shouldGenerateCustomPropertiesFileJson(boolean useNativeGit) throws
                     .setUseNativeGit(useNativeGit)
                     .setShouldGenerateGitPropertiesFile(true)
                     .setGenerateGitPropertiesFilename(targetFilePath.getCanonicalPath())
-                    .setPropertiesOutputFormat("json")
+                    .setPropertiesOutputFormat(CommitIdPropertiesOutputFormat.JSON)
                     .build();
     Properties properties = new Properties();
 

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

@@ -51,7 +51,7 @@ public class GitCommitIdTestCallback {
   private String evaluateOnCommit = "HEAD";
   private File dotGitDirectory;
   private boolean shouldGenerateGitPropertiesFile = false;
-  private String propertiesOutputFormat = "properties";
+  private CommitIdPropertiesOutputFormat propertiesOutputFormat = CommitIdPropertiesOutputFormat.PROPERTIES;
   private String projectName = "dummy-project";
   private File projectBaseDir;
   private String generateGitPropertiesFilename = "src/main/resources/git.properties";
@@ -161,7 +161,7 @@ public GitCommitIdTestCallback setShouldGenerateGitPropertiesFile(boolean should
     return this;
   }
 
-  public GitCommitIdTestCallback setPropertiesOutputFormat(String propertiesOutputFormat) {
+  public GitCommitIdTestCallback setPropertiesOutputFormat(CommitIdPropertiesOutputFormat propertiesOutputFormat) {
     this.propertiesOutputFormat = propertiesOutputFormat;
     return this;
   }
@@ -304,7 +304,7 @@ public void performPropertiesReplacement(Properties properties) {
       }
 
       @Override
-      public String getPropertiesOutputFormat() {
+      public CommitIdPropertiesOutputFormat getPropertiesOutputFormat() {
         return propertiesOutputFormat;
       }
 

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

@@ -46,7 +46,7 @@ public void setUp() {
       // Ignore
     };
 
-    propertiesFileGenerator = new PropertiesFileGenerator(logInterface, buildFileChangeListener, "properties", "", "test");
+    propertiesFileGenerator = new PropertiesFileGenerator(logInterface, buildFileChangeListener, CommitIdPropertiesOutputFormat.PROPERTIES, "", "test");
   }
 
   @Test