Refactor copy-method to be much more elegant, now

Author: pesse

src/main/java/org/utplsql/api/ResourceUtil.java

@@ -0,0 +1,61 @@
+package org.utplsql.api;
+
+import org.utplsql.api.reporter.CoverageHTMLReporter;
+
+import java.io.IOException;
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.nio.file.*;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+
+/** Helper class for dealing with Resources
+ *
+ * @author pesse
+ */
+public class ResourceUtil {
+
+    /** Returns the Path to a resource so it is walkable no matter if it's inside a jar or on the file system
+     *
+     * @param resourceName The name of the resource
+     * @return Path to the resource, either in JAR or on file system
+     * @throws IOException
+     * @throws URISyntaxException
+     */
+    public static Path getPathToResource( String resourceName ) throws IOException, URISyntaxException {
+        URI uri = CoverageHTMLReporter.class.getResource(resourceName).toURI();
+        Path myPath;
+        if (uri.getScheme().equalsIgnoreCase("jar")) {
+            FileSystem fileSystem = FileSystems.newFileSystem(uri, Collections.emptyMap());
+            myPath = fileSystem.getPath(resourceName);
+        } else {
+            myPath = Paths.get(uri);
+        }
+
+        return myPath;
+    }
+
+    /** Returns the relative paths of all children of the given resource. Relative path begins from the first atom of the given path.
+     *
+     * @param resourceAsPath The resource to get children from
+     * @param filesOnly If set to true it will only return files, not directories
+     * @return List of relative Paths to the children
+     * @throws IOException
+     * @throws URISyntaxException
+     */
+    public static List<Path> getListOfChildren( Path resourceAsPath, boolean filesOnly ) throws IOException, URISyntaxException {
+
+        Path resourcePath = getPathToResource("/"+resourceAsPath.toString());
+        int relativeStartIndex = resourcePath.getNameCount()-resourceAsPath.getNameCount();
+
+        final List<Path> result = new ArrayList<>();
+
+        Files.walk(resourcePath)
+                .filter(p -> !filesOnly || p.toFile().isFile())
+                .forEach( p -> result.add(p.subpath(relativeStartIndex, p.getNameCount())));
+
+        return result;
+    }
+
+}

src/main/java/org/utplsql/api/reporter/CoverageHTMLReporter.java

@@ -1,15 +1,19 @@
 package org.utplsql.api.reporter;
 
 import org.utplsql.api.CustomTypes;
+import org.utplsql.api.ResourceUtil;
 
 import java.io.IOException;
 import java.io.InputStream;
+import java.net.URISyntaxException;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.sql.SQLException;
 import java.sql.SQLInput;
 import java.sql.SQLOutput;
