#18: support YML format

Author: TheSnoozer

pom.xml

@@ -205,6 +205,12 @@
             <artifactId>javax.json</artifactId>
             <version>1.1.4</version>
         </dependency>
+        <!-- yaml -->
+        <dependency>
+            <groupId>org.yaml</groupId>
+            <artifactId>snakeyaml</artifactId>
+            <version>2.0</version>
+        </dependency>
 
         <!-- Test stuff -->
         <dependency>

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

@@ -34,4 +34,8 @@ public enum CommitIdPropertiesOutputFormat {
    * Indicator to generate a xml file.
    */
   XML,
+  /**
+   * Indicator to generate a yml file.
+   */
+  YML,
 }

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

@@ -23,12 +23,12 @@
 import pl.project13.core.util.JsonManager;
 import pl.project13.core.util.PropertyManager;
 import pl.project13.core.util.XmlManager;
+import pl.project13.core.util.YmlManager;
 
 import javax.annotation.Nonnull;
 import java.io.*;
 import java.nio.charset.Charset;
 import java.nio.file.Files;
-import java.nio.file.Paths;
 import java.util.Comparator;
 import java.util.Properties;
 
@@ -76,6 +76,10 @@ public void maybeGeneratePropertiesFile(
               log.info(String.format("Reading existing xml file [%s] (for module %s)...", gitPropsFile.getAbsolutePath(), projectName));
               persistedProperties = XmlManager.readXmlProperties(gitPropsFile, sourceCharset);
               break;
+            case YML:
+              log.info(String.format("Reading existing yml file [%s] (for module %s)...", gitPropsFile.getAbsolutePath(), projectName));
+              persistedProperties = YmlManager.readYmlProperties(gitPropsFile, sourceCharset);
+              break;
             default:
               throw new GitCommitIdExecutionException("Not implemented:" + propertiesOutputFormat);
           }
@@ -115,6 +119,11 @@ public void maybeGeneratePropertiesFile(
               // using outputStream directly instead of outputWriter this way the UTF-8 characters appears in unicode escaped form
               XmlManager.dumpXml(outputStream, sortedLocalProperties, sourceCharset);
               break;
+            case YML:
+              log.info(String.format("Writing yml file to [%s] (for module %s)...", gitPropsFile.getAbsolutePath(), projectName));
+              // using outputStream directly instead of outputWriter this way the UTF-8 characters appears in unicode escaped form
+              YmlManager.dumpYml(outputStream, sortedLocalProperties, sourceCharset);
+              break;
             default:
               throw new GitCommitIdExecutionException("Not implemented:" + propertiesOutputFormat);
           }

src/main/java/pl/project13/core/util/YmlManager.java

@@ -0,0 +1,79 @@
+/*
+ * 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.util;
+
+import nu.studer.java.util.OrderedProperties;
+import org.yaml.snakeyaml.DumperOptions;
+import org.yaml.snakeyaml.LoaderOptions;
+import org.yaml.snakeyaml.Yaml;
+import pl.project13.core.CannotReadFileException;
+
+import javax.annotation.Nonnull;
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.io.OutputStream;
+import java.io.OutputStreamWriter;
+import java.io.Writer;
+import java.nio.charset.Charset;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Properties;
+
+public class YmlManager {
+  public static void dumpYml(OutputStream outputStream, OrderedProperties sortedLocalProperties, Charset sourceCharset) throws IOException {
+    try (Writer outputWriter = new OutputStreamWriter(outputStream, sourceCharset)) {
+      DumperOptions dumperOptions = new DumperOptions();
+      dumperOptions.setAllowUnicode(true);
+      dumperOptions.setAllowReadOnlyProperties(true);
+      dumperOptions.setPrettyFlow(true);
+      // dumperOptions.setCanonical(true);
+      dumperOptions.setDefaultFlowStyle(DumperOptions.FlowStyle.AUTO);
+
+      Yaml yaml = new Yaml(dumperOptions);
+
+      Map<String, Object> dataMap = new HashMap<>();
+      for (Map.Entry<String, String> e: sortedLocalProperties.entrySet()) {
+        dataMap.put(e.getKey(), e.getValue());
+      }
+      yaml.dump(dataMap, outputWriter);
+    }
+  }
+
+  public static Properties readYmlProperties(@Nonnull File xmlFile, Charset sourceCharset) throws CannotReadFileException {
+    Properties retVal = new Properties();
+
+    try (FileInputStream fis = new FileInputStream(xmlFile)) {
+      try (InputStreamReader reader = new InputStreamReader(fis, sourceCharset)) {
+        LoaderOptions loaderOptions = new LoaderOptions();
+        loaderOptions.setAllowDuplicateKeys(false);
+        loaderOptions.setAllowRecursiveKeys(false);
+        loaderOptions.setProcessComments(false);
+        Yaml yaml = new Yaml(loaderOptions);
+        Map<String, Object> data = yaml.load(reader);
+        for (Map.Entry<String, Object> e: data.entrySet()) {
+          retVal.put(e.getKey(), e.getValue());
+        }
+      }
+    } catch (IOException e) {
+      throw new CannotReadFileException(e);
+    }
+    return retVal;
+  }
+}

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

@@ -27,6 +27,7 @@
 import pl.project13.core.git.GitDescribeConfig;
 import pl.project13.core.util.JsonManager;
 import pl.project13.core.util.XmlManager;
+import pl.project13.core.util.YmlManager;
 
 import javax.annotation.Nonnull;
 import java.io.File;
@@ -492,6 +493,33 @@ public void shouldGenerateCustomPropertiesFileXml(boolean useNativeGit) throws E
     Assert.assertEquals(p, properties);
   }
 
+  @Test
+  @Parameters(method = "useNativeGit")
+  public void shouldGenerateCustomPropertiesFileYml(boolean useNativeGit) throws Exception {
+    // given
+    File dotGitDirectory = createTmpDotGitDirectory(AvailableGitTestRepo.WITH_ONE_COMMIT_WITH_SPECIAL_CHARACTERS);
+
+    File targetFilePath = sandbox.resolve("custom-git.yml").toFile();
+    targetFilePath.delete();
+
+    GitCommitIdPlugin.Callback cb =
+        new GitCommitIdTestCallback()
+            .setDotGitDirectory(dotGitDirectory)
+            .setUseNativeGit(useNativeGit)
+            .setShouldGenerateGitPropertiesFile(true)
+            .setGenerateGitPropertiesFilename(targetFilePath)
+            .setPropertiesOutputFormat(CommitIdPropertiesOutputFormat.YML)
+            .build();
+    Properties properties = new Properties();
+
+    // when
+    GitCommitIdPlugin.runPlugin(cb, properties);
+    // then
+    assertThat(targetFilePath).exists();
+    Properties p = YmlManager.readYmlProperties(targetFilePath, StandardCharsets.UTF_8);
+    assertThat(p.size() > 10);
+    Assert.assertEquals(p, properties);
+  }
 
   @Test
   @Parameters(method = "useNativeGit")