Merge pull request #74 from adangel:remove-commons-io

Remove commons-io #74

Author: adangel

CHANGELOG.md

@@ -9,12 +9,14 @@
 * [#61](https://github.com/pmd/pmd-designer/issues/61) Remove dependency to jcommander
 * [#62](https://github.com/pmd/pmd-designer/issues/62) Exceptions and errors are not always logged
 * [#63](https://github.com/pmd/pmd-designer/issues/63) Update to PMD 7.0.0-rc3
+* [#73](https://github.com/pmd/pmd-designer/issues/73) Remove commons-io dependency
 
 **Merged pull requests:**
 
 * [#68](https://github.com/pmd/pmd-designer/pull/68) Expose all properties with default values by [@jsotuyod](https://github.com/jsotuyod)
 * [#69](https://github.com/pmd/pmd-designer/pull/69) Perform the persistence asynchronously to not block the main (UI) thread #69 by [@adangel](https://github.com/adangel)
 * [#70](https://github.com/pmd/pmd-designer/pull/70) Fix drag and drop for tests case violations by [@adangel](https://github.com/adangel)
+* [#74](https://github.com/pmd/pmd-designer/pull/74) Remove commons-io by [@adangel](https://github.com/adangel)
 
 See https://github.com/pmd/pmd-designer/milestone/11
 

pom.xml

@@ -644,12 +644,6 @@
             <artifactId>commons-logging</artifactId>
             <version>1.2</version>
         </dependency>
-        <dependency>
-            <groupId>commons-io</groupId>
-            <artifactId>commons-io</artifactId>
-            <version>2.7</version>
-        </dependency>
-
 
         <!-- Icon packs -->
         <!-- Unfortunately these can't be updated as the author now uses Java 11...-->

src/main/java/net/sourceforge/pmd/util/fxdesigner/MainDesignerController.java

@@ -23,7 +23,6 @@
 import java.util.Stack;
 import java.util.stream.Collectors;
 
-import org.apache.commons.io.IOUtils;
 import org.checkerframework.checker.nullness.qual.NonNull;
 import org.reactfx.Subscription;
 import org.reactfx.value.Var;
@@ -37,6 +36,7 @@
 import net.sourceforge.pmd.util.fxdesigner.util.AuxLanguageRegistry;
 import net.sourceforge.pmd.util.fxdesigner.util.DesignerUtil;
 import net.sourceforge.pmd.util.fxdesigner.util.LimitedSizeStack;
+import net.sourceforge.pmd.util.fxdesigner.util.ResourceUtil;
 import net.sourceforge.pmd.util.fxdesigner.util.SoftReferenceCache;
 import net.sourceforge.pmd.util.fxdesigner.util.beans.SettingsPersistenceUtil.PersistentProperty;
 import net.sourceforge.pmd.util.fxdesigner.util.controls.DynamicWidthChoicebox;
@@ -218,7 +218,7 @@ private void onOpenFileClicked() {
     private void loadSourceFromFile(File file) {
         if (file != null) {
             try {
-                String source = IOUtils.toString(Files.newInputStream(file.toPath()), StandardCharsets.UTF_8);
+                String source = ResourceUtil.readToString(Files.newInputStream(file.toPath()), StandardCharsets.UTF_8);
                 sourceEditorController.setText(source);
                 LanguageVersion guess = getLanguageVersionFromExtension(file.getName());
                 if (guess == null) {

src/main/java/net/sourceforge/pmd/util/fxdesigner/SourceEditorController.java

@@ -18,7 +18,6 @@
 import java.util.Objects;
 import java.util.stream.Collectors;
 
-import org.apache.commons.io.IOUtils;
 import org.apache.commons.lang3.StringUtils;
 import org.checkerframework.checker.nullness.qual.NonNull;
 import org.controlsfx.control.PopOver;
@@ -331,31 +330,10 @@ private void handleTestOpenRequest(@NonNull LiveTestCase oldValue, @NonNull Live
 
 
     private String getDefaultText() {
-        try {
-            // TODO this should take language into account
-            //  it doesn't handle the case where java is not on the classpath
+        // TODO this should take language into account
+        //  it doesn't handle the case where java is not on the classpath
 
-            return IOUtils.resourceToString(ResourceUtil.resolveResource("placeholders/editor.java"), StandardCharsets.UTF_8);
-        } catch (IOException e) {
-            e.printStackTrace();
-            return "class Foo {\n"
-                + "\n"
-                + "    /*\n"
-                + "        Welcome to the PMD Rule designer :)\n"
-                + "\n"
-                + "        Type some code in this area\n"
-                + "        \n"
-                + "        On the right, the Abstract Syntax Tree is displayed\n"
-                + "        On the left, you can examine the XPath attributes of\n"
-                + "        the nodes you select\n"
-                + "        \n"
-                + "        You can set the language you'd like to work in with\n"
-                + "        the cog icon above this code area\n"
-                + "     */\n"
-                + "\n"
-                + "    int i = 0;\n"
-                + "}";
-        }
+        return ResourceUtil.readToString(SourceEditorController.class.getResourceAsStream(ResourceUtil.resolveResource("placeholders/editor.java")), StandardCharsets.UTF_8);
     }
 
 

src/main/java/net/sourceforge/pmd/util/fxdesigner/popups/SimplePopups.java

@@ -7,12 +7,10 @@
 import static java.lang.Double.max;
 import static java.lang.Math.min;
 
-import java.io.IOException;
 import java.nio.charset.StandardCharsets;
 import java.util.Locale;
 import java.util.stream.Collectors;
 
-import org.apache.commons.io.IOUtils;
 import org.checkerframework.checker.nullness.qual.NonNull;
 import org.checkerframework.checker.nullness.qual.Nullable;
 import org.kordamp.ikonli.javafx.FontIcon;
@@ -25,6 +23,7 @@
 import net.sourceforge.pmd.util.fxdesigner.app.DesignerRoot;
 import net.sourceforge.pmd.util.fxdesigner.util.AuxLanguageRegistry;
 import net.sourceforge.pmd.util.fxdesigner.util.DesignerUtil;
+import net.sourceforge.pmd.util.fxdesigner.util.ResourceUtil;
 
 import javafx.animation.Animation;
 import javafx.animation.Interpolator;
@@ -192,11 +191,7 @@ public static void showLicensePopup() {
         licenseAlert.setHeaderText("License");
 
         ScrollPane scroll = new ScrollPane();
-        try {
-            scroll.setContent(new TextArea(IOUtils.toString(SimplePopups.class.getResourceAsStream(LICENSE_FILE_PATH), StandardCharsets.UTF_8)));
-        } catch (IOException e) {
-            e.printStackTrace();
-        }
+        scroll.setContent(new TextArea(ResourceUtil.readToString(SimplePopups.class.getResourceAsStream(LICENSE_FILE_PATH), StandardCharsets.UTF_8)));
 
         licenseAlert.getDialogPane().setContent(scroll);
         licenseAlert.showAndWait();

src/main/java/net/sourceforge/pmd/util/fxdesigner/util/ResourceUtil.java

@@ -6,10 +6,14 @@
 
 import java.io.File;
 import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.io.UncheckedIOException;
 import java.net.MalformedURLException;
 import java.net.URI;
 import java.net.URISyntaxException;
 import java.net.URL;
+import java.nio.charset.Charset;
 import java.nio.file.FileSystem;
 import java.nio.file.FileSystemNotFoundException;
 import java.nio.file.FileSystems;
@@ -24,9 +28,6 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
-import org.apache.commons.io.FilenameUtils;
-
-
 /**
  * Deals with resource fetching and the hardcore details of when we're in a Jar
  * vs when we're exploded in the IDE.
@@ -93,10 +94,10 @@ private static Stream<Path> pathsInResource(ClassLoader classLoader,
     /** Maps paths to classes. */
     private static Class<?> toClass(Path path, String packageName) {
         return Optional.of(path)
-                       .filter(p -> "class".equalsIgnoreCase(FilenameUtils.getExtension(path.toString())))
+                       .filter(p -> "class".equalsIgnoreCase(getFilenameExtension(path.toString())))
             .<Class<?>>map(p -> {
                 try {
-                    return Class.forName(packageName + "." + FilenameUtils.getBaseName(path.getFileName().toString()));
+                    return Class.forName(packageName + "." + getFilenameBase(path.getFileName().toString()));
                 } catch (ClassNotFoundException e) {
                     e.printStackTrace();
                     return null;
@@ -105,6 +106,24 @@ private static Class<?> toClass(Path path, String packageName) {
             .orElse(null);
     }
 
+    private static String getFilenameExtension(String name) {
+        String filename = Paths.get(name).getFileName().toString();
+        int lastDot = filename.lastIndexOf('.');
+        if (lastDot > -1) {
+            return filename.substring(lastDot + 1);
+        }
+        return filename;
+    }
+
+    private static String getFilenameBase(String name) {
+        String filename = Paths.get(name).getFileName().toString();
+        int lastDot = filename.lastIndexOf('.');
+        if (lastDot > -1) {
+            return filename.substring(0, lastDot);
+        }
+        return filename;
+    }
+
     private static String getJarRelativePath(URI uri) {
         if ("jar".equals(uri.getScheme())) {
             // we have to cut out the path to the jar + '!'
@@ -176,4 +195,18 @@ public static FileSystem getFileSystem(URI uri) throws IOException {
             }
         }
     }
+
+    public static String readToString(InputStream stream, Charset charset) {
+        try (InputStreamReader reader = new InputStreamReader(stream, charset)) {
+            StringBuilder result = new StringBuilder(8192);
+            int count;
+            char[] buffer = new char[8192];
+            while ((count = reader.read(buffer)) != -1) {
+                result.append(buffer, 0, count);
+            }
+            return result.toString();
+        } catch (IOException e) {
+            throw new UncheckedIOException(e);
+        }
+    }
 }