collapsium-config 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b003113648d35417f65b7f142c1e1957df44390e
-  data.tar.gz: 4c6ddaf1aafe5804b918877b5663169a85206afe
+  metadata.gz: a5580fb8452b9b3d0c23ee9a987638fc870317e4
+  data.tar.gz: c3f68cac77df64fc6bc9175ebbcfde04d845d9d3
 SHA512:
-  metadata.gz: 07fd37c0e483fb12ecbd24924a27af10a49f4c07a8ffaff28bf9555b983b26377fdd5ab7b3a29b19ff0687d95a64c746db21df980838b9e87aed4be2a551dfa9
-  data.tar.gz: a0df3d326c1a71bd9001517b5f801fd9d7aab93054dd105d42a4604382881eb8b790c452b7ab2d7245534bb93ce19dc78460c74695eb665fd41cd787cfd3dfed
+  metadata.gz: 8e0fdc2746cb84e896168f26ade95ce81374848bbb536d18352b3f761648808c6f2c8a7696385c3fee1a4d052261c150d509c9cb1a77162d22470f4ce3c09f42
+  data.tar.gz: 4b7fdb6738ec3dc159a4e30bc8ecbecfa33690f2f09220f7db3c353fe81d95e9dcbc6b4fc11417b5dbf7002087122ad368b81085155ceabb7ca4f165868a26c0

data/Gemfile.lock

@@ -1,51 +1,51 @@
 PATH
   remote: .
   specs:
-    collapsium-config (0.1.1)
-      collapsium (~> 0.1)
+    collapsium-config (0.2.0)
+      collapsium (~> 0.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.2.0)
-    codeclimate-test-reporter (0.5.0)
+    ast (2.3.0)
+    codeclimate-test-reporter (0.6.0)
       simplecov (>= 0.7.1, < 1.0.0)
-    collapsium (0.1.0)
+    collapsium (0.4.0)
     diff-lcs (1.2.5)
     docile (1.1.5)
-    json (1.8.3)
-    parser (2.3.1.0)
+    json (2.0.2)
+    parser (2.3.1.2)
       ast (~> 2.2)
     powerpack (0.1.1)
     rainbow (2.1.0)
-    rake (11.1.2)
-    rspec (3.4.0)
-      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.4)
-      rspec-support (~> 3.4.0)
-    rspec-expectations (3.4.0)
+    rake (11.2.2)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.2)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.1)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-support (3.4.1)
-    rubocop (0.40.0)
-      parser (>= 2.3.1.0, < 3.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rubocop (0.42.0)
+      parser (>= 2.3.1.1, < 3.0)
       powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.8.0)
-    simplecov (0.11.2)
+    ruby-progressbar (1.8.1)
+    simplecov (0.12.0)
       docile (~> 1.1.0)
-      json (~> 1.8)
+      json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
-    unicode-display_width (1.0.5)
-    yard (0.8.7.6)
+    unicode-display_width (1.1.0)
+    yard (0.9.5)
 
 PLATFORMS
   ruby
@@ -54,11 +54,11 @@ DEPENDENCIES
   bundler (~> 1.12)
   codeclimate-test-reporter
   collapsium-config!
-  rake (~> 11.1)
-  rspec (~> 3.4)
-  rubocop (~> 0.40)
-  simplecov (~> 0.11)
-  yard (~> 0.8)
+  rake (~> 11.2)
+  rspec (~> 3.5)
+  rubocop (~> 0.42)
+  simplecov (~> 0.12)
+  yard (~> 0.9)
 
 BUNDLED WITH
-   1.12.3
+   1.12.5

data/collapsium-config.gemspec

@@ -37,13 +37,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.40"
-  spec.add_development_dependency "rake", "~> 11.1"
-  spec.add_development_dependency "rspec", "~> 3.4"
-  spec.add_development_dependency "simplecov", "~> 0.11"
-  spec.add_development_dependency "yard", "~> 0.8"
+  spec.add_development_dependency "rubocop", "~> 0.42"
+  spec.add_development_dependency "rake", "~> 11.2"
+  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.1'
+  spec.add_dependency 'collapsium', '~> 0.4'
 end
 # rubocop:enable Style/SpaceAroundOperators
 # rubocop:enable Style/UnneededPercentQ, Style/ExtraSpacing

