static_config 0.0.1

data/.autotest

@@ -0,0 +1,5 @@
+Autotest.add_hook(:initialize) do |at|
+  at.add_exception /^\.git/
+  at.add_exception /^\.bundle/
+  at.add_exception /sw[op]$/
+end

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--debug

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in static_config.gemspec
+gemspec
+
+gem 'rake'
+gem 'rspec'
+gem 'autotest',       :require => nil
+gem 'autotest-growl', :require => nil
+gem 'ruby-debug'

data/README.md

@@ -0,0 +1,35 @@
+Example
+-------
+
+    MyAppConfig = StaticConfig.build do
+      first do
+        env_yaml 'my_app_config'
+        file Rails.root.join('config/my_app.yml'), :section => Rails.env
+      end
+      env 'MY_APP'
+    end
+
+Now you have an object MyAppConfig that you can use anywhere.
+
+For instance, if your `config/my_app.yml` looks like this:
+
+    development:
+      user:
+        selected:
+          color: orange
+
+You could get `orange` by doing this:
+
+    MyAppConfig.user.selected.color
+
+You could override it at runtime by setting the environment variable
+`MY_APP_USER_SELECTED_COLOR`.
+
+You can also override the entire `config/my_app.yml` file by storing
+some yaml in an environment variable called `my_app_config`.
+
+To get your config to reload on each request in Rails, add this:
+
+    Rails.application.config.to_prepare do
+      MyAppConfig.reload!
+    end

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+desc 'Run specs'
+RSpec::Core::RakeTask.new

data/lib/static_config.rb

@@ -0,0 +1,11 @@
+require 'static_config/configurer'
+
+module StaticConfig
+  class << self
+    def build(&block)
+      config = Configurer.new
+      config.instance_eval(&block)
+      config.build
+    end
+  end
+end

data/lib/static_config/aggregation/first.rb

@@ -0,0 +1,22 @@
+module StaticConfig
+  module Aggregation
+    class First
+      def initialize(readers)
+        @readers = readers
+      end
+
+      def read
+        @readers.inject(nil) { |res, reader| res || empty_to_nil(reader.read) } || {}
+      end
+
+      private
+      def empty_to_nil(hash)
+        if hash && hash.size > 0
+          hash
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/static_config/aggregation/merge.rb

@@ -0,0 +1,26 @@
+module StaticConfig
+  module Aggregation
+    class Merge
+      def initialize(readers)
+        @readers = readers
+      end
+
+      def read
+        @readers.inject({}) { |res, reader| deep_merge res, reader.read }
+      end
+
+      private
+      def deep_merge base, overrides
+        overrides.inject(base.dup) { |res, (key, value)|
+          res[key] =
+            if res[key].is_a?(Hash) && value.is_a?(Hash)
+              deep_merge res[key], value
+            else
+              value
+            end
+          res
+        }
+      end
+    end
+  end
+end

data/lib/static_config/config_hash.rb

@@ -0,0 +1,23 @@
+module StaticConfig
+  class ConfigHash
+    def initialize(data)
+      @data = data
+    end
+
+    def method_missing(attr, *args)
+      if value = @data[attr.to_s]
+        if value.is_a? Hash
+          ConfigHash.new value
+        else
+          value
+        end
+      else
+        nil
+      end
+    end
+
+    def ==(other)
+      super || @data == other
+    end
+  end
+end

data/lib/static_config/config_proxy.rb

@@ -0,0 +1,21 @@
+require 'static_config/config_hash'
+
+module StaticConfig
+  class ConfigProxy
+    def initialize(reader)
+      @reader = reader
+    end
+
+    def method_missing(*args)
+      config.send(*args)
+    end
+
+    def config
+      @config ||= ConfigHash.new @reader.read
+    end
+
+    def reload!
+      @config = nil
+    end
+  end
+end

data/lib/static_config/configurer.rb

