revolutionhealth-config_loader 2.0.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Revolution Health
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,13 @@
+LICENSE
+Manifest.txt
+Rakefile
+README
+TODO
+lib/config_loader.rb
+lib/service_config.rb
+test/test_config_reload.rb
+test/test_helper.rb
+test/test_service_config.rb
+test/config/database.yml
+test/config/service.yml
+test/config/test_reload.yml

data/README

@@ -0,0 +1,52 @@
+= Configuration Files Loader
+
+Configuration Files Loader can be used as a gem or a Rails plugin to load various config files.
+
+Finds config file fragments in a Rails config directory and in the 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 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:
+
+sudo gem install revolutionhealth-config_loader -s http://gems.github.com
+
+== Source
+
+http://github.com/revolutionhealth/config_loader
+
+
+= Usage
+
+require 'config_loader'
+
+== ConfigLoader
+
+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
+
+== ServiceConfig
+
+Assuming you have a file 'config/service.yml' with a 'search' entry for your RAILS_ENV setting
+
+ServiceConfig.endpoint('search') # gets the url of the service
+
+ServiceConfig.timeout('timeout') # gets the timeout of the service
+
+
+= Support
+
+The RubyForge home page is http://github.com/revolutionhealth/config_loader

data/Rakefile

@@ -0,0 +1,65 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rubygems/specification'
+require 'date'
+
+GEM = "config_loader"
+GEM_VERSION = "2.0.0"
+AUTHOR = "Revolution Health"
+EMAIL = "rails-trunk@revolutionhealth.com"
+HOMEPAGE = %q{http://github.com/revolutionhealth/config_loader}
+SUMMARY = "Provides convenience methods for the loading of configuration files"
+DESCRIPTION = "Abstracts out the loading of common configuration files such as database.yml dependent on the Rails environment"
+
+spec = Gem::Specification.new do |s|
+  s.name = GEM
+  s.version = GEM_VERSION
+  s.date = Time.now.strftime("%Y-%m-%d")
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["Manifest.txt", "README"]
+  s.rdoc_options = ["--main", "README"]
+  
+  s.summary = SUMMARY
+  s.description = DESCRIPTION
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  
+  # Uncomment this to add a dependency
+  # s.add_dependency "foo"
+  
+  s.require_path = 'lib'
+  s.autorequire = GEM
+  s.files = %w(Manifest.txt LICENSE README TODO Rakefile) + Dir.glob("{lib,test}/**/*")
+  s.test_files = Dir.glob('test/**/test_*.rb') - ['test/test_helper.rb']
+end
+
+
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "install the gem locally"
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{GEM}-#{GEM_VERSION}}
+end
+
+desc "create a gemspec file"
+task :make_spec do
+  File.open("#{GEM}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end
+
+require 'test/unit'
+ 
+task :test do
+ runner = Test::Unit::AutoRunner.new(true)
+ runner.to_run << 'test'
+ runner.run
+end
+ 
+task :default => [:test, :package] do
+end

data/TODO

@@ -0,0 +1,4 @@
+= TODO
+
+* More tests
+* More documentation

data/lib/config_loader.rb

@@ -0,0 +1,249 @@
+# 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
+#
+# In your environment.rb
+#   config.gem 'revolutionhealth-config_loader', :lib => 'config_loader, :source => 'http://gems.github.com'
+# 
+# Examples
+#   Gets the RAILS_ENV section from database.yml
+#   ConfigLoader.load_db_config                 
+#
+#   Loads a YAML-processed config file
+#   ConfigLoader.load_file('cfg.yml')
+# 
+#   Loads a ERB+YAML-processed config file
+#   ConfigLoader.load_dynamic_file('cfg.yml')
+# 
+#   Loads a current RAILS_ENV section from a YAML-processed config file
+#   ConfigLoader.load_section('cfg.yml')
+# 
+#   Loads a 'test' section from a ERB+YAML-processed config file
+#   ConfigLoader.load_dynamic_section('cfg.yml', 'test')
+#
+
+require 'yaml'
+require 'pp'
+require 'erb'
+require File.join(File.dirname(__FILE__), 'service_config')
+
+class ConfigurationLoader
+  
+  def initialize(cache_option = :force_cache, base_path = nil)
+    @caching = (cache_option == :force_cache)
+    @base_path = base_path
+  end
+  
+  def load_file(file, use_env = false)
+    merge(load_assembled_file(file, use_env))
+  end
+  
+  def load_dynamic_file(file, use_env = false)
+    merge(load_assembled_dynamic_file(file, use_env))
+  end
+    
+  def load_assembled_file(file, use_env = false)
+    cache[key(file, use_env)] ||= yaml_load_file(file, use_env)
+  end
+  
+  def load_assembled_dynamic_file(file, use_env = false)
+	  cache[key(file, use_env)] ||= yaml_load_file(file, use_env, :erb)
+  end
+    
+  def load_section(file, section = default_section, follow_links = false)
+    loaded = load_assembled_file(file)
+    section(loaded, section, follow_links)
+  end
+  
+  def load_dynamic_section(file, section = default_section, follow_links = false)
+    loaded = load_assembled_dynamic_file(file)
+    section(loaded, section, follow_links)
+  end
+  
+  def load_raw_file(file)
+	  cache[key(file, false)] ||= yaml_load_file(file, false, :raw).last
+  end
+
+  def load_service_config
+    begin
+      load_dynamic_section('service.yml')
+    rescue => ex
+      puts "Warning: no or broken service.yml detected for this project - #{ ex }"
+      {}
+    end
+  end
+
+  def load_db_config(section = default_section)
+    load_section('database.yml', section)
+  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
+    rails_env
+  end
+  
+  def rails_env
+    RAILS_ENV || 'development'
+  end
+  
+  def file_path(path, file, use_env)
+    to_load = use_env ? "environments/#{ rails_env }-#{ file }" : file
+    File.join(path, to_load)
+  end
+  
+  def cache
+    if cache? 
+      if loaded_file_changed?
+        @@cached = nil
+        loaded_files.clear
+      end 
+      (@@cached ||= {})
+    else 
+      {}
+    end
+  end
+  
+  def key(file, env)
+    "#{ file }_#{ env }"
+  end
+  
+  def loaded_files
+    (@@loaded_files ||= {})
+  end
+    
+  # frequency in secs to reload config files
+  RELOAD_FREQ_SECS = 10
+  
+  def loaded_file_changed?
+    result = false
+    now = Time.now
+    # check every 10 sec
+    if (now > ((@@last_file_changed_check ||= now) + RELOAD_FREQ_SECS))
+      loaded_files.each do |file, time|
+        if (File.stat(file).mtime <=> time) != 0
+          result = true
+          break
+        end
+      end
+      @@last_file_changed_check = now
+    end
+    result
+  end
+
+  def configs
+    cache[:configs] ||= begin 
+      (load_pathes("/gems/") + load_pathes("vendor/plugins/") + app_root).uniq.inject([]) do |configs, path|
+        puts "Component: #{ path }" if ENV['CONFIG_LOADER_DEBUG']      
+        config = File.join(path, 'config')
+        configs << config if File.exist?(config)
+        configs
+      end
+    end 
+  end
+
+  def app_root
+    raise "Must set base_path if RAILS_ROOT is nil" unless (defined?(RAILS_ROOT) or @base_path)
+    path_to_return = defined?(RAILS_ROOT) ? RAILS_ROOT : @base_path
+    return [ File.expand_path(path_to_return) ]
+  end
+  
+  def load_pathes(pattern)
+    $:.grep(%r{#{ pattern }}).collect { |path| File.expand_path(path[%r{.*#{ pattern }[^/]+}]) }
+  end
+
+  def yaml_load_file(file_name, use_env, file_type = :none)    
+    configs.inject([]) do |loaded, config_path|
+      file = file_path(config_path, file_name, use_env)
+      puts "Probing #{ file }" if ENV['CONFIG_LOADER_DEBUG']
+      if File.exist?(file)
+        f = file_loader(file, file_type)
+        res = (file_type == :raw) ? f : YAML.load(f)
+        loaded << res
+      end
+      loaded
+    end
+  end
+  
+  def file_loader(file, file_type)
+    loaded_files[file.to_s] = File.stat(file).mtime
+    case file_type
+      when :erb then ERB.new(IO.read(file)).result
+      else IO.read(file)
+    end
+  end
+
+  def cache?
+    @caching
+  end
+  
+  def merge(values)
+    
+    if ENV['CONFIG_LOADER_DEBUG']
+      puts "Merging configs: "
+      pp values
+    end
+      
+    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
+
+end
+
+::ConfigLoader = ConfigurationLoader.new unless defined?(ConfigLoader)

data/lib/service_config.rb

@@ -0,0 +1,118 @@
+require 'logger'
+
+module ServiceConfig
+  extend self
+
+  ConfigLogger = defined?(RAILS_DEFAULT_LOGGER) ? RAILS_DEFAULT_LOGGER : Logger.new(STDOUT)
+      
+  def endpoint(service)
+	  begin
+      cfg[service.to_s]['url']
+		rescue
+			nil
+		end
+  end
+  
+  def config_timeout(service)
+	  begin
+      cfg[service.to_s]['timeout']
+		rescue
+		  log_not_found service
+			ConfigLogger.error "Configuring a default timeout of 5 seconds."
+			5
+		end
+  end
+  
+  def is_mocked?(service)
+    begin
+      cfg[service.to_s][:mocked.to_s]
+    rescue
+      log_not_found service
+      false
+    end
+  end
+
+  def is_service_backed?(service)
+    begin
+      cfg[service.to_s][:service_backed.to_s]
+    rescue
+      log_not_found service
+      false
+    end
+  end
+
+  def mocked(service)
+    cfg[service.to_s][:mocked.to_s]
+  end
+  
+  def service_backed(service)
+    cfg[service.to_s][:service_backed.to_s]
+  end
+  
+  def login
+    cfg[:service_creds.to_s][:login.to_s]
+  end
+  
+  def host(service)
+	  begin
+      cfg[service.to_s]['host']
+		rescue
+		  log_not_found service
+			nil
+		end
+  end
+
+  def path(service)
+	  begin
+      cfg[service.to_s]['path']
+		rescue
+		  log_not_found service
+			nil
+		end
+  end
+
+  def port(service)
+	  begin
+      cfg[service.to_s]['port']
+		rescue
+		  log_not_found service
+			nil
+		end
+  end
+
+  def service_params(service)
+    cfg[service.to_s]
+  end
+
+  def sp_entity_value(service)
+    find_target(service, 'sp_entity_value')
+  end
+  
+  def sp_target_value(service)
+    find_target(service, 'sp_target_value')
+  end
+
+  def find_target(service, name)
+    begin
+      cfg[service.to_s][name]
+    rescue
+      log_not_found "service: #{service.to_s}, attr: #{name}"
+      nil
+    end
+  end
+
+  def ends_with_slash(url)
+    (url[-1,1] == '/') ? url : url + '/'
+  end
+
+private
+
+  def log_not_found(service)
+    ConfigLogger.error "Could not load endpoint configuration for #{service.to_s}"
+  end
+  
+  def cfg
+    ConfigLoader.load_service_config
+  end
+
+end

data/test/config/service.yml

@@ -0,0 +1,9 @@
+test:
+  search:
+    url: http://www.google.com
+    timeout: 10
+    mocked: false
+    service_backed: true
+    host: google.com
+    path: /search/all
+    port: 80

data/test/config/test_reload.yml

@@ -0,0 +1,3 @@
+--- 
+test: 
+  adapter: oracle

data/test/test_config_reload.rb

@@ -0,0 +1,116 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class ConfigurationLoader
+  alias :file_loader_old :file_loader
+  
+  def reset_loader_called
+    @@loader_called = false
+  end
+  
+  def loader_called
+    (@@loader_called ||= false) 
+  end
+  
+  def file_loader(file, file_type)
+    @@loader_called = true
+    file_loader_old(file, file_type)
+  end
+  
+  def loaded_file_changed_checkonly?
+    orig = @@last_file_changed_check if defined? @@last_file_changed_check
+    changed = loaded_file_changed? 
+    @@last_file_changed_check = orig
+    changed
+  end
+end
+
+class TestConfigReload < Test::Unit::TestCase
+  
+  def test_config_reload
+    loaded = ConfigLoader.load_file('test_reload.yml')
+    assert_not_nil loaded
+    assert ConfigLoader.loader_called
+    
+    another_loaded = ConfigLoader.load_file('database.yml')
+    assert_not_nil another_loaded
+        
+    # should be under threshold of timeout
+    changed = false
+    changed = ConfigLoader.loaded_file_changed_checkonly?
+    assert !changed
+    
+    sleep 5
+    ConfigLoader.reset_loader_called
+    ## after sleeping it should not reload since the mtime is same
+
+    changed = false
+    changed = ConfigLoader.loaded_file_changed_checkonly?
+    assert !changed
+
+
+    not_reloaded = ConfigLoader.load_file('test_reload.yml')
+    assert_equal loaded, not_reloaded
+
+    assert !ConfigLoader.loader_called
+    
+    #try another file
+    another_loaded = ConfigLoader.load_file('database.yml')
+    assert_not_nil another_loaded
+    assert !ConfigLoader.loader_called
+    
+    ## change the file
+    new_adapter = 'oracle'
+    orig_adapter = loaded['test']['adapter']
+    loaded['test']['adapter'] = new_adapter
+
+    
+    test_reload_file = File.join(File.dirname(__FILE__), 'config', 'test_reload.yml')
+    File.open(test_reload_file, 'w' ) do |out|
+        YAML.dump(loaded, out )
+    end
+    
+    sleep 5
+    ConfigLoader.reset_loader_called
+    
+    changed = ConfigLoader.loaded_file_changed_checkonly?
+    assert changed
+    
+    reloaded = ConfigLoader.load_file('test_reload.yml')
+    assert ConfigLoader.loader_called
+    assert_equal new_adapter, reloaded['test']['adapter']
+    
+    # should be under threshold of timeout
+    changed = false
+    changed = ConfigLoader.loaded_file_changed_checkonly?
+    assert !changed
+    
+    #try another file
+    another_loaded = ConfigLoader.load_file('database.yml')
+    assert_not_nil another_loaded
+    assert ConfigLoader.loader_called
+    
+    
+    loaded['test']['adapter'] = orig_adapter    
+    File.open( test_reload_file, 'w' ) do |out|
+      YAML.dump(loaded, out )
+    end
+  end
+  
+  def test_check_only
+    ConfigLoader.loaded_file_changed_checkonly?
+    ConfigLoader.instance_eval { loaded_file_changed? }
+    ConfigLoader.loaded_file_changed_checkonly?
+  end
+  
+  def test_use_alternate_base_path
+    Object.send(:remove_const, "RAILS_ROOT")
+    assert_raise(RuntimeError) {
+      ConfigurationLoader.new(false).send(:app_root)
+    }
+    top_dir = File.join(File.dirname(__FILE__), '..')
+    conf = ConfigurationLoader.new(false, top_dir)
+    assert conf.send(:app_root).first == File.expand_path(top_dir)
+  end
+  
+end
+

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'test/unit'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'config_loader')
+
+unless defined?(RAILS_ENV)
+  RAILS_ROOT = File.dirname(__FILE__) 
+  RAILS_ENV  = 'test'
+end

data/test/test_service_config.rb

@@ -0,0 +1,22 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+require 'yaml'
+
+class TestServiceConfig < Test::Unit::TestCase
+  
+  def test_service_config
+    service_yaml = YAML::load_file(File.join(File.dirname(__FILE__), 'config', 'service.yml'))
+    service_yaml['test']['search'].each do |k, v|
+      real_key = case k 
+                 when 'url'
+                   'endpoint'
+                 when 'timeout'
+                   'config_timeout'
+                 else 
+                   k
+                 end
+
+      assert ServiceConfig.send(real_key.to_sym, 'search') == v
+    end
+  end
+
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: revolutionhealth-config_loader
+version: !ruby/object:Gem::Version 
+  version: 2.0.0
+platform: ruby
+authors: 
+- Revolution Health
+autorequire: config_loader
+bindir: bin
+cert_chain: []
+
+date: 2008-06-25 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Abstracts out the loading of common configuration files such as database.yml dependent on the Rails environment
+email: rails-trunk@revolutionhealth.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- Manifest.txt
+- README
+files: 
+- Manifest.txt
+- LICENSE
+- README
+- TODO
+- Rakefile
+- lib/config_loader.rb
+- lib/service_config.rb
+- test/config
+- test/test_config_reload.rb
+- test/test_helper.rb
+- test/test_service_config.rb
+- test/config/database.yml
+- test/config/service.yml
+- test/config/test_reload.yml
+has_rdoc: true
+homepage: http://github.com/revolutionhealth/config_loader
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Provides convenience methods for the loading of configuration files
+test_files: 
+- test/test_config_reload.rb
+- test/test_service_config.rb