refactor!: now using yaml instead of json

Author: quintesse

.gitignore

@@ -2,6 +2,7 @@ target/
 !.mvn/wrapper/maven-wrapper.jar
 !**/src/main/**/target/
 !**/src/test/**/target/
+deps/
 
 ### IntelliJ IDEA ###
 .idea/
@@ -36,4 +37,4 @@ build/
 .vscode/
 
 ### Mac OS ###
-.DS_Store
+.DS_Store

README.md

@@ -59,7 +59,7 @@ Let's see what that did:
 ```shell
 $ tree
 .
-├── app.json
+├── app.yml
 ├── deps
 │   └── jfiglet-0.0.9.jar -> /home/user/.m2/repository/com/github/lalyos/jfiglet/0.0.9/jfiglet-0.0.9.jar
 └── HelloWorld.java
@@ -79,13 +79,13 @@ $ javac -cp deps/* HelloWorld.java
  |_| |_|\___|_|_|\___( )    \_/\_/ \___/|_|  |_|\__,_(_)
 ```
 
-But if we look again at the above output of `tree`, we also see an `app.json` file.
+But if we look again at the above output of `tree`, we also see an `app.yml` file.
 This file is used by `jpm` to keep track of the dependencies of your project. If you want to share your project
-with someone else, you can simply share the `app.json` file along with the code, and they can run `jpm install`
+with someone else, you can simply share the `app.yml` file along with the code, and they can run `jpm install`
 to get the required dependencies to run the code.
 
 _NB: We could have used `jpm copy` instead of `jpm install` to copy the dependencies but that would not have created
-the `app.json` file._
+the `app.yml` file._
 
 ### JBang
 
@@ -123,20 +123,20 @@ Commands:
                 jpm search httpclient
 
   install, i  This adds the given artifacts to the list of dependencies
-                available in the app.json file. It then behaves just like 'copy
+                available in the app.yml file. It then behaves just like 'copy
                 --sync' and copies all artifacts in that list and all their
                 dependencies to the target directory while at the same time
                 removing any artifacts that are no longer needed (ie the ones
-                that are not mentioned in the app.json file). If no artifacts
-                are passed the app.json file will be left untouched and only
+                that are not mentioned in the app.yml file). If no artifacts
+                are passed the app.yml file will be left untouched and only
                 the existing dependencies in the file will be copied.
 
               Example:
                 jpm install org.apache.httpcomponents:httpclient:4.5.14
 
   path, p     Resolves one or more artifacts and prints the full classpath to
                 standard output. If no artifacts are passed the classpath for
-                the dependencies defined in the app.json file will be printed
+                the dependencies defined in the app.yml file will be printed
                 instead.
 
               Example:

app.json

@@ -0,0 +1,10 @@
+dependencies:
+  eu.maveniverse.maven.mima:context: "2.4.15"
+  eu.maveniverse.maven.mima.runtime:standalone-static: "2.4.15"
+  info.picocli:picocli: "4.7.6"
+  org.yaml:snakeyaml: "2.3"
+  org.jline:jline-console-ui: "3.29.0"
+  org.jline:jline-terminal-jni: "3.29.0"
+  org.slf4j:slf4j-api: "2.0.13"
+  org.slf4j:slf4j-log4j12: "2.0.13"
+  org.slf4j:slf4j-simple: "2.0.13"

app.yml

@@ -34,7 +34,7 @@
         <mainClass>org.codejive.jpm.Main</mainClass>
         <version.mima>2.4.15</version.mima>
         <version.picocli>4.7.6</version.picocli>
-        <version.gson>2.11.0</version.gson>
+        <version.snakeyaml>2.3</version.snakeyaml>
         <version.jline>3.29.0</version.jline>
         <version.slf4j>2.0.13</version.slf4j>
         <version.spotless>2.43.0</version.spotless>
@@ -58,9 +58,9 @@
             <version>${version.picocli}</version>
         </dependency>
         <dependency>
-            <groupId>com.google.code.gson</groupId>
-            <artifactId>gson</artifactId>
-            <version>${version.gson}</version>
+            <groupId>org.yaml</groupId>
+            <artifactId>snakeyaml</artifactId>
+            <version>${version.snakeyaml}</version>
         </dependency>
         <dependency>
             <groupId>org.jline</groupId>

pom.xml

