active_record_slave 0.1.0 → 0.2.0

data/README.md

@@ -3,14 +3,14 @@ active_record_slave
 
 * http://github.com/ClarityServices/active_record_slave
 
-### Introduction
+## Introduction
 
 active_record_slave allows all database reads to go to a slave while ensuring
 that all writes go to the master database. Also, active_record_slave ensures that
 any reads that are performed in a transaction will always go to the master
 database to ensure data consistency.
 
-### Features
+## Features
 
 * Redirecting reads to a single slave database
 * Supports all Rails 3 read apis, including dynamic finders, AREL, and ActiveRecord::Base.select
@@ -25,34 +25,36 @@ database to ensure data consistency.
 * Debug logs include 'Slave: ' prefix to indicate which SQL statements are going
   to the slave database
 
-# For Example the following code:
+### Example showing Slave redirected read
     r = Role.where(:name => "manager").first
     r.description = 'Manager'
     r.save!
 
-Results in:
+Log file output:
+
     03-13-12 05:56:05 pm,[2608],b[0],[0],  Slave: Role Load (3.0ms)  SELECT `roles`.* FROM `roles` WHERE `roles`.`name` = 'manager' LIMIT 1
     03-13-12 05:56:22 pm,[2608],b[0],[0],  AREL (12.0ms)  UPDATE `roles` SET `description` = 'Manager' WHERE `roles`.`id` = 5
 
-# Example code showing use of a transaction and reads going to the master:
+### Example showing how reads within a transaction go to the master
     Role.transaction do
       r = Role.where(:name => "manager").first
       r.description = 'Manager'
       r.save!
     end
 
-Results in:
+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
 
-### Requirements
+## Requirements
 
-* Rails 3 or greater
+* ActiveRecord 3 or greater (Rails 3 or greater)
 
 May also work with Rails 2. Anyone want to give it a try and let me know?
 Happy to make it work with Rails 2 if anyone needs it
 
-### Note
+## Note
 
 ActiveRecord::Base.execute is commonly used to perform custom SQL calls against
 the database that bypasses ActiveRecord. It is necessary to replace these calls
@@ -62,11 +64,11 @@ active_record_slave and redirected to the slave.
 This is because ActiveRecord::Base.execute can also be used for database updates
 which we do not want redirected to the slave
 
-### Install
+## Install
 
   gem install active_record_slave
 
-### Configuration
+## Configuration
 
 To enable slave reads for any environment just add a _slave:_ entry to database.yml
 along with all the usual ActiveRecord database configuration options.
@@ -92,6 +94,7 @@ For Example:
 
 Sometimes it is useful to turn on slave reads per host, for example to activate
 slave reads only on the linux host 'batch':
+
     development:
       database: clarity_development
       username: root
@@ -111,7 +114,7 @@ slave reads only on the linux host 'batch':
         pool:     20
     <% end %>
 
-### Possible Future Enhancements
+## Possible Future Enhancements
 
 * Support multiple slaves (ask for it by submitting a ticket)
 
@@ -120,7 +123,7 @@ Meta
 
 * Code: `git clone git://github.com/ClarityServices/active_record_slave.git`
 * Home: <https://github.com/ClarityServices/active_record_slave>
-* Bugs: <http://github.com/reidmorrison/active_record_slave/issues>
+* Bugs: <https://github.com/ClarityServices/active_record_slave/issues>
 * Gems: <http://rubygems.org/gems/active_record_slave>
 
 This project uses [Semantic Versioning](http://semver.org/).

data/lib/active_record_slave/active_record_slave.rb

@@ -14,9 +14,21 @@ module ActiveRecordSlave
       # 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
+      base.alias_method_chain(:select, :slave_reader)
     end
   end
 
+  # Force reads for the supplied block to read from the master database
+  # Only applies to calls made within the current thread
+  def self.read_from_master
+    # Set :master indicator in thread local storage so that it is visible
+    # during the select call
+    current = Thread.current[:active_record_slave]
+    Thread.current[:active_record_slave] = :master
+    yield
+  ensure
+    Thread.current[:active_record_slave] = current
+  end
+
 end
 

data/lib/active_record_slave/instance_methods.rb

@@ -5,8 +5,10 @@ module ActiveRecordSlave
     # Replace #select with one that calls the slave connection instead
     def select_with_slave_reader(sql, name = nil)
       # Only read from slave when not in a transaction and when this is not already the slave connection
-      if (open_transactions == 0) && !(name && name.starts_with?('Slave: '))
-        Slave.connection.select(sql, "Slave: #{name || 'SQL'}")
+      if (open_transactions == 0) && (Thread.current[:active_record_slave] != :master)
+        ActiveRecordSlave.read_from_master do
+          Slave.connection.select(sql, "Slave: #{name || 'SQL'}")
+        end
       else
         select_without_slave_reader(sql, name)
       end

data/lib/active_record_slave/version.rb

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

metadata

@@ -1,22 +1,26 @@
 --- !ruby/object:Gem::Specification 
 name: active_record_slave
 version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.1.0
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
-  - Reid Morrison
+- Reid Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2012-03-13 00:00:00 -04:00
+date: 2012-03-16 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
 description: ActiveRecordSlave is a library to seamlessly enable reading from database slaves in a Rails 3 project, written in Ruby.
 email: 
-  - reidmo@gmail.com
+- reidmo@gmail.com
 executables: []
 
 extensions: []
@@ -24,22 +28,22 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-  - active_record_slave-0.1.0.gem
-  - LICENSE.txt
-  - Rakefile
-  - README.md
-  - lib/active_record_slave.rb
-  - lib/active_record_slave/active_record_slave.rb
-  - lib/active_record_slave/instance_methods.rb
-  - lib/active_record_slave/railtie.rb
-  - lib/active_record_slave/slave.rb
-  - lib/active_record_slave/version.rb
-  - nbproject/project.properties
-  - nbproject/project.xml
-  - nbproject/private/config.properties
-  - nbproject/private/private.properties
-  - nbproject/private/private.xml
-  - nbproject/private/rake-d.txt
+- active_record_slave-0.1.0.gem
+- lib/active_record_slave/active_record_slave.rb
+- lib/active_record_slave/instance_methods.rb
+- lib/active_record_slave/railtie.rb
+- lib/active_record_slave/slave.rb
+- 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
 homepage: https://github.com/ClarityServices/active_record_slave
 licenses: []
@@ -48,23 +52,25 @@ post_install_message:
 rdoc_options: []
 
 require_paths: 
-  - lib
+- lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.1
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: ActiveRecord read from slave