Allow injecting Paths not Files.

Make the ActionAliasMigrator use a Path, and add a basic
unit test. Need to make ConfigFile use paths to do anything
sensible.

Also refresh gradle libs in idea so JimFs shows up.

Change-Id: I0cb2692083d0fe117b91edce63d8417ddd74e288
Reviewed-on: http://gerrit.dmdirc.com/3999
Automatic-Compile: DMDirc Build Manager
Reviewed-by: Greg Holmes <greg@dmdirc.com>

.idea/inspectionProfiles/Project_Default.xml

@@ -316,4 +316,4 @@
       <option name="ignoreNonEmtpyLoops" value="false" />
     </inspection_tool>
   </profile>
-</component>
+</component>

.idea/parser.iml

@@ -21,6 +21,8 @@
     <orderEntry type="library" scope="TEST" name="Gradle: junit:junit:4.12-beta-1" level="project" />
     <orderEntry type="library" scope="TEST" name="Gradle: org.mockito:mockito-all:1.9.5" level="project" />
     <orderEntry type="library" scope="TEST" name="Gradle: org.hamcrest:hamcrest-core:1.3" level="project" />
+    <orderEntry type="library" scope="TEST" name="Gradle: com.google.jimfs:jimfs:1.0" level="project" />
+    <orderEntry type="library" scope="TEST" name="Gradle: com.google.guava:guava:16.0.1" level="project" />
   </component>
 </module>
 

.idea/plugins.iml

@@ -7,9 +7,6 @@
     <content url="file://$MODULE_DIR$/modules/plugins">
       <excludeFolder url="file://$MODULE_DIR$/modules/plugins/.gradle" />
       <excludeFolder url="file://$MODULE_DIR$/modules/plugins/build" />
-      <excludeFolder url="file://$MODULE_DIR$/modules/plugins/etc" />
-      <excludeFolder url="file://$MODULE_DIR$/modules/plugins/gradle" />
-      <excludeFolder url="file://$MODULE_DIR$/modules/plugins/lib" />
     </content>
     <orderEntry type="inheritedJdk" />
     <orderEntry type="sourceFolder" forTests="false" />
@@ -19,6 +16,8 @@
     <orderEntry type="library" scope="TEST" name="Gradle: junit:junit:4.12-beta-1" level="project" />
     <orderEntry type="library" scope="TEST" name="Gradle: org.mockito:mockito-all:1.9.5" level="project" />
     <orderEntry type="library" scope="TEST" name="Gradle: org.hamcrest:hamcrest-core:1.3" level="project" />
+    <orderEntry type="library" scope="TEST" name="Gradle: com.google.jimfs:jimfs:1.0" level="project" />
+    <orderEntry type="library" scope="TEST" name="Gradle: com.google.guava:guava:16.0.1" level="project" />
   </component>
 </module>
 

.idea/util.iml

@@ -15,15 +15,14 @@
       <sourceFolder url="file://$MODULE_DIR$/modules/util/test-res" type="java-test-resource" />
       <excludeFolder url="file://$MODULE_DIR$/modules/util/.gradle" />
       <excludeFolder url="file://$MODULE_DIR$/modules/util/build" />
-      <excludeFolder url="file://$MODULE_DIR$/modules/util/gradle" />
-      <excludeFolder url="file://$MODULE_DIR$/modules/util/lib" />
-      <excludeFolder url="file://$MODULE_DIR$/modules/util/nbproject" />
     </content>
     <orderEntry type="inheritedJdk" />
     <orderEntry type="sourceFolder" forTests="false" />
     <orderEntry type="library" scope="TEST" name="Gradle: junit:junit:4.12-beta-1" level="project" />
     <orderEntry type="library" scope="TEST" name="Gradle: org.mockito:mockito-all:1.9.5" level="project" />
     <orderEntry type="library" scope="TEST" name="Gradle: org.hamcrest:hamcrest-core:1.3" level="project" />
+    <orderEntry type="library" scope="TEST" name="Gradle: com.google.jimfs:jimfs:1.0" level="project" />
+    <orderEntry type="library" scope="TEST" name="Gradle: com.google.guava:guava:16.0.1" level="project" />
   </component>
 </module>
 

dmdirc.iml