data/lib/collapsium-config/configuration.rb

@@ -39,6 +39,8 @@ module Collapsium
     # That means that if you are trying to merge a hash with an array config, the
     # result may be unexpected.
     class Configuration < ::Collapsium::UberHash
+      include ::Collapsium::EnvironmentOverride
+
       # @api private
       # Very simple YAML parser
       class YAMLParser
@@ -46,7 +48,7 @@ module Collapsium
 
         # @return parsed string
         def self.parse(string)
-          YAML.load(string)
+          return YAML.load(string)
         end
       end
       private_constant :YAMLParser
@@ -58,44 +60,11 @@ module Collapsium
 
         # @return parsed string
         def self.parse(string)
-          JSON.parse(string)
+          return JSON.parse(string)
         end
       end
       private_constant :JSONParser
 
-      UberHash::READ_METHODS.each do |method|
-        # Wrap all read functions into something that checks for environment
-        # variables first.
-        define_method(method) do |*args, &block|
-          # If there are no arguments, there's nothing to do with paths. Just
-          # delegate to the hash.
-          if args.empty?
-            return super(*args, &block)
-          end
-
-          # We'll make it rather simple: since the first argument is a key, we
-          # will just transform it to the matching environment variable name,
-          # and see if that environment variable is set.
-          env_name = args[0].to_s.upcase.gsub(split_pattern, '_')
-          contents = nil
-          if env_name != '_'
-            contents = ENV[env_name]
-          end
-
-          # No environment variable set? Fine, just do the usual thing.
-          if contents.nil? or contents.empty?
-            return super(*args, &block)
-          end
-
-          # With an environment variable, we will try to parse it as JSON first.
-          begin
-            return JSONParser.parse(contents)
-          rescue JSON::ParserError
-            return contents
-          end
-        end
-      end
-
       class << self
         # @api private
         # Mapping of file name extensions to parser types.
@@ -117,24 +86,32 @@ module Collapsium
         # detected based on one of the extensions in FILE_TO_PARSER.
         #
         # @param path [String] the path of the configuration file to load.
-        # @param resolve_extensions [Boolean] flag whether to resolve configuration
-        #   hash extensions. (see `#resolve_extensions`)
-        def load_config(path, resolve_extensions = true)
+        # @param options [Hash] options hash with the following keys:
+        #   - resolve_extensions [Boolean] flag whether to resolve configuration
+        #       hash extensions. (see `#resolve_extensions`)
+        #   - data [Hash] data Hash to pass on to the templating mechanism.
+        def load_config(path, options = {})
+          # Option defaults
+          if options[:resolve_extensions].nil?
+            options[:resolve_extensions] = true
+          end
+          options[:data] ||= {}
+
           # Load base and local configuration files
-          base, config = load_base_config(path)
-          _, local_config = load_local_config(base)
+          base, config = load_base_config(path, options[:data])
+          _, local_config = load_local_config(base, options[:data])
 
           # Merge local configuration
           config.recursive_merge!(local_config)
 
           # Resolve includes
-          config = resolve_includes(base, config)
+          config = resolve_includes(base, config, options[:data])
 
           # Create config from the result
           cfg = Configuration.new(config)
 
           # Now resolve config hashes that extend other hashes.
-          if resolve_extensions
+          if options[:resolve_extensions]
             cfg.resolve_extensions!
           end
 
@@ -143,7 +120,17 @@ module Collapsium
 
         private
 
-        def load_base_config(path)
+        def parse(extension, contents, data)
+          # Evaluate template
+          require 'erb'
+          b = binding
+          contents = ERB.new(contents).result(b)
+
+          # Pass on to file type parser
+          return FILE_TO_PARSER[extension].parse(contents)
+        end
+
+        def load_base_config(path, template_data)
           # Make sure the format is recognized early on.
           base = Pathname.new(path)
           formats = FILE_TO_PARSER.keys
@@ -158,12 +145,12 @@ module Collapsium
           contents = file.read
 
           # Parse the contents.
