scotch-app_config 1.4 → 1.5

data/README.rdoc

@@ -1,75 +1,40 @@
-Conf## Summary
-
-Application level configuration.
-
-## Author
-
-Christopher J. Bottaro
-
-### Accessing the Conf object
-
-After installing this plugin, the Conf object will be global available.  Entries are accessed via object member notation:
-
-	Conf.my_config_entry
-	
-Nested entries are supported:
-
-	Conf.my_section.some_entry
-
-### Common config file
-
-Config entries defined in
-
-	RAILS_ROOT/config/app_config.yml
-	
-will be available to all environments.
-
-### 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 f=ile:
-
-	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.
-
-### Examples
-
-Consider the two following config files.
-
-RAILS\_ROOT/config/app\_config.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.
-
-	Conf.size -> 2
-	Conf.server -> google.com
-
-Notice the embedded Ruby.
-
-	Conf.computed -> 6
-
-Notice that object member notation is maintained even in nested entries.
-
-	Conf.section.size -> 3
-
-Notice array notation and object member notation is maintained.
-
-	Conf.section.servers[0].name -> yahoo.com
-	Conf.section.servers[1].name -> amazon.com
+= AppConfig
+
+It allows to have a file (config/config.yml) with application configuration parameters.
+It should have a "common" section with all parameters along with default values and can also
+contain a section for each of the rails environments (development, test, production, or 
+your custom one). The values from the current environment section will override the values in the 
+"common" section.
+
+If some developer needs his own specific values for his working copy, he can simply create 
+a config/config.local.yml file and override any value there, again having a "common" section 
+and a section for each environment. 
+
+Nothing is mandatory (files, sections) -- you just have what you really need. The files are parsed with ERB,
+so they can contain some Ruby
+
+== Example usage
+
+  common:
+    admin_email: admin@domain.com
+    xml_rpc_url: http://domain.com:8000/
+    media_path: <%= RAILS_ROOT %>/tmp/media
+
+  development:
+    xml_rpc_url: http://localhost:8000/
+
+  test:
+    xml_rpc_url: http://localhost:8008/
+
+Then, in the application you can use the config parameters like this:
+
+  #{Conf.site_url}
+
+So it means that you've got a Config object which holds all the configuration parameters defined. 
+It doesn't allow to change the values in the application code, BTW.
+
+== Authors and credits
+
+Authors::      Eugene Bolshakov, 
+Site URL::     http://www.taknado.com
+Based on::     http://kpumuk.info/ruby-on-rails/flexible-application-configuration-in-ruby-on-rails/lang-pref/en/

data/app_config.gemspec

@@ -1,18 +1,17 @@
 Gem::Specification.new do |s|
   s.name = 'app_config'
-  s.version = '1.4'
+  s.version = '1.5'
   s.date = '2008-09-03'
   
   s.summary = "Application level configuration"
   s.description = "Allow application wide configuration settings via YML files"
   
-  s.authors = ['RailsJedi', 'Christopher J. Bottaro']
-  s.email = 'railsjedi@gmail.com'
+  s.authors = ['Eugene Bolshakov']
   s.homepage = 'http://github.com/scotch/app_config'
   
   s.has_rdoc = true
   s.rdoc_options = ["--main", "README"]
-  s.extra_rdoc_files = ["README"]
+  s.extra_rdoc_files = ["README.rdoc"]
 
   s.add_dependency 'rails', ['>= 2.1']
   
@@ -23,10 +22,6 @@ Gem::Specification.new do |s|
              "lib/app_config.rb",
              "rails/init.rb"]
   
-  s.test_files = ["test/app_config.yml",
-                  "test/app_config_test.rb",
-                  "test/development.yml",
-                  "test/empty1.yml",
-                  "test/empty2.yml"]
+  s.test_files = ["test/app_config_test.rb"]
 
 end

data/lib/app_config.rb

