slavery 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5346c12e4fcf3eaad7b55ce70ca0ffea79f33fe0
-  data.tar.gz: 74b684b645a28770ecb4d8ae08f6bd5b8daaf7b3
+  metadata.gz: 02a75efbc26dd3232de851d07d1903f8808c0afe
+  data.tar.gz: 1c6bea05c62d6f8806e45b2e853ea5a78e05f70b
 SHA512:
-  metadata.gz: 7b9d823e65b28450161595daaef467bc96dc819ed38c4f2d8e9ea663958fca628dd59942700ad829a36903b415088c3ee07ac0df80f3b81e52fd463f588862b2
-  data.tar.gz: ff44e84b3580ce6bccafe3d42ca0b00a07dfb6d83bce83be21bce320c3c2df1b3ab2b4de430612332a0136d072f64ffea0b1ca52cac0d0ac7e41a631efcdffcb
+  metadata.gz: 4e9f079b232c11fc516e14d849a48f8f7de7cd00149fdf8efa951340d76a10f4c0db4b337ce602d5883212f7186d531198a60bb7a33398170dd95231301f19a6
+  data.tar.gz: e82e262252ab96f041f5e47766e78200e0845ba0af7983910cb6b833d0af743be6525e04bb0c7cfad0c8e0d5ed045c083aa602fd4a392c2a16ea5df5c55f6175

data/README.md

@@ -123,13 +123,27 @@ It is a good idea to confirm this behavior in your test code as well.
 You can quickly disable slave reads by dropping the following line in `config/initializers/slavery.rb`.
 
 ```ruby
-Slavely.disabled = true
+Slavery.disabled = true
 ```
 
 With this line, Slavery stops connection switching and all queries go to the master.
 
 This may be useful when one of the master or the slave goes down. You would rewrite `database.yml` to make all queries go to the surviving database, until you restore or rebuild the failed one.
 
