hocon 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f53bd3b94192eb5515fdd8dee18a31f1b7ec3301
-  data.tar.gz: 9528170c7011011e68058de66b134240b6aaba5b
+  metadata.gz: f5f840792a5f3186c9fa371d26249c29160d789f
+  data.tar.gz: b0ef532026b4e0884ba1d17bfe44206835ed3053
 SHA512:
-  metadata.gz: 692390bfc06e62f8674b9a45ac76777df321738ccb647180cff3378e69ff489a182f1a91573243da0703586709fcb4d02ae874ce2f7f2674770485b0b14afa18
-  data.tar.gz: e4f43e24a79072d8964fd3ee89dab2e9daa2e96dd1a9afd1b2db0ae97b5249f16d49a67617fa20272ef023b9c1836e502c9d9f0885c49d463ff45c01a0606f2f
+  metadata.gz: d705bb5985d3a0c1792726de5526272bb46ea28502e25da8b98d171aae1b3c598aa57908ecb56ba76d0c6ae1ca5cc8e941cd4ecf55a69fd2a65e5b0bd6617075
+  data.tar.gz: adcea68d2278b03b1e4ff067a8f615e8c9796574c61dabaad49397cdd8ef81dfb4d60d3aa298a4d6a8ec2c2cd5398195886dd3f69d1d53f1cee4b5bb6539ce47

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 1.1.0
+This is a bugfix/feature release
+
+* Fixed a bug where unrecognized config file extensions caused `Hocon.load` to return an empty
+  hash instead of an error.
+* Added an optional `:syntax` key to the `Hocon.load` method to explicitly specify the file format
+* Renamed internal usage of `name` methods to avoid overriding built in `Object#name` method
+
 ## 1.0.1
 
 This is a bugfix release.

data/README.md

@@ -8,7 +8,7 @@ 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`
+At present, it 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`.
@@ -35,6 +35,22 @@ conf = Hocon.load("myapp.conf")
 puts "Here's a setting: #{conf["foo"]["bar"]["baz"]}"
 ```
 
+By default, the simple API will determine the configuration file syntax/format
+based on the filename extension of the file; `.conf` will be interpreted as HOCON,
+`.json` will be interpreted as strict JSON, and any other extension will cause an
+error to be raised since the syntax is unknown.  If you'd like to use a different
+file extension, you manually specify the syntax, like this:
+
+```rb
+require 'hocon'
+require 'hocon/config_syntax'
+
+conf = Hocon.load("myapp.blah", {:syntax => Hocon::ConfigSyntax::HOCON})
+```
+
+Supported values for `:syntax` are: JSON, CONF, and HOCON.  (CONF and HOCON are
+aliases, and both map to the underlying HOCON syntax.)
+
 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:
@@ -61,7 +77,7 @@ Testing
 =======
 
 ```sh
