config_loader 1.0.0

data/README

@@ -0,0 +1,50 @@
+= 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 config_loader.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/config_loader
+
+
+=== Usage
+
+require 'config_loader'
+
+ConfigLoader = ConfigurationLoader.new
+
+ConfigLoader.load_db_config # gets the RAILS_ENV section from database.yml
+
+ConfigLoader.load_file('cfg.yml') # loads a YAML-processed config file
+
+ConfigLoader.load_dynamic_file('cfg.yml') # loads a ERB+YAML-processed config file
+
+ConfigLoader.load_section('cfg.yml') # loads a current RAILS_ENV section from a YAML-processed config file
+
+ConfigLoader.load_dynamic_section('cfg.yml', 'test') # loads a 'test' section from a ERB+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/config_loader.rb

@@ -0,0 +1,210 @@
+# 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 config_loader.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 'config_loader'
+# 
+# ConfigLoader = ConfigurationLoader.new
+# 
+# ConfigLoader.load_db_config # gets the RAILS_ENV section from database.yml
+# 
+# ConfigLoader.load_file('cfg.yml') # loads a YAML-processed config file
+# 
+# ConfigLoader.load_dynamic_file('cfg.yml') # loads a ERB+YAML-processed config file
+# 
+# ConfigLoader.load_section('cfg.yml') # loads a current RAILS_ENV section from a YAML-processed config file
+# 
+# ConfigLoader.load_dynamic_section('cfg.yml', 'test') # loads a 'test' section from a ERB+YAML-processed config file
+#
+class ConfigurationLoader
+  
+  require 'pp'
+  
+  # Creats a configuration loader instance
+  # Any vaule but +:use_cache+ would trigger having no caching
+  def initialize(cache_option = :use_cache)
+    @use_cache = (cache_option == :use_cache)
+  end
+  
+  # Works as <tt>load_assembled_file</tt> but returns the merged results as a single entry
+  def load_file(file)
+    merge(load_assembled_file(file))
+  end
+  
+  # Works as <tt>load_assembled_dynamic_file</tt> but returns the merged results as a single entry
+  def load_dynamic_file(file)
+    merge(load_assembled_dynamic_file(file))
+  end
+  
+  # Finds files with a provided file name, loads them, YML-processes, and returns an array of results
+  def load_assembled_file(file)
+    cache[file] ||= yaml_load_file(file)
+  end
+  
+  # Finds files with a provided file name, loads them, ERB-processes, YML-processes, and returns an array of results
+  def load_assembled_dynamic_file(file)
+	  cache[file] ||= yaml_load_file(file, :erb)
+  end
+  
+  # Works as <tt>load_file</tt> but in addition returns only a section (assuming that the entry is a hash) based on the supplied +section+.
+  # If no +section+ is provided, the current +RAILS_ENV+ value is being used
+  def load_section(file, section = default_section, follow_links = false)
+    loaded = load_assembled_file(file)
+    section(loaded, section, follow_links)
+  end
+  
+  # Works as <tt>load_assembled_dynamic_file</tt> but in addition returns only a section (assuming that the entry is a hash) based on the supplied +section+.
+  # If no +section+ is provided, the current +RAILS_ENV+ value is being used  
+  def load_dynamic_section(file, section = default_section, follow_links = false)
+    loaded = load_assembled_dynamic_file(file)
+    section(loaded, section, follow_links)
+  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_section('database.yml', section)
+  end
+  
+  # Empties the cached entries thus forcing it to reload them from a file system
+  def self.refresh!
+    @@cached = {}
+  end
+
+private
+
+  def section(loaded_configs, section, follow_links)
+    loaded_configs.empty? ? nil : merge(collect_sections(loaded_configs, section, follow_links))
+  end
+  
+  def collect_sections(loaded_configs, section, follow_links)
+    loaded_configs.inject([]) do |combined_section, config|    
+      s = select_section(config, section, follow_links)
+      combined_section << s if s
+      combined_section
+    end
+  end
+
+  def select_section(loaded_config, section, follow_links)
+    
+    section = loaded_config[section]
+    if follow_links
+      seen_sections = [ ]
+      while section.class == String
+        if seen_sections.include? section
+          raise ArgumentError("Circular references in config file")
+        end
+        seen_sections << section
+        section = loaded_config[section]
+      end
+    end
+    section
+
+  end
+    
+  def default_section
+    (defined?(RAILS_ENV) && RAILS_ENV) || 'development'
+  end
+
+  def file_path(path, file)
+    File.join(path, file)
+  end
+  
+  def cache
+    cache? ? (@@cached ||= {}) : {}
+  end
+    
+  def configs
+    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?(RAILS_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 yaml_load_file(file_name, file_type = :none)
+        
+    configs.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, file_type))
+        debug('Found')
+      else
+        debug('Not found')
+      end
+      loaded
+    end
+    
+  end
+  
+  def file_loader(file, file_type)
+    case file_type
+      when :erb then ERB.new(IO.read(file)).result
+      else IO.read(file)
+    end
+  end
+
+  def cache?
+    @use_cache
+  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

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.2
+specification_version: 1
+name: config_loader
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+date: 2007-03-15 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/config_loader.rb
+- README
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: 
+- README
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+