Merge pull request #604 from csmith/config-value-retriever

Extract config value retrieving from binder.

src/com/dmdirc/config/ConfigBinder.java

@@ -24,7 +24,6 @@ package com.dmdirc.config;
 
 import com.dmdirc.interfaces.config.AggregateConfigProvider;
 import com.dmdirc.interfaces.config.ConfigChangeListener;
-import com.dmdirc.interfaces.config.ReadOnlyConfigProvider;
 
 import com.google.common.collect.ArrayListMultimap;
 import com.google.common.collect.Multimap;
@@ -35,7 +34,6 @@ import java.lang.reflect.Field;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
-import java.util.List;
 import java.util.Optional;
 
 import javax.annotation.Nonnull;
@@ -59,14 +57,18 @@ public class ConfigBinder {
     private final Optional<String> defaultDomain;
     /** The configuration manager to use to retrieve settings. */
     private final AggregateConfigProvider manager;
+    /** Retriever to use to get typed config values. */
+    private final ConfigValueRetriever valueRetriever;
 
     ConfigBinder(final AggregateConfigProvider manager) {
         this.manager = manager;
+        this.valueRetriever = new ConfigValueRetriever(manager);
         this.defaultDomain = Optional.empty();
     }
 
     ConfigBinder(final AggregateConfigProvider manager, @Nonnull final String domain) {
         this.manager = manager;
+        this.valueRetriever = new ConfigValueRetriever(manager);
         this.defaultDomain = Optional.of(domain);
     }
 
@@ -142,7 +144,12 @@ public class ConfigBinder {
             element.setAccessible(true);
         }
 
-        final Object value = getValue(binding, getTargetClass(element));
+        final Object value = valueRetriever.getValue(
+                getTargetClass(element),
+                getDomain(binding.domain()),
+                binding.key(),
+                binding.required(),
+                binding.fallbacks());
 
         try {
             binding.invocation().newInstance().invoke(element, instance, value);
@@ -151,45 +158,6 @@ public class ConfigBinder {
         }
     }
 
-    /**
-     * Gets a value from the configuration manager for use with the given binding, and attempts to
-     * coerce it into the given class.
-     *
-     * @param binding     The binding defining configuration parameters
-     * @param targetClass The desired class
-     *
-     * @return An object representing the current value of the configuration key(s) associated with
-     *         the binding, of the desired target class, or null if the type conversion couldn't be
-     *         performed.
-     */
-    private Object getValue(final ConfigBinding binding,
-            final Class<?> targetClass) {
-        if (targetClass.equals(String.class)) {
-            return manager.getOptionString(getDomain(binding.domain()), binding.key(),
-                    binding.required(), ReadOnlyConfigProvider.PERMISSIVE_VALIDATOR,
-                    binding.fallbacks());
-        }
-
-        if (targetClass.equals(Boolean.class) || targetClass.equals(Boolean.TYPE)) {
-            return manager.getOptionBool(getDomain(binding.domain()), binding.key());
-        }
-
-        if (targetClass.equals(Character.class) || targetClass.equals(Character.TYPE)) {
-            return manager.getOptionChar(getDomain(binding.domain()), binding.key());
-        }
-
-        if (targetClass.equals(Integer.class) || targetClass.equals(Integer.TYPE)) {
-            return manager.getOptionInt(getDomain(binding.domain()), binding.key(),
-                    binding.fallbacks());
-        }
-
-        if (targetClass.equals(List.class)) {
-            return manager.getOptionList(getDomain(binding.domain()), binding.key());
-        }
-
-        return null;
-    }
-
     /**
      * Gets the type required for setting the given element.
      *

src/com/dmdirc/config/ConfigValueRetriever.java

@@ -0,0 +1,92 @@
+/*
+ * Copyright (c) 2006-2015 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.config;
+
+import com.dmdirc.interfaces.config.ReadOnlyConfigProvider;
+
+import java.util.List;
+
+/**
+ * Provides methods to retrieve a value of a certain type from a config provider.
+ */
+public class ConfigValueRetriever {
+
+    private final ReadOnlyConfigProvider configProvider;
+
+    public ConfigValueRetriever(final ReadOnlyConfigProvider configProvider) {
+        this.configProvider = configProvider;
+    }
+
+    /**
+     * Gets a value from the configuration manager, and attempts to coerce it into the given class.
+     *
+     * @param targetClass The desired class.
+     * @param domain The domain of the option to retrieve.
+     * @param key The key of the option to retrieve.
+     * @param required Whether the option is required or not (only used for strings).
+     * @param fallbacks Ordered collection of domain/key pairs to try if the value is not set.
+     *
+     * @return An object representing the current value of the configuration key(s) given, of the
+     *         desired target class, or null if the type conversion couldn't be performed.
+     */
+    public Object getValue(final Class<?> targetClass, final String domain, final String key,
+            final boolean required, final String ... fallbacks) {
+        if (targetClass.equals(String.class)) {
+            return configProvider.getOptionString(
+                    domain, key, required, ReadOnlyConfigProvider.PERMISSIVE_VALIDATOR, fallbacks);
+        }
+
+        if (targetClass.equals(Boolean.class) || targetClass.equals(Boolean.TYPE)) {
+            return configProvider.getOptionBool(domain, key);
+        }
+
+        if (targetClass.equals(Character.class) || targetClass.equals(Character.TYPE)) {
+            return configProvider.getOptionChar(domain, key);
+        }
+
+        if (targetClass.equals(Integer.class) || targetClass.equals(Integer.TYPE)) {
+            return configProvider.getOptionInt(domain, key, fallbacks);
+        }
+
+        if (targetClass.equals(List.class)) {
+            return configProvider.getOptionList(domain, key);
+        }
+
+        return null;
+    }
+
+    /**
+     * Gets a value from the configuration manager, and attempts to coerce it into the given class.
+     *
+     * @param targetClass The desired class.
+     * @param domain The domain of the option to retrieve.
+     * @param key The key of the option to retrieve.
+     *
+     * @return An object representing the current value of the configuration key(s) given, of the
+     *         desired target class, or null if the type conversion couldn't be performed.
+     */
+    public Object getValue(final Class<?> targetClass, final String domain, final String key) {
+        return getValue(targetClass, domain, key, true);
+    }
+
+}

test/com/dmdirc/config/ConfigValueRetrieverTest.java

@@ -0,0 +1,151 @@
+/*
+ * Copyright (c) 2006-2015 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.config;
+
+import com.dmdirc.interfaces.config.ReadOnlyConfigProvider;
+
+import com.google.common.collect.Lists;
+
+import java.util.List;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import org.mockito.runners.MockitoJUnitRunner;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNull;
+import static org.mockito.Mockito.when;
+
+@RunWith(MockitoJUnitRunner.class)
+public class ConfigValueRetrieverTest {
+
+    private static final String DOMAIN = "mydomain";
+    private static final String KEY = "mykey";
+
+    private static final String FALLBACK_DOMAIN = "otherdomain";
+    private static final String FALLBACK_KEY = "otherkey";
+
+    @Mock private ReadOnlyConfigProvider configProvider;
+    private ConfigValueRetriever retriever;
+
+    @Before
+    public void setUpRetriever() {
+        retriever = new ConfigValueRetriever(configProvider);
+    }
+
+    @Test
+    public void testRetrievesBasicString() {
+        when(configProvider.getOptionString(DOMAIN, KEY, true,
+                ReadOnlyConfigProvider.PERMISSIVE_VALIDATOR)).thenReturn("value!");
+
+        assertEquals("value!", retriever.getValue(String.class, DOMAIN, KEY));
+    }
+
+    @Test
+    public void testRetrievesStringWithFallback() {
+        when(configProvider.getOptionString(DOMAIN, KEY, true,
+                ReadOnlyConfigProvider.PERMISSIVE_VALIDATOR)).thenReturn(null);
+        when(configProvider.getOptionString(
+                DOMAIN, KEY, true, ReadOnlyConfigProvider.PERMISSIVE_VALIDATOR,
+                FALLBACK_DOMAIN, FALLBACK_KEY))
+                .thenReturn("value!");
+
+        assertEquals("value!", retriever.getValue(String.class, DOMAIN, KEY, true,
+                FALLBACK_DOMAIN, FALLBACK_KEY));
+    }
+
+    @Test
+    public void testRetrievesStringWithRequiresFalse() {
+        when(configProvider.getOptionString(DOMAIN, KEY, false,
+                ReadOnlyConfigProvider.PERMISSIVE_VALIDATOR)).thenReturn(null);
+        when(configProvider.getOptionString(DOMAIN, KEY, true,
+                ReadOnlyConfigProvider.PERMISSIVE_VALIDATOR)).thenReturn("value!");
+
+        assertNull(retriever.getValue(String.class, DOMAIN, KEY, false));
+    }
+
+    @Test
+    public void testRetrievesStringWithRequiresTrue() {
+        when(configProvider.getOptionString(DOMAIN, KEY, false,
+                ReadOnlyConfigProvider.PERMISSIVE_VALIDATOR)).thenReturn(null);
+        when(configProvider.getOptionString(DOMAIN, KEY, true,
+                ReadOnlyConfigProvider.PERMISSIVE_VALIDATOR)).thenReturn("value!");
+
+        assertEquals("value!", retriever.getValue(String.class, DOMAIN, KEY, true));
+    }
+
+    @Test
+    public void testRetrievesBoolean() {
+        when(configProvider.getOptionBool(DOMAIN, KEY)).thenReturn(true);
+
+        assertEquals(true, retriever.getValue(Boolean.class, DOMAIN, KEY));
+    }
+
+    @Test
+    public void testRetrievesBooleanByPrimitiveType() {
+        when(configProvider.getOptionBool(DOMAIN, KEY)).thenReturn(true);
+
+        assertEquals(true, retriever.getValue(Boolean.TYPE, DOMAIN, KEY));
+    }
+
+    @Test
+    public void testRetrievesChar() {
+        when(configProvider.getOptionChar(DOMAIN, KEY)).thenReturn('s');
+
+        assertEquals('s', retriever.getValue(Character.class, DOMAIN, KEY));
+    }
+
+    @Test
+    public void testRetrievesCharByPrimitiveType() {
+        when(configProvider.getOptionChar(DOMAIN, KEY)).thenReturn('s');
+
+        assertEquals('s', retriever.getValue(Character.TYPE, DOMAIN, KEY));
+    }
+
+    @Test
+    public void testRetrievesInt() {
+        when(configProvider.getOptionInt(DOMAIN, KEY)).thenReturn(1337);
+
+        assertEquals(1337, retriever.getValue(Integer.class, DOMAIN, KEY));
+    }
+
+    @Test
+    public void testRetrievesIntByPrimitiveType() {
+        when(configProvider.getOptionInt(DOMAIN, KEY)).thenReturn(1337);
+
+        assertEquals(1337, retriever.getValue(Integer.TYPE, DOMAIN, KEY));
+    }
+
+    @Test
+    @SuppressWarnings("AssertEqualsBetweenInconvertibleTypes")
+    public void testRetrievesList() {
+        when(configProvider.getOptionList(DOMAIN, KEY)).thenReturn(
+                Lists.newArrayList("test1", "test2"));
+
+        assertEquals(Lists.newArrayList("test1", "test2"),
+                retriever.getValue(List.class, DOMAIN, KEY));
+    }
+
+}