slavery 2.1.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02a75efbc26dd3232de851d07d1903f8808c0afe
-  data.tar.gz: 1c6bea05c62d6f8806e45b2e853ea5a78e05f70b
+  metadata.gz: d8d8a53892c3dc8ba6beea003eeb3e8dda2fcb7f
+  data.tar.gz: 884ce3b0bccb928742362447f0a1afdc9f7edc5c
 SHA512:
-  metadata.gz: 4e9f079b232c11fc516e14d849a48f8f7de7cd00149fdf8efa951340d76a10f4c0db4b337ce602d5883212f7186d531198a60bb7a33398170dd95231301f19a6
-  data.tar.gz: e82e262252ab96f041f5e47766e78200e0845ba0af7983910cb6b833d0af743be6525e04bb0c7cfad0c8e0d5ed045c083aa602fd4a392c2a16ea5df5c55f6175
+  metadata.gz: 603d8b62b416668e3cec066d49308aa78f194557d14741e551f14280b337dcbc081e52cf48848141c1ab0a0ae8cdc948cc6ba1e85ddb177c2ad61d8a1357ffc3
+  data.tar.gz: b0fd5c1246b7ada095fa7a1ef93a88ef1cb6d134a6a4bf0e1b2f9ce9635a1b6a3dd729059729cc5ee10f442b491a7805aeacce26fe7c5b53110e73fc9d5bf243

data/.gitignore

@@ -18,4 +18,5 @@ test/version_tmp
 tmp
 
 test_db
-test_slave_db
+test_slave_one
+test_slave_two

data/README.md

@@ -66,6 +66,7 @@ To start using Slavery, you need to add `Slavery.on_slave` in your code. Queries
 
 ```ruby
 Slavery.on_slave { User.count } 	# => runs on slave
+Slavery.on_slave(:two) { User.count }  # => runs on another slave configured as `development_slave_two`
 ```
 
 You can nest `on_slave` and `on_master` interchangeably. The following code works as expected.
