feat: added --cache/-c for setting cache folder

This as an alternative to the `JPM_CACHE` environment variable.

Author: quintesse

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

@@ -15,12 +15,14 @@ public class Jpm {
     private final Path directory;
     private final boolean noLinks;
     private final Path appFile;
+    private final Path cacheDir;
     private final boolean verbose;
 
-    private Jpm(Path directory, boolean noLinks, Path appFile, boolean verbose) {
+    private Jpm(Path directory, boolean noLinks, Path appFile, Path cacheDir, boolean verbose) {
         this.directory = directory;
         this.noLinks = noLinks;
         this.appFile = appFile;
+        this.cacheDir = cacheDir;
         this.verbose = verbose;
     }
 
@@ -38,6 +40,7 @@ public static class Builder {
         private Path directory;
         private boolean noLinks;
         private Path appFile;
+        private Path cacheDir;
         private boolean verbose;
 
         private Builder() {}
@@ -75,6 +78,17 @@ public Builder appFile(Path appFile) {
             return this;
         }
 
+        /**
+         * Set the cache directory to use for downloaded artifacts.
+         *
+         * @param cacheDir The cache directory.
+         * @return The builder instance for chaining.
+         */
+        public Builder cacheDir(Path cacheDir) {
+            this.cacheDir = cacheDir;
+            return this;
+        }
+
         /**
          * Set whether to enable verbose output or not.
          *
@@ -92,7 +106,7 @@ public Builder verbose(boolean verbose) {
          * @return A {@link Jpm} instance.
          */
         public Jpm build() {
-            return new Jpm(directory, noLinks, appFile, verbose);
+            return new Jpm(directory, noLinks, appFile, cacheDir, verbose);
         }
     }
 
@@ -122,7 +136,7 @@ public SyncResult copy(String[] artifactNames, boolean sync)
      */
     public SyncResult copy(String[] artifactNames, Map<String, String> repos, boolean sync)
             throws IOException, DependencyResolutionException {
-        List<Path> files = Resolver.create(artifactNames, repos).resolvePaths();
+        List<Path> files = Resolver.create(artifactNames, repos, cacheDir).resolvePaths();
         return FileUtils.syncArtifacts(files, directory, noLinks, !sync);
     }
 
@@ -197,7 +211,7 @@ public SyncResult install(String[] artifactNames, Map<String, String> extraRepos
         String[] artifacts = getArtifacts(artifactNames, appInfo);
         Map<String, String> repos = getRepositories(extraRepos, appInfo);
         if (artifacts.length > 0) {
-            List<Path> files = Resolver.create(artifacts, repos).resolvePaths();
+            List<Path> files = Resolver.create(artifacts, repos, cacheDir).resolvePaths();
             SyncResult stats = FileUtils.syncArtifacts(files, directory, noLinks, true);
             if (artifactNames.length > 0) {
                 appInfo.dependencies().addAll(Arrays.asList(artifactNames));
@@ -240,7 +254,7 @@ public List<Path> path(String[] artifactNames, Map<String, String> extraRepos)
         String[] deps = getArtifacts(artifactNames, appInfo);
         Map<String, String> repos = getRepositories(extraRepos, appInfo);
         if (deps.length > 0) {
-            List<Path> files = Resolver.create(deps, repos).resolvePaths();
+            List<Path> files = Resolver.create(deps, repos, cacheDir).resolvePaths();
             if (artifactNames.length > 0) {
                 return files;
             } else {
@@ -280,6 +294,23 @@ private Map<String, String> getRepositories(Map<String, String> extraRepos, AppI
      */
     public int executeAction(String actionName, List<String> args)
             throws IOException, DependencyResolutionException, InterruptedException {
+        return executeAction(actionName, args, Collections.emptyMap());
+    }
+
+    /**
+     * Executes an action defined in app.yml file.
+     *
+     * @param actionName The name of the action to execute
+     * @param args A list of additional arguments to pass to the action command
+     * @param extraRepos A map of additional repository names to URLs where artifacts can be found.
+     * @return An integer containing the exit result of the action
+     * @throws IllegalArgumentException If the action name is not provided or not found
+     * @throws IOException If an error occurred during the operation
+     * @throws DependencyResolutionException If an error occurred during dependency resolution
+     * @throws InterruptedException If the action execution was interrupted
+     */
+    public int executeAction(String actionName, List<String> args, Map<String, String> extraRepos)
+            throws IOException, DependencyResolutionException, InterruptedException {
         AppInfo appInfo = readAppInfo();
 
         // Get the action command
@@ -299,7 +330,7 @@ public int executeAction(String actionName, List<String> args)
                             .collect(Collectors.joining(" ", " ", ""));
         }
 
-        return executeCommand(command);
+        return executeCommand(command, extraRepos);
     }
 
     /**
@@ -324,10 +355,28 @@ public List<String> listActions() throws IOException {
      */
     public int executeCommand(String command)
             throws IOException, DependencyResolutionException, InterruptedException {
+        return executeCommand(command, Collections.emptyMap());
+    }
+
+    /**
+     * Executes an action defined in app.yml file.
+     *
+     * @param command The command to execute
+     * @param extraRepos A map of additional repository names to URLs where artifacts can be found.
+     * @return An integer containing the exit result of the action
+     * @throws IOException If an error occurred during the operation
+     * @throws DependencyResolutionException If an error occurred during dependency resolution
+     * @throws InterruptedException If the action execution was interrupted
+     */
+    public int executeCommand(String command, Map<String, String> extraRepos)
+            throws IOException, DependencyResolutionException, InterruptedException {
         // Get the classpath for variable substitution only if needed
         List<Path> classpath = Collections.emptyList();
         if (command.contains("{{deps}}")) {
-            classpath = this.path(new String[0]); // Empty array means use dependencies from app.yml
+            classpath =
+                    this.path(
+                            new String[0],
+                            extraRepos); // Empty array means use dependencies from app.yml
         }
 
         return ScriptUtils.executeScript(command, classpath, verbose);

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

@@ -88,8 +88,9 @@ static class Copy implements Callable<Integer> {
         public Integer call() throws Exception {
             SyncResult stats =
                     Jpm.builder()
-                            .directory(artifactsMixin.depsMixin.directory)
-                            .noLinks(artifactsMixin.depsMixin.noLinks)
+                            .directory(artifactsMixin.directory)
+                            .noLinks(artifactsMixin.noLinks)
+                            .cacheDir(artifactsMixin.cacheDir)
                             .build()
                             .copy(
                                     artifactsMixin.artifactNames,
@@ -162,9 +163,12 @@ public Integer call() throws Exception {
                                     Jpm.builder()
                                             .directory(depsMixin.directory)
                                             .noLinks(depsMixin.noLinks)
+                                            .cacheDir(depsMixin.cacheDir)
                                             .appFile(appInfoFileMixin.appInfoFile)
                                             .build()
-                                            .install(new String[] {selectedArtifact});
+                                            .install(
+                                                    new String[] {selectedArtifact},
+                                                    depsMixin.getRepositoryMap());
                             if (!quietMixin.quiet) {
                                 printStats(stats);
                             }
@@ -173,9 +177,13 @@ public Integer call() throws Exception {
                                     Jpm.builder()
                                             .directory(depsMixin.directory)
                                             .noLinks(depsMixin.noLinks)
+                                            .cacheDir(depsMixin.cacheDir)
                                             .appFile(appInfoFileMixin.appInfoFile)
                                             .build()
-                                            .copy(new String[] {selectedArtifact}, false);
+                                            .copy(
+                                                    new String[] {selectedArtifact},
+                                                    depsMixin.getRepositoryMap(),
+                                                    false);
                             if (!quietMixin.quiet) {
                                 printStats(stats);
                             }
@@ -211,6 +219,7 @@ String[] search(String artifactPattern) {
                 return Jpm.builder()
                         .directory(depsMixin.directory)
                         .noLinks(depsMixin.noLinks)
+                        .cacheDir(depsMixin.cacheDir)
                         .appFile(appInfoFileMixin.appInfoFile)
                         .build()
                         .search(artifactPattern, Math.min(max, 200), backend);
@@ -309,8 +318,9 @@ static class Install implements Callable<Integer> {
         public Integer call() throws Exception {
             SyncResult stats =
                     Jpm.builder()
-                            .directory(optionalArtifactsMixin.depsMixin.directory)
-                            .noLinks(optionalArtifactsMixin.depsMixin.noLinks)
+                            .directory(optionalArtifactsMixin.directory)
+                            .noLinks(optionalArtifactsMixin.noLinks)
+                            .cacheDir(optionalArtifactsMixin.cacheDir)
                             .appFile(appInfoFileMixin.appInfoFile)
                             .build()
                             .install(
@@ -339,8 +349,9 @@ static class PrintPath implements Callable<Integer> {
         public Integer call() throws Exception {
             List<Path> files =
                     Jpm.builder()
-                            .directory(optionalArtifactsMixin.depsMixin.directory)
-                            .noLinks(optionalArtifactsMixin.depsMixin.noLinks)
+                            .directory(optionalArtifactsMixin.directory)
+                            .noLinks(optionalArtifactsMixin.noLinks)
+                            .cacheDir(optionalArtifactsMixin.cacheDir)
                             .appFile(appInfoFileMixin.appInfoFile)
                             .build()
                             .path(
@@ -386,6 +397,7 @@ static class Exec implements Callable<Integer> {
         @Mixin VerboseMixin verboseMixin;
         @Mixin DepsMixin depsMixin;
         @Mixin QuietMixin quietMixin;
+        @Mixin AppInfoFileMixin appInfoFileMixin;
 
         @Parameters(paramLabel = "command", description = "The command to execute", arity = "0..*")
         private List<String> command;
@@ -397,9 +409,11 @@ public Integer call() throws Exception {
                 return Jpm.builder()
                         .directory(depsMixin.directory)
                         .noLinks(depsMixin.noLinks)
+                        .cacheDir(depsMixin.cacheDir)
+                        .appFile(appInfoFileMixin.appInfoFile)
                         .verbose(!quietMixin.quiet)
                         .build()
-                        .executeCommand(cmd);
+                        .executeCommand(cmd, depsMixin.getRepositoryMap());
             } catch (Exception e) {
                 System.err.println(e.getMessage());
                 return 1;
@@ -454,6 +468,7 @@ public Integer call() throws Exception {
                             Jpm.builder()
                                     .directory(depsMixin.directory)
                                     .noLinks(depsMixin.noLinks)
+                                    .cacheDir(depsMixin.cacheDir)
                                     .appFile(appInfoFileMixin.appInfoFile)
                                     .build()
                                     .listActions();
@@ -499,10 +514,11 @@ public Integer call() throws Exception {
                                 Jpm.builder()
                                         .directory(depsMixin.directory)
                                         .noLinks(depsMixin.noLinks)
+                                        .cacheDir(depsMixin.cacheDir)
                                         .appFile(appInfoFileMixin.appInfoFile)
                                         .verbose(!quietMixin.quiet)
                                         .build()
-                                        .executeAction(action, args);
+                                        .executeAction(action, args, depsMixin.getRepositoryMap());
                         if (exitCode != 0) {
                             return exitCode;
                         }
@@ -532,9 +548,10 @@ public Integer call() throws Exception {
                 return Jpm.builder()
                         .directory(depsMixin.directory)
                         .noLinks(depsMixin.noLinks)
+                        .cacheDir(depsMixin.cacheDir)
                         .appFile(appInfoFileMixin.appInfoFile)
                         .build()
-                        .executeAction(actionName(), args);
+                        .executeAction(actionName(), args, depsMixin.getRepositoryMap());
             } catch (Exception e) {
                 System.err.println(e.getMessage());
                 return 1;
@@ -594,17 +611,19 @@ static class DepsMixin {
                 description = "Always copy artifacts, don't try to create symlinks",
                 defaultValue = "false")
         boolean noLinks;
-    }
-
-    static class BaseArtifactsMixin {
-        @Mixin DepsMixin depsMixin;
 
         @Option(
                 names = {"-r", "--repo"},
                 description =
                         "URL to additional repository to use when resolving artifacts. Can be preceded by a name and an equals sign, e.g. -r myrepo=https://my.repo.com/maven2. When needing to pass user and password you can set JPM_REPO_<name>_USER and JPM_REPO_<name>_PASSWORD environment variables.")
         List<String> repositories = new ArrayList<>();
 
+        @Option(
+                names = {"-c", "--cache"},
+                description =
+                        "Directory where downloaded artifacts will be cached (default: value of JPM_CACHE environment variable; whatever is set in Maven's settings.xml or $HOME/.m2/repository")
+        Path cacheDir;
+
         Map<String, String> getRepositoryMap() {
             Map<String, String> repoMap = new HashMap<>();
             for (String repo : repositories) {
@@ -634,7 +653,7 @@ Map<String, String> getRepositoryMap() {
         }
     }
 
-    static class ArtifactsMixin extends BaseArtifactsMixin {
+    static class ArtifactsMixin extends DepsMixin {
         @Parameters(
                 paramLabel = "artifacts",
                 description =
@@ -643,7 +662,7 @@ static class ArtifactsMixin extends BaseArtifactsMixin {
         private String[] artifactNames = {};
     }
 
-    static class OptionalArtifactsMixin extends BaseArtifactsMixin {
+    static class OptionalArtifactsMixin extends DepsMixin {
         @Parameters(
                 paramLabel = "artifacts",
                 description =

src/main/java/org/codejive/jpm/util/Resolver.java

@@ -24,21 +24,24 @@
 public class Resolver {
     private final List<Artifact> artifacts;
     private final List<RemoteRepository> repositories;
+    private final Path cacheDir;
 
     private List<ArtifactResult> resolvedArtifacts;
 
-    public static Resolver create(String[] artifactNames, Map<String, String> repositories) {
-        return new Resolver(artifactNames, repositories);
+    public static Resolver create(
+            String[] artifactNames, Map<String, String> repositories, Path cacheDir) {
+        return new Resolver(artifactNames, repositories, cacheDir);
     }
 
-    private Resolver(String[] artifactNames, Map<String, String> repos) {
+    private Resolver(String[] artifactNames, Map<String, String> repos, Path cacheDir) {
         artifacts = parseArtifacts(artifactNames);
         repositories = parseRepositories(repos);
+        this.cacheDir = cacheDir;
     }
 
     public List<ArtifactResult> resolve() throws DependencyResolutionException {
         if (resolvedArtifacts == null) {
-            resolvedArtifacts = resolveArtifacts(artifacts, repositories);
+            resolvedArtifacts = resolveArtifacts(artifacts, repositories, cacheDir);
         }
         return resolvedArtifacts;
     }
@@ -58,7 +61,7 @@ public List<Path> resolvePaths() throws DependencyResolutionException {
      * @throws DependencyResolutionException if an error occurs while resolving the artifacts
      */
     public static List<ArtifactResult> resolveArtifacts(
-            List<Artifact> artifacts, List<RemoteRepository> repositories)
+            List<Artifact> artifacts, List<RemoteRepository> repositories, Path cacheDir)
             throws DependencyResolutionException {
         List<Dependency> dependencies =
                 artifacts.stream()
@@ -67,8 +70,7 @@ public static List<ArtifactResult> resolveArtifacts(
         ContextOverrides.Builder ctxb =
                 ContextOverrides.create()
                         .withUserSettings(true)
-                        .withLocalRepositoryOverride(
-                                FileUtils.safePath(System.getenv("JPM_CACHE")));
+                        .withLocalRepositoryOverride(cacheDir);
         if (repositories != null && !repositories.isEmpty()) {
             ctxb.repositories(repositories);
         }