@@ -0,0 +1,42 @@
+require 'static_config/config_proxy'
+require 'static_config/aggregation/merge'
+require 'static_config/aggregation/first'
+require 'static_config/reader/environment'
+require 'static_config/reader/yaml_env'
+require 'static_config/reader/yaml_file'
+
+module StaticConfig
+  class Configurer
+    def build
+      ConfigProxy.new StaticConfig::Aggregation::Merge.new(self.readers)
+    end
+    def first(&block)
+      push_readers do
+        instance_eval(&block)
+        add StaticConfig::Aggregation::First.new self.readers
+      end
+    end
+    def env(var_prefix)
+      add StaticConfig::Reader::Environment.new(:env_prefix => var_prefix)
+    end
+    def env_yaml(var_name)
+      add StaticConfig::Reader::YamlEnv.new(:env => var_name)
+    end
+    def file(path, opts={})
+      add StaticConfig::Reader::YamlFile.new(opts.merge(:file => path))
+    end
+    def add(reader)
+      readers << reader
+    end
+    def push_readers
+      old_readers, self.readers = self.readers, []
+      yield
+    ensure
+      self.readers = old_readers
+    end
+    def readers
+      @readers ||= []
+    end
+    attr_writer :readers
+  end
+end

data/lib/static_config/reader/base.rb

@@ -0,0 +1,18 @@
+module StaticConfig
+  module Reader
+    class Base
+      class << self
+        def read(opts = {})
+          new(opts).read
+        end
+      end
+
+      def initialize(opts = {})
+      end
+
+      def read
+        raw_data || {}
+      end
+    end
+  end
+end

data/lib/static_config/reader/environment.rb

@@ -0,0 +1,28 @@
+require 'static_config/reader/base'
+
+module StaticConfig
+  module Reader
+    class Environment < Base
+      def initialize(opts = {})
+        super
+        @env_prefix = opts[:env_prefix]
+      end
+
+      protected
+      def raw_data
+        ENV.inject({}) { |res, (name, value)| update(res, name, value) }
+      end
+
+      def update(data, env_name, env_value)
+        if env_name =~ /^#{@env_prefix}_(.*)/
+          parts = $1.downcase.split(/_/)
+          last_part = parts.pop
+          parts.inject(data) { |h, k| h[k] ||= {} }[last_part] = env_value
+        end
+        data
+      rescue => e
+        raise "Unable to fit #{env_name} into #{data.inspect}"
+      end
+    end
+  end
+end

data/lib/static_config/reader/yaml_env.rb

@@ -0,0 +1,18 @@
+require 'static_config/reader/base'
+require 'yaml'
+
+module StaticConfig
+  module Reader
+    class YamlEnv < Base
+      def initialize(opts = {})
+        super
+        @env = opts[:env]
+      end
+
+      protected
+      def raw_data
+        YAML.load(ENV[@env])
+      end
+    end
+  end
+end

data/lib/static_config/reader/yaml_file.rb

@@ -0,0 +1,21 @@
+require 'static_config/reader/base'
+require 'yaml'
+
+module StaticConfig
+  module Reader
+    class YamlFile < Base
+      def initialize(opts = {})
+        super
+        @file = opts[:file]
+        @section = opts[:section]
+      end
+
+      protected
+      def raw_data
+        data = YAML.load_file(@file) if File.exists? @file
+        data = data[@section] if data && @section
+        data
+      end
+    end
+  end
+end

data/lib/static_config/version.rb

@@ -0,0 +1,3 @@
+module StaticConfig
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+# if necessary.

data/spec/static_config/aggregation/first_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'static_config/aggregation/first'
+
+describe StaticConfig::Aggregation::First do
+  let(:subject) { described_class.new(readers) }
+
+  class Reader
+    def initialize(data)
+      @read = data
+    end
+    attr_accessor :read
+  end
+
+  let(:nil_reader) { Reader.new(nil) }
+  let(:empty_reader) { Reader.new({}) }
+  let(:reader_A) { Reader.new('a' => '1') }
+  let(:reader_B) { Reader.new('b' => '1') }
+
+  context 'with a not-empty reader' do
+    let(:readers) { [reader_A] }
+    its(:read) { should == {'a' => '1'} }
+  end
+
+  context 'with just a nil reader' do
+    let(:readers) { [nil_reader] }
+    its(:read) { should == {} }
+  end
+
+  context 'with an empty and not-empty reader' do
+    let(:readers) { [empty_reader, reader_A] }
+    its(:read) { should == {'a' => '1'} }
+  end
+
+  context 'with two readers' do
+    let(:readers) { [reader_B, reader_A] }
+    its(:read) { should == {'b' => '1'} }
+  end
+end

