webmat-local_config 0.1.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Mathieu Martin
+
+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.rdoc

@@ -0,0 +1,29 @@
+= local_config
+
+local_config is a micro plugin that encapsulates the pattern of loading either the official foo.yml 
+config file or the developer's personal foo.local.yml file.
+
+== Example
+
+    LocalConfig.load_config('database')
+
+This loads RAILS_ROOT/config/database.local.yml if present. Otherwise loads database.yml.
+Will return only the section related to the current RAILS_ENV by default.
+
+If you have a file that isn't split in the usual RAILS_ENV sections, simply call
+
+    LocalConfig.load_environment_config('foo', :environment => false)
+
+== Install
+
+Whichever you prefer:
+
+    script/plugin install http://github.com/webmat/local_config.git
+
+or 
+
+    config.gem "webmat-local_config", :lib => 'local_config', :source => "http://gems.github.com"
+
+== Copyright
+
+Copyright (c) 2009 Mathieu Martin. See LICENSE for details.

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 1
+:patch: 1
+:major: 0

data/lib/local_config.rb

@@ -0,0 +1,14 @@
+require 'yaml'
+
+module LocalConfig
+  def self.load_config(name, options={})
+    environment = options.has_key?(:environment) ? options[:environment] : true
+
+    personal_config_file  = "#{RAILS_ROOT}/config/#{name}.local.yml"
+    shared_config_file    = "#{RAILS_ROOT}/config/#{name}.yml"
+    config_file = File.exists?(personal_config_file) ? personal_config_file : shared_config_file
+
+    config = HashWithIndifferentAccess.new YAML.load(File.read(config_file))
+    environment ? config[RAILS_ENV] : config
+  end
+end

data/test/local_config_test.rb

@@ -0,0 +1,53 @@
+require 'test_helper'
+
+class LocalConfigTest < Test::Unit::TestCase
+  context "with RAILS_ENV set to 'development'" do
+    setup do
+      silence_warnings { ::RAILS_ENV = 'development' }
+    end
+
+    context "in the general case" do
+      setup do
+        @config = LocalConfig.load_config('without_local')
+      end
+
+      should "return the content of the hash for the current environment" do
+        assert !@config.has_key?(:development)
+      end
+
+      should "return a Rails' HashWithIndifferentAccess, for convenience's sake" do
+        assert_equal HashWithIndifferentAccess, @config.class
+      end
+    end
+
+    context "reading with_local.yml" do
+      setup do
+        @config = LocalConfig.load_config('with_local')
+      end
+
+      should "return the values of the .local file" do
+        assert_equal 'local value', @config[:param]
+      end
+    end
+
+    context "reading without_local.yml" do
+      setup do
+        @config = LocalConfig.load_config('without_local')
+      end
+
+      should "return the values of the .yml file" do
+        assert_equal 'never overridden', @config[:param]
+      end
+    end
+  end
+
+  context "reading no_env.yml" do
+    setup do
+      @config = LocalConfig.load_config('no_env', :environment => false)
+    end
+
+    should "return the values of the .yml file" do
+      assert_equal 'value', @config[:param]
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'activesupport'
+
+test_dir = File.dirname(__FILE__)
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(test_dir)
+require 'local_config'
+
+RAILS_ROOT = File.join test_dir, 'test_rails_root'
+
+class Test::Unit::TestCase
+end

data/test/test_rails_root/config/no_env.yml

@@ -0,0 +1 @@
+param: value

data/test/test_rails_root/config/with_local.local.yml

@@ -0,0 +1,2 @@
+development:
+  param: local value

data/test/test_rails_root/config/with_local.yml

@@ -0,0 +1,2 @@
+development:
+  param: official value

data/test/test_rails_root/config/without_local.yml

@@ -0,0 +1,2 @@
+development:
+  param: never overridden

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: webmat-local_config
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Mathieu Martin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-04 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: webmat@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+files: 
+- README.rdoc
+- VERSION.yml
+- lib/local_config.rb
+- test/local_config_test.rb
+- test/test_helper.rb
+- test/test_rails_root
+- test/test_rails_root/config
+- test/test_rails_root/config/no_env.yml
+- test/test_rails_root/config/with_local.local.yml
+- test/test_rails_root/config/with_local.yml
+- test/test_rails_root/config/without_local.yml
+- LICENSE
+has_rdoc: true
+homepage: http://github.com/webmat/local_config
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: "Micro plugin to solve a micro problem: loading  either your .local.yml config file if it's there, or the official .yml otherwise."
+test_files: []
+