connection_ninja 0.3.5 → 0.4.0

data/.autotest

@@ -0,0 +1 @@
+Autotest.add_discovery { "rspec2" }

data/README.markdown

@@ -6,18 +6,10 @@ Connection Ninja is a really simple gem to help connection to multiple databases
 Installation
 ============
 
-To install connection_ninja you need to be using gemcutter, so install it if you haven't:
+Install the gem:
 
-    sudo gem install gemcutter
+    gem install connection_ninja
     
-And enable the gem source
-
-    gem tumble
-    
-Then you can install connection_ninja
-
-    sudo gem install connection_ninja
-
 Configuration
 =============
 
@@ -25,29 +17,28 @@ Configuration
       use_connection_ninja(:database)
     end
 
-Then in your after your normal configuration in database.yml:
-
-    database_development:
-      adapter: postgresql
-      database: database_name
-      user: username
+After your normal configuration in database.yml add a new group:
 
-    database_test:
-      adapter: postgresql
-      database: database_name
-      user: username
+    database:
+      development:
+        adapter: postgresql
+        database: database_name
+        user: username
 
-    database_production:
-      adapter: postgresql
-      database: database_name
-      user: username
+      test:
+        adapter: postgresql
+        database: database_name
+        user: username
 
-Connection ninja takes the database name you pass in and appends the environment on the end so it is important that you name the entries in database.yml as "#{database}_#{RAILS_ENV}" or it won't work.
+      production:
+        adapter: postgresql
+        database: database_name
+        user: username
 
 WHY?
 ===
 
-If you look at the code you will probably wonder why I didn't just call establish_connection "database_#{RAILS_ENV}", well at first I went about it differently, and thought I needed it. Now I realised maybe I don't, but it was a great exercise in learning how to write a gem and I learned a few things about ActiveRecord along the way which was great. It also gave me IMO a nice clean way to connect a bunch of models to the right database regardless of which of my apps the code was sitting in.
+Pure laziness. Rather than putting together a hash you can just call a group with use_connection_ninja(:group)
 
 How I used it
 =============
@@ -63,4 +54,4 @@ So I could:
 
     class ModelFromOtherDB < OtherConnection
 
-    end
+    end

data/Rakefile

@@ -10,35 +10,19 @@ begin
     gem.email = "chris.herring.iphone@gmail.com"
     gem.homepage = "http://github.com/cherring/connection_ninja"
     gem.authors = ["Chris Herring"]
-    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "rspec", ">= 2.0.0.beta19"
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: sudo 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 = "rangetastic #{version}"
+  rdoc.title = "connection ninja #{version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/VERSION

@@ -1 +1 @@
-0.3.5
+0.4.0

data/connection_ninja.gemspec

@@ -5,56 +5,56 @@
 
 Gem::Specification.new do |s|
   s.name = %q{connection_ninja}
-  s.version = "0.3.5"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Chris Herring"]
-  s.date = %q{2009-11-24}
+  s.date = %q{2010-09-01}
   s.description = %q{Handle multiple Database conenctions with ActiveRecord Models}
   s.email = %q{chris.herring.iphone@gmail.com}
   s.extra_rdoc_files = [
     "README.markdown"
   ]
   s.files = [
-    ".gitignore",
+    ".autotest",
+     ".gitignore",
      "CHANGELOG",
      "MIT-License",
      "Manifest",
      "README.markdown",
      "Rakefile",
      "VERSION",
-     "config/database.example.yml",
      "connection_ninja.gemspec",
      "lib/connection_ninja.rb",
+     "lib/connection_ninja/orms/active_record.rb",
+     "lib/connection_ninja/railtie.rb",
      "spec/connection_ninja_spec.rb",
+     "spec/fixtures/database.yml",
      "spec/fixtures/models.rb",
-     "spec/fixtures/structure.sql",
-     "spec/spec_helper.rb",
-     "spec/test_helper.rb"
+     "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/cherring/connection_ninja}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Handle multiple Database conenctions with ActiveRecord Models}
   s.test_files = [
     "spec/connection_ninja_spec.rb",
      "spec/fixtures/models.rb",
-     "spec/spec_helper.rb",
-     "spec/test_helper.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"])
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 2.0.0.beta19"])
     else
