build: Prepare codebase for Java modules

kordamp · Feb 10, 2023 · 039fb63 · 039fb63
1 parent bf2677d
commit 039fb63
Show file tree

Hide file tree

Showing 28 changed files with 80 additions and 40 deletions.
diff --git a/build.gradle b/build.gradle
@@ -42,6 +42,7 @@ config {
     quality {
         checkstyle {
             toolVersion = checkstyleVersion
+            exclude('module-info.*')
             aggregate {
                 enabled = true
             }

diff --git a/core/jarviz-core/src/main/java/module-info.java b/core/jarviz-core/src/main/java/module-info.java
@@ -0,0 +1,33 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Copyright 2022-2023 The Jarviz authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * @author Andres Almiray
+ * @since 0.3.0
+ */
+module org.kordamp.jarviz.core {
+    exports org.kordamp.jarviz.bundle;
+    exports org.kordamp.jarviz.core;
+    exports org.kordamp.jarviz.core.bytecode;
+    exports org.kordamp.jarviz.core.model;
+    exports org.kordamp.jarviz.core.modules;
+    exports org.kordamp.jarviz.core.processors;
+    exports org.kordamp.jarviz.core.services;
+    exports org.kordamp.jarviz.reporting;
+    exports org.kordamp.jarviz.util;
+}
diff --git a/...rviz/core/resolvers/JarFileResolvers.java → ...kordamp/jarviz/core/JarFileResolvers.java b/...rviz/core/resolvers/JarFileResolvers.java → ...kordamp/jarviz/core/JarFileResolvers.java
@@ -15,9 +15,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.kordamp.jarviz.core.resolvers;
+package org.kordamp.jarviz.core;
 
-import org.kordamp.jarviz.core.JarFileResolver;
+import org.kordamp.jarviz.core.resolvers.GavBasedJarFileResolver;
+import org.kordamp.jarviz.core.resolvers.PathBasedJarFileResolver;
+import org.kordamp.jarviz.core.resolvers.UrlBasedJarFileResolver;
 
 import java.net.URL;
 import java.nio.file.Path;

diff --git a/gradle.properties b/gradle.properties
@@ -28,7 +28,7 @@ jdksPluginVersion      = 1.4.0
 moditectPluginVersion  = 1.0.0-rc3
 
 asmVersion             = 9.4
-checkstyleVersion      = 10.5.0
+checkstyleVersion      = 10.7.0
 hamcrestVersion        = 2.2
 jipsyVersion           = 1.1.1
 junitVersion           = 4.13.2

diff --git a/plugins/jarviz-cli/jarviz-cli.gradle b/plugins/jarviz-cli/jarviz-cli.gradle
@@ -27,7 +27,10 @@ application {
 
 jar {
     manifest {
-        attributes('Main-Class': 'org.kordamp.jarviz.cli.Main')
+        attributes([
+            'Main-Class': 'org.kordamp.jarviz.cli.Main',
+            'Automatic-Module-Name': 'org.kordamp.jarviz.cli'
+        ])
     }
 }
 

diff --git a/plugins/jarviz-cli/src/main/java/org/kordamp/jarviz/cli/Main.java b/plugins/jarviz-cli/src/main/java/org/kordamp/jarviz/cli/Main.java
@@ -18,6 +18,8 @@
 package org.kordamp.jarviz.cli;
 
 import org.kordamp.jarviz.cli.bytecode.Bytecode;
+import org.kordamp.jarviz.cli.internal.Banner;
+import org.kordamp.jarviz.cli.internal.BaseCommand;
 import org.kordamp.jarviz.cli.manifest.Manifest;
 import org.kordamp.jarviz.cli.services.Services;
 import picocli.AutoComplete;

diff --git a/plugins/jarviz-cli/src/main/java/org/kordamp/jarviz/cli/bytecode/Bytecode.java b/plugins/jarviz-cli/src/main/java/org/kordamp/jarviz/cli/bytecode/Bytecode.java
@@ -17,7 +17,7 @@
  */
 package org.kordamp.jarviz.cli.bytecode;
 
-import org.kordamp.jarviz.cli.AbstractJarvizCommand;
+import org.kordamp.jarviz.cli.internal.AbstractJarvizCommand;
 import org.kordamp.jarviz.cli.Main;
 import picocli.CommandLine;
 

diff --git a/plugins/jarviz-cli/src/main/java/org/kordamp/jarviz/cli/bytecode/BytecodeShow.java b/plugins/jarviz-cli/src/main/java/org/kordamp/jarviz/cli/bytecode/BytecodeShow.java
@@ -17,7 +17,7 @@
  */
 package org.kordamp.jarviz.cli.bytecode;
 
-import org.kordamp.jarviz.cli.AbstractJarvizSubcommand;
+import org.kordamp.jarviz.cli.internal.AbstractJarvizSubcommand;
 import org.kordamp.jarviz.cli.internal.Colorizer;
 import org.kordamp.jarviz.core.JarFileResolver;
 import org.kordamp.jarviz.core.bytecode.ShowBytecodeJarProcessor;
@@ -33,7 +33,7 @@
 import java.util.Set;
 
 import static java.util.stream.Collectors.joining;
-import static org.kordamp.jarviz.core.resolvers.JarFileResolvers.createJarFileResolver;
+import static org.kordamp.jarviz.core.JarFileResolvers.createJarFileResolver;
 
 /**
  * @author Andres Almiray

diff --git a/plugins/jarviz-cli/src/main/java/org/kordamp/jarviz/cli/bytecode/BytecodeValidate.java b/plugins/jarviz-cli/src/main/java/org/kordamp/jarviz/cli/bytecode/BytecodeValidate.java
@@ -17,7 +17,7 @@
  */
 package org.kordamp.jarviz.cli.bytecode;
 
-import org.kordamp.jarviz.cli.AbstractJarvizSubcommand;
+import org.kordamp.jarviz.cli.internal.AbstractJarvizSubcommand;
 import picocli.CommandLine;
 
 /**

diff --git a/...g/kordamp/jarviz/cli/AbstractCommand.java → .../jarviz/cli/internal/AbstractCommand.java b/...g/kordamp/jarviz/cli/AbstractCommand.java → .../jarviz/cli/internal/AbstractCommand.java
@@ -15,8 +15,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.kordamp.jarviz.cli;
+package org.kordamp.jarviz.cli.internal;
 
+import org.kordamp.jarviz.cli.IO;
 import picocli.CommandLine;
 
 import java.io.PrintWriter;
@@ -27,8 +28,7 @@
  * @since 0.1.0
  */
 @CommandLine.Command(mixinStandardHelpOptions = true,
-    versionProvider = Versions.class,
-    resourceBundle = "org.kordamp.jarviz.cli.Messages")
+    versionProvider = Versions.class)
 public abstract class AbstractCommand<C extends IO> extends BaseCommand implements Callable<Integer>, IO {
     protected abstract C parent();
 

diff --git a/...amp/jarviz/cli/AbstractJarvizCommand.java → ...z/cli/internal/AbstractJarvizCommand.java b/...amp/jarviz/cli/AbstractJarvizCommand.java → ...z/cli/internal/AbstractJarvizCommand.java
@@ -15,8 +15,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.kordamp.jarviz.cli;
+package org.kordamp.jarviz.cli.internal;
 
+import org.kordamp.jarviz.cli.IO;
 import picocli.CommandLine;
 
 /**

diff --git a/.../jarviz/cli/AbstractJarvizSubcommand.java → ...li/internal/AbstractJarvizSubcommand.java b/.../jarviz/cli/AbstractJarvizSubcommand.java → ...li/internal/AbstractJarvizSubcommand.java
@@ -15,9 +15,10 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.kordamp.jarviz.cli;
+package org.kordamp.jarviz.cli.internal;
 
 import org.kordamp.jarviz.bundle.RB;
+import org.kordamp.jarviz.cli.IO;
 import org.kordamp.jarviz.core.JarvizException;
 import org.kordamp.jarviz.reporting.Format;
 import org.kordamp.jarviz.reporting.Formatter;

diff --git a/...n/java/org/kordamp/jarviz/cli/Banner.java → ...g/kordamp/jarviz/cli/internal/Banner.java b/...n/java/org/kordamp/jarviz/cli/Banner.java → ...g/kordamp/jarviz/cli/internal/Banner.java
@@ -15,7 +15,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.kordamp.jarviz.cli;
+package org.kordamp.jarviz.cli.internal;
 
 import org.kordamp.jarviz.util.JarvizOutput;
 
@@ -33,7 +33,7 @@
  * @author Andres Almiray
  * @since 0.1.0
  */
-final class Banner {
+public final class Banner {
     private static final Banner BANNER = new Banner();
     private final ResourceBundle bundle = ResourceBundle.getBundle(Banner.class.getName());
     private final String productVersion = bundle.getString("product.version");

diff --git a/...a/org/kordamp/jarviz/cli/BaseCommand.java → ...damp/jarviz/cli/internal/BaseCommand.java b/...a/org/kordamp/jarviz/cli/BaseCommand.java → ...damp/jarviz/cli/internal/BaseCommand.java
@@ -15,21 +15,20 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.kordamp.jarviz.cli;
+package org.kordamp.jarviz.cli.internal;
 
 import picocli.CommandLine;
 
 import java.text.MessageFormat;
 import java.util.Map;
-import java.util.ResourceBundle;
 
 /**
  * @author Andres Almiray
  * @since 0.1.0
  */
 @CommandLine.Command(mixinStandardHelpOptions = true,
     versionProvider = Versions.class,
-    resourceBundle = "org.kordamp.jarviz.cli.Messages")
+    resourceBundle = "org.kordamp.jarviz.cli.internal.Messages")
 public abstract class BaseCommand {
     static {
         if (System.getenv().containsKey("JARVIZ_NO_COLOR")) {
@@ -40,8 +39,6 @@ public abstract class BaseCommand {
     @CommandLine.Spec
     public CommandLine.Model.CommandSpec spec;
 
-    public ResourceBundle bundle = ResourceBundle.getBundle("org.kordamp.jarviz.cli.Messages");
-
     @CommandLine.Option(names = "-D",
         paramLabel = "<key=value>",
         descriptionKey = "system-property",
@@ -52,8 +49,8 @@ void setProperty(Map<String, String> props) {
 
     protected String $(String key, Object... args) {
         if (null == args || args.length == 0) {
-            return bundle.getString(key);
+            return spec.resourceBundle().getString(key);
         }
-        return MessageFormat.format(bundle.getString(key), args);
+        return MessageFormat.format(spec.resourceBundle().getString(key), args);
     }
 }
diff --git a/...java/org/kordamp/jarviz/cli/Versions.java → ...kordamp/jarviz/cli/internal/Versions.java b/...java/org/kordamp/jarviz/cli/Versions.java → ...kordamp/jarviz/cli/internal/Versions.java
@@ -15,7 +15,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.kordamp.jarviz.cli;
+package org.kordamp.jarviz.cli.internal;
 
 import org.kordamp.jarviz.util.JarvizVersion;
 import picocli.CommandLine;

diff --git a/plugins/jarviz-cli/src/main/java/org/kordamp/jarviz/cli/manifest/Manifest.java b/plugins/jarviz-cli/src/main/java/org/kordamp/jarviz/cli/manifest/Manifest.java
@@ -17,7 +17,7 @@
  */
 package org.kordamp.jarviz.cli.manifest;
 
-import org.kordamp.jarviz.cli.AbstractJarvizCommand;
+import org.kordamp.jarviz.cli.internal.AbstractJarvizCommand;
 import org.kordamp.jarviz.cli.Main;
 import picocli.CommandLine;
 

diff --git a/plugins/jarviz-cli/src/main/java/org/kordamp/jarviz/cli/manifest/ManifestQuery.java b/plugins/jarviz-cli/src/main/java/org/kordamp/jarviz/cli/manifest/ManifestQuery.java
@@ -17,7 +17,7 @@
  */
 package org.kordamp.jarviz.cli.manifest;
 
-import org.kordamp.jarviz.cli.AbstractJarvizSubcommand;
+import org.kordamp.jarviz.cli.internal.AbstractJarvizSubcommand;
 import org.kordamp.jarviz.core.JarFileResolver;
 import org.kordamp.jarviz.core.processors.QueryManifestJarProcessor;
 import org.kordamp.jarviz.reporting.Format;
@@ -28,7 +28,7 @@
 import java.nio.file.Paths;
 import java.util.Optional;
 
-import static org.kordamp.jarviz.core.resolvers.JarFileResolvers.createJarFileResolver;
+import static org.kordamp.jarviz.core.JarFileResolvers.createJarFileResolver;
 import static org.kordamp.jarviz.util.StringUtils.isNotBlank;
 
 /**

diff --git a/plugins/jarviz-cli/src/main/java/org/kordamp/jarviz/cli/manifest/ManifestShow.java b/plugins/jarviz-cli/src/main/java/org/kordamp/jarviz/cli/manifest/ManifestShow.java
@@ -18,7 +18,7 @@
 package org.kordamp.jarviz.cli.manifest;
 
 import org.kordamp.jarviz.bundle.RB;
-import org.kordamp.jarviz.cli.AbstractJarvizSubcommand;
+import org.kordamp.jarviz.cli.internal.AbstractJarvizSubcommand;
 import org.kordamp.jarviz.core.JarFileResolver;
 import org.kordamp.jarviz.core.JarvizException;
 import org.kordamp.jarviz.core.processors.ShowManifestJarProcessor;
@@ -32,7 +32,7 @@
 import java.nio.file.Paths;
 import java.util.Optional;
 
-import static org.kordamp.jarviz.core.resolvers.JarFileResolvers.createJarFileResolver;
+import static org.kordamp.jarviz.core.JarFileResolvers.createJarFileResolver;
 
 /**
  * @author Andres Almiray

diff --git a/plugins/jarviz-cli/src/main/java/org/kordamp/jarviz/cli/modules/Module.java b/plugins/jarviz-cli/src/main/java/org/kordamp/jarviz/cli/modules/Module.java
@@ -17,7 +17,7 @@
  */
 package org.kordamp.jarviz.cli.modules;
 
-import org.kordamp.jarviz.cli.AbstractJarvizCommand;
+import org.kordamp.jarviz.cli.internal.AbstractJarvizCommand;
 import org.kordamp.jarviz.cli.Main;
 import picocli.CommandLine;
 

diff --git a/plugins/jarviz-cli/src/main/java/org/kordamp/jarviz/cli/modules/ModuleDescriptor.java b/plugins/jarviz-cli/src/main/java/org/kordamp/jarviz/cli/modules/ModuleDescriptor.java
@@ -17,7 +17,7 @@
  */
 package org.kordamp.jarviz.cli.modules;
 
-import org.kordamp.jarviz.cli.AbstractJarvizSubcommand;
+import org.kordamp.jarviz.cli.internal.AbstractJarvizSubcommand;
 import org.kordamp.jarviz.core.JarFileResolver;
 import org.kordamp.jarviz.core.modules.DescriptorModuleJarProcessor;
 import org.kordamp.jarviz.reporting.Format;
@@ -36,7 +36,7 @@
 import static java.util.stream.Collectors.joining;
 import static java.util.stream.Collectors.toList;
 import static org.kordamp.jarviz.cli.internal.Colorizer.magenta;
-import static org.kordamp.jarviz.core.resolvers.JarFileResolvers.createJarFileResolver;
+import static org.kordamp.jarviz.core.JarFileResolvers.createJarFileResolver;
 
 /**
  * @author Andres Almiray

diff --git a/plugins/jarviz-cli/src/main/java/org/kordamp/jarviz/cli/modules/ModuleName.java b/plugins/jarviz-cli/src/main/java/org/kordamp/jarviz/cli/modules/ModuleName.java
@@ -17,7 +17,7 @@
  */
 package org.kordamp.jarviz.cli.modules;
 
-import org.kordamp.jarviz.cli.AbstractJarvizSubcommand;
+import org.kordamp.jarviz.cli.internal.AbstractJarvizSubcommand;
 import org.kordamp.jarviz.core.JarFileResolver;
 import org.kordamp.jarviz.core.modules.NameModuleJarProcessor;
 import org.kordamp.jarviz.reporting.Format;
@@ -27,7 +27,7 @@
 import java.nio.file.Path;
 import java.nio.file.Paths;
 
-import static org.kordamp.jarviz.core.resolvers.JarFileResolvers.createJarFileResolver;
+import static org.kordamp.jarviz.core.JarFileResolvers.createJarFileResolver;
 
 /**
  * @author Andres Almiray

diff --git a/plugins/jarviz-cli/src/main/java/org/kordamp/jarviz/cli/mrjar/Mrjar.java b/plugins/jarviz-cli/src/main/java/org/kordamp/jarviz/cli/mrjar/Mrjar.java
@@ -17,7 +17,7 @@
  */
 package org.kordamp.jarviz.cli.mrjar;
 
-import org.kordamp.jarviz.cli.AbstractJarvizCommand;
+import org.kordamp.jarviz.cli.internal.AbstractJarvizCommand;
 import org.kordamp.jarviz.cli.Main;
 import picocli.CommandLine;
 

diff --git a/plugins/jarviz-cli/src/main/java/org/kordamp/jarviz/cli/mrjar/MrjarValidate.java b/plugins/jarviz-cli/src/main/java/org/kordamp/jarviz/cli/mrjar/MrjarValidate.java
@@ -17,7 +17,7 @@
  */
 package org.kordamp.jarviz.cli.mrjar;
 
-import org.kordamp.jarviz.cli.AbstractJarvizSubcommand;
+import org.kordamp.jarviz.cli.internal.AbstractJarvizSubcommand;
 import picocli.CommandLine;
 
 /**

diff --git a/plugins/jarviz-cli/src/main/java/org/kordamp/jarviz/cli/services/Services.java b/plugins/jarviz-cli/src/main/java/org/kordamp/jarviz/cli/services/Services.java
@@ -17,7 +17,7 @@
  */
 package org.kordamp.jarviz.cli.services;
 
-import org.kordamp.jarviz.cli.AbstractJarvizCommand;
+import org.kordamp.jarviz.cli.internal.AbstractJarvizCommand;
 import org.kordamp.jarviz.cli.Main;
 import picocli.CommandLine;
 

diff --git a/plugins/jarviz-cli/src/main/java/org/kordamp/jarviz/cli/services/ServicesList.java b/plugins/jarviz-cli/src/main/java/org/kordamp/jarviz/cli/services/ServicesList.java
@@ -17,7 +17,7 @@
  */
 package org.kordamp.jarviz.cli.services;
 
-import org.kordamp.jarviz.cli.AbstractJarvizSubcommand;
+import org.kordamp.jarviz.cli.internal.AbstractJarvizSubcommand;
 import org.kordamp.jarviz.core.JarFileResolver;
 import org.kordamp.jarviz.core.services.ListServicesJarProcessor;
 import org.kordamp.jarviz.reporting.Format;
@@ -29,7 +29,7 @@
 import java.util.List;
 import java.util.Optional;
 
-import static org.kordamp.jarviz.core.resolvers.JarFileResolvers.createJarFileResolver;
+import static org.kordamp.jarviz.core.JarFileResolvers.createJarFileResolver;
 
 /**
  * @author Andres Almiray

diff --git a/plugins/jarviz-cli/src/main/java/org/kordamp/jarviz/cli/services/ServicesShow.java b/plugins/jarviz-cli/src/main/java/org/kordamp/jarviz/cli/services/ServicesShow.java
@@ -17,7 +17,7 @@
  */
 package org.kordamp.jarviz.cli.services;
 
-import org.kordamp.jarviz.cli.AbstractJarvizSubcommand;
+import org.kordamp.jarviz.cli.internal.AbstractJarvizSubcommand;
 import org.kordamp.jarviz.core.JarFileResolver;
 import org.kordamp.jarviz.core.services.ShowServicesJarProcessor;
 import org.kordamp.jarviz.reporting.Format;
@@ -29,7 +29,7 @@
 import java.util.List;
 import java.util.Optional;
 
-import static org.kordamp.jarviz.core.resolvers.JarFileResolvers.createJarFileResolver;
+import static org.kordamp.jarviz.core.JarFileResolvers.createJarFileResolver;
 
 /**
  * @author Andres Almiray

diff --git a/.../org/kordamp/jarviz/cli/Banner.properties → ...amp/jarviz/cli/internal/Banner.properties b/.../org/kordamp/jarviz/cli/Banner.properties → ...amp/jarviz/cli/internal/Banner.properties
diff --git a/...rg/kordamp/jarviz/cli/Messages.properties → ...p/jarviz/cli/internal/Messages.properties b/...rg/kordamp/jarviz/cli/Messages.properties → ...p/jarviz/cli/internal/Messages.properties