Move Yaml utils to com.dmdirc.util.io.yaml bundle.

Issue #750

build.gradle

@@ -45,7 +45,10 @@ dependencies {
     bundle group: 'com.google.guava', name:'guava', version: '19.0'
     bundle group: 'net.engio', name: 'mbassador', version: '1.3.0'
     bundle group: 'com.google.code.gson', name: 'gson', 'version': '2.5'
+
     bundle group: 'com.dmdirc', name: 'com.dmdirc.events.eventbus', version: '+', changing: true
+    bundle group: 'com.dmdirc', name: 'com.dmdirc.util.io.yaml', version: '+', changing: true
+
     bundle group: 'com.dmdirc', name: 'api', version: '+', changing: true
     bundle group: 'com.dmdirc', name: 'util', version: '+', changing: true
     bundle group: 'com.dmdirc', name: 'parser-common', version: '+', changing: true

bundles/com.dmdirc.util.io.yaml/build.gradle

@@ -0,0 +1,55 @@
+/*
+ * Copyright (c) 2006-2017 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.
+ */
+
+plugins {
+  id 'java'
+  id 'findbugs'
+  id 'pmd'
+  id 'idea'
+}
+
+group = 'com.dmdirc'
+
+idea {
+    module {
+         sourceDirs += file('src/main/generated')
+         testSourceDirs += file('src/test/generated_tests')
+         generatedSourceDirs = [file('src/main/generated'), file('src/test/generated_tests')]
+    }
+}
+
+configurations.all {
+    resolutionStrategy.cacheDynamicVersionsFor 2, 'minutes'
+    resolutionStrategy.cacheChangingModulesFor 2, 'minutes'
+}
+
+dependencies {
+    compile group: 'com.google.code.findbugs', name: 'jsr305', version: '3.0.1'
+    compile group: 'org.slf4j', name: 'slf4j-api', version:'1.7.21'
+    compile group: 'com.esotericsoftware.yamlbeans', name: 'yamlbeans', version: '1.09'
+
+    testCompile group: 'junit', name: 'junit', version: '4.12'
+    testCompile group: 'org.mockito', name: 'mockito-core', version: '1.10.19'
+}
+
+sourceCompatibility = 1.8
+targetCompatibility = 1.8
+
+repositories {
+    mavenCentral()
+}
+

src/main/java/com/dmdirc/util/BaseYamlStore.java → bundles/com.dmdirc.util.io.yaml/src/main/java/com/dmdirc/util/io/yaml/BaseYamlStore.java

@@ -15,8 +15,10 @@
  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
-package com.dmdirc.util;
+package com.dmdirc.util.io.yaml;
 
+import com.esotericsoftware.yamlbeans.YamlReader;
+import com.esotericsoftware.yamlbeans.YamlWriter;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.InputStreamReader;
@@ -28,14 +30,10 @@ import java.util.ArrayList;
 import java.util.Collection;
 import java.util.List;
 import java.util.Optional;
-
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import com.esotericsoftware.yamlbeans.YamlReader;
-import com.esotericsoftware.yamlbeans.YamlWriter;
-
-import static com.dmdirc.util.YamlReaderUtils.asList;
+import static com.dmdirc.util.io.yaml.YamlReaderUtils.asList;
 import static java.util.stream.Collectors.toList;
 
 /**
@@ -43,17 +41,20 @@ import static java.util.stream.Collectors.toList;
  */
 public abstract class BaseYamlStore<T> {
 
-    /** The charset to use when reading and writing files. */
+    /**
+     * The charset to use when reading and writing files.
+     */
     private static final String CHARSET = "UTF-8";
 
-    /** Logger to use. */
+    /**
+     * Logger to use.
+     */
     private static final Logger LOG = LoggerFactory.getLogger(BaseYamlStore.class);
 
     /**
      * Reads a list of items from the YAML file at the specified path.
-     *
-     * <p>Each item is converted from an object into some form of model by invoking the
-     * {@link #convertFromYaml} method.
+     * <p>
+     * Each item is converted from an object into some form of model by invoking the {@link #convertFromYaml} method.
      *
      * @param path The path of the file to read.
      * @return A list of successfully converted model objects.
@@ -62,7 +63,7 @@ public abstract class BaseYamlStore<T> {
         final List<T> results = new ArrayList<>();
         if (Files.exists(path)) {
             try (final InputStream stream = Files.newInputStream(path);
-                    final InputStreamReader reader = new InputStreamReader(stream, CHARSET)) {
+                 final InputStreamReader reader = new InputStreamReader(stream, CHARSET)) {
                 final YamlReader yamlReader = new YamlReader(reader);
                 results.addAll(asList(yamlReader.read(), this::convertFromYaml));
                 yamlReader.close();
@@ -75,21 +76,20 @@ public abstract class BaseYamlStore<T> {
 
     /**
      * Writes a collection of items to a YAML file at the specified path.
-     *
-     * <p>Each item is converted into a "plain" object by invoking the {@link #convertToYaml}
-     * method.
+     * <p>
+     * Each item is converted into a "plain" object by invoking the {@link #convertToYaml} method.
      *
      * @param path The path of the file to write.
      * @param items A collection of items to write.
      */
     protected void write(final Path path, final Collection<T> items) {
         try (final OutputStream stream = Files.newOutputStream(path);
-                final OutputStreamWriter writer = new OutputStreamWriter(stream, CHARSET)) {
+             final OutputStreamWriter writer = new OutputStreamWriter(stream, CHARSET)) {
             final YamlWriter yamlWriter = new YamlWriter(writer);
             yamlWriter.write(items.parallelStream().map(this::convertToYaml).collect(toList()));
             yamlWriter.close();
         } catch (IOException ex) {
-            LOG.error(LogUtils.USER_ERROR, "Unable to write to {}", path, ex);
+            LOG.warn("Unable to write to {}", path, ex);
         }
     }
 

src/main/java/com/dmdirc/util/YamlReaderUtils.java → bundles/com.dmdirc.util.io.yaml/src/main/java/com/dmdirc/util/io/yaml/YamlReaderUtils.java

@@ -15,19 +15,15 @@
  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
-package com.dmdirc.util;
-
+package com.dmdirc.util.io.yaml;
 
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
 import java.util.function.Function;
 import java.util.stream.Collectors;
-
 import javax.annotation.Nullable;
 
-import static com.google.common.base.Preconditions.checkNotNull;
-
 /**
  * Provides utility methods for classes that read from YAML files.
  */
@@ -43,7 +39,6 @@ public final class YamlReaderUtils {
      * suppression to be reduced just to the single line.
      *
      * @param map The wildcard map to be cast.
-     *
      * @return A usable object-to-object map.
      */
     @SuppressWarnings("unchecked")
@@ -57,7 +52,6 @@ public final class YamlReaderUtils {
      * suppression to be reduced just to the single line.
      *
      * @param list The wildcard list to be cast.
-     *
      * @return A usable object list.
      */
     @SuppressWarnings("unchecked")
@@ -69,55 +63,47 @@ public final class YamlReaderUtils {
      * Checks that the specified object is a map, and casts it.
      *
      * @param object The object to be cast.
-     *
      * @return The given object cast as a map.
-     *
      * @throws IllegalArgumentException If the specified object is not a map.
      */
-    public static Map<Object, Object> asMap(@Nullable final Object object)
-            throws IllegalArgumentException {
+    public static Map<Object, Object> asMap(@Nullable final Object object) throws IllegalArgumentException {
         if (object instanceof Map) {
             return uncheckedCast((Map<?, ?>) object);
         }
 
-        throw new IllegalArgumentException("Unexpected element. Found "
-                + simpleName(object) + ", expected Map");
+        throw new IllegalArgumentException("Unexpected element. Found " + simpleName(object) + ", expected Map");
     }
 
     /**
      * Checks that the specified object is a list, and casts it.
      *
      * @param object The object to be cast.
-     *
      * @return The given object cast as a list.
-     *
      * @throws IllegalArgumentException If the specified object is not a list.
      */
-    public static List<Object> asList(@Nullable final Object object)
-            throws IllegalArgumentException {
+    public static List<Object> asList(@Nullable final Object object) throws IllegalArgumentException {
         if (object instanceof List) {
             return uncheckedCast((List<?>) object);
         }
 
-        throw new IllegalArgumentException("Unexpected element. Found "
-                + simpleName(object) + ", expected List");
+        throw new IllegalArgumentException("Unexpected element. Found " + simpleName(object) + ", expected List");
     }
 
     /**
      * Checks that the specified object is a list, and casts it.
      *
      * @param object The object to be cast.
-     * @param convertor The function to use to convert each list member to the desired type.
-     *
+     * @param converter The function to use to convert each list member to the desired type.
      * @return The given object cast as a list.
-     *
      * @throws IllegalArgumentException If the specified object is not a list.
      */
-    public static <T> List<T> asList(@Nullable final Object object,
-            final Function<Object, Optional<T>> convertor) throws IllegalArgumentException {
+    public static <T> List<T> asList(@Nullable final Object object, final Function<Object, Optional<T>> converter)
+            throws IllegalArgumentException {
         return asList(object).parallelStream()
-                .map(convertor).filter(Optional::isPresent)
-                .map(Optional::get).collect(Collectors.toList());
+                .map(converter)
+                .filter(Optional::isPresent)
+                .map(Optional::get)
+                .collect(Collectors.toList());
     }
 
     /**
@@ -125,16 +111,11 @@ public final class YamlReaderUtils {
      *
      * @param map The map to retrieve the entry from.
      * @param key The key of the entry to retrieve.
-     *
      * @return The string representation of the value of the key.
-     *
      * @throws IllegalArgumentException If the specified key is not present, or is empty.
      */
     public static String requiredString(final Map<Object, Object> map, final String key)
             throws IllegalArgumentException {
-        checkNotNull(map);
-        checkNotNull(key);
-
         if (!map.containsKey(key)) {
             throw new IllegalArgumentException("Required key not present: " + key);
         }
@@ -152,14 +133,10 @@ public final class YamlReaderUtils {
      *
      * @param map The map to retrieve the entry from.
      * @param key The key of the entry to retrieve.
-     *
      * @return The string value of the entry with the given key, or {@code null} if not present.
      */
     @Nullable
     public static String optionalString(final Map<Object, Object> map, final String key) {
-        checkNotNull(map);
-        checkNotNull(key);
-
         final Object value = map.get(key);
         return value == null ? null : value.toString();
     }
@@ -168,7 +145,6 @@ public final class YamlReaderUtils {
      * Gets the simple name of the given object's class.
      *
      * @param object The object to get the class name of
-     *
      * @return The simple class name of the object, or the string {@code "null"}.
      */
     private static String simpleName(@Nullable final Object object) {

settings.gradle

@@ -1,2 +1,7 @@
 include 'api'
-include 'bundles:com.dmdirc.events.eventbus'
+
+// Include all bundles
+new File(rootDir, 'bundles').eachDir() { File dir ->
+  include 'bundles:' + dir.name
+}
+

src/main/java/com/dmdirc/commandparser/aliases/YamlAliasStore.java

@@ -17,7 +17,7 @@
 
 package com.dmdirc.commandparser.aliases;
 
-import com.dmdirc.util.BaseYamlStore;
+import com.dmdirc.util.io.yaml.BaseYamlStore;
 
 import java.nio.file.Path;
 import java.util.HashMap;
@@ -29,8 +29,8 @@ import java.util.Set;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import static com.dmdirc.util.YamlReaderUtils.asMap;
-import static com.dmdirc.util.YamlReaderUtils.requiredString;
+import static com.dmdirc.util.io.yaml.YamlReaderUtils.asMap;
+import static com.dmdirc.util.io.yaml.YamlReaderUtils.requiredString;
 
 /**
  * Store that reads and writes aliases from a YAML file on disk.

src/main/java/com/dmdirc/commandparser/auto/YamlAutoCommandStore.java

@@ -17,7 +17,7 @@
 
 package com.dmdirc.commandparser.auto;
 
-import com.dmdirc.util.BaseYamlStore;
+import com.dmdirc.util.io.yaml.BaseYamlStore;
 
 import java.nio.file.Path;
 import java.util.HashMap;
@@ -29,9 +29,9 @@ import java.util.Set;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import static com.dmdirc.util.YamlReaderUtils.asMap;
-import static com.dmdirc.util.YamlReaderUtils.optionalString;
-import static com.dmdirc.util.YamlReaderUtils.requiredString;
+import static com.dmdirc.util.io.yaml.YamlReaderUtils.asMap;
+import static com.dmdirc.util.io.yaml.YamlReaderUtils.optionalString;
+import static com.dmdirc.util.io.yaml.YamlReaderUtils.requiredString;
 
 /**
  * Store that reads and writes auto-commands from a YAML file on disk.

src/main/java/com/dmdirc/config/prefs/reader/CategoryReader.java

@@ -24,8 +24,8 @@ import java.util.LinkedList;
 import java.util.List;
 import java.util.Map;
 
-import static com.dmdirc.util.YamlReaderUtils.optionalString;
-import static com.dmdirc.util.YamlReaderUtils.requiredString;
+import static com.dmdirc.util.io.yaml.YamlReaderUtils.optionalString;
+import static com.dmdirc.util.io.yaml.YamlReaderUtils.requiredString;
 import static com.google.common.base.Preconditions.checkNotNull;
 
 /**

src/main/java/com/dmdirc/config/prefs/reader/PreferencesReader.java

@@ -34,8 +34,8 @@ import org.slf4j.LoggerFactory;
 
 import com.esotericsoftware.yamlbeans.YamlReader;
 
-import static com.dmdirc.util.YamlReaderUtils.asList;
-import static com.dmdirc.util.YamlReaderUtils.asMap;
+import static com.dmdirc.util.io.yaml.YamlReaderUtils.asList;
+import static com.dmdirc.util.io.yaml.YamlReaderUtils.asMap;
 import static com.google.common.base.Preconditions.checkNotNull;
 
 /**

src/main/java/com/dmdirc/config/profiles/YamlProfileStore.java

@@ -17,7 +17,7 @@
 
 package com.dmdirc.config.profiles;
 
-import com.dmdirc.util.BaseYamlStore;
+import com.dmdirc.util.io.yaml.BaseYamlStore;
 
 import java.nio.file.Path;
 import java.util.Collection;
@@ -30,10 +30,10 @@ import java.util.Optional;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import static com.dmdirc.util.YamlReaderUtils.asList;
-import static com.dmdirc.util.YamlReaderUtils.asMap;
-import static com.dmdirc.util.YamlReaderUtils.optionalString;
-import static com.dmdirc.util.YamlReaderUtils.requiredString;
+import static com.dmdirc.util.io.yaml.YamlReaderUtils.asList;
+import static com.dmdirc.util.io.yaml.YamlReaderUtils.asMap;
+import static com.dmdirc.util.io.yaml.YamlReaderUtils.optionalString;
+import static com.dmdirc.util.io.yaml.YamlReaderUtils.requiredString;
 
 /**
  * Store that reads and writes profiles from a YAML file on disk.

src/main/java/com/dmdirc/ui/messages/YamlEventFormatProvider.java

@@ -38,7 +38,7 @@ import com.esotericsoftware.yamlbeans.YamlReader;
 
 import static com.dmdirc.util.LogUtils.FATAL_APP_ERROR;
 import static com.dmdirc.util.LogUtils.USER_ERROR;
-import static com.dmdirc.util.YamlReaderUtils.asMap;
+import static com.dmdirc.util.io.yaml.YamlReaderUtils.asMap;
 
 /**
  * YAML-backed supplier of event formats.