-      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<rspec>, [">= 2.0.0.beta19"])
     end
   else
-    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<rspec>, [">= 2.0.0.beta19"])
   end
 end
 

data/lib/connection_ninja/orms/active_record.rb

@@ -0,0 +1,21 @@
+require 'active_record'
+require 'connection_ninja'
+
+module ConnectionNinja
+  module Orms
+    module ActiveRecord
+      def use_connection_ninja(config_group)
+          establish_connection ninja_config(config_group)
+      end
+      
+      protected
+      def ninja_config(config_group)
+        begin
+          configurations[config_group.to_s][Rails.env]
+        rescue
+          raise ::ActiveRecord::AdapterNotFound, "connection ninja could not find the #{Rails.env} configuration for group \"#{config_group.to_s}\""
+        end
+      end
+    end
+  end
+end

data/lib/connection_ninja/railtie.rb

@@ -0,0 +1,12 @@
+require 'connection_ninja'
+
+module ConnectionNinja
+  class Railtie < Rails::Railtie
+    initializer "connection_ninja.active_record" do |app|
+      if defined? ::ActiveRecord
+        require 'connection_ninja/orms/active_record'
+        ActiveRecord::Base.send(:extend, ConnectionNinja::Orms::ActiveRecord)
+      end
+    end
+  end
+end

data/lib/connection_ninja.rb

@@ -1,35 +1,6 @@
 module ConnectionNinja
-  
-  def self.included(base)
-    base.extend ClassMethods
-  end
-  
-  module ClassMethods
-    #These are just here to use to run my specs, will work out how to fake these later
-    # RAILS_ENV = "development"
-    #  RAILS_ROOT = File.dirname(__FILE__) + "/.."
-    #  ActiveRecord::Base.configurations = { 'alternate_development' => { 
-    #    'adapter' => 'postgresql',
-    #    'database' => 'connection_ninja_alternate',
-    #    'host' => 'localhost'
-    #    }
-    #  }
-    
-    def use_connection_ninja(config_name)
-      connect_to_db(config(config_name))
-    end
-    
-    def config(config)
-      ActiveRecord::Base.configurations["#{config.to_s}_#{RAILS_ENV}"]
-    end
-      
-    def connect_to_db(config)
-      establish_connection(config)
-    end
-        
-  end
 end
 
-ActiveRecord::Base.class_eval do
-  include ConnectionNinja
-end
+if defined?(::Rails::Railtie)
+  require 'connection_ninja/railtie'
+end

data/spec/connection_ninja_spec.rb

@@ -1,46 +1,48 @@
 require 'spec/spec_helper'
-require 'connection_ninja'
-include ConnectionNinja
 
-describe Order do  
-  it "should be connected to the default database" do
-    Order.connection.current_database.should == "connection_ninja"
+describe ActiveRecord::Base, "methods" do
+  before do
+    ActiveRecord::Base.send(:extend, ConnectionNinja::Orms::ActiveRecord)
+  end
+
+  it "should have configurtions" do
+    ActiveRecord::Base.configurations.should_not == {}
+  end
+
+  it "should have connection ninja methods" do
+    ActiveRecord::Base.should respond_to(:use_connection_ninja)
   end
-  
 end
 
-describe Customer do
-  it "should be connected to the alternate database" do
-    Customer.connection.current_database.should == "connection_ninja_alternate"
+describe ConnectionNinja::Orms::ActiveRecord, "exception" do
+  it "should raise an error if connection group not in database.yml" do
+    lambda{ActiveRecord::Base.use_connection_ninja(:fial)}.should raise_error(::ActiveRecord::AdapterNotFound)
   end
-  
-  it "should respond to use_connection_ninja" do
-    Customer.respond_to?(:use_connection_ninja).should == true
-  end  
 end
 
