collapsium-config 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7226c990a104075ae8b906ac940c962db5bc24a4
-  data.tar.gz: 5f0e566d08dc54452653f9155455b41bc350a838
+  metadata.gz: 31e518d37d4cdaa12f8a8718c3ca5816939b6ab2
+  data.tar.gz: 3d466b1b37734a90beafa962991fd9735734ea39
 SHA512:
-  metadata.gz: 94ce0f061cfe720f4d02b37eb28d39c2cff34da9711c934792096f53997114139d651cb34a98035f8c0978874a12c62282104986c8d3e53366d746608e58f414
-  data.tar.gz: 8a47d3515b417eee8497f2924417dd034d92ad5c0b30574270ddc23f6b1c7263f732d5ebc6794b09061b98de3cb51b0acab46ff9584d8c430a5bf02f6a4d104d
+  metadata.gz: 7052b7b696d6b7cb5422fa2e6236656de330ffc28ecf08fdb0db52593b36a5fab2d219333ef8ea0c55b3ae83c7a18704d0c7fb998c77caece40e8ebac69fd94a
+  data.tar.gz: 85bddfd097bce75d0285c01e1f1da0dfc612f127be4bfc769481669e75df7425a6e67ecd9b11f551378da7edef29cd944a8ca38928a49cfd2da4305023145fc1

data/.travis.yml

@@ -5,7 +5,7 @@ rvm:
   - 2.2
 script:
   - bundle exec rake
-  - bundle exec codeclimate-test-reporter
+  - bundle exec codeclimate-test-reporter || true
 addons:
   code_climate:
     repo_token: 3cca4d10a51839bc5d115d41a0c12b98cbdb27a21e9c86544324fa028b799b84

data/Gemfile.lock

@@ -1,23 +1,23 @@
 PATH
   remote: .
   specs:
-    collapsium-config (0.4.3)
-      collapsium (~> 0.7)
+    collapsium-config (0.5.0)
+      collapsium (~> 0.8)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.3.0)
-    codeclimate-test-reporter (1.0.3)
+    codeclimate-test-reporter (1.0.4)
       simplecov
-    collapsium (0.7.0)
+    collapsium (0.8.2)
     diff-lcs (1.2.5)
     docile (1.1.5)
     json (2.0.2)
-    parser (2.3.2.0)
+    parser (2.3.3.1)
       ast (~> 2.2)
     powerpack (0.1.1)
-    rainbow (2.1.0)
+    rainbow (2.2.1)
     rake (11.3.0)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
@@ -32,7 +32,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.5.0)
     rspec-support (3.5.0)
-    rubocop (0.45.0)
+    rubocop (0.46.0)
       parser (>= 2.3.1.1, < 3.0)
       powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)
@@ -44,8 +44,8 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
-    unicode-display_width (1.1.1)
-    yard (0.9.5)
+    unicode-display_width (1.1.2)
+    yard (0.9.6)
 
 PLATFORMS
   ruby
@@ -56,7 +56,7 @@ DEPENDENCIES
   collapsium-config!
   rake (~> 11.3)
   rspec (~> 3.5)
-  rubocop (~> 0.45)
+  rubocop (~> 0.46)
   simplecov (~> 0.12)
   yard (~> 0.9)
 

data/collapsium-config.gemspec

@@ -38,13 +38,13 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.0'
 
   spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rubocop", "~> 0.45"
+  spec.add_development_dependency "rubocop", "~> 0.46"
   spec.add_development_dependency "rake", "~> 11.3"
   spec.add_development_dependency "rspec", "~> 3.5"
   spec.add_development_dependency "simplecov", "~> 0.12"
   spec.add_development_dependency "yard", "~> 0.9"
 
-  spec.add_dependency 'collapsium', '~> 0.7'
+  spec.add_dependency 'collapsium', '~> 0.8'
 end
 # rubocop:enable Metrics/BlockLength
 # rubocop:enable Style/SpaceAroundOperators

data/lib/collapsium-config.rb

@@ -18,6 +18,13 @@ module Collapsium
     # The default configuration file path
     DEFAULT_CONFIG_PATH = 'config.yml'.freeze
 
+    # Default options for configuration loading
+    DEFAULT_CONFIG_OPTIONS = {
+      resolve_extensions: true,
+      nonexistent_base: :ignore,
+      data: nil,
+    }.freeze
+
     ##
     # Modules can have class methods, too, but it's a little more verbose to
     # provide them.
@@ -32,6 +39,16 @@ module Collapsium
         return @config_file || DEFAULT_CONFIG_PATH
       end
 
+      # Set configuration loading options
+      def config_options=(opts)
+        @config_options = opts
+      end
+
+      # @return [Hash] configuration loading options
+      def config_options
+        return @config_options || DEFAULT_CONFIG_OPTIONS
+      end
+
       # @api private
       attr_accessor :config
     end # module ClassMethods
@@ -42,7 +59,8 @@ module Collapsium
     def config
       if Config.config.nil? or Config.config.empty?
         begin
