Merge pull request #52 from pmd/cli-compat

jsotuyod · web-flow · commit c3ec06cbeece · 2022-08-11T14:35:08.000-03:00
Better expose entry points for pmd-cli integration
diff --git a/.gitignore b/.gitignore
@@ -95,6 +95,11 @@ buildNumber.properties
 
 # End of https://www.gitignore.io/api/intellij,maven
 
+### Eclipse ###
+.project
+.settings
+.classpath
+
 .idea/*
 # Share run configurations for easier setup
 !/.idea/runConfigurations/
diff --git a/src/main/java/net/sourceforge/pmd/util/fxdesigner/Designer.java b/src/main/java/net/sourceforge/pmd/util/fxdesigner/Designer.java
@@ -5,23 +5,18 @@
 package net.sourceforge.pmd.util.fxdesigner;
 
 import java.io.IOException;
-import java.io.InputStream;
 import java.util.Arrays;
 import java.util.List;
 import java.util.Objects;
-import java.util.Optional;
-import java.util.Properties;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 import java.util.stream.Collectors;
 
-import net.sourceforge.pmd.PMDVersion;
 import net.sourceforge.pmd.lang.ast.xpath.Attribute;
 import net.sourceforge.pmd.util.fxdesigner.app.DesignerParams;
 import net.sourceforge.pmd.util.fxdesigner.app.DesignerRoot;
 import net.sourceforge.pmd.util.fxdesigner.app.DesignerRootImpl;
 import net.sourceforge.pmd.util.fxdesigner.util.DesignerUtil;
-import net.sourceforge.pmd.util.fxdesigner.util.ResourceUtil;
 
 import javafx.application.Application;
 import javafx.application.Platform;
@@ -41,44 +36,6 @@
  */
 public class Designer extends Application {
 
-    /**
-     * Constant that contains always the current version of the designer.
-     */
-    private static final String VERSION;
-    private static final String PMD_CORE_MIN_VERSION;
-    private static final String UNKNOWN_VERSION = "unknown";
-
-
-    /**
-     * Determines the version from maven's generated pom.properties file.
-     */
-    static {
-        VERSION = readProperty("/META-INF/maven/net.sourceforge.pmd/pmd-ui/pom.properties", "version").orElse(UNKNOWN_VERSION);
-        PMD_CORE_MIN_VERSION = readProperty(ResourceUtil.resolveResource("designer.properties"), "pmd.core.version").orElse(UNKNOWN_VERSION);
-    }
-
-
-    public static String getCurrentVersion() {
-        return VERSION;
-    }
-
-    public static String getPmdCoreMinVersion() {
-        return PMD_CORE_MIN_VERSION;
-    }
-
-    private static Optional<String> readProperty(String resourcePath, String key) {
-        try (InputStream stream = PMDVersion.class.getResourceAsStream(resourcePath)) {
-            if (stream != null) {
-                final Properties properties = new Properties();
-                properties.load(stream);
-                return Optional.ofNullable(properties.getProperty(key));
-            }
-        } catch (final IOException ignored) {
-            // fallthrough
-        }
-        return Optional.empty();
-    }
-
     private long initStartTimeMillis;
     private DesignerRoot designerRoot;
 
@@ -101,7 +58,7 @@ public void stop() {
     public void start(Stage stage, DesignerRoot owner) throws IOException {
         this.designerRoot = owner;
 
-        stage.setTitle("PMD Rule Designer (v " + Designer.VERSION + ')');
+        stage.setTitle("PMD Rule Designer (v " + DesignerVersion.getCurrentVersion() + ')');
         setIcons(stage);
 
         Logger.getLogger(Attribute.class.getName()).setLevel(Level.OFF);
diff --git a/src/main/java/net/sourceforge/pmd/util/fxdesigner/DesignerStarter.java b/src/main/java/net/sourceforge/pmd/util/fxdesigner/DesignerStarter.java
@@ -11,6 +11,8 @@
 
 import org.apache.commons.lang3.SystemUtils;
 
+import net.sourceforge.pmd.annotation.InternalApi;
+
 import com.beust.jcommander.JCommander;
 import com.beust.jcommander.ParameterException;
 import javafx.application.Application;
@@ -32,9 +34,6 @@ public final class DesignerStarter {
 
     private static final int MIN_JAVAFX_VERSION_ON_MAC_OSX = 14;
 
-    private static final int ERROR_EXIT = 1;
-    private static final int OK = 0;
-
     private DesignerStarter() {
     }
 
@@ -47,7 +46,7 @@ private static boolean isJavaFxAvailable() {
         }
     }
 
-
+    @Deprecated
     private static MainCliArgs readParameters(String[] argv) {
 
         MainCliArgs argsObj = new MainCliArgs();
@@ -59,7 +58,7 @@ private static MainCliArgs readParameters(String[] argv) {
 
             if (argsObj.help) {
                 System.out.println(getHelpText(jCommander));
-                System.exit(OK);
+                System.exit(ExitStatus.OK.getCode());
             }
 
             return argsObj;
@@ -68,19 +67,24 @@ private static MainCliArgs readParameters(String[] argv) {
             System.out.println(e.getMessage());
             System.out.println();
             System.out.println(getHelpText(jCommander));
-            System.exit(OK);
+            System.exit(ExitStatus.OK.getCode());
             throw new AssertionError();
         }
 
 
     }
 
-
+    /**
+     * Starting from PMD 7.0.0 this method usage will be limited for development.
+     * CLI support will be provided by pmd-cli
+     */
+    @InternalApi
     public static void main(String[] args) {
 
         readParameters(args);
 
-        launchGui(args);
+        final ExitStatus ret = launchGui(args);
+        System.exit(ret.getCode());
     }
 
     private static void setSystemProperties() {
@@ -118,6 +122,7 @@ private static String getJavaFxVersion() {
         return null;
     }
 
+    @Deprecated
     private static String getHelpText(JCommander jCommander) {
 
         StringBuilder sb = new StringBuilder();
@@ -139,7 +144,7 @@ private static String getHelpText(JCommander jCommander) {
     }
 
     @SuppressWarnings("PMD.AvoidCatchingThrowable")
-    private static void launchGui(String[] args) {
+    public static ExitStatus launchGui(String[] args) {
         setSystemProperties();
 
         String message = null;
@@ -152,14 +157,31 @@ private static void launchGui(String[] args) {
         if (message != null) {
             System.err.println(message);
             JOptionPane.showMessageDialog(null, message);
-            System.exit(ERROR_EXIT);
+            return ExitStatus.ERROR;
         }
 
         try {
             Application.launch(Designer.class, args);
         } catch (Throwable unrecoverable) {
             unrecoverable.printStackTrace();
-            System.exit(ERROR_EXIT);
+            return ExitStatus.ERROR;
+        }
+
+        return ExitStatus.OK;
+    }
+
+    public enum ExitStatus {
+        OK(0),
+        ERROR(1);
+
+        private final int code;
+
+        ExitStatus(final int code) {
+            this.code = code;
+        }
+
+        public int getCode() {
+            return code;
         }
     }
 }
diff --git a/src/main/java/net/sourceforge/pmd/util/fxdesigner/DesignerVersion.java b/src/main/java/net/sourceforge/pmd/util/fxdesigner/DesignerVersion.java
@@ -0,0 +1,59 @@
+/*
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.util.fxdesigner;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.Optional;
+import java.util.Properties;
+
+import net.sourceforge.pmd.PMDVersion;
+import net.sourceforge.pmd.util.fxdesigner.util.ResourceUtil;
+
+/**
+ * Stores the current Designer and PMD version and provides utility methods around them.
+ */
+public final class DesignerVersion {
+
+    /**
+     * Constant that contains always the current version of the designer.
+     */
+    private static final String VERSION;
+    private static final String PMD_CORE_MIN_VERSION;
+    private static final String UNKNOWN_VERSION = "unknown";
+
+    /**
+     * Determines the version from maven's generated pom.properties file.
+     */
+    static {
+        VERSION = readProperty("/META-INF/maven/net.sourceforge.pmd/pmd-ui/pom.properties", "version").orElse(UNKNOWN_VERSION);
+        PMD_CORE_MIN_VERSION = readProperty(ResourceUtil.resolveResource("designer.properties"), "pmd.core.version").orElse(UNKNOWN_VERSION);
+    }
+
+    private DesignerVersion() {
+        throw new AssertionError("Can't instantiate a utility class.");
+    }
+
+    public static String getCurrentVersion() {
+        return VERSION;
+    }
+
+    public static String getPmdCoreMinVersion() {
+        return PMD_CORE_MIN_VERSION;
+    }
+
+    private static Optional<String> readProperty(String resourcePath, String key) {
+        try (InputStream stream = PMDVersion.class.getResourceAsStream(resourcePath)) {
+            if (stream != null) {
+                final Properties properties = new Properties();
+                properties.load(stream);
+                return Optional.ofNullable(properties.getProperty(key));
+            }
+        } catch (final IOException ignored) {
+            // fallthrough
+        }
+        return Optional.empty();
+    }
+}
diff --git a/src/main/java/net/sourceforge/pmd/util/fxdesigner/MainCliArgs.java b/src/main/java/net/sourceforge/pmd/util/fxdesigner/MainCliArgs.java
@@ -6,10 +6,11 @@
 
 import com.beust.jcommander.Parameter;
 
+@Deprecated
 final class MainCliArgs {
 
 
-    @Parameter(names = {"--verbose", "-v"},
+    @Parameter(names = {"--verbose", "-v", "-D", "--debug"},
                arity = 0,
                description = "Whether to launch the app in verbose mode. "
                    + "This enables logging of exception stack traces and "
diff --git a/src/main/java/net/sourceforge/pmd/util/fxdesigner/app/DesignerParams.java b/src/main/java/net/sourceforge/pmd/util/fxdesigner/app/DesignerParams.java
@@ -42,7 +42,7 @@ public DesignerParams(String... args) {
     public DesignerParams(Parameters params) {
         List<String> raw = params.getRaw();
         // error output is disabled by default
-        if (raw.contains("-v") || raw.contains("--verbose")) {
+        if (raw.contains("-v") || raw.contains("--verbose") || raw.contains("--debug") || raw.contains("-D")) {
             isDeveloperMode = true;
         }
 
diff --git a/src/main/java/net/sourceforge/pmd/util/fxdesigner/app/services/GlobalDiskManagerImpl.java b/src/main/java/net/sourceforge/pmd/util/fxdesigner/app/services/GlobalDiskManagerImpl.java
@@ -11,7 +11,7 @@
 import java.util.List;
 import java.util.stream.Collectors;
 
-import net.sourceforge.pmd.util.fxdesigner.Designer;
+import net.sourceforge.pmd.util.fxdesigner.DesignerVersion;
 import net.sourceforge.pmd.util.fxdesigner.app.ApplicationComponent;
 import net.sourceforge.pmd.util.fxdesigner.app.DesignerRoot;
 
@@ -33,7 +33,7 @@ public GlobalDiskManagerImpl(DesignerRoot root, Path settingsDirectory) {
         this.settingsDirectory = settingsDirectory;
 
 
-        Path curVersionStamp = settingsDirectory.resolve("version-" + Designer.getCurrentVersion());
+        Path curVersionStamp = settingsDirectory.resolve("version-" + DesignerVersion.getCurrentVersion());
 
 
         List<Path> diskVersionStamps = getDiskVersionStamps();
@@ -62,7 +62,7 @@ private List<Path> getDiskVersionStamps() {
                         .filter(it -> !Files.isDirectory(it))
                         .filter(it -> it.getFileName().toString().startsWith(STAMP_PREFIX))
                         .collect(Collectors.toList());
-        } catch (IOException e) {
+        } catch (IOException ignored) {
             return Collections.emptyList();
         }
     }
diff --git a/src/main/java/net/sourceforge/pmd/util/fxdesigner/app/services/OnDiskPersistenceManager.java b/src/main/java/net/sourceforge/pmd/util/fxdesigner/app/services/OnDiskPersistenceManager.java
@@ -9,7 +9,7 @@
 import java.nio.file.Path;
 import java.util.concurrent.CompletableFuture;
 
-import net.sourceforge.pmd.util.fxdesigner.Designer;
+import net.sourceforge.pmd.util.fxdesigner.DesignerVersion;
 import net.sourceforge.pmd.util.fxdesigner.app.DesignerRoot;
 import net.sourceforge.pmd.util.fxdesigner.util.beans.SettingsOwner;
 import net.sourceforge.pmd.util.fxdesigner.util.beans.SettingsPersistenceUtil;
@@ -85,7 +85,7 @@ private void commitAppState() throws IOException, InterruptedException {
         process.start().waitFor();
         process.command("git", "add", output.toString());
         process.start().waitFor();
-        process.command("git", "commit", "-m", "\"On version " + Designer.getCurrentVersion() + "\"");
+        process.command("git", "commit", "-m", "\"On version " + DesignerVersion.getCurrentVersion() + "\"");
         process.start().waitFor();
 
     }
diff --git a/src/main/java/net/sourceforge/pmd/util/fxdesigner/popups/SimplePopups.java b/src/main/java/net/sourceforge/pmd/util/fxdesigner/popups/SimplePopups.java
@@ -21,7 +21,7 @@
 
 import net.sourceforge.pmd.PMDVersion;
 import net.sourceforge.pmd.lang.Language;
-import net.sourceforge.pmd.util.fxdesigner.Designer;
+import net.sourceforge.pmd.util.fxdesigner.DesignerVersion;
 import net.sourceforge.pmd.util.fxdesigner.app.DesignerRoot;
 import net.sourceforge.pmd.util.fxdesigner.util.AuxLanguageRegistry;
 import net.sourceforge.pmd.util.fxdesigner.util.DesignerUtil;
@@ -213,8 +213,8 @@ public static void showAboutPopup(DesignerRoot root) {
 
         String sb =
             "PMD core version:\t\t\t" + PMDVersion.VERSION + "\n"
-                + "Designer version:\t\t\t" + Designer.getCurrentVersion()
-                + " (supports PMD core " + Designer.getPmdCoreMinVersion() + ")\n"
+                + "Designer version:\t\t\t" + DesignerVersion.getCurrentVersion()
+                + " (supports PMD core " + DesignerVersion.getPmdCoreMinVersion() + ")\n"
                 + "Designer settings dir:\t\t"
                 + root.getService(DesignerRoot.DISK_MANAGER).getSettingsDirectory() + "\n"
                 + "Available languages:\t\t"

Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ public DesignerParams(String... args) {`
`42`	`42`	`public DesignerParams(Parameters params) {`
`43`	`43`	`List<String> raw = params.getRaw();`
`44`	`44`	`// error output is disabled by default`
`45`		`- if (raw.contains("-v") \|\| raw.contains("--verbose")) {`
	`45`	`+ if (raw.contains("-v") \|\| raw.contains("--verbose") \|\| raw.contains("--debug") \|\| raw.contains("-D")) {`
`46`	`46`	`isDeveloperMode = true;`
`47`	`47`	`}`
`48`	`48`