hocon 0.9.5 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d586be6e36bce66c74d12ea9406b9b6d844394ae
-  data.tar.gz: dafe13b0402fc522a2eb8b1048c9c9adcedc4aaf
+  metadata.gz: f53bd3b94192eb5515fdd8dee18a31f1b7ec3301
+  data.tar.gz: 9528170c7011011e68058de66b134240b6aaba5b
 SHA512:
-  metadata.gz: 07793700cdc1f874d77686530ec13610197e91f9d2cd8b39cede3a8d01f36002ff1faa7e3a7c7c12b3109f96a80f71291248ff7bb3e7f91cca86111692d52b00
-  data.tar.gz: 268a221b935ee64a080d0f4466914ca0652e02ce1405aec1d957d42d4169a0f391e25570564ab26070416cd712fa5ab5bb3164c9c4d43f18ba925c3afb6e77b2
+  metadata.gz: 692390bfc06e62f8674b9a45ac76777df321738ccb647180cff3378e69ff489a182f1a91573243da0703586709fcb4d02ae874ce2f7f2674770485b0b14afa18
+  data.tar.gz: e4f43e24a79072d8964fd3ee89dab2e9daa2e96dd1a9afd1b2db0ae97b5249f16d49a67617fa20272ef023b9c1836e502c9d9f0885c49d463ff45c01a0606f2f

data/CHANGELOG.md

@@ -1,6 +1,18 @@
-## 0.9.5
+## 1.0.1
 
-This is a re-release of 0.9.3 to revert changes made in 0.9.4
+This is a bugfix release.
+The API is stable enough and the code is being used in production, so the version is also being bumped to 1.0.0
+
+* Fixed a bug wherein calling "Hocon.load" would not
+  resolve substitutions.
+* Fixed a circular dependency between the Hocon and Hocon::ConfigFactory
+  namespaces. Using the Hocon::ConfigFactory class now requires you to
+  use a `require 'hocon/config_factory'` instead of `require hocon`
+* Add support for hashes with keyword keys
+
+## 1.0.0
+
+This version number was burned.
 
 ## 0.9.3
 

data/README.md

