basic_config 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 basic_config.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Stepan Tubanov
+
+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,99 @@
+# BasicConfig
+
+Friendly configuration wrapper. If you find yourself using things like:
+
+```ruby
+AppConfig = YAML.load_file('config/app.yml')[environment].symbolize_keys
+```
+
+then you might like this.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'basic_config'
+
+And then execute:
+
+    $ bundle
+
+Or install it via RubyGems as:
+
+    $ gem install basic_config
+
+## Usage
+
+```ruby
+settings = BasicConfig.load_file('config.yml')
+
+# Access your configuration with simple method calls
+settings.some_param
+
+# At any level of nesting
+settings.smtp.address
+
+# Hash access also works
+settings[:smtp][:address]
+
+# And you can check if particular key exists
+puts('Yes') if settings.include?(:smtp)
+```
+
+If your file has sections for different environments:
+```
+development:
+  host: localhost
+  port: 123
+test
+  host: localhost
+  port: 456
+```
+then you can load the right environment with `load_env`:
+```ruby
+AppConfig = BasicConfig.load_env('config.yml', Rails.env)
+```
+
+## Why should I use it instead of plain Hash variables?
+
+### It raises errors when you unintentionally read non-existent keys:
+
+If you are using a `Hash`:
+```ruby
+secret_token = AppConfig[:something]
+```
+and for some reason your configuration does not have `:something` in it - you'll
+get a `nil`. Worst case: this `nil` will live inside your system compromising
+or corrupting some data until you finally notice and track it down back to this line.
+
+If you are using a `BasicConfig`:
+```ruby
+secret_token = AppConfig.something
+```
+you'll get `NoMethodError` in that particular line with the name of the key that
+is missing.
+
+*Note:* There is also an `include?` method which you can use to check if
+particular key exist in your config - `AppConfig.include?(:something)`.
+Additionaly, for some keys it makes sense to get a `nil` when they do not exist and for this
+purpose there is a `[]` method which is delegated to underlying hash.
+
+### Works recursively.
+
+If your YAML is more than 1 level deep then simple `symbolize_keys` is not going to be enough:
+```ruby
+AppConfig[:something]['have_to_use_string_here']
+```
+
+With BasicConfig above would look like this:
+```ruby
+AppConfig.something.have_to_use_string_here
+```
+
+### Easier to test.
+
+You can stub out any config variable just like a normal method in your tests.
+
+```ruby
+AppConfig.stub(:something).and_return('anything')
+```

data/Rakefile

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

data/basic_config.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/basic_config', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Stepan Tubanov']
+  gem.email         = ['stepan773@gmail.com']
+  gem.description   = 'Makes it easier to use configuration by wrapping it in a struct-like object'
+  gem.summary       = 'Friendly configuration wrapper'
+  gem.homepage      = 'https://github.com/stephan778/basic_config'
+
+  gem.files         = `git ls-files`.split($\)
+  gem.test_files    = gem.files.grep(%r{^(spec)/})
+  gem.name          = 'basic_config'
+  gem.require_path  = 'lib'
+  gem.version       = '0.0.1'
+
+  gem.add_development_dependency('rspec', '~> 2.10')
+end

data/lib/basic_config.rb

@@ -0,0 +1,54 @@
+require 'yaml'
+
+class BasicConfig
+  def initialize(hash)
+    raise ArgumentError, 'Hash can not be nil' if hash.nil?
+
+    # Symbolize keys: don't want to add ActiveSupport dependency just for this.
+    @hash = hash.inject({}) do |h, (key, value)|
+      h[key.to_sym] = value
+      h
+    end
+
+    @hash.each do |key, value|
+      @hash[key] = BasicConfig.new(value) if value.is_a?(Hash)
+    end
+  end
+
+  def [](key)
+    @hash[key]
+  end
+
+  def include?(key)
+    @hash.has_key?(key)
+  end
+
+  def method_missing(meth, *args, &block)
+    if include?(meth)
+      raise ArgumentError, 'Getter can not receive any arguments' if !args.empty? || block_given?
+      @hash[meth]
+    else
+      super
+    end
+  end
+
+  def respond_to?(meth)
+    include?(meth) or super
+  end
+
+  def to_hash
+    @hash.dup.tap do |h|
+      h.each do |key, value|
+        h[key] = value.to_hash if value.is_a?(BasicConfig)
+      end
+    end
+  end
+
+  def self.load_file(name)
+    BasicConfig.new(YAML.load_file(name))
+  end
+
+  def self.load_env(name, env)
+    BasicConfig.new(YAML.load_file(name)[env])
+  end
+end

data/spec/basic_config_spec.rb

@@ -0,0 +1,76 @@
+require_relative '../lib/basic_config'
+require 'active_support/core_ext/hash'
+
+describe BasicConfig do
+  let(:hash) do
+    {
+      'one' => 'something',
+      'two' => 'other_value',
+      'three' => {
+        'nested' => '123'
+      }
+    }
+  end
+
+  subject { BasicConfig.new(hash) }
+
+  it 'can not be created with nil' do
+    expect { BasicConfig.new(nil) }.to raise_error(ArgumentError)
+  end
+
+  it 'provides with getters for keys' do
+    subject.one.should == 'something'
+    subject.two.should == 'other_value'
+  end
+
+  it 'symbolizes keys' do
+    subject.to_hash.keys.first.should be_a Symbol
+  end
+
+  it 'transforms nested hashes into BasicConfigs' do
+    subject.three.should be_a BasicConfig
+    subject.three.nested.should == '123'
+  end
+
+  it 'correctly handles respond_to? queries' do
+    subject.should respond_to :one
+    subject.should respond_to :three
+    subject.should_not respond_to :unknown
+  end
+
+  it 'raises NoMethodError for unknown keys' do
+    expect { subject.four }.to raise_error(NoMethodError)
+  end
+
+  it 'can be converted back to hash' do
+    converted = subject.to_hash.stringify_keys
+    converted['three'] = converted['three'].stringify_keys
+    converted.should == hash
+  end
+
+  describe '::load_file' do
+    it 'uses YAML to load files' do
+      YAML.should_receive(:load_file).with('file').and_return(:content)
+      BasicConfig.should_receive(:new).with(:content)
+      BasicConfig.load_file('file')
+    end
+  end
+
+  describe '::load_env' do
+    let(:content) do
+      {
+        'development' => {
+          'value' => 'x'
+        },
+        'test' => {
+          'value' => 'y'
+        }
+      }
+    end
+    it 'selects env section from YAML loaded file' do
+      YAML.should_receive(:load_file).with('file').and_return(content)
+      BasicConfig.should_receive(:new).with(content['development'])
+      BasicConfig.load_env('file', 'development')
+    end
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: basic_config
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Stepan Tubanov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.10'
+description: Makes it easier to use configuration by wrapping it in a struct-like
+  object
+email:
+- stepan773@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- basic_config.gemspec
+- lib/basic_config.rb
+- spec/basic_config_spec.rb
+homepage: https://github.com/stephan778/basic_config
+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.19
+signing_key: 
+specification_version: 3
+summary: Friendly configuration wrapper
+test_files:
+- spec/basic_config_spec.rb