Merge pull request #501 from TheSnoozer/jackson-databind

replace jackson-databind with lightweight javax.json

Author: TheSnoozer

core/pom.xml

@@ -18,6 +18,7 @@
         <java.target>1.8</java.target>
 
         <jgit.version>5.9.0.202009080501-r</jgit.version>
+        <junit.version>4.12</junit.version>
     </properties>
 
     <dependencies>
@@ -39,11 +40,6 @@
             <artifactId>plexus-build-api</artifactId>
             <version>0.0.7</version>
         </dependency>
-        <dependency>
-            <groupId>com.fasterxml.jackson.core</groupId>
-            <artifactId>jackson-databind</artifactId>
-            <version>2.11.2</version>
-        </dependency>
         <dependency>
             <groupId>com.google.code.findbugs</groupId>
             <artifactId>jsr305</artifactId>
@@ -53,5 +49,24 @@
             <artifactId>java-ordered-properties</artifactId>
             <version>1.0.4</version>
         </dependency>
+        <!-- json stuff -->
+        <dependency>
+            <groupId>javax.json</groupId>
+            <artifactId>javax.json-api</artifactId>
+            <version>1.1.4</version>
+        </dependency>
+        <dependency>
+            <groupId>org.glassfish</groupId>
+            <artifactId>javax.json</artifactId>
+            <version>1.1.4</version>
+        </dependency>
+
+        <!-- Test stuff -->
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+            <version>${junit.version}</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 </project>

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

