configloader 0.2.2 → 0.3.0

data/README.rdoc

@@ -44,12 +44,19 @@ If you need to create a custom config file for you Rails project, ConfigLoader w
       db_config['port']                       # 5984
       db_config['database_name']              # addressbook_production
   
-  Finally, you can specify the project root too. If you don't, it will assume the project root is Rails.root.
+  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')
+      
+  Dinamic keys are also accepted. They're parsed using ERB. So, you're free to write a config file like this:
+
+    test:
+      server: <%= `hostname` %>
+      port: 5984
+      database_name: addressbook_test
 
 == Note on Patches/Pull Requests
  

data/Rakefile

@@ -5,7 +5,7 @@ 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.summary = %Q{ConfigLoader makes it easy to load the values of a custom configuration file in a Rails project or in a regular Ruby 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"

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.3.0

data/configloader.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{configloader}
-  s.version = "0.2.2"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Vinicius Teles"]
-  s.date = %q{2010-09-28}
+  s.date = %q{2011-02-07}
   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 = [
@@ -32,8 +32,9 @@ Gem::Specification.new do |s|
      "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/alternative_root_dir/config/database.yml",
      "spec/config_loader_spec.rb",
+     "spec/root_dir/config/database.yml",
      "spec/spec.opts",
      "spec/spec_helper.rb"
   ]
@@ -41,10 +42,9 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
-  s.summary = %q{ConfigLoader makes it easy to load the values of a custom configuration file in a Rails project.}
+  s.summary = %q{ConfigLoader makes it easy to load the values of a custom configuration file in a Rails project or in a regular Ruby project.}
   s.test_files = [
-    "spec/config_loader/map_spec.rb",
-     "spec/config_loader_spec.rb",
+    "spec/config_loader_spec.rb",
      "spec/spec_helper.rb"
   ]
 

data/lib/config_loader.rb

@@ -2,7 +2,6 @@ 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:
@@ -36,13 +35,19 @@ module ConfigLoader
   #     db_config['port']                       # 5984
   #     db_config['database_name']              # addressbook_production
   # 
-  # 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:
+  # 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')  
+  #
+  # Dinamic keys are also accepted. They're parsed using ERB. So, you're free to write a config file like this:
+  #
+  #     test:
+  #       server: <%= `hostname` %>
+  #       port: 5984
+  #       database_name: addressbook_test
   def self.load(file_name, running_env = Rails.env, project_root = Rails.root.to_s)
     ConfigLoader::Map.new(file_name, running_env, project_root).load
   end
-  
 end

data/lib/config_loader/map.rb

@@ -1,9 +1,8 @@
+require 'erb'
 require 'yaml'
 
 module ConfigLoader
-  
   class Map
-    
     attr_reader :file_name, :running_env, :project_root
 
     def initialize(file_name, running_env, project_root)
@@ -14,8 +13,8 @@ module ConfigLoader
     end
     
     def file_content
-      raise MissingConfigFileError unless File.exists?(full_file_name)
-      File.open(full_file_name) { |file| YAML::load(file) }
+      raise MissingConfigFileError.new(full_file_name) unless File.exists?(full_file_name)
+      YAML.load(ERB.new(File.read(full_file_name)).result)
     end
     
     def full_file_name
@@ -29,7 +28,5 @@ module ConfigLoader
     def method_missing(method_name)
       self[method_name]
     end
-
   end
-  
-end
+end

data/lib/config_loader/missing_config_file_error.rb

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

data/lib/config_loader/missing_config_file_name_error.rb

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

data/spec/alternative_root_dir/config/database.yml

@@ -0,0 +1,9 @@
+development: 
+  server: localhost
+  port: 5984
+  name: alternative_customers_development
+
+test:
+  server: localhost
+  post: 5985
+  name: alternative_customers_test

data/spec/config_loader_spec.rb

@@ -1,35 +1,39 @@
 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)
-      Rails.stub!(:root).and_return('/home/user/project')
-      ConfigLoader::Map.should_receive(:new).with('database', running_env, project_root).and_return(@map_mock)
-      @map_mock.should_receive(:load).and_return('config')
+  before(:each) do
+    @root_dir = File.expand_path(File.join(File.dirname(__FILE__), "..", "spec", "root_dir"))
+    Rails.stub!(:root).and_return(@root_dir)
+    Rails.stub!(:env).and_return('development')
+  end
+
+  describe ".load" do    
+    it "raises exception when no config file name is given" do
+      lambda { ConfigLoader.load(nil) }.should raise_error(ConfigLoader::MissingConfigFileNameError)
     end
     
-    before(:each) do
-      @map_mock = mock('ConfigLoader::Map')
+    it "raises exception when the config file can't be found" do
+      lambda { ConfigLoader.load('database', 'development', 'invalid_location') }.should raise_error(ConfigLoader::MissingConfigFileError)
     end
     
-    it "should delegate to ConfigLoader::Map.populate" do
-      prepare_mocks('development', '/home/user/project')      
-      ConfigLoader.load('database').should == 'config'
+    it "loads keys for Rails.env from the config file located in Rails.root/config" do
+      ConfigLoader.load('database')['name'].should == 'customers_development'
     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 == 'config'
+    it "loads keys for the given environament from the config file located in Rails.root/config" do
+      ConfigLoader.load('database', 'test')['name'].should == 'customers_test'
     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 == 'config'
+    it "loads keys for the given environmanent from the config file located under the given directory/config" do
+      alternative_root_dir = File.expand_path(File.join(File.dirname(__FILE__), "..", "spec", "alternative_root_dir"))
+      ConfigLoader.load('database', 'development', alternative_root_dir)['name'].should == 'alternative_customers_development'
     end
 
+    it "loads dinamic keys" do
+      # KEY:
+      #   name: <%= "CUSTOMERS".downcase %>_test
+      config = ConfigLoader.load('database', 'test')
+      config['name'].should == 'customers_test'
+    end
   end
-
 end

data/spec/root_dir/config/database.yml

@@ -0,0 +1,9 @@
+development: 
+  server: localhost
+  port: 5984
+  name: customers_development
+
+test:
+  server: localhost
+  post: 5985
+  name: <%= "CUSTOMERS".downcase %>_test

data/spec/spec_helper.rb

@@ -6,6 +6,3 @@ require 'spec/autorun'
 
 class Rails
 end
-
-Spec::Runner.configure do |config|
-end

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 2
-  version: 0.2.2
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Vinicius Teles
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-28 00:00:00 -03:00
+date: 2011-02-07 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -59,8 +59,9 @@ files:
 - 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/alternative_root_dir/config/database.yml
 - spec/config_loader_spec.rb
+- spec/root_dir/config/database.yml
 - spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: true
@@ -96,8 +97,7 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: ConfigLoader makes it easy to load the values of a custom configuration file in a Rails project.
+summary: ConfigLoader makes it easy to load the values of a custom configuration file in a Rails project or in a regular Ruby project.
 test_files: 
-- spec/config_loader/map_spec.rb
 - spec/config_loader_spec.rb
 - spec/spec_helper.rb

data/spec/config_loader/map_spec.rb

@@ -1,75 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
-require 'yaml'
-
-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 ".load" do
-
-      it "should load config for a specific running environment" do
-        development_config = {  'server'        => 'localhost',
-                                'port'          => 5984,
-                                'name'          => 'customers' }
-        file_content = { 'development' => development_config }
-        @config_loader.should_receive(:file_content).and_return(file_content)
-        @config_loader.load.should == development_config
-      end
-
-    end
-
-  end
-
-end