@@ -1,47 +1,33 @@
-require 'ostruct'
-require 'yaml'
-require 'erb'
-
-# == Summary
-# This is API documentation, NOT documentation on how to use this plugin.  For that, see the README.
-class ApplicationConfig
-  
-  cattr_accessor :conf_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(*conf_load_paths)
-    self.conf_paths = []
-    self.conf_paths += conf_load_paths
-    self.conf_paths.uniq!
-    
-    reload
-  end
-  
-  def self.reload
-    conf = {}
-    conf_paths.each do |path|
-      new_conf = YAML.load(ERB.new(IO.read(path)).result) if path and File.exists?(path)
-      conf.merge!(new_conf) if new_conf
-    end
-    return convert(conf)
-  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.instance_of?(Hash)
-        s.send( (k+'=').to_sym, convert(v))
-      elsif v.instance_of?(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
-
+require 'erb'
+require 'yaml'
+
+class AppConfig
+  
+  def initialize(file = nil)
+    @sections = {}
+    @params = {}
+    use_file!(file) if file
+  end
+  
+  def use_file!(file)
+    begin
+      hash = YAML::load(ERB.new(IO.read(file)).result)       
+      @sections.merge!(hash) {|key, old_val, new_val| (old_val || new_val).merge new_val }
+      @params.merge!(@sections['common'])
+    rescue; end    
+  end
+  
+  def use_section!(section)
+    @params.merge!(@sections[section.to_s]) if @sections.key?(section.to_s)
+  end
+  
+  def method_missing(param)
+    param = param.to_s
+    if @params.key?(param)
+      @params[param]
+    else
+      raise "Invalid AppConfig Parameter " + param
+    end
+  end
+  
 end

data/rails/init.rb

@@ -1,9 +1,7 @@
-require 'app_config'
-
-::Conf = ApplicationConfig.load_files(RAILS_ROOT+"/config/app_config.yml",
-                                           RAILS_ROOT+"/config/environments/#{RAILS_ENV}.yml")
-
-def Conf.reload!
-  Conf.marshal_load(ApplicationConfig.reload.marshal_dump)
-  return Conf
-end
+require 'app_config'
+
+c = AppConfig.new
+c.use_file!("#{RAILS_ROOT}/config/config.yml")
+c.use_file!("#{RAILS_ROOT}/config/config.local.yml")
+c.use_section!(RAILS_ENV)
+::Conf = c

data/test/app_config_test.rb

@@ -1,46 +1,114 @@
-require 'rubygems'
-require 'test/unit'
-require 'active_support'
-require 'lib/app_config'
-
-class AppConfigTest < Test::Unit::TestCase
-  
-  def test_missing_files
-    config = ApplicationConfig.load_files('not_here1', 'not_here2')
-    assert_equal OpenStruct.new, config
-  end
-  
-  def test_empty_files
-    config = ApplicationConfig.load_files('test/empty1.yml', 'test/empty2.yml')
-    assert_equal OpenStruct.new, config
-  end
-  
-  def test_common
-    config = ApplicationConfig.load_files('test/app_config.yml')
-    assert_equal 1, config.size
-    assert_equal 'google.com', config.server
-  end
-  
-  def test_environment_override
-    config = ApplicationConfig.load_files('test/app_config.yml', 'test/development.yml')
-    assert_equal 2, config.size
-    assert_equal 'google.com', config.server
-  end
-  
-  def test_nested
-    config = ApplicationConfig.load_files('test/development.yml')
-    assert_equal 3, config.section.size
-  end
-  
-  def test_array
-    config = ApplicationConfig.load_files('test/development.yml')
-    assert_equal 'yahoo.com', config.section.servers[0].name
-    assert_equal 'amazon.com', config.section.servers[1].name
-  end
-  
-  def test_erb
-    config = ApplicationConfig.load_files('test/development.yml')
-    assert_equal 6, config.computed
-  end
-  
-end
+require 'test/unit'
+require 'fileutils'
+require File.expand_path(File.dirname(__FILE__) + "/../lib/app_config.rb")
+
+class AppConfigTest < Test::Unit::TestCase
+
+  def setup
+    @dir = File.dirname(__FILE__) + "/"
+    @files = []
+  end
+  
+  def test_should_read_from_yml
+    test_config 'common' => {'a' => '1', 'b' => '2'} do |file, hash|
+      config = AppConfig.new(file)
+      assert_equal_with_hash config, hash['common']
+    end
+  end
+  
+  def test_should_ignore_non_existent_file
+    config = AppConfig.new('nonexsistentfile')
+    assert_not_nil config
+  end
+  
+  def test_should_igonre_non_existent_section
+    test_config 'common' => {'a' => '1', 'b' => '2' } do |file, hash|
+      config = AppConfig.new(file)
+      config.use_section!('nonexistentsection')
+      assert_equal config.b, '2'
+    end    
+  end
+  
+  def test_should_parse_yaml_with_erb
+    test_config 'common' => {'a' => '1', 'b' => '<%= 2 + 2 %>' } do |file, hash|
+      config = AppConfig.new(file)
+      assert_equal config.b, 4
+    end
+  end
+  
+  def test_should_override_params_with_given_section
+    test_config 'common' => {'a' => '1', 'b' => '<%= 2 + 2 %>'}, 
+                 'special' => {'a' => 1, 'b' => 5 } do |file, hash|
+      config = AppConfig.new(file)
+      config.use_section!('special')
+      assert_equal_with_hash config, hash['special']
+    end
+    test_config 'common' => {'a' => '1', 'b' => '<%= 2 + 2 %>'}, 
+                'special' => {'b' => 5 } do |file, hash|
+      config = AppConfig.new(file)
+      config.use_section!('special')
+      assert_equal_with_hash config, {'a' => '1', 'b' => 5}
+    end    
+  end
+  
+  def test_should_ovveride_params_with_another_file
+    test_config({'common' => {'a' => '1', 'b' => '<%= 2 + 2 %>'}, 
+                 'special' => {'b' => 5 }}, 'config') do |file1, hash1|
+      test_config({'common' => {'a' => '2'}, 
+                   'special' => {'b' => 8 }}, 'config.local') do |file2, hash2|                
+        config = AppConfig.new(file1)
+        assert_equal_with_hash config, {'a' => '1', 'b' => 4}
+        config.use_file!(file2)
+        assert_equal_with_hash config, {'a' => '2', 'b' => 4}
+      end
+    end        
+  end
+  
+  def test_should_ovveride_params_with_another_file_and_use_proper_section
+    test_config({'common' => {'a' => '1', 'b' => '<%= 2 + 2 %>', 'c' => 2}, 
+                 'special' => {'b' => 5, 'd' => 6 },
+                 'extra' => {'f' => 4, 'a' => 8}}, 'config') do |file1, hash1|
+      test_config({'common' => {'a' => '2'}, 
+                   'special' => {'b' => 8 }}, 'config.local') do |file2, hash2|                
+        config = AppConfig.new
+        config.use_file!(file1)
+        config.use_file!(file2)
+        config.use_section!('special')
+        assert_equal_with_hash config, {'a' => '2', 'b' => 8, 'c' => 2, 'd' => 6}
+      end
+    end        
+  end  
+  
+  def teardown
+    begin
+      FileUtils.rm @files
+    rescue
+    end
+  end
+  
+  protected
+  
+    def file_path(file)
+      @dir + file + '.yml'
+    end
+  
+    def create_config_file(file, hash) 
+      file = @dir + file + '.yml'
+      @files << file
+      File.open(file, 'w') do |f|
+        f.write hash.to_yaml        
+      end
+    end
+    
+    def assert_equal_with_hash(config, hash)    
+      hash.each do |key, value|
+        assert_equal config.send(key), value
+      end
+    end
+    
+    def test_config(hash, file = 'config', &blk)
+      create_config_file file, hash
+      blk.call(file_path(file), hash)
+    end
+   
+end

metadata

@@ -1,11 +1,10 @@
 --- !ruby/object:Gem::Specification 
 name: scotch-app_config
 version: !ruby/object:Gem::Version 
-  version: "1.4"
+  version: "1.5"
 platform: ruby
 authors: 
-- RailsJedi
-- Christopher J. Bottaro
+- Eugene Bolshakov
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -23,13 +22,13 @@ dependencies:
         version: "2.1"
     version: 
 description: Allow application wide configuration settings via YML files
-email: railsjedi@gmail.com
+email: 
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- README
+- README.rdoc
 files: 
 - README
 - README.rdoc
@@ -65,8 +64,4 @@ signing_key:
 specification_version: 2
 summary: Application level configuration
 test_files: 
-- test/app_config.yml
 - test/app_config_test.rb
-- test/development.yml
-- test/empty1.yml
-- test/empty2.yml

data/README

@@ -1 +0,0 @@
-README.rdoc

data/test/app_config.yml

@@ -1,2 +0,0 @@
-size: 1
-server: google.com

data/test/development.yml

@@ -1,5 +0,0 @@
-size: 2
-computed: <%= 1 + 2 + 3 %>
-section:
-  size: 3
-  servers: [ {name: yahoo.com}, {name: amazon.com} ]