+## Transactional fixtures
+
+When `use_transactional_fixtures` is set to `true`, it's NOT recommended to
+write to the database besides fixtures, since the slave connection is not aware
+of changes performed in the master connection due to [transaction isolation](https://en.wikipedia.org/wiki/Isolation_(database_systems)).
+
+In that case, you are suggested to disable Slavery in the test environment by
+putting the following in `test/test_helper.rb`
+(or `spec/spec_helper.rb` for RSpec users):
+
+```ruby
+Slavery.disabled = true
+```
+
 ## Support for non-Rails apps
 
 If you're using ActiveRecord in a non-Rails app (e.g. Sinatra), be sure to set `RACK_ENV` environment variable in the boot sequence, then:

data/bin/console

@@ -2,4 +2,7 @@
 
 require_relative "../spec/spec_helper"
 require "irb"
+
+ActiveRecord::Base.logger = ActiveSupport::Logger.new(STDOUT)
+
 IRB.start

data/lib/slavery/base.rb

@@ -11,11 +11,11 @@ module Slavery
   private
 
     def decide_with(target)
-      raise Slavery::Error.new('on_slave cannot be used inside transaction block!') if inside_transaction?
-
       if Slavery.disabled
         :master
       else
+        raise Slavery::Error.new('on_slave cannot be used inside transaction block!') if inside_transaction?
+
         target
       end
     end

data/lib/slavery/transaction.rb

@@ -1,18 +1,29 @@
 module Slavery
   class Transaction
+    # The methods on ActiveSupport::TestCase which can potentially be used
+    # to determine if transactional fixtures are enabled
+    TEST_CONFIG_METHODS = [
+      :use_transactional_tests,
+      :use_transactional_fixtures
+    ]
+
     class << self
       def base_depth
-        @base_depth ||= begin
-          testcase = ActiveSupport::TestCase
-          if defined?(testcase) &&
-              testcase.respond_to?(:use_transactional_fixtures) &&
-              testcase.try(:use_transactional_fixtures)
-            1
-          else
-            0
-          end
+        @base_depth ||= if defined?(ActiveSupport::TestCase) &&
+          transactional_fixtures_enabled?
+        then
+          1
+        else
+          0
         end
       end
+
+      private
+
+      def transactional_fixtures_enabled?
+        config = ActiveSupport::TestCase
+        TEST_CONFIG_METHODS.any? {|m| config.respond_to?(m) and config.send(m) }
+      end
     end
   end
 end

data/lib/slavery/version.rb

@@ -1,3 +1,3 @@
 module Slavery
-  VERSION = '2.1.0'
+  VERSION = '2.1.1'
 end

data/spec/active_record/log_subscriber_spec.rb

@@ -10,10 +10,11 @@ describe ActiveRecord::LogSubscriber do
 
     before do
       ActiveRecord::Base.logger = logger
+      @backup_disabled = Slavery.disabled
     end
 
     after do
-      Slavery.disabled = false
+      Slavery.disabled = @backup_disabled
     end
 
     it 'it prefixes log messages with master' do

data/spec/configuration_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe 'configuration' do
+  before do
+    # Backup connection and configs
+    @backup_conn = Slavery.instance_variable_get :@connection_holder
+    @backup_config = ActiveRecord::Base.configurations.dup
+    @backup_disabled = Slavery.disabled
+    Slavery.instance_variable_set :@connection_holder, nil
+  end
+
+  after do
+    # Restore connection and configs
+    Slavery.instance_variable_set :@connection_holder, @backup_conn
+    ActiveRecord::Base.configurations = @backup_config
+    Slavery.disabled = @backup_disabled
+  end
+
+  it 'raises error if slave configuration not specified' do
+    ActiveRecord::Base.configurations['test_slave'] = nil
+
+    expect { Slavery.on_slave { User.count } }.to raise_error(Slavery::Error)
+  end
+
+  it 'connects to master if slave configuration not specified' do
+    ActiveRecord::Base.configurations['test_slave'] = nil
+    Slavery.disabled = true
+
+    expect(Slavery.on_slave { User.count }).to be 2
+  end
+
+  it 'connects to slave when specified as a hash' do
+    Slavery.spec_key = 'test_slave'
+    hash = ActiveRecord::Base.configurations['test_slave']
+    expect(Slavery::ConnectionHolder).to receive(:establish_connection).with(hash)
+    Slavery::ConnectionHolder.activate
+  end
+
+  it 'connects to slave when specified as a url' do
+    expected = if Gem::Version.new(ActiveRecord::VERSION::STRING) < Gem::Version.new('4.1.0')
+      'postgres://root:@localhost:5432/test_slave'
+    else
+      {
+        'adapter'  => 'postgresql',
+        'username' => 'root',
+        'host'     => 'localhost',
+        'port'     => 5432,
+        'database' => 'test_slave'
+      }
+    end
+    Slavery.spec_key = 'test_slave_url'
+    expect(Slavery::ConnectionHolder).to receive(:establish_connection).with(expected)
+    Slavery::ConnectionHolder.activate
+  end
+end

data/spec/slavery_spec.rb

@@ -91,58 +91,4 @@ describe Slavery do
     expect(User.where(nil).to_a.size).to be 2
     expect(User.on_slave.where(nil).to_a.size).to be 1
   end
-
-  describe 'configuration' do
-    before do
-      # Backup connection and configs
-      @backup_conn = Slavery.instance_variable_get :@connection_holder
-      @backup_config = ActiveRecord::Base.configurations.dup
-      @backup_disabled = Slavery.disabled
-      Slavery.instance_variable_set :@connection_holder, nil
-    end
-
-    after do
-      # Restore connection and configs
-      Slavery.instance_variable_set :@connection_holder, @backup_conn
-      ActiveRecord::Base.configurations = @backup_config
-      Slavery.disabled = @backup_disabled
-    end
-
-    it 'raises error if slave configuration not specified' do
-      ActiveRecord::Base.configurations['test_slave'] = nil
-
-      expect { Slavery.on_slave { User.count } }.to raise_error(Slavery::Error)
-    end
-
-    it 'connects to master if slave configuration not specified' do
-      ActiveRecord::Base.configurations['test_slave'] = nil
-      Slavery.disabled = true
-
-      expect(Slavery.on_slave { User.count }).to be 2
-    end
-
-    it 'connects to slave when specified as a hash' do
-      Slavery.spec_key = 'test_slave'
-      hash = ActiveRecord::Base.configurations['test_slave']
-      expect(Slavery::ConnectionHolder).to receive(:establish_connection).with(hash)
-      Slavery::ConnectionHolder.activate
-    end
-
-    it 'connects to slave when specified as a url' do
-      expected = if Gem::Version.new(ActiveRecord::VERSION::STRING) < Gem::Version.new('4.1.0')
-        'postgres://root:@localhost:5432/test_slave'
-      else
-        {
-          'adapter'  => 'postgresql',
-          'username' => 'root',
-          'port'     => 5432,
-          'database' => 'test_slave',
-          'host'     => 'localhost'
-        }
-      end
-      Slavery.spec_key = 'test_slave_url'
-      expect(Slavery::ConnectionHolder).to receive(:establish_connection).with(expected)
-      Slavery::ConnectionHolder.activate
-    end
-  end
 end

data/spec/spec_helper.rb

@@ -6,25 +6,48 @@ ENV['RACK_ENV'] = 'test'
 require 'slavery'
 
 ActiveRecord::Base.configurations = {
-  'test' =>            { adapter: 'sqlite3', database: 'test_db' },
-  'test_slave'     =>  { adapter: 'sqlite3', database: 'test_slave_db' },
-  'test_slave_url' => "postgres://root:@localhost:5432/test_slave"
+  'test'            =>  { 'adapter' => 'sqlite3', 'database' => 'test_db' },
+  'test_slave'      =>  { 'adapter' => 'sqlite3', 'database' => 'test_slave_db' },
+  'test_slave_url'  =>  'postgres://root:@localhost:5432/test_slave'
 }
 
 # Prepare databases
 class User < ActiveRecord::Base
+  has_many :items
 end
 
-# Create two records on master
-ActiveRecord::Base.establish_connection(:test)
-ActiveRecord::Base.connection.create_table :users, force: true
-User.create
-User.create
+class Item < ActiveRecord::Base
+  belongs_to :user
+end
+
+class Seeder
+  def run
+    # Populate on master
+    connect(:test)
+    create_tables
+    User.create
+    User.create
+    User.first.items.create
+
+    # Populate on slave, emulating replication lag
+    connect(:test_slave)
+    create_tables
+    User.create
 
-# Create one record on slave, emulating replication lag
-ActiveRecord::Base.establish_connection(:test_slave)
-ActiveRecord::Base.connection.create_table :users, force: true
-User.create
+    # Reconnect to master
+    connect(:test)
+  end
+
+  def create_tables
+    ActiveRecord::Base.connection.create_table :users, force: true
+    ActiveRecord::Base.connection.create_table :items, force: true do |t|
+      t.references :user
+    end
+  end
+
+  def connect(env)
+    ActiveRecord::Base.establish_connection(env)
+  end
+end
 
-# Reconnect to master
-ActiveRecord::Base.establish_connection(:test)
+Seeder.new.run

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slavery
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Kenn Ejima
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-15 00:00:00.000000000 Z
+date: 2017-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -83,6 +83,7 @@ files:
 - lib/slavery/version.rb
 - slavery.gemspec
 - spec/active_record/log_subscriber_spec.rb
+- spec/configuration_spec.rb
 - spec/slavery_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/kenn/slavery
@@ -104,11 +105,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Simple, conservative slave reads for ActiveRecord
 test_files:
 - spec/active_record/log_subscriber_spec.rb
+- spec/configuration_spec.rb
 - spec/slavery_spec.rb
 - spec/spec_helper.rb