data/spec/static_config/aggregation/merge_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+require 'static_config/aggregation/merge'
+
+describe StaticConfig::Aggregation::Merge do
+  let(:subject) { described_class.new(readers) }
+
+  class Reader
+    def initialize(data)
+      @read = data
+    end
+    attr_accessor :read
+  end
+
+  let(:reader_A) { Reader.new('a' => '1') }
+  let(:reader_A2) { Reader.new('a' => '2') }
+  let(:reader_B) { Reader.new('b' => '1') }
+  let(:deep_reader_A) { Reader.new('really' => { 'deep' => { 'A' => '1' } }) }
+  let(:deep_reader_B) { Reader.new('really' => { 'deep' => { 'B' => '1' } }) }
+
+  context 'with one reader' do
+    let(:readers) { [reader_A] }
+    its(:read) { should == {'a' => '1'} }
+  end
+
+  context 'with two readers' do
+    let(:readers) { [reader_A, reader_B] }
+    its(:read) { should == {'a' => '1', 'b' => '1'} }
+  end
+
+  context 'with two readers with the same key' do
+    let(:readers) { [reader_A, reader_A2] }
+    its(:read) { should == {'a' => '2'} }
+  end
+
+  context 'with two deeply-nested results' do
+    let(:readers) { [deep_reader_A, deep_reader_B] }
+    its(:read) { should == {'really' => {'deep' => {'A' => '1', 'B' => '1'}}} }
+  end
+end

data/spec/static_config/config_hash_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+require 'static_config/config_hash'
+
+describe StaticConfig::ConfigHash do
+  let(:subject) { StaticConfig::ConfigHash.new({'a' => 'ok', 'nested' => { 'key' => 'also ok' }}) }
+
+  its('a')          { should == 'ok' }
+  its('nested')     { should == { 'key' => 'also ok' } }
+  its('nested.key') { should == 'also ok' }
+  its('missing')    { should be_nil }
+end

data/spec/static_config/config_proxy_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+require 'static_config/config_proxy'
+
+describe StaticConfig::ConfigProxy do
+  let(:subject) { described_class.new(reader) }
+
+  context do
+    class SimpleReader
+      def read
+        {'a' => 'ok', 'nested' => { 'key' => 'also ok' }}
+      end
+    end
+    let(:reader)  { SimpleReader.new }
+
+    its('a')          { should == 'ok' }
+    its('nested')     { should == { 'key' => 'also ok' } }
+    its('nested.key') { should == 'also ok' }
+    its('missing')    { should be_nil }
+  end
+
+  context do
+    class ChangeableReader
+      attr_accessor :read
+    end
+    let(:reader) { ChangeableReader.new }
+    it 're-reads' do
+      reader.read = { 'a' => 'old' }
+      expect{subject.reload! ; reader.read = { 'a' => 'new' }}.to change{subject.a}.from('old').to('new')
+    end
+  end
+end

data/spec/static_config/reader/environment_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+require 'static_config/reader/environment'
+
+describe StaticConfig::Reader::Environment do
+  before do
+    ENV['MY_CONFIG_DEV_KEY'] = 'value'
+  end
+  after do
+    ENV['MY_CONFIG_DEV_KEY'] = nil
+  end
+  let(:subject) { described_class.read(opts) }
+
+  def opts ; { :env_prefix => 'MY_CONFIG' } ; end
+  it('reads environment') { should == { 'dev' => { 'key' => 'value' } } }
+end
+

