miniconfig 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e56e0a7e8df417859d0aea5cc5ed2b737ab74f07
+  data.tar.gz: 183f1db6ad0d62bcb223234ae7f870f8929a67b2
+SHA512:
+  metadata.gz: 1bf48c34ee02a772a29bac5981039f2ed3467e978c93d268571d776e01e2aa48c18a76468664eee4fe66a3505ca77da7beb7783cd342cc3cd6acfc3ef8b15d07
+  data.tar.gz: eb735fb8f7cb91ac280272346d47fa48df71d4ad08ab010d54a22fa3d439b9dfe36368cab35cf2f4de22f705d2a374a9f4393ed7373150b9f057970c0deed3cf

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/.travis.yml

@@ -0,0 +1,9 @@
+---
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - rbx-19mode
+  - jruby-19mode
+  - jruby-20mode
+  - jruby-head
+  - ruby-head

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Patricio Mac Adden
+
+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,173 @@
+# Miniconfig
+
+[![Build Status](https://travis-ci.org/patriciomacadden/miniconfig.png)](https://travis-ci.org/patriciomacadden/miniconfig)
+[![Code Climate](https://codeclimate.com/github/patriciomacadden/miniconfig.png)](https://codeclimate.com/github/patriciomacadden/miniconfig)
+
+Minimalistic configuration files for your projects.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'miniconfig'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install miniconfig
+```
+
+## Usage
+
+Create your application configuration files in yaml format. For instance:
+
+```yaml
+# config/app.yml
+app:
+  name: Amazing app with great configuration files handling
+  version: 0.1.0
+some:
+  cool:
+    setting: Some Cool Setting
+  cooler:
+    setting: Some Other Even Cooler Setting
+```
+
+Then, load this configuration into an object:
+
+```ruby
+config = Miniconfig.load 'config/app.yml'
+```
+
+And access your application configuration:
+
+```ruby
+config.app.name # => "Amazing app with great configuration files handling"
+config.app.version # => "0.1.0"
+config.some.cool.setting # => "Some Cool Setting"
+config.some.other.setting # => "Some Other Even Cooler Setting"
+```
+
+### Loading more than one file
+
+You can load more than one file. Suppose that we have the file `config/app.yml`
+as defined above (it contains general settings for your application) and
+`config/development.yml` (which contains settings for your application in
+development mode).
+
+You can load those files using:
+
+```ruby
+config = Miniconfig.load 'config/app.yml', 'config/development.yml'
+```
+
+And then access your application configuration as usual:
+
+```ruby
+config.app.name # => "Amazing app with great configuration files handling"
+config.app.version # => "0.1.0"
+config.some.cool.setting # => "Some Cool Setting"
+config.some.other.setting # => "Some Other Even Cooler Setting"
+```
+
+#### Precedence
+
+When loading multiple yaml files, the values defined in the second have higher
+precedence. See the example:
+
+```yaml
+# config/app.yml
+app:
+  name: Application Name
+  version: 0.1.0
+```
+
+```yaml
+# config/development.yml
+app:
+  name: Application Name [DEVELOPMENT]
+some:
+  setting: Some Setting
+```
+
+```ruby
+config.app.name # => "Application Name [DEVELOPMENT]"
+config.app.version # => "0.1.0"
+config.some.setting # => "Some Setting"
+```
+
+## Integration with Sinatra
+
+The integration with sinatra is pretty simple, you must create a
+helper method that creates the config object:
+
+```ruby
+require 'sinatra'
+
+helpers do
+  def config
+    @config ||= Miniconfig.load 'config/app.yml'
+  end
+end
+
+get '/' do
+  config.app.name
+end
+```
+
+## Integration with Rails
+
+The integration with rails is also pretty straightforward, as in
+the previous example, just create a helper:
+
+```ruby
+# config/application.rb
+
+module SomeApplication
+  class Application < Rails::Application
+    # configuration options here
+
+    def miniconfig
+      @miniconfig ||= Miniconfig.load 'config/app.yml'
+    end
+  end
+end
+```
+
+And then access the application instance:
+
+```ruby
+class SomeController < ApplicationController
+  def index
+    config = SomeApplication::Application.instance.miniconfig
+
+    render text: config.app.name
+  end
+end
+```
+
+Obviously, this can be done in many different ways and integrated
+with any Ruby application. But, for instance, if you need to access
+the configuration options only in your rails app controllers, define this
+method on the `ApplicationController`. Choose the one that suits best, and
+may the force be with you.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## TODO
+
+* Do not depend on `activesupport` (a.k.a. implement `deep_merge`)

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+task default: :test

data/lib/miniconfig.rb

@@ -0,0 +1,35 @@
+require 'active_support/core_ext'
+require 'yaml'
+
+require 'miniconfig/version'
+
+module Miniconfig
+  def self.load(*filenames)
+    data = {}
+    filenames.each do |filename|
+      data.deep_merge! YAML.load(File.read(filename))
+    end
+    Config.new(data)
+  end
+
+  class Config
+    def initialize(data = {})
+      build self, data
+    end
+
+    private
+
+    def build(object, hash)
+      if hash.is_a? Hash
+        hash.each do |k, v|
+          value = v.is_a?(Hash) ? Config.new(v) : v
+
+          self.class.send(:attr_reader, k.to_sym)
+          instance_variable_set :"@#{k}", value
+        end
+      else
+        hash
+      end
+    end
+  end
+end

data/lib/miniconfig/version.rb

@@ -0,0 +1,3 @@
+module Miniconfig
+  VERSION = '0.0.1'
+end

data/miniconfig.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'miniconfig/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'miniconfig'
+  spec.version       = Miniconfig::VERSION
+  spec.authors       = ['Patricio Mac Adden']
+  spec.email         = ['patriciomacadden@gmail.com']
+  spec.description   = %q{Minimalistic configuration files for your projects.}
+  spec.summary       = %q{Minimalistic configuration files for your projects.}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'rake'
+end

data/spec/config_spec.rb

@@ -0,0 +1,53 @@
+require 'minitest_helper'
+
+describe Miniconfig::Config do
+  it 'loads a single yaml file with 1 level' do
+    config = Miniconfig.load fixture_path('config_1.yml')
+
+    config.one.must_equal 1
+    config.two.must_equal 2
+  end
+
+  it 'loads a single yaml file with 2 levels' do
+    config = Miniconfig.load fixture_path('config_2.yml')
+
+    config.one.one_one.must_equal 1.1
+    config.one.one_two.must_equal 1.2
+    config.two.two_one.must_equal 2.1
+    config.two.two_two.must_equal 2.2
+  end
+
+  it 'loads a single yaml file with 3 levels' do
+    config = Miniconfig.load fixture_path('config_3.yml')
+
+    config.one.one_one.must_equal 1.1
+    config.one.one_two.must_equal 1.2
+    config.one.two.two_one.must_equal 2.1
+    config.one.two.two_two.must_equal 2.2
+  end
+
+  it 'loads multiple yaml files with 1 level' do
+    config = Miniconfig.load fixture_path('config_1.yml'), fixture_path('config_1_1.yml')
+
+    config.one.must_equal 'One'
+    config.two.must_equal 2
+  end
+
+  it 'loads multiple yaml files with 2 levels' do
+    config = Miniconfig.load fixture_path('config_2.yml'), fixture_path('config_2_1.yml')
+
+    config.one.one_one.must_equal 'One.One'
+    config.one.one_two.must_equal 1.2
+    config.two.two_one.must_equal 'Two.One'
+    config.two.two_two.must_equal 2.2
+  end
+
+  it 'loads multiple yaml files with 3 levels' do
+    config = Miniconfig.load fixture_path('config_3.yml'), fixture_path('config_3_1.yml')
+
+    config.one.one_one.must_equal 'One.One'
+    config.one.one_two.must_equal 1.2
+    config.one.two.two_one.must_equal 2.1
+    config.one.two.two_two.must_equal 'Two.Two'
+  end
+end

data/spec/fixtures/config_1.yml

@@ -0,0 +1,2 @@
+one: 1
+two: 2

data/spec/fixtures/config_1_1.yml

@@ -0,0 +1 @@
+one: One

data/spec/fixtures/config_2.yml

@@ -0,0 +1,6 @@
+one:
+  one_one: 1.1
+  one_two: 1.2
+two:
+  two_one: 2.1
+  two_two: 2.2

data/spec/fixtures/config_2_1.yml

@@ -0,0 +1,4 @@
+one:
+  one_one: One.One
+two:
+  two_one: Two.One

data/spec/fixtures/config_3.yml

@@ -0,0 +1,6 @@
+one:
+  one_one: 1.1
+  one_two: 1.2
+  two:
+    two_one: 2.1
+    two_two: 2.2

data/spec/fixtures/config_3_1.yml

@@ -0,0 +1,4 @@
+one:
+  one_one: One.One
+  two:
+    two_two: Two.Two

data/spec/minitest_helper.rb

@@ -0,0 +1,8 @@
+require 'bundler'
+Bundler.require :default, :test
+
+require 'minitest/autorun'
+
+def fixture_path(filename)
+  File.expand_path("../fixtures/#{filename}", __FILE__)
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: miniconfig
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Patricio Mac Adden
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Minimalistic configuration files for your projects.
+email:
+- patriciomacadden@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/miniconfig.rb
+- lib/miniconfig/version.rb
+- miniconfig.gemspec
+- spec/config_spec.rb
+- spec/fixtures/config_1.yml
+- spec/fixtures/config_1_1.yml
+- spec/fixtures/config_2.yml
+- spec/fixtures/config_2_1.yml
+- spec/fixtures/config_3.yml
+- spec/fixtures/config_3_1.yml
+- spec/minitest_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: Minimalistic configuration files for your projects.
+test_files:
+- spec/config_spec.rb
+- spec/fixtures/config_1.yml
+- spec/fixtures/config_1_1.yml
+- spec/fixtures/config_2.yml
+- spec/fixtures/config_2_1.yml
+- spec/fixtures/config_3.yml
+- spec/fixtures/config_3_1.yml
+- spec/minitest_helper.rb