dry-config 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5cebd6a6d0383fcb039c2dfc66e262992d71c72
-  data.tar.gz: 4aa181325a5fb085cdfc7da1c0cdfa32dc7e8747
+  metadata.gz: 412477071e60ae65b5f06549108ee7864926964c
+  data.tar.gz: c7f28f2f85e928ff693b6526a315916e9db6e200
 SHA512:
-  metadata.gz: e9a5d9294a5b1ac10eee9b1f4733cf6ccd1340fb3ad1f58d144973d169c3d864ecb7dc9e333285c783e0110900a460648b78e320fabed735192cb9013ef5fa63
-  data.tar.gz: a5519d08c52c8fb5d6871023286542b26615058542c8a8ccb9202b766a97896c269ab80aa299183a5168de2ea63e27f19ee0d1e0f183d4a2c8fbf4128ef8ecea
+  metadata.gz: 46da6bd6986668591d96de8b464d38b163d0f1182d46e99897e71c957773e3516ee269cb253197c4c8e785eb130f59c34321f7f16c37bbf20c1967c67564eb75
+  data.tar.gz: b29babccda05bd28332141231c0d144b7210155c9e7633fc4e50363ec631b07ab038bc9d39fc2a86fd46705df790899e24f2a5ba499fe97cefcdf0fc8f44edfa

data/README.md

@@ -1,9 +1,10 @@
 # Dry::Config
 
-Simple base class for DRY environment based configurations that can be loaded from multiple overriding yml files.  
+Simple base class for DRY configurations configurations that can be loaded from multiple overriding yml files.
+  
+Sample uses include environment based e.g. `development, test, production` and multi-domain white label configurations.  
 