@@ -158,15 +159,8 @@ ActiveRecord::Base.configurations = {
 ActiveRecord::Base.establish_connection(:development)
 ```
 
-## Custom slave key in database.yml
-
-This is useful for deploying on EngineYard where the configuration key in database.yml is simple "slave". Put the following line in `config/initializers/slavery.rb`.
-
-```ruby
-Slavery.spec_key = "slave" #instead of production_slave
-```
-
 ## Changelog
 
+* v3.0.0: Support for multiple slave targets ([@punchh](https://github.com/punchh))
 * v2.1.0: Debug log support / Database URL support / Rails 3.2 & 4.0 compatibility (Thanks to [@citrus](https://github.com/citrus))
 * v2.0.0: Rails 5 support

data/lib/slavery.rb

@@ -12,14 +12,14 @@ require 'slavery/active_record/log_subscriber'
 module Slavery
   class << self
     attr_accessor :disabled
-    attr_writer :spec_key
 
-    def spec_key
-      @spec_key ||= "#{ActiveRecord::ConnectionHandling::RAILS_ENV.call}_slave"
+    def slave_connections
+      @slave_connections ||= {}
     end
 
-    def on_slave(&block)
-      Base.new(:slave).run &block
+    def on_slave(name = :null_state, &block)
+      raise Slavery::Error.new('invalid slave target') unless name.is_a?(Symbol)
+      Base.new(name).run &block
     end
 
     def on_master(&block)

data/lib/slavery/active_record/base.rb

@@ -5,21 +5,19 @@ module ActiveRecord
 
       def connection
         case Thread.current[:slavery]
-        when :slave
-          Slavery.connection_holder.connection_without_slavery
         when :master, NilClass
           connection_without_slavery
         else
-          raise Slavery::Error.new("invalid target: #{Thread.current[:slavery]}")
+          Slavery.connection_holder(Thread.current[:slavery]).connection_without_slavery
         end
       end
 
       # Generate scope at top level e.g. User.on_slave
-      def on_slave
+      def on_slave(name = :null_state)
         # Why where(nil)?
         # http://stackoverflow.com/questions/18198963/with-rails-4-model-scoped-is-deprecated-but-model-all-cant-replace-it
         context = where(nil)
-        context.slavery_target = :slave
+        context.slavery_target = name || :null_state
         context
       end
     end

data/lib/slavery/active_record/relation.rb

@@ -6,8 +6,8 @@ module ActiveRecord
     alias_method :exec_queries_without_slavery, :exec_queries
 
     def exec_queries
-      if slavery_target == :slave
-        Slavery.on_slave { exec_queries_without_slavery }
+      if slavery_target
+        Slavery.on_slave(slavery_target) { exec_queries_without_slavery }
       else
         exec_queries_without_slavery
       end
@@ -18,8 +18,8 @@ module ActiveRecord
     alias_method :calculate_without_slavery, :calculate
 
     def calculate(*args)
-      if slavery_target == :slave
-        Slavery.on_slave { calculate_without_slavery(*args) }
+      if slavery_target
+        Slavery.on_slave(slavery_target) { calculate_without_slavery(*args) }
       else
         calculate_without_slavery(*args)
       end

data/lib/slavery/base.rb

@@ -11,12 +11,16 @@ module Slavery
   private
 
     def decide_with(target)
-      if Slavery.disabled
+      if Slavery.disabled || target == :master
         :master
+      elsif inside_transaction?
+        raise Slavery::Error.new('on_slave cannot be used inside transaction block!')
+      elsif target == :null_state
+        :slave
+      elsif target.present?
+        "slave_#{target}".to_sym
       else
-        raise Slavery::Error.new('on_slave cannot be used inside transaction block!') if inside_transaction?
-
-        target
+        raise Slavery::Error.new('on_slave cannot be used with a nil target!')
       end
     end
 

data/lib/slavery/connection_holder.rb

@@ -4,19 +4,24 @@ module Slavery
 
     class << self
       # for delayed activation
-      def activate
-        spec = ActiveRecord::Base.configurations[Slavery.spec_key]
-        raise Error.new('Slavery.spec_key invalid!') if spec.nil?
+      def activate(target)
+        spec = ActiveRecord::Base.configurations["#{ActiveRecord::ConnectionHandling::RAILS_ENV.call}_#{target}"]
+        raise Error.new("Slave target '#{target}' is invalid!") if spec.nil?
         establish_connection spec
       end
     end
   end
 
   class << self
-    def connection_holder
-      @connection_holder ||= begin
-        ConnectionHolder.activate
-        ConnectionHolder
+    def connection_holder(target)
+      klass_name = "Slavery#{target.to_s.camelize}ConnectionHolder"
+      slave_connections[klass_name] ||= begin
+        klass = Class.new(Slavery::ConnectionHolder) do
+          self.abstract_class = true
+        end
+        Object.const_set(klass_name, klass)
+        klass.activate(target)
+        klass
       end
     end
   end

data/lib/slavery/version.rb

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

data/spec/configuration_spec.rb

@@ -3,15 +3,18 @@ require 'spec_helper'
 describe 'configuration' do
   before do
     # Backup connection and configs
-    @backup_conn = Slavery.instance_variable_get :@connection_holder
+    @backup_conn = Slavery.instance_variable_get :@slave_connections
     @backup_config = ActiveRecord::Base.configurations.dup
     @backup_disabled = Slavery.disabled
-    Slavery.instance_variable_set :@connection_holder, nil
+    @backup_conn.each_key do |klass_name|
+      Object.send(:remove_const, klass_name) if Object.const_defined?(klass_name)
+    end
+    Slavery.instance_variable_set :@slave_connections, {}
   end
 
   after do
     # Restore connection and configs
-    Slavery.instance_variable_set :@connection_holder, @backup_conn
+    Slavery.instance_variable_set :@slave_connections, @backup_conn
     ActiveRecord::Base.configurations = @backup_config
     Slavery.disabled = @backup_disabled
   end
@@ -22,34 +25,10 @@ describe 'configuration' do
     expect { Slavery.on_slave { User.count } }.to raise_error(Slavery::Error)
   end
 
-  it 'connects to master if slave configuration not specified' do
+  it 'connects to master if slave configuration is disabled' 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

@@ -12,11 +12,13 @@ describe Slavery do
   it 'sets thread local' do
     Slavery.on_master { expect(slavery_value).to be :master }
     Slavery.on_slave  { expect(slavery_value).to be :slave }
+    Slavery.on_slave(:two) { expect(slavery_value).to be :slave_two}
   end
 
   it 'returns value from block' do
     expect(Slavery.on_master { User.count }).to be 2
     expect(Slavery.on_slave  { User.count }).to be 1
+    expect(Slavery.on_slave(:two) { User.count }).to be 0
   end
 
   it 'handles nested calls' do
@@ -61,11 +63,6 @@ describe Slavery do
     Slavery.disabled = backup
   end
 
-  it 'sets the Slavery database spec name by configuration' do
-    Slavery.spec_key = 'custom_slave'
-    expect(Slavery.spec_key).to eq 'custom_slave'
-  end
-
   it 'avoids stack overflow with 3rdparty gem that defines alias_method. namely newrelic...' do
     class ActiveRecord::Relation
       alias_method :calculate_without_thirdparty, :calculate
@@ -82,13 +79,29 @@ describe Slavery do
     end
   end
 
+  it 'works with nils like slave' do
+    expect(User.on_slave(nil).count).to be User.on_slave.count
+  end
+
+  it 'raises on blanks and strings' do
+    expect { User.on_slave("").count }.to raise_error(Slavery::Error)
+    expect { User.on_slave("two").count }.to raise_error(Slavery::Error)
+    expect { User.on_slave("slave").count }.to raise_error(Slavery::Error)
+  end
+
+  it 'raises with non existent extension' do
+    expect { Slavery.on_slave(:non_existent) { User.first } }.to raise_error(Slavery::Error)
+  end
+
   it 'works with any scopes' do
     expect(User.count).to be 2
+    expect(User.on_slave(:two).count).to be 0
     expect(User.on_slave.count).to be 1
 
     # Why where(nil)?
     # http://stackoverflow.com/questions/18198963/with-rails-4-model-scoped-is-deprecated-but-model-all-cant-replace-it
     expect(User.where(nil).to_a.size).to be 2
+    expect(User.on_slave(:two).where(nil).to_a.size).to be 0
     expect(User.on_slave.where(nil).to_a.size).to be 1
   end
 end

data/spec/spec_helper.rb

@@ -7,7 +7,8 @@ require 'slavery'
 
 ActiveRecord::Base.configurations = {
   'test'            =>  { 'adapter' => 'sqlite3', 'database' => 'test_db' },
-  'test_slave'      =>  { 'adapter' => 'sqlite3', 'database' => 'test_slave_db' },
+  'test_slave'      =>  { 'adapter' => 'sqlite3', 'database' => 'test_slave_one' },
+  'test_slave_two'  =>  { 'adapter' => 'sqlite3', 'database' => 'test_slave_two'},
   'test_slave_url'  =>  'postgres://root:@localhost:5432/test_slave'
 }
 
@@ -34,6 +35,10 @@ class Seeder
     create_tables
     User.create
 
+    # Populate on slave two
+    connect(:test_slave_two)
+    create_tables
+
     # Reconnect to master
     connect(:test)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slavery
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Kenn Ejima
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-23 00:00:00.000000000 Z
+date: 2017-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -105,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Simple, conservative slave reads for ActiveRecord