multi_config 0.0.1

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.idea
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+spec/support/*db*
+.rbenv*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in multi_config.gemspec
+gemspec
+
+group :test do
+  gem 'rake'
+  gem 'rspec'
+  gem 'autotest'
+  gem 'simplecov', :platforms => :mri_19, :require => false
+  gem 'rcov', :platforms => :mri_18
+  gem 'rails', '~> 3.0'
+  gem 'sqlite3'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Shadab Ahmed
+
+MIT License
+
+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,37 @@
+# ActiveRecordMultiConfig
+
+## Build Status
+[![Build Status](https://secure.travis-ci.org/shadabahmed/multi_config.png)](https://secure.travis-ci.org/shadabahmed/multi_config)
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'multi_config'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install multi_config
+
+## Usage
+
+This gem will allow multiple db config files to be used in a Rails 3 project. All you have to do is
+```ruby
+  class MyTable < ActiveRecord::Base
+    self.config_file = 'my_config'
+  end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,43 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require 'fileutils'
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new('spec') do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+end
+
+# Run the rdoc task to generate rdocs for this gem
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  require "multi_config/version"
+  version = MultiConfig::VERSION
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "multi_config #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+if RUBY_VERSION =~ /^1\.8/
+    RSpec::Core::RakeTask.new(:rcov) do |spec|
+      spec.pattern = 'spec/**/*_spec.rb'
+      spec.rcov = true
+      spec.rcov_opts = %w{--exclude pkg\/,spec\/,features\/}
+    end
+  else
+    desc "Code coverage detail"
+    task :simplecov do
+      ENV['COVERAGE'] = "true"
+      Rake::Task['spec'].execute
+    end
+end
+
+
+desc  "Run all specs with rcov"
+RSpec::Core::RakeTask.new(:rcov) do |t|
+  t.rcov = true
+  t.rcov_opts = %w{--exclude pkg\/,spec\/,features\/}
+end

data/lib/multi_config/orms/active_record.rb

@@ -0,0 +1,49 @@
+module MultiConfig
+  module ORMs
+    module ActiveRecord
+      def self.included(mod)
+        mod.extend ClassMethods
+        mod.send(:class_variable_set, :'@@db_configs', [])
+      end
+
+      module ClassMethods
+        def config_file=(file_name)
+          file_name += '.yml' unless File.extname(file_name).eql? '.yml'
+          unless file_name == 'database.yml'
+            namespace = File.basename(file_name, '.yml')
+            add_to_db_configs(file_name, namespace)
+            raise "Configuration for #{::Rails.env} environment not defined in #{config_path file_name}" unless
+                configurations.include? "#{namespace}_#{::Rails.env}"
+            establish_connection "#{namespace}_#{::Rails.env}"
+          end
+        end
+
+        private
+
+        def add_to_db_configs(file_name, namespace)
+          db_configs = class_variable_get(:'@@db_configs')
+          unless db_configs.include?(namespace)
+            configurations.merge!(config(file_name, namespace))
+            db_configs << namespace
+          end
+        end
+
+        def config_path(file_name)
+          File.join(Rails.root, 'config', file_name)
+        end
+
+        def config(file_name, namespace)
+          begin
+            YAML.load(ERB.new(File.read(config_path(file_name))).result).inject({}) do |hash,(k,v)|
+              hash["#{namespace}_#{k}"]=v
+              hash
+            end
+          rescue Exception => exc
+            raise "File #{config_path file_name} does not exist in config" unless File.exists?(config_path(file_name))
+            raise "Invalid config file #{config_path file_name}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/multi_config/version.rb

@@ -0,0 +1,3 @@
+module MultiConfig
+  VERSION = "0.0.1"
+end

data/lib/multi_config.rb

@@ -0,0 +1,23 @@
+require "multi_config/version"
+
+module MultiConfig
+  if defined? Rails::Railtie
+    require 'rails'
+    class Railtie < Rails::Railtie
+      initializer 'multi_config.active_record' do
+        ActiveSupport.on_load :active_record do
+          MultiConfig::Railtie.insert
+        end
+      end
+    end
+  end
+
+  class Railtie
+    def self.insert
+      if defined?(ActiveRecord)
+        require 'multi_config/orms/active_record'
+        ActiveRecord::Base.send(:include, MultiConfig::ORMs::ActiveRecord)
+      end
+    end
+  end
+end

data/multi_config.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'multi_config/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "multi_config"
+  gem.version       = MultiConfig::VERSION
+  gem.authors       = ["Shadab Ahmed"]
+  gem.email         = [""]
+  gem.description   = %q{This gem lets you specify different config file for an ActiveRecord Model}
+  gem.summary       = %q{Use this gem to use multiple db config files}
+  gem.homepage      = "https://github.com/shadabahmed/multi_config"
+
+  # Load Paths...
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  # Dependencies (installed via 'bundle install')...
+  gem.add_development_dependency("bundler", [">= 1.0.0"])
+  gem.add_development_dependency("rails", [">= 3.0"])
+  gem.add_development_dependency("activerecord", [">= 3.0"])
+  gem.add_development_dependency("autotest", [">= 4.0"])
+  gem.add_development_dependency("rdoc")
+  gem.add_development_dependency("sqlite3")
+end