-A programmatic seed configuration may be specified, as well as the ability to load multiple overriding configuration files 
-(think multi-environment and a white label multi-domain configuration).
+A programmatic seed configuration may be specified, as well as the ability to load one to many overriding configuration files.
  
 The [elastic-beanstalk gem](https://github.com/alienfast/elastic-beanstalk) is a real world example that utilized `Dry::Config::Base`.
 
@@ -109,6 +110,16 @@ Note this sample uses the `Singleton` pattern, which is useful but not required.
 - Expected environments are `[:development, :test, :staging, :production]`.  Expand or redefine `@potential_environments` these by overriding the `#initialize` or doing so in your optional `#seed_default_configuration`.  This is used in the used in the overlay pruning process to prevent unused branches of configuration from showing up in the resolved configuration.
 - An optional `#seed_default_configuration` allows you to provide a configuration base    
 - `#clear` will restore to the seed configuration, allowing you to `#load!` new settings.
+
+## White Label sample
+
+```ruby
+    class WhiteLabelConfig < Dry::Config::Base
+    end
+
+    config = WhiteLabelConfig.new
+    config.load!(nil, 'base.yml', 'acme.com.yml', 'scheduling.acme.com.yml')
+```    
    
 ## Contributing
 

data/lib/dry/config/base.rb

@@ -31,49 +31,62 @@ module Dry
       # a name of the file to read as it's argument. We can also pass in some
       # options, but at the moment it's being used to allow per-environment
       # overrides in Rails
-      def load!(environment, filename)
+      def load!(environment, *filenames)
 
         # raise 'Unspecified environment' if environment.nil?
-        raise 'Unspecified filename' if filename.nil?
+        raise 'Unspecified filename' if filenames.nil?
+
+        # ensure symbol
+        if environment
+          environment = environment.to_sym unless environment.is_a? Symbol
+        end
 
         # save these in case we #reload
         @environment = environment
-        @filename = filename
+        @filenames = filenames
 
-        # merge all top level settings with the defaults set in the #init
-
-        deep_merge!(@configuration, YAML::load_file(filename).deep_symbolize)
+        filenames.each do |filename|
+          # merge all top level settings with the defaults set in the #init
+          deep_merge!(@configuration, resolve_config(environment, filename))
+        end
 
         # add the environment to the top level settings
         @configuration[:environment] = (environment.nil? ? nil : environment.to_s)
+      end
 
-        # TODO: the target file should be overlaid in an environment specific way in isolation, prior to merging with @configuration
-        # TODO: otherwise this will kill prior wanted settings when merging multiple files.
+      def resolve_config(environment, filename)
 
-        # overlay the specific environment if provided
-        if environment && @configuration[environment.to_sym]
+        config = load_yaml_file(filename)
 
-          # this is environment specific, so prune any environment
-          # based settings from the initial set so that they can be overlaid.
-          @potential_environments.each do |env|
-            @configuration.delete(env)
-          end
+        should_overlay_environment = environment && config[environment]
 
+        # Prune all known environments so that we end up with the top-level configuration.
+        @potential_environments.each do |env|
+          config.delete(env)
+        end
+
+        # overlay the specific environment if provided
+        if should_overlay_environment
           # re-read the file
-          environment_settings = YAML::load_file(filename).deep_symbolize
+          environment_settings = load_yaml_file(filename)
 
           # snag the requested environment
           environment_settings = environment_settings[environment.to_sym]
 
-          # finally overlay what was provided
-          #@configuration.deep_merge!(environment_settings)
-          deep_merge!(@configuration, environment_settings)
+          # finally overlay what was provided the settings from the specific environment
+          deep_merge!(config, environment_settings)
         end
+
+        config
+      end
+
+      def load_yaml_file(filename)
+        YAML::load_file(filename).deep_symbolize
       end
 
       def reload!
         clear
-        load! @environment, @filename
+        load! @environment, @filenames
       end
 
       def clear
@@ -88,7 +101,11 @@ module Dry
 
       private
 
-      def deep_merge!(target, data)
+      def deep_merge!(target, overrides)
+
+        raise 'target cannot be nil' if target.nil?
+        raise 'overrides cannot be nil' if overrides.nil?
+
         merger = proc { |key, v1, v2|
           if (Hash === v1 && Hash === v2)
             v1.merge(v2, &merger)
@@ -98,7 +115,7 @@ module Dry
             v2
           end
         }
-        target.merge! data, &merger
+        target.merge! overrides, &merger
       end
     end
   end

data/lib/dry/config/version.rb

@@ -1,5 +1,5 @@
 module Dry
   module Config
-    VERSION = '1.0.0'
+    VERSION = '1.1.0'
   end
 end

data/spec/dry/config/base_spec.rb

@@ -34,50 +34,66 @@ describe Dry::Config::Base do
     acmeConfig.clear
     assert_common_seed_settings
     expect(acmeConfig.options.length).to eql 0
+
+    # ensure no unnecessary environments make it into the resolved configuration
+    expect(acmeConfig.development).to be_nil
+    expect(acmeConfig.production).to be_nil
   end
 
-  it 'should read file with nil environment' do
-    acmeConfig.clear
-    acmeConfig.load!(nil, config_file_path)
+  context 'when loading a single configuration file' do
 
-    assert_common_seed_settings
-    assert_common_top_level_settings
+    it 'should read file with nil environment' do
+      acmeConfig.clear
+      acmeConfig.load!(nil, config_file_path)
 
-    assert_option :'aws:elasticbeanstalk:application:environment', :RAILS_ENV, 'foobar'
-    assert_option :'aws:autoscaling:launchconfiguration', :InstanceType, 'foo'
-  end
+      assert_common_seed_settings
+      assert_common_top_level_settings
 
-  it 'should read file and override with development environment' do
-    acmeConfig.clear
-    acmeConfig.load!(:development, config_file_path)
+      assert_option :'aws:elasticbeanstalk:application:environment', :RAILS_ENV, 'foobar'
+      assert_option :'aws:autoscaling:launchconfiguration', :InstanceType, 'foo'
 
-    # assert_common_seed_settings
-    assert_common_top_level_settings
+      # ensure no unnecessary environments make it into the resolved configuration
+      expect(acmeConfig.development).to be_nil
+      expect(acmeConfig.production).to be_nil
+    end
 
-    assert_option :'aws:elasticbeanstalk:application:environment', :RAILS_ENV, 'development'
-    assert_option :'aws:autoscaling:launchconfiguration', :InstanceType, 't1.micro'
+    it 'should override with development environment' do
+      acmeConfig.clear
+      acmeConfig.load!(:development, config_file_path)
 
-    expect(acmeConfig.package[:verbose]).to eql true
-    expect(acmeConfig.strategy).to eql 'inplace-update'
-  end
+      # assert_common_seed_settings
+      assert_common_top_level_settings
 
-  it 'should read file and override with production environment' do
-    acmeConfig.clear
-    acmeConfig.load!(:production, config_file_path)
+      assert_option :'aws:elasticbeanstalk:application:environment', :RAILS_ENV, 'development'
+      assert_option :'aws:autoscaling:launchconfiguration', :InstanceType, 't1.micro'
 
-    # assert_common_seed_settings
-    assert_common_top_level_settings
+      expect(acmeConfig.package[:verbose]).to eql true
+      expect(acmeConfig.strategy).to eql 'inplace-update'
 
-    assert_option :'aws:elasticbeanstalk:application:environment', :RAILS_ENV, 'production'
-    assert_option :'aws:autoscaling:launchconfiguration', :InstanceType, 't1.large'
+      # ensure no unnecessary environments make it into the resolved configuration
+      expect(acmeConfig.production).to be_nil
+    end
 
-    expect(acmeConfig.package[:verbose]).to eql false
+    it 'should override with production environment' do
+      acmeConfig.clear
+      acmeConfig.load!(:production, config_file_path)
 
-    # seed values
-    expect(acmeConfig.strategy).to eql :blue_green
-    expect(acmeConfig.package[:verbose]).to eql false
-  end
+      # assert_common_seed_settings
+      assert_common_top_level_settings
 
+      assert_option :'aws:elasticbeanstalk:application:environment', :RAILS_ENV, 'production'
+      assert_option :'aws:autoscaling:launchconfiguration', :InstanceType, 't1.large'
+
+      expect(acmeConfig.package[:verbose]).to eql false
+
+      # seed values
+      expect(acmeConfig.strategy).to eql :blue_green
+      expect(acmeConfig.package[:verbose]).to eql false
+
+      # ensure no unnecessary environments make it into the resolved configuration
+      expect(acmeConfig.development).to be_nil
+    end
+  end
   private
 
   def assert_option(section, name, value)
@@ -100,4 +116,45 @@ describe Dry::Config::Base do
   def config_file_path
     File.expand_path('../acme.yml', __FILE__)
   end
+
+  context 'white label' do
+    class WhiteLabelConfig < Dry::Config::Base
+    end
+
+    subject(:white_label_config) { WhiteLabelConfig.new }
+
+    it 'should read the base white_label_config ' do
+      white_label_config.clear
+      white_label_config.load!(nil, base_file_path)
+
+      expect(white_label_config.domain).to eql '<undefined>'
+      expect(white_label_config.title).to eql '<undefined2>'
+      expect(white_label_config.layouts[:app]).to eql '<undefined3>'
+      expect(white_label_config.layouts[:public]).to eql '<undefined4>'
+      expect(white_label_config.features[:scheduling]).to eql true
+    end
+
+    it 'should read the scheduling.acme.com white_label_config ' do
+      white_label_config.clear
+      white_label_config.load!(nil, base_file_path, acme_file_path, scheduling_acme_file_path)
+
+      expect(white_label_config.domain).to eql 'scheduling.acme.com'
+      expect(white_label_config.title).to eql 'Acme Industries Limited, Inc.'
+      expect(white_label_config.layouts[:app]).to eql 'layouts/scheduling_app.haml'
+      expect(white_label_config.layouts[:public]).to eql 'layouts/public.haml'
+      expect(white_label_config.features[:scheduling]).to eql 8
+    end
+
+    def base_file_path
+      File.expand_path('../white-label/base.yml', __FILE__)
+    end
+
+    def acme_file_path
+      File.expand_path('../white-label/acme.com.yml', __FILE__)
+    end
+
+    def scheduling_acme_file_path
+      File.expand_path('../white-label/scheduling.acme.com.yml', __FILE__)
+    end
+  end
 end

data/spec/dry/config/white-label/acme.com.yml

@@ -0,0 +1,12 @@
+# sample config demonstrating white label overrides for acme.com
+---
+domain: acme.com
+title: Acme Industries Limited, Inc.
+layouts:
+  app: layouts/app.haml
+  public: layouts/public.haml
+#---
+
+
+features:
+  scheduling: false

data/spec/dry/config/white-label/base.yml

@@ -0,0 +1,12 @@
+# sample config demonstrating white label overrides
+---
+domain: <undefined>
+title: <undefined2>
+layouts:
+  app: <undefined3>
+  public: <undefined4>
+#---
+
+
+features:
+  scheduling: true

data/spec/dry/config/white-label/scheduling.acme.com.yml

@@ -0,0 +1,10 @@
+# sample config demonstrating white label overrides for acme.com
+---
+domain: scheduling.acme.com
+layouts:
+  app: layouts/scheduling_app.haml
+#---
+
+
+features:
+  scheduling: 8

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-config
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Kevin Ross
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-10 00:00:00.000000000 Z
+date: 2014-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -74,6 +74,9 @@ files:
 - spec/dry/config/acme.yml
 - spec/dry/config/base_spec.rb
 - spec/dry/config/deep_symbolizable_spec.rb
+- spec/dry/config/white-label/acme.com.yml
+- spec/dry/config/white-label/base.yml
+- spec/dry/config/white-label/scheduling.acme.com.yml
 - spec/spec_helper.rb
 homepage: https://github.com/alienfast/dry-config
 licenses:
@@ -103,4 +106,7 @@ test_files:
 - spec/dry/config/acme.yml
 - spec/dry/config/base_spec.rb
 - spec/dry/config/deep_symbolizable_spec.rb
+- spec/dry/config/white-label/acme.com.yml
+- spec/dry/config/white-label/base.yml
+- spec/dry/config/white-label/scheduling.acme.com.yml
 - spec/spec_helper.rb