rails_config_loader 0.1.1

data/.document

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

data/.rspec

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

data/Gemfile

@@ -0,0 +1,12 @@
+source :rubygems
+
+gem 'hashie'
+gem 'json_pure'
+
+group :development do
+  gem "rspec", 			"~> 2.8.0"
+  gem "rdoc", 			"~> 3.12"
+  gem "bundler", 		"~> 1.1.0"
+  gem "jeweler", 		"~> 1.8.3"
+  gem "simplecov", 	">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,41 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    hashie (1.2.0)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.0)
+    json_pure (1.7.0)
+    multi_json (1.3.4)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    simplecov (0.6.2)
+      multi_json (~> 1.3)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.1.0)
+  hashie
+  jeweler (~> 1.8.3)
+  json_pure
+  rdoc (~> 3.12)
+  rspec (~> 2.8.0)
+  simplecov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Kristian Mandrup
+
+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.md

@@ -0,0 +1,58 @@
+# Config loader
+
+Nice little utility to load config files from the Rails config dir or even in other locations. Supports YAML and JSON formats that are wrapped in a Hashie for nice method and hash access.
+
+```ruby
+module MainApp
+	def self.config
+		Config.instance
+	end
+
+	class Config
+		include Singleton
+		include ConfigLoader::Delegator
+
+		# load seed file (see geo-autocomplete demo)
+		def seed
+			@seed ||= load_yaml('config/seed.yml', :dir => 'db')
+		end
+
+		# config for the app
+		# any missing method on this is delegated to the 
+		# Hashie wrapping this loaded content
+		def config
+			@config ||= load_yaml('app.yml')
+		end
+
+		# auto detect load method based on filename extension
+		def app
+			@app ||= load('app.yml')
+		end
+
+		# load json
+		def addresses locale = :da
+			@config ||= load 'data/addresses.json', :locale => get_locale(locale)
+		end
+
+		def payment_provider
+			@payment_provider ||= load_yaml('payment_gateway/quickpay.yml')
+		end
+	end
+end
+```
+
+## Contributing to config_loader
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2012 Kristian Mandrup. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "rails_config_loader"
+  gem.homepage = "http://github.com/kristianmandrup/config_loader"
+  gem.license = "MIT"
+  gem.summary = %Q{Nice little utility to load config files for Rails}
+  gem.description = %Q{Load yaml and json config files and 
+ make the structures easily available for use in the app.}
+  gem.email = "kmandrup@gmail.com"
+  gem.authors = ["Kristian Mandrup"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rails_config_loader #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/config_loader/base.rb

@@ -0,0 +1,49 @@
+require 'hashie'
+
+module ConfigLoader
+	class Base
+  	attr_reader :locale, :path, :file_name, :ext, :file_path, :root
+
+  	# will try root element if such exists
+		def initialize file_path, options = {}
+			@path 		 	= File.dirname file_path
+			@file_name 	= File.basename file_path			
+			parts 			= file_name.split(/(ya?ml$)/)
+			name 				= parts.first
+			@ext 			 	= parts.last
+			@locale 		= options[:locale]
+
+			@file_path 	= @locale ? File.join(@path, "#{@name}.#{@locale}.#{@ext}") : file_path
+
+			@dir 				= options[:dir] if options[:dir]
+			@root 		 	= (options[:root] || file_name.split('.').first).to_s			
+			@root 		 	= nil unless mashie.send(@root)
+			@mashie 	 	= mashie.send(@root) if @root
+		end
+
+		def as_hash
+			@as_hash ||= mashie
+		end
+
+		def load *args
+		end
+
+		protected
+
+		def file_content
+			File.open(config_file_path)
+		end
+
+		def dir
+			@dir ||= 'config'
+		end
+
+		def mashie
+			@mashie ||= ::Hashie::Mash.new content
+		end
+
+    def config_file_path
+    	@config_file_path ||= File.join(Rails.root.to_s, dir, file_path)
+    end
+	end
+end

data/lib/config_loader/delegator.rb

@@ -0,0 +1,12 @@
+module ConfigLoader
+	module Delegator	
+		def self.included(base)
+			base.send :include, ConfigLoader
+		end
+
+	  def method_missing(m, *args, &block)
+	  	raise "A #config method must be defined in the container for ConfigLoader::Delegator, for it to delegate to #config: delegation attempted with #{m}" unless self.respond_to?(:config)
+	    config.send(m)
+	  end
+	end
+end

data/lib/config_loader/json.rb

@@ -0,0 +1,9 @@
+require 'config_loader/base'
+
+module ConfigLoader
+  class Json < Base
+		def content
+			@content ||= JSON.parse file_content.read
+		end
+	end
+end

data/lib/config_loader/yaml.rb

@@ -0,0 +1,9 @@
+require 'config_loader/base'
+
+module ConfigLoader
+  class Yaml < Base
+		def content
+			@content ||= ::YAML::load file_content
+		end
+	end
+end

data/lib/rails_config_loader.rb

@@ -0,0 +1,24 @@
+require 'config_loader/yaml'
+require 'config_loader/json'
+require 'config_loader/delegator'
+
+module ConfigLoader
+	def load file_path, options = {}
+		ext 	 = File.basename(file_path).split(/(ya?ml|json)$/).last
+		loader = case ext.to_sym
+		when :json
+			ConfigLoader::Json
+		when :yml, :yaml
+			ConfigLoader::Yaml
+		end
+		loader.new file_path, options = {}
+	end
+
+	def load_yaml file_path, options = {}
+		ConfigLoader::Yaml.new file_path, options = {}
+	end
+
+	def load_json file_path, options = {}
+		ConfigLoader::Json.new file_path, options = {}
+	end
+end

data/rails_config_loader.gemspec

@@ -0,0 +1,79 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "rails_config_loader"
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kristian Mandrup"]
+  s.date = "2012-05-07"
+  s.description = "Load yaml and json config files and \n make the structures easily available for use in the app."
+  s.email = "kmandrup@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/config_loader/base.rb",
+    "lib/config_loader/delegator.rb",
+    "lib/config_loader/json.rb",
+    "lib/config_loader/yaml.rb",
+    "lib/rails_config_loader.rb",
+    "rails_config_loader.gemspec",
+    "spec/config_loader/yaml_spec.rb",
+    "spec/fixtures/config/app.yml",
+    "spec/fixtures/config/facebook.yml",
+    "spec/fixtures/config/htc.yml",
+    "spec/fixtures/config/payment_gateway/quickpay.da.yml",
+    "spec/fixtures/db/config/seed.yml",
+    "spec/spec_helper.rb",
+    "spec/support/main_app.rb"
+  ]
+  s.homepage = "http://github.com/kristianmandrup/config_loader"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Nice little utility to load config files for Rails"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<hashie>, [">= 0"])
+      s.add_runtime_dependency(%q<json_pure>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<hashie>, [">= 0"])
+      s.add_dependency(%q<json_pure>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<hashie>, [">= 0"])
+    s.add_dependency(%q<json_pure>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

data/spec/config_loader/yaml_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+module Rails
+	def self.root
+		File.join SPEC_DIR, 'fixtures'
+	end
+end
+
+describe ConfigLoader::Yaml do
+	subject { config }
+	let(:config) { ConfigLoader::Yaml.new('facebook.yml') }
+
+	its(:file_name) { should == 'facebook.yml' }
+	its(:root) 			{ should == 'facebook' }
+	its(:ext) 			{ should == 'yml' }
+
+	its(:content) { should_not be_nil }
+	its(:as_hash) { should be_a Hash }
+
+	specify { subject.as_hash.domain == 'www.facebook.com' }
+
+	describe 'no root' do
+		subject { config }
+		let(:config) { ConfigLoader::Yaml.new('htc.yml') }
+
+		its(:root) 	 { should == nil }
+		specify { subject.as_hash.domain == 'www.htc.com' }
+	end
+
+	describe 'specific root' do
+		subject { config }
+		let(:config) { ConfigLoader::Yaml.new('htc.yml', :root => 'root') }
+
+		its(:root) 	 { should == 'root' }
+		specify { subject.as_hash.domain == 'www.htc.dk' }
+	end
+end
+
+describe 'Delegator' do
+	subject { config }
+	let(:config) { MainApp.config }
+
+	specify { subject.as_hash.name.should == 'HTC' }
+end
+
+describe '.load' do
+	subject { app }
+	let(:app) { MainApp.config.app }
+
+	specify { subject.as_hash.name.should == 'HTC' }
+end

data/spec/fixtures/config/app.yml

@@ -0,0 +1,2 @@
+app:
+  name: HTC

data/spec/fixtures/config/facebook.yml

@@ -0,0 +1,3 @@
+facebook:
+  domain: www.facebook.com
+  app_id: 12345

data/spec/fixtures/config/htc.yml

@@ -0,0 +1,3 @@
+domain: www.htc.com
+root:
+  domain: www.domain.dk

data/spec/fixtures/config/payment_gateway/quickpay.da.yml

@@ -0,0 +1,21 @@
+# https://github.com/Shopify/active_merchant/blob/master/test/fixtures.yml
+development:
+  login: demo@quickpay.net
+  password: test234
+  api_key: MIl16LPa152HZB6wA4dN
+  version: 4
+
+cards:
+  visa_no_cvv2: 4000300011112220
+  visa: 4000100011112224
+  dankort: 5019717010103742
+
+
+test:
+  login: demo@quickpay.net
+  password: test234
+  api_key: MIl16LPa152HZB6wA4dN
+  version: 4
+
+production:
+  api_key:

data/spec/fixtures/db/config/seed.yml

@@ -0,0 +1,14 @@
+user:
+	tenant: 700
+	landlord: 500
+	both: 20
+
+# 500 total
+property: 
+	room_share: 15
+	1_room: 50
+	2_rooms: 200
+	3_rooms: 100
+	many_rooms: 100
+	house: 30
+	house_boat: 5

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rspec'
+require 'rails_config_loader'
+
+SPEC_DIR = File.dirname(__FILE__)
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

data/spec/support/main_app.rb

@@ -0,0 +1,33 @@
+require 'json/pure'
+require 'singleton'
+
+module MainApp
+	def self.config
+		Config.instance
+	end
+
+	class Config
+		include Singleton
+		include ConfigLoader::Delegator
+
+		# load seed file (see geo-autocomplete demo)
+		def seed
+			@seed ||= load_yaml('config/seed.yml', :dir => 'db')
+		end
+
+		# config for the app
+		# any missing method on this is delegated to the Hashie wrapping this # loaded content
+		def config
+			@config ||= load_yaml('app.yml')
+		end
+
+		# auto detect load method based on filename
+		def app
+			@app ||= load('app.yml')
+		end
+
+		def payment_provider
+			@payment_provider ||= load_yaml('payment_gateway/quickpay.yml')
+		end
+	end
+end

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: rails_config_loader
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Kristian Mandrup
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json_pure
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "Load yaml and json config files and \n make the structures easily
+  available for use in the app."
+email: kmandrup@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/config_loader/base.rb
+- lib/config_loader/delegator.rb
+- lib/config_loader/json.rb
+- lib/config_loader/yaml.rb
+- lib/rails_config_loader.rb
+- rails_config_loader.gemspec
+- spec/config_loader/yaml_spec.rb
+- spec/fixtures/config/app.yml
+- spec/fixtures/config/facebook.yml
+- spec/fixtures/config/htc.yml
+- spec/fixtures/config/payment_gateway/quickpay.da.yml
+- spec/fixtures/db/config/seed.yml
+- spec/spec_helper.rb
+- spec/support/main_app.rb
+homepage: http://github.com/kristianmandrup/config_loader
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1179121962009242759
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Nice little utility to load config files for Rails
+test_files: []