@@ -0,0 +1,26 @@
+/*
+ * This file is part of git-commit-id-plugin by Konrad 'ktoso' Malawski <konrad.malawski@java.pl>
+ *
+ * git-commit-id-plugin 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 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.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package pl.project13.core;
+
+public class CannotReadFileException extends Exception {
+  private static final long serialVersionUID = -9080356227094128542L;
+
+  public CannotReadFileException(Throwable cause) {
+    super(cause);
+  }
+}

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

@@ -17,24 +17,19 @@
 
 package pl.project13.core;
 
-import com.fasterxml.jackson.core.type.TypeReference;
-import com.fasterxml.jackson.databind.MapperFeature;
-import com.fasterxml.jackson.databind.ObjectMapper;
 import nu.studer.java.util.OrderedProperties;
 import org.sonatype.plexus.build.incremental.BuildContext;
 import pl.project13.core.log.LoggerBridge;
+import pl.project13.core.util.JsonManager;
 
 import javax.annotation.Nonnull;
 import java.io.*;
 import java.nio.charset.Charset;
 import java.nio.file.Files;
 import java.util.Comparator;
-import java.util.HashMap;
-import java.util.Map;
 import java.util.Properties;
 
 public class PropertiesFileGenerator {
-  private static final ObjectMapper MAPPER = new ObjectMapper().enable(MapperFeature.BLOCK_UNSAFE_POLYMORPHIC_BASE_TYPES);
 
   private LoggerBridge log;
   private BuildContext buildContext;
@@ -63,11 +58,9 @@ public void maybeGeneratePropertiesFile(@Nonnull Properties localProperties, Fil
         try {
           if (isJsonFormat) {
             log.info("Reading existing json file [{}] (for module {})...", gitPropsFile.getAbsolutePath(), projectName);
-
-            persistedProperties = readJsonProperties(gitPropsFile, sourceCharset);
+            persistedProperties = JsonManager.readJsonProperties(gitPropsFile, sourceCharset);
           } else {
             log.info("Reading existing properties file [{}] (for module {})...", gitPropsFile.getAbsolutePath(), projectName);
-
             persistedProperties = readProperties(gitPropsFile, sourceCharset);
           }
 
@@ -89,16 +82,11 @@ public void maybeGeneratePropertiesFile(@Nonnull Properties localProperties, Fil
       if (shouldGenerate) {
         Files.createDirectories(gitPropsFile.getParentFile().toPath());
         try (OutputStream outputStream = new FileOutputStream(gitPropsFile)) {
-          OrderedProperties sortedLocalProperties = new OrderedProperties.OrderedPropertiesBuilder()
-                  .withSuppressDateInComment(true)
-                  .withOrdering(Comparator.nullsLast(Comparator.naturalOrder()))
-                  .build();
+          OrderedProperties sortedLocalProperties = PropertiesFileGenerator.createOrderedProperties();
           localProperties.forEach((key, value) -> sortedLocalProperties.setProperty((String) key, (String) value));
           if (isJsonFormat) {
-            try (Writer outputWriter = new OutputStreamWriter(outputStream, sourceCharset)) {
-              log.info("Writing json file to [{}] (for module {})...", gitPropsFile.getAbsolutePath(), projectName);
-              MAPPER.writerWithDefaultPrettyPrinter().writeValue(outputWriter, sortedLocalProperties);
-            }
+            log.info("Writing json file to [{}] (for module {})...", gitPropsFile.getAbsolutePath(), projectName);
+            JsonManager.dumpJson(outputStream, sortedLocalProperties, sourceCharset);
           } else {
             log.info("Writing properties file to [{}] (for module {})...", gitPropsFile.getAbsolutePath(), projectName);
             // using outputStream directly instead of outputWriter this way the UTF-8 characters appears in unicode escaped form
@@ -120,6 +108,13 @@ public void maybeGeneratePropertiesFile(@Nonnull Properties localProperties, Fil
     }
   }
 
+  public static OrderedProperties createOrderedProperties() {
+    return new OrderedProperties.OrderedPropertiesBuilder()
+            .withSuppressDateInComment(true)
+            .withOrdering(Comparator.nullsLast(Comparator.naturalOrder()))
+            .build();
+  }
+
   public static File craftPropertiesOutputFile(File base, String propertiesFilename) {
     File returnPath = new File(base, propertiesFilename);
 
@@ -131,29 +126,6 @@ public static File craftPropertiesOutputFile(File base, String propertiesFilenam
     return returnPath;
   }
 
-  private Properties readJsonProperties(@Nonnull File jsonFile, Charset sourceCharset) throws CannotReadFileException {
-    final HashMap<String, Object> propertiesMap;
-
-    try (final FileInputStream fis = new FileInputStream(jsonFile)) {
-      try (final InputStreamReader reader = new InputStreamReader(fis, sourceCharset)) {
-        final TypeReference<HashMap<String, Object>> mapTypeRef =
-                new TypeReference<HashMap<String, Object>>() {};
-
-        propertiesMap = MAPPER.readValue(reader, mapTypeRef);
-      }
-    } catch (final Exception ex) {
-      throw new CannotReadFileException(ex);
-    }
-
-    final Properties retVal = new Properties();
-
-    for (final Map.Entry<String, Object> entry : propertiesMap.entrySet()) {
-      retVal.setProperty(entry.getKey(), String.valueOf(entry.getValue()));
-    }
-
-    return retVal;
-  }
-
   private Properties readProperties(@Nonnull File propertiesFile, Charset sourceCharset) throws CannotReadFileException {
     try (final FileInputStream fis = new FileInputStream(propertiesFile)) {
       try (final InputStreamReader reader = new InputStreamReader(fis, sourceCharset)) {
@@ -165,12 +137,4 @@ private Properties readProperties(@Nonnull File propertiesFile, Charset sourceCh
       throw new CannotReadFileException(ex);
     }
   }
-
-  static class CannotReadFileException extends Exception {
-    private static final long serialVersionUID = -6290782570018307756L;
-
-    CannotReadFileException(Throwable cause) {
-      super(cause);
-    }
-  }
 }

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

@@ -0,0 +1,72 @@
+/*
+ * This file is part of git-commit-id-plugin by Konrad 'ktoso' Malawski <konrad.malawski@java.pl>
+ *
+ * git-commit-id-plugin 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 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.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package pl.project13.core.util;
+
+import nu.studer.java.util.OrderedProperties;
+import pl.project13.core.CannotReadFileException;
+
+import javax.annotation.Nonnull;
+import javax.json.Json;
+import javax.json.JsonReader;
+import javax.json.JsonString;
+import javax.json.stream.JsonGenerator;
+import javax.json.stream.JsonGeneratorFactory;
+import java.io.*;
+import java.nio.charset.Charset;
+import java.util.Collections;
+import java.util.Map;
+import java.util.Properties;
+
+public class JsonManager {
+  public static void dumpJson(OutputStream outputStream, OrderedProperties sortedLocalProperties, Charset sourceCharset) throws IOException {
+    JsonGeneratorFactory jgf = Json.createGeneratorFactory(
+            Collections.singletonMap(JsonGenerator.PRETTY_PRINTING, true));
+
+    try (Writer outputWriter = new OutputStreamWriter(outputStream, sourceCharset)) {
+      JsonGenerator jg = jgf.createGenerator(outputWriter);
+      jg.writeStartObject();
+
+      for (Map.Entry e : sortedLocalProperties.entrySet()) {
+        jg.write((String) e.getKey(), (String) e.getValue());
+      }
+      jg.writeEnd();
+      jg.close();
+    }
+
+  }
+
+  public static Properties readJsonProperties(@Nonnull File jsonFile, Charset sourceCharset) throws CannotReadFileException {
+    Properties retVal = new Properties();
+    try (FileInputStream fis = new FileInputStream(jsonFile)) {
+      try (InputStreamReader reader = new InputStreamReader(fis, sourceCharset)) {
+        try (JsonReader jsonReader = Json.createReader(reader)) {
+          jsonReader.readObject().forEach((key, val) -> {
+            if (val instanceof JsonString) {
+              retVal.setProperty(key, ((JsonString) val).getString());
+            } else {
+              // TODO warning?
+            }
+          });
+        }
+      }
+    } catch (IOException e) {
+      throw new CannotReadFileException(e);
+    }
+    return retVal;
+  }
+}