lite_config 0.0.1 → 0.0.2

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+cache: bundler
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0

data/README.md

@@ -1,50 +1,113 @@
 # LiteConfig
 
+[![Build Status](https://travis-ci.org/gtd/lite_config.png?branch=master)](https://travis-ci.org/gtd/lite_config)
+[![Code Climate](https://codeclimate.com/github/gtd/lite_config.png)](https://codeclimate.com/github/gtd/lite_config)
+
 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.
+and cached, automatically choosing the current environment's hash.  It also supports local developer override via
+a simple, easily git-ignoreable naming convention.
+
 
 ## Installation
 
-Add this line to your application's Gemfile:
+It's just a regular gem, add with the usual Gemfile declaration:
 
     gem 'lite_config'
 
-And then execute:
+Alternatively if you aren't using Bundler then you probably don't need me telling you what to do.
+
 
-    $ bundle
+## Usage
 
-Or install it yourself as:
+By default LiteConfig follows the Rails convention for config file directory.  For instance you might have a file
+`config/options.yml`:
 
-    $ gem install lite_config
+    development:
+      stuff: Things
+    test:
+      stuff: Test Things
 
-## Usage
+You can access the sub-hash of the current environment with a simple method call:
+
+    LiteConfig(:options)
+    => {"stuff"=>"Things"}
+
+Note that it is a HashWithIndifferentAccess:
+
+    LiteConfig(:options)[:stuff]
+    => "Things"
+
+It's worth mentioning that this applies to nested hashes as well, so given `config/options.yml`:
+
+    development:
+      outer:
+        inner: Stuff
+
+you can do:
+
+    LiteConfig(:options)[:outer][:inner]
+    => "Stuff"
+
+Of course any valid YAML will work, but it works particularly nicely with simple hashes and arrays.
+
+#### Flat Config Files
+
+Do you ever cringe when your config file uses advanced YAML features do duplicate the exact same hash for every
+environment?  With LiteConfig you can just skip the environment keys at the top-level entirely if you want to. So for
+instance a config file `config/options.yml` containing only:
+
+    root: This is tops
+
+can be used as such:
+
+    LiteConfig(:options)[:root]
+    => "This is tops"
+
+In case you're wondering, this is based on a simple heuristic by checking for the presence of a `test`, `development`
+or `production` at the root level, so if those are the keys for your config values than I'm sorry but you'll need to go
+back to your byzantine YAML ampersand syntax hacks.
+
+#### Local Overrides
+
+Sometimes on your team individual developers have local configuration that you don't want in version control.  Consider
+`config/geoip.yml`:
+
+    foo: bar
+    data_file: /usr/share/geoip.dat
+
+But developers may not all organize their systems exactly the same way, so you create a local config named
+`config/geoip_local.yml`:
+
+    data_file: /Users/apple-fanboy/Documents/geoip.dat
 
-Simple loading of environment-namespaced config files with local overrides.
+LiteConfig automatically picks this up based on the naming convention and merges the values into main config file hash:
 
-    LiteConfig(:foobar)
+    LiteConfig(:geoip)[:data_file]
+    => "/Users/apple-fanboy/Documents/geoip.dat"
 
-loads and caches the current environment section from:
+    LiteConfig(:geoip)[:foo]
+    => "bar"
 
-    config/foobar.yml
+The naming convention also allows you to add the following to your `.gitignore`:
 
-The file must contain a yaml hash with environments for top-level keys.
+    config/*_local.yml
 
-Config files can be overridden by adding '_local' to the filename:
+#### LiteConfig Settings
 
-    config/foobar_local.yml
+LiteConfig is meant to work out of the box with Rails, but it also is configurable.  Note that these settings can not be
+changed after the first config file is loaded as that could lead to the wrong data being loaded and cached.
 
-Local overrides are intended for individual developer boxes and thus
-should be left out of version control.
+    LiteConfig.config_path = '/usr/local/global_app_config' # Full path to the directory files should be loaded from
+    LiteConfig.app_env = 'production' # Explicitly override RAILS_ENV, RACK_ENV defaults
 
 
-## TODO
+## Future Ideas
 
-* Convert hash to OpenStruct for method-based access
-* Raise errors for undefined config keys
+* Convert LiteConfig to an insantiable class instead of a singleton
+* Remove ActiveSupport dependency
+* Ability to raise errors for undefined config keys
 * Support TOML or other config formats
-* Allow configuration of source directory
-* Allow multiple source directories
+* Allow OpenStruct-like access to the config.  I'm not 100% sure on the ROI of this feature.
 
 
 ## Contributing

data/lib/lite_config/version.rb

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

data/lib/lite_config.rb

@@ -16,12 +16,18 @@ module LiteConfig
     @configs.key?(name) ? @configs[name] : (@configs[name] = HashWithIndifferentAccess.new(load(name)))
   end
 
-  def set_config_path(path)
+  def config_path=(path)
     raise ImmutableError, "config_path is frozen after the first file load" unless @configs.nil?
 
     @config_path = path
   end
 
+  def app_env=(app_env)
+    raise ImmutableError, "app_env is frozen after the first file load" unless @configs.nil?
+
+    @app_env = app_env
+  end
+
   def reset
     @configs = nil
   end
@@ -32,7 +38,9 @@ module LiteConfig
     config = load_single(config_filename(name))
 
     if File.exist?(local_config_filename(name))
-      config.deep_merge!(load_single(local_config_filename(name)))
+      local_config = load_single(local_config_filename(name))
+
+      config.deep_merge!(local_config) if local_config
     end
 
     raise "Oops, no #{app_env} config found for #{name} in #{filename}" unless config
@@ -58,9 +66,6 @@ module LiteConfig
     config_filename(name).gsub(/.yml$/, '_local.yml')
   end
 
-  def active_config_filename(name)
-  end
-
   def app_root
     defined?(Rails) ? Rails.root : `pwd`.strip
   end
@@ -79,7 +84,7 @@ module LiteConfig
   end
 
   def has_environmenty_key?(hash)
-    %w(development test production).any?{ |envy| hash.key?(envy) }
+    %w(development test production).any?{ |envy| hash.key?(envy) } if hash
   end
 end
 

data/lite_config.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   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.description   = %q{Lightweight configuration for your ruby app.  Reads Rails-style YAML files from your config directory.  Features include optional environment namespacing, local convention-based override files, and indifferent (symbol vs string) access.}
+  spec.summary       = %q{Lightweight configuration for your ruby app}
   spec.homepage      = ""
   spec.license       = "MIT"
 

data/spec/fixtures/empty_environment_override.yml

@@ -0,0 +1,4 @@
+development:
+  option: again empty
+test:
+  option: again test_empty

data/spec/fixtures/empty_environment_override_local.yml

@@ -0,0 +1,2 @@
+development:
+test:

data/spec/fixtures/empty_override.yml

@@ -0,0 +1,4 @@
+development:
+  option: empty
+test:
+  option: test_empty

data/spec/fixtures/missing_environment_override.yml

@@ -0,0 +1,4 @@
+development:
+  option: yet again empty
+test:
+  option: yet again test_empty

data/spec/fixtures/missing_environment_override_local.yml

@@ -0,0 +1,2 @@
+test:
+  option: only test option here

data/spec/lite_config_spec.rb

@@ -5,11 +5,19 @@ describe LiteConfig do
     LiteConfig.reset
   end
 
-  describe "set_config_path" do
+  describe "config_path=" do
     it "should fail after the first load" do
       LiteConfig(:basic)
 
-      proc { LiteConfig.set_config_path('foo') }.must_raise LiteConfig::ImmutableError
+      proc { LiteConfig.config_path = 'foo' }.must_raise LiteConfig::ImmutableError
+    end
+  end
+
+  describe "app_env=" do
+    it "should fail after the first load" do
+      LiteConfig(:basic)
+
+      proc { LiteConfig.app_env = 'foo' }.must_raise LiteConfig::ImmutableError
     end
   end
 
@@ -76,6 +84,36 @@ describe LiteConfig do
     end
   end
 
+  describe "empty_override config" do
+    before do
+      @config = LiteConfig(:empty_override)
+    end
+
+    it "should load successfully" do
+      @config[:option].must_equal 'empty'
+    end
+  end
+
+  describe "empty_environment_override config" do
+    before do
+      @config = LiteConfig(:empty_environment_override)
+    end
+
+    it "should load successfully" do
+      @config[:option].must_equal 'again empty'
+    end
+  end
+
+  describe "missing_environment_override config" do
+    before do
+      @config = LiteConfig(:missing_environment_override)
+    end
+
+    it "should load successfully" do
+      @config[:option].must_equal 'yet again empty'
+    end
+  end
+
   describe "environmentless config" do
     before do
       @config = LiteConfig(:environmentless)

data/spec/spec_helper.rb

@@ -4,4 +4,5 @@ require 'debugger'
 
 require 'lite_config'
 
-LiteConfig.set_config_path(File.expand_path(__FILE__ + '/../fixtures'))
+LiteConfig.config_path = File.expand_path(__FILE__ + '/../fixtures')
+LiteConfig.app_env = 'development'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lite_config
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-17 00:00:00.000000000 Z
+date: 2014-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -91,8 +91,9 @@ dependencies:
     - - ! '>='
       - !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.
+description: Lightweight configuration for your ruby app.  Reads Rails-style YAML
+  files from your config directory.  Features include optional environment namespacing,
+  local convention-based override files, and indifferent (symbol vs string) access.
 email:
 - gabe@websaviour.com
 executables: []
@@ -100,6 +101,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -108,7 +110,13 @@ files:
 - lib/lite_config/version.rb
 - lite_config.gemspec
 - spec/fixtures/basic.yml
+- spec/fixtures/empty_environment_override.yml
+- spec/fixtures/empty_environment_override_local.yml
+- spec/fixtures/empty_override.yml
+- spec/fixtures/empty_override_local.yml
 - spec/fixtures/environmentless.yml
+- spec/fixtures/missing_environment_override.yml
+- spec/fixtures/missing_environment_override_local.yml
 - spec/fixtures/nested.yml
 - spec/fixtures/override.yml
 - spec/fixtures/override_local.yml
@@ -138,10 +146,16 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Lightweight configuration for your app
+summary: Lightweight configuration for your ruby app
 test_files:
 - spec/fixtures/basic.yml
+- spec/fixtures/empty_environment_override.yml
+- spec/fixtures/empty_environment_override_local.yml
+- spec/fixtures/empty_override.yml
+- spec/fixtures/empty_override_local.yml
 - spec/fixtures/environmentless.yml
+- spec/fixtures/missing_environment_override.yml
+- spec/fixtures/missing_environment_override_local.yml
 - spec/fixtures/nested.yml
 - spec/fixtures/override.yml
 - spec/fixtures/override_local.yml