multi_config 0.1.6 → 0.1.8

data/CHANGELOG.md

@@ -1,9 +1,14 @@
-Unreleased ([changes](https://github.com/shadabahmed/multi_config/v0.1.6...master))
+Unreleased ([changes](https://github.com/shadabahmed/multi_config/v0.1.8...master))
 -------------------
 **Note: Not implemented yet**
+  * Add generators for migrations
 
-  * Further refactoring
-  * Add generators for migration
+v0.1.8, 2012-09-10 ([changes](https://github.com/shadabahmed/multi_config/compare/v0.1.6...v0.1.8))
+-------------------
+  * Test for initializers added. Coverage results now 100%
+  * Refactoring of spec
+  * More documentation
+  * 100% rdoc documentation coverage
 
 v0.1.6, 2012-09-09 ([changes](https://github.com/shadabahmed/multi_config/compare/v0.1.1...v0.1.6))
 -------------------

data/README.md

@@ -31,7 +31,6 @@ Or, from the command line:
     test:
       <<: *development
 
-
 ## Notes
 All database config files should be similar to the database.yml. You need to specify configuration for all the environments
 in use like you would specify in database.yml.
@@ -45,7 +44,6 @@ If you need to create migrations for the other db, then you will have to make mo
 [guide](http://stackoverflow.com/questions/1404620/using-rails-migration-on-different-database-than-standard-production-or-devel) on
 how to do that. The parameter for `establish_connection` would be the namespaced key for you config.
 
-
 ## Versions
 All versions require Rails 3.0.x and higher.
 
@@ -62,8 +60,14 @@ All versions require Rails 3.0.x and higher.
 - 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.
+- Send me a pull request
 - 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.
 
+## Development
+ - Run tests - `rake`
+ - Generate test coverage report - `rake coverage`. Coverage report path - coverage/index.html
+ - Generate documentation - `rake rdoc`
+
 ## Copyright
 
 Copyright (c) 2012 Shadab Ahmed, released under the MIT license

data/lib/multi_config/orms/active_record.rb

@@ -3,6 +3,9 @@ module MultiConfig
   module ORMs
     # Implementation for the ActiveRecord ORM
     module ActiveRecord
+      # Method called when the module is included.
+      # * +mod+ - Name of the class including this module.
+      # Calls mod.extend with param ClassMethods so that methods in ClassMethods module become class methods of the class.
       def self.included(mod)
         mod.extend ClassMethods
         # Setting @@db_configs in the including class. This will help us keep track of database configuration files already included

data/lib/multi_config/version.rb

@@ -1,4 +1,4 @@
 module MultiConfig
   # Gem version
-  VERSION = "0.1.6"
+  VERSION = "0.1.8"
 end

data/lib/multi_config.rb

@@ -5,6 +5,8 @@ module MultiConfig
   # Checking if Rails::Railtie exists. Only then loca this railtie
   if defined? Rails::Railtie
     require 'rails'
+    # Railtie class for the gem. Initialization magic happens here. Inherits from Rails::Railtie so that initializer
+    # methods are available to it
     class Railtie < Rails::Railtie
       # Railtie initializer method
       initializer 'multi_config.active_record' do

data/spec/active_record/class_methods_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper'
+
+describe MultiConfig::ORMs::ActiveRecord::ClassMethods do
+  let!(:db_config) { load_namespaced_config('database.yml') }
+  let!(:other_config) { load_namespaced_config('other.yml') }
+  let!(:erb_config) { load_namespaced_config('erb.yml') }
+
+  before(:each) do
+    @test_class = Class.new
+    @test_class.stub_chain(:name).and_return('test_class')
+    @test_class.stub(:configurations).and_return({})
+    @test_class.stub(:establish_connection)
+    @test_class.send(:include, MultiConfig::ORMs::ActiveRecord)
+  end
+  let(:test_class) { @test_class }
+
+  describe "#config_file=" do
+    describe "setting config_file in unspecified environment" do
+      before do
+        Rails.stub(:env).and_return('unknown')
+      end
+      it "should through error when I specify a config file with environment not defined" do
+        lambda { test_class.config_file = 'other' }.should raise_error
+      end
+    end
+
+    describe "modifies class variable @@db_configs" do
+      before do
+        test_class.send(:class_variable_get, '@@db_configs').should == {}
+        test_class.config_file = 'other'
+      end
+      subject { test_class.send(:class_variable_get, '@@db_configs') }
+      it { should == {"other" => ["test_class"]} }
+    end
+
+    describe "modifies .configurations" do
+      before do
+        test_class.should_receive(:establish_connection).once.with('other_test')
+        expect {
+          test_class.config_file = 'other'
+        }.to change(test_class, :configurations).from({}).to(other_config)
+      end
+      subject { test_class.configurations }
+      it { should include 'other_development' }
+      it { should include 'other_test' }
+    end
+
+    describe "works as expected when filename without extension .yml is specified" do
+      before do
+        test_class.should_receive(:establish_connection).once.with('other_test')
+        expect {
+          test_class.config_file = 'other'
+        }.to change(test_class, :configurations).from({}).to(other_config)
+      end
+      subject { test_class.configurations.keys }
+      it { should include 'other_development' }
+      it { should include 'other_test' }
+    end
+
+    describe "works as expected when filename with extension .yml is specified" do
+      before do
+        test_class.should_receive(:establish_connection).once.with('other_test')
+        expect {
+          test_class.config_file = 'other.yml'
+        }.to change(test_class, :configurations).from({}).to(other_config)
+      end
+      subject { test_class.configurations.keys }
+      it { should include 'other_development' }
+      it { should include 'other_test' }
+    end
+
+    describe "multiple calls for config_file= in different models modify configurations only once" do
+      let(:first_test_class) { Class.new(test_class) }
+      let(:second_test_class) { Class.new(test_class) }
+      before do
+        first_test_class.should_receive(:establish_connection).once.with('other_test')
+        expect {
+          first_test_class.config_file = 'other.yml'
+        }.to change(test_class, :configurations).from({}).to(other_config)
+
+        second_test_class.should_receive(:establish_connection).once.with('other_test')
+        expect {
+          second_test_class.config_file = 'other'
+        }.not_to change(test_class, :configurations)
+
+      end
+      subject { second_test_class.configurations.keys }
+      it { should include 'other_development' }
+      it { should include 'other_test' }
+    end
+
+    describe "does nothing if database.yml specified" do
+      before do
+        test_class.should_not_receive(:establish_connection)
+        test_class.should_not_receive(:add_db_config)
+        MultiConfig::ORMs::ActiveRecord::Config.should_not_receive(:path)
+        MultiConfig::ORMs::ActiveRecord::Config.should_not_receive(:load)
+        expect {
+          test_class.config_file = 'database'
+        }.not_to change(test_class, :configurations)
+      end
+      subject { test_class.configurations.keys }
+      it { should_not include 'database_development' }
+      it { should_not include 'database_test' }
+    end
+  end
+end

data/spec/active_record/config_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe MultiConfig::ORMs::ActiveRecord::Config do
+  describe '#path' do
+    before do
+      Rails.stub(:root).and_return('/')
+    end
+    subject { MultiConfig::ORMs::ActiveRecord::Config.path('other_db.yml') }
+    it { should == '/config/other_db.yml' }
+  end
+
+  describe '#load' do
+    let!(:db_config) { load_namespaced_config('database.yml') }
+    let!(:other_config) { load_namespaced_config('other.yml') }
+    let!(:erb_config) { load_namespaced_config('erb.yml') }
+
+    it "should load yaml and erb/yaml files correctly" do
+      MultiConfig::ORMs::ActiveRecord::Config.load('other.yml', 'other').should == other_config
+      MultiConfig::ORMs::ActiveRecord::Config.load('erb.yml', 'erb').should == erb_config
+    end
+
+    it "should raise an error if file is not in present" do
+      lambda { MultiConfig::ORMs::ActiveRecord::Config.load('none.yml', 'none') }.should raise_error(RuntimeError)
+    end
+
+    it "should raise an error when I specify invalid config file" do
+      lambda { MultiConfig::ORMs::ActiveRecord::Config.load('invalid.yml', 'invalid') }.should raise_error(RuntimeError)
+    end
+  end
+end

data/spec/models/uses_other_yml_spec.rb

@@ -11,6 +11,6 @@ describe UsesOtherYml do
   end
 
   it "the @@db_configs should have entry for this class" do
-    UsesOtherYml.send(:class_variable_get,:'@@db_configs').should == {"other" => ["UsesOtherYml"]}
+    UsesOtherYml.send(:class_variable_get, :'@@db_configs').should == {"other" => ["UsesOtherYml"]}
   end
 end

data/spec/multi_config_spec.rb

@@ -1,123 +1,31 @@
 require 'spec_helper'
-
-describe MultiConfig::ORMs::ActiveRecord do
-  let!(:db_config) { load_namespaced_config('database.yml') }
-  let!(:other_config) { load_namespaced_config('other.yml') }
-  let!(:erb_config) { load_namespaced_config('erb.yml') }
-
-  describe MultiConfig::ORMs::ActiveRecord::ClassMethods do
-    before(:each) do
-      @test_class = Class.new
-      @test_class.stub_chain(:name).and_return('test_class')
-      @test_class.stub(:configurations).and_return({})
-      @test_class.stub(:establish_connection)
-      @test_class.send(:include, MultiConfig::ORMs::ActiveRecord)
+require 'rails/railtie'
+
+describe MultiConfig::Railtie do
+ describe "railtie initialization" do
+    before do
+      # Stub the initializer method and store the block to run later
+      Rails::Railtie.stub(:initializer) { |initializer_name, &block| @railtie_initializer_block = block }
+      # Stub  onload to yield directly
+      ActiveSupport.stub(:on_load).and_yield
+      # Remove the class definition
+      MultiConfig.send(:remove_const, :Railtie)
     end
-    let(:test_class) { @test_class }
-
-    describe "#config_file=" do
-
-      it "should raise an error if file is not in present" do
-        lambda { test_class.config_file = 'none' }.should raise_error
-      end
-
-      describe "should raise error in unspecified environment" do
-        before do
-          Rails.stub(:env).and_return('unknown')
-        end
-        it "should through error when I specify a config file with environment not defined" do
-          lambda { test_class.config_file = 'other' }.should raise_error
-        end
-      end
-
-      it "should through error when I specify invalid config file" do
-        lambda { test_class.config_file = 'invalid' }.should raise_error
-      end
-
-      describe "should modify class variable @@db_configs" do
-        before do
-          test_class.send(:class_variable_get, '@@db_configs').should == {}
-          test_class.config_file = 'other'
-        end
-        subject { test_class.send(:class_variable_get, '@@db_configs') }
-        it { should == {"other" => ["test_class"]} }
-      end
-
-      describe "should modify .configurations" do
-        before do
-          test_class.should_receive(:establish_connection).once.with('other_test')
-          expect {
-            test_class.config_file = 'other'
-          }.to change(test_class, :configurations).from({}).to(other_config)
-        end
-        subject { test_class.configurations }
-        it { should include 'other_development' }
-        it { should include 'other_test' }
-      end
-
-      describe "should work as expected when filename with extension .yml is specified" do
-        before do
-          test_class.should_receive(:establish_connection).once.with('other_test')
-          expect {
-            test_class.config_file = 'other.yml'
-          }.to change(test_class, :configurations).from({}).to(other_config)
-        end
-        subject { test_class.configurations.keys }
-        it { should include 'other_development' }
-        it { should include 'other_test' }
-      end
-
-      describe "multiple calls for config_file= in different models should modify configurations only once" do
-        let(:first_test_class) { Class.new(test_class) }
-        let(:second_test_class) { Class.new(test_class) }
-        before do
-          first_test_class.should_receive(:establish_connection).once.with('other_test')
-          expect {
-            first_test_class.config_file = 'other.yml'
-          }.to change(test_class, :configurations).from({}).to(other_config)
-
-          second_test_class.should_receive(:establish_connection).once.with('other_test')
-          expect {
-            second_test_class.config_file = 'other'
-          }.not_to change(test_class, :configurations)
-
-        end
-        subject { second_test_class.configurations.keys }
-        it { should include 'other_development' }
-        it { should include 'other_test' }
-      end
-
-      describe "should not do anything if database.yml specified" do
-        before do
-          test_class.should_not_receive(:establish_connection)
-          test_class.should_not_receive(:add_db_config)
-          MultiConfig::ORMs::ActiveRecord::Config.should_not_receive(:path)
-          MultiConfig::ORMs::ActiveRecord::Config.should_not_receive(:load)
-          expect {
-            test_class.config_file = 'database'
-          }.not_to change(test_class, :configurations)
-        end
-        subject { test_class.configurations.keys }
-        it { should_not include 'database_development' }
-        it { should_not include 'database_test' }
-      end
+    it "should call Railtie Insert when hook is executed" do
+      # Reload class definition so that class in instantiated and Railitie.initializer is called
+      load 'multi_config.rb'
+      MultiConfig::Railtie.should_receive(:insert).once()
+      # Call the initializer block we stored earlier. We wait so that the file is completely loaded and method Railitie.insert
+      # to be defined first. If we do not wait and yield directly from initializer, it would raise method not found exception
+      # for Railtie.insert since we removed the constant
+      @railtie_initializer_block.call
     end
   end
 
-  describe MultiConfig::ORMs::ActiveRecord::Config do
-    describe '#path' do
-      before do
-        Rails.stub(:root).and_return('/')
-      end
-      subject { MultiConfig::ORMs::ActiveRecord::Config.path('other_db.yml') }
-      it { should == '/config/other_db.yml' }
-    end
-
-    describe '#load' do
-      it "should load yaml and erb/yaml files correctly" do
-        MultiConfig::ORMs::ActiveRecord::Config.load('other.yml','other').should == other_config
-        MultiConfig::ORMs::ActiveRecord::Config.load('erb.yml','erb').should == erb_config
-      end
+  describe '#insert' do
+    it "should call ActiveRecord::Base.include" do
+      ActiveRecord::Base.should_receive(:send).with(:include, MultiConfig::ORMs::ActiveRecord).once()
+      MultiConfig::Railtie.insert
     end
   end
 end

data/spec/spec_helper.rb

@@ -6,12 +6,12 @@ if ENV['COVERAGE']
   SimpleCov.start do
     # Remove the spec folder from coverage. By default all code files are included. For more config options see
     # https://github.com/colszowka/simplecov
-    add_filter File.expand_path('../../spec',__FILE__)
+    add_filter File.expand_path('../../spec', __FILE__)
   end
 end
 
 # Modify load path so you can require 'multi_config' directly.
-$LOAD_PATH.unshift(File.expand_path('../../lib',__FILE__))
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
 
 require 'rubygems'
 # Loads bundler setup tasks. Now if I run spec without installing gems then it would say gem not installed and
@@ -30,7 +30,7 @@ require 'rspec/autorun'
 
 # Requires supporting ruby files with custom matchers and macros, etc,
 # in spec/support/ and its subdirectories.
-Dir[File.join(File.dirname(__FILE__), "support/**/*.rb")].each {|f| require f}
+Dir[File.join(File.dirname(__FILE__), "support/**/*.rb")].each { |f| require f }
 
 # Set Rails environment as test
 ENV['RAILS_ENV'] = 'test'

data/spec/support/active_record_config.rb

@@ -1,4 +1,4 @@
 # Setting default Active Record configs
 ActiveRecord::Base.logger         = Logger.new(StringIO.new)
-ActiveRecord::Base.configurations = YAML.load_file(ERB.new(File.expand_path("../config/database.yml",__FILE__)).result)
+ActiveRecord::Base.configurations = YAML.load_file(ERB.new(File.expand_path("../config/database.yml", __FILE__)).result)
 

data/spec/support/config_helper.rb

@@ -2,5 +2,5 @@
 def load_namespaced_config(file)
   namespace = File.basename(file, File.extname(file))
   config = YAML.load(ERB.new(IO.read(File.expand_path("../config/#{file}", __FILE__))).result)
-  config.inject({}){|h,(k,v)| h["#{namespace}_#{k}"]=v;h}
+  config.inject({}) { |h, (k, v)| h["#{namespace}_#{k}"]=v; h }
 end

metadata

@@ -1,135 +1,136 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: multi_config
-version: !ruby/object:Gem::Version
-  version: 0.1.6
+version: !ruby/object:Gem::Version 
+  hash: 11
   prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 8
+  version: 0.1.8
 platform: ruby
-authors:
+authors: 
 - Shadab Ahmed
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-09 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-09-10 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: rails
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
         version: 1.0.0
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '3.0'
   type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rails
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '3.0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
   type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: activerecord
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: autotest
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '4.0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
   type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: autotest
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 4
+        - 0
+        version: "4.0"
   type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rdoc
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
 description: This gem lets you specify different config file for an ActiveRecord Model
-email:
-- ''
+email: 
+- ""
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - .rspec
 - .travis.yml
@@ -142,6 +143,8 @@ files:
 - lib/multi_config/orms/active_record.rb
 - lib/multi_config/version.rb
 - multi_config.gemspec
+- spec/active_record/class_methods_spec.rb
+- spec/active_record/config_spec.rb
 - spec/active_record_spec.rb
 - spec/models/uses_database_yml_spec.rb
 - spec/models/uses_other_yml_spec.rb
@@ -158,29 +161,40 @@ files:
 - spec/support/rails_config.rb
 homepage: https://github.com/shadabahmed/multi_config
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Use this gem to use multiple db config files
-test_files:
+test_files: 
+- spec/active_record/class_methods_spec.rb
+- spec/active_record/config_spec.rb
 - spec/active_record_spec.rb
 - spec/models/uses_database_yml_spec.rb
 - spec/models/uses_other_yml_spec.rb