rails_config 0.0.5 → 0.0.6

data/TODO

@@ -0,0 +1,10 @@
+- 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)
+- Add generator `rails_config:install` to create the default setting files
+  - config/settings.yml
+  - config/settings/development.yml
+  - config/settings/test.yml
+  - config/settings/production.yml
+
+- Remove OStruct and create a custom implementation (return proxy obj)
+

data/VERSION

@@ -1 +1 @@
-0.0.5
+0.0.6

data/lib/rails_config/railtie.rb

@@ -1,13 +1,15 @@
 if defined?(Rails::Railtie)
   module RailsConfig
     class Railtie < Rails::Railtie
-      initializer :setup_rails_config do
-        ::Settings = RailsConfig::SettingBuilder.load_files(
+
+      ActiveSupport.on_load :before_initialize, :yield => true do
+        ::Settings = RailsConfig.load_files(
           Rails.root.join("config", "settings.yml").to_s,
           Rails.root.join("config", "settings", "#{Rails.env}.yml").to_s,
           Rails.root.join("config", "environments", "#{Rails.env}.yml").to_s
         )
       end
+
     end
   end
 end

data/lib/rails_config.rb

@@ -1,5 +1,65 @@
-require 'rails_config/vendor/deep_merge' unless defined?(DeepMerge)
 require 'pathname'
+require 'ostruct'
+require 'yaml'
+require 'erb'
+
+require 'rails_config/vendor/deep_merge' unless defined?(DeepMerge)
+
+module RailsConfig
+
+  @@load_paths = []
+  def self.load_paths
+    @@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
+  # 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
+
+        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
+    end
+
+    config.reload!
+    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
 
-require 'rails_config/setting_builder'
+# add railtie
 require 'rails_config/railtie'

data/spec/rails_config_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper'
+
+describe RailsConfig do
+
+  it "should load a basic config file" do
+    config = RailsConfig.load_files(setting_path("settings.yml"))
+    config.size.should == 1
+    config.server.should == "google.com"
+  end
+
+  it "should load 2 basic config files" do
+    config = RailsConfig.load_files(setting_path("settings.yml"), setting_path("settings2.yml"))
+    config.size.should == 1
+    config.server.should == "google.com"
+    config.another.should == "something"
+  end
+
+  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
+  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
+  end
+
+  it "should load empty config for an empty setting file" do
+    config = RailsConfig.load_files(setting_path("empty1.yml"))
+    config.should == OpenStruct.new
+  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
+  end
+
+  it "should allow overrides" do
+    files = [setting_path("settings.yml"), setting_path("development.yml")]
+    config = RailsConfig.load_files(files)
+    config.server.should == "google.com"
+    config.size.should == 2
+  end
+
+  context "Nested Settings" do
+    let(:config) do
+      RailsConfig.load_files(setting_path("development.yml"))
+    end
+
+    it "should allow nested sections" do
+      config.section.size.should == 3
+    end
+
+    it "should allow configuration collections (arrays)" do
+      config.section.servers[0].name.should == "yahoo.com"
+      config.section.servers[1].name.should == "amazon.com"
+    end
+  end
+
+  context "Settings with ERB tags" do
+    let(:config) do
+      RailsConfig.load_files(setting_path("with_erb.yml"))
+    end
+
+    it "should evaluate ERB tags" do
+      config.computed.should == 6
+    end
+
+    it "should evaluated nested ERB tags" do
+      config.section.computed1.should == 1
+      config.section.computed2.should == 2
+    end
+  end
+
+  context "Deep Merging" do
+    let(:config) do
+      files = [setting_path("deep_merge/config1.yml"), setting_path("deep_merge/config2.yml")]
+      RailsConfig.load_files(files)
+    end
+
+    it "should merge hashes from multiple configs" do
+      config.inner.marshal_dump.keys.size.should == 3
+      config.inner2.inner2_inner.marshal_dump.keys.size.should == 3
+    end
+
+    it "should merge arrays from multiple configs" do
+      config.arraylist1.size.should == 6
+      config.arraylist2.inner.size.should == 6
+    end
+  end
+
+  context "Boolean Overrides" do
+    let(:config) do
+      files = [setting_path("bool_override/config1.yml"), setting_path("bool_override/config2.yml")]
+      RailsConfig.load_files(files)
+    end
+
+    it "should allow overriding of bool settings" do
+      config.override_bool.should == false
+      config.override_bool_opposite.should == true
+    end
+  end
+
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rails_config
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Jacques Crocker
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-08 00:00:00 -07:00
+date: 2010-08-10 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -45,16 +45,17 @@ extensions: []
 extra_rdoc_files: 
 - LICENSE
 - README
+- TODO
 files: 
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README
 - Rakefile
+- TODO
 - VERSION
 - lib/rails_config.rb
 - lib/rails_config/railtie.rb
-- lib/rails_config/setting_builder.rb
 - lib/rails_config/vendor/deep_merge.rb
 - spec/fixtures/bool_override/config1.yml
 - spec/fixtures/bool_override/config2.yml
@@ -68,7 +69,7 @@ files:
 - spec/fixtures/settings.yml
 - spec/fixtures/settings2.yml
 - spec/fixtures/with_erb.yml
-- spec/rails_config/setting_builder_spec.rb
+- spec/rails_config_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/railsjedi/rails_config
@@ -105,5 +106,5 @@ signing_key:
 specification_version: 3
 summary: provides an Settings for rails3 that reads config/settings.yml
 test_files: 
-- spec/rails_config/setting_builder_spec.rb
+- spec/rails_config_spec.rb
 - spec/spec_helper.rb

data/lib/rails_config/setting_builder.rb

@@ -1,61 +0,0 @@
-require 'ostruct'
-require 'yaml'
-require 'erb'
-
-module RailsConfig
-  module SettingBuilder
-    @@load_paths = []
-
-    # 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
-    # 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 = {}
-        SettingBuilder.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
-
-          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::SettingBuilder.convert(conf).marshal_dump)
-
-        return self
-      end
-
-      config.reload!
-      return config
-    end
-
-    def self.load_paths
-      @@load_paths
-    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
-end