@@ -106,8 +106,8 @@ private static String artifactGav(Artifact artifact) {
 
     /**
      * Installs the given artifacts to the target directory while also registering them as
-     * dependencies in the app.json file in the current directory. If no artifacts are given, all
-     * dependencies in the app.json file will be installed. NB: "installation" in this context
+     * dependencies in the app.yml file in the current directory. If no artifacts are given, all
+     * dependencies in the app.yml file will be installed. NB: "installation" in this context
      * basically means sync-copying the artifacts to the target directory.
      *
      * @param artifactNames The artifacts to install.
@@ -139,7 +139,7 @@ public SyncStats install(String[] artifactNames)
 
     /**
      * Returns the paths of the given artifacts. If no artifacts are given, the paths for all
-     * dependencies in the app.json file will be returned instead.
+     * dependencies in the app.yml file will be returned instead.
      *
      * @param artifactNames The artifacts to get the paths for.
      * @return A list of paths.

src/main/java/org/codejive/jpm/Jpm.java

@@ -153,7 +153,7 @@ public Integer call() throws Exception {
                             break;
                         }
                         String finalAction = selectFinalAction(prompt);
-                        if ("quit".equals(finalAction)) {
+                        if (!"again".equals(finalAction)) {
                             break;
                         }
                         artifactPattern = null;
@@ -238,12 +238,12 @@ String selectFinalAction(ConsolePrompt prompt) throws IOException {
                     .createListPrompt()
                     .name("action")
                     .message("Next step:")
-                    .newItem("again")
-                    .text("Search again")
-                    .add()
                     .newItem("quit")
                     .text("Quit")
                     .add()
+                    .newItem("again")
+                    .text("Search again")
+                    .add()
                     .addPrompt();
             Map<String, PromptResultItemIF> result = prompt.prompt(promptBuilder.build());
             return getSelectedId(result, "action");
@@ -259,9 +259,9 @@ private static String getSelectedId(
             name = "install",
             aliases = {"i"},
             description =
-                    "This adds the given artifacts to the list of dependencies available in the app.json file. "
-                            + "It then behaves just like 'copy --sync' and copies all artifacts in that list and all their dependencies to the target directory while at the same time removing any artifacts that are no longer needed (ie the ones that are not mentioned in the app.json file). "
-                            + "If no artifacts are passed the app.json file will be left untouched and only the existing dependencies in the file will be copied.\n\n"
+                    "This adds the given artifacts to the list of dependencies available in the app.yml file. "
+                            + "It then behaves just like 'copy --sync' and copies all artifacts in that list and all their dependencies to the target directory while at the same time removing any artifacts that are no longer needed (ie the ones that are not mentioned in the app.yml file). "
+                            + "If no artifacts are passed the app.yml file will be left untouched and only the existing dependencies in the file will be copied.\n\n"
                             + "Example:\n  jpm install org.apache.httpcomponents:httpclient:4.5.14\n")
     static class Install implements Callable<Integer> {
         @Mixin QuietMixin quietMixin;
@@ -287,7 +287,7 @@ public Integer call() throws Exception {
             aliases = {"p"},
             description =
                     "Resolves one or more artifacts and prints the full classpath to standard output. "
-                            + "If no artifacts are passed the classpath for the dependencies defined in the app.json file will be printed instead.\n\n"
+                            + "If no artifacts are passed the classpath for the dependencies defined in the app.yml file will be printed instead.\n\n"
                             + "Example:\n  jpm path org.apache.httpcomponents:httpclient:4.5.14\n")
     static class PrintPath implements Callable<Integer> {
         @Mixin OptionalArtifactsMixin optionalArtifactsMixin;

src/main/java/org/codejive/jpm/Main.java

@@ -1,7 +1,5 @@
 package org.codejive.jpm.json;
 
-import com.google.gson.Gson;
-import com.google.gson.GsonBuilder;
 import java.io.IOException;
 import java.io.Reader;
 import java.io.Writer;
@@ -10,17 +8,19 @@
 import java.nio.file.Paths;
 import java.util.Map;
 import java.util.TreeMap;
+import org.yaml.snakeyaml.DumperOptions;
+import org.yaml.snakeyaml.Yaml;
 
 /**
- * Represents the contents of an app.json file. There are methods for reading and writing instances
+ * Represents the contents of an app.yml file. There are methods for reading and writing instances
  * from/to files.
  */
 public class AppInfo {
-    private Map<String, Object> json = new TreeMap<>();
+    private Map<String, Object> yaml = new TreeMap<>();
     public Map<String, String> dependencies = new TreeMap<>();
 
-    /** The official name of the app.json file. */
-    public static final String APP_INFO_FILE = "app.json";
+    /** The official name of the app.yml file. */
+    public static final String APP_INFO_FILE = "app.yml";
 
     /**
      * Returns the dependencies as an array of strings in the format "groupId:artifactId:version".
@@ -34,8 +34,7 @@ public String[] getDependencyGAVs() {
     }
 
     /**
-     * Reads the app.json file in the current directory and returns its content as an AppInfo
-     * object.
+     * Reads the app.yml file in the current directory and returns its content as an AppInfo object.
      *
      * @return An instance of AppInfo
      * @throws IOException if an error occurred while reading or parsing the file
@@ -45,33 +44,39 @@ public static AppInfo read() throws IOException {
         AppInfo appInfo = new AppInfo();
         if (Files.isRegularFile(prjJson)) {
             try (Reader in = Files.newBufferedReader(prjJson)) {
-                Gson parser = new GsonBuilder().create();
-                appInfo.json = parser.fromJson(in, Map.class);
+                Yaml yaml = new Yaml();
+                appInfo.yaml = yaml.load(in);
             }
         } else {
             appInfo = new AppInfo();
         }
         // WARNING awful code ahead
-        if (appInfo.json.containsKey("dependencies")
-                && appInfo.json.get("dependencies") instanceof Map) {
-            appInfo.dependencies.putAll((Map<String, String>) appInfo.json.get("dependencies"));
+        if (appInfo.yaml.containsKey("dependencies")
+                && appInfo.yaml.get("dependencies") instanceof Map) {
+            Map<String, Object> deps = (Map<String, Object>) appInfo.yaml.get("dependencies");
+            for (Map.Entry<String, Object> entry : deps.entrySet()) {
+                appInfo.dependencies.put(entry.getKey(), entry.getValue().toString());
+            }
         }
         return appInfo;
     }
 
     /**
-     * Writes the AppInfo object to the app.json file in the current directory.
+     * Writes the AppInfo object to the app.yml file in the current directory.
      *
      * @param appInfo The AppInfo object to write
      * @throws IOException if an error occurred while writing the file
      */
     public static void write(AppInfo appInfo) throws IOException {
         Path prjJson = Paths.get(APP_INFO_FILE);
         try (Writer out = Files.newBufferedWriter(prjJson)) {
-            Gson parser = new GsonBuilder().setPrettyPrinting().create();
+            DumperOptions dopts = new DumperOptions();
+            dopts.setDefaultFlowStyle(DumperOptions.FlowStyle.BLOCK);
+            dopts.setPrettyFlow(true);
+            Yaml yaml = new Yaml(dopts);
             // WARNING awful code ahead
-            appInfo.json.put("dependencies", (Map<String, Object>) (Map) appInfo.dependencies);
-            parser.toJson(appInfo.json, out);
+            appInfo.yaml.put("dependencies", (Map<String, Object>) (Map) appInfo.dependencies);
+            yaml.dump(appInfo.yaml, out);
         }
     }
 }

src/main/java/org/codejive/jpm/json/AppInfo.java

@@ -1,7 +1,5 @@
 package org.codejive.jpm.util;
 
-import com.google.gson.Gson;
-import com.google.gson.GsonBuilder;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.InputStreamReader;
@@ -13,6 +11,11 @@
 import org.apache.http.impl.client.CloseableHttpClient;
 import org.apache.http.impl.client.HttpClients;
 import org.eclipse.aether.artifact.DefaultArtifact;
+import org.yaml.snakeyaml.DumperOptions;
+import org.yaml.snakeyaml.LoaderOptions;
+import org.yaml.snakeyaml.Yaml;
+import org.yaml.snakeyaml.constructor.Constructor;
+import org.yaml.snakeyaml.representer.Representer;
 
 /** Utility class for searching Maven artifacts. */
 public class SearchUtils {
@@ -81,10 +84,14 @@ private static SearchResult select(String query, int start, int count) throws IO
         try (CloseableHttpClient httpClient = HttpClients.custom().setUserAgent(agent).build()) {
             HttpGet request = new HttpGet(searchUrl);
             try (CloseableHttpResponse response = httpClient.execute(request)) {
-                Gson gson = new GsonBuilder().create();
+                DumperOptions dopts = new DumperOptions();
+                Constructor cons = new Constructor(MvnSearchResult.class, new LoaderOptions());
+                Representer representer = new Representer(dopts);
+                representer.getPropertyUtils().setSkipMissingProperties(true);
+                Yaml yaml = new Yaml(cons, representer, dopts);
                 InputStream ins = response.getEntity().getContent();
                 InputStreamReader rdr = new InputStreamReader(ins);
-                MvnSearchResult result = gson.fromJson(rdr, MvnSearchResult.class);
+                MvnSearchResult result = yaml.load(rdr);
                 if (result.responseHeader.status != 0) {
                     throw new IOException("Search failed");
                 }