@@ -8,12 +8,16 @@ This is a port of the [Typesafe Config](https://github.com/typesafehub/config) l
 The library provides Ruby support for the [HOCON](https://github.com/typesafehub/config/blob/master/HOCON.md) configuration file format.
 
 
-At present, it supports supports parsing and modification of existing HOCON/JSON files via the `ConfigFactory` class and the `ConfigValueFactory` class, and rendering parsed config objects back to a String.
-It also supports the parsing and modification of HOCON/JSON files via `ConfigDocumentFactory`.
-PLEASE NOTE this project is in an experimental state, and in some cases may not work properly, so
-please be wary when using it. If you find a problem, feel free to open a github issue.
+At present, it supports supports parsing and modification of existing HOCON/JSON files via the `ConfigFactory`
+class and the `ConfigValueFactory` class, and rendering parsed config objects back to a String
+([see examples below](#basic-usage)). It also supports the parsing and modification of HOCON/JSON files via
+`ConfigDocumentFactory`.
 
-The implementation is intended to be as close to a line-for-line port as the two languages allow, in hopes of making it fairly easy to port over new changesets from the Java code base over time.
+**Note:** While the project is production ready, since not all features in the Typesafe library are supported,
+you may still run into some issues. If you find a problem, feel free to open a github issue.
+
+The implementation is intended to be as close to a line-for-line port as the two languages allow,
+in hopes of making it fairly easy to port over new changesets from the Java code base over time.
 
 Basic Usage
 ===========
@@ -22,15 +26,18 @@ Basic Usage
 gem install hocon
 ```
 
+To use the simple API, for reading config values:
 
 ```rb
-require 'hocon/config_factory'
+require 'hocon'
 
-conf = Hocon::ConfigFactory.parse_file("myapp.conf")
-conf_map = conf.root.unwrapped
+conf = Hocon.load("myapp.conf")
+puts "Here's a setting: #{conf["foo"]["bar"]["baz"]}"
 ```
 
-To use the ConfigDocument API
+To use the ConfigDocument API, if you need both read/write capability for
+modifying settings in a config file, or if you want to retain access to
+things like comments and line numbers:
 
 ```rb
 require 'hocon/parser/config_document_factory'
@@ -46,6 +53,10 @@ doc_has_value = doc.has_value?("a") # returns boolean
 orig_doc_text = doc.render # returns string
 ```
 
+Note that a `ConfigDocument` is used primarily for simple configuration manipulation while preserving
+whitespace and comments. As such, it is not powerful as the regular `Config` API, and will not resolve
+substitutions.
+
 Testing
 =======
 
@@ -57,7 +68,8 @@ bundle exec rspec spec
 Unsupported Features
 ====================
 
-This supports many of the same things as the Java library, but there are some notable exceptions. Unsupported features include:
+This supports many of the same things as the Java library, but there are some notable exceptions.
+Unsupported features include:
 
 * Non file includes
 * Loading resources from the class path or URLs

data/lib/hocon.rb

@@ -1,14 +1,20 @@
 # encoding: utf-8
 
 module Hocon
-  require 'hocon/config_factory'
-
   def self.load(file)
-    config = Hocon::ConfigFactory.parse_file(file)
+    # doing this require lazily, because otherwise, classes that need to
+    # `require 'hocon'` to get the module into scope will end up recursing
+    # through this require and probably ending up with circular dependencies.
+    require 'hocon/config_factory'
+    config = Hocon::ConfigFactory.load_file(file)
     return config.root.unwrapped
   end
 
   def self.parse(string)
+    # doing this require lazily, because otherwise, classes that need to
+    # `require 'hocon'` to get the module into scope will end up recursing
+    # through this require and probably ending up with circular dependencies.
+    require 'hocon/config_factory'
     config = Hocon::ConfigFactory.parse_string(string)
     return config.root.unwrapped
   end

data/lib/hocon/config_factory.rb

@@ -6,6 +6,10 @@ require 'hocon/config_parse_options'
 require 'hocon/impl/config_impl'
 require 'hocon/config_factory'
 
+## Please note that the `parse` operations will simply create a ConfigValue
+## and do nothing else, whereas the `load` operations will perform a higher-level
+## operation and will resolve substitutions. If you have substitutions in your
+## configuration, use a `load` function
 class Hocon::ConfigFactory
   def self.parse_file(file_path, options = Hocon::ConfigParseOptions.defaults)
     Hocon::Impl::Parseable.new_file(file_path, options).parse.to_config

data/lib/hocon/config_value_factory.rb

@@ -55,7 +55,11 @@ class Hocon::ConfigValueFactory
   # @return a new value
   #
   def self.from_any_ref(object, origin_description = nil)
-    ConfigImpl.from_any_ref(object, origin_description)
+    if object.is_a?(Hash)
+      from_map(object, origin_description)
+    else
+      ConfigImpl.from_any_ref(object, origin_description)
+    end
   end
 
   #
@@ -69,6 +73,13 @@ class Hocon::ConfigValueFactory
   # @return a new {@link ConfigObject}
   #
   def self.from_map(values, origin_description = nil)
-    ConfigImpl.from_any_ref(values, origin_description)
+    ConfigImpl.from_any_ref(process_hash(values), origin_description)
   end
+
+  private
+
+  def self.process_hash(hash)
+    Hash[hash.map {|k, v| [k.is_a?(Symbol) ? k.to_s : k, v.is_a?(Hash) ? process_hash(v) : v]}]
+  end
+
 end

data/lib/hocon/impl/config_reference.rb

@@ -3,13 +3,16 @@
 require 'hocon'
 require 'hocon/impl'
 require 'hocon/impl/abstract_config_value'
-require 'hocon/impl/resolve_source'
-require 'hocon/impl/resolve_result'
 
 class Hocon::Impl::ConfigReference
   include Hocon::Impl::Unmergeable
   include Hocon::Impl::AbstractConfigValue
 
+  # Require these lazily, to avoid circular dependencies
+  require 'hocon/impl/resolve_source'
+  require 'hocon/impl/resolve_result'
+
+
   NotPossibleToResolve = Hocon::Impl::AbstractConfigValue::NotPossibleToResolve
   UnresolvedSubstitutionError = Hocon::ConfigError::UnresolvedSubstitutionError
 

data/lib/hocon/impl/simple_config_origin.rb

@@ -212,7 +212,7 @@ class Hocon::Impl::SimpleConfigOrigin
         if a.origin_type == b.origin_type
           a.origin_type
         else
-          Hocon::Impl::OriginType.GENERIC
+          Hocon::Impl::OriginType::GENERIC
         end
 
     # first use the "description" field which has no line numbers

data/spec/fixtures/parse_render/example1/input.conf

@@ -0,0 +1,21 @@
+# These are some opening comments
+# These are some additional opening comments
+foo.bar {
+  // the baz is is blah blah
+  baz = 42
+  boom = [1, 2, {derp : duh }, 4]
+  empty = []
+
+  # abracadabra setting
+  abracadabra = "hi"
+}
+
+// as for the yippee
+# it entails some things
+foo.bar.yahoo = "yippee"
+
+# truthy
+foo.bar.truthy = true
+
+# falsy
+foo.bar.falsy  = false

data/spec/fixtures/parse_render/example1/output.conf

@@ -0,0 +1,26 @@
+foo {
+    # These are some opening comments
+    # These are some additional opening comments
+    bar {
+        # falsy
+        falsy=false
+        # truthy
+        truthy=true
+        # as for the yippee
+        # it entails some things
+        yahoo=yippee
+        # the baz is is blah blah
+        baz=42
+        boom=[
+            1,
+            2,
+            {
+                derp=duh
+            },
+            4
+        ]
+        empty=[]
+        # abracadabra setting
+        abracadabra=hi
+    }
+}

data/spec/fixtures/parse_render/example1/output_nocomments.conf

@@ -0,0 +1,17 @@
+foo {
+    bar {
+        falsy=false
+        truthy=true
+        yahoo=yippee
+        baz=42
+        boom=[
+            1,
+            2,
+            {
+                derp=duh
+            },
+            4
+        ]
+        abracadabra=hi
+    }
+}

data/spec/fixtures/parse_render/example2/input.conf

@@ -0,0 +1,10 @@
+jruby-puppet: {
+    jruby-pools: [{environment: production}]
+    load-path: [/usr/lib/ruby/site_ruby/1.8, /usr/lib/ruby/site_ruby/1.8]
+    master-conf-dir: /etc/puppet
+    master-var-dir: /var/lib/puppet
+}
+
+webserver: {
+  host: 1.2.3.4
+}

data/spec/fixtures/parse_render/example2/output.conf

@@ -0,0 +1,17 @@
+jruby-puppet {
+    jruby-pools=[
+        {
+            environment=production
+        }
+    ]
+    load-path=[
+        "/usr/lib/ruby/site_ruby/1.8",
+        "/usr/lib/ruby/site_ruby/1.8"
+    ]
+    master-conf-dir="/etc/puppet"
+    master-var-dir="/var/lib/puppet"
+}
+
+webserver {
+  host="1.2.3.4"
+}

data/spec/fixtures/parse_render/example2/output_nocomments.conf

@@ -0,0 +1,17 @@
+jruby-puppet {
+    jruby-pools=[
+        {
+            environment=production
+        }
+    ]
+    load-path=[
+        "/usr/lib/ruby/site_ruby/1.8",
+        "/usr/lib/ruby/site_ruby/1.8"
+    ]
+    master-conf-dir="/etc/puppet"
+    master-var-dir="/var/lib/puppet"
+}
+
+webserver {
+  host="1.2.3.4"
+}

data/spec/fixtures/parse_render/example3/input.conf

@@ -0,0 +1,2 @@
+a: true
+b: ${a}

data/spec/fixtures/parse_render/example3/output.conf

@@ -0,0 +1,2 @@
+a=true
+b=true

data/spec/fixtures/parse_render/example4/input.json

@@ -0,0 +1,6 @@
+{
+    "kermit": "frog",
+    "miss": "piggy",
+    "bert": "ernie",
+    "janice": "guitar"
+}

data/spec/fixtures/parse_render/example4/output.conf

@@ -0,0 +1,6 @@
+{
+    "kermit"="frog",
+    "miss"="piggy",
+    "bert"="ernie",
+    "janice"="guitar"
+}

data/spec/fixtures/test_utils/resources/bom.conf

@@ -0,0 +1,2 @@
+#
+foo = bar

data/spec/fixtures/test_utils/resources/cycle.conf

@@ -0,0 +1 @@
+include "cycle.conf"

data/spec/fixtures/test_utils/resources/file-include.conf

@@ -0,0 +1,5 @@
+base=41
+# included without file() in a subdir
+include "subdir/foo.conf"
+# included using file() in a subdir
+include file("subdir/baz.conf")

data/spec/fixtures/test_utils/resources/include-from-list.conf

@@ -0,0 +1,4 @@
+// The {} inside the [] is needed because
+// just [ include ] means an array with the
+// string "include" in it.
+a = [ { include "test01.conf" } ]

data/spec/fixtures/test_utils/resources/subdir/bar.conf

@@ -0,0 +1 @@
+bar=43

data/spec/fixtures/test_utils/resources/subdir/baz.conf

@@ -0,0 +1 @@
+baz=45

data/spec/fixtures/test_utils/resources/subdir/foo.conf

@@ -0,0 +1,5 @@
+foo=42
+# included without file()
+include "bar.conf"
+# included using file()
+include file("bar-file.conf")

data/spec/fixtures/test_utils/resources/test01.conf

@@ -0,0 +1,80 @@
+{
+    "ints" : {
+        "fortyTwo" : 42,
+        "fortyTwoAgain" : ${ints.fortyTwo}
+    },
+
+    "floats" : {
+        "fortyTwoPointOne" : 42.1,
+        "fortyTwoPointOneAgain" : ${floats.fortyTwoPointOne}
+    },
+
+    "strings" : {
+        "abcd" : "abcd",
+        "abcdAgain" : ${strings.a}${strings.b}${strings.c}${strings.d},
+        "a" : "a",
+        "b" : "b",
+        "c" : "c",
+        "d" : "d",
+        "concatenated" : null bar 42 baz true 3.14 hi,
+        "double" : "3.14",
+        "number" : "57",
+        "null" : "null",
+        "true" : "true",
+        "yes" : "yes",
+        "false" : "false",
+        "no" : "no"
+    },
+
+    "arrays" : {
+        "empty" : [],
+        "ofInt" : [1, 2, 3],
+        "ofString" : [ ${strings.a}, ${strings.b}, ${strings.c} ],
+        "ofDouble" : [3.14, 4.14, 5.14],
+        "ofNull" : [null, null, null],
+        "ofBoolean" : [true, false],
+        "ofArray" : [${arrays.ofString}, ${arrays.ofString}, ${arrays.ofString}],
+        "ofObject" : [${ints}, ${booleans}, ${strings}],
+        "firstElementNotASubst" : [ "a", ${strings.b} ]
+    },
+
+    "booleans" : {
+        "true" : true,
+        "trueAgain" : ${booleans.true},
+        "false" : false,
+        "falseAgain" : ${booleans.false}
+    },
+
+    "nulls" : {
+        "null" : null,
+        "nullAgain" : ${nulls.null}
+    },
+
+    "durations" : {
+        "second" : 1s,
+        "secondsList" : [1s,2seconds,3 s, 4000],
+        "secondAsNumber" : 1000,
+        "halfSecond" : 0.5s,
+        "millis" : 1 milli,
+        "micros" : 2000 micros
+    },
+
+    "memsizes" : {
+        "meg" : 1M,
+        "megsList" : [1M, 1024K, 1048576],
+        "megAsNumber" : 1048576,
+        "halfMeg" : 0.5M
+    },
+
+    "system" : {
+        "javaversion" : ${?java.version},
+        "userhome" : ${?user.home},
+        "home" : ${?HOME},
+        "pwd" : ${?PWD},
+        "shell" : ${?SHELL},
+        "lang" : ${?LANG},
+        "path" : ${?PATH},
+        "not_here" : ${?NOT_HERE},
+        "concatenated" : Your Java version is ${?system.javaversion} and your user.home is ${?system.userhome}
+    }
+}