@@ -13,15 +13,8 @@
       <sourceFolder url="file://$MODULE_DIR$/src/main/resources" type="java-resource" />
       <sourceFolder url="file://$MODULE_DIR$/src/test/resources" type="java-test-resource" />
       <sourceFolder url="file://$MODULE_DIR$/test-res" type="java-test-resource" />
-      <excludeFolder url="file://$MODULE_DIR$/.clover" />
       <excludeFolder url="file://$MODULE_DIR$/.gradle" />
-      <excludeFolder url="file://$MODULE_DIR$/.idea" />
       <excludeFolder url="file://$MODULE_DIR$/build" />
-      <excludeFolder url="file://$MODULE_DIR$/etc" />
-      <excludeFolder url="file://$MODULE_DIR$/gradle" />
-      <excludeFolder url="file://$MODULE_DIR$/installer" />
-      <excludeFolder url="file://$MODULE_DIR$/junitreports" />
-      <excludeFolder url="file://$MODULE_DIR$/lib" />
     </content>
     <orderEntry type="inheritedJdk" />
     <orderEntry type="sourceFolder" forTests="false" />
@@ -42,6 +35,7 @@
     <orderEntry type="library" exported="" name="Gradle: com.squareup:javawriter:2.3.0" level="project" />
     <orderEntry type="library" scope="TEST" name="Gradle: junit:junit:4.12-beta-1" level="project" />
     <orderEntry type="library" scope="TEST" name="Gradle: org.mockito:mockito-all:1.9.5" level="project" />
+    <orderEntry type="library" scope="TEST" name="Gradle: com.google.jimfs:jimfs:1.0" level="project" />
   </component>
 </module>
 

modules/modules.iml

@@ -21,6 +21,8 @@
     <orderEntry type="library" scope="TEST" name="Gradle: junit:junit:4.12-beta-1" level="project" />
     <orderEntry type="library" scope="TEST" name="Gradle: org.mockito:mockito-all:1.9.5" level="project" />
     <orderEntry type="library" scope="TEST" name="Gradle: org.hamcrest:hamcrest-core:1.3" level="project" />
+    <orderEntry type="library" scope="TEST" name="Gradle: com.google.jimfs:jimfs:1.0" level="project" />
+    <orderEntry type="library" scope="TEST" name="Gradle: com.google.guava:guava:16.0.1" level="project" />
   </component>
 </module>
 

src/com/dmdirc/commandline/CommandLineOptionsModule.java

@@ -23,6 +23,7 @@
 package com.dmdirc.commandline;
 
 import java.io.File;
+import java.nio.file.Path;
 
 import javax.inject.Qualifier;
 import javax.inject.Singleton;
@@ -192,4 +193,46 @@ public class CommandLineOptionsModule {
         return baseDirectory;
     }
 
+    @Provides
+    @Singleton
+    @Directory(DirectoryType.BASE)
+    public Path getBasePath(@Directory(DirectoryType.BASE) final String directory) {
+        return new File(directory).toPath();
+    }
+
+    @Provides
+    @Singleton
+    @Directory(DirectoryType.PLUGINS)
+    public Path getPluginsPath(@Directory(DirectoryType.PLUGINS) final String directory) {
+        return new File(directory).toPath();
+    }
+
+    @Provides
+    @Singleton
+    @Directory(DirectoryType.ACTIONS)
+    public Path getActionsPath(@Directory(DirectoryType.ACTIONS) final String directory) {
+        return new File(directory).toPath();
+    }
+
+    @Provides
+    @Singleton
+    @Directory(DirectoryType.IDENTITIES)
+    public Path getIdentitiesPath(@Directory(DirectoryType.IDENTITIES) final String directory) {
+        return new File(directory).toPath();
+    }
+
+    @Provides
+    @Singleton
+    @Directory(DirectoryType.ERRORS)
+    public Path getErrorsPath(@Directory(DirectoryType.ERRORS) final String directory) {
+        return new File(directory).toPath();
+    }
+
+    @Provides
+    @Singleton
+    @Directory(DirectoryType.THEMES)
+    public Path getThemesPath(@Directory(DirectoryType.THEMES) final String directory) {
+        return new File(directory).toPath();
+    }
+
 }