-          Config.config = Configuration.load_config(Config.config_file)
+          Config.config = Configuration.load_config(Config.config_file,
+                                                    Config.config_options)
         rescue Errno::ENOENT
           Config.config = {}
         end

data/lib/collapsium-config/configuration.rb

@@ -98,13 +98,31 @@ module Collapsium
         # @param options [Hash] options hash with the following keys:
         #   - resolve_extensions [Boolean] flag whether to resolve configuration
         #       hash extensions. (see `#resolve_extensions`)
+        #   - nonexistent_base [Symbol] either of :extend or :ignore; flag that
+        #     determines how a nonexistent base should be treated:
+        #     - :extend behaves as if it does exist, but refers to an empty Hash
+        #     - :ignore does not modify the `.base` or `.extends` properties,
+        #       and simply ignores the reference.
         #   - data [Hash] data Hash to pass on to the templating mechanism.
         def load_config(path, options = {})
           # Option defaults
+          options = options.dup
           if options[:resolve_extensions].nil?
             options[:resolve_extensions] = true
           end
+          if not [true, false].include?(options[:resolve_extensions])
+            raise "The :resolve_extensions option must be a boolean value!"
+          end
+          if options[:nonexistent_base].nil?
+            options[:nonexistent_base] = :ignore
+          end
+          if not [:extend, :ignore].include?(options[:nonexistent_base])
+            raise "The :nonexistent_base option must be one of :ignore or :extend!"
+          end
           options[:data] ||= {}
+          if not options[:data].is_a? Hash
+            raise "The :data option must be a Hash!"
+          end
 
           # Load base and local configuration files
           base, config = load_base_config(path, options[:data])
@@ -121,7 +139,7 @@ module Collapsium
 
           # Now resolve config hashes that extend other hashes.
           if options[:resolve_extensions]
-            cfg.resolve_extensions!
+            cfg.resolve_extensions!(options)
           end
 
           return cfg
@@ -251,35 +269,35 @@ module Collapsium
       # Also note that all of this means that :extends and :base are reserved
       # keywords that cannot be used in configuration files other than for this
       # purpose!
-      def resolve_extensions!
+      def resolve_extensions!(options)
         # The root object is always a Hash, so has keys, which can be processed
         # recursively.
-        recursive_resolve(self)
+        recursive_resolve(self, "", options)
       end
 
-      def recursive_resolve(root, prefix = "")
+      def recursive_resolve(root, prefix = "", options = {})
         # The self object is a Hash or an Array. Let's iterate over its children
         # one by one. Defaulting to a Hash here is just convenience, it could
         # equally be an Array.
         children = root.fetch(prefix, {})
 
-        merge_base(root, prefix, children)
+        merge_base(root, prefix, children, options)
 
         if children.is_a? Hash
           children.each do |key, _|
             full_key = normalize_path("#{prefix}#{separator}#{key}")
-            recursive_resolve(root, full_key)
+            recursive_resolve(root, full_key, options)
           end
         elsif children.is_a? Array
           children.each_with_index do |_, idx|
             key = idx.to_s
             full_key = normalize_path("#{prefix}#{separator}#{key}")
-            recursive_resolve(root, full_key)
+            recursive_resolve(root, full_key, options)
           end
         end
       end
 
-      def merge_base(root, path, value)
+      def merge_base(root, path, value, options)
         # If the value is not a Hash, we can't do anything here.
         if not value.is_a? Hash
           return
@@ -292,18 +310,19 @@ module Collapsium
         end
 
         # Now to resolve the path to the base and remove the "extends" keyword.
-        bases = fetch_base_values(root, parent_path(path), value)
+        bases = fetch_base_values(root, parent_path(path), value, options)
 
         # Merge the bases
-        merge_base_values(root, value, bases)
+        merge_base_values(root, value, bases, options)
 
         # And we're done, set the value to what was being merged.
         root[path] = value
       end
 
-      def fetch_base_values(root, parent, value)
+      def fetch_base_values(root, parent, value, options)
         base_paths = array_value(value["extends"])
         bases = []
+        base_count = 0
         base_paths.each do |base_path|
           if not base_path.start_with?(separator)
             base_path = "#{parent}#{separator}#{base_path}"
@@ -315,30 +334,38 @@ module Collapsium
           # We default to nil. Only Hash base values can be processed.
           base_value = root.fetch(base_path, nil)
           if not base_value.is_a? Hash
+            bases << [base_path, nil]
             next
           end
 
           bases << [base_path, base_value]
+          base_count += 1
         end
 
         # Only delete the "extends" keyword if we found all base.
-        if bases.length == base_paths.length
+        if options[:nonexistent_base] == :extend or \
+           base_count == base_paths.length
           value.delete("extends")
         end
 
         return bases
       end
 
-      def merge_base_values(root, value, bases)
+      def merge_base_values(root, value, bases, options)
         # We need to recursively resolve the base values before merging them into
         # value. To preserve the override order, we need to overwrite values when
         # merging bases...
         merged_base = Configuration.new
         bases.each do |base_path, base_value|
