replica 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+*.log
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Zendesk
+
+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.rdoc

@@ -0,0 +1,33 @@
+= replica
+
+== Example
+  
+  Ticket.with_slave do
+    Ticket.first(50)
+  end
+
+== Install
+
+gem install replica
+
+Add the slave database to config/database.yml:
+  development_slave:
+    adapter: mysql
+    ...
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Zendesk. See LICENSE for details.
+
+== Authors
+Mick Staugaard

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "replica"
+    gem.summary = %Q{Simple database switching for ActiveRecord.}
+    gem.description = %Q{Easily run queries on replicated/slave databases.}
+    gem.email = "eac@zendesk.com"
+    gem.homepage = "http://github.com/eac/replica"
+    gem.authors = ["Eric Chapweske", "Mick Staugaard"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "replica #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/replica.rb

@@ -0,0 +1,116 @@
+require 'activerecord'
+
+module ActiveRecord # :nodoc:
+  class Base # :nodoc:
+    module Replica
+
+      # Executes queries using the slave database. Fails over to master if no slave is found.
+      # if you want to execute a block of code on the slave you can go:
+      #   Account.with_slave do
+      #     Account.first
+      #   end
+      # the first account will be found on the slave DB
+      #
+      # this is the same as:
+      #   Account.with_replica(:slave) do
+      #     Account.first
+      #   end
+      def with_slave(&block)
+        with_replica(:slave, &block)
+      end
+      
+      # See with_slave
+      def with_master(&block)
+        with_replica(nil, &block)
+      end
+
+      # Name of the connection pool. Used by ConnectionHandler to retrieve the current connection pool.
+      def connection_pool_name # :nodoc:
+        replica = current_replica_name
+        if replica
+          "#{name}_#{replica}"
+        elsif self == ActiveRecord::Base
+          name
+        else
+          superclass.connection_pool_name
+        end
+      end
+
+      # Specify which database to use. 
+      #
+      # Example:
+      # database.yml
+      #   test_slave:
+      #     adapter: mysql
+      #     ...
+      #
+      # Account.with_replica(:slave) { Account.count }
+      #
+      def with_replica(replica_name, &block)
+        old_replica_name = current_replica_name
+        begin
+          self.current_replica_name = replica_name
+        rescue ActiveRecord::AdapterNotSpecified => e
+          self.current_replica_name = old_replica_name
+          logger.warn("Failed to establish replica connection: #{e.message} - defaulting to master")
+        end        
+        yield
+      ensure
+        self.current_replica_name = old_replica_name
+      end
+
+      private
+      
+        def current_replica_name
+          Thread.current[replica_key]
+        end
+
+        def current_replica_name=(new_replica_name)
+          Thread.current[replica_key] = new_replica_name
+
+          establish_replica_connection(new_replica_name) unless connected_to_replica?
+        end
+        
+        def establish_replica_connection(replica_name)
+           name = replica_name ? "#{RAILS_ENV}_#{replica_name}" : RAILS_ENV
+           spec = configurations[name]
+           raise AdapterNotSpecified.new("No database defined by #{name} in database.yml") if spec.nil?
+           
+           connection_handler.establish_connection(connection_pool_name, ConnectionSpecification.new(spec, "#{spec['adapter']}_connection"))
+        end
+        
+        def connected_to_replica?
+          connection_handler.connection_pools.has_key?(connection_pool_name)
+        end
+        
+        def replica_key
+          @replica_key ||= "#{name}_replica"
+        end
+        
+    end
+  end
+  Base.extend(Base::Replica)
+  
+  # The only difference here is that we use klass.connection_pool_name
+  # instead of klass.name as the pool key
+  module ConnectionAdapters # :nodoc:
+    class ConnectionHandler # :nodoc:
+      
+      def retrieve_connection_pool(klass)
+        pool = @connection_pools[klass.connection_pool_name]
+        return pool if pool
+        return nil if ActiveRecord::Base == klass
+        retrieve_connection_pool klass.superclass
+      end
+      
+      def remove_connection(klass)
+         pool = @connection_pools[klass.connection_pool_name]
+         @connection_pools.delete_if { |key, value| value == pool }
+         pool.disconnect! if pool
+         pool.spec.config if pool
+       end
+      
+    end
+  end
+end
+

data/test/database.yml

@@ -0,0 +1,19 @@
+test:
+  adapter: mysql
+  encoding: utf8
+  database: replica_test
+  username: root
+  password:
+  socket: /tmp/mysql.sock
+  host: localhost
+  
+test_slave:
+  adapter: mysql
+  encoding: utf8
+  database: replica_test_slave
+  username: root
+  password:
+  socket: /tmp/mysql.sock
+  host: localhost
+    
+  

data/test/helper.rb

@@ -0,0 +1,32 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'replica'
+require 'models'
+
+RAILS_ENV = "test"
+
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/test.log")
+ActiveRecord::Base.configurations = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+
+ActiveRecord::Base.establish_connection('test_slave')
+load(File.dirname(__FILE__) + "/schema.rb")
+
+ActiveRecord::Base.establish_connection('test')
+load(File.dirname(__FILE__) + "/schema.rb")
+
+
+class Test::Unit::TestCase
+  
+  def assert_using_master_db(klass)
+    assert_equal('replica_test', klass.connection.instance_variable_get(:@config)[:database])
+  end
+
+  def assert_using_slave_db(klass)
+    assert_equal('replica_test_slave', klass.connection.instance_variable_get(:@config)[:database])
+  end
+  
+end

data/test/models.rb

@@ -0,0 +1,7 @@
+class Account < ActiveRecord::Base
+  # attributes: id, name, updated_at, created_at
+end
+
+class Ticket < ActiveRecord::Base
+  # attributes: id, title, account_id, updated_at, created_at
+end

data/test/replica_test.rb

@@ -0,0 +1,91 @@
+require 'helper'
+
+class ReplicaTest < ActiveRecord::TestCase
+  
+  context "without replica configuration" do
+    
+    setup do
+      ActiveRecord::Base.configurations.delete('test_slave')
+      ActiveRecord::Base.connection_handler.connection_pools.clear
+      ActiveRecord::Base.establish_connection('test')
+    end
+    
+    should "default to the master database" do
+      Account.create!
+      
+      ActiveRecord::Base.with_slave { assert_using_master_db(Account) } 
+      Account.with_slave { assert_using_master_db(Account) }
+      Ticket.with_slave  { assert_using_master_db(Account) }
+    end
+    
+    should "successfully execute queries" do
+      Account.create!
+      assert_using_master_db(Account)
+            
+      assert_equal Account.count, ActiveRecord::Base.with_slave { Account.count }
+      assert_equal Account.count, Account.with_slave { Account.count }
+    end
+        
+  end
+  
+  context "with replica configuration" do
+  
+    should "successfully execute queries" do
+      assert_using_master_db(Account)
+      Account.create!
+            
+      assert_not_equal Account.count, ActiveRecord::Base.with_slave { Account.count }
+      assert_not_equal Account.count, Account.with_slave { Account.count }
+      assert_equal Account.count, Ticket.with_slave { Account.count }
+    end
+  
+    should "support model specific with_slave blocks" do
+         assert_using_master_db(Account)
+         assert_using_master_db(Ticket)
+     
+         Account.with_slave do
+           assert_using_slave_db(Account)
+           assert_using_master_db(Ticket)
+         end
+     
+         assert_using_master_db(Account)
+         assert_using_master_db(Ticket)
+       end
+     
+       should "support global with_slave blocks" do
+         assert_using_master_db(Account)
+         assert_using_master_db(Ticket)
+     
+         ActiveRecord::Base.with_slave do
+           assert_using_slave_db(Account)
+           assert_using_slave_db(Ticket)
+         end
+     
+         assert_using_master_db(Account)
+         assert_using_master_db(Ticket)
+       end
+     
+       should_eventually "support nested with_* blocks" do
+         
+         assert_using_master_db(Account)
+         assert_using_master_db(Ticket)
+     
+         ActiveRecord::Base.with_slave do
+           assert_using_slave_db(Account)
+           assert_using_slave_db(Ticket)
+     
+           Account.with_master do
+             assert_using_master_db(Account)
+             assert_using_slave_db(Ticket)
+           end
+     
+           assert_using_slave_db(Account)
+           assert_using_slave_db(Ticket)
+         end
+     
+         assert_using_master_db(Account)
+         assert_using_master_db(Ticket)
+       end
+   
+  end
+end

data/test/schema.rb

@@ -0,0 +1,16 @@
+ActiveRecord::Schema.define(:version => 1) do
+
+  create_table "accounts", :force => true do |t|
+    t.string   "name"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "tickets", :force => true do |t|
+    t.string   "title"
+    t.integer  "account_id"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: replica
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Eric Chapweske
+- Mick Staugaard
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-04 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Easily run queries on replicated/slave databases.
+email: eac@zendesk.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/replica.rb
+- test/database.yml
+- test/helper.rb
+- test/models.rb
+- test/replica_test.rb
+- test/schema.rb
+has_rdoc: true
+homepage: http://github.com/eac/replica
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Simple database switching for ActiveRecord.
+test_files: 
+- test/helper.rb
+- test/models.rb
+- test/replica_test.rb
+- test/schema.rb