src/com/dmdirc/commandparser/aliases/ActionAliasMigrator.java

@@ -22,19 +22,23 @@
 
 package com.dmdirc.commandparser.aliases;
 
+import com.dmdirc.DMDircMBassador;
 import com.dmdirc.commandline.CommandLineOptionsModule.Directory;
 import com.dmdirc.commandline.CommandLineOptionsModule.DirectoryType;
+import com.dmdirc.events.AppErrorEvent;
 import com.dmdirc.interfaces.Migrator;
+import com.dmdirc.logger.ErrorLevel;
 import com.dmdirc.util.io.ConfigFile;
 import com.dmdirc.util.io.InvalidConfigFileException;
 
 import com.google.common.base.Joiner;
 
-import java.io.File;
 import java.io.IOException;
+import java.nio.file.DirectoryStream;
+import java.nio.file.Files;
+import java.nio.file.Path;
 import java.util.Map;
 
-import javax.annotation.Nullable;
 import javax.inject.Inject;
 import javax.inject.Singleton;
 
@@ -44,9 +48,10 @@ import javax.inject.Singleton;
 @Singleton
 public class ActionAliasMigrator implements Migrator {
 
-    private final File directory;
+    private final Path directory;
     private final AliasFactory aliasFactory;
     private final AliasManager aliasManager;
+    private final DMDircMBassador eventBus;
 
     /**
      * Creates a new alias migrator.
@@ -54,33 +59,38 @@ public class ActionAliasMigrator implements Migrator {
      * @param directory    The base directory to read alias actions from.
      * @param aliasFactory The factory to use to create new aliases.
      * @param aliasManager The manager to add aliases to.
+     * @param eventBus     Bus to report errors on.
      */
     @Inject
     public ActionAliasMigrator(
-            @Directory(DirectoryType.ACTIONS) final String directory,
+            @Directory(DirectoryType.ACTIONS) final Path directory,
             final AliasFactory aliasFactory,
-            final AliasManager aliasManager) {
-        this.directory = new File(directory, "aliases");
+            final AliasManager aliasManager,
+            final DMDircMBassador eventBus) {
+        this.directory = directory.resolve("aliases");
         this.aliasFactory = aliasFactory;
         this.aliasManager = aliasManager;
+        this.eventBus = eventBus;
     }
 
     @Override
     public boolean needsMigration() {
-        return directory.exists();
+        return Files.isDirectory(directory);
     }
 
     @Override
     public void migrate() {
-        @Nullable final File[] files = directory.listFiles();
-        if (files != null) {
-            for (File child : files) {
-                if (migrate(child)) {
-                    child.delete();
+        try (DirectoryStream<Path> directoryStream = Files.newDirectoryStream(directory)) {
+            for (Path path : directoryStream) {
+                if (migrate(path)) {
+                    Files.delete(path);
                 }
             }
+            Files.delete(directory);
+        } catch (IOException ex) {
+            eventBus.publish(new AppErrorEvent(ErrorLevel.MEDIUM, ex,
+                    "Unable to migrate aliases", ex.getMessage()));
         }
-        directory.delete();
     }
 
     /**
@@ -90,9 +100,10 @@ public class ActionAliasMigrator implements Migrator {
      *
      * @return True if the file was migrated successfully, false otherwise.
      */
-    private boolean migrate(final File file) {
+    private boolean migrate(final Path file) {
         try {
-            final ConfigFile configFile = new ConfigFile(file);
+            // TODO: Make ConfigFile take a Path.
+            final ConfigFile configFile = new ConfigFile(file.toFile());
             configFile.read();
 
             final String response = Joiner.on('\n').join(configFile.getFlatDomain("response"));

src/com/dmdirc/config/ConfigModule.java

@@ -56,7 +56,6 @@ import static com.dmdirc.commandline.CommandLineOptionsModule.DirectoryType;
 @Module(library = true, complete = false)
 public class ConfigModule {
 
-
     @Provides
     @Singleton
     public IdentityManager getIdentityManager(

test-res/com/dmdirc/commandparser/aliases/op-greater-0

@@ -0,0 +1,37 @@
+# This is a DMDirc configuration file.
+# Written on: Sun Nov 25 13:32:17 GMT 2007
+
+# This section indicates which sections below take key/value
+# pairs, rather than a simple list. It should be placed above
+# any sections that take key/values.
+keysections:
+  condition 0
+  condition 1
+  condition 2
+
+triggers:
+  UNKNOWN_COMMAND
+
+response:
+  /mode ooooooooooooooo $1-
+
+format:
+
+
+condition 0:
+  argument=1
+  component=STRING_STRING
+  target=op
+  comparison=STRING_EQUALS
+
+condition 1:
+  argument=2
+  component=STRINGARRAY_LENGTH
+  target=0
+  comparison=INT_GREATER
+
+condition 2:
+  argument=2
+  component=STRINGARRAY_LENGTH
+  target=16
+  comparison=INT_LESS

test-res/com/dmdirc/commandparser/aliases/unset-equals-2

@@ -0,0 +1,30 @@
+# This is a DMDirc configuration file.
+# Written on: Sun Nov 25 13:32:17 GMT 2007
+
+# This section indicates which sections below take key/value
+# pairs, rather than a simple list. It should be placed above
+# any sections that take key/values.
+keysections:
+  condition 0
+  condition 1
+
+triggers:
+  UNKNOWN_COMMAND
+
+response:
+  /set --unset $1-
+
+format:
+
+
+condition 0:
+  argument=1
+  component=STRING_STRING
+  target=unset
+  comparison=STRING_EQUALS
+
+condition 1:
+  argument=2
+  component=STRINGARRAY_LENGTH
+  target=2
+  comparison=INT_EQUALS

test/com/dmdirc/commandparser/aliases/ActionAliasMigratorTest.java

@@ -0,0 +1,93 @@
+/*
+ * Copyright (c) 2006-2014 DMDirc Developers
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.dmdirc.commandparser.aliases;
+
+import com.dmdirc.DMDircMBassador;
+
+import com.google.common.jimfs.Configuration;
+import com.google.common.jimfs.Jimfs;
+
+import java.io.IOException;
+import java.nio.file.FileSystem;
+import java.nio.file.Files;
+
+import org.junit.Before;
+import org.junit.Ignore;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import org.mockito.runners.MockitoJUnitRunner;
+
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+
+@RunWith(MockitoJUnitRunner.class)
+public class ActionAliasMigratorTest {
+
+    @Mock private AliasManager aliasManager;
+    @Mock private AliasFactory aliasFactory;
+    @Mock private DMDircMBassador eventBus;
+
+    private FileSystem fs;
+    private ActionAliasMigrator migrator1;
+    private ActionAliasMigrator migrator2;
+
+    @Before
+    public void setup() throws IOException {
+        fs = Jimfs.newFileSystem(Configuration.unix());
+        Files.createDirectories(fs.getPath("test1/aliases"));
+        Files.createDirectories(fs.getPath("test2/other-stuff/aliases"));
+        Files.copy(getClass().getResource("op-greater-0").openStream(),
+                fs.getPath("test1/aliases/op"));
+        Files.copy(getClass().getResource("unset-equals-2").openStream(),
+                fs.getPath("test1/aliases/unset"));
+
+        migrator1 = new ActionAliasMigrator(fs.getPath("test1"), aliasFactory,
+                aliasManager, eventBus);
+        migrator2 = new ActionAliasMigrator(fs.getPath("test2"), aliasFactory,
+                aliasManager, eventBus);
+    }
+
+    @Test
+    public void testNeedMigration() {
+        assertTrue(migrator1.needsMigration());
+        assertFalse(migrator2.needsMigration());
+    }
+
+    @Test
+    @Ignore("Converts to a file, throws UnsupportedOperationException under JimFs")
+    public void testDeletesFilesAfterMigration() {
+        migrator1.migrate();
+        assertFalse(Files.exists(fs.getPath("test1/aliases/unset")));
+        assertFalse(Files.exists(fs.getPath("test1/aliases/op")));
+        assertFalse(Files.exists(fs.getPath("test1/aliases")));
+        assertTrue(Files.exists(fs.getPath("test1")));
+    }
+
+    @Test
+    public void testLeavesOtherFilesDuringMigration() {
+        migrator2.migrate();
+        assertTrue(Files.exists(fs.getPath("test2/other-stuff/aliases")));
+    }
+
+}