data/spec/static_config/reader/yaml_env_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+require 'static_config/reader/yaml_env'
+
+describe StaticConfig::Reader::YamlEnv do
+  let(:subject) { described_class.read(opts) }
+  after  { ENV['my_config_yml'] = nil }
+  before { ENV['my_config_yml'] = "dev:\n  key: value\n" }
+
+  def opts ; { :env => 'my_config_yml' } ; end
+  it('loads the yaml') { should == { 'dev' => { 'key' => 'value' } } }
+end

data/spec/static_config/reader/yaml_file_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+require 'static_config/reader/yaml_file'
+
+describe StaticConfig::Reader::YamlFile do
+  let(:subject) { described_class.read(opts) }
+
+  def opts ; { :file => "#{__FILE__}.yml" } ; end
+  it('loads the yaml') { should == { 'dev' => { 'key' => 'value' } } }
+
+  context 'with section' do
+    def opts ; super.merge :section => 'dev' ; end
+    it('uses the section') { should == { 'key' => 'value' } }
+  end
+
+  context 'with a section that does not exist' do
+    def opts ; super.merge :section => 'bad' ; end
+    it('is empty') { should == {} }
+  end
+
+  context 'with an empty file' do
+    def opts ; { :file => "#{__FILE__}.empty" } ; end
+    it('is empty') { should == {} }
+
+    context 'and a section' do
+      def opts ; super.merge :section => 'section' ; end
+      it('is empty') { should == {} }
+    end
+  end
+
+  context 'with a file that does not exist' do
+    def opts ; { :file => "#{__FILE__}.does.not.exist" } ; end
+    it('is empty') { should == {} }
+  end
+end

data/spec/static_config/reader/yaml_file_spec.rb.yml

@@ -0,0 +1,2 @@
+dev:
+  key: value

data/static_config.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "static_config/version"
+
+Gem::Specification.new do |s|
+  s.name        = "static_config"
+  s.version     = StaticConfig::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Matt Burke"]
+  s.email       = ["spraints@gmail.com"]
+  s.homepage    = "http://github.com/spraints/static_config"
+  s.summary     = %q{Load configuration from yaml and/or environment variables}
+  s.description = %q{Load configuration from yaml and/or environment variables}
+
+  s.rubyforge_project = "static_config"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification 
+name: static_config
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Matt Burke
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-09 00:00:00 Z
+dependencies: []
+
+description: Load configuration from yaml and/or environment variables
+email: 
+- spraints@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .autotest
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- lib/static_config.rb
+- lib/static_config/aggregation/first.rb
+- lib/static_config/aggregation/merge.rb
+- lib/static_config/config_hash.rb
+- lib/static_config/config_proxy.rb
+- lib/static_config/configurer.rb
+- lib/static_config/reader/base.rb
+- lib/static_config/reader/environment.rb
+- lib/static_config/reader/yaml_env.rb
+- lib/static_config/reader/yaml_file.rb
+- lib/static_config/version.rb
+- spec/spec_helper.rb
+- spec/static_config/aggregation/first_spec.rb
+- spec/static_config/aggregation/merge_spec.rb
+- spec/static_config/config_hash_spec.rb
+- spec/static_config/config_proxy_spec.rb
+- spec/static_config/reader/environment_spec.rb
+- spec/static_config/reader/yaml_env_spec.rb
+- spec/static_config/reader/yaml_file_spec.rb
+- spec/static_config/reader/yaml_file_spec.rb.empty
+- spec/static_config/reader/yaml_file_spec.rb.yml
+- static_config.gemspec
+homepage: http://github.com/spraints/static_config
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: static_config
+rubygems_version: 1.8.4
+signing_key: 
+specification_version: 3
+summary: Load configuration from yaml and/or environment variables
+test_files: 
+- spec/spec_helper.rb
+- spec/static_config/aggregation/first_spec.rb
+- spec/static_config/aggregation/merge_spec.rb
+- spec/static_config/config_hash_spec.rb
+- spec/static_config/config_proxy_spec.rb
+- spec/static_config/reader/environment_spec.rb
+- spec/static_config/reader/yaml_env_spec.rb
+- spec/static_config/reader/yaml_file_spec.rb
+- spec/static_config/reader/yaml_file_spec.rb.empty
+- spec/static_config/reader/yaml_file_spec.rb.yml