active_record_slave 0.2.0 → 1.0.0

data/Gemfile

@@ -0,0 +1,15 @@
+source :rubygems
+
+group :test do
+  gem "shoulda"
+end
+
+gem "activerecord"
+platforms :ruby do
+  gem 'sqlite3'
+end
+
+platforms :jruby do
+  gem 'jdbc-sqlite3'
+  gem 'activerecord-jdbcsqlite3-adapter'
+end

data/Gemfile.lock

@@ -0,0 +1,34 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+    activerecord (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.4)
+    i18n (0.6.1)
+    multi_json (1.3.7)
+    shoulda (3.3.2)
+      shoulda-context (~> 1.0.1)
+      shoulda-matchers (~> 1.4.1)
+    shoulda-context (1.0.1)
+    shoulda-matchers (1.4.1)
+      activesupport (>= 3.0.0)
+    sqlite3 (1.3.6)
+    tzinfo (0.3.35)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  shoulda
+  sqlite3

data/README.md

@@ -1,6 +1,8 @@
 active_record_slave
 ===================
 
+ActiveRecord drop-in solution to efficiently redirect reads to slave databases
+
 * http://github.com/ClarityServices/active_record_slave
 
 ## Introduction
@@ -13,6 +15,7 @@ database to ensure data consistency.
 ## Features
 
 * Redirecting reads to a single slave database
+* Works with any database driver that works with ActiveRecord
 * Supports all Rails 3 read apis, including dynamic finders, AREL, and ActiveRecord::Base.select
 * Transaction aware. Detects when a query is inside of a transaction and sends
   those reads to the master
@@ -47,6 +50,39 @@ Log file output:
     03-13-12 06:02:09 pm,[2608],b[0],[0],  Role Load (2.0ms)  SELECT `roles`.* FROM `roles` WHERE `roles`.`name` = 'manager' LIMIT 1
     03-13-12 06:02:09 pm,[2608],b[0],[0],  AREL (2.0ms)  UPDATE `roles` SET `description` = 'Manager' WHERE `roles`.`id` = 4
 
+### Forcing a read against the master
+
+Sometimes it is necessary to read from the master:
+
+```ruby
+ActiveRecordSlave.read_from_master do
+  r = Role.where(:name => "manager").first
+end
+```
+
+## Usage Notes
+
+### delete_all
+
+Delete all executes against the master database since it is only a delete:
+
+```
+D, [2012-11-06T19:47:29.125932 #89772] DEBUG -- :   SQL (1.0ms)  DELETE FROM "users"
+```
+
+### destroy_all
+
+First performs a read against the slave database and then deletes the corresponding
+data from the master
+
+```
+D, [2012-11-06T19:43:26.890674 #89002] DEBUG -- :   Slave: User Load (0.1ms)  SELECT "users".* FROM "users"
+D, [2012-11-06T19:43:26.890972 #89002] DEBUG -- :    (0.0ms)  begin transaction
+D, [2012-11-06T19:43:26.891667 #89002] DEBUG -- :   SQL (0.4ms)  DELETE FROM "users" WHERE "users"."id" = ?  [["id", 3]]
+D, [2012-11-06T19:43:26.892697 #89002] DEBUG -- :    (0.9ms)  commit transaction
+```
+
+
 ## Requirements
 
 * ActiveRecord 3 or greater (Rails 3 or greater)
@@ -114,9 +150,16 @@ slave reads only on the linux host 'batch':
         pool:     20
     <% end %>
 
+## Tests
+
+* active_record_slave is running in a large production system and was tested
+  directly as part of that solution
+* I welcome anyone that can submit tests to verify this gem in a standalone outside
+  environment
+
 ## Possible Future Enhancements
 
-* Support multiple slaves (ask for it by submitting a ticket)
+* Support for multiple slaves (ask for it by submitting a ticket)
 
 Meta
 ----

data/Rakefile

@@ -18,7 +18,7 @@ task :gem  do |t|
     s.date        = Date.today.to_s
     s.summary     = "ActiveRecord read from slave"
     s.description = "ActiveRecordSlave is a library to seamlessly enable reading from database slaves in a Rails 3 project, written in Ruby."
