configuration_loader 1.0.0

data/README

@@ -0,0 +1,47 @@
+= Configuration Files Loader
+
+Configuration Files Loader can be used as a gem or a Rails plugin to load various config files.
+
+It finds config file fragments in a Rails config directory and in config directories of plugins and dependent gems. It then tries to merge them in the following order: gem<-plugin<-application. This allows overrides of global (gem/plugin) configs by individual applications. The supported types for merging are String, Hash, and Array. It caches the content of files by default. ConfigurationLoader is RoR environment aware and provides a shortcut ('load_section') to load a section of a config file corresponding to RAILS_ENV. It is being used in another method provided by ConfigurationLoader - 'load_db_config'. It loads a section from 'config/database.yml' providing a convenient method for placing secondary DB entries in a code as seen here:
+
+establish_connection ConfigurationLoader.load_db_config['secondary_db']
+
+See the 'DRYing Up Configuration Files' post in our team blog http://revolutiononrails.blogspot.com/2007/03/drying-up-configuration-files.html for additional details.
+
+
+== Setup
+
+=== Installation
+
+To install Configuration Files Loader as a gem:
+
+Get the gem file from the project page (http://rubyforge.org/projects/config-loader) and install it
+
+To install as a Rails plugin:
+
+ruby script/plugin install svn://rubyforge.org/var/svn/config-loader/trunk/vendor/plugins/configuration_loader
+
+
+=== Usage
+
+require 'configuration_loader'
+
+ConfigurationLoader.load_db_config # gets the RAILS_ENV section from database.yml
+
+ConfigurationLoader.load('cfg.yml') # loads a YAML-processed config file
+
+ConfigurationLoader.load('cfg.yml', :erb => true) # loads a ERB+YAML-processed config file
+
+ConfigurationLoader.load('cfg.yml', :section => RAILS_ENV) # loads a current RAILS_ENV section from a YAML-processed config file
+
+ConfigLoader.load('cfg.yml', :cache => false) # loads an uncached copy YAML-processed config file
+
+
+== License
+
+Configuration Files Loader is released under the MIT license.
+
+
+== Support
+
+The RubyForge home page is http://rubyforge.org/projects/config-loader

data/lib/configuration_loader.rb

@@ -0,0 +1,183 @@
+# Configuration Files Loader can be used as a gem or a Rails plugin to load config files.
+# 
+# It finds config file fragments in a rails config directory and in config directories of plugins and dependent gems.
+# It then tries to merge them in order gem<-plugin<-application thus allowing overrides of global (gem/plugin) configs by individual applications.
+# The supported types for merging are String, Hash, and Array.
+# 
+# It caches the content of files by default. 
+# 
+# ConfigurationLoader is RoR environment aware and provides a short-cut 'load_section' to load a section of a config file corresponding to RAILS_ENV.
+# It is being used in another method provided by ConfigurationLoader - load_db_config.
+# It loads a section from 'config/database.yml' providing a convenience method for getting secondary DB entries in a code like this:
+# 
+# establish_connection ConfigurationLoader.load_db_config['secondary_db']
+#  
+# See the 'DRYing Up Configuration Files' post in our team blog http://revolutiononrails.blogspot.com/2007/03/drying-up-configuration-files.html
+# for additional details.
+#
+#
+# == Usage
+#
+# require 'configuration_loader'
+# 
+# ConfigurationLoader.load_db_config # gets the RAILS_ENV section from database.yml
+# 
+# ConfigurationLoader.load('cfg.yml') # loads a YAML-processed config file
+# 
+# ConfigurationLoader.load('cfg.yml', :erb => true) # loads a ERB+YAML-processed config file
+# 
+# ConfigurationLoader.load('cfg.yml', :section => RAILS_ENV) # loads a current RAILS_ENV section from a YAML-processed config file
+# 
+# ConfigLoader.load('cfg.yml', :cache => false) # loads an uncached copy YAML-processed config file
+#
+class ConfigurationLoader
+
+  require 'yaml'
+  require 'erb'
+  require 'pp'
+  
+  class << self
+  
+    @@cached = {}
+  
+    # Finds files with a provided file name, loads and processes them. The +options+ control the processing:
+    #   :erb => true -- runs the file through ERB before YAML-processing (DEFAULT: false)
+    #   :section => 'section_name' -- loads a specific section of the file (like 'development' for 'database.yml') (DEFAULT: nil)
+    #   :merge => false -- returns an arrary of processed resulted without trying to merge them into a single entry (DEFAULT: true)
+    #   :cache => false -- returns a non-cached copy (DEFAULT: true)
+    def load(file, supplied_options = {})
+      options = default_options.merge(supplied_options)
+      res = load_file(file, options)
+      res = sections(res, options[:section]) if options[:section]
+      res = merge(res) if options[:merge]
+      res
+    end
+
+    # A convenience method for loading the current RAILS_ENV section of the Rails DB config file 
+    def load_db_config(section = default_section)
+      load('database.yml', :section => section)
+    end
+    
+    # Empties the cached entry[es] thus forcing to reload from a file system next time
+    def refresh!(key = :everything)
+      case key
+        when :everything then
+          @@cached = {}
+        else
+          @@cached.delete(:__configs__)
+          @@cached.delete(key)
+      end
+    end
+    
+  private
+
+    def default_options
+      {
+        :erb => false,
+        :section => nil,
+        :merge => true,
+        :cache => true
+      }
+    end
+    
+    def load_file(file, options)
+      cache(options[:cache])[file] ||= load_yaml_file(file, options)
+    end
+
+    def sections(configs, section)
+      configs.empty? ? nil : collect_sections(configs, section)
+    end
+
+    def collect_sections(configs, section)
+      configs.inject([]) do |config_sections, config|    
+        config_sections << config[section] if (config.respond_to?('[]') && config[section])
+        config_sections
+      end
+    end
+    
+    def default_section
+      (defined?(RAILS_ENV) && RAILS_ENV) || 'development'
+    end
+
+    def file_path(path, file)
+      File.join(path, file)
+    end
+  
+    def cache(use_cache)
+      use_cache ? @@cached : {}
+    end
+    
+    def config_files(use_cache)
+      cache(use_cache)[:__configs__] ||= begin 
+        (load_pathes("/gems/") + load_pathes("vendor/plugins/") + app_root).uniq.inject([]) do |configs, path|
+          debug("Component: #{ path }")
+          config = File.join(path, 'config')
+          if File.exist?(config)
+            configs << config
+            debug('Has config')
+          else
+            debug('No config')
+          end
+          configs
+        end
+      end 
+    end
+
+    def app_root
+      path = defined?(CONFIG_LOADER_ROOT) ? CONFIG_LOADER_ROOT : RAILS_ROOT
+      [ File.expand_path(path) ]
+    end
+  
+    def load_pathes(pattern)
+      $:.grep(%r{#{ pattern }}).collect { |path| File.expand_path(path[%r{.*#{ pattern }[^/]+}]) }
+    end
+
+    def load_yaml_file(file_name, options)
+      config_files(options[:cache]).inject([]) do |loaded, config_path|
+        file = file_path(config_path, file_name)
+        debug("Probing #{ file }")
+        if File.exist?(file)
+          loaded << YAML.load(file_loader(file, options))
+          debug('Found')
+        else
+          debug('Not found')
+        end
+        loaded
+      end
+    
+    end
+  
+    def file_loader(file, options)
+      res = IO.read(file)
+      res = ERB.new(res).result if options[:erb]
+      res
+    end
+  
+    def merge(values)
+    
+      debug('Merging configs:') { pp values }
+      
+      case
+        when all_are?(values, Hash) then
+          values.inject({}) { |c, v| c.merge(v) }
+        when all_are?(values, Array) then
+          values.inject([]) { |c, v| c + v }
+        else
+          values.last
+      end
+    
+    end
+  
+    def all_are?(values, type)
+      values.all? { |v| v.is_a?(type) }
+    end
+  
+    def debug(msg)
+      if ENV['CONFIG_LOADER_DEBUG']
+        puts "CONFIG_LOADER: #{ msg }" 
+        yield if block_given?
+      end
+    end
+
+  end
+end

data/test/configuration_loader_test.rb

@@ -0,0 +1,110 @@
+require File.dirname(__FILE__) + '/../lib/configuration_loader'
+require 'test/unit' 
+
+class ConfigurationLoaderTest < Test::Unit::TestCase
+
+  ::CONFIG_LOADER_ROOT = File.join(File.dirname(__FILE__), 'configs')
+  
+  ['vendor/plugins', 'gems'].each do |dir|
+    Dir["#{ CONFIG_LOADER_ROOT }/#{ dir }/*"].each { |path| $: << path }
+  end
+  
+  def test_default_db_config
+    cfg = ConfigurationLoader.load_db_config
+    assert_not_equal Hash.new, cfg
+    assert cfg['loaded']
+  end 
+   
+  def test_db_config_section
+    cfg = ConfigurationLoader.load_db_config('test')
+    assert_not_equal Hash.new, cfg
+    assert_equal 'app_db', cfg['db']
+    assert cfg['app_db']
+    assert cfg['plugin_db']
+    assert cfg['gem_db']
+  end  
+   
+  def test_db_config_unknown_section
+    cfg = ConfigurationLoader.load_db_config('unknown')
+    assert_equal Hash.new, cfg
+  end
+  
+  def test_merging_config
+    cfg = ConfigurationLoader.load('cfg.yml')
+    assert cfg['hash']['app']
+    assert_nil cfg['hash']['plugin']
+    assert_nil cfg['hash']['gem']
+    assert_equal [ "app_one", "app_two" ], cfg['array']
+  end
+  
+  def test_merging_hash
+    cfg = ConfigurationLoader.load('cfg.yml', :section => 'hash')
+    assert_equal 'app', cfg['global'], 'App takes the precedence among app, plugin, and gem'
+    assert_equal 'plugin', cfg['component'], 'Plugin takes the precedence between plugin and gem'
+    assert cfg['app']
+    assert cfg['plugin']
+    assert cfg['gem']
+  end
+  
+  def test_merging_array
+    cfg = ConfigurationLoader.load('cfg.yml', :section => 'array')
+    ["app_one", "app_two", "plugin_one", "plugin_two", "gem_one", "gem_two"].each { |e| assert cfg.include?(e) }
+  end  
+  
+  def test_merging_string
+    cfg = ConfigurationLoader.load('cfg.yml', :section => 'string')
+    assert_equal 'app', cfg
+  end
+
+  def test_no_merging
+    cfg = ConfigurationLoader.load('cfg.yml', :section => 'string', :merge => false)
+    ["app", "plugin", "gem"].each { |e| assert cfg.include?(e) }
+  end
+  
+  def test_erb_processing
+    cfg = ConfigurationLoader.load('cfg.yml')
+    assert_equal '<%= 1 %>', cfg['erb']
+    erb = ConfigurationLoader.load('cfg.yml', :erb => true, :cache => false)
+    assert_equal 1, erb['erb']
+  end
+  
+  def test_no_caching
+    
+    cfg = ConfigurationLoader.load('cfg.yml')
+    assert_nil cfg['optional']
+    
+    add_optional_gem
+    
+    cached = ConfigurationLoader.load('cfg.yml')
+    assert_nil cached['optional'], "Still nil since cached"
+    
+    fresh = ConfigurationLoader.load('cfg.yml', :cache => false)
+    assert fresh['optional']
+    
+  end
+
+  def test_refresh
+    
+    assert_equal Hash.new, ConfigurationLoader.load('optional.yml')
+    cfg = ConfigurationLoader.load('cfg.yml')
+    assert_nil cfg['optional']
+    
+    add_optional_gem
+    ConfigurationLoader.refresh!('cfg.yml')
+    
+    fresh = ConfigurationLoader.load('cfg.yml', :cache => false)
+    assert fresh['optional']
+    assert_equal Hash.new, ConfigurationLoader.load('optional.yml'), 'Was not refreshed'
+
+    ConfigurationLoader.refresh!
+    assert ConfigurationLoader.load('optional.yml')['loaded']
+    
+  end
+  
+private
+
+  def add_optional_gem
+    $: << "#{ CONFIG_LOADER_ROOT }/optional_config/gems/optional_gem"
+  end
+  
+end

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.2
+specification_version: 1
+name: configuration_loader
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+date: 2007-03-16 00:00:00 -04:00
+summary: Configuration files loader
+require_paths: 
+- lib
+email: rails-trunk@revolution.com
+homepage: 
+rubyforge_project: 
+description: 
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: false
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- RHG Team
+files: 
+- lib/configuration_loader.rb
+- README
+test_files: 
+- test/configuration_loader_test.rb
+rdoc_options: []
+
+extra_rdoc_files: 
+- README
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+