settings-env-loader 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.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
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ian Yang
+
+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,29 @@
+# Settings::Env::Loader
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'settings-env-loader'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install settings-env-loader
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+

data/lib/settings-env-loader.rb

@@ -0,0 +1,79 @@
+require "enumerator"
+
+module Settings
+  module Env
+    module Loader
+      VERSION = "0.0.1"
+
+      # Merges ENV and modify the hash directly
+      def merge_env(prefix = nil, separator = '_')
+        Merger.new(prefix, separator, self).merge
+        self
+      end
+
+      # Iterates the Hash as ENV key value pairs
+      def each_env(prefix = nil, separator = '_')
+        Enumerator.new do |y|
+          Exporter.new(prefix, separator, self).each(y)
+        end
+      end
+
+      class Merger
+        def initialize(prefix, separator, hash)
+          @prefix = prefix
+          @separator = separator
+          @hash = hash
+        end
+
+        def merge
+          @hash.each do |key, value|
+            env_name = [@prefix, key].compact.join(@separator).upcase
+
+            if value.is_a?(Hash)
+              Merger.new(env_name, @separator, value).merge
+            else
+              env_value = ENV[env_name]
+              if env_value
+                @hash[key] = convert(env_value, value)
+              end
+            end
+          end
+        end
+
+        def convert(value, origin_value)
+          case origin_value
+          when Symbol
+            value.to_sym
+          when Fixnum
+            value.to_i
+          when Float
+            value.to_f
+          when Array
+            Array(YAML.load(value))
+          else
+            value
+          end
+        end
+      end
+
+      class Exporter
+        def initialize(prefix, separator, hash)
+          @prefix = prefix
+          @separator = separator
+          @hash = hash
+        end
+
+        def each(y)
+          @hash.each do |key, value|
+            env_name = [@prefix, key].compact.join(@separator).upcase
+            if value.is_a?(Hash)
+              Exporter.new(env_name, @separator, value).each(y)
+            else
+              y << [env_name, value.to_s]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/settings_env_loader.rb

@@ -0,0 +1 @@
+require "settings-env-loader"

data/settings-env-loader.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'settings-env-loader'
+
+Gem::Specification.new do |gem|
+  gem.name          = "settings-env-loader"
+  gem.version       = Settings::Env::Loader::VERSION
+  gem.authors       = ["Ian Yang"]
+  gem.email         = ["me@iany.me"]
+  gem.description   = %q{Scan ENV and override correspondong settings in a nested Hash}
+  gem.summary       = %q{
+    The Hash must provide all configuration options. It
+    eases the deployment to platform such as heroku.
+
+    It is recommended to use settingslogic to load settings first, and then
+    merge ENV into it.
+  }
+  gem.homepage      = "https://github.com/doitian/settings-env-loader"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rake'
+end

data/spec/lib/settings-env-loader_spec.rb

@@ -0,0 +1,118 @@
+require 'settings-env-loader'
+
+describe Settings::Env::Loader do
+  let(:hash) do
+    {
+      :float => 1.2,
+      :fixnum => 20,
+      :array => [1, 2],
+      :hash => {
+        key: 'name',
+        value: 'settings-env-loader'
+      }
+    }
+  end
+
+  subject { hash }
+
+  before do
+    hash.extend Settings::Env::Loader
+  end
+
+  before do
+    $remember_env = ENV.to_hash
+    ENV.replace $remember_env.dup
+  end
+
+  after do
+    ENV.replace $remember_env
+  end
+
+  describe 'merge_env' do
+    context 'when prefix is nil' do
+      context 'ENV[FIXNUM] = 1' do
+        before do
+          ENV['FIXNUM'] = '1'
+          hash.merge_env
+        end
+
+        its([:fixnum]) { should == 1 }
+      end
+      context 'ENV[FIXNUM] = 1.1' do
+        before do
+          ENV['FIXNUM'] = '1.1'
+          hash.merge_env
+        end
+
+        its([:fixnum]) { should == 1 }
+      end
+      context 'ENV[FLOAT] = 1.5' do
+        before do
+          ENV['FLOAT'] = '1.5'
+          hash.merge_env
+        end
+
+        its([:float]) { should == 1.5 }
+      end
+      context 'ENV[ARRAY] = [10,20]' do
+        before do
+          ENV['ARRAY'] = '[10,20]'
+          hash.merge_env
+        end
+
+        its([:array]) { should == [10,20] }
+      end
+      context 'ENV[HASH_KEY] = key' do
+        before do
+          ENV['HASH_KEY'] = 'key'
+          hash.merge_env
+        end
+
+        its([:hash]) { should == { :key => 'key', :value => 'settings-env-loader'} }
+      end
+
+      context 'when no ENV' do
+        it 'should not be changed' do
+          before = hash.dup
+          hash.merge_env
+          hash.should == before
+        end
+      end
+    end
+
+    context 'when prefix is SETTINGS' do
+      context 'ENV[FIXNUM] = 1' do
+        before do
+          ENV['FIXNUM'] = '1'
+          hash.merge_env('SETTINGS')
+        end
+
+        its([:fixnum]) { should == 20 }
+      end
+      context 'ENV[SETTINGS_FIXNUM] = 1' do
+        before do
+          ENV['SETTINGS_FIXNUM'] = '1'
+          hash.merge_env('SETTINGS')
+        end
+
+        its([:fixnum]) { should == 1 }
+      end
+    end
+  end
+
+  describe 'each_env' do
+    context 'when prefix is nil' do
+      subject { Hash[*hash.each_env.to_a.flatten] }
+      its(['FLOAT']) { should == '1.2' }
+      its(['FIXNUM']) { should == '20' }
+      its(['ARRAY']) { should == '[1, 2]' }
+      its(['HASH_KEY']) { should == 'name' }
+      its(['HASH_VALUE']) { should =='settings-env-loader' }
+    end
+    context 'when prefix is SETTINGS' do
+      subject { Hash[*hash.each_env('SETTINGS').to_a.flatten] }
+      its(['FIXNUM']) { should be_nil }
+      its(['SETTINGS_FIXNUM']) { should == '20' }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: settings-env-loader
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ian Yang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Scan ENV and override correspondong settings in a nested Hash
+email:
+- me@iany.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/settings-env-loader.rb
+- lib/settings_env_loader.rb
+- settings-env-loader.gemspec
+- spec/lib/settings-env-loader_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/doitian/settings-env-loader
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1968224689981837943
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1968224689981837943
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: The Hash must provide all configuration options. It eases the deployment
+  to platform such as heroku.  It is recommended to use settingslogic to load settings
+  first, and then merge ENV into it.
+test_files:
+- spec/lib/settings-env-loader_spec.rb
+- spec/spec_helper.rb