-describe Customer,"config" do
+describe Customer do
+  before do
+    ActiveRecord::Base.send(:extend, ConnectionNinja::Orms::ActiveRecord)
+    @connection = Customer.establish_connection
+  end
   
-  it "should return the database config" do
-    Customer.config(:alternate).should == ActiveRecord::Base.configurations['alternate_development']
+  it "should be connected to the alternate database" do
+    Customer.connection.current_database.should == "ninja_one"
   end
 end
 
+describe Order do
+  before do
+    ActiveRecord::Base.send(:extend, ConnectionNinja::Orms::ActiveRecord)
+    @connection = Order.send(:use_connection_ninja, :other)
+  end
 
-describe Customer,"use_connection_ninja" do  
+  it "should return correct configuration" do
+    Order.send(:ninja_config, :other).should == {"username"=>"rails", "adapter"=>"postgresql", "database"=>"ninja_two", "host"=>"localhost", "password"=>"rails"}
+  end
 
-  it "should call connect_to_db" do
-    Customer.stub!(:config).and_return(ActiveRecord::Base.configurations['alternate_development'])
-    Customer.should_receive(:connect_to_db).with(Customer.config)
-    Customer.use_connection_ninja(:alternate)
+  it "should be connected to the default database" do
+    Order.connection.current_database.should == "ninja_two"
   end
-  
 end
 
-describe Customer,"connect_to_db" do
-  
-  it "should call establish_connection" do
-    Customer.should_receive(:establish_connection)
-    Customer.connect_to_db('alternate_development')
-  end
-end

data/spec/fixtures/database.yml

@@ -0,0 +1,20 @@
+development: &development
+  database: ninja_one
+  host: localhost
+  adapter: postgresql
+  username: rails
+  password: rails
+
+test: 
+  <<: *development
+
+other:
+  development: &development
+    database: ninja_two
+    host: localhost
+    adapter: postgresql
+    username: rails
+    password: rails
+
+  test: 
+    <<: *development

data/spec/fixtures/models.rb

@@ -1,7 +1,2 @@
-class Order < ActiveRecord::Base
-  
-end
-
-class Customer < ActiveRecord::Base
-  use_connection_ninja(:alternate)
-end
+class Order < ActiveRecord::Base; end
+class Customer < ActiveRecord::Base; end

data/spec/spec_helper.rb

@@ -1,28 +1,14 @@
-# Inspiration gained from Thinking Sphinx's test suite via Ryan Bigg's by_star test suite.
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rspec'
 
-$:.unshift File.dirname(__FILE__) + '/../lib'
+require 'rails'
+require 'active_record'
+require 'connection_ninja/orms/active_record'
 
-require 'rubygems'
-require 'activerecord'
-require 'connection_ninja'
 require 'spec/fixtures/models'
-require 'spec/test_helper'
 
 FileUtils.mkdir_p "#{Dir.pwd}/tmp"
+ActiveRecord::Base.logger         = Logger.new(StringIO.new)
+ActiveRecord::Base.configurations = YAML.load_file(File.join("spec", "fixtures", "database.yml"))
 
-ActiveRecord::Base.logger = Logger.new(StringIO.new)
-
-Spec::Runner.configure do |config|  
-  test = TestHelper.new
-  test.setup_postgresql
-  RAILS_ENV = "development"
-  RAILS_ROOT = File.dirname(__FILE__) + "/.."
-  
-  # This is to simulate what would be loaded out of datbase.yml for ActiveRecord
-  ActiveRecord::Base.configurations = { 'alternate_development' => { 
-    'adapter' => 'postgresql',
-    'database' => 'connection_ninja_alternate',
-    'host' => 'localhost'
-    }
-  }
-end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: connection_ninja
 version: !ruby/object:Gem::Version 
-  version: 0.3.5
+  hash: 15
+  prerelease: false
+  segments: 
+  - 0
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Chris Herring
@@ -9,19 +15,26 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-24 00:00:00 +11:00
+date: 2010-09-01 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.2.9
-    version: 
+        hash: -1967355497
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta19
+        version: 2.0.0.beta19
+  type: :development
+  version_requirements: *id001
 description: Handle multiple Database conenctions with ActiveRecord Models
 email: chris.herring.iphone@gmail.com
 executables: []
