configutron 0.2.0

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 neal clark
+
+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.markdown

@@ -0,0 +1,64 @@
+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.
+
+usage
+-----
+
+use the gem in your rails project:
+
+    Rails::Initializer.run do |config|
+	  config.gem 'configutron'
+	end
+
+create a folder *config/settings* and a file named after each of your rails environments:
+
+    % 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:
+
+    % ./script/console
+    Loading development environment (Rails 2.3.5)
+    >> Configutron.variable
+    => "value"
+
+name it something easier to type:
+
+    Rails::Initializer.run do |config|
+      config.gem 'configutron'
+    end
+    
+    Configutron.constant = 'App'
+
+then back in the console:
+
+    % ./script/console
+    Loading development environment (Rails 2.3.5)
+    >> App.variable
+    => "value"
+
+inspiration
+-----------
+* [Christopher J. Bottaro](http://github.com/cjbottaro/app_config/)'s app_config
+* [Brian Smith](http://swig505.com)
+
+note on patches/pull requests
+-----------------------------
+* fork the project.
+* make your feature addition or bug fix.
+* add tests for it. this is important so i don't break it in a
+  future version unintentionally.
+* commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself i can ignore when i pull)
+* send me a pull request. bonus points for topic branches.
+
+
+copyright
+---------
+copyright (c) 2010 neal clark. See LICENSE for details (MIT License).

data/Rakefile

@@ -0,0 +1,60 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "configutron"
+    gem.summary = %Q{simple app-wide settings for rails apps}
+    gem.description = %Q{simple app-wide settings for rails applications}
+    gem.email = "nclark@thrownproject.com"
+    gem.homepage = "http://github.com/nclark/configutron"
+    gem.authors = ["Neal Clark"]
+    gem.add_dependency "activesupport", ">= 0"
+    gem.add_runtime_dependency "activesupport", ">= 0"
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.files = [
+       ".gitignore",
+       "LICENSE",
+       "README.markdown",
+       "Rakefile",
+       "VERSION",
+       "lib/configutron.rb",
+       "lib/to_openstruct.rb",
+       "rails/init.rb",
+       "spec/configutron_spec.rb",
+       "spec/spec.opts",
+       "spec/spec_helper.rb",
+       "spec/fake_rails_root/config/settings/development.yml"
+    ]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION.yml') ? File.read('VERSION.yml') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "configutron #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/lib/configutron.rb

@@ -0,0 +1,24 @@
+require 'yaml'
+require 'ostruct'
+require 'core_ext'
+
+module Configutron
+  extend self
+    
+  def constant=(name)
+    Kernel.const_set(name, Configutron)
+  end
+
+  private
+  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
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require "configutron"

data/spec/configutron_spec.rb

@@ -0,0 +1,59 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+RAILS_ROOT = File.join(File.dirname(__FILE__), 'fake_rails_root')
+RAILS_ENV  = 'development'
+
+describe Configutron do
+  before do
+    @fixture_path = File.expand_path(File.dirname(__FILE__) + "/fake_rails_root/config/settings/development.yml")
+  end
+  
+  describe "module methods" do
+    describe ".constant=" do
+      it "should alias the Configutron constant to something you actually want to use" do
+        Configutron.constant = 'App'
+        Configutron.should == App
+      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
+    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.two.three.should == 3
+    end
+    
+    describe "nested settings" do
+      specify "can be accessed" do
+        Configutron.four.five.six.should == 6
+      end
+    end
+  end
+end

data/spec/fake_rails_root/config/settings/development.yml

@@ -0,0 +1,23 @@
+some_variable: some value
+
+my_string: string
+
+my_integer: 1
+
+my_array:
+  - 1
+  - 2
+  - 3
+  - 4
+  
+my_hash:
+  one: 1
+  two: 2
+  
+two:
+  three: 3
+
+four:
+  five: 
+    six: 6
+

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'configutron'
+require 'spec'
+require 'spec/autorun'
+
+require 'rubygems'
+require 'active_support'

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: configutron
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Neal Clark
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-30 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+description: simple app-wide settings for rails applications
+email: nclark@thrownproject.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- lib/configutron.rb
+- rails/init.rb
+- spec/configutron_spec.rb
+- spec/fake_rails_root/config/settings/development.yml
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/nclark/configutron
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --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.3.5
+signing_key: 
+specification_version: 3
+summary: simple app-wide settings for rails apps
+test_files: 
+- spec/configutron_spec.rb
+- spec/spec_helper.rb