-    s.files       = FileList["./**/*"].exclude('*.gem', 'nbproject').map{|f| f.sub(/^\.\//, '')}
+    s.files       = FileList["./**/*"].exclude(/.gem$/, /.log$/,/nbproject/,/sqlite3$/).map{|f| f.sub(/^\.\//, '')}
     s.has_rdoc    = true
     #s.add_dependency 'activerecord', '>= 3.0.0'
   end

data/lib/active_record_slave/active_record_slave.rb

@@ -4,17 +4,30 @@
 module ActiveRecordSlave
 
   # Install ActiveRecord::Slave into ActiveRecord to redirect reads to the slave
-  # By default, only the default Database adapter (ActiveRecord::Base.connection.class)
-  # is extended with slave read capabilities
-  def self.install!(adapter_class = nil)
-    if slave_config = ActiveRecord::Base.connection.config[:slave]
-      Rails.logger.info "ActiveRecordSlave.install! v#{ActiveRecordSlave::VERSION} Establishing connection to slave database"
+  # Parameters:
+  #   adapter_class:
+  #     By default, only the default Database adapter (ActiveRecord::Base.connection.class)
+  #     is extended with slave read capabilities
+  #
+  #   environment:
+  #     In a non-Rails environment, supply the environment such as
+  #     'development', 'production'
+  def self.install!(adapter_class = nil, environment = nil)
+    slave_config = if ActiveRecord::Base.connection.respond_to?(:config)
+      ActiveRecord::Base.connection.config[:slave]
+    else
+      ActiveRecord::Base.configurations[environment || Rails.env]['slave']
+    end
+    if slave_config
+      ActiveRecord::Base.logger.info "ActiveRecordSlave.install! v#{ActiveRecordSlave::VERSION} Establishing connection to slave database"
       Slave.establish_connection(slave_config)
 
       # Inject a new #select method into the ActiveRecord Database adapter
       base = adapter_class || ActiveRecord::Base.connection.class
       base.send(:include, InstanceMethods)
       base.alias_method_chain(:select, :slave_reader)
+    else
+      ActiveRecord::Base.logger.info "ActiveRecordSlave no slave database defined"
     end
   end
 

data/lib/active_record_slave/instance_methods.rb

@@ -3,14 +3,14 @@ module ActiveRecordSlave
 
     # Database Adapter method #select is called for every select call
     # Replace #select with one that calls the slave connection instead
-    def select_with_slave_reader(sql, name = nil)
+    def select_with_slave_reader(sql, name = nil, *args)
       # Only read from slave when not in a transaction and when this is not already the slave connection
       if (open_transactions == 0) && (Thread.current[:active_record_slave] != :master)
         ActiveRecordSlave.read_from_master do
-          Slave.connection.select(sql, "Slave: #{name || 'SQL'}")
+          Slave.connection.select(sql, "Slave: #{name || 'SQL'}", *args)
         end
       else
-        select_without_slave_reader(sql, name)
+        select_without_slave_reader(sql, name, *args)
       end
     end
 

data/lib/active_record_slave/version.rb

@@ -1,3 +1,3 @@
 module ActiveRecordSlave #:nodoc
-  VERSION = "0.2.0"
+  VERSION = "1.0.0"
 end

data/test/active_record_slave_test.rb

@@ -0,0 +1,121 @@
+# Allow examples to be run in-place without requiring a gem install
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+
+require 'rubygems'
+require 'logger'
+require 'erb'
+require 'test/unit'
+require 'shoulda'
+require 'active_record'
+require 'active_record_slave'
+
+l = Logger.new('test.log')
+l.level = ::Logger::DEBUG
+ActiveRecord::Base.logger = l
+ActiveRecord::Base.configurations = YAML::load(ERB.new(IO.read('test/database.yml')).result)
+
+# Define Schema in second database (slave)
+# Note: This is not be required when the master database is being replicated to the slave db
+ActiveRecord::Base.establish_connection(ActiveRecord::Base.configurations['test']['slave'])
+
+# Create table users in database active_record_slave_test
+ActiveRecord::Schema.define :version => 0 do
+  create_table :users, :force => true do |t|
+    t.string :name
+    t.string :address
+  end
+end
+
+# Define Schema in master database
+ActiveRecord::Base.establish_connection(:test)
+
+# Create table users in database active_record_slave_test
+ActiveRecord::Schema.define :version => 0 do
+  create_table :users, :force => true do |t|
+    t.string :name
+    t.string :address
+  end
+end
+
+# AR Model
+class User < ActiveRecord::Base
+end
+
+# Install ActiveRecord slave. Done automatically by railtie in a Rails environment
+# Also tell it to use the test environment since Rails.env is not available
+ActiveRecordSlave.install!(nil, 'test')
+
+#
+# Unit Test for active_record_slave
+#
+class ActiveRecordSlaveTest < Test::Unit::TestCase
+  context 'the active_record_slave gem' do
+
+    setup do
+      User.delete_all
+
+      @name    = "Joe Bloggs"
+      @address = "Somewhere"
+      @user    = User.new(
+        :name => @name,
+        :address => @address
+      )
+    end
+
+    teardown do
+      User.delete_all
+    end
+
+    should "save to master" do
+      assert_equal true, @user.save!
+    end
+
+    #
+    # NOTE:
+    #
+    #   There is no automated replication between the SQL lite databases
+    #   so the tests will be verifying that reads going to the "slave" (second)
+    #   database do not find data written to the master.
+    #
+    should "save to master, read from slave" do
+      # Read from slave
+      assert_equal 0, User.where(:name => @name, :address => @address).count
+
+      # Write to master
+      assert_equal true, @user.save!
+
+      # Read from slave
+      assert_equal 0, User.where(:name => @name, :address => @address).count
+    end
+
+    should "save to master, read from master when in a transaction" do
+      User.transaction do
+        # Read from Master
+        assert_equal 0, User.where(:name => @name, :address => @address).count
+
+        # Write to master
+        assert_equal true, @user.save!
+
+        # Read from Master
+        assert_equal 1, User.where(:name => @name, :address => @address).count
+      end
+    end
+
+    should "save to master, force a read from master even when _not_ in a transaction" do
+      # Read from slave
+      assert_equal 0, User.where(:name => @name, :address => @address).count
+
+      # Write to master
+      assert_equal true, @user.save!
+
+      # Read from slave
+      assert_equal 0, User.where(:name => @name, :address => @address).count
+
+      # Read from Master
+      ActiveRecordSlave.read_from_master do
+        assert_equal 1, User.where(:name => @name, :address => @address).count
+      end
+    end
+
+  end
+end

data/test/database.yml

@@ -0,0 +1,12 @@
+test:
+  adapter:  sqlite3
+  database: test/db/test.sqlite3
+  pool:     5
+  timeout:  5000
+  # Make the slave a separate database that is not slaved to ensure reads
+  # and writes go to the appropriate databases
+  slave:
+    adapter:  sqlite3
+    database: test/db/test_slave.sqlite3
+    pool:     5
+    timeout:  5000

metadata

@@ -1,34 +1,26 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: active_record_slave
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 2
-  - 0
-  version: 0.2.0
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Reid Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-03-16 00:00:00 -04:00
-default_executable: 
+date: 2012-11-06 00:00:00.000000000 Z
 dependencies: []
-
-description: ActiveRecordSlave is a library to seamlessly enable reading from database slaves in a Rails 3 project, written in Ruby.
-email: 
+description: ActiveRecordSlave is a library to seamlessly enable reading from database
+  slaves in a Rails 3 project, written in Ruby.
+email:
 - reidmo@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- active_record_slave-0.1.0.gem
+files:
+- Gemfile
+- Gemfile.lock
 - lib/active_record_slave/active_record_slave.rb
 - lib/active_record_slave/instance_methods.rb
 - lib/active_record_slave/railtie.rb
@@ -36,43 +28,35 @@ files:
 - lib/active_record_slave/version.rb
 - lib/active_record_slave.rb
 - LICENSE.txt
-- nbproject/private/config.properties
-- nbproject/private/private.properties
-- nbproject/private/private.xml
-- nbproject/private/rake-d.txt
-- nbproject/project.properties
-- nbproject/project.xml
 - Rakefile
 - README.md
-has_rdoc: true
+- test/active_record_slave_test.rb
+- test/database.yml
 homepage: https://github.com/ClarityServices/active_record_slave
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+      hash: -2259159571471524106
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: ActiveRecord read from slave
 test_files: []
-

data/nbproject/private/private.properties

@@ -1,3 +0,0 @@
-file.reference.activerecord_slave-lib=/Users/rmorrison/Sandbox/activerecord_slave/lib
-file.reference.activerecord_slave-test=/Users/rmorrison/Sandbox/activerecord_slave/test
-platform.active=JRuby_0

data/nbproject/private/private.xml

@@ -1,4 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project-private xmlns="http://www.netbeans.org/ns/project-private/1">
-    <editor-bookmarks xmlns="http://www.netbeans.org/ns/editor-bookmarks/1"/>
-</project-private>

data/nbproject/private/rake-d.txt

@@ -1,4 +0,0 @@
-clean=
-clobber=
-gem=
-test=

data/nbproject/project.properties

@@ -1,8 +0,0 @@
-file.reference.activerecord_slave-lib=lib
-file.reference.activerecord_slave-test=test
-javac.classpath=
-main.file=
-platform.active=JRuby_0
-source.encoding=UTF-8
-src.lib.dir=lib
-test.test.dir=test

data/nbproject/project.xml

@@ -1,15 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://www.netbeans.org/ns/project/1">
-    <type>org.netbeans.modules.ruby.rubyproject</type>
-    <configuration>
-        <data xmlns="http://www.netbeans.org/ns/ruby-project/1">
-            <name>active_record_slave</name>
-            <source-roots>
-                <root id="src.lib.dir" name="Source Files"/>
-            </source-roots>
-            <test-roots>
-                <root id="test.test.dir" name="Test Files"/>
-            </test-roots>
-        </data>
-    </configuration>
-</project>