data/spec/rails_config/setting_builder_spec.rb

@@ -1,109 +0,0 @@
-require 'spec_helper'
-
-module RailsConfig
-  describe SettingBuilder do
-
-    it "should load a basic config file" do
-      config = SettingBuilder.load_files(setting_path("settings.yml"))
-      config.size.should == 1
-      config.server.should == "google.com"
-    end
-
-    it "should load 2 basic config files" do
-      config = SettingBuilder.load_files(setting_path("settings.yml"), setting_path("settings2.yml"))
-      config.size.should == 1
-      config.server.should == "google.com"
-      config.another.should == "something"
-    end
-
-    it "should load empty config for a missing file path" do
-      config = SettingBuilder.load_files(setting_path("some_file_that_doesnt_exist.yml"))
-      config.should == OpenStruct.new
-    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 = SettingBuilder.load_files(files)
-      config.should == OpenStruct.new
-    end
-
-    it "should load empty config for an empty setting file" do
-      config = SettingBuilder.load_files(setting_path("empty1.yml"))
-      config.should == OpenStruct.new
-    end
-
-    it "should load an empty config for multiple missing file paths" do
-      files = [setting_path("empty1.yml"), setting_path("empty2.yml")]
-      config = SettingBuilder.load_files(files)
-      config.should == OpenStruct.new
-    end
-
-    it "should allow overrides" do
-      files = [setting_path("settings.yml"), setting_path("development.yml")]
-      config = SettingBuilder.load_files(files)
-      config.server.should == "google.com"
-      config.size.should == 2
-    end
-
-    context "Nested Settings" do
-      let(:config) do
-        SettingBuilder.load_files(setting_path("development.yml"))
-      end
-
-      it "should allow nested sections" do
-        config.section.size.should == 3
-      end
-
-      it "should allow configuration collections (arrays)" do
-        config.section.servers[0].name.should == "yahoo.com"
-        config.section.servers[1].name.should == "amazon.com"
-      end
-    end
-
-    context "Settings with ERB tags" do
-      let(:config) do
-        SettingBuilder.load_files(setting_path("with_erb.yml"))
-      end
-
-      it "should evaluate ERB tags" do
-        config.computed.should == 6
-      end
-
-      it "should evaluated nested ERB tags" do
-        config.section.computed1.should == 1
-        config.section.computed2.should == 2
-      end
-    end
-
-    context "Deep Merging" do
-      let(:config) do
-        files = [setting_path("deep_merge/config1.yml"), setting_path("deep_merge/config2.yml")]
-        SettingBuilder.load_files(files)
-      end
-
-      it "should merge hashes from multiple configs" do
-        config.inner.marshal_dump.keys.size.should == 3
-        config.inner2.inner2_inner.marshal_dump.keys.size.should == 3
-      end
-
-      it "should merge arrays from multiple configs" do
-        config.arraylist1.size.should == 6
-        config.arraylist2.inner.size.should == 6
-      end
-    end
-
-    context "Boolean Overrides" do
-      let(:config) do
-        files = [setting_path("bool_override/config1.yml"), setting_path("bool_override/config2.yml")]
-        SettingBuilder.load_files(files)
-      end
-
-      it "should allow overriding of bool settings" do
-        config.override_bool.should == false
-        config.override_bool_opposite.should == true
-      end
-    end
-
-
-  end
-end