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

@@ -0,0 +1,4 @@
+language: ruby
+
+rvm:
+  - 1.9.3

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Steffen Uhlig
+
+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,37 @@
+# ConfigRC
+
+Provides simple, hierarchical app configuration:
+
+  * Environment variables take precendence over
+    * Command-line options, which take precendence over
+      * rc-file options.
+
+Environment variables are expected to be prefixed with the application name and an underscore (e.g. `app_foo` will set `foo`). The rc file is assumed to have the usual name of `.apprc` in the user's home directory. An additional options hash can be passed.
+
+[![Build Status](https://secure.travis-ci.org/nerab/config-rc.png?branch=master)](http://travis-ci.org/nerab/config-rc)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'config-rc'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install config-rc
+
+## Usage
+
+See test/bin/app for an example.
+
+## 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,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |test|
+  test.libs << 'lib' << 'test' << 'test/unit'
+  test.pattern = 'test/unit/test_*.rb'
+end
+
+task :default => :test

data/config-rc.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/config-rc/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors = ["Nicholas E. Rabenau"]
+  gem.email = "nerab@gmx.net"
+  gem.description   = %q{Opinionated configuration library. Reads from config file, command line option and environment variable.}
+  gem.summary       = %q{Opinionated config library}
+  gem.homepage      = "http://github.com/nerab/config-rc"
+
+  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          = "config-rc"
+  gem.require_paths = ["lib"]
+  gem.version       = ConfigRC::VERSION
+
+  gem.add_runtime_dependency 'require_all'
+  gem.add_development_dependency 'minitest'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'rake'
+end

data/lib/config-rc.rb

@@ -0,0 +1,2 @@
+require 'require_all'
+require_all('lib')

data/lib/config-rc/base.rb

@@ -0,0 +1,7 @@
+module ConfigRC
+  class BaseProvider
+    def to_s
+      map.map{|k, v| "#{k}=#{v}"}.join("\n")
+    end
+  end
+end

data/lib/config-rc/configuration.rb

@@ -0,0 +1,32 @@
+require 'forwardable'
+
+module ConfigRC
+  #
+  # Provide hierarchical configuration.
+  #
+  # Environment variables win over
+  #   command line options win over
+  #     settings from the config file
+  #
+  class Configuration
+    include Enumerable
+    extend Forwardable
+    def_delegators :map, :each, :[]
+
+    def initialize(app_name, options = {})
+      @providers = [RcFileProvider.new(app_name), OptionsProvider.new(options), EnvironmentProvider.new(app_name)]
+    end
+
+    private
+    #
+    # Provides the union of each key across all providers
+    #
+    def map
+      result = {}
+      @providers.each do |provider|
+        result.merge!(provider.map)
+      end
+      result
+    end
+  end
+end

data/lib/config-rc/environment.rb

@@ -0,0 +1,14 @@
+module ConfigRC
+  #
+  # Configuration stored as environment variable
+  #
+  class EnvironmentProvider < BaseProvider
+    def initialize(prefix)
+      @prefix = "#{prefix}_"
+    end
+
+    def map
+      ENV.select{|k, v| k.start_with?(@prefix)}.each_with_object({}){|(k, v), h| h[k.gsub(@prefix, '')] = v}
+    end
+  end
+end

data/lib/config-rc/options.rb

@@ -0,0 +1,14 @@
+module ConfigRC
+  #
+  # Configuration from options hash that is passed through
+  #
+  class OptionsProvider < BaseProvider
+    def initialize(options)
+      @options = options
+    end
+
+    def map
+      @options
+    end
+  end
+end

data/lib/config-rc/rc_file.rb

@@ -0,0 +1,19 @@
+module ConfigRC
+  #
+  # Configuration stored in a file
+  #
+  class RcFileProvider < BaseProvider
+    def initialize(prefix)
+      @path = File.expand_path(File.join('~', ".#{prefix}rc"))
+    end
+
+    def map
+      props = {}
+      File.open(@path).select{|line| not line =~ /^[ \t]*(#.+)*$/}.each do |line|
+        k, v = line.chomp.split('=', 2)
+        props[k] = v
+      end if File.exist?(@path)
+      props
+    end
+  end
+end

data/lib/config-rc/version.rb

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

data/test/bin/app

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+
+#
+# Sample usage:
+#
+#   HOME=$(pwd)/test/fixtures test/bin/app.rb
+#
+# to see foo being read from test/fixtures/.testconfigrc. Override this
+# setting with an environment variable:
+#
+#   HOME=$(pwd)/test/fixtures testconfig_foo=env test/bin/app.rb
+#
+require 'bundler'
+Bundler.require
+
+require 'config-rc'
+
+class App
+  attr_reader :config
+  APP_NAME = 'testconfig'
+
+  def initialize
+    @config = ConfigRC::Configuration.new(APP_NAME, 'foo' => 'option')
+  end
+
+  def to_s
+    "Hi, my name is '#{APP_NAME}', and I do " <<
+      if @config.any?
+        "have configuration:"
+      else
+        "not have any configuration."
+      end
+  end
+end
+
+app = App.new
+puts app.to_s
+app.config.each do |k, v|
+  puts "#{k}=#{v}"
+end

data/test/fixtures/.testconfigrc

@@ -0,0 +1 @@
+foo=file

data/test/helper.rb

@@ -0,0 +1,2 @@
+require 'minitest/autorun'
+require 'config-rc'

data/test/unit/test_config_rc.rb

@@ -0,0 +1,42 @@
+require 'helper'
+
+class TestConfigRC < MiniTest::Unit::TestCase
+  def setup
+    ENV['HOME'] = File.join(File.dirname(__FILE__), '..', 'fixtures')
+  end
+
+  def test_empty
+    c = ConfigRC::Configuration.new('test_empty')
+    refute(c.any?)
+  end
+
+  def test_file
+    ENV['testconfig_foo'] = nil
+    c = ConfigRC::Configuration.new('testconfig')
+    assert_equal('file', c['foo'])
+  end
+
+  def test_file_option
+    ENV['testconfig_foo'] = nil
+    c = ConfigRC::Configuration.new('testconfig', 'foo' => 'option')
+    assert_equal('option', c['foo'])
+  end
+
+  def test_file_option_env
+    ENV['testconfig_foo'] = 'env'
+    c = ConfigRC::Configuration.new('testconfig', 'foo' => 'option')
+    assert_equal('env', c['foo'])
+  end
+
+  def test_file_env
+    ENV['testconfig_foo'] = 'env'
+    c = ConfigRC::Configuration.new('testconfig', 'foo' => 'option')
+    assert_equal('env', c['foo'])
+  end
+
+  def test_option_env
+    ENV['testconfig2_foo2'] = 'envi'
+    c = ConfigRC::Configuration.new('testconfig2', 'foo2' => 'option')
+    assert_equal('envi', c['foo2'])
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: config-rc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Nicholas E. Rabenau
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Opinionated configuration library. Reads from config file, command line
+  option and environment variable.
+email: nerab@gmx.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- config-rc.gemspec
+- lib/config-rc.rb
+- lib/config-rc/base.rb
+- lib/config-rc/configuration.rb
+- lib/config-rc/environment.rb
+- lib/config-rc/options.rb
+- lib/config-rc/rc_file.rb
+- lib/config-rc/version.rb
+- test/bin/app
+- test/fixtures/.testconfigrc
+- test/helper.rb
+- test/unit/test_config_rc.rb
+homepage: http://github.com/nerab/config-rc
+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.24
+signing_key: 
+specification_version: 3
+summary: Opinionated config library
+test_files:
+- test/bin/app
+- test/fixtures/.testconfigrc
+- test/helper.rb
+- test/unit/test_config_rc.rb