bonfig 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7468a2f0db5fdccd9d11b5d5872ec29e83243397
+  data.tar.gz: 1bd2eb2a5796cb20bad3968fe767b28ed9fc6905
+SHA512:
+  metadata.gz: 2bc8e7d440dd490ce33ebedc07f3e5ca01739c6031b9eac32e2609c148a8e61d05329301724b822538c36709416ff6eaa3b9d3263abbc03e76f97d146ae898cc
+  data.tar.gz: 5868838988dbe7c409c2c95fdc1551de97b88b5910bf13fbb9ff0800430d3ea7f1086ee1b443156a111dcf8287571212de0869dd55cbe6659757649af1efd103

data/.coveralls.yml

@@ -0,0 +1 @@
+repo_token: wFwWApCvRT7srX8AbTakbUOzJCos4HvFw

data/.document

@@ -0,0 +1,3 @@
+- 
+ChangeLog.md
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,6 @@
+Gemfile.lock
+doc/
+pkg/
+coverage/
+vendor/cache/*.gem
+.bundle/

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.rubocop.yml

@@ -0,0 +1,18 @@
+Documentation:
+  Enabled: false
+
+RedundantSelf:
+  Enabled: false
+
+LineLength:
+  Max: 200
+
+HashSyntax:
+  EnforcedStyle: ruby19
+
+AllCops:
+  Includes:
+    - Gemfile
+    - Rakefile
+  Excludes:
+    - bin/**

data/.ruby-gemset

@@ -0,0 +1 @@
+bonfig

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - jruby-19mode

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title "bonfig Documentation" --protected

data/ChangeLog.md

@@ -0,0 +1,4 @@
+### 0.1.0 / 2014-03-02
+
+* Initial release:
+

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'pry'
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-rubocop'
+  gem 'gem-release'
+  gem 'coveralls', require: false
+end

data/Guardfile

@@ -0,0 +1,10 @@
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch('spec/spec_helper.rb') { "spec" }
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+end
+
+guard :rubocop, all_on_start: true, cli: ['--auto-correct'] do
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 George Erickson
+
+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,50 @@
+# Bonfig
+[![Build Status](https://travis-ci.org/GeorgeErickson/bonfig.png?branch=master)](https://travis-ci.org/GeorgeErickson/bonfig)
+[![Code Climate](https://codeclimate.com/github/GeorgeErickson/bonfig.png)](https://codeclimate.com/github/GeorgeErickson/bonfig)
+[![Coverage Status](https://coveralls.io/repos/GeorgeErickson/bonfig/badge.png?branch=master)](https://coveralls.io/r/GeorgeErickson/bonfig?branch=master)
+[![Dependency Status](https://gemnasium.com/GeorgeErickson/bonfig.png)](https://gemnasium.com/GeorgeErickson/bonfig)
+
+
+Simple configuration for modules.
+
+## Install
+```ruby
+gem 'bonfig'
+```
+
+## Usage
+```ruby
+module MyModule
+  extend Bonfig
+
+  bonfig do
+    config :index_name, default: 'test'
+    config :redis do
+      config :port, default: 6379
+      config :host, default: 'localhost'
+      config :db, default: 1
+    end
+  end
+end
+
+
+MyModule.config do |c|
+  c.index_name = 'dev'
+
+  c.redis = {port: 1234, host: '0.0.0.0' }
+  # Or
+  c.redis do |r|
+    r.port = 1234
+    r.host = '0.0.0.0'
+  end
+  # Or
+  c.redis.port = 1234
+  c.redis.host = '0.0.0.0'
+end
+
+
+puts MyModule.config.index_name # 'dev'
+puts MyModule.config.redis.port  # 1234
+puts MyModule.config.redis.host  # '0.0.0.0'
+puts MyModule.config.redis.db  # 1
+```

data/Rakefile

@@ -0,0 +1,34 @@
+# encoding: utf-8
+
+require 'rubygems'
+
+begin
+  require 'bundler'
+rescue LoadError => e
+  warn e.message
+  warn 'Run `gem install bundler` to install Bundler.'
+  exit(-1)
+end
+
+begin
+  Bundler.setup(:development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn 'Run `bundle install` to install missing gems.'
+  exit e.status_code
+end
+
+require 'rake'
+
+require 'rubygems/tasks'
+Gem::Tasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task test: :spec
+task default: :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new
+task doc: :yard

data/bonfig.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/bonfig/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "bonfig"
+  gem.version       = Bonfig::VERSION
+  gem.summary       = %q{A simple config mixin for gems.}
+  gem.description   = %q{Configuration Mixin}
+  gem.license       = "MIT"
+  gem.authors       = ["George Erickson"]
+  gem.email         = "george.erickson.jr@gmail.com"
+  gem.homepage      = "https://github.com/GeorgeErickson/bonfig/"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'bundler', '~> 1.0'
+  gem.add_development_dependency 'rake', '~> 0.8'
+  gem.add_development_dependency 'rspec', '~> 2.4'
+  gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
+  gem.add_development_dependency 'yard', '~> 0.8'
+end

data/lib/bonfig.rb

@@ -0,0 +1,67 @@
+module Bonfig
+  class BlankConfig < BasicObject
+    def initialize(&block)
+      @_data = ::Hash.new
+      instance_eval(&block)
+    end
+
+    def config(name, options = {}, &block)
+      name = name.to_sym
+      if block
+        _nested(name, &block)
+      else
+        @_data[name] = options[:default]
+        define_method("#{name}=") { |value| @_data[name] = value }
+        define_method(name) { @_data[name] }
+      end
+
+      define_method("#{name}?") { @_data.key?(name) }
+    end
+
+    def [](key)
+      @_data[key]
+    end
+
+    protected
+
+    def _update(data)
+      @_data.update(data)
+    end
+
+    def _nested(name, &block)
+      nested = @_data[name] = BlankConfig.new(&block)
+
+      define_method(name) do |&b|
+        if b
+          b.call(nested)
+        else
+          @_data[name]
+        end
+      end
+
+      define_method("#{name}=") do |val|
+        if val.is_a?(::Hash)
+          nested._update(val)
+        else
+          fail 'Can\'t assign value to nested config.'
+        end
+      end
+    end
+
+    def define_method(name, &block)
+      name = name.to_sym
+      (class << self; self; end).class_eval do
+        define_method(name, &block)
+      end
+    end
+  end
+
+  def bonfig(&block)
+    @config ||= BlankConfig.new(&block)
+  end
+
+  def config(data = nil, &block)
+    yield(@config) if block_given?
+    @config
+  end
+end

data/lib/bonfig/version.rb

@@ -0,0 +1,4 @@
+module Bonfig
+  # bonfig version
+  VERSION = '0.1.0'
+end

data/spec/bonfig_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+
+module Helper
+  def bonfig_subject(&block)
+    subject do
+      Module.new do
+        extend Bonfig
+        bonfig(&block)
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.extend Helper
+end
+
+PROTECTED_WORDS = [:size, :method_missing, :new]
+
+describe Bonfig do
+  context 'simple' do
+    bonfig_subject do
+      config :name
+      config :name_default, default: 1
+    end
+
+    it 'uses a default if given or nil' do
+      expect(subject.config.name).to be_nil
+      expect(subject.config.name_default).to eq(1)
+    end
+
+    it 'allows overide' do
+      subject.config do |c|
+        c.name = 1
+        c.name_default = 2
+      end
+
+      expect(subject.config.name).to eq(1)
+      expect(subject.config.name_default).to eq(2)
+    end
+  end
+
+  context 'protected words should be valid configs' do
+    bonfig_subject do
+      PROTECTED_WORDS.each do |meth|
+        config meth, default: meth
+      end
+    end
+
+    PROTECTED_WORDS.each do |meth|
+      it meth.to_s do
+        expect(subject.config[meth]).to eq(meth)
+      end
+    end
+  end
+
+  context 'nested assignment' do
+    bonfig_subject do
+      config :redis do
+        config :port, default: 6379
+        config :host, default: 'localhost'
+      end
+    end
+
+    it 'allows nested block assignment' do
+      subject.config do |c|
+        c.redis do |r|
+          r.port = 1
+        end
+
+        expect(subject.config.redis.port).to eq(1)
+        expect(subject.config.redis.host).to eq('localhost')
+      end
+    end
+
+    it 'allows attribute assignment' do
+      subject.config do |c|
+        c.redis.port = 1
+      end
+
+      expect(subject.config.redis.port).to eq(1)
+      expect(subject.config.redis.host).to eq('localhost')
+    end
+
+    it 'allows hash assignment' do
+      subject.config do |c|
+        c.redis = { port: 1 }
+      end
+
+      expect(subject.config.redis.port).to eq(1)
+      expect(subject.config.redis.host).to eq('localhost')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'bonfig'

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: bonfig
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- George Erickson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Configuration Mixin
+email: george.erickson.jr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .coveralls.yml
+- .document
+- .gitignore
+- .rspec
+- .rubocop.yml
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
+- .yardopts
+- ChangeLog.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bonfig.gemspec
+- lib/bonfig.rb
+- lib/bonfig/version.rb
+- spec/bonfig_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/GeorgeErickson/bonfig/
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A simple config mixin for gems.
+test_files:
+- spec/bonfig_spec.rb
+- spec/spec_helper.rb
+has_rdoc: