ez_config 0.1.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,19 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", ">= 2.8.0"
+  gem "yard", "~> 0.7"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.8.3"
+  if RUBY_VERSION =~ /^1\.9/
+    gem "simplecov"
+  else
+    gem "rcov"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Aaron Qian
+
+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,93 @@
+ez_config
+=========
+
+This gem can load your yaml configuration files from a specified path.
+
+
+The idea behind this type of configuration is a similar concept to the
+traditional database.yml file found in Rails applications. This file specifies
+all environments for a service in one file, instead of all services for an
+environment in one file.
+
+Install
+--------
+
+Terminal:
+
+```
+gem install ez_config
+```
+
+Bundler:
+
+```ruby
+gem 'ez_config'
+```
+
+Usage
+-----
+
+The following example creates a new `EzConfig` object and loads all configurations
+from your applications `config` directory. Obviously you can use this gem in any
+ruby project, and it is not rails specific.
+
+```ruby
+@config = EzConfig.new({
+  :env          => Rails.env,
+  :path         => "#{Rais.root}/config"
+})
+```
+
+To configure a new service called 'new_service', you will create a YML file in
+your config direcotry. The file has to have an extension of `.yml`. The name of
+the file will become the config key. This file has to contain at least two
+environments, `production` and `non_production`:
+
+```yaml
+non_production:
+  uri: http://dev.path.to.new.service
+  something: else
+
+production:
+  uri: http://path.to.new.service
+  something: else
+```
+
+After this file has been created, access to it can be obtained by doing:
+
+```ruby
+@config['new_service']
+# {'uri' => 'http://path.to.new.service', 'something' => 'else'}
+```
+
+By the fault if your `env` name does not start with `production` and is not specified in
+your yaml file, EzConfig will load the default `non_production` env. If your `env`
+name starts with `production`( e.g. `production-1` ), and is not specified in your yaml
+file, it will load the default `production` env. This simplifies configuration for large
+projects that may have many a dozen different environments.
+
+Lastly, if your cretiria in recognizing `production` and `production` environments differs
+from the default, you can pass in `:production_regex` to specify your own cretieria 
+
+```ruby
+@config = EzConfig.new({
+  :env          => Rails.env,
+  :path         => "#{Rais.root}/config",
+  :production_regex => /-prod$/
+})
+
+== Contributing to ez_config
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Aaron Qian. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "ez_config"
+  gem.homepage = "http://github.com/aq1018/ez_config"
+  gem.license = "MIT"
+  gem.summary = %Q{load yml files from specified path and easily access your config data.}
+  gem.description = %Q{ez_config loads yml files from specified path and allows you to easily access your config data.}
+  gem.email = "aq1018@gmail.com"
+  gem.authors = ["Aaron Qian"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+  spec.rspec_opts = "--color --format progress"
+end
+
+if RUBY_VERSION =~ /^1\.9/
+  desc "Code coverage detail"
+  task :simplecov do
+    ENV['COVERAGE'] = "true"
+    Rake::Task[:spec].execute
+  end
+elsif  RUBY_VERSION =~ /^1\.8/
+  RSpec::Core::RakeTask.new(:rcov) do |spec|
+    spec.pattern = 'spec/**/*_spec.rb'
+    spec.rcov = true
+    spec.rcov_opts = "--exclude ~\/.rvm,spec"
+  end
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/ez_config.gemspec

@@ -0,0 +1,66 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "ez_config"
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Aaron Qian"]
+  s.date = "2012-02-06"
+  s.description = "ez_config loads yml files from specified path and allows you to easily access your config data."
+  s.email = "aq1018@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "ez_config.gemspec",
+    "lib/ez_config.rb",
+    "spec/config/bar.yml",
+    "spec/config/foo.yml",
+    "spec/ez_config_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/aq1018/ez_config"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "load yml files from specified path and easily access your config data."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 2.8.0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.7"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 2.8.0"])
+      s.add_dependency(%q<yard>, ["~> 0.7"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 2.8.0"])
+    s.add_dependency(%q<yard>, ["~> 0.7"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

data/lib/ez_config.rb

@@ -0,0 +1,36 @@
+class EzConfig
+  class NoConfigForEnv < StandardError; end
+
+  PRODUCTION_REGEX  = /^production/
+
+  def initialize(opt)
+    @env              = opt[:env].to_s
+    @path             = opt[:path]
+    @production_regex = opt[:production_regex] || PRODUCTION_REGEX
+  end
+
+  def [](k)
+    config[k]
+  end
+
+  def files
+    Dir.glob File.join(@path, '*.yml')
+  end
+
+  def default_env
+    @env =~ @production_regex ? 'production' : 'non_production'
+  end
+
+  def config
+    @config ||= files.inject({}) do |config, file|
+      key   = File.basename file, '.yml'
+      yaml  = YAML.load_file file
+      val   = yaml[@env] || yaml[default_env]
+
+      raise NoConfigForEnv, "Environment #{@env} not found in #{file}" unless val
+
+      config[key] = val
+      config
+    end
+  end
+end

data/spec/config/bar.yml

@@ -0,0 +1,11 @@
+non_production:
+  foo_path: /path/to/dev
+
+production:
+  foo_path: /path/to/prod
+
+production_west_coast:
+  foo_path: /path/to/prod_west
+
+production_east_coast:
+  foo_path: /path/to/prod_east

data/spec/config/foo.yml

@@ -0,0 +1,11 @@
+non_production:
+  foo_path: /path/to/dev
+
+production:
+  foo_path: /path/to/prod
+
+production_west_coast:
+  foo_path: /path/to/prod_west
+
+production_east_coast:
+  foo_path: /path/to/prod_east

data/spec/ez_config_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe EzConfig do
+  def ez_config(env)
+    EzConfig.new({
+      :env  => env,
+      :path => File.join(File.dirname(__FILE__), 'config')
+    })
+  end
+
+  it "should load all configs" do
+    config = ez_config(:test)
+    config['foo'].should_not be_empty
+    config['bar'].should_not be_empty
+  end
+
+  it "should load default non_production configurations" do
+    config = ez_config(:test)
+    config['foo']['foo_path'].should == '/path/to/dev'
+  end
+
+  it "should load default production configurations" do
+    config = ez_config(:production_japan)
+    config['foo']['foo_path'].should == '/path/to/prod'
+  end
+
+  it "should load specific configurations" do
+    config = ez_config(:production_west_coast)
+    config['foo']['foo_path'].should == '/path/to/prod_west'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,38 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rspec'
+
+GEM_ROOT = File.join(File.dirname(__FILE__), '..')
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+if RUBY_VERSION =~ /^1\.9/
+  require 'simplecov'
+
+  module SimpleCov::Configuration
+    def clean_filters
+      @filters = []
+    end
+  end
+
+  SimpleCov.configure do
+    clean_filters
+    load_adapter 'test_frameworks'
+  end
+
+  ENV["COVERAGE"] && SimpleCov.start do
+    add_filter "/.rvm/"
+  end
+end
+
+require 'ez_config'
+

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: ez_config
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Aaron Qian
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &19350100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *19350100
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &19349520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: *19349520
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &19349020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: *19349020
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &19368200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *19368200
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &19367640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: *19367640
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &19367120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *19367120
+description: ez_config loads yml files from specified path and allows you to easily
+  access your config data.
+email: aq1018@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- ez_config.gemspec
+- lib/ez_config.rb
+- spec/config/bar.yml
+- spec/config/foo.yml
+- spec/ez_config_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/aq1018/ez_config
+licenses:
+- MIT
+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: -3859281619698538461
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: load yml files from specified path and easily access your config data.
+test_files: []