-          config = FILE_TO_PARSER[base.extname].parse(contents)
+          config = parse(base.extname, contents, template_data)
 
           return base, UberHash.new(hashify(config))
         end
 
-        def load_local_config(base)
+        def load_local_config(base, template_data)
           # Now construct a file name for a local override.
           local = Pathname.new(base.dirname)
           local = local.join(base.basename(base.extname).to_s + "-local" +
@@ -177,7 +164,7 @@ module Collapsium
           file = local.open
           contents = file.read
 
-          local_config = FILE_TO_PARSER[base.extname].parse(contents)
+          local_config = parse(base.extname, contents, template_data)
 
           return local, UberHash.new(hashify(local_config))
         end
@@ -192,7 +179,7 @@ module Collapsium
           return data
         end
 
-        def resolve_includes(base, config)
+        def resolve_includes(base, config, template_data)
           processed = []
           includes = []
 
@@ -219,14 +206,14 @@ module Collapsium
               file = incfile.open
               contents = file.read
 
-              parsed = FILE_TO_PARSER[incfile.extname].parse(contents)
+              parsed = parse(incfile.extname, contents, template_data)
 
               # Extract and merge includes
               inner_inc = extract_includes(parsed)
               includes += inner_inc
 
               # Merge the rest
-              config.recursive_merge!(UberHash.new(hashify(parsed)))
+              config.recursive_merge!(hashify(parsed))
 
               processed << filename
             end

data/lib/collapsium-config/version.rb

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

data/spec/configuration_spec.rb

@@ -83,6 +83,17 @@ describe Collapsium::Config::Configuration do
       expect(cfg["baz"]).to eql "override"
       ENV.delete("BAZ")
     end
+
+    it "parses JSON when overriding from the environment" do
+      config = File.join(@data_path, 'hash.yml')
+      cfg = Collapsium::Config::Configuration.load_config(config)
+
+      ENV["BAZ"] = '{ "json_key": "json_value" }'
+      expect(cfg["foo"]).to eql "bar"
+      expect(cfg["baz"].is_a?(Hash)).to be_truthy
+      expect(cfg["baz.json_key"]).to eql "json_value"
+      ENV.delete("BAZ")
+    end
   end
 
   describe "extend functionality" do
@@ -180,4 +191,18 @@ describe Collapsium::Config::Configuration do
       expect { cfg[] }.to raise_error(ArgumentError)
     end
   end
+
+  describe "ERB templating" do
+    it "replaces variables" do
+      config = File.join(@data_path, 'template.yml')
+
+      data = {
+        my_var: Random.rand
+      }
+      cfg = Collapsium::Config::Configuration.load_config(config, data: data)
+
+      expect(cfg["foo"]).to eql "bar"
+      expect(cfg["baz"]).to eql data[:my_var]
+    end
+  end
 end

data/spec/data/template.yml

@@ -0,0 +1,3 @@
+---
+foo: bar
+baz: <%= data[:my_var] %>

data/spec/module_spec.rb

@@ -26,7 +26,7 @@ describe Collapsium::Config do
 
     it "loads configuration from an existing path" do
       Collapsium::Config.config_file = File.join(@data_path, 'global.yml')
-      expect { config.empty? }.not_to raise_error(ArgumentError)
+      expect { config.empty? }.not_to raise_error
       expect(config.empty?).to be_falsy
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: collapsium-config
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Jens Finkhaeuser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-11 00:00:00.000000000 Z
+date: 2016-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,84 +30,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.40'
+        version: '0.42'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.40'
+        version: '0.42'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.1'
+        version: '11.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.1'
+        version: '11.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: collapsium
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.4'
 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  "
@@ -152,6 +152,7 @@ files:
 - spec/data/merge-hash.yml
 - spec/data/recurse.yml
 - spec/data/recursive.yml
+- spec/data/template.yml
 - spec/data/test.json
 - spec/module_spec.rb
 - spec/spec_helper.rb
@@ -201,7 +202,7 @@ test_files:
 - spec/data/merge-hash.yml
 - spec/data/recurse.yml
 - spec/data/recursive.yml
+- spec/data/template.yml
 - spec/data/test.json
 - spec/module_spec.rb
 - spec/spec_helper.rb
-has_rdoc: