lite_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,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Gabe da Silveira
+
+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,56 @@
+# LiteConfig
+
+LiteConfig automates the loading of Rails-style YAML config files.  With a single line the config file is lazily loaded
+and cached, automatically choosing the current environment's hash.  It also supports a naming convention for overriding
+the official config file without source code changes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'lite_config'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lite_config
+
+## Usage
+
+Simple loading of environment-namespaced config files with local overrides.
+
+    LiteConfig(:foobar)
+
+loads and caches the current environment section from:
+
+    config/foobar.yml
+
+The file must contain a yaml hash with environments for top-level keys.
+
+Config files can be overridden by adding '_local' to the filename:
+
+    config/foobar_local.yml
+
+Local overrides are intended for individual developer boxes and thus
+should be left out of version control.
+
+
+## TODO
+
+* Convert hash to OpenStruct for method-based access
+* Raise errors for undefined config keys
+* Support TOML or other config formats
+* Allow configuration of source directory
+* Allow multiple source directories
+
+
+## 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

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new :test do |t|
+  t.test_files = FileList['spec/*_spec.rb']
+end
+
+task :default => :test

data/lib/lite_config/version.rb

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

data/lib/lite_config.rb

@@ -0,0 +1,88 @@
+require "lite_config/version"
+
+require 'active_support/core_ext/hash/deep_merge'
+require 'active_support/core_ext/hash/indifferent_access'
+
+require 'yaml'
+
+module LiteConfig
+  class ImmutableError < StandardError; end
+
+  extend self
+
+  def fetch(name)
+    name = name.to_sym
+    @configs ||= {}
+    @configs.key?(name) ? @configs[name] : (@configs[name] = HashWithIndifferentAccess.new(load(name)))
+  end
+
+  def set_config_path(path)
+    raise ImmutableError, "config_path is frozen after the first file load" unless @configs.nil?
+
+    @config_path = path
+  end
+
+  def reset
+    @configs = nil
+  end
+
+  private
+
+  def load(name)
+    config = load_single(config_filename(name))
+
+    if File.exist?(local_config_filename(name))
+      config.deep_merge!(load_single(local_config_filename(name)))
+    end
+
+    raise "Oops, no #{app_env} config found for #{name} in #{filename}" unless config
+
+    config
+  end
+
+  def load_single(filename)
+    hash = YAML.load_file(filename)
+
+    has_environmenty_key?(hash) ? hash[app_env] : hash
+  end
+
+  def config_path
+    @config_path ||= File.join(app_root, 'config')
+  end
+
+  def config_filename(name)
+    File.join(config_path, name.to_s + '.yml')
+  end
+
+  def local_config_filename(name)
+    config_filename(name).gsub(/.yml$/, '_local.yml')
+  end
+
+  def active_config_filename(name)
+  end
+
+  def app_root
+    defined?(Rails) ? Rails.root : `pwd`.strip
+  end
+
+  def app_env
+    @app_env ||=
+    if defined?(Rails)
+      Rails.env
+    elsif ENV['RAILS_ENV']
+      ENV['RAILS_ENV']
+    elsif ENV['RACK_ENV']
+      ENV['RACK_ENV']
+    else
+      'development'
+    end
+  end
+
+  def has_environmenty_key?(hash)
+    %w(development test production).any?{ |envy| hash.key?(envy) }
+  end
+end
+
+def LiteConfig(name)
+  LiteConfig.fetch(name)
+end

data/lite_config.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lite_config/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lite_config"
+  spec.version       = LiteConfig::VERSION
+  spec.authors       = ["Gabe da Silveira"]
+  spec.email         = ["gabe@websaviour.com"]
+  spec.description   = %q{Lightweight configuration for your app.  Supports open_struct style access, detects environments by default, for Rails, Rack or any other app.}
+  spec.summary       = %q{Lightweight configuration for your app}
+  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 "rake"
+  spec.add_development_dependency "minitest", ">= 5.0.0"
+  spec.add_development_dependency "debugger"
+end

data/spec/fixtures/basic.yml

@@ -0,0 +1,4 @@
+development:
+  option: dev
+test:
+  option: test

data/spec/fixtures/environmentless.yml

@@ -0,0 +1,4 @@
+one: fish
+two: fish
+red: fish
+blue: fish

data/spec/fixtures/nested.yml

@@ -0,0 +1,19 @@
+development:
+  top_level:
+    deeper:
+      and_deeper: qux
+    stuff: foobar
+    an_array:
+      - one
+      - two
+      - three
+    array_of_hashish:
+      - fu: schnickens
+        wu: tang
+      - br: and
+        nu: bians
+test:
+  top_level:
+    deeper:
+      and_deeper: testqux
+    stuff: testfoobar

data/spec/fixtures/override.yml

@@ -0,0 +1,6 @@
+development:
+  this: is a string
+  that: is another string
+  inner:
+    one: bee
+    two: baw

data/spec/fixtures/override_local.yml

@@ -0,0 +1,6 @@
+development:
+  this: overrides the first string
+  other: is yet one more
+  inner:
+    one: baz
+    three: boo

data/spec/lite_config_spec.rb

@@ -0,0 +1,88 @@
+require_relative 'spec_helper'
+
+describe LiteConfig do
+  before do
+    LiteConfig.reset
+  end
+
+  describe "set_config_path" do
+    it "should fail after the first load" do
+      LiteConfig(:basic)
+
+      proc { LiteConfig.set_config_path('foo') }.must_raise LiteConfig::ImmutableError
+    end
+  end
+
+  describe "basic config" do
+    before do
+      @config = LiteConfig(:basic)
+    end
+
+    it "should default to development enviroment" do
+      @config['option'].must_equal 'dev'
+    end
+
+    it "should allow indifferent access" do
+      @config[:option].must_equal 'dev'
+    end
+  end
+
+  describe "nested config" do
+    before do
+      @config = LiteConfig(:nested)
+    end
+
+    it "should find nested keys" do
+      @config['top_level']['deeper']['and_deeper'].must_equal 'qux'
+    end
+
+    it "should allow indifferent access" do
+      @config[:top_level][:deeper][:and_deeper].must_equal 'qux'
+    end
+
+    it "should allow arrays" do
+      @config[:top_level][:an_array][0].must_equal 'one'
+      @config[:top_level][:an_array][1].must_equal 'two'
+      @config[:top_level][:an_array][2].must_equal 'three'
+    end
+
+    it "should allow hashes in arrays" do
+      @config['top_level']['array_of_hashish'][0]['fu'].must_equal 'schnickens'
+      @config['top_level']['array_of_hashish'][0]['wu'].must_equal 'tang'
+    end
+
+    it "should allow hashes in arrays indifferently" do
+      @config[:top_level][:array_of_hashish][0][:fu].must_equal 'schnickens'
+      @config[:top_level][:array_of_hashish][0][:wu].must_equal 'tang'
+    end
+  end
+
+  describe "local_override config" do
+    before do
+      @config = LiteConfig(:override)
+    end
+
+    it "should respect override" do
+      @config[:this].must_equal "overrides the first string"
+    end
+
+    it "should merge override params" do
+      @config[:that].must_equal "is another string"
+    end
+
+    it "should merge deep override params" do
+      @config[:inner][:one].must_equal "baz"
+      @config[:inner][:two].must_equal "baw"
+    end
+  end
+
+  describe "environmentless config" do
+    before do
+      @config = LiteConfig(:environmentless)
+    end
+
+    it "should use root level as config if keys do not look environmenty" do
+      @config[:red].must_equal 'fish'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'bundler/setup'
+require 'minitest/autorun'
+require 'debugger'
+
+require 'lite_config'
+
+LiteConfig.set_config_path(File.expand_path(__FILE__ + '/../fixtures'))

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: lite_config
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Gabe da Silveira
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: debugger
+  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: Lightweight configuration for your app.  Supports open_struct style access,
+  detects environments by default, for Rails, Rack or any other app.
+email:
+- gabe@websaviour.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/lite_config.rb
+- lib/lite_config/version.rb
+- lite_config.gemspec
+- spec/fixtures/basic.yml
+- spec/fixtures/environmentless.yml
+- spec/fixtures/nested.yml
+- spec/fixtures/override.yml
+- spec/fixtures/override_local.yml
+- spec/lite_config_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+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: Lightweight configuration for your app
+test_files:
+- spec/fixtures/basic.yml
+- spec/fixtures/environmentless.yml
+- spec/fixtures/nested.yml
+- spec/fixtures/override.yml
+- spec/fixtures/override_local.yml
+- spec/lite_config_spec.rb
+- spec/spec_helper.rb
+has_rdoc: