Finish import use case

MstrPikachu · MstrPikachu · commit ab44cff48092 · 2022-12-07T21:47:13.000-05:00
diff --git a/src/main/java/org/hydev/mcpm/client/arguments/CommandsFactory.java b/src/main/java/org/hydev/mcpm/client/arguments/CommandsFactory.java
@@ -59,7 +59,7 @@ public static List<CommandParser> baseParsers(boolean isMinecraft) {
         var updater = new UpdateInteractor(updateChecker, installer, tracker);
 
         // Controllers
-        var exportPluginsController = new ExportPluginsController(
+        var exportPluginsController = new ExportController(
                 new ExportInteractor(tracker), new LogExportPresenter());
         var listController = new ListController(new ListAllInteractor(tracker));
         var searchController = new SearchPackagesController(searcher, pager);
diff --git a/src/main/java/org/hydev/mcpm/client/arguments/parsers/ExportPluginsParser.java b/src/main/java/org/hydev/mcpm/client/arguments/parsers/ExportPluginsParser.java
@@ -2,7 +2,7 @@
 
 import net.sourceforge.argparse4j.inf.Namespace;
 import net.sourceforge.argparse4j.inf.Subparser;
-import org.hydev.mcpm.client.commands.controllers.ExportPluginsController;
+import org.hydev.mcpm.client.commands.controllers.ExportController;
 import org.hydev.mcpm.client.export.ExportPluginsInput;
 
 import java.util.function.Consumer;
@@ -12,9 +12,9 @@
  */
 public class ExportPluginsParser implements CommandParser
 {
-    private final ExportPluginsController controller;
+    private final ExportController controller;
 
-    public ExportPluginsParser(ExportPluginsController controller)
+    public ExportPluginsParser(ExportController controller)
     {
         this.controller = controller;
     }
diff --git a/src/main/java/org/hydev/mcpm/client/arguments/parsers/ImportParser.java b/src/main/java/org/hydev/mcpm/client/arguments/parsers/ImportParser.java
@@ -0,0 +1,31 @@
+package org.hydev.mcpm.client.arguments.parsers;
+
+import net.sourceforge.argparse4j.inf.Namespace;
+import net.sourceforge.argparse4j.inf.Subparser;
+
+import java.util.function.Consumer;
+
+/**
+ * Parser for the import use case
+ */
+public class ImportParser implements CommandParser {
+    @Override
+    public String name() {
+        return "import";
+    }
+
+    @Override
+    public String description() {
+        return "Import a plugins config from a previous export";
+    }
+
+    @Override
+    public void configure(Subparser parser) {
+
+    }
+
+    @Override
+    public void run(Namespace details, Consumer<String> log) {
+
+    }
+}
diff --git a/src/main/java/org/hydev/mcpm/client/commands/controllers/ExportController.java b/src/main/java/org/hydev/mcpm/client/commands/controllers/ExportController.java
@@ -12,7 +12,7 @@
  * @param boundary The export implementation
  * @param presenter The presenter to show the result
  */
-public record ExportPluginsController(
+public record ExportController(
         ExportPluginsBoundary boundary,
         ExportPresenter presenter
 ) {
diff --git a/src/main/java/org/hydev/mcpm/client/commands/controllers/ImportController.java b/src/main/java/org/hydev/mcpm/client/commands/controllers/ImportController.java
@@ -0,0 +1,30 @@
+package org.hydev.mcpm.client.commands.controllers;
+
+import org.hydev.mcpm.client.commands.presenters.ImportPresenter;
+import org.hydev.mcpm.client.export.ImportInput;
+import org.hydev.mcpm.client.export.ImportPluginsBoundary;
+
+import java.util.function.Consumer;
+
+/**
+ * Controller for the import use case.
+ *
+ * @param boundary The boundary used to import
+ * @param presenter The presenter to display the result
+ */
+public record ImportController(
+        ImportPluginsBoundary boundary,
+        ImportPresenter presenter
+) {
+
+    /**
+     * Import the plugins.
+     *
+     * @param input Specification of where to import from
+     * @param log The log to write to
+     */
+    public void importPlugins(ImportInput input, Consumer<String> log) {
+        var result = boundary.importPlugins(input);
+        presenter.present(result, log);
+    }
+}
diff --git a/src/main/java/org/hydev/mcpm/client/commands/presenters/ImportPresenter.java b/src/main/java/org/hydev/mcpm/client/commands/presenters/ImportPresenter.java
@@ -0,0 +1,18 @@
+package org.hydev.mcpm.client.commands.presenters;
+
+import org.hydev.mcpm.client.export.ImportResult;
+
+import java.util.function.Consumer;
+
+/**
+ * Interface for displaying the results of an import
+ */
+public interface ImportPresenter {
+
+    /**
+     * Present the result of the import
+     *
+     * @param result the result to present
+     */
+    void present(ImportResult result, Consumer<String> log);
+}
diff --git a/src/main/java/org/hydev/mcpm/client/display/presenters/LogExportPresenter.java b/src/main/java/org/hydev/mcpm/client/display/presenters/LogExportPresenter.java
@@ -10,16 +10,16 @@
  */
 public class LogExportPresenter implements ExportPresenter {
 
-    private String getColor(ExportPluginsResult exportPluginsResult) {
-        return switch (exportPluginsResult.state()) {
+    private String getColor(ExportPluginsResult result) {
+        return switch (result.state()) {
             case SUCCESS -> "&a";
             case FAILED_TO_FETCH_PLUGINS -> "&c";
         };
     }
 
-    private String getMessage(ExportPluginsResult exportPluginsResult) {
-        return switch ((exportPluginsResult.state())) {
-            case SUCCESS -> "Exported to " + exportPluginsResult.export();
+    private String getMessage(ExportPluginsResult result) {
+        return switch ((result.state())) {
+            case SUCCESS -> "Exported to " + result.export();
             case FAILED_TO_FETCH_PLUGINS -> "Export failed to fetch plugins";
         };
     }
diff --git a/src/main/java/org/hydev/mcpm/client/display/presenters/LogImportPresenter.java b/src/main/java/org/hydev/mcpm/client/display/presenters/LogImportPresenter.java
@@ -0,0 +1,36 @@
+package org.hydev.mcpm.client.display.presenters;
+
+import org.hydev.mcpm.client.commands.presenters.ImportPresenter;
+import org.hydev.mcpm.client.export.ImportResult;
+
+import java.util.function.Consumer;
+
+/**
+ * ImportPresenter that writes to a log
+ */
+public class LogImportPresenter implements ImportPresenter {
+
+    private String getColor(ImportResult result) {
+        return switch (result.state()) {
+            case SUCCESS -> "&a";
+            case PARTIAL_SUCCESS -> "&6";
+            case FAILURE -> "&c";
+            case IMPORT_ERROR -> "&4";
+        };
+    }
+
+    private String getMessage(ImportResult result) {
+        return switch (result.state()) {
+            case SUCCESS -> "All plugins installed";
+            case PARTIAL_SUCCESS -> "Some plugins failed to install:\n"
+                    + String.join("\n", result.noninstalledPlugins);
+            case FAILURE -> "All plugins failed to install";
+            case IMPORT_ERROR -> "Import failed. " + result.error;
+        };
+    }
+
+    @Override
+    public void present(ImportResult result, Consumer<String> log) {
+        log.accept(getColor(result) + getMessage(result));
+    }
+}
diff --git a/src/main/java/org/hydev/mcpm/client/export/ImportInput.java b/src/main/java/org/hydev/mcpm/client/export/ImportInput.java
@@ -0,0 +1,13 @@
+package org.hydev.mcpm.client.export;
+
+/**
+ * The input for the import use case.
+ *
+ * @param type The type of the import source (pastebin, file, etc)
+ * @param input The location of the input
+ */
+public record ImportInput(
+        String type,
+        String input
+) {
+}
diff --git a/src/main/java/org/hydev/mcpm/client/export/ImportInteractor.java b/src/main/java/org/hydev/mcpm/client/export/ImportInteractor.java
@@ -2,27 +2,30 @@
 
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.core.type.TypeReference;
-import org.hydev.mcpm.client.commands.presenters.InstallResultPresenter;
+import org.hydev.mcpm.client.export.storage.StringStorage;
+import org.hydev.mcpm.client.export.storage.StringStorageFactory;
 import org.hydev.mcpm.client.installer.InstallBoundary;
-import org.hydev.mcpm.client.installer.InstallResult;
 import org.hydev.mcpm.client.installer.input.InstallInput;
 import org.hydev.mcpm.client.search.SearchPackagesType;
 import org.hydev.mcpm.utils.Pair;
 
+import java.io.IOException;
 import java.util.List;
 
 import static org.hydev.mcpm.Constants.JACKSON;
 
 /**
  * Default implementation of ImportPluginsBoundary
  *
- * @param install the install boundary
+ * @param install the installer boundary
  */
 public record ImportInteractor(InstallBoundary install) implements ImportPluginsBoundary {
     @Override
-    public ImportResult importPlugins(String input) throws ImportException {
+    public ImportResult importPlugins(ImportInput input) {
         try {
-            var plugins = JACKSON.readValue(input, new TypeReference<List<ExportModel>>() { });
+            StringStorage storage = StringStorageFactory.createStringStorage(input);
+            String json = storage.load(input.input());
+            var plugins = JACKSON.readValue(json, new TypeReference<List<ExportModel>>() { });
             // TODO: Install specific versions
             var results = plugins.stream()
                     .map(p -> new Pair<>(p.name(),
@@ -34,7 +37,10 @@ public ImportResult importPlugins(String input) throws ImportException {
 
             return new ImportResult(results);
         } catch (JsonProcessingException e) {
-            throw new ImportException(e);
+            return new ImportResult("Import source is invalid or corrupted.");
+        } catch (IOException e) {
+            return new ImportResult("Unable to read from import source." +
+                    " Check if you imported from the right source.");
         }
     }
 }
diff --git a/src/main/java/org/hydev/mcpm/client/export/ImportPluginsBoundary.java b/src/main/java/org/hydev/mcpm/client/export/ImportPluginsBoundary.java
@@ -2,16 +2,13 @@
 
 /**
  * Defines how a user can export their plugins.
- *
- * @author Peter (https://github.com/MstrPikachu)
- * @since 2022-11-19
  */
 public interface ImportPluginsBoundary {
     /**
      * Install and load the plugins
      *
-     * @param input The plugins to import
+     * @param input Specification of where to import from
      * @return Whether the export was successful or not
      */
-    ImportResult importPlugins(String input) throws ImportException;
+    ImportResult importPlugins(ImportInput input);
 }
diff --git a/src/main/java/org/hydev/mcpm/client/export/ImportResult.java b/src/main/java/org/hydev/mcpm/client/export/ImportResult.java
@@ -1,14 +1,19 @@
 package org.hydev.mcpm.client.export;
 
+import java.util.ArrayList;
+import java.util.List;
 import java.util.Map;
 
 
 /**
- * Class storing results of the
+ * Class storing results of the import for each imported plugin
  */
 public class ImportResult {
-    private final State state;
+    private State state;
     private final Map<String, Boolean> installResults;
+    public final List<String> noninstalledPlugins;
+    public final String error;
+
 
     /**
      * Result for importing plugins
@@ -17,6 +22,9 @@ public class ImportResult {
      */
     public ImportResult(Map<String, Boolean> installResults) {
         this.installResults = installResults;
+        noninstalledPlugins = new ArrayList<>();
+        error = null;
+
         boolean success = true;
         boolean fail = false;
 
@@ -28,33 +36,51 @@ public ImportResult(Map<String, Boolean> installResults) {
         }
          */
 
-        for (var x : installResults.values()) {
-            success &= x;
-            fail |= x;
+        for (var x : installResults.entrySet()) {
+            success &= x.getValue();
+            fail |= x.getValue();
+
+            if (!x.getValue()) {
+                noninstalledPlugins.add(x.getKey());
+            }
+
             if (!success && fail) { // not a full success nor full failure
                 state = State.PARTIAL_SUCCESS;
-                return;
             }
         }
-        state = success ? State.SUCCESS : State.FAILURE;
+
+        if (state == null)
+            state = success ? State.SUCCESS : State.FAILURE;
     }
 
+    /**
+     * ImportResult constructor with the given error message
+     *
+     * @param error The error message
+     */
+    public ImportResult(String error) {
+        this.error = error;
+        state = State.IMPORT_ERROR;
+        noninstalledPlugins = null;
+        installResults = null;
+    }
 
     /**
-     * State of a single import
+     * Aggregate state of install
      */
     public enum State {
         SUCCESS,
         PARTIAL_SUCCESS,
-        FAILURE
+        FAILURE,
+        IMPORT_ERROR
     }
 
     /**
      * Infer the state from the state of the installation results
      *
      * @return Overall state of the import
      */
-    public State getState()
+    public State state()
     {
         return state;
     }
diff --git a/src/main/java/org/hydev/mcpm/client/export/storage/StringStorageFactory.java b/src/main/java/org/hydev/mcpm/client/export/storage/StringStorageFactory.java
@@ -1,6 +1,7 @@
 package org.hydev.mcpm.client.export.storage;
 
 import org.hydev.mcpm.client.export.ExportPluginsInput;
+import org.hydev.mcpm.client.export.ImportInput;
 
 
 /**
@@ -23,4 +24,21 @@ public static StringStorage createStringStorage(ExportPluginsInput input) {
             default -> throw new IllegalArgumentException("Invalid output type");
         };
     }
+
+    /**
+     * Create a StringStorage based on the input type.
+     *
+     * @param input The input query
+     * @return a StringStorage satisfying the query
+     */
+    public static StringStorage createStringStorage(ImportInput input) {
+        return switch (input.type()) {
+            case "file" -> input.input() == null ?
+                    new FixedFileStorage("export.json") : new FixedFileStorage(input.input());
+
+            case "pastebin" -> input.input() == null ? new PasteBinStorage() : new PasteBinStorage(input.input());
+            case "literal" -> new StringLiteralStorage();
+            default -> throw new IllegalArgumentException("Invalid input type");
+        };
+    }
 }
diff --git a/src/test/java/org/hydev/mcpm/client/export/ExportInteractorTest.java b/src/test/java/org/hydev/mcpm/client/export/ExportInteractorTest.java

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`import net.sourceforge.argparse4j.inf.Namespace;`
`4`	`4`	`import net.sourceforge.argparse4j.inf.Subparser;`
`5`		`-import org.hydev.mcpm.client.commands.controllers.ExportPluginsController;`
	`5`	`+import org.hydev.mcpm.client.commands.controllers.ExportController;`
`6`	`6`	`import org.hydev.mcpm.client.export.ExportPluginsInput;`
`7`	`7`
`8`	`8`	`import java.util.function.Consumer;`
`@@ -12,9 +12,9 @@`
`12`	`12`	`*/`
`13`	`13`	`public class ExportPluginsParser implements CommandParser`
`14`	`14`	`{`
`15`		`- private final ExportPluginsController controller;`
	`15`	`+ private final ExportController controller;`
`16`	`16`
`17`		`- public ExportPluginsParser(ExportPluginsController controller)`
	`17`	`+ public ExportPluginsParser(ExportController controller)`
`18`	`18`	`{`
`19`	`19`	`this.controller = controller;`
`20`	`20`	`}`