data/spec/active_record_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe ActiveRecord::Base, "methods" do
+  before do
+    ActiveRecord::Base.send(:include, MultiConfig::ORMs::ActiveRecord)
+  end
+
+  it "should have configurations" do
+    ActiveRecord::Base.configurations.should_not == {}
+  end
+
+  it "should have multi config methods" do
+    ActiveRecord::Base.singleton_methods.should include(RUBY_VERSION =~ /^1\.8/ ? 'config_file=' : :'config_file=')
+  end
+
+  it "should have @@db_config class variable set" do
+    ActiveRecord::Base.send(:class_variable_get, '@@db_configs').should == []
+  end
+
+end
+
+
+
+

data/spec/models/uses_database_yml_spec.rb

@@ -0,0 +1,12 @@
+require "spec_helper"
+
+describe UsesDatabaseYml do
+  before do
+    ActiveRecord::Base.send(:extend, MultiConfig::ORMs::ActiveRecord)
+    UsesDatabaseYml.establish_connection
+  end
+
+  it "should be connected to the alternate database" do
+    UsesDatabaseYml.connection.instance_variable_get(:@config)[:database].split('/').last.should == "db"
+  end
+end

data/spec/models/uses_other_yml_spec.rb

@@ -0,0 +1,12 @@
+require "spec_helper"
+
+describe UsesOtherYml do
+  before do
+    ActiveRecord::Base.send(:include, MultiConfig::ORMs::ActiveRecord)
+    UsesOtherYml.config_file = 'other'
+  end
+
+  it "should be connected to the default database" do
+    UsesOtherYml.connection.instance_variable_get(:@config)[:database].split('/').last.should == "other_db"
+  end
+end

data/spec/multi_config_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+
+describe MultiConfig::ORMs::ActiveRecord do
+  let!(:db_config){ load_namespaced_config('database.yml') }
+  let!(:other_config){ load_namespaced_config('other.yml') }
+  before(:each) do
+    @test_class = Class.new
+    @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
+
+    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']}
+    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_to_db_configs)
+        test_class.should_not_receive(:config_path)
+        test_class.should_not_receive(:config)
+        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/spec_helper.rb

@@ -0,0 +1,39 @@
+if ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter File.expand_path('../../spec',__FILE__)
+  end
+end
+$LOAD_PATH.unshift(File.expand_path('../../lib',__FILE__))
+
+require 'rubygems'
+require 'bundler/setup'
+Bundler.require(:default, :test)
+require 'active_record'
+
+require 'multi_config/orms/active_record'
+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}
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+  config.before(:each) do
+    set_rails_conf
+  end
+end

data/spec/support/active_record_config.rb

@@ -0,0 +1,3 @@
+ActiveRecord::Base.logger         = Logger.new(StringIO.new)
+ActiveRecord::Base.configurations = YAML.load_file(ERB.new(File.expand_path("../config/database.yml",__FILE__)).result)
+

data/spec/support/config/database.yml

@@ -0,0 +1,7 @@
+development: &development
+  database: db
+  host: localhost
+  adapter: sqlite3
+
+test:
+  <<: *development

data/spec/support/config/invalid.yml

@@ -0,0 +1,3 @@
+#Do not change this. It contains binary data
+:
+

data/spec/support/config/other.yml

@@ -0,0 +1,8 @@
+development: &development
+  database: other_db
+  host: localhost
+  adapter: sqlite3
+
+test:
+  <<: *development
+

data/spec/support/config_helper.rb

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

data/spec/support/models.rb

@@ -0,0 +1,2 @@
+class UsesDatabaseYml < ActiveRecord::Base; end
+class UsesOtherYml < ActiveRecord::Base; end

data/spec/support/rails_config.rb

@@ -0,0 +1,4 @@
+def set_rails_conf
+  Rails.stub(:env).and_return('test')
+  Rails.stub(:root).and_return(File.expand_path('../', __FILE__))
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification 
+name: multi_config
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Shadab Ahmed
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-09-08 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: autotest
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 4
+        - 0
+        version: "4.0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+description: This gem lets you specify different config file for an ActiveRecord Model
+email: 
+- ""
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/multi_config.rb
+- lib/multi_config/orms/active_record.rb
+- lib/multi_config/version.rb
+- multi_config.gemspec
+- spec/active_record_spec.rb
+- spec/models/uses_database_yml_spec.rb
+- spec/models/uses_other_yml_spec.rb
+- spec/multi_config_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record_config.rb
+- spec/support/config/database.yml
+- spec/support/config/db
+- spec/support/config/invalid.yml
+- spec/support/config/other.yml
+- spec/support/config_helper.rb
+- spec/support/models.rb
+- spec/support/rails_config.rb
+homepage: https://github.com/shadabahmed/multi_config
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  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 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Use this gem to use multiple db config files
+test_files: 
+- spec/active_record_spec.rb
+- spec/models/uses_database_yml_spec.rb
+- spec/models/uses_other_yml_spec.rb
+- spec/multi_config_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record_config.rb
+- spec/support/config/database.yml
+- spec/support/config/db
+- spec/support/config/invalid.yml
+- spec/support/config/other.yml
+- spec/support/config_helper.rb
+- spec/support/models.rb
+- spec/support/rails_config.rb