config_yml 0.0.1

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem "rspec"

data/Gemfile.lock

@@ -0,0 +1,18 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec

data/README.md

@@ -0,0 +1,104 @@
+config.yml
+==========
+
+Simplify your app configuration.
+
+Description
+-----------
+
+config.yml provides a very simple way of configure your ruby applications through yaml files.
+
+Examples
+--------
+
+```yaml
+# config/redis.yml
+password: foo
+host: localhost
+port: 6379
+database: bar
+```
+
+```ruby
+if redis = Configuration.redis
+  password = redis[:password] && ":#{redis[:password]}@"
+  ENV["REDIS_URL"] = %(redis://#{password}#{redis[:host]}:#{redis[:port]}/#{redis[:database]})
+end
+
+ENV["REDIS_URL"] # => "redis://:foo@localhost:6379/bar"
+```
+
+
+#### Environment based:
+
+```yaml
+# config/mysql.yml
+development:
+  adapter: mysql2
+  encoding: utf8
+  database: myapp_development
+  username: foo
+  password:
+  socket: /tmp/mysql.sock
+
+test:
+  adapter: mysql2
+  encoding: utf8
+  database: myapp_test
+  username: foo
+  password:
+  socket: /tmp/mysql.sock
+```
+
+Rack
+```ruby
+ENV["RACK_ENV"] # => "development"
+Configuration.mysql[:database] # => "myapp_development"
+```
+
+Rails
+```ruby
+Rails.env # => "test"
+Configuration.mysql[:database] # => "myapp_test"
+```
+
+
+#### Nested:
+
+```yaml
+# config/russian_doll.yml
+foo:
+  bar:
+    baz:
+      array:
+        - :red
+        - :green
+        - :blue
+```
+
+```ruby
+Configuration.russian_doll[:foo][:bar][:baz] # => { :array => [:red, :green, :blue] }
+```
+
+License
+-------
+
+Copyright 2013 Vitor Kiyoshi Arimitsu - http://vitork.com
+
+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/config_yml.gemspec

@@ -0,0 +1,17 @@
+$:.unshift(File.expand_path("../lib", __FILE__))
+require "configuration/version"
+
+Gem::Specification.new do |spec|
+  spec.name        = "config_yml"
+  spec.version     = Configuration::VERSION.dup
+  spec.summary     = "Simplify your app configuration."
+  spec.description = "A very simple way of configure your ruby applications through yaml files."
+  spec.license     = "MIT"
+
+  spec.authors     = ["Vitor Kiyoshi Arimitsu"]
+  spec.email       = "to@vitork.com"
+  spec.homepage    = "https://github.com/vitork/config_yml"
+
+  spec.files       = `git ls-files`.split("\n")
+  spec.test_files  = `git ls-files -- spec/*`.split("\n")
+end

data/lib/configuration/version.rb

@@ -0,0 +1,3 @@
+module Configuration
+  VERSION = "0.0.1".freeze
+end

data/lib/configuration.rb

@@ -0,0 +1,53 @@
+require "yaml"
+
+module Configuration
+  # Returns a hash with configuration for the given class method
+  # called. The configuration is loaded from the file config/+method_called+.yml.
+  # If the hash contains a key in the first level with the same name of environment,
+  # the value of this key is returned. Returns nil if file is not found.
+  #
+  # For example:
+  #   ## config/database.yml
+  #   # development:
+  #   #   host: "localhost"
+  #   #   username: "root"
+  #
+  #   ENV["RACK_ENV"] # => "development"
+  #   Configuration.database # => { :host => "localhost", :username => "root" }
+  #
+  class << self
+    def method_missing(method, *args)
+      if file = files.select { |f| f =~ /#{method.to_s}/ }[0]
+        hash[method] ||= load_yml(file)
+      end
+    end
+
+    def files
+      @files ||= Dir.glob("config/*.yml")
+    end
+
+    def hash
+      @hash ||= {}
+    end
+
+    def env
+      @env ||= (ENV["RACK_ENV"] || Rails.env).to_sym rescue nil
+    end
+
+    private
+
+    def load_yml(file)
+      config = with_symbol_keys YAML.load_file(file)
+      config.is_a?(Hash) && config.has_key?(env) ?
+        config[env] : config
+    end
+
+    def with_symbol_keys(hash_config)
+      return hash_config unless hash_config.is_a?(Hash)
+
+      hash_config.inject({}) do |symbolized, (key, value)|
+        symbolized.merge({ key.to_sym => with_symbol_keys(value) })
+      end
+    end
+  end
+end

data/spec/lib/configuration_spec.rb

@@ -0,0 +1,107 @@
+require "spec_helper"
+
+describe Configuration do
+  let(:files) { ["config/file_a.yml", "config/file_b.yml"] }
+
+  before do
+    Configuration.instance_variable_set(:@hash, nil)
+    Dir.stub(:glob).and_return(files)
+    YAML.stub(:load_file).and_return(file_a, file_b)
+  end
+
+  describe "loading config files" do
+    let(:file_a) { double }
+    let(:file_b) { double }
+
+    it "loads all config files" do
+      Configuration.file_a
+      Configuration.files.should be_eql files
+    end
+  end
+
+  describe ".env" do
+    let(:file_a) { double }
+    let(:file_b) { double }
+    let(:rack_env) { "rack_test" }
+    let(:rails_env) { "rails_test" }
+
+    before { Configuration.instance_variable_set(:@env, nil) }
+
+    context "when Rack application" do
+      before { ENV["RACK_ENV"] = rack_env }
+      after { ENV["RACK_ENV"] = nil }
+
+      it "returns the environment as symbol" do
+        Configuration.env.should be_eql rack_env.to_sym
+      end
+    end
+
+    context "when is a Rails application" do
+      before do
+        module Rails ; end
+        Rails.stub(:env).and_return(rails_env)
+      end
+
+      after { Object.send(:remove_const, :Rails) }
+
+      it "returns the environment as symbol" do
+        Configuration.env.should be_eql rails_env.to_sym
+      end
+    end
+
+    context "when environment isn't defined" do
+      it "returns nil" do
+        Configuration.env.should be_nil
+      end
+    end
+  end
+
+  describe "acessing a key from configuration files" do
+    context "when a file has a flat hash" do
+      let(:file_a) { { key_a: "value_a" } }
+      let(:file_b) { { key_b: "value_b" } }
+
+      it "responds to keys split in different files" do
+        Configuration.file_a[:key_a].should be_eql "value_a"
+        Configuration.file_b[:key_b].should be_eql "value_b"
+      end
+    end
+
+    context "when a file has a nested hash" do
+      let(:file_a) { { nested: { key: "value" } } }
+      let(:file_b) { double }
+
+      it "responds to nested key values" do
+        Configuration.file_a[:nested][:key].should be_eql "value"
+      end
+    end
+
+    context "when a file first level keys is environment names" do
+      let(:file_b) { double }
+      let(:file_a) do
+        { test: { key: "value_test" },
+          development: { key: "value_dev" } }
+      end
+
+      before { ENV["RACK_ENV"] = "test" }
+      after { ENV["RACK_ENV"] = nil }
+
+      it "returns hash of environment key" do
+        Configuration.file_a[:key].should be_eql "value_test"
+      end
+
+      it "doesn't load hash of other environments" do
+        Configuration.file_a[:key].should_not be_eql "value_dev"
+      end
+    end
+
+    context "when configuration file doesn't exist" do
+      let(:file_a) { double }
+      let(:file_b) { double }
+
+      it "returns nil" do
+        Configuration.foo.should be_nil
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require "configuration"
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter = "documentation"
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: config_yml
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Vitor Kiyoshi Arimitsu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-27 00:00:00.000000000 Z
+dependencies: []
+description: A very simple way of configure your ruby applications through yaml files.
+email: to@vitork.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- config_yml.gemspec
+- lib/configuration.rb
+- lib/configuration/version.rb
+- spec/lib/configuration_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/vitork/config_yml
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Simplify your app configuration.
+test_files:
+- spec/lib/configuration_spec.rb
+- spec/spec_helper.rb