configutron 0.2.1 → 0.3.0

data/README.markdown

@@ -1,7 +1,7 @@
 configutron
 ===========
 
-configutron is a rails gemplugin for simple, application wide configuration variables specific to a rails environment. there are a grip of projects like this; each does it differently, and this is how i like to do it. all the ones I tried seemed too heavy handed. i am publishing this as a convenience for me to use in projects i work on.
+configutron is a rails gemplugin for simple, application wide settings. there are tons of projects like this; each does it differently, and this is how i like to do it. all the ones I tried seemed too heavy handed. i am publishing this as a convenience for myself to use in projects i work on.
 
 usage
 -----
@@ -12,16 +12,42 @@ use the gem in your rails project:
 	  config.gem 'configutron'
 	end
 
-create a folder *config/settings* and a file named after each of your rails environments:
+you have two options for specifying settings. 
+
+1.  one file (_config/settings.yml_) 
+2.  one file per environment (_config/settings/environment\_name.yml_)
+
+option 1 takes presedence; that is, if _config/settings.yml_ exists, it will be used, and the _config/settings_ directory will be ignored.
+
+config/settings.yml
+-------------------
+this option uses one file for the application, with settings for each 
+environment nested under the environment's name, like database.yml.
+
+add your variables to that file:
+
+    % echo "--- \ndevelopment: \n  variable: value\n" > config/settings.yml
+
+try it out:
+
+    % ./script/console 
+    Loading development environment (Rails 2.3.5)
+    $ >> Configutron.variable
+    % => "value
+
+config/settings/RAILS\_ENV.yml
+------------------------------
+
+create a folder *config/settings*. configutron will be available for each environment 
+that has a corresponding yaml file in that directory.
 
     % mkdir config/settings
-    % touch config/settings/development.yml config/settings/test.yml config/settings/production.yml
 
 add your variables to those files:
 
     % echo "--- \nvariable: value\n" > config/settings/development.yml
 
-make sure it works:
+try it out:
 
     % ./script/console
     Loading development environment (Rails 2.3.5)
@@ -29,6 +55,8 @@ make sure it works:
     => "value"
 
 name it something easier to type:
+---------------------------------
+back in _environment.rb_
 
     Rails::Initializer.run do |config|
       config.gem 'configutron'
@@ -36,7 +64,7 @@ name it something easier to type:
     
     Configutron.constant = 'App'
 
-then back in the console:
+try it out:
 
     % ./script/console
     Loading development environment (Rails 2.3.5)

data/Rakefile

@@ -13,6 +13,8 @@ begin
     gem.add_dependency "activesupport", ">= 0"
     gem.add_runtime_dependency "activesupport", ">= 0"
     gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "fakefs", ">= 0.2.1"
+    
     gem.files = [
        ".gitignore",
        "LICENSE",
@@ -25,7 +27,7 @@ begin
        "spec/configutron_spec.rb",
        "spec/spec.opts",
        "spec/spec_helper.rb",
-       "spec/fake_rails_root/config/settings/development.yml"
+       "spec/fake_yml_files.rb"
     ]
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.3.0

data/lib/configutron.rb

@@ -13,12 +13,21 @@ module Configutron
   def method_missing(key)
     configutron[key].to_openstruct || nil
   end
-
-  def settings_path
-    File.expand_path("#{RAILS_ROOT}/config/settings/#{RAILS_ENV}.yml")
-  end
   
   def configutron
-    @configutron ||= YAML.load_file(settings_path).symbolize_keys
+    @configutron ||= setup
+  end
+  
+  def setup
+    settings_path     = File.expand_path("#{RAILS_ROOT}/config/settings.yml")
+    env_settings_path = File.expand_path("#{RAILS_ROOT}/config/settings/#{RAILS_ENV}.yml")
+    
+    if File.exist?(settings_path)
+      @configutron = YAML.load_file(settings_path)[RAILS_ENV].symbolize_keys
+    elsif File.exists?(env_settings_path)
+      @configutron = YAML.load_file(env_settings_path).symbolize_keys
+    else
+      raise IOError, "Create either config/settings.yml or config/settings/RAILS_ENV.yml"
+    end
   end
 end

data/spec/configutron_spec.rb

@@ -1,11 +1,10 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-RAILS_ROOT = File.join(File.dirname(__FILE__), 'fake_rails_root')
-RAILS_ENV  = 'development'
+RAILS_ROOT = '/rails_root/'
+RAILS_ENV = 'test'
 
 describe Configutron do
-  before do
-    @fixture_path = File.expand_path(File.dirname(__FILE__) + "/fake_rails_root/config/settings/development.yml")
-  end
+  include FakeFS::SpecHelpers
+  after(:each) { reset! }
   
   describe "module methods" do
     describe ".constant=" do
@@ -15,45 +14,63 @@ describe Configutron do
       end
     end
   end
