active_record_slave 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99bdf4d7588229de3ab130af6ded5d46b2488bed
-  data.tar.gz: 465b4f5a5c037702fe3e1a8ec0f535ceefbd3418
+  metadata.gz: df85e9044445ca044fcbe373312c3634f5c4d1f5
+  data.tar.gz: 1d31ecdaa29211fa71f852a95ab183498a26a0fb
 SHA512:
-  metadata.gz: 63618a6ca32f59027db8a2f8b491616561c5566c25122f2e6b0e50cc44494bb0e36d6b862a388b22d8b8962f1fd1e0193864a66198af865925f17ec7a73bca0a
-  data.tar.gz: 6ddc32f2cecd2dc61891930db2c1d532e1d4f7970b24e884faea149eece50d04b8f7646bce8e42e681220d217ee93d9653f53c342c72d5922da68ec479ea56fe
+  metadata.gz: fe6e8c3dfa5e7638879c954e016b6970e4432865b0a9e60e8f0d769b2201b62c571e5bda9e222770c7839f1d5884b689b0de6980b13c95290096a07572d6f94b
+  data.tar.gz: 38475bf316504c120a18cd7aa0e355e431dd99842370e79c1a7cb37ceaf67e48c26694e4bfc2d8c9a1339cb50a3d41313cd27c86066f16a3149969b4f02977ec

data/README.md

