configoro 1.1.0 → 1.2.0

data/.ruby-gemset

@@ -0,0 +1 @@
+configoro

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3

data/Gemfile

@@ -1,7 +1,6 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gem 'rails', '>= 3.0'
-#gem 'activesupport', '>= 3.0'
 
 group :development do
   # SPECS

data/Gemfile.lock

@@ -1,14 +1,14 @@
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    RedCloth (4.2.7)
+    RedCloth (4.2.9)
     abstract (1.0.0)
-    actionmailer (3.0.7)
-      actionpack (= 3.0.7)
-      mail (~> 2.2.15)
-    actionpack (3.0.7)
-      activemodel (= 3.0.7)
-      activesupport (= 3.0.7)
+    actionmailer (3.0.8)
+      actionpack (= 3.0.8)
+      mail (~> 2.2.19)
+    actionpack (3.0.8)
+      activemodel (= 3.0.8)
+      activesupport (= 3.0.8)
       builder (~> 2.1.2)
       erubis (~> 2.6.6)
       i18n (~> 0.5.0)
@@ -16,69 +16,74 @@ GEM
       rack-mount (~> 0.6.14)
       rack-test (~> 0.5.7)
       tzinfo (~> 0.3.23)
-    activemodel (3.0.7)
-      activesupport (= 3.0.7)
+    activemodel (3.0.8)
+      activesupport (= 3.0.8)
       builder (~> 2.1.2)
       i18n (~> 0.5.0)
-    activerecord (3.0.7)
-      activemodel (= 3.0.7)
-      activesupport (= 3.0.7)
-      arel (~> 2.0.2)
+    activerecord (3.0.8)
+      activemodel (= 3.0.8)
+      activesupport (= 3.0.8)
+      arel (~> 2.0.10)
       tzinfo (~> 0.3.23)
-    activeresource (3.0.7)
-      activemodel (= 3.0.7)
-      activesupport (= 3.0.7)
-    activesupport (3.0.7)
-    arel (2.0.9)
+    activeresource (3.0.8)
+      activemodel (= 3.0.8)
+      activesupport (= 3.0.8)
+    activesupport (3.0.8)
+    arel (2.0.10)
     builder (2.1.2)
-    diff-lcs (1.1.2)
+    diff-lcs (1.2.4)
     erubis (2.6.6)
       abstract (>= 1.0.0)
     git (1.2.5)
     i18n (0.5.0)
-    jeweler (1.6.0)
-      bundler (~> 1.0.0)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
       git (>= 1.2.5)
       rake
+      rdoc
+    json (1.7.7)
     mail (2.2.19)
       activesupport (>= 2.3.6)
       i18n (>= 0.4.0)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
-    mime-types (1.16)
-    polyglot (0.3.1)
-    rack (1.2.2)
+    mime-types (1.23)
+    polyglot (0.3.3)
+    rack (1.2.8)
     rack-mount (0.6.14)
       rack (>= 1.0.0)
     rack-test (0.5.7)
       rack (>= 1.0)
-    rails (3.0.7)
-      actionmailer (= 3.0.7)
-      actionpack (= 3.0.7)
-      activerecord (= 3.0.7)
-      activeresource (= 3.0.7)
-      activesupport (= 3.0.7)
+    rails (3.0.8)
+      actionmailer (= 3.0.8)
+      actionpack (= 3.0.8)
+      activerecord (= 3.0.8)
+      activeresource (= 3.0.8)
+      activesupport (= 3.0.8)
       bundler (~> 1.0)
-      railties (= 3.0.7)
-    railties (3.0.7)
-      actionpack (= 3.0.7)
-      activesupport (= 3.0.7)
+      railties (= 3.0.8)
+    railties (3.0.8)
+      actionpack (= 3.0.8)
+      activesupport (= 3.0.8)
       rake (>= 0.8.7)
       thor (~> 0.14.4)
