rails_config 0.1.0 → 0.1.3

data/Gemfile

@@ -1,5 +1,6 @@
 source 'http://rubygems.org'
 
+gem "activesupport", ">= 3.0.0.rc"
 gem "rspec", ">= 2.0.0.beta.19"
 gem 'autotest'
 gem "growl-glue"

data/Gemfile.lock

@@ -1,6 +1,7 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    activesupport (3.0.0.rc)
     autotest (4.3.2)
     columnize (0.3.1)
     diff-lcs (1.1.2)
@@ -24,6 +25,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  activesupport (>= 3.0.0.rc)
   autotest
   growl-glue
   rspec (>= 2.0.0.beta.19)

data/README.md

@@ -0,0 +1,111 @@
+## Summary
+
+RailsConfig helps you easily manage environment specific Rails settings in an easy and usable manner
+
+## Features
+
+* simple YAML config files
+* config files support ERB
+* config files support inheritance
+* access config information via convenient object member notation
+
+## Compatibility
+
+* Rails 3.0
+
+For older versions of Rails and other Ruby apps, use [AppConfig](http://github.com/fredwu/app_config).
+
+## Installing on Rails 3
+
+Add this to your `Gemfile`:
+
+    gem "rails_config"
+
+## Customizing RailsConfig
+
+You may customize the behavior of RailsConfig by generating an initializer file:
+
+    rails g rails_config
+
+This will generate `config/initializers/rails_config.rb` with a set of default settings.
+
+## Accessing the Settings object
+
+After installing this plugin, the Settings object will be global available. Entries are accessed via object member notation:
+
+    Settings.my_config_entry
+
+Nested entries are supported:
+
+    Settings.my_section.some_entry
+
+If you have set a different constant name for the object in the initializer file, use that instead.
+
+## Common config file
+
+Config entries are compiled from
+
+    config/settings.yml
+    config/settings/#{environment}.yml
+    config/environments/#{environment}.yml
+
+settings defined in files that are lower in the list override settings higher
+
+### Reloading config files
+
+You can reload the Settings from file at any time by running Settings.reload!
+
+### Environment specific config files
+
+You can have environment specific config files.  Environment specific config entries take precedence over common config entries.
+
+Example development environment config file:
+
+    #{Rails.root}/config/environments/development.yml
+
+Example production environment config file:
+
+    #{Rails.root}/config/environments/production.yml
+
+## Embedded Ruby (ERB)
+
+Embedded Ruby is allowed in the configuration files.  See examples below.
+
+## Accessing Configuration Settings
+
+Consider the two following config files.
+
+    # #{Rails.root}/config/settings.yml:
+    size: 1
+    server: google.com
+
+    # #{Rails.root}/config/environments/development.yml:
+    size: 2
+    computed: <%= 1 + 2 + 3 %>
+    section:
+      size: 3
+      servers: [ {name: yahoo.com}, {name: amazon.com} ]
+
+Notice that the environment specific config entries overwrite the common entries.
+
+    Settings.size   # => 2
+    Settings.server # => google.com
+
+Notice the embedded Ruby.
+
+    Settings.computed # => 6
+
+Notice that object member notation is maintained even in nested entries.
+
+    Settings.section.size # => 3
+
+Notice array notation and object member notation is maintained.
+
+    Settings.section.servers[0].name # => yahoo.com
+    Settings.section.servers[1].name # => amazon.com
+
+## Authors
+
+* [Jacques Crocker](http://github.com/railsjedi)
+* [Fred Wu](http://github.com/fredwu)
+* Inherited from [AppConfig](http://github.com/cjbottaro/app_config) by [Christopher J. Bottaro](http://github.com/cjbottaro)

data/Rakefile

@@ -5,13 +5,13 @@ begin
   Jeweler::Tasks.new do |s|
     s.name = "rails_config"
     s.summary = "provides an Settings for rails3 that reads config/settings.yml"
-    s.email = "railsjedi@gmail.com"
     s.homepage = "http://github.com/railsjedi/rails_config"
     s.description = "Provides an easy to use Application Configuration object"
     s.authors = ["Jacques Crocker", "Fred Wu"]
+    s.email = ["railsjedi@gmail.com", "ifredwu@gmail.com"]
     s.files =  FileList["[A-Z]*", "{bin,generators,lib,spec}/**/*"]
 
-    s.add_dependency 'active_support', ">=3.0.0.rc"
+    s.add_dependency 'activesupport', ">=3.0.0.rc"
     s.add_development_dependency 'rspec', ">=2.0.0.beta.19"
 
   end

data/TODO

@@ -1,5 +1,3 @@
-- Remove OStruct and use ActiveSupport::OrderedOptions instead (adds dependency to active_support 3.0)
-
 - Add generator `rails_config:install` to create the default setting files
   - config/settings.yml
   - config/settings/development.yml
@@ -8,7 +6,9 @@
 
 - Add generator `rails_config:override` that creates an config/rails_config.rb initializer and disables the default initialzer
 
-
 DONE:
 - Add a Rails before_filter that triggers Settings.reload! for each development request
 - Allow user to customize the name of the global setting object (Settings)
+- Abstract OpenStruct to RailsConfig::Options
+- Add ability to define multiple sources (Start with YAMLSource)
+

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.3

data/lib/rails_config.rb

@@ -1,18 +1,17 @@
 require 'active_support/core_ext/module/attribute_accessors'
-require 'pathname'
-require 'ostruct'
-require 'yaml'
-require 'erb'
+require 'rails_config/options'
+
+require "rails_config/sources/yaml_source"
 
 require 'rails_config/vendor/deep_merge' unless defined?(DeepMerge)
 
 module RailsConfig
   # ensures the setup only gets run once
   @@_ran_once = false
-  
+
   mattr_accessor :const_name
   @@const_name = "Settings"
-  
+
   def self.setup
     yield self if @@_ran_once == false
     @@_ran_once = true
@@ -23,53 +22,19 @@ module RailsConfig
     @@load_paths
   end
 
-  # Create a config object (OpenStruct) from a yaml file.  If a second yaml file is given, then the sections of that file will overwrite the sections
+  # Create a populated Options instance from a yaml file.  If a second yaml file is given, then the sections of that file will overwrite the sections
   # if the first file if they exist in the first file.
   def self.load_files(*files)
-    config = OpenStruct.new
-
-    @@load_paths = [files].flatten.compact.uniq
-    # add singleton method to our Settings that reloads its settings from the load_paths
-    def config.reload!
-
-      conf = {}
-      RailsConfig.load_paths.to_a.each do |path|
-        file_conf = YAML.load(ERB.new(IO.read(path.to_s)).result) if path and File.exists?(path.to_s)
-        next unless file_conf
+    config = Options.new
 
-        if conf.size > 0
-          DeepMerge.deep_merge!(file_conf, conf, :preserve_unmergeables => false)
-        else
-          conf = file_conf
-        end
-      end
-
-      # load all the new values into the openstruct
-      marshal_load(RailsConfig.convert(conf).marshal_dump)
-
-      return self
+    # add yaml sources
+    [files].flatten.compact.uniq.each do |file|
+      config.add_source!(Sources::YAMLSource.new(file))
     end
-
-    config.reload!
+    config.load!
     return config
   end
 
-  # Recursively converts Hashes to OpenStructs (including Hashes inside Arrays)
-  def self.convert(h) #:nodoc:
-    s = OpenStruct.new
-    h.each do |k, v|
-      s.new_ostruct_member(k)
-      if v.is_a?(Hash)
-        s.send( (k+'=').to_sym, convert(v))
-      elsif v.is_a?(Array)
-        converted_array = v.collect { |e| e.instance_of?(Hash) ? convert(e) : e }
-        s.send("#{k}=".to_sym, converted_array)
-      else
-        s.send("#{k}=".to_sym, v)
-      end
-    end
-    s
-  end
 end
 
 # add railtie

data/lib/rails_config/options.rb

@@ -0,0 +1,61 @@
+require 'ostruct'
+module RailsConfig
+  class Options < OpenStruct
+
+    def empty?
+      marshal_dump.empty?
+    end
+
+    def add_source!(source)
+      @config_sources ||= []
+      @config_sources << source
+    end
+
+    def load!
+      reload!
+    end
+
+    # look through all our sources and rebuild the configuration
+    def reload!
+      conf = {}
+      @config_sources.each do |source|
+        source_conf = source.load
+
+        if conf.empty?
+          conf = source_conf
+        else
+          DeepMerge.deep_merge!(source_conf, conf, :preserve_unmergeables => false)
+        end
+      end
+
+      # swap out the contents of the OStruct with a hash (need to recursively convert)
+      marshal_load(__convert(conf).marshal_dump)
+
+      return self
+    end
+
+    alias :load! :reload!
+
+    protected
+
+    # Recursively converts Hashes to Options (including Hashes inside Arrays)
+    def __convert(h) #:nodoc:
+      s = self.class.new
+      unless h.is_a?(Hash)
+        require 'ruby-debug';debugger
+      end
+      h.each do |k, v|
+        s.new_ostruct_member(k)
+        if v.is_a?(Hash)
+          s.send( (k+'=').to_sym, __convert(v))
+        elsif v.is_a?(Array)
+          converted_array = v.collect { |e| e.instance_of?(Hash) ? __convert(e) : e }
+          s.send("#{k}=".to_sym, converted_array)
+        else
+          s.send("#{k}=".to_sym, v)
+        end
+      end
+      s
+    end
+  end
+end

data/lib/rails_config/sources/yaml_source.rb

@@ -0,0 +1,24 @@
+require 'yaml'
+require 'erb'
+
+module RailsConfig
+  module Sources
+    class YAMLSource
+
+      attr_accessor :path
+
+      def initialize(path)
+        @path = path
+      end
+
+      # returns a config hash from the YML file
+      def load
+        if @path and File.exists?(@path.to_s)
+          result = YAML.load(ERB.new(IO.read(@path.to_s)).result)
+        end
+        result || {}
+      end
+
+    end
+  end
+end

data/spec/rails_config_spec.rb

@@ -17,24 +17,24 @@ describe RailsConfig do
 
   it "should load empty config for a missing file path" do
     config = RailsConfig.load_files(setting_path("some_file_that_doesnt_exist.yml"))
-    config.should == OpenStruct.new
+    config.should be_empty
   end
 
   it "should load an empty config for multiple missing file paths" do
     files = [setting_path("doesnt_exist1.yml"), setting_path("doesnt_exist2.yml")]
     config = RailsConfig.load_files(files)
-    config.should == OpenStruct.new
+    config.should be_empty
   end
 
   it "should load empty config for an empty setting file" do
     config = RailsConfig.load_files(setting_path("empty1.yml"))
-    config.should == OpenStruct.new
+    config.should be_empty
   end
 
   it "should load an empty config for multiple missing file paths" do
     files = [setting_path("empty1.yml"), setting_path("empty2.yml")]
     config = RailsConfig.load_files(files)
-    config.should == OpenStruct.new
+    config.should be_empty
   end
 
   it "should allow overrides" do
@@ -107,7 +107,7 @@ describe RailsConfig do
     it "should have the default settings constant as 'Settings'" do
       RailsConfig.const_name.should == "Settings"
     end
-    
+
     it "should be able to assign a different settings constant" do
       RailsConfig.setup{ |config| config.const_name = "Settings2" }
       RailsConfig.const_name.should == "Settings2"

data/spec/sources/yaml_source_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+module RailsConfig::Sources
+  describe YAMLSource do
+
+    it "should take a path as initializer" do
+      source = YAMLSource.new "somepath"
+      source.path.should == "somepath"
+    end
+
+    context "basic yml file" do
+      let(:source) do
+        YAMLSource.new setting_path("development.yml")
+      end
+
+      it "should properly read the settings" do
+        results = source.load
+        results["size"].should == 2
+      end
+
+      it "should properly read nested settings" do
+        results = source.load
+        results["section"]["size"].should == 3
+        results["section"]["servers"].should be_an(Array)
+        results["section"]["servers"].size.should == 2
+      end
+    end
+
+    context "yml file with erb tags" do
+      let(:source) do
+        YAMLSource.new setting_path("with_erb.yml")
+      end
+
+      it "should properly evaluate the erb" do
+        results = source.load
+        results["computed"].should == 6
+      end
+
+      it "should properly evaluate the nested erb settings" do
+        results = source.load
+        results["section"]["computed1"].should == 1
+        results["section"]["computed2"].should == 2
+      end
+    end
+
+    context "missing yml file" do
+      let(:source) do
+        YAMLSource.new "somewhere_that_doesnt_exist.yml"
+      end
+
+      it "should return an empty hash" do
+        results = source.load
+        results.should == {}
+      end
+    end
+
+    context "blank yml file" do
+      let(:source) do
+        YAMLSource.new setting_path("empty1.yml")
+      end
+
+      it "should return an empty hash" do
+        results = source.load
+        results.should == {}
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 require 'rails_config'
+require 'pathname'
 require "bundler"
 Bundler.setup
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rails_config
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 29
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - Jacques Crocker
@@ -20,7 +20,7 @@ date: 2010-08-10 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: active_support
+  name: activesupport
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
@@ -55,27 +55,31 @@ dependencies:
   type: :development
   version_requirements: *id002
 description: Provides an easy to use Application Configuration object
-email: railsjedi@gmail.com
+email: 
+- railsjedi@gmail.com
+- ifredwu@gmail.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README
+- README.md
 - TODO
 files: 
 - Gemfile
 - Gemfile.lock
 - LICENSE
-- README
+- README.md
 - Rakefile
 - TODO
 - VERSION
 - lib/generators/rails_config_generator.rb
 - lib/generators/templates/rails_config.rb
 - lib/rails_config.rb
+- lib/rails_config/options.rb
 - lib/rails_config/railtie.rb
+- lib/rails_config/sources/yaml_source.rb
 - lib/rails_config/vendor/deep_merge.rb
 - spec/fixtures/bool_override/config1.yml
 - spec/fixtures/bool_override/config2.yml
@@ -90,6 +94,7 @@ files:
 - spec/fixtures/settings2.yml
 - spec/fixtures/with_erb.yml
 - spec/rails_config_spec.rb
+- spec/sources/yaml_source_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/railsjedi/rails_config
@@ -127,4 +132,5 @@ specification_version: 3
 summary: provides an Settings for rails3 that reads config/settings.yml
 test_files: 
 - spec/rails_config_spec.rb
+- spec/sources/yaml_source_spec.rb
 - spec/spec_helper.rb

data/README

@@ -1,72 +0,0 @@
-== Summary
-RailsConfig helps you easily manage environment specific Rails settings in an easy and usable manner
-
-== Author
-Jacques Crocker
-Modified from Original Project (AppConfig by Christopher J. Bottaro)
-
-=== Compatibility
-Rails 3.0
-
-=== Installing on Rails 3
-
-add this to your Gemfile
-
-    gem "rails_config"
-
-=== Accessing the Settings object
-After installing this plugin, the Settings object will be global available.  Entries are accessed via object member notation:
- Settings.my_config_entry
-Nested entries are supported:
- Settings.my_section.some_entry
-
-=== Common config file
-Config entries are compiled from
- config/settings.yml
- config/settings/#{environment}.yml
- config/environments/#{environment}.yml
-
-settings defined in files that are lower in the list override settings higher
-
-=== Reloading config files
-You can reload the Settings from file at any time by running Settings.reload!
-
-=== Environment specific config files
-You can have environment specific config files.  Environment specific config entries take precedence over common config entries.
-
-Example development environment config file:
- #{Rails.root}/config/environments/development.yml
-
-Example production environment config file:
- #{Rails.root}/config/environments/production.yml
-
-=== Embedded Ruby (ERB)
- Embedded Ruby is allowed in the configuration files.  See examples below.
-
-=== Accessing Configuration Settings
-Consider the two following config files.
-
-#{Rails.root}/config/settings.yml:
- size: 1
- server: google.com
-
-#{Rails.root}/config/environments/development.yml:
- size: 2
- computed: <%= 1 + 2 + 3 %>
- section:
-   size: 3
-   servers: [ {name: yahoo.com}, {name: amazon.com} ]
-
-Notice that the environment specific config entries overwrite the common entries.
- Settings.size -> 2
- Settings.server -> google.com
-
-Notice the embedded Ruby.
- Settings.computed -> 6
-
-Notice that object member notation is maintained even in nested entries.
- Settings.section.size -> 3
-
-Notice array notation and object member notation is maintained.
- Settings.section.servers[0].name -> yahoo.com
- Settings.section.servers[1].name -> amazon.com