@@ -31,6 +44,7 @@ extensions: []
 extra_rdoc_files: 
 - README.markdown
 files: 
+- .autotest
 - .gitignore
 - CHANGELOG
 - MIT-License
@@ -38,14 +52,14 @@ files:
 - README.markdown
 - Rakefile
 - VERSION
-- config/database.example.yml
 - connection_ninja.gemspec
 - lib/connection_ninja.rb
+- lib/connection_ninja/orms/active_record.rb
+- lib/connection_ninja/railtie.rb
 - spec/connection_ninja_spec.rb
+- spec/fixtures/database.yml
 - spec/fixtures/models.rb
-- spec/fixtures/structure.sql
 - spec/spec_helper.rb
-- spec/test_helper.rb
 has_rdoc: true
 homepage: http://github.com/cherring/connection_ninja
 licenses: []
@@ -56,21 +70,27 @@ 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"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Handle multiple Database conenctions with ActiveRecord Models
@@ -78,4 +98,3 @@ test_files:
 - spec/connection_ninja_spec.rb
 - spec/fixtures/models.rb
 - spec/spec_helper.rb
-- spec/test_helper.rb

data/config/database.example.yml

@@ -1,6 +0,0 @@
-alternate_development:
-  adapter: postgresql
-  database: connection_ninja_alternate
-  user: chris
-  password:
-  host: localhost

data/spec/fixtures/structure.sql

@@ -1,39 +0,0 @@
-DROP TABLE IF EXISTS orders;
-
-DROP SEQUENCE IF EXISTS orders_id_seq;
-
-CREATE SEQUENCE orders_id_seq
-    START WITH 1
-    INCREMENT BY 1
-    NO MAXVALUE
-    NO MINVALUE
-    CACHE 1;
-    
-CREATE TABLE orders (
-    id integer NOT NULL default nextval('orders_id_seq'),
-    ordered_on timestamp,
-    fulfilled_on timestamp,
-    shipped_on timestamp,
-    created_at timestamp without time zone,
-    updated_at timestamp without time zone
-);
-
-DROP TABLE IF EXISTS customers;
-
-DROP SEQUENCE IF EXISTS customers_id_seq;
-
-CREATE SEQUENCE customers_id_seq
-    START WITH 1
-    INCREMENT BY 1
-    NO MAXVALUE
-    NO MINVALUE
-    CACHE 1;
-    
-CREATE TABLE customers (
-    id integer NOT NULL default nextval('customers_id_seq'),
-    given_name char(255),
-    family_name char(255),
-    created_at timestamp without time zone,
-    updated_at timestamp without time zone
-);
-

data/spec/test_helper.rb

@@ -1,42 +0,0 @@
-class TestHelper
-  attr_accessor :host, :username, :password
-  attr_reader   :path
-  
-  def initialize
-    @host     = "localhost"
-    @username = "chris" #Insert username for db here
-    @password = ""
-
-    @path = File.expand_path(File.dirname(__FILE__))
-  end
-  
-  def setup_postgresql
-    ActiveRecord::Base.establish_connection(
-      :adapter  => 'postgresql',
-      :database => 'connection_ninja',
-      :username => @username,
-      :password => @password,
-      :host     => @host
-    )
-    ActiveRecord::Base.logger = Logger.new(File.open("tmp/activerecord.log", "a"))
-    
-    structure = File.open("spec/fixtures/structure.sql") { |f| f.read.chomp }
-    structure.split(';').each { |table|
-      ActiveRecord::Base.connection.execute table
-    }
-    
-    10.times do
-      Order.create(:ordered_on => 2.weeks.ago)
-    end
-
-    10.times do
-      Order.create(:ordered_on => 3.weeks.ago, :fulfilled_on => 1.day.ago)
-    end
-    
-    5.times do
-      Order.create(:ordered_on => 1.weeks.ago)
-    end
-      
-  end
-  
-end