-  
-  describe "settings file" do      
-    before do
-      Configutron.should_receive(:settings_path).and_return(@fixture_path)
-    end
-    
-    specify "is loaded from config/settings based on the RAILS_ENV" do
-      lambda { Configutron.some_variable }.should_not raise_error
-    end
-  end
 
-  describe "non-nested settings" do
-    specify "strings can be accessed" do
-      Configutron.my_string.should == 'string'
-    end
-    
-    specify "integers can be accessed" do
-      Configutron.my_integer.should == 1
+  describe "settings file" do
+    context 'one file per env' do
+      before(:each) { mock_test_yml }
+      
+      specify 'is loaded from config/settings/#{RAILS_ENV}.yml' do
+        Configutron.file.should == 'test.yml'
+      end      
     end
     
-    specify "arrays can be accessed" do
-      Configutron.my_array.should == [1,2,3,4]
+    context 'one file for the whole application' do
+      before(:each) { mock_settings_yml }
+      
+      specify 'is loaded from config/settings.yml based on the RAILS_ENV' do
+        Configutron.file.should == 'settings.yml'
+      end
     end
     
-    specify "hashes can be accesed" do
-      Configutron.my_hash.one.should == 1
-      Configutron.my_hash.two.should == 2
+    context 'that is missing' do
+      specify 'raises an IOError' do
+        lambda { Configutron.snoop_dogg }.should raise_error(IOError, "Create either config/settings.yml or config/settings/RAILS_ENV.yml")
+      end
     end
   end
-  
-  describe "nested settings" do
-    specify "can be accessed" do
-      Configutron.two.three.should == 3
+
+  describe "settings" do
+    before(:each) { mock_test_yml }
+        
+    describe "non-nested settings" do
+      specify "strings can be accessed" do
+        Configutron.my_string.should == 'string'
+      end
+      
+      specify "integers can be accessed" do
+        Configutron.my_integer.should == 1
+      end
+      
+      specify "arrays can be accessed" do
+        Configutron.my_array.should == [1,2,3,4]
+      end
+      
+      specify "hashes can be accesed" do
+        Configutron.my_hash.one.should == 1
+        Configutron.my_hash.two.should == 2
+      end
     end
     
     describe "nested settings" do
       specify "can be accessed" do
-        Configutron.four.five.six.should == 6
+        Configutron.two.three.should == 3
       end
-    end
+      
+      describe "nested settings" do
+        specify "can be accessed" do
+          Configutron.four.five.six.should == 6
+        end
+      end
+    end    
   end
 end

data/spec/{fake_rails_root/config/settings/development.yml → fake_yml_files.rb}

@@ -1,3 +1,6 @@
+TEST_YML = <<-END_SETTINGS
+file: test.yml
+
 some_variable: some value
 
 my_string: string
@@ -9,15 +12,20 @@ my_array:
   - 2
   - 3
   - 4
-  
+
 my_hash:
   one: 1
   two: 2
-  
+
 two:
   three: 3
 
 four:
-  five: 
+  five:
     six: 6
+END_SETTINGS
 
+SETTINGS_YML = <<-END_SETTINGS
+test:
+  file: settings.yml
+END_SETTINGS

data/spec/spec_helper.rb

@@ -3,6 +3,32 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'configutron'
 require 'spec'
 require 'spec/autorun'
+require 'fake_yml_files'
 
 require 'rubygems'
-require 'active_support'
+require 'active_support'
+require 'fakefs/spec_helpers'
+
+def mock_test_yml
+  path = '/rails_root/config/settings/test.yml'
+  
+  FileUtils.mkdir_p('/rails_root/config/settings')
+  File.open(path, 'w') do |f|
+    f.puts TEST_YML
+  end
+end
+
+def mock_settings_yml
+  FileUtils.mkdir_p('/rails_root/config')
+  File.open('/rails_root/config/settings.yml', 'w') do |f|
+    f.puts SETTINGS_YML
+  end
+end
+
+def reset!
+  FileUtils.rm_rf('/rails_root')
+  
+  Configutron.instance_eval do
+    @configutron = nil
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: configutron
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors: 
 - Neal Clark
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-30 00:00:00 -08:00
+date: 2010-03-03 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,6 +42,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.2.9
     version: 
+- !ruby/object:Gem::Dependency 
+  name: fakefs
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.1
+    version: 
 description: simple app-wide settings for rails applications
 email: nclark@thrownproject.com
 executables: []
@@ -61,7 +71,7 @@ files:
 - lib/core_ext.rb
 - rails/init.rb
 - spec/configutron_spec.rb
-- spec/fake_rails_root/config/settings/development.yml
+- spec/fake_yml_files.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: true
@@ -94,4 +104,5 @@ specification_version: 3
 summary: simple app-wide settings for rails apps
 test_files: 
 - spec/configutron_spec.rb
+- spec/fake_yml_files.rb
 - spec/spec_helper.rb