+import java.util.List;
+import java.util.function.Consumer;
 
 public class CoverageHTMLReporter extends Reporter {
 
@@ -64,55 +68,63 @@ public void writeSQL(SQLOutput stream) throws SQLException {
         stream.writeString(getAssetsPath());
     }
 
-    private static void copyFileFromClasspath( Path assetPath, Path targetDirectory ) throws IOException {
-        Files.createDirectories(targetDirectory.resolve(assetPath).getParent());
+    /** Copies files from Classpath to a target directory.
+     * Can omit the first x folders of the asset-path when copying to the target directory
+     *
+     * @param assetPath Path of the asset in the classpath
+     * @param targetDirectory Target directory to copy the asset to
+     * @param filterNumOfFolders Omits the first x folders of the path when copying the asset to the target directory
+     * @throws IOException
+     */
+    private static void copyFileFromClasspath( Path assetPath, Path targetDirectory, int filterNumOfFolders ) throws IOException {
+
+        Path assetStartPath = assetPath.subpath(filterNumOfFolders, assetPath.getNameCount());
+        Path targetAssetPath = targetDirectory.resolve(assetStartPath);
+
+        Files.createDirectories(targetAssetPath.getParent());
 
         try (InputStream is = CoverageHTMLReporter.class.getClassLoader()
-                .getResourceAsStream(
-                        Paths.get("CoverageHTMLReporter").resolve(assetPath).toString()
-                )
+                .getResourceAsStream(assetPath.toString())
         ) {
-            Files.copy( is, targetDirectory.resolve(assetPath) );
+            Files.copy( is, targetAssetPath );
         }
     }
 
     /** Write the bundled assets necessary for the HTML Coverage report to a given targetPath
      *
      * @param targetDirectory Directory where the assets should be stored
-     * @throws IOException
+     * @throws RuntimeException
      */
-    public static void writeReportAssetsTo(Path targetDirectory) throws IOException {
-
-        Files.createDirectories(targetDirectory);
-
-        // Simplest approach to start with
-        copyFileFromClasspath(Paths.get("application.css"), targetDirectory);
-        copyFileFromClasspath(Paths.get("application.js"), targetDirectory);
-        copyFileFromClasspath(Paths.get("favicon_green.png"), targetDirectory);
-        copyFileFromClasspath(Paths.get("favicon_red.png"), targetDirectory);
-        copyFileFromClasspath(Paths.get("favicon_yellow.png"), targetDirectory);
-        copyFileFromClasspath(Paths.get("loading.gif"), targetDirectory);
-        copyFileFromClasspath(Paths.get("magnify.png"), targetDirectory);
-
-        copyFileFromClasspath(Paths.get("colorbox", "border.png"), targetDirectory);
-        copyFileFromClasspath(Paths.get("colorbox", "controls.png"), targetDirectory);
-        copyFileFromClasspath(Paths.get("colorbox", "loading.gif"), targetDirectory);
-        copyFileFromClasspath(Paths.get("colorbox", "loading_background.png"), targetDirectory);
-
-        copyFileFromClasspath(Paths.get("images", "ui-bg_flat_0_aaaaaa_40x100.png"), targetDirectory);
-        copyFileFromClasspath(Paths.get("images", "ui-bg_flat_75_ffffff_40x100.png"), targetDirectory);
-        copyFileFromClasspath(Paths.get("images", "ui-bg_glass_55_fbf9ee_1x400.png"), targetDirectory);
-        copyFileFromClasspath(Paths.get("images", "ui-bg_glass_65_ffffff_1x400.png"), targetDirectory);
-        copyFileFromClasspath(Paths.get("images", "ui-bg_glass_75_dadada_1x400.png"), targetDirectory);
-        copyFileFromClasspath(Paths.get("images", "ui-bg_glass_75_e6e6e6_1x400.png"), targetDirectory);
-        copyFileFromClasspath(Paths.get("images", "ui-bg_glass_95_fef1ec_1x400.png"), targetDirectory);
-        copyFileFromClasspath(Paths.get("images", "ui-bg_highlight-soft_75_cccccc_1x100.png"), targetDirectory);
-        copyFileFromClasspath(Paths.get("images", "ui-icons_2e83ff_256x240.png"), targetDirectory);
-        copyFileFromClasspath(Paths.get("images", "ui-icons_222222_256x240.png"), targetDirectory);
-        copyFileFromClasspath(Paths.get("images", "ui-icons_454545_256x240.png"), targetDirectory);
-        copyFileFromClasspath(Paths.get("images", "ui-icons_888888_256x240.png"), targetDirectory);
-        copyFileFromClasspath(Paths.get("images", "ui-icons_cd0a0a_256x240.png"), targetDirectory);
+    public static void writeReportAssetsTo(Path targetDirectory) throws RuntimeException {
+
+        try {
+            Files.createDirectories(targetDirectory);
+
+            List<Path> paths = ResourceUtil.getListOfChildren(Paths.get("CoverageHTMLReporter"), true);
 
+            paths.forEach((ThrowingConsumer<Path>) p -> copyFileFromClasspath(p, targetDirectory, 1) );
+        }
+        catch ( IOException | URISyntaxException e ) {
+            throw new RuntimeException(e);
+        }
+    }
+
+    /** Functional Interface just to throw Exception from Consumer
+     *
+     * @param <T>
+     */
+    @FunctionalInterface
+    public interface ThrowingConsumer<T> extends Consumer<T> {
+
+        @Override
+        default void accept(final T elem) {
+            try {
+                acceptThrows(elem);
+            } catch (final Exception e) {
+                throw new RuntimeException(e);
+            }
+        }
 
+        void acceptThrows( T t ) throws IOException;
     }
 }

src/test/java/org/utplsql/api/reporter/CoverageHTMLReporterAssetTest.java

@@ -56,7 +56,7 @@ public void writeReporterAssetsTo()
             testFileExists(targetPath.resolve(Paths.get("loading.gif")));
             testFileExists(targetPath.resolve(Paths.get("magnify.png")));
         }
-        catch ( IOException e )
+        catch ( RuntimeException e )
         {
             fail(e);
         }