-bundle install
+bundle install --path .bundle
 bundle exec rspec spec
 ```
 
@@ -77,3 +93,9 @@ Unsupported features include:
 * Parsing anything other than files and strings
 * Duration and size settings
 * Java system properties
+
+## Maintainence
+
+Maintainers: Joe Pinsonault <joe.pinsonault@puppet.com>, Chris Price <chris@puppet.com>, Kevin Corcoran <kevin.corcoran@puppet.com>
+
+Tickets: https://tickets.puppetlabs.com/browse/HC

data/lib/hocon.rb

@@ -1,13 +1,39 @@
 # encoding: utf-8
 
 module Hocon
-  def self.load(file)
-    # doing this require lazily, because otherwise, classes that need to
+  # NOTE: the behavior of this load method differs a bit from the upstream public
+  # API, where a file extension may be the preferred method of determining
+  # the config syntax, even if you specify a Syntax value on ConfigParseOptions.
+  # Here we prefer the syntax (optionally) specified by the user no matter what
+  # the file extension is, and if they don't specify one and the file extension
+  # is unrecognized, we raise an error.
+  def self.load(file, opts = nil)
+    # doing these requires 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
+    require 'hocon/impl/parseable'
+    require 'hocon/config_parse_options'
+    require 'hocon/config_resolve_options'
+    require 'hocon/config_error'
+    syntax = opts ? opts[:syntax] : nil
+
+    if syntax.nil?
+      unless Hocon::Impl::Parseable.syntax_from_extension(file)
+        raise Hocon::ConfigError::ConfigParseError.new(
+            nil, "Unrecognized file extension '#{File.extname(file)}' and no value provided for :syntax option", nil)
+      end
+      config = Hocon::ConfigFactory.parse_file_any_syntax(
+          file, Hocon::ConfigParseOptions.defaults)
+    else
+      config = Hocon::ConfigFactory.parse_file(
+          file, Hocon::ConfigParseOptions.defaults.set_syntax(syntax))
+    end
+
+    resolved_config = Hocon::ConfigFactory.load_from_config(
+        config, Hocon::ConfigResolveOptions.defaults)
+
+    return resolved_config.root.unwrapped
   end
 
   def self.parse(string)

data/lib/hocon/config_syntax.rb

@@ -5,6 +5,8 @@ require 'hocon'
 module Hocon::ConfigSyntax
   JSON = 0
   CONF = 1
+  # alias 'HOCON' to 'CONF' since some users may be more familiar with that
+  HOCON = 1
   # we're not going to try to support .properties files any time soon :)
   #PROPERTIES = 2
 end

data/lib/hocon/config_value_type.rb

@@ -15,7 +15,7 @@ module Hocon::ConfigValueType
   NULL = 4
   STRING = 5
 
-  def self.name(config_value_type)
+  def self.value_type_name(config_value_type)
     case config_value_type
       when OBJECT then "OBJECT"
       when LIST then "LIST"

data/lib/hocon/impl/from_map_mode.rb

@@ -8,7 +8,7 @@ module Hocon::Impl::FromMapMode
   KEYS_ARE_KEYS = 1
   ConfigBugOrBrokenError = Hocon::ConfigError::ConfigBugOrBrokenError
 
-  def self.name(from_map_mode)
+  def self.map_mode_name(from_map_mode)
     case from_map_mode
       when KEYS_ARE_PATHS then "KEYS_ARE_PATHS"
       when KEYS_ARE_KEYS then "KEYS_ARE_KEYS"

data/lib/hocon/impl/parseable.rb

@@ -125,7 +125,7 @@ class Hocon::Impl::Parseable
       raise Hocon::ConfigError::ConfigWrongTypeError.with_expected_actual(value.origin,
                                                          "",
                                                          "object at file root",
-                                                         value.value_type.name)
+                                                         value.value_type.value_type_name)
     end
   end
 

data/lib/hocon/impl/simple_config.rb

@@ -61,12 +61,12 @@ class Hocon::Impl::SimpleConfig
     if v.value_type == ConfigValueType::NULL
       raise ConfigNullError.new(v.origin,
                                 (ConfigNullError.make_message(original_path.render,
-                                                              (not expected.nil?) ? ConfigValueType.name(expected) : nil)),
+                                                              (not expected.nil?) ? ConfigValueType.value_type_name(expected) : nil)),
                                 nil)
     elsif (not expected.nil?) && v.value_type != expected
       raise ConfigWrongTypeError.new(v.origin,
-                                     "#{original_path.render} has type #{ConfigValueType.name(v.value_type)} " +
-                                         "rather than #{ConfigValueType.name(expected)}",
+                                     "#{original_path.render} has type #{ConfigValueType.value_type_name(v.value_type)} " +
+                                         "rather than #{ConfigValueType.value_type_name(expected)}",
                                      nil)
     else
       return v
@@ -121,8 +121,8 @@ class Hocon::Impl::SimpleConfig
     if (not expected.nil?) && (v.value_type != expected && v.value_type != Hocon::ConfigValueType::NULL)
       raise Hocon::ConfigError::ConfigWrongTypeError.with_expected_actual(v.origin,
                                                                           original_path.render,
-                                                                          expected.name,
-                                                                          Hocon::ConfigValueType.name(v.value_type))
+                                                                          expected.value_type_name,
+                                                                          Hocon::ConfigValueType.value_type_name(v.value_type))
     else
       return v
     end
@@ -220,8 +220,8 @@ class Hocon::Impl::SimpleConfig
       end
       if v.value_type != expected
         raise ConfigWrongTypeError.with_expected_actual(origin, path,
-              "list of #{expected.name}",
-              "list of #{v.value_type.name}")
+              "list of #{expected.value_type_name}",
+              "list of #{v.value_type.value_type_name}")
       end
       l << v.unwrapped
     end
@@ -271,8 +271,8 @@ class Hocon::Impl::SimpleConfig
       end
       if v.value_type != expected
         raise ConfigWrongTypeError.with_expected_actual(origin, path,
-                                                        "list of #{expected.name}",
-                                                        "list of #{v.value_type.name}")
+                                                        "list of #{expected.value_type_name}",
+                                                        "list of #{v.value_type.value_type_name}")
       end
       l << v
     end

data/lib/hocon/impl/token.rb

@@ -30,7 +30,7 @@ class Hocon::Impl::Token
     if !@debug_string.nil?
       @debug_string
     else
-      Hocon::Impl::TokenType.name(@token_type)
+      Hocon::Impl::TokenType.token_type_name(@token_type)
     end
   end
 

data/lib/hocon/impl/token_type.rb

@@ -21,7 +21,7 @@ class Hocon::Impl::TokenType
   PLUS_EQUALS = 15
   IGNORED_WHITESPACE = 16
 
-  def self.name(token_type)
+  def self.token_type_name(token_type)
     case token_type
       when START then "START"
       when EOF then "EOF"

data/lib/hocon/impl/tokens.rb

@@ -35,9 +35,9 @@ class Hocon::Impl::Tokens
 
     def to_s
       if value.resolve_status == ResolveStatus::RESOLVED
-        "'#{value.unwrapped}' (#{Hocon::ConfigValueType.name(value.value_type)})"
+        "'#{value.unwrapped}' (#{Hocon::ConfigValueType.value_type_name(value.value_type)})"
       else
-        "'<unresolved value>' (#{@value.value_type.name})"
+        "'<unresolved value>' (#{@value.value_type.value_type_name})"
       end
 
     end

data/spec/fixtures/hocon/by_extension/cat.conf

@@ -0,0 +1,4 @@
+# Comment
+{
+  "meow": "cats"
+}

data/spec/fixtures/hocon/by_extension/cat.test

@@ -0,0 +1,4 @@
+# Comment
+{
+  "meow": "cats"
+}

data/spec/fixtures/hocon/by_extension/cat.test-json

@@ -0,0 +1,3 @@
+{
+  "meow": "cats"
+}

data/spec/unit/hocon/README.md

@@ -0,0 +1,7 @@
+## RUBY-SPECIFIC TESTS
+
+This directory should only contain tests that are specific to the Ruby library/API.
+Tests ported from the upstream Java library should live in spec/typesafe/config.
+
+Where possible it would be good to avoid sharing fixtures between the two types
+of tests as well.

data/spec/unit/{typesafe/config → hocon}/hocon_spec.rb

@@ -3,6 +3,10 @@
 require 'spec_helper'
 require 'hocon'
 require 'hocon/config_render_options'
+require 'hocon/config_error'
+require 'hocon/config_syntax'
+
+ConfigParseError = Hocon::ConfigError::ConfigParseError
 
 describe Hocon do
   let(:render_options) { Hocon::ConfigRenderOptions.defaults }
@@ -50,5 +54,39 @@ describe Hocon do
       expect(conf).to eq(expected)
     end
   end
+
+  context "loading a file with an unknown extension" do
+    context "without specifying the config format" do
+      it "should raise an error" do
+        expect {
+          Hocon.load("#{FIXTURE_DIR}/hocon/by_extension/cat.test")
+        }.to raise_error(ConfigParseError, /Unrecognized file extension '.test'/)
+      end
+    end
+
+    context "while specifying the config format" do
+      it "should parse properly if the config format is correct" do
+        expect(Hocon.load("#{FIXTURE_DIR}/hocon/by_extension/cat.test",
+                          {:syntax => Hocon::ConfigSyntax::HOCON})).
+            to eq({"meow" => "cats"})
+        expect(Hocon.load("#{FIXTURE_DIR}/hocon/by_extension/cat.test-json",
+                          {:syntax => Hocon::ConfigSyntax::HOCON})).
+            to eq({"meow" => "cats"})
+      end
+      it "should parse properly if the config format is compatible" do
+        expect(Hocon.load("#{FIXTURE_DIR}/hocon/by_extension/cat.test-json",
+                          {:syntax => Hocon::ConfigSyntax::JSON})).
+            to eq({"meow" => "cats"})
+      end
+      it "should raise an error if the config format is incompatible" do
+        expect {
+          Hocon.load("#{FIXTURE_DIR}/hocon/by_extension/cat.test",
+                     {:syntax => Hocon::ConfigSyntax::JSON})
+        }.to raise_error(ConfigParseError, /Document must have an object or array at root/)
+      end
+    end
+  end
+
+
 end
 

data/spec/unit/typesafe/config/README.md

@@ -0,0 +1,4 @@
+## TESTS PORTED FROM UPSTREAM
+
+This directory should only contain tests that are ported from the upstream
+Java library.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hocon
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Chris Price
@@ -138,6 +138,9 @@ files:
 - lib/hocon/parser/config_document.rb
 - lib/hocon/parser/config_document_factory.rb
 - lib/hocon/parser/config_node.rb
+- spec/fixtures/hocon/by_extension/cat.conf
+- spec/fixtures/hocon/by_extension/cat.test
+- spec/fixtures/hocon/by_extension/cat.test-json
 - spec/fixtures/parse_render/example1/input.conf
 - spec/fixtures/parse_render/example1/output.conf
 - spec/fixtures/parse_render/example1/output_nocomments.conf
@@ -160,6 +163,9 @@ files:
 - spec/fixtures/test_utils/resources/test03.conf
 - spec/spec_helper.rb
 - spec/test_utils.rb
+- spec/unit/hocon/README.md
+- spec/unit/hocon/hocon_spec.rb
+- spec/unit/typesafe/config/README.md
 - spec/unit/typesafe/config/concatenation_spec.rb
 - spec/unit/typesafe/config/conf_parser_spec.rb
 - spec/unit/typesafe/config/config_document_parser_spec.rb
@@ -168,7 +174,6 @@ files:
 - spec/unit/typesafe/config/config_node_spec.rb
 - spec/unit/typesafe/config/config_value_factory_spec.rb
 - spec/unit/typesafe/config/config_value_spec.rb
-- spec/unit/typesafe/config/hocon_spec.rb
 - spec/unit/typesafe/config/path_spec.rb
 - spec/unit/typesafe/config/public_api_spec.rb
 - spec/unit/typesafe/config/simple_config_spec.rb
@@ -194,7 +199,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: HOCON Config Library