configs 0.1.0

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/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Kickstarter
+
+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,47 @@
+# Configs
+
+Loads and manages config/*.yml files.
+
+Searches through a few locations to find the right environment config:
+
+1. config/$name/$env.yml
+2. config/$name.yml (with $env key)
+3. config/$name/default.yml
+3. config/$name.yml (with 'default' key)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'configs'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install configs
+
+## Usage
+
+If you have a `config/foo.yml`, then anywhere you need to read the file
+you can use `Configs[:foo]` as a hash.
+
+Example:
+
+    # config/foo.yml
+    development:
+      hello: world
+
+    # Elsewhere (even in a config/initializer)
+    Configs[:foo][:hello]
+    => 'world'
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/configs.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/configs/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Lance Ivy"]
+  gem.email         = ["lance@cainlevy.net"]
+  gem.description   = "Easy (easier?) management of config/*.yml files. Defines a lookup priority for the current environment's settings."
+  gem.summary       = "Easy (easier?) management of config/*.yml files."
+  gem.homepage      = "http://github.com/kickstarter/configs"
+
+  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.name          = "configs"
+  gem.require_paths = ["lib"]
+  gem.version       = Configs::VERSION
+
+  gem.add_dependency 'activesupport', '>3.0'
+  gem.add_development_dependency "test-unit"
+end

data/lib/configs.rb

@@ -0,0 +1,57 @@
+require "configs/version"
+require "configs/railtie" if defined? Rails
+
+module Configs
+  class NotFound < StandardError; end
+
+  class << self
+
+    # Where the wild .yml live.
+    # In a Rails app, this is Rails.root.join('config')
+    attr_accessor :config_dir
+
+    # The name of our environment.
+    # In a Rails app, this is Rails.env
+    attr_accessor :environment
+
+    # will find (and memoize) the yml config file with this name
+    #
+    # cascades through a loading order to find the most specific yml file available (see Configs.load)
+    #
+    # if none can be found, it will raise an error
+    def [](name)
+      @_configs ||= {}
+      @_configs[name.to_sym] ||= load(name).symbolize_keys
+    end
+
+    def inspect
+      @_configs.inspect
+    end
+
+    protected
+
+    # checks loading order for named yml file
+    #
+    # 1) `config/$NAME/$ENV.yml'
+    # 2) `config/$NAME.yml' with $ENV key
+    # 3) `config/$NAME.yml' with 'default' key
+    def load(name)
+      yml_file("#{name}/#{environment}") ||
+        yml_file_with_key("#{name}", environment) ||
+        yml_file("#{name}/default") ||
+        yml_file_with_key("#{name}", 'default') ||
+        raise(NotFound)
+    end
+
+    def yml_file(name)
+      path = config_dir.join(name + '.yml')
+      YAML.load_file path if File.exists? path
+    end
+
+    def yml_file_with_key(path, key)
+      hash = yml_file(path)
+      hash && hash[key]
+    end
+
+  end
+end

data/lib/configs/railtie.rb

@@ -0,0 +1,8 @@
+module Configs
+  class Railtie < Rails::Railtie
+    initializer 'configs.rails_settings' do
+      Configs.config_dir = Rails.root.join('config')
+      Configs.environment = Rails.env
+    end
+  end
+end

data/lib/configs/version.rb

@@ -0,0 +1,3 @@
+module Configs
+  VERSION = "0.1.0"
+end

data/test/configs_test.rb

@@ -0,0 +1,51 @@
+require File.expand_path(File.dirname(__FILE__) + '/test_helper')
+
+class ConfigsTest < Configs::TestCase
+
+  should "find config/foo/test.yml" do
+    with_config('foo/test.yml', :hello => 'world') do
+      assert_equal 'world', Configs[:foo][:hello]
+    end
+  end
+
+  should "find config/foo.yml with test key" do
+    with_config('foo.yml', :test => {:hello => 'world'}) do
+      assert_equal 'world', Configs[:foo][:hello]
+    end
+  end
+
+  should "find config/foo/default.yml" do
+    with_config('foo/default.yml', :hello => 'world') do
+      assert_equal 'world', Configs[:foo][:hello]
+    end
+  end
+
+  should "find config/foo.yml with 'default' key" do
+    with_config('foo.yml', :default => {:hello => 'world'}) do
+      assert_equal 'world', Configs[:foo][:hello]
+    end
+  end
+
+  should "not find missing config" do
+    assert_raises(Configs::NotFound) { Configs[:unknown] }
+  end
+
+  should "symbolize keys" do
+    with_config('foo.yml', :test => {'hello' => 'world'}) do
+      assert_equal 'world', Configs[:foo][:hello]
+    end
+  end
+
+  protected
+
+  def with_config(path, contents, &block)
+    path = Configs.config_dir.join(path).to_s
+    begin
+      FileUtils.mkdir_p(File.dirname(path))
+      File.open(path, 'w') { |f| f << contents.to_yaml }
+      yield
+    ensure
+      File.delete(path)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'bundler'
+Bundler.require(:default, :test)
+
+require 'test/unit'
+require 'active_support/core_ext/hash/keys'
+
+class Configs::TestCase < Test::Unit::TestCase
+  def default_test; end # quiet Test::Unit
+
+  def self.should(name, &block) # very simple syntax
+    define_method("test_should_#{name.gsub(/[ -\/]/, '_').gsub(/[^a-z0-9_]/i, '')}", &block)
+  end
+end
+
+Configs.config_dir = Pathname.new(File.dirname(__FILE__) + '/config')
+Configs.environment = 'test'

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: configs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Lance Ivy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70229314323460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70229314323460
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: &70229314803880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70229314803880
+description: Easy (easier?) management of config/*.yml files. Defines a lookup priority
+  for the current environment's settings.
+email:
+- lance@cainlevy.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- configs.gemspec
+- lib/configs.rb
+- lib/configs/railtie.rb
+- lib/configs/version.rb
+- test/configs_test.rb
+- test/test_helper.rb
+homepage: http://github.com/kickstarter/configs
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Easy (easier?) management of config/*.yml files.
+test_files:
+- test/configs_test.rb
+- test/test_helper.rb