slavery 1.1.1 → 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cf1496eaaf7ad5d9839bf821fc4fafd5b48d2f4c
+  data.tar.gz: 6b3f1389be627e4e46af04b15b31a6efbba80907
+SHA512:
+  metadata.gz: a5c25149caf8f300de53c07e7c2f3892ee1ff1d06972332357fae177a7a407aac2417467e0a60695f03e69552a38c5cd6aeea8670e2003220768770a01a7dd34
+  data.tar.gz: aa386b5a735bd33ff57338e20bcfb0928dc1d8e8aa9092e4452f0f87d8f10e05e522b1dc7f62a94f6345545c308ce18563f89364013bd906bd74a5fadb1f08e6

data/README.md

@@ -22,13 +22,9 @@ And create slave configs for each environment.
 
 ```yaml
 development:
-  adapter: mysql2
-  username: root
   database: myapp_development
 
 development_slave:
-  adapter: mysql2
-  username: root
   database: myapp_development
 ```
 
@@ -36,7 +32,22 @@ By convention, config keys with `[env]_slave` are automatically used for slave r
 
 Notice that we just copied the settings of `development` to `development_slave`. For `development` and `test`, it's actually recommended as probably you don't want to have replicating multiple databases on your machine. Two connections to the same identical database should be fine for testing purpose.
 
-At this point, Slavery does nothing. Run tests and confirm that anything isn't broken.
+In case you prefer DRYer definition, YAML's aliasing and key merging might help.
+
+```yaml
+common: &common
+  adapter: mysql2
+  username: root
+  database: myapp_development
+
+development:
+  <<: *common
+
+development_slave:
+  <<: *common
+```
+
+At this point, Slavery does nothing. Run tests and confirm that nothing is broken.
 
 ## Usage
 
@@ -58,15 +69,22 @@ Slavery.on_slave do
 end
 ```
 
+Alternatively, you may call `on_slave` directly on the scope, so that the query will be read from slave when it's executed.
+
+```ruby
+User.on_slave.where(active: true).count
+```
+
+Caveat: `pluck` is not supported by the scope syntax, you still need `Slavery.on_slave` in this case.
+
 ## Read-only user
 
 For an extra safeguard, it is recommended to use a read-only user for slave access.
 
-```ruby
+```yaml
 development_slave:
-  adapter: mysql2
+  <<: *common
   username: readonly
-  database: myapp_development
 ```
 
 With MySQL, `GRANT SELECT` creates a read-only user.
@@ -81,7 +99,7 @@ With this user, writes on slave should raises an exception.
 Slavery.on_slave { User.create } 	# => ActiveRecord::StatementInvalid: Mysql2::Error: INSERT command denied...
 ```
 
-It is a good idea to confirm this behavior in your test code.
+It is a good idea to confirm this behavior in your test code as well.
 
 ## Database failure
 

data/lib/slavery.rb

@@ -7,6 +7,8 @@ module Slavery
   extend ActiveSupport::Concern
 
   included do
+    require 'slavery/relation'
+
     class << self
       alias_method_chain :connection, :slavery
     end
@@ -16,13 +18,21 @@ module Slavery
 
   mattr_accessor :disabled
 
-  module ModuleFunctions
+  class << self
     def on_slave(&block)
-      ActiveRecord::Base.on_slave(&block)
+      run true, &block
     end
 
     def on_master(&block)
-      ActiveRecord::Base.on_master(&block)
+      run false, &block
+    end
+
+    def run(new_value)
+      old_value = Thread.current[:on_slave] # Save for recursive nested calls
+      Thread.current[:on_slave] = new_value
+      yield
+    ensure
+      Thread.current[:on_slave] = old_value
     end
 
     def env
@@ -34,23 +44,12 @@ module Slavery
       @env = ActiveSupport::StringInquirer.new(string)
     end
   end
-  extend ModuleFunctions
 
   module ClassMethods
-    def on_slave(&block)
-      with_slavery true, &block
-    end
-
-    def on_master(&block)
-      with_slavery false, &block
-    end
-
-    def with_slavery(new_value)
-      old_value = Thread.current[:on_slave] # Save for recursive nested calls
-      Thread.current[:on_slave] = new_value
-      yield
-    ensure
-      Thread.current[:on_slave] = old_value
+    def on_slave
+      context = scoped
+      context.slavery_target = :slave
+      context
     end
 
     def connection_with_slavery

data/lib/slavery/relation.rb

@@ -0,0 +1,24 @@
+class ActiveRecord::Relation
+  attr_accessor :slavery_target
+
+  # Supports queries like User.on_slave.all
+  def exec_queries_with_slavery
+    if slavery_target == :slave
+      Slavery.on_slave { exec_queries_without_slavery }
+    else
+      exec_queries_without_slavery
+    end
+  end
+
+  # Supports queries like User.on_slave.count
+  def calculate_with_slavery(operation, column_name, options = {})
+    if slavery_target == :slave
+      Slavery.on_slave { calculate_without_slavery(operation, column_name, options) }
+    else
+      calculate_without_slavery(operation, column_name, options)
+    end
+  end
+
+  alias_method_chain :exec_queries, :slavery
+  alias_method_chain :calculate, :slavery
+end

data/lib/slavery/version.rb

@@ -1,3 +1,3 @@
 module Slavery
-  VERSION = '1.1.1'
+  VERSION = '1.2.0'
 end

data/spec/slavery_spec.rb

@@ -53,6 +53,14 @@ describe Slavery do
     Slavery.on_slave { User.slaveryable?.should == false }
   end
 
+  it 'works with scopes' do
+    User.count.should == 2
+    User.on_slave.count.should == 1
+
+    User.scoped.to_a.size.should == 2
+    User.on_slave.scoped.to_a.size.should == 1
+  end
+
   describe 'configuration' do
     before do
       # Backup connection and configs

metadata

@@ -1,62 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: slavery
 version: !ruby/object:Gem::Version
-  version: 1.1.1
-  prerelease: 
+  version: 1.2.0
 platform: ruby
 authors:
 - Kenn Ejima
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-02 00:00:00.000000000 Z
+date: 2013-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Simple, conservative slave reads for ActiveRecord
@@ -74,35 +67,34 @@ files:
 - Rakefile
 - lib/slavery.rb
 - lib/slavery/railtie.rb
+- lib/slavery/relation.rb
 - lib/slavery/version.rb
 - slavery.gemspec
 - spec/slavery_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/kenn/slavery
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.19
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Simple, conservative slave reads for ActiveRecord
 test_files:
 - spec/slavery_spec.rb
 - spec/spec_helper.rb
-has_rdoc: