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

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 fl00r
+
+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,144 @@
+# Configa
+
+Configa makes it easier to use multi environment YAML configs.
+
+Inspired by [prepor](https://github.com/prepor)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'configa'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install configa
+
+## Usage
+
+```ruby
+config_file_path = File.expand_path("../config/config.yml", __FILE__)
+config = Configa.new(config_file_path)
+config.mysql.host
+#=> "localhost"
+config.development.mongodb.user
+#=> "pedro"
+config.development.mongodb(:user, :password)
+#=> ["pedro", "password"]
+config.production.root.password
+#=> Error is raised ;)
+```
+
+## Why anyone needs configa?
+
+You can specify in your config file many environments without duplication
+
+```yaml
+mysql:
+  adapter: mysql
+  encoding: utf8
+  host: localhost
+  username: root
+
+development:
+  mysql:
+    database: mysql_dev
+
+test:
+  mysql:
+    database: mysql_test
+
+production:
+  mysql:
+    username: admin
+    password: strongone
+```
+
+So, it will create `mysql` "node" which will be shared between all of environments:
+
+```ruby
+config.development.mysql.username
+#=> "root"
+config.production.mysql.username
+#=> "admin"
+config.production.mysql(:username, :host)
+#=> ["admin", "localhost"]
+```
+
+Also you can share base templates between multiple nodes of one environment
+
+```yaml
+mysql:
+  adapter: mysql
+  encoding: utf8
+  host: localhost
+  username: root
+
+development:
+  databases:
+    users:
+      mysql:
+        database: users_dev
+    blogs:
+      mysql:
+        database: blogs_dev
+```
+
+```ruby
+config.development.databases.users.mysql.database
+#=> "users_dev"
+```
+
+## Sometimes configuration files grows
+
+You can create `development.yml`, `staging.yml` or any other file, put it into the same folder as a base config file and Configa will automatically fetch and load it. Also you can use cascade templates. For example in following example you can define `tarantool` namespace, wich will be inherited by `tarantool` namespace in "development" env.
+
+```yaml
+# config.yml
+mysql:
+  adapter: mysql
+  encoding: utf8
+  host: localhost
+  username: root
+tarantool:
+  host: localhost
+  port: 13013
+  type: :block
+
+# development.yml
+mysql:
+  database: my_database
+tarantool:
+  type: :em
+videos:
+  tarantool:
+    space: 1
+users:
+  tarantool:
+    space: 2
+```
+
+```ruby
+config = Configa.new("config.yml")
+config.development.mysql.database
+#=> "my_database"
+config.development.mysql.username
+#=> "root"
+config.videos.tarantool.space
+#=> 1
+config.videos.tarantool.type
+#=> :em
+
+```
+
+## 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,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+task :default => :spec
+
+desc 'Tests'
+Rake::TestTask.new(:spec) do |t|
+  t.libs << 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = false
+end

data/configa.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/configa/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["fl00r"]
+  gem.email         = ["fl00r@yandex.ru"]
+  gem.description   = %q{YAML configuration file parser}
+  gem.summary       = %q{Configa makes it easier to use multi environment YAML configs}
+  gem.homepage      = ""
+
+  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          = "configa"
+  gem.require_paths = ["lib"]
+  gem.version       = Configa::VERSION
+end

data/lib/configa/version.rb

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

data/lib/configa.rb

@@ -0,0 +1,101 @@
+require "configa/version"
+require "yaml"
+
+module Configa
+  extend self
+
+  def new(path)
+    MagicContainer.new(path)
+  end
+
+  class MagicContainer
+    def initialize(path)
+      @base_extname = File.extname(path)
+      @base_env = File.basename(path, @base_extname)
+      @base_dir = File.dirname(path)
+      @yamls = {}
+      @yaml = {}
+      parser
+    end
+
+    def parser(env=nil)
+      env ||= @base_env
+      env = env.to_s
+      load_yaml(env)
+      @yaml = merge_yamls
+      @yaml = magic(@yaml)
+    end
+
+    def load_yaml(env)
+      @yamls[env] ||= begin
+        path = File.join(@base_dir, env.to_s + @base_extname)
+        file = File.read(path)
+        yaml = YAML.load(file)
+        yaml
+      end
+    end
+
+    def merge_yamls
+      ymls = @yamls.dup
+      base = ymls.delete(@base_env)
+      yaml = base
+      ymls.each do |env, data|
+        yaml[env] = base.merge(data)
+      end
+      yaml = merge_yaml(yaml)
+      ymls.each do |env, data|
+        yaml[env] = merge_yaml(yaml[env])
+      end
+      yaml
+    end
+
+    def merge_yaml(yaml)
+      root_keys = yaml.keys
+      yaml.each do |k,v|
+        next  unless Hash === v
+        v.each do |key, data|
+          if root_keys.include? key
+            yaml[k][key] = yaml[key].merge data
+          end
+        end
+      end
+      yaml
+    end
+
+    def magic(data)
+      data.each do |k,v|
+        data.define_singleton_method(k) do |*args|
+          if args.any?
+            args.map do |arg|
+              data[k][arg.to_s]
+            end
+          else
+            data[k]
+          end
+        end
+        data.define_singleton_method(:method_missing) do |name, *args, &blk|
+          raise Configa::UnknownKey, "Unknown key '#{name}' for current node. Available keys are: '#{data.keys * '\', \''}'. Current node: #{data.inspect}"
+        end
+        if Hash === v
+          data[k] = magic(v)
+        end
+      end
+      data
+    end
+
+    def method_missing(name, *args, &blk)
+      path = File.join(@base_dir, name.to_s + @base_extname)
+      unless @yaml[name.to_s] || @yamls[name.to_s]
+        if File.exist?(path)
+          parser(name)
+        end
+      end
+      @yaml.send(name, *args, &blk)
+    rescue
+      raise Configa::UnknownEnvironment, "Unknown environment '#{name}', and file '#{path}' doesn't exist also"
+    end
+  end
+
+  class UnknownEnvironment < StandardError; end
+  class UnknownKey < StandardError; end
+end

data/spec/base.yml

@@ -0,0 +1,9 @@
+mysql:
+  adapter: mysql
+  encoding: utf8
+  host: localhost
+  username: root
+
+tarantool:
+  host: localhost
+  port: 13013

data/spec/config.yml

@@ -0,0 +1,19 @@
+mysql:
+  adapter: mysql
+  encoding: utf8
+  host: localhost
+  username: root
+
+development:
+  mysql:
+    database: mysql_dev
+
+test:
+  mysql:
+    database: mysql_test
+
+production:
+  mysql:
+    database: mysql_prod
+    username: admin
+    password: strongone

data/spec/configa/configa_spec.rb

@@ -0,0 +1,72 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Configa do
+
+  describe Configa::MagicContainer do
+    it "basic test for one file config" do
+      path = File.expand_path("../../config.yml", __FILE__)
+      configa = Configa::MagicContainer.new(path)
+      mysql = configa.instance_variable_get(:"@yaml")["mysql"]
+      dev = configa.instance_variable_get(:"@yaml")["development"]
+      dev["mysql"]["adapter"].must_equal mysql["adapter"]
+      dev["mysql"]["database"].must_equal "mysql_dev"
+    end
+
+    it "basic test for multi file config" do
+      path = File.expand_path("../../base.yml", __FILE__)
+      configa = Configa::MagicContainer.new(path)
+      mysql = configa.mysql
+      dev = configa.development
+      dev["mysql"]["adapter"].must_equal mysql.adapter
+      dev.mysql.database.must_equal "mysql_dev"
+    end
+
+    it "should raise an error" do
+      path = File.expand_path("../../base.yml", __FILE__)
+      configa = Configa::MagicContainer.new(path)
+      proc{configa.staging}.must_raise Configa::UnknownEnvironment
+    end
+
+    it "should raise an error" do
+      path = File.expand_path("../../base.yml", __FILE__)
+      configa = Configa::MagicContainer.new(path)
+      proc{configa.development.sqlite3}.must_raise Configa::UnknownKey
+    end
+  end
+
+  describe "one file" do
+    before do
+      path = File.expand_path("../../config.yml", __FILE__)
+      @config = Configa.new(path)
+    end
+
+    it "should parse simple yml" do
+      @config.development.mysql.database.must_equal "mysql_dev"
+      @config.development(:mysql).must_equal([{"adapter"=>"mysql", "encoding"=>"utf8", "host"=>"localhost", "username"=>"root", "database"=>"mysql_dev"}])
+      @config.development.mysql.username.must_equal "root"
+      @config.production.mysql.username.must_equal "admin"
+      @config.production.mysql(:username, :database).must_equal ["admin", "mysql_prod"]
+      @config.development.mysql.must_equal({"database"=>"mysql_dev", "adapter"=>"mysql", "encoding"=>"utf8", "host"=>"localhost", "username"=>"root"})
+    end
+  end
+
+  describe "multiple file" do
+    before do
+      path = File.expand_path("../../base.yml", __FILE__)
+      @config = Configa.new(path)
+    end
+
+    it "should parse simple yml" do
+      @config.development.mysql.database.must_equal "mysql_dev"
+      @config.development(:mysql).must_equal([{"adapter"=>"mysql", "encoding"=>"utf8", "host"=>"localhost", "username"=>"root", "database"=>"mysql_dev"}])
+      @config.development.mysql.username.must_equal "root"
+      @config.production.mysql.username.must_equal "admin"
+      @config.production.mysql(:username, :database).must_equal ["admin", "mysql_prod"]
+      @config.development.mysql.must_equal({"database"=>"mysql_dev", "adapter"=>"mysql", "encoding"=>"utf8", "host"=>"localhost", "username"=>"root"})
+      @config.development.users.tarantool.space.must_equal 1
+      @config.development.users.tarantool.port.must_equal 13013
+      @config.development.users.tarantool.host.must_equal "212.11.3.1"
+    end
+  end
+end

data/spec/development.yml

@@ -0,0 +1,14 @@
+mysql:
+  database: mysql_dev
+
+tarantool:
+  host: "212.11.3.1"
+  type: :em
+
+users:
+  tarantool:
+    space: 1
+
+posts:
+  tarantool:
+    space: 2

data/spec/production.yml

@@ -0,0 +1,4 @@
+mysql:
+  database: mysql_prod
+  username: admin
+  password: strongone

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'configa'
+require 'minitest/spec'
+require 'minitest/autorun'

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: configa
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- fl00r
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-05 00:00:00.000000000 Z
+dependencies: []
+description: YAML configuration file parser
+email:
+- fl00r@yandex.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- configa.gemspec
+- lib/configa.rb
+- lib/configa/version.rb
+- spec/base.yml
+- spec/config.yml
+- spec/configa/configa_spec.rb
+- spec/development.yml
+- spec/production.yml
+- spec/spec_helper.rb
+homepage: ''
+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.23
+signing_key: 
+specification_version: 3
+summary: Configa makes it easier to use multi environment YAML configs
+test_files:
+- spec/base.yml
+- spec/config.yml
+- spec/configa/configa_spec.rb
+- spec/development.yml
+- spec/production.yml
+- spec/spec_helper.rb