Merge branch 'master' of https://github.com/Johnlon/config

Author: Johnlon

README.md

@@ -76,14 +76,17 @@ to merge it in.
   - [Debugging Your Configuration](#debugging-your-configuration)
   - [Supports Java 8 and Later](#supports-java-8-and-later)
   - [Rationale for Supported File Formats](#rationale-for-supported-file-formats)
-  - [Other APIs (Wrappers and Ports)](#other-apis-wrappers-and-ports)
+  - [Other APIs (Wrappers, Ports and Utilities)](#other-apis-wrappers-ports-and-utilities)
+    - [Guice integration](#guice-integration)
+    - [Java (yep!) wrappers for the Java library](#java-yep-wrappers-for-the-java-library)
     - [Scala wrappers for the Java library](#scala-wrappers-for-the-java-library)
     - [Clojure wrappers for the Java library](#clojure-wrappers-for-the-java-library)
+    - [Scala port](#scala-port)
     - [Ruby port](#ruby-port)
     - [Puppet module](#puppet-module)
     - [Python port](#python-port)
-    - [C++ port](#c++-port)
-
+    - [C++ port](#c-port)
+    - [Linting tool](#linting-tool)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
@@ -837,11 +840,16 @@ format.
   * config-annotation https://github.com/wacai/config-annotation
   * PureConfig https://github.com/melrief/pureconfig
   * Simple Scala Config https://github.com/ElderResearch/ssc
+  * konfig https://github.com/vpon/konfig
 
 #### Clojure wrappers for the Java library
 
   * beamly-core.config https://github.com/beamly/beamly-core.config
 
+#### Scala port
+
+  * SHocon https://github.com/unicredit/shocon (work with both Scala and Scala.Js)
+
 #### Ruby port
 
    * https://github.com/puppetlabs/ruby-hocon
@@ -859,5 +867,6 @@ format.
    * https://github.com/puppetlabs/cpp-hocon
 
 #### Linting tool
-   
-   * A web based linting tool http://www.hoconlint.com/
+
+   * A web based linting tool http://www.hoconlint.com/
+

appveyor.yml

@@ -0,0 +1,14 @@
+version: '{build}'
+os: Windows Server 2012
+install:
+  - cmd: choco install sbt -ia "INSTALLDIR=""C:\sbt"""
+  - cmd: SET PATH=C:\sbt\bin;%JAVA_HOME%\bin;%PATH%
+  - cmd: SET SBT_OPTS=-XX:MaxPermSize=2g -Xmx4g
+build_script:
+  - sbt clean compile
+test_script:
+  - sbt test
+  - sbt doc
+cache:
+  - C:\sbt\
+  - C:\Users\appveyor\.ivy2

config/src/main/java/com/typesafe/config/Config.java

@@ -597,6 +597,22 @@ public interface Config extends ConfigMergeable {
      */
     String getString(String path);
 
+    /**
+     * @param enumClass
+     *            an enum class
+     * @param <T>
+     *            a generic denoting a specific type of enum
+     * @param path
+     *            path expression
+     * @return the {@code Enum} value at the requested path
+     *              of the requested enum class
+     * @throws ConfigException.Missing
+     *             if value is absent or null
+     * @throws ConfigException.WrongType
+     *             if value is not convertible to an Enum
+     */
+    public <T extends Enum<T>> T getEnum(Class<T> enumClass, String path);
+
     /**
      * @param path
      *            path expression
@@ -882,6 +898,25 @@ public interface Config extends ConfigMergeable {
      */
     List<String> getStringList(String path);
 
+    /**
+     * Gets a list value with {@code Enum} elements.  Throws if the
+     * path is unset or null or not a list or contains values not
+     * convertible to {@code Enum}.
+     *
+     * @param enumClass
+     *            the enum class
+     * @param <T>
+     *            a generic denoting a specific type of enum
+     * @param path
+     *            the path to the list value.
+     * @return the list at the path
+     * @throws ConfigException.Missing
+     *             if value is absent or null
+     * @throws ConfigException.WrongType
+     *             if value is not convertible to a list of {@code Enum}
+     */
+    <T extends Enum<T>> List<T> getEnumList(Class<T> enumClass, String path);
+
     /**
      * Gets a list value with object elements.  Throws if the
      * path is unset or null or not a list or contains values not

config/src/main/java/com/typesafe/config/ConfigFactory.java

@@ -3,17 +3,16 @@
  */
 package com.typesafe.config;
 
+import com.typesafe.config.impl.ConfigImpl;
+import com.typesafe.config.impl.Parseable;
+
 import java.io.File;
 import java.io.Reader;
-import java.net.MalformedURLException;
 import java.net.URL;
 import java.util.Map;
 import java.util.Properties;
 import java.util.concurrent.Callable;
 
-import com.typesafe.config.impl.ConfigImpl;
-import com.typesafe.config.impl.Parseable;
-
 /**
  * Contains static methods for creating {@link Config} instances.
  *
@@ -36,6 +35,8 @@
  * examples.
  */
 public final class ConfigFactory {
+    private static final String STRATEGY_PROPERTY_NAME = "config.strategy";
+
     private ConfigFactory() {
     }
 
@@ -213,54 +214,7 @@ public static Config load(ClassLoader loader, Config config, ConfigResolveOption
                 .resolve(resolveOptions);
     }
 
-    private static Config parseApplicationConfig(ConfigParseOptions parseOptions) {
-        ClassLoader loader = parseOptions.getClassLoader();
-        if (loader == null)
-            throw new ConfigException.BugOrBroken(
-                    "ClassLoader should have been set here; bug in ConfigFactory. "
-                            + "(You can probably work around this bug by passing in a class loader or calling currentThread().setContextClassLoader() though.)");
-
-        int specified = 0;
-
-        // override application.conf with config.file, config.resource,
-        // config.url if requested.
-        String resource = System.getProperty("config.resource");
-        if (resource != null)
-            specified += 1;
-        String file = System.getProperty("config.file");
-        if (file != null)
-            specified += 1;
-        String url = System.getProperty("config.url");
-        if (url != null)
-            specified += 1;
-
-        if (specified == 0) {
-            return ConfigFactory.parseResourcesAnySyntax("application", parseOptions);
-        } else if (specified > 1) {
-            throw new ConfigException.Generic("You set more than one of config.file='" + file
-                    + "', config.url='" + url + "', config.resource='" + resource
-                    + "'; don't know which one to use!");
-        } else {
-            // the override file/url/resource MUST be present or it's an error
-            ConfigParseOptions overrideOptions = parseOptions.setAllowMissing(false);
-            if (resource != null) {
-                if (resource.startsWith("/"))
-                    resource = resource.substring(1);
-                // this deliberately does not parseResourcesAnySyntax; if
-                // people want that they can use an include statement.
-                return parseResources(loader, resource, overrideOptions);
-            } else if (file != null) {
-                return parseFile(new File(file), overrideOptions);
-            } else {
-                try {
-                    return parseURL(new URL(url), overrideOptions);
-                } catch (MalformedURLException e) {
-                    throw new ConfigException.Generic("Bad URL in config.url system property: '"
-                            + url + "': " + e.getMessage(), e);
-                }
-            }
-        }
-    }
+
 
     /**
      * Loads a default configuration, equivalent to {@link #load(Config)
@@ -516,7 +470,7 @@ public static Config defaultApplication(ClassLoader loader) {
      * @return the default application configuration
      */
     public static Config defaultApplication(ConfigParseOptions options) {
-        return parseApplicationConfig(ensureClassLoader(options, "defaultApplication"));
+        return getConfigLoadingStrategy().parseApplicationConfig(ensureClassLoader(options, "defaultApplication"));
     }
 
     /**
@@ -1094,4 +1048,18 @@ public static Config parseMap(Map<String, ? extends Object> values,
     public static Config parseMap(Map<String, ? extends Object> values) {
         return parseMap(values, null);
     }
+
+    private static ConfigLoadingStrategy getConfigLoadingStrategy() {
+        String className = System.getProperties().getProperty(STRATEGY_PROPERTY_NAME);
+
+        if (className != null) {
+            try {
+                return ConfigLoadingStrategy.class.cast(Class.forName(className).newInstance());
+            } catch (Throwable e) {
+                throw new ConfigException.BugOrBroken("Failed to load strategy: " + className, e);
+            }
+        } else {
+            return new DefaultConfigLoadingStrategy();
+        }
+    }
 }

config/src/main/java/com/typesafe/config/ConfigLoadingStrategy.java

@@ -0,0 +1,20 @@
+package com.typesafe.config;
+
+/**
+ * This method allows you to alter default config loading strategy for all the code which
+ * calls {@link ConfigFactory#load}.
+ *
+ * Usually you don't have to implement this interface but it may be required
+ * when you fixing a improperly implemented library with unavailable source code.
+ *
+ * You have to define VM property {@code config.strategy} to replace default strategy with your own.
+ */
+public interface ConfigLoadingStrategy {
+    /**
+     * This method must load and parse application config.
+     *
+     * @param parseOptions {@link ConfigParseOptions} to use
+     * @return loaded config
+     */
+    Config parseApplicationConfig(ConfigParseOptions parseOptions);
+}

config/src/main/java/com/typesafe/config/DefaultConfigLoadingStrategy.java

@@ -0,0 +1,62 @@
+package com.typesafe.config;
+
+import java.io.File;
+import java.net.MalformedURLException;
+import java.net.URL;
+
+/**
+ * Default config loading strategy. Able to load resource, file or URL.
+ * Behavior may be altered by defining one of VM properties
+ * {@code config.resource}, {@code config.file} or {@code config.url}
+ */
+public class DefaultConfigLoadingStrategy implements ConfigLoadingStrategy {
+    @Override
+    public Config parseApplicationConfig(ConfigParseOptions parseOptions) {
+        ClassLoader loader = parseOptions.getClassLoader();
+        if (loader == null)
+            throw new ConfigException.BugOrBroken(
+                    "ClassLoader should have been set here; bug in ConfigFactory. "
+                            + "(You can probably work around this bug by passing in a class loader or calling currentThread().setContextClassLoader() though.)");
+
+        int specified = 0;
+
+        // override application.conf with config.file, config.resource,
+        // config.url if requested.
+        String resource = System.getProperty("config.resource");
+        if (resource != null)
+            specified += 1;
+        String file = System.getProperty("config.file");
+        if (file != null)
+            specified += 1;
+        String url = System.getProperty("config.url");
+        if (url != null)
+            specified += 1;
+
+        if (specified == 0) {
+            return ConfigFactory.parseResourcesAnySyntax("application", parseOptions);
+        } else if (specified > 1) {
+            throw new ConfigException.Generic("You set more than one of config.file='" + file
+                                                      + "', config.url='" + url + "', config.resource='" + resource
+                                                      + "'; don't know which one to use!");
+        } else {
+            // the override file/url/resource MUST be present or it's an error
+            ConfigParseOptions overrideOptions = parseOptions.setAllowMissing(false);
+            if (resource != null) {
+                if (resource.startsWith("/"))
+                    resource = resource.substring(1);
+                // this deliberately does not parseResourcesAnySyntax; if
+                // people want that they can use an include statement.
+                return ConfigFactory.parseResources(loader, resource, overrideOptions);
+            } else if (file != null) {
+                return ConfigFactory.parseFile(new File(file), overrideOptions);
+            } else {
+                try {
+                    return ConfigFactory.parseURL(new URL(url), overrideOptions);
+                } catch (MalformedURLException e) {
+                    throw new ConfigException.Generic("Bad URL in config.url system property: '"
+                                                              + url + "': " + e.getMessage(), e);
+                }
+            }
+        }
+    }
+}

config/src/main/java/com/typesafe/config/Optional.java

@@ -0,0 +1,14 @@
+package com.typesafe.config;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+
+/**
+ * Allows an config property to be {@code null}.
+ */
+@Documented
+@Retention(RetentionPolicy.RUNTIME)
+public @interface Optional {
+
+}