-    rake (0.8.7)
-    rspec (2.5.0)
-      rspec-core (~> 2.5.0)
-      rspec-expectations (~> 2.5.0)
-      rspec-mocks (~> 2.5.0)
-    rspec-core (2.5.2)
-    rspec-expectations (2.5.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.5.0)
+    rake (10.0.4)
+    rdoc (4.0.1)
+      json (~> 1.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
     thor (0.14.6)
-    treetop (1.4.9)
+    treetop (1.4.12)
+      polyglot
       polyglot (>= 0.3.1)
-    tzinfo (0.3.27)
-    yard (0.6.8)
+    tzinfo (0.3.37)
+    yard (0.8.6.1)
 
 PLATFORMS
   ruby

data/README.textile

@@ -70,6 +70,10 @@ Configuration is stored within the @config/environments@ directory of your Rails
 app. Files ending in ".yml" are loaded from the @common/@ subdirectory and a
 subdirectory named after the current environment.
 
+Configuration files are preprocessed as ERB, in the same way that Rails
+preprocesses @config/database.yml@. This allows dynamic configuration,
+e.g. @host: <%= ENV["DB_HOST"] || "localhost" %>@.
+
 Each file goes into its own hash in the configuration. For example, if you
 placed a file called @memcache.yml@ within @config/environments/development@,
 you would be able to access your Memcache timeout using

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.2.0

data/configoro.gemspec

@@ -4,14 +4,14 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{configoro}
-  s.version = "1.1.0"
+  s.name = "configoro"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = [%q{Tim Morgan}]
-  s.date = %q{2011-05-09}
-  s.description = %q{Creates a YourApp::Configuration object whose methods are generated from environment-specific YAML files.}
-  s.email = %q{git@timothymorgan.info}
+  s.authors = ["Tim Morgan"]
+  s.date = "2013-04-25"
+  s.description = "Creates a YourApp::Configuration object whose methods are generated from environment-specific YAML files."
+  s.email = "git@timothymorgan.info"
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.textile"
@@ -19,6 +19,8 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
     ".rspec",
+    ".ruby-gemset",
+    ".ruby-version",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
@@ -34,17 +36,20 @@ Gem::Specification.new do |s|
     "spec/configoro/hash_spec.rb",
     "spec/configoro_spec.rb",
     "spec/data/config/environments/common/basic.yml",
+    "spec/data/config/environments/common/erb_test.yml",
     "spec/data/config/environments/common/hash_test.yml",
     "spec/data/config/environments/development/basic.yml",
     "spec/data/config/environments/development/hash_test.yml",
     "spec/data/config/environments/production/basic.yml",
+    "spec/data/other/common/basic.yml",
+    "spec/data/other/development/basic.yml",
     "spec/spec_helper.rb"
   ]
