brodock-config-file-loader 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/CHANGELOG

@@ -0,0 +1,2 @@
+0.1.0
+Initial Version

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 kbrock
+
+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/README.markdown

@@ -0,0 +1,75 @@
+# config-file-loader
+
+Inspired/ ripped off from ryan bate's great railscast
+
+[http://railscasts.com/episodes/85-yaml-configuration-file]()
+
+## features
+
+* configuration file is in yaml
+* supports erb in yaml file
+* assumes/adds yml extension
+* assumes file is in RAILS_ROOT/config
+* can override config file location per file (using an absolute or relative path) or globally 
+* allows custom override files, so for local developers or production per machine values
+* different variable values for different "Rails" environments.
+* works in Rails, but also in non rails-projects.
+
+## planned features
+
+* monitoring files and updating upon file changes using fsevents.
+* database based config values
+* memcache config values
+* ui to see and edit variables (will save to db/memcache - probably not file)
+
+## file format
+
+  supports aliases, erb, and any yaml construct.
+
+    defaults: &defaults
+      d1: v1
+      d2: v2
+    development:
+      <<: *defaults
+      attribute1: value1
+      attribute2:
+        attribute2a: value2a
+        attribute2b: value2b
+      attribute3: <%= ENV['USER'] %>
+    test:
+      <<: *defaults
+      attribute1: value1b
+    ...
+
+override file:
+
+    development:
+      attribute2:
+        attribute2a: replaced-value2a
+
+If you are nesting hashes within a file, remember that yaml will replace the whole hash.
+
+But a separate override file will merge in values. So in development, only attribute2a will be replaced.
+
+## usage
+
+    APP_CONFIG = ConfigFileLoader.load(
+      'app_config.yml',
+      'app_config_local.yml',
+      '/opt/local/config/app_config_override.yml'
+    )
+
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 kbrock. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "brodock-config-file-loader"
+    gem.summary = %Q{Load config files from disk}
+    gem.description = %Q{simple way to load erb yaml config files. based upon http://railscasts.com/episodes/85-yaml-configuration-file with OpenStruct support}
+    gem.email = "brodock@gmail.com"
+    gem.homepage = "http://github.com/brodock/config-file-loader"
+    gem.authors = ["kbrock", "brodock"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "brodock-config-file-loader #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/init.rb

@@ -0,0 +1 @@
+require 'config_file_loader'

data/lib/config-file-loader.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/config_file_loader'

data/lib/config_file_loader.rb

@@ -0,0 +1,121 @@
+require 'erb'
+require 'yaml'
+require 'ostruct'
+class ConfigFileLoader
+
+  ## base directory for configuration
+  ## typically in rails root / config
+  def self.base
+    if defined?(@@base)
+      @@base
+    elsif defined?(Rails)
+      @@base||="#{Rails.root}/config/"
+    else
+      @@base||=File.expand_path(File.dirname(__FILE__)) + "/config/"
+    end
+  end
+
+  def self.base=(val)
+    @@base=val
+  end
+
+
+  def self.env
+    if defined?(@@env)
+      @@env
+    elsif defined?(RAILS_ENV)
+      RAILS_ENV
+    end
+    #else nil
+  end
+  
+  def self.env=(val)
+    @@env=val
+  end
+
+  def self.load_no_symbolize_keys(*files)
+    load_files(*files)
+  end
+
+  def self.load_as_struct(*files)
+    OpenStruct.new(load_files(*files))
+  end
+
+  def self.load(*files, &block)    
+    block=lambda() { |hash| self.deep_symbolize_keys(hash) } unless block_given?
+    load_files(*files,&block)
+  end
+  
+  def self.load_files(*files, &block)
+    raw_hash = nil
+    files.each do |file_name|
+      second_hash = contents(file_name)
+      second_hash = yield second_hash if block_given?
+      raw_hash=deep_merge(raw_hash,second_hash)
+    end
+    raw_hash
+  end
+  
+  #add .yml or rails config root if necessary
+  def self.fix_name(name)
+    return unless name.is_a?(String)
+    #if it is not relative ('./file') or absolute ('/a/b/file') - tack on config directory
+    name = "#{self.base}/#{name}" unless ['.','/','~'].include?(name[0,1])
+    name+=".yml" unless name.include?('yml') || name.include?('cfg')
+    name
+  end
+
+  def self.contents(file_name)
+    if file_name.nil?
+      nil
+    elsif (file_name.is_a?(Hash))
+      file_name
+    else
+      file_name=fix_name(file_name)
+      load_erb_yaml(file_name) if File.exist?(file_name)
+    end
+  end
+
+  def self.load_erb_yaml(file_name)
+    raw_config = ERB.new(File.read(file_name)).result
+    yaml_config = YAML.load(raw_config)
+    yaml_config = yaml_config[env] || yaml_config[env.to_s] if env
+    yaml_config
+  end
+  
+  # def self.deep_merge(target, extra)
+  #   (target && extra) ? target.deep_merge(extra) : (target || extra)
+  # end
+
+  # http://snippets.dzone.com/posts/show/4706
+  # http://www.francisfish.com/deep_merge_a_ruby_hash_the_joys_of_recursion.htm
+  # rails already defines this
+  # return target.deep_merge(extra) if target.respond_to?(:deep_merge)
+  def self.deep_merge(target, extra)
+    # return something if either is nil
+    return target || extra if target.nil? || extra.nil?
+
+    extra.each_key do |k1|
+      # if the key exists in both sides and they are both "hashes", merge
+      # could move this block to the first line, but may want special logic for lists
+      if target.key?(k1) && target[k1].respond_to?(:each_key) && extra[k1].respond_to?(:each_key)
+        target[k1] = deep_merge(target[k1],extra[k1])
+      else
+        target[k1] = extra[k1] #dup?
+      end
+    end
+    target    
+  end
+
+  def self.deep_symbolize_keys(hash)
+    return hash unless hash.is_a?(Hash)
+
+    #hash.symbolize_keys
+    hash.inject({}) do |options, (key, value)|
+      value=deep_symbolize_keys(value) if value.is_a?(Hash)
+      options[(key.to_sym rescue key) || key] = value
+      options
+    end
+    #ret inject value
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'config_file_loader'

data/spec/config/a.yml

@@ -0,0 +1,9 @@
+---
+a:
+  aa:
+    aaa: 111
+c:
+  aa: 11
+  cc:
+    ccc: 111
+    aaa: 111

data/spec/config/b.yml

@@ -0,0 +1,9 @@
+---
+b:
+  bb:
+    bbb: 222
+c:
+  bb: 22
+  cc:
+    ccc: 222
+    bbb: 222

data/spec/config/dev_prod.yml

@@ -0,0 +1,6 @@
+development:
+  fun: yes
+  uptime_percentage: 5
+production:
+  fun: no
+  uptime_percentage: 99.9

data/spec/config_file_loader_spec.rb

@@ -0,0 +1,68 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+#require '/spec_helper'
+
+describe ConfigFileLoader do
+  context "load" do
+    it "should handle no files" do
+      l().should == nil
+    end
+
+    it "should load empty hash" do
+      l({}).should == {}
+    end
+
+    it "should load 1 hash with symbold" do
+      l({:a => 1}).should == {:a => 1}
+    end
+
+    it "should load 1 hash symbolize" do
+      l({"a" => 1}).should == {:a => 1}
+    end
+
+    it "should load 1 hash not symbolize" do
+      ConfigFileLoader.load_no_symbolize_keys({"a" => 1}).should == {"a" => 1}
+    end
+
+    it "should load hash using custom hash 'fixing' function" do
+      ret=l({"c" => 1}, {:c => 2}) do |hash|
+        hash.inject({}) do |options, (key, value)|
+          options[key.to_s.upcase]=value
+          options
+        end
+      end
+      ret.should == {"C" => 2}
+    end
+
+    it "should handle file not found" do
+      l({},'bogus.yml').should == {}
+    end
+
+    it "should load 1 file" do
+      l('a').should ==
+        {:a=>{:aa=>{:aaa=>111}}, :c=>{:cc=>{:aaa=>111, :ccc=>111}, :aa=>11}}
+    end
+
+    it "should load 2 files and merge" do
+      l('a','b').should ==
+        {:b=>{:bb=>{:bbb=>222}}, :c=>{:aa=>11, :bb=>22, :cc=>{:ccc=>222, :bbb=>222, :aaa=>111}}, :a=>{:aa=>{:aaa=>111}}}
+    end
+
+    context "dev_prod" do
+      it "should load dev properties" do
+        ConfigFileLoader.env='development'
+        l('dev_prod').should == {:fun => true, :uptime_percentage => 5}
+        ConfigFileLoader.env=nil #back to testing default
+      end
+
+      it "should load prod properties" do
+        ConfigFileLoader.env='production'
+        l('dev_prod').should == {:fun => false, :uptime_percentage => 99.9}
+        ConfigFileLoader.env=nil #back to testing default
+      end
+    end
+  end
+
+  def l(*files,&block)
+    ConfigFileLoader.load(*files,&block)
+  end
+end

data/spec/deep_merge_spec.rb

@@ -0,0 +1,66 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+#require '/spec_helper'
+
+describe ConfigFileLoader do
+  context "deep merge" do
+    it "should merge with no target" do
+      dm({},{}).should == {}
+    end
+    
+    it "should merge with no target 2" do
+      dm(nil,nil).should == nil
+    end
+      
+    it "should merge with source" do
+      dm({:a=>1},{}).should == {:a=>1}
+    end
+  
+    it "should merge with source 2" do
+      dm({:a=>1},nil).should == {:a=>1}
+    end
+  
+    it "should merge with target" do
+      dm({},{:b=>1}).should == {:b=>1}
+    end
+  
+    it "should merge with target 2" do
+      dm(nil,{:b=>1}).should == {:b=>1}
+    end
+  
+    it "should take override over source" do
+      dm({:c => 1},{:c=>2}).should == {:c=>2}
+    end
+  
+    context "in a hash" do
+      it "should merge with source" do
+        dm({:c =>{:aa=>1}},{}).should == {:c => {:aa=>1}}
+      end
+  
+      it "should merge with target" do
+        dm({},{:c=>{:bb=>1}}).should == {:c => {:bb=>1}}
+      end
+  
+      it "should merge both" do
+        dm({:c=>{:aa => 1}},{:c =>{:bb => 2}}).should == {:c=>{:aa=>1, :bb => 2}}
+      end
+  
+      it "should take override over source" do
+        dm({:c => {:cc=>1}},{:c=>{:cc=>2}}).should == {:c=>{:cc=>2}}
+      end
+    end
+    
+    context "half hash" do
+      it "should replace single value with hash" do
+        dm({:c => :a},{:c => {:b => 1}}).should == {:c => {:b => 1}}
+      end
+  
+      it "should replace hash with single value" do
+        dm({:c => {:a => 1}}, {:c => :b}).should == {:c => :b}
+      end
+    end
+  end
+
+  def dm(a,b)
+    ConfigFileLoader.deep_merge(a,b)
+  end
+end

data/spec/filename_spec.rb

@@ -0,0 +1,39 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+#require '/spec_helper'
+
+describe ConfigFileLoader do
+  context "fix file name" do
+    it "should handle fienames with a slash and yml" do
+      fn("/a.yml").should == "/a.yml"
+    end
+  
+    it "should handle fienames with a slash and cfg" do
+      fn("/a.cfg").should == "/a.cfg"
+    end
+  
+    it "should add yml to the filename" do
+      fn("/a").should == "/a.yml"
+    end
+  
+    it "should add directory to filename" do
+      rslt=fn("a.yml")
+      rslt.index('/').should == 0 #starts with slash
+      rslt.index('a.yml').should == rslt.length - 5
+      rslt.index('/config/').should_not be_nil
+    end
+  
+    it "should add directory and yml to filename" do
+      rslt=fn("a")
+      rslt.index('/').should == 0 #starts with slash
+      rslt.index('a.yml').should == rslt.length - 5
+    end
+  
+    it "should leave directory alone if it starts with a ." do
+      fn("./abc.yml").should == "./abc.yml"
+    end
+  end
+
+  def fn(a)
+    ConfigFileLoader.fix_name(a)
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'config_file_loader'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  ConfigFileLoader.base = File.join(File.dirname(__FILE__),'config/')
+end

data/spec/symbolize_keys_spec.rb

@@ -0,0 +1,24 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+#require '/spec_helper'
+
+describe ConfigFileLoader do
+  context "symbolize keys" do
+    it "should handle nil" do
+      sk(nil).should == nil
+    end
+  
+    it "should handle string key" do
+      sk({"a" => 1}).should == {:a => 1}
+    end
+    it "should handle symbol key" do
+      sk({:a => 1}).should == {:a => 1}
+    end
+    it "should handle nested strings" do
+      sk({"a" => {"aa" => 1}}).should == {:a => {:aa => 1}}
+    end
+  end
+
+  def sk(a)
+    ConfigFileLoader.deep_symbolize_keys(a)
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: brodock-config-file-loader
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- kbrock
+- brodock
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-20 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: simple way to load erb yaml config files. based upon http://railscasts.com/episodes/85-yaml-configuration-file with OpenStruct support
+email: brodock@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- CHANGELOG
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- init.rb
+- lib/config-file-loader.rb
+- lib/config_file_loader.rb
+- rails/init.rb
+- spec/config/a.yml
+- spec/config/b.yml
+- spec/config/dev_prod.yml
+- spec/config_file_loader_spec.rb
+- spec/deep_merge_spec.rb
+- spec/filename_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/symbolize_keys_spec.rb
+has_rdoc: true
+homepage: http://github.com/brodock/config-file-loader
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Load config files from disk
+test_files: 
+- spec/config_file_loader_spec.rb
+- spec/deep_merge_spec.rb
+- spec/filename_spec.rb
+- spec/spec_helper.rb
+- spec/symbolize_keys_spec.rb