configloader 0.1.0

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/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Vinicius Teles
+
+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.rdoc

@@ -0,0 +1,66 @@
+= configloader
+
+If you need to create a custom config file for you Rails project, ConfigLoader will help you to load the contents of this file.
+
+== How to install the gem
+
+  gem install configloader
+
+== Usage
+
+  ConfigLoader.load(file_name, running_env, project_root)
+  
+  Let's assume that you have the special file config/database.yml in your Rails project.
+  In this example, you are using CouchDB as your database. This file has the content below:
+  
+      development:
+        server: localhost
+        port: 5984
+        database_name: addressbook_development
+  
+      test:
+        server: localhost
+        port: 5984
+        database_name: addressbook_development
+  
+      production:
+        server: production.server.com
+        port: 5984
+        database_name: addressbook_development
+  
+  In order to access the database configuration for your current environment, you'd write, for instance:
+  
+      db_config = ConfigLoader.load('database')
+      db_config['server'] # localhost
+      db_config[:server]  # localhost
+      db_config.server    # localhost
+  
+  We're assuming that your current environment is development.
+  
+  You can get the configuration of a specific running environment writing this:
+  
+      db_config = ConfigLoader.load('database', 'production')
+      db_config['server'] # production.server.com
+      db_config[:server]  # production.server.com
+      db_config.server    # production.server.com
+  
+  Finally, you can specify the project root too. If you don't, it will assume the project root is RAILS_ROOT.
+  To change it, write:
+  
+  
+      db_config = ConfigLoader.load('database', 'production')
+      db_config = ConfigLoader.load('database', 'test', '/home/user/my_special_project_root')
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add specs 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 Vinicius Teles. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,44 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "configloader"
+    gem.summary = %Q{ConfigLoader makes it easy to load the values of a custom configuration file in a Rails project.}
+    gem.description = %Q{If you need to create a custom config file for you project, ConfigLoader will help you to load the contents of this file.}
+    gem.email = "vinicius@improveit.com.br"
+    gem.homepage = "http://github.com/viniciusteles/configloader"
+    gem.authors = ["Vinicius Teles"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+  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 = "configloader #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/configloader.gemspec

@@ -0,0 +1,61 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{configloader}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Vinicius Teles"]
+  s.date = %q{2010-05-17}
+  s.description = %q{If you need to create a custom config file for you project, ConfigLoader will help you to load the contents of this file.}
+  s.email = %q{vinicius@improveit.com.br}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "configloader.gemspec",
+     "lib/config_loader.rb",
+     "lib/config_loader/map.rb",
+     "lib/config_loader/missing_config_file_error.rb",
+     "lib/config_loader/missing_config_file_name_error.rb",
+     "lib/configloader.rb",
+     "spec/config_loader/map_spec.rb",
+     "spec/config_loader_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/viniciusteles/configloader}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{ConfigLoader makes it easy to load the values of a custom configuration file in a Rails project.}
+  s.test_files = [
+    "spec/config_loader/map_spec.rb",
+     "spec/config_loader_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/lib/config_loader.rb

@@ -0,0 +1,48 @@
+dependencies = %w(missing_config_file_name_error missing_config_file_error map)
+dependencies.each { |dependency| require "config_loader/#{dependency}" }
+
+module ConfigLoader
+  
+  # Let's assume that you have the special file config/database.yml in your Rails project. In this example, you are using CouchDB as your database. This file has the content below:
+  # 
+  #     development:
+  #       server: localhost
+  #       port: 5984
+  #       database_name: addressbook_development
+  # 
+  #     test:
+  #       server: localhost
+  #       port: 5984
+  #       database_name: addressbook_development
+  # 
+  #     production:
+  #       server: production.server.com
+  #       port: 5984
+  #       database_name: addressbook_development
+  # 
+  # In order to access the database configuration for your current environment, you'd write, for instance:
+  # 
+  #     db_config = ConfigLoader.load('database')
+  #     db_config['server'] # localhost
+  #     db_config[:server]  # localhost
+  #     db_config.server    # localhost
+  # 
+  # We're assuming that your current environment is development.
+  # 
+  # You can get the configuration of a specific running environment writing this:
+  # 
+  #     db_config = ConfigLoader.load('database', 'production')
+  #     db_config['server'] # production.server.com
+  #     db_config[:server]  # production.server.com
+  #     db_config.server    # production.server.com
+  # 
+  # Finally, you can specify the project root too. If you don't, it will assume the project root is RAILS_ROOT. To change it, write:
+  # 
+  # 
+  #     db_config = ConfigLoader.load('database', 'production')
+  #     db_config = ConfigLoader.load('database', 'test', '/home/user/my_special_project_root')  
+  def self.load(file_name, running_env = Rails.env, project_root = RAILS_ROOT)
+    ConfigLoader::Map.new(file_name, running_env, project_root).populate
+  end
+  
+end

data/lib/config_loader/map.rb

@@ -0,0 +1,36 @@
+module ConfigLoader
+  
+  class Map < Hash
+    
+    attr_reader :file_name, :running_env, :project_root
+
+    def initialize(file_name, running_env, project_root)
+      raise MissingConfigFileNameError unless file_name
+      @file_name    = "#{file_name}.yml"
+      @running_env  = running_env
+      @project_root = project_root
+    end
+    
+    def file_content
+      raise MissingConfigFileError unless File.exists?(full_file_name)
+      File.open(full_file_name) { |file| YAML::load(file) }
+    end
+    
+    def full_file_name
+      "#{project_root}/config/#{file_name}"
+    end
+    
+    def populate
+      file_content[@running_env].each do |key, value|
+        self[key] = value
+        self[key.to_sym] = value
+      end
+    end
+    
+    def method_missing(method_name)
+      self[method_name]
+    end
+
+  end
+  
+end

data/lib/config_loader/missing_config_file_error.rb

@@ -0,0 +1,11 @@
+module ConfigLoader
+
+  class MissingConfigFileError < RuntimeError
+
+    def initialize
+      super("The config file couldn't be found.")
+    end
+
+  end
+
+end

data/lib/config_loader/missing_config_file_name_error.rb

@@ -0,0 +1,11 @@
+module ConfigLoader
+
+  class MissingConfigFileNameError < ArgumentError
+    
+    def initialize
+      super('You must provide a config file name.')
+    end
+    
+  end
+
+end

data/lib/configloader.rb

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

data/spec/config_loader/map_spec.rb

@@ -0,0 +1,83 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+module ConfigLoader
+  
+  describe "Map" do
+  
+    before(:each) do
+      Rails.stub!(:env).and_return('development')
+      @config_loader = Map.new("database", 'development', '/home/user/project')
+    end
+  
+    describe "initialize" do
+      
+      it "should raise appropriate exception when no config file name is given" do
+        lambda { Map.new(nil, nil, nil) }.should raise_error(MissingConfigFileNameError)
+      end
+
+      it "should store the configuration file name" do
+        @config_loader.file_name.should == 'database.yml'
+      end
+
+      it "should store the given running environment" do
+        config_loader = Map.new("database", "production", '/home/user/project')
+        config_loader.running_env.should == 'production'
+      end
+      
+      it "should store the given project root" do
+        config_loader = Map.new("database", "development", "/home/user/another_project")
+        config_loader.project_root.should == "/home/user/another_project"
+      end
+      
+    end
+    
+    describe ".full_file_name" do
+
+      it "should return the full path of the configuration file name" do
+        @config_loader.full_file_name.should == '/home/user/project/config/database.yml'
+      end
+
+    end
+    
+    describe ".file_content" do
+
+      it "should load the contents of the YAML file" do
+        file_mock = mock('File')
+        File.should_receive(:exists?).with('/home/user/project/config/database.yml').and_return(true)
+        File.should_receive(:open).with('/home/user/project/config/database.yml').and_yield(file_mock)
+        YAML.should_receive(:load).with(file_mock).and_return({ 'development' => 'content'})
+        @config_loader.file_content.should == { 'development' => 'content'}
+      end
+      
+      it "should raise appropriate exception when the config file is not found" do
+        File.should_receive(:exists?).with('/home/user/project/config/database.yml').and_return(false)
+        lambda { @config_loader.file_content }.should raise_error(MissingConfigFileError)
+      end
+
+    end
+    
+    describe ".populate" do
+
+      it "should load config for a specific running environment" do
+        file_content = { 'development' => 
+                            { 'server'        => 'localhost',
+                              'port'          => 5984,
+                              'name'          => 'customers' } }
+        @config_loader.should_receive(:file_content).and_return(file_content)
+        @config_loader.populate
+        @config_loader['server'].should == 'localhost'
+        @config_loader[:server].should  == 'localhost'
+        @config_loader.server.should    == 'localhost'
+        @config_loader['port'].should   == 5984
+        @config_loader[:port].should    == 5984
+        @config_loader.port.should      == 5984
+        @config_loader['name'].should   == 'customers'
+        @config_loader[:name].should    == 'customers'
+        @config_loader.name.should      == 'customers'
+      end
+
+    end
+
+  end
+
+end

data/spec/config_loader_spec.rb

@@ -0,0 +1,31 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "ConfigLoader" do
+  
+  describe ".load" do
+    
+    def prepare_mocks(running_env, project_root)
+      Rails.stub!(:env).and_return(running_env)
+      map_mock = mock('ConfigLoader::Map')
+      map_mock.should_receive(:populate).and_return('result')
+      ConfigLoader::Map.should_receive(:new).with('database', running_env, project_root).and_return(map_mock)
+    end
+    
+    it "should delegate to ConfigLoader::Map.populate" do
+      prepare_mocks('development', '/home/user/project')      
+      ConfigLoader.load('database').should == 'result'
+    end
+    
+    it "should delegate to ConfigLoader::Map.populate with the given running_env" do
+      prepare_mocks('production', '/home/user/project')      
+      ConfigLoader.load('database', 'production').should == 'result'
+    end
+
+    it "should delegate to ConfigLoader::Map.populate with the given project_root" do
+      prepare_mocks('development', '/home/user/another_project')      
+      ConfigLoader.load('database', 'development', '/home/user/another_project').should == 'result'
+    end
+
+  end
+
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'configloader'
+require 'spec'
+require 'spec/autorun'
+
+RAILS_ROOT = '/home/user/project'
+
+class Rails
+end
+
+
+Spec::Runner.configure do |config|
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: configloader
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Vinicius Teles
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-17 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: If you need to create a custom config file for you project, ConfigLoader will help you to load the contents of this file.
+email: vinicius@improveit.com.br
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- configloader.gemspec
+- lib/config_loader.rb
+- lib/config_loader/map.rb
+- lib/config_loader/missing_config_file_error.rb
+- lib/config_loader/missing_config_file_name_error.rb
+- lib/configloader.rb
+- spec/config_loader/map_spec.rb
+- spec/config_loader_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/viniciusteles/configloader
+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: ConfigLoader makes it easy to load the values of a custom configuration file in a Rails project.
+test_files: 
+- spec/config_loader/map_spec.rb
+- spec/config_loader_spec.rb
+- spec/spec_helper.rb