-  s.homepage = %q{http://github.com/RISCfuture/configoro}
-  s.licenses = [%q{MIT}]
-  s.require_paths = [%q{lib}]
-  s.rubygems_version = %q{1.8.1}
-  s.summary = %q{Configuration object and YAML-based storage for Rails apps}
+  s.homepage = "http://github.com/RISCfuture/configoro"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.25"
+  s.summary = "Configuration object and YAML-based storage for Rails apps"
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

data/lib/configoro.rb

@@ -1,5 +1,6 @@
 raise "Configoro must be used in the context of a Rails 3 application" unless defined?(Rails)
 
+require 'erb'
 require 'yaml'
 require 'bundler'
 Bundler.setup

data/lib/configoro/base.rb

@@ -14,21 +14,57 @@ module Configoro
   # @MyApp::Configuration@ (assuming an application named @MyApp@).
 
   def self.initialize
-    namespace.const_set :Configuration, build_hash(Rails.env)
+    namespace.const_set :Configuration, load_environment(Rails.env)
   end
 
-  private
+  # The search paths Configoro uses to locate configuration files. By default
+  # this list contains one item, `RAILS_ROOT/config/environments`. You can edit
+  # this list to add your own search paths. Any such paths should have
+  # subdirectories for each environment, and `common`, as expected by Configoro.
+  #
+  # Be sure to add paths before the Configoro initializer is called (see the
+  # example).
+  #
+  # Paths are processed in the order they appear in this array.
+  #
+  # @return [Array<String>] An editable array of search paths.
+  #
+  # @example Adding additional paths (application.rn)
+  #   config.before_initialize do
+  #     Configoro.paths << '/my/custom/path'
+  #   end
 
-  def self.build_hash(env)
-    config = Hash.new
+  def self.paths
+    @paths ||= begin
+      paths = []
+      paths << "#{Rails.root}/config/environments" if defined?(Rails)
+      paths
+    end
+  end
 
-    load_data config, 'common'
-    load_data config, env
+  # Loads the configuration for an environment and returns it as a {Hash}. Use
+  # this method to access Configoro options outside the context of your Rails
+  # app. You will need to configure paths first (see example).
+  #
+  # @param [String] env The Rails environment.
+  # @return [Configoro::Hash] The configuration for that environment.
+  #
+  # @example Accessing Configoro options outside of Rails
+  #   Configoro.paths << "#{rails_root}/config/environments"
+  #   Configoro.load_environment(rails_env) #=> { ... }
 
+  def self.load_environment(env)
+    config = Hash.new
+    load_data config, env
     config
   end
 
+  private
+
   def self.load_data(config, env)
-    Dir.glob("#{Rails.root}/config/environments/#{env}/*.yml").sort.each { |file| config << file }
+    paths.each do |path|
+      Dir.glob("#{path}/common/*.yml").sort.each { |file| config << file }
+      Dir.glob("#{path}/#{env}/*.yml").sort.each { |file| config << file }
+    end
   end
 end

data/lib/configoro/hash.rb

@@ -30,7 +30,7 @@ class Configoro::Hash < HashWithIndifferentAccess
       when String
         raise ArgumentError, "Only files ending in .yml can be added" unless File.extname(hsh_or_path) == '.yml'
         return self unless File.exist?(hsh_or_path)
-        data = YAML.load_file(hsh_or_path)
+        data = load_preprocessed_yaml(hsh_or_path)
         deep_merge! File.basename(hsh_or_path, ".yml") => data
       when ::Hash
         deep_merge! hsh_or_path
@@ -146,4 +146,9 @@ class Configoro::Hash < HashWithIndifferentAccess
 
     raise NameError, "undefined local variable or method `#{meth}' for #{self.inspect}"
   end
+
+  def load_preprocessed_yaml(path)
+    YAML.load(ERB.new(IO.read(path)).result)
+  end
+
 end

data/spec/configoro/hash_spec.rb

@@ -95,6 +95,11 @@ describe Configoro::Hash do
       subject << "example.yml"
       subject.should be_empty
     end
+
+    it "should preprocess YAML file as ERB" do
+      subject << "#{File.dirname __FILE__}/../data/config/environments/common/erb_test.yml"
+      subject.erb_test.sum.should == 2
+    end
   end
 
   describe "#deep_merge!" do

data/spec/configoro_spec.rb

@@ -34,7 +34,25 @@ describe Configoro do
     it "should not complain when there is no directory for the current environment" do
       Rails.stub!(:env).and_return('unknown')
       Configoro.initialize
-      MyApp::Configuration.should eql({"basic"=>{"common_only"=>"common", "env_name"=>"common"}, "hash_test"=>{"akey"=>"value", "subhash"=>{"key1"=>"val1", "key2"=>"val2"}}})
+      MyApp::Configuration.should eql({"basic"=>{"common_only"=>"common", "env_name"=>"common"}, "erb_test" => {"sum" => 2}, "hash_test"=>{"akey"=>"value", "subhash"=>{"key1"=>"val1", "key2"=>"val2"}}})
+    end
+
+    context "[custom search paths]" do
+      before(:each) { Configoro.instance_variable_set :@paths, nil }
+
+      it "should use common configuration under a custom search path" do
+        Rails.stub!(:env).and_return('unknown')
+        Configoro.paths << File.join(File.dirname(__FILE__), 'data', 'other')
+        Configoro.initialize
+        MyApp::Configuration.basic.env_name.should eql('other_common')
+      end
+
+      it "should use environment-specific configuration under a custom search path" do
+        Rails.stub!(:env).and_return('development')
+        Configoro.paths << File.join(File.dirname(__FILE__), 'data', 'other')
+        Configoro.initialize
+        MyApp::Configuration.basic.env_name.should eql('other_development')
+      end
     end
   end
 end

data/spec/data/config/environments/common/erb_test.yml

@@ -0,0 +1,2 @@
+---
+sum: <%= 1 + 1 %>

data/spec/data/other/common/basic.yml

@@ -0,0 +1,2 @@
+--- 
+env_name: other_common

data/spec/data/other/development/basic.yml

@@ -0,0 +1,2 @@
+--- 
+env_name: other_development

metadata

@@ -1,95 +1,125 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: configoro
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 1.2.0
   prerelease: 
-  version: 1.1.0
 platform: ruby
-authors: 
+authors:
 - Tim Morgan
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-09 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rails
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "3.0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: yard
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: RedCloth
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id006
-description: Creates a YourApp::Configuration object whose methods are generated from environment-specific YAML files.
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Creates a YourApp::Configuration object whose methods are generated from
+  environment-specific YAML files.
 email: git@timothymorgan.info
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE.txt
 - README.textile
-files: 
+files:
 - .document
 - .rspec
+- .ruby-gemset
+- .ruby-version
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -105,40 +135,40 @@ files:
 - spec/configoro/hash_spec.rb
 - spec/configoro_spec.rb
 - spec/data/config/environments/common/basic.yml
+- spec/data/config/environments/common/erb_test.yml
 - spec/data/config/environments/common/hash_test.yml
 - spec/data/config/environments/development/basic.yml
 - spec/data/config/environments/development/hash_test.yml
 - spec/data/config/environments/production/basic.yml
+- spec/data/other/common/basic.yml
+- spec/data/other/development/basic.yml
 - spec/spec_helper.rb
 homepage: http://github.com/RISCfuture/configoro
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3499907636224046396
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -4443263758316120902
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.1
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Configuration object and YAML-based storage for Rails apps
 test_files: []
-