connection_ninja 0.3.3

data/CHANGELOG

@@ -0,0 +1,4 @@
+Changelog.
+
+Took out connnection_ninja.yml in favour of using database.yml to leverage the use of ActiveRecord::Base.configurations
+Took out connection_ninja_config and connection_ninja_config_file since I don't need them when using database.yml

data/MIT-License

@@ -0,0 +1,22 @@
+Copyright (c) 2009 Chris Herring
+
+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/Manifest

@@ -0,0 +1,13 @@
+CHANGELOG
+config/database.example.yml
+connection_ninja.gemspec
+lib/connection_ninja.rb
+Manifest
+MIT-License
+Rakefile
+README.markdown
+spec/connection_ninja_spec.rb
+spec/fixtures/models.rb
+spec/fixtures/structure.sql
+spec/spec_helper.rb
+spec/test_helper.rb

data/README.markdown

@@ -0,0 +1,51 @@
+Introduction
+============
+
+Connection Ninja is a really simple gem to help connection to multiple databases. I wrote it to help with the way we were connected a new application at work to our older application that holds the data we needed to do reporting on. We have code (models) that is shared between those two applications, and I wanted them to be able to connect to the correct database regardless which app they were in, and therefore which database.yml they were reading.
+
+Configuration
+=============
+
+    class MyModel < ActiveRecord::Base
+      use_connection_ninja(:database)
+    end
+
+Then in your after your normal configuration in database.yml:
+
+    database_development:
+      adapter: postgresql
+      database: database_name
+      user: username
+
+    database_test:
+      adapter: postgresql
+      database: database_name
+      user: username
+
+    database_production:
+      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.
+
+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.
+
+How I used it
+=============
+
+To get my 20 or 30 models to all use one connection I used a simple abstract class to do it. I also got to learn about these along the way
+
+    class OtherConnection < ActiveRecord::Base
+      self.abstract_class = true
+      use_connection_ninja(:database)
+    end
+
+So I could:
+
+    class ModelFromOtherDB < OtherConnection
+
+    end

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('connection_ninja', '0.3.3') do |p|
+  p.description     = "Inject a new connection to an alternate database into an ActiveRecord Model at runtime"
+  p.summary         = ""
+  p.url             = "http://github.com/cherring/connection_ninja"
+  p.author          = "Chris Herring"
+  p.email           = "chris.herring.iphone@gmail.com"
+  p.ignore_pattern  = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/config/database.example.yml

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

data/connection_ninja.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{connection_ninja}
+  s.version = "0.3.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Chris Herring"]
+  s.date = %q{2009-06-08}
+  s.description = %q{Inject a new connection to an alternate database into an ActiveRecord Model at runtime}
+  s.email = %q{chris.herring.iphone@gmail.com}
+  s.extra_rdoc_files = ["CHANGELOG", "lib/connection_ninja.rb", "README.markdown"]
+  s.files = ["CHANGELOG", "config/database.example.yml", "connection_ninja.gemspec", "lib/connection_ninja.rb", "Manifest", "MIT-License", "Rakefile", "README.markdown", "spec/connection_ninja_spec.rb", "spec/fixtures/models.rb", "spec/fixtures/structure.sql", "spec/spec_helper.rb", "spec/test_helper.rb"]
+  s.homepage = %q{http://github.com/cherring/connection_ninja}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Connection_ninja", "--main", "README.markdown"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{connection_ninja}
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{Inject a new connection to an alternate database into an ActiveRecord Model at runtime}
+
+  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
+    else
+    end
+  else
+  end
+end

data/lib/connection_ninja.rb

@@ -0,0 +1,35 @@
+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

data/spec/connection_ninja_spec.rb

@@ -0,0 +1,46 @@
+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"
+  end
+  
+end
+
+describe Customer do
+  it "should be connected to the alternate database" do
+    Customer.connection.current_database.should == "connection_ninja_alternate"
+  end
+  
+  it "should respond to use_connection_ninja" do
+    Customer.respond_to?(:use_connection_ninja).should == true
+  end  
+end
+
+describe Customer,"config" do
+  
+  it "should return the database config" do
+    Customer.config(:alternate).should == ActiveRecord::Base.configurations['alternate_development']
+  end
+end
+
+
+describe Customer,"use_connection_ninja" do  
+
+  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)
+  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/models.rb

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

data/spec/fixtures/structure.sql

@@ -0,0 +1,39 @@
+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/spec_helper.rb

@@ -0,0 +1,28 @@
+# Inspiration gained from Thinking Sphinx's test suite via Ryan Bigg's by_star test suite.
+
+$:.unshift File.dirname(__FILE__) + '/../lib'
+
+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)
+
+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

data/spec/test_helper.rb

@@ -0,0 +1,42 @@
+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

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: connection_ninja
+version: !ruby/object:Gem::Version 
+  version: 0.3.3
+platform: ruby
+authors: 
+- Chris Herring
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-08 00:00:00 +10:00
+default_executable: 
+dependencies: []
+
+description: Inject a new connection to an alternate database into an ActiveRecord Model at runtime
+email: chris.herring.iphone@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- lib/connection_ninja.rb
+- README.markdown
+files: 
+- CHANGELOG
+- config/database.example.yml
+- connection_ninja.gemspec
+- lib/connection_ninja.rb
+- Manifest
+- MIT-License
+- Rakefile
+- README.markdown
+- spec/connection_ninja_spec.rb
+- 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: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Connection_ninja
+- --main
+- README.markdown
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: connection_ninja
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: Inject a new connection to an alternate database into an ActiveRecord Model at runtime
+test_files: []
+