@@ -1,38 +1,43 @@
-active_record_slave [![Build Status](https://secure.travis-ci.org/reidmorrison/active_record_slave.png?branch=master)](http://travis-ci.org/reidmorrison/active_record_slave)
-===================
+# active_record_slave
+[![Gem Version](https://img.shields.io/gem/v/active_record_slave.svg)](https://rubygems.org/gems/active_record_slave) [![Build Status](https://travis-ci.org/rocketjob/active_record_slave.svg?branch=master)](https://travis-ci.org/rocketjob/active_record_slave) [![Downloads](https://img.shields.io/gem/dt/active_record_slave.svg)](https://rubygems.org/gems/active_record_slave) ![](https://img.shields.io/badge/status-Production%20Ready-blue.svg) [![Gitter chat](https://img.shields.io/badge/IRC%20(gitter)-Support-brightgreen.svg)](https://gitter.im/rocketjob/support)
 
-ActiveRecord drop-in solution to efficiently redirect reads to slave databases
+Redirect ActiveRecord (Rails) reads to slave databases while ensuring all writes go to the master database.
 
-* http://github.com/reidmorrison/active_record_slave
+* https://github.com/rocketjob/active_record_slave
 
 ## 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
+Redirect database reads to slave instances while ensuring that all writes go to the master database. 
+Any reads that are performed within a database transaction are by default directed to the master
 database to ensure data consistency.
 
+## Status
+
+Production Ready. Actively used in large production environments.
+
 ## 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
-* Lightweight footprint
-* No overhead whatsoever when a slave is not configured
-* Negligible overhead when redirecting reads to the slave
-* Connection Pools to both databases are retained and maintained independently by ActiveRecord
+* Redirect reads to a single slave database.
+* Works with any database driver that works with ActiveRecord.
+* Supports all Rails 3, 4, or 5 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 by default.
+    * Can be configured to send reads in a transaction to slave databases.
+* Lightweight footprint.
+* No overhead whatsoever when a slave is not configured.
+* Negligible overhead when redirecting reads to the slave.
+* Connection Pools to both databases are retained and maintained independently by ActiveRecord.
 * The master and slave databases do not have to be of the same type.
-  For example one can be MySQL and the other Oracle if required.
-* Debug logs include a prefix of 'Slave: ' to indicate which SQL statements are going
-  to the slave database
+    * For example Oracle could be the master with MySQL as the slave database.
+* Debug logs include a prefix of `Slave: ` to indicate which SQL statements are going
+  to the slave database.
 
 ### Example showing Slave redirected read
 
 ```ruby
 # Read from the slave database
-r = Role.where(:name => "manager").first
+r = Role.where(name: 'manager').first
 r.description = 'Manager'
 
 # Save changes back to the master database
@@ -48,7 +53,7 @@ Log file output:
 
 ```ruby
 Role.transaction do
-  r = Role.where(:name => "manager").first
+  r = Role.where(name: 'manager').first
   r.description = 'Manager'
   r.save!
 end
@@ -65,7 +70,7 @@ Sometimes it is necessary to read from the master:
 
 ```ruby
 ActiveRecordSlave.read_from_master do
-  r = Role.where(:name => "manager").first
+  r = Role.where(name: 'manager').first
 end
 ```
 
@@ -96,9 +101,6 @@ D, [2012-11-06T19:43:26.892697 #89002] DEBUG -- :    (0.9ms)  commit transaction
 By default ActiveRecordSlave detects when a call is inside a transaction and will
 send all reads to the _master_ when a transaction is active.
 
-With the latest Rails releases, Rails automatically wraps all Controller Action
-calls with a transaction, effectively sending all reads to the master database.
-
 It is now possible to send reads to database slaves and ignore whether currently
 inside a transaction:
 
@@ -114,22 +116,19 @@ able to read any changes already part of the transaction, but not yet committed
 and wrap those reads with `ActiveRecordSlave.read_from_master`
 
 ```ruby
-# Create a new inquiry
-Inquiry.create
+Inquiry.transaction do
+  # Create a new inquiry
+  Inquiry.create
+  
+  # The above inquiry is not visible yet if already in a Rails transaction.
+  # Use `read_from_master` to ensure it is included in the count below:
+  ActiveRecordSlave.read_from_master do
+    count = Inquiry.count
+  end
 
-# Then make sure that the new inquiry that is not yet committed is visible during
-# the read below:
-ActiveRecordSlave.read_from_master do
-  count = Inquiry.count
 end
 ```
 
-## Dependencies
-
-* Tested on Rails 3 and Rails 4
-
-See [.travis.yml](https://github.com/reidmorrison/active_record_slave/.travis.yml) for the list of tested Ruby platforms
-
 ## Note
 
 ActiveRecord::Base.execute is sometimes used to perform custom SQL calls against
@@ -142,7 +141,23 @@ which we do not want redirected to the slave
 
 ## Install
 
-  gem install active_record_slave
+Add to `Gemfile`
+
+```ruby
+gem 'active_record_slave'
+```
+
+Run bundler to install:
+
+```
+bundle
+```
+
+Or, without Bundler:
+
+```
+gem install active_record_slave
+```
 
 ## Configuration
 
@@ -152,80 +167,103 @@ along with all the usual ActiveRecord database configuration options.
 For Example:
 
 ```yaml
-development:
-  database: myapp_development
-  username: root
-  password:
+production:
+  database: production
+  username: username
+  password: password
   encoding: utf8
   adapter:  mysql
-  host:     127.0.0.1
-  pool:     20
+  host:     master1
+  pool:     50
   slave:
-    database: myapp_development_replica
-    username: root
-    password:
+    database: production
+    username: username
+    password: password
     encoding: utf8
     adapter:  mysql
-    host:     127.0.0.1
-    pool:     20
+    host:     slave1
+    pool:     50
 ```
 
 Sometimes it is useful to turn on slave reads per host, for example to activate
 slave reads only on the linux host 'batch':
 
 ```yaml
-development:
-  database: myapp_development
-  username: root
-  password:
+production:
+  database: production
+  username: username
+  password: password
   encoding: utf8
   adapter:  mysql
-  host:     127.0.0.1
-  pool:     20
+  host:     master1
+  pool:     50
 <% if `hostname`.strip == 'batch' %>
   slave:
-    database: myapp_development_replica
-    username: root
-    password:
+    database: production
+    username: username
+    password: password
     encoding: utf8
     adapter:  mysql
-    host:     127.0.0.1
-    pool:     20
+    host:     slave1
+    pool:     50
 <% end %>
 ```
 
-## Possible Future Enhancements
+If there are multiple slaves, it is possible to randomly select a slave on startup
+to balance the load across the slaves:
 
-* Support for multiple slaves (ask for it by submitting an issue)
+```yaml
+production:
+  database: production
+  username: username
+  password: password
+  encoding: utf8
+  adapter:  mysql
+  host:     master1
+  pool:     50
+  slave:
+    database: production
+    username: username
+    password: password
+    encoding: utf8
+    adapter:  mysql
+    host:     <%= %w(slave1 slave2 slave3).sample %>
+    pool:     50
+```
 
-Meta
-----
+Slaves can also be assigned to specific hosts by using the hostname:
 
-* Code: `git clone git://github.com/reidmorrison/active_record_slave.git`
-* Home: <https://github.com/reidmorrison/active_record_slave>
-* Bugs: <https://github.com/reidmorrison/active_record_slave/issues>
-* Gems: <http://rubygems.org/gems/active_record_slave>
+```yaml
+production:
+  database: production
+  username: username
+  password: password
+  encoding: utf8
+  adapter:  mysql
+  host:     master1
+  pool:     50
+  slave:
+    database: production
+    username: username
+    password: password
+    encoding: utf8
+    adapter:  mysql
+    host:     <%= `hostname`.strip == 'app1' ? 'slave1' : 'slave2' %>
+    pool:     50
+```
 
-This project uses [Semantic Versioning](http://semver.org/).
+## Dependencies
 
-Authors
--------
+See [.travis.yml](https://github.com/reidmorrison/active_record_slave/blob/master/.travis.yml) for the list of tested Ruby platforms
 
-Reid Morrison :: reidmo@gmail.com :: @reidmorrison
+## Possible Future Enhancements
 
-License
--------
+* Support for multiple named slaves (ask for it by submitting an issue)
 
-Copyright 2012, 2013, 2014 Reid Morrison
+## Versioning
 
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
+This project uses [Semantic Versioning](http://semver.org/).
 
-    http://www.apache.org/licenses/LICENSE-2.0
+## Author
 
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+[Reid Morrison](https://github.com/reidmorrison) :: @reidmorrison

data/Rakefile

@@ -1,8 +1,9 @@
-require 'rake/clean'
-require 'rake/testtask'
+# Setup bundler to avoid having to run bundle exec all the time.
+require 'rubygems'
+require 'bundler/setup'
 
-$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
-require 'active_record_slave/version'
+require 'rake/testtask'
+require_relative 'lib/active_record_slave/version'
 
 task :gem do
   system "gem build active_record_slave.gemspec"
@@ -15,14 +16,16 @@ task :publish => :gem do
   system "rm active_record_slave-#{ActiveRecordSlave::VERSION}.gem"
 end
 
-desc "Run Test Suite"
-task :test do
-  Rake::TestTask.new(:functional) do |t|
-    t.test_files = FileList['test/*_test.rb']
-    t.verbose    = true
-  end
-
-  Rake::Task['functional'].invoke
+Rake::TestTask.new(:test) do |t|
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+  t.warning = false
 end
 
-task :default => :test
+# By default run tests against all appraisals
+if !ENV["APPRAISAL_INITIALIZED"] && !ENV["TRAVIS"]
+  require 'appraisal'
+  task default: :appraisal
+else
+  task default: :test
+end

data/lib/active_record_slave/active_record_slave.rb

@@ -13,11 +13,12 @@ module ActiveRecordSlave
   #     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
+    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)
@@ -25,9 +26,6 @@ module ActiveRecordSlave
       # Inject a new #select method into the ActiveRecord Database adapter
       base = adapter_class || ActiveRecord::Base.connection.class
       base.send(:include, InstanceMethods)
-      SELECT_METHODS.each do |select_method|
-        base.alias_method_chain(select_method, :slave_reader)
-      end
     else
       ActiveRecord::Base.logger.info "ActiveRecordSlave not installed since no slave database defined"
     end
@@ -82,7 +80,7 @@ module ActiveRecordSlave
   # Parameters
   #   variable [Symbol]
   #     Name of variable to get
-  if RUBY_VERSION.to_i >= 2
+  if (RUBY_VERSION.to_i >= 2) && !defined?(Rubinius::VERSION)
     # Fibers have their own thread local variables so use thread_variable_get
     def self.thread_variable_get(variable)
       Thread.current.thread_variable_get(variable)
@@ -100,7 +98,7 @@ module ActiveRecordSlave
   #     Name of variable to set
   #   value [Object]
   #     Value to set the thread variable to
-  if RUBY_VERSION.to_i >= 2
+  if (RUBY_VERSION.to_i >= 2) && !defined?(Rubinius::VERSION)
     # Fibers have their own thread local variables so use thread_variable_set
     def self.thread_variable_set(variable, value)
       Thread.current.thread_variable_set(variable, value)

data/lib/active_record_slave/instance_methods.rb

@@ -11,14 +11,11 @@ module ActiveRecordSlave
       # Database Adapter method #exec_query is called for every select call
       # Replace #exec_query with one that calls the slave connection instead
       eval <<-METHOD
-      def #{select_method}_with_slave_reader(sql, name = nil, *args)
-        if active_record_slave_read_from_master?
-          #{select_method}_without_slave_reader(sql, name, *args)
-        else
-          # Calls are going against the Slave now, prevent an infinite loop
-          ActiveRecordSlave.read_from_master do
-            Slave.connection.#{select_method}(sql, "Slave: \#{name || 'SQL'}", *args)
-          end
+      def #{select_method}(sql, name = nil, *args)
+        return super if active_record_slave_read_from_master?
+
+        ActiveRecordSlave.read_from_master do
+          Slave.connection.#{select_method}(sql, "Slave: \#{name || 'SQL'}", *args)
         end
       end
       METHOD

data/lib/active_record_slave/railtie.rb

@@ -17,7 +17,7 @@ module ActiveRecordSlave #:nodoc:
     config.active_record_slave = ::ActiveRecordSlave
 
     # Initialize ActiveRecordSlave
-    initializer "load active_record_slave" , :after => "active_record.initialize_database" do
+    initializer "load active_record_slave", :after => "active_record.initialize_database" do
       ActiveRecordSlave.install!
     end
 

data/lib/active_record_slave/version.rb

@@ -1,3 +1,3 @@
 module ActiveRecordSlave #:nodoc
-  VERSION = "1.2.1"
+  VERSION = '1.3.0'
 end

data/test/active_record_slave_test.rb

@@ -2,9 +2,9 @@ require File.join(File.dirname(__FILE__), 'test_helper')
 require 'logger'
 require 'erb'
 
-l = Logger.new('test.log')
-l.level = ::Logger::DEBUG
-ActiveRecord::Base.logger = l
+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)
@@ -42,9 +42,9 @@ ActiveRecordSlave.install!(nil, 'test')
 # Unit Test for active_record_slave
 #
 class ActiveRecordSlaveTest < Minitest::Test
-  context 'the active_record_slave gem' do
+  describe 'the active_record_slave gem' do
 
-    setup do
+    before do
       ActiveRecordSlave.ignore_transactions = false
 
       User.delete_all
@@ -52,16 +52,16 @@ class ActiveRecordSlaveTest < Minitest::Test
       @name    = "Joe Bloggs"
       @address = "Somewhere"
       @user    = User.new(
-        :name => @name,
+        :name    => @name,
         :address => @address
       )
     end
 
-    teardown do
+    after do
       User.delete_all
     end
 
-    should "save to master" do
+    it 'saves to master' do
       assert_equal true, @user.save!
     end
 
@@ -72,7 +72,7 @@ class ActiveRecordSlaveTest < Minitest::Test
     #   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
+    it 'saves to master, read from slave' do
       # Read from slave
       assert_equal 0, User.where(:name => @name, :address => @address).count
 
@@ -83,7 +83,7 @@ class ActiveRecordSlaveTest < Minitest::Test
       assert_equal 0, User.where(:name => @name, :address => @address).count
     end
 
-    should "save to master, read from master when in a transaction" do
+    it 'save to master, read from master when in a transaction' do
       assert_equal false, ActiveRecordSlave.ignore_transactions?
 
       User.transaction do
@@ -104,7 +104,7 @@ class ActiveRecordSlaveTest < Minitest::Test
       assert_equal 0, User.where(:name => @name, :address => @address).count
     end
 
-    should "save to master, read from slave when ignoring transactions" do
+    it 'save to master, read from slave when ignoring transactions' do
       ActiveRecordSlave.ignore_transactions = true
       assert_equal true, ActiveRecordSlave.ignore_transactions?
 
@@ -126,7 +126,7 @@ class ActiveRecordSlaveTest < Minitest::Test
       assert_equal 0, User.where(:name => @name, :address => @address).count
     end
 
-    should "save to master, force a read from master even when _not_ in a transaction" do
+    it 'saves 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
 
@@ -143,4 +143,4 @@ class ActiveRecordSlaveTest < Minitest::Test
     end
 
   end
-end
+end

data/test/test_helper.rb

@@ -1,14 +1,10 @@
-# Allow test to be run in-place without requiring a gem install
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
-
-# Configure Rails Environment
 ENV['RAILS_ENV'] = 'test'
 
 require 'active_record'
 require 'minitest/autorun'
 require 'minitest/reporters'
 require 'minitest/stub_any_instance'
-require 'shoulda/context'
 require 'active_record_slave'
+require 'awesome_print'
 
 Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record_slave
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Reid Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-18 00:00:00.000000000 Z
+date: 2017-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -45,7 +45,7 @@ files:
 - test/test.sqlite3
 - test/test_helper.rb
 - test/test_slave.sqlite3
-homepage: https://github.com/reidmorrison/active_record_slave
+homepage: https://github.com/rocketjob/active_record_slave
 licenses:
 - Apache License V2.0
 metadata: {}
@@ -65,10 +65,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: ActiveRecord drop-in solution to efficiently redirect reads to slave databases
+summary: Redirect ActiveRecord (Rails) reads to slave databases while ensuring all
+  writes go to the master database.
 test_files:
 - test/active_record_slave_test.rb
 - test/database.yml