-          base_value.recursive_resolve(root, base_path)
-          merged_base.recursive_merge!(base_value, true)
+          if not base_value.nil?
+            base_value.recursive_resolve(root, base_path)
+            merged_base.recursive_merge!(base_value, true)
+          end
 
           # Modify bases for this path: we go depth first into the hierarchy
+          if options[:nonexistent_base] == :ignore and base_value.nil?
+            next
+          end
           base_val = merged_base.fetch("base", []).dup
           base_val << base_path
           base_val.uniq!

data/lib/collapsium-config/version.rb

@@ -9,6 +9,6 @@
 module Collapsium
   module Config
     # The current release version
-    VERSION = "0.4.3".freeze
+    VERSION = "0.5.0".freeze
   end # module Config
 end # module Collapsium

data/spec/configuration_spec.rb

@@ -49,6 +49,25 @@ describe Collapsium::Config::Configuration do
       cfg = Collapsium::Config::Configuration.load_config(config)
       expect(cfg).to be_empty
     end
+
+    it "validates options" do
+      config = File.join(@data_path, 'hash.yml')
+
+      # :resolve_extensions must be a boolean
+      opts = { resolve_extensions: 42 }
+      expect { Collapsium::Config::Configuration.load_config(config, opts) }.to \
+        raise_error RuntimeError
+
+      # :data must be a Hash
+      opts = { data: 42 }
+      expect { Collapsium::Config::Configuration.load_config(config, opts) }.to \
+        raise_error RuntimeError
+
+      # :nonexistent_base must be one of :ignore, :extend
+      opts = { nonexistent_base: :foo }
+      expect { Collapsium::Config::Configuration.load_config(config, opts) }.to \
+        raise_error RuntimeError
+    end
   end
 
   describe "merge behaviour" do
@@ -175,16 +194,34 @@ describe Collapsium::Config::Configuration do
                                                           .drivers.branch2)
         end
 
-        it "works when a base does not exist" do
-          # Ensure the hash contains its own value
-          expect(@config["drivers.base_does_not_exist.some"]).to eql "value"
+        context "Extension" do
+          it "ignores nonexistent bases by default" do
+            # Ensure the hash contains its own value
+            expect(@config["drivers.base_does_not_exist.some"]).to eql "value"
+
+            # Also ensure the "base" is _not_ set properly
+            expect(@config["drivers.base_does_not_exist.base"]).to be_nil
+
+            # On the other hand, "extends" should stay.
+            expect(@config["drivers.base_does_not_exist.extends"]).to eql \
+              "nonexistent_base"
+          end
+
+          it "can pretend nonexistent bases are empty" do
+            opts = { nonexistent_base: :extend }
+            config = Collapsium::Config::Configuration.load_config(@config_path,
+                                                                   opts)
+
+            # Ensure the hash contains its own value
+            expect(config["drivers.base_does_not_exist.some"]).to eql "value"
 
-          # Also ensure the "base" is _not_ set properly
-          expect(@config["drivers.base_does_not_exist.base"]).to be_nil
+            # Here, the base must be set!
+            expect(config["drivers.base_does_not_exist.base"]).to eql \
+              %w(.drivers.nonexistent_base)
 
-          # On the other hand, "extends" should stay.
-          expect(@config["drivers.base_does_not_exist.extends"]).to eql \
-            "nonexistent_base"
+            # Then "extends" needs to vanish.
+            expect(config["drivers.base_does_not_exist.extends"]).to be_nil
+          end
         end
       end
 

data/spec/data/global.yml

@@ -2,3 +2,5 @@
 test: 42
 some:
   path: 123
+foo:
+  extends: some

data/spec/module_spec.rb

@@ -4,11 +4,12 @@ require_relative '../lib/collapsium-config'
 include Collapsium::Config
 
 describe Collapsium::Config do
-  before do
+  before :each do
     @data_path = File.join(File.dirname(__FILE__), 'data')
     ENV.delete("SOME_PATH")
     ENV.delete("SOME")
     ENV.delete("PATH")
+    Collapsium::Config.config = nil
   end
 
   it "fails to load configuration from the default path (it does not exist)" do
@@ -55,5 +56,12 @@ describe Collapsium::Config do
       expect(config["some.path"]).to eql "override"
       expect(config["some"]["path"]).to eql "override"
     end
+
+    it "accepts non-default options" do
+      Collapsium::Config.config_file = File.join(@data_path, 'global.yml')
+      Collapsium::Config.config_options = { resolve_extensions: false }
+
+      expect(config["foo.base"]).to be_nil
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: collapsium-config
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Jens Finkhaeuser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-22 00:00:00.000000000 Z
+date: 2017-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.45'
+        version: '0.46'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.45'
+        version: '0.46'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
 description: "\n    Using collapsium's UberHash class for easy access to configuration
   values,\n    this gem reads and merges various configuration sources into one\n
   \   configuration object.\n  "