dry-config 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d5cebd6a6d0383fcb039c2dfc66e262992d71c72
+  data.tar.gz: 4aa181325a5fb085cdfc7da1c0cdfa32dc7e8747
+SHA512:
+  metadata.gz: e9a5d9294a5b1ac10eee9b1f4733cf6ccd1340fb3ad1f58d144973d169c3d864ecb7dc9e333285c783e0110900a460648b78e320fabed735192cb9013ef5fa63
+  data.tar.gz: a5519d08c52c8fb5d6871023286542b26615058542c8a8ccb9202b766a97896c269ab80aa299183a5168de2ea63e27f19ee0d1e0f183d4a2c8fbf4128ef8ecea

data/.gitignore

@@ -0,0 +1,18 @@
+.idea
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ruby-2.1.2@dry_config --create

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dry-config.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 AlienFast, LLC
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,119 @@
+# Dry::Config
+
+Simple base class for DRY environment based configurations that can be loaded from multiple overriding yml files.  
+
+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).
+ 
+The [elastic-beanstalk gem](https://github.com/alienfast/elastic-beanstalk) is a real world example that utilized `Dry::Config::Base`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dry-config'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dry-config
+
+## Usage
+
+### Step 1.  Write a config class
+Note this sample uses the `Singleton` pattern, which is useful but not required.
+
+```ruby    
+    require 'singleton'
+    require 'dry/config'
+    
+    class AcmeConfig < Dry::Config::Base
+        
+        # (optional) make this the only instance 
+        include Singleton
+        
+        # seed the sensible defaults here
+        def seed_default_configuration
+          
+          @configuration = {
+              environment: nil,
+              strategy: :blue_green,
+              package: {
+                  verbose: false
+              },
+              options: {}
+          }
+        end
+    end
+```
+    
+### Step 2.  Write a yml config file
+    
+```yaml
+    # sample config demonstrating multi-environment override
+    ---
+    app: acme
+    title: Acme Holdings, LLC
+    #---
+    options:
+      aws:elasticbeanstalk:application:environment:
+        RAILS_ENV: foobar
+    
+      aws:autoscaling:launchconfiguration:
+        InstanceType: foo
+    
+    #---
+    development:
+      strategy: inplace-update
+      package:
+        verbose: true
+      options:
+        aws:autoscaling:launchconfiguration:
+          InstanceType: t1.micro
+        aws:elasticbeanstalk:application:environment:
+          RAILS_ENV: development
+    
+    #---
+    production:
+      options:
+        aws:autoscaling:launchconfiguration:
+          InstanceType: t1.large
+        aws:elasticbeanstalk:application:environment:
+          RAILS_ENV: production    
+```
+
+### Step 3. Load your config
+ Note that multiple files can be loaded and overriden.  A nil environment is also possible.
+ 
+```ruby
+     AcmeConfig.instance.load!(:production, 'path_to/acme.yml')
+```
+
+### Step 4. Use the values
+ Note that all keys are symbolized upon loading.
+
+```ruby
+    config = Acme.config.instance
+    config.load!(:production, 'path_to/acme.yml')
+    
+    config.app          # acme
+    config.title        # Acme Holdings, LLC    
+    config.strategy     # :blue_green,
+    config.options[:'aws:autoscaling:launchconfiguration'][:InstanceType] # t1.large
+```   
+   
+## Other options
+- 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.
+   
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+
+# add rspec task
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+task :default => :spec
+task :test => :spec

data/dry-config.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dry/config/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'dry-config'
+  s.version       = Dry::Config::VERSION
+  s.authors       = ['Kevin Ross']
+  s.email         = ['kevin.ross@alienfast.com']
+  s.description   = %q{Simple base class for DRY environment based configurations.}
+  s.summary       = %q{Simple base class for DRY environment based configurations.}
+  s.homepage      = 'https://github.com/alienfast/dry-config'
+  s.license       = 'MIT'
+
+  s.files = `git ls-files`.split($/).reject { |f| f =~ /^samples\// }
+  s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'bundler', '~> 1.3'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec', '>= 2.14.1'
+
+end

data/lib/dry/config/base.rb

@@ -0,0 +1,105 @@
+require 'dry/config/deep_symbolizable'
+require 'yaml'
+
+module Dry
+  module Config
+#
+# Dry::Config::Base allows for default settings and mounting a specific environment with
+# overriding hash values and merging of array values.
+#
+#   NOTE: Anything can be overridden and merged into top-level settings (hashes) including
+#   anything that is an array value.  Array values are merged *not* replaced.  If you think
+#   something is screwy, see the defaults in the #initialize as those add some default array values.
+#   If this behavior of merging arrays or the defaults are somehow un-sensible, file an issue and we'll revisit it.
+#
+    class Base
+      attr_reader :configuration
+
+      def initialize
+        seed_default_configuration
+
+        # used for pruning initial base set.  See #load!
+        @potential_environments = [:development, :test, :staging, :production]
+      end
+
+      def seed_default_configuration
+        # override and seed the sensible defaults here
+        @configuration = {}
+      end
+
+      # This is the main point of entry - we call #load! and provide
+      # 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)
+
+        # raise 'Unspecified environment' if environment.nil?
+        raise 'Unspecified filename' if filename.nil?
+
+        # save these in case we #reload
+        @environment = environment
+        @filename = filename
+
+        # merge all top level settings with the defaults set in the #init
+
+        deep_merge!(@configuration, YAML::load_file(filename).deep_symbolize)
+
+        # add the environment to the top level settings
+        @configuration[:environment] = (environment.nil? ? nil : environment.to_s)
+
+        # 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.
+
+        # overlay the specific environment if provided
+        if environment && @configuration[environment.to_sym]
+
+          # 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
+
+          # re-read the file
+          environment_settings = YAML::load_file(filename).deep_symbolize
+
+          # 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)
+        end
+      end
+
+      def reload!
+        clear
+        load! @environment, @filename
+      end
+
+      def clear
+        seed_default_configuration
+      end
+
+      def method_missing(name, *args, &block)
+        @configuration[name.to_sym] ||
+            #fail(NoMethodError, "Unknown settings root \'#{name}\'", caller)
+            nil
+      end
+
+      private
+
+      def deep_merge!(target, data)
+        merger = proc { |key, v1, v2|
+          if (Hash === v1 && Hash === v2)
+            v1.merge(v2, &merger)
+          elsif (Array === v1 && Array === v2)
+            v1.concat(v2)
+          else
+            v2
+          end
+        }
+        target.merge! data, &merger
+      end
+    end
+  end
+end

data/lib/dry/config/deep_symbolizable.rb

@@ -0,0 +1,81 @@
+# Slightly modified from https://gist.github.com/morhekil/998709
+
+# Symbolizes all of hash's keys and subkeys.
+# Also allows for custom pre-processing of keys (e.g. downcasing, etc)
+# if the block is given:
+#
+# somehash.deep_symbolize { |key| key.downcase }
+#
+# Usage: either include it into global Hash class to make it available to
+#        to all hashes, or extend only your own hash objects with this
+#        module.
+#        E.g.:
+#        1) class Hash; include DeepSymbolizable; end
+#        2) myhash.extend DeepSymbolizable
+module Dry
+  module Config
+
+    module DeepSymbolizable
+      def deep_symbolize(invert = false, &block)
+        method = self.class.to_s.downcase.to_sym
+        symbolizers = DeepSymbolizable::Symbolizers
+        symbolizers.respond_to?(method) ? symbolizers.send(method, self, invert, &block) : self
+      end
+
+      module Symbolizers
+        extend self
+
+        # the primary method - symbolizes keys of the given hash,
+        # preprocessing them with a block if one was given, and recursively
+        # going into all nested enumerables
+        def hash(hash, invert, &block)
+          hash.inject({}) do |result, (key, value)|
+            # Recursively deep-symbolize subhashes
+            value = _recurse_(value, invert, &block)
+
+            # Pre-process the key with a block if it was given
+            key = yield key if block_given?
+
+            if invert
+              # UN-Symbolize the key
+              s_key = key.to_s rescue key
+
+              # write it back into the result and return the updated hash
+              result[s_key] = value
+
+            else
+              # Symbolize the key string if it responds to to_sym
+              sym_key = key.to_sym rescue key
+
+              # write it back into the result and return the updated hash
+              result[sym_key] = value
+            end
+            result
+          end
+        end
+
+        # walking over arrays and symbolizing all nested elements
+        def array(ary, invert, &block)
+          ary.map { |v| _recurse_(v, invert, &block) }
+        end
+
+        # handling recursion - any Enumerable elements (except String)
+        # is being extended with the module, and then symbolized
+        def _recurse_(value, invert, &block)
+          if value.is_a?(Enumerable) && !value.is_a?(String)
+            # support for a use case without extended core Hash
+            value.extend DeepSymbolizable unless value.class.include?(DeepSymbolizable)
+            value = value.deep_symbolize(invert, &block)
+          end
+          value
+        end
+      end
+
+    end
+  end
+end
+
+# include in all Hash objects
+class Hash;
+  include Dry::Config::DeepSymbolizable;
+end

data/lib/dry/config/version.rb

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

data/lib/dry/config.rb

@@ -0,0 +1,8 @@
+require 'dry/config/version'
+
+module Dry
+  module Config
+    require 'dry/config/deep_symbolizable'
+    require 'dry/config/base'
+  end
+end

data/spec/dry/config/acme.yml

@@ -0,0 +1,30 @@
+# sample config demonstrating multi-environment override
+---
+app: acme
+title: Acme Holdings, LLC
+#---
+options:
+  aws:elasticbeanstalk:application:environment:
+    RAILS_ENV: foobar
+
+  aws:autoscaling:launchconfiguration:
+    InstanceType: foo
+
+#---
+development:
+  strategy: inplace-update
+  package:
+    verbose: true
+  options:
+    aws:autoscaling:launchconfiguration:
+      InstanceType: t1.micro
+    aws:elasticbeanstalk:application:environment:
+      RAILS_ENV: development
+
+#---
+production:
+  options:
+    aws:autoscaling:launchconfiguration:
+      InstanceType: t1.large
+    aws:elasticbeanstalk:application:environment:
+      RAILS_ENV: production

data/spec/dry/config/base_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+require 'singleton'
+
+describe Dry::Config::Base do
+
+  class AcmeConfig < Dry::Config::Base
+    include Singleton
+
+    def seed_default_configuration
+      # seed the sensible defaults here
+      @configuration = {
+          environment: nil,
+          strategy: :blue_green,
+          package: {
+              verbose: false
+          },
+          options: {}
+      }
+    end
+  end
+
+  subject(:acmeConfig) { AcmeConfig.instance }
+
+  it 'should work as a singleton' do
+    expect(acmeConfig).to equal(AcmeConfig.instance)
+  end
+
+  it 'should not raise error when key is not found' do
+    acmeConfig.clear
+    expect(acmeConfig.app).to be_nil
+  end
+
+  it 'should provide seed configuration' do
+    acmeConfig.clear
+    assert_common_seed_settings
+    expect(acmeConfig.options.length).to eql 0
+  end
+
+  it 'should read file with nil environment' do
+    acmeConfig.clear
+    acmeConfig.load!(nil, config_file_path)
+
+    assert_common_seed_settings
+    assert_common_top_level_settings
+
+    assert_option :'aws:elasticbeanstalk:application:environment', :RAILS_ENV, 'foobar'
+    assert_option :'aws:autoscaling:launchconfiguration', :InstanceType, 'foo'
+  end
+
+  it 'should read file and override with development environment' do
+    acmeConfig.clear
+    acmeConfig.load!(:development, config_file_path)
+
+    # assert_common_seed_settings
+    assert_common_top_level_settings
+
+    assert_option :'aws:elasticbeanstalk:application:environment', :RAILS_ENV, 'development'
+    assert_option :'aws:autoscaling:launchconfiguration', :InstanceType, 't1.micro'
+
+    expect(acmeConfig.package[:verbose]).to eql true
+    expect(acmeConfig.strategy).to eql 'inplace-update'
+  end
+
+  it 'should read file and override with production environment' do
+    acmeConfig.clear
+    acmeConfig.load!(:production, config_file_path)
+
+    # 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
+  end
+
+  private
+
+  def assert_option(section, name, value)
+    expect(acmeConfig.options[section][name]).to eql value
+  end
+
+
+  def assert_common_seed_settings
+    expect(acmeConfig.strategy).to eql :blue_green
+    expect(acmeConfig.environment).to be_nil
+    expect(acmeConfig.package[:verbose]).to eql false
+    expect(acmeConfig.options).not_to be_nil
+  end
+
+  def assert_common_top_level_settings
+    expect(acmeConfig.app).to eql 'acme'
+    expect(acmeConfig.title).to eql 'Acme Holdings, LLC'
+  end
+
+  def config_file_path
+    File.expand_path('../acme.yml', __FILE__)
+  end
+end

data/spec/dry/config/deep_symbolizable_spec.rb

@@ -0,0 +1,58 @@
+# https://gist.github.com/morhekil/998709
+
+require 'rspec'
+require 'dry/config/deep_symbolizable'
+
+describe 'Hash#deep_symbolize' do
+  let(:hash) { {} }
+  subject do
+    #hash.extend DeepSymbolizable
+    hash.deep_symbolize
+  end
+
+
+  context 'on simple hash' do
+    let(:hash) { {:key1 => 'val1', 'key2' => 'val2'} }
+    it {
+      h2 = hash.deep_symbolize
+      expect(h2).to eql({:key1 => 'val1', :key2 => 'val2'})
+    }
+
+    context 'when inverting' do
+      let(:hash) { {'key1' => 'val1', 'key2' => 'val2'} }
+      it {
+        h2 = hash.deep_symbolize
+        expect(h2).to eql({:key1 => 'val1', :key2 => 'val2'})
+
+        h3 = h2.deep_symbolize(true)
+        expect(h3).to eql({'key1' => 'val1', 'key2' => 'val2'})
+      }
+    end
+  end
+
+  context 'on nested hash' do
+    let(:hash) { {'key1' => 'val1', 'subkey' => {'key2' => 'val2'}} }
+    it {
+      h2 = hash.deep_symbolize
+      expect(h2).to eql({:key1 => 'val1', :subkey => {:key2 => 'val2'}})
+    }
+
+
+    context 'with nested array' do
+      let(:hash) { {'key1' => 'val1', 'subkey' => [{'key2' => 'val2'}]} }
+      it {
+        h2 = hash.deep_symbolize
+        expect(h2).to eql({:key1 => 'val1', :subkey => [{:key2 => 'val2'}]})
+      }
+    end
+  end
+
+
+  describe 'block preprocessing keys' do
+    let(:hash) { {'key1' => 'val1', 'subkey' => [{'key2' => 'val2'}]} }
+    it {
+      h2 = hash.deep_symbolize{ |k| k.upcase }
+      expect(h2).to eql({:KEY1 => 'val1', :SUBKEY => [{:KEY2 => 'val2'}]})
+    }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+
+# our gem
+require 'dry/config'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: dry-config
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kevin Ross
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+description: Simple base class for DRY environment based configurations.
+email:
+- kevin.ross@alienfast.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rvmrc"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dry-config.gemspec
+- lib/dry/config.rb
+- lib/dry/config/base.rb
+- lib/dry/config/deep_symbolizable.rb
+- lib/dry/config/version.rb
+- spec/dry/config/acme.yml
+- spec/dry/config/base_spec.rb
+- spec/dry/config/deep_symbolizable_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/alienfast/dry-config
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Simple base class for DRY environment based configurations.
+test_files:
+- spec/dry/config/acme.yml
+- spec/dry/config/base_spec.rb
+- spec/dry/config/deep_symbolizable_spec.rb
+- spec/spec_helper.rb