slavery 1.0.1 → 1.1.0

data/README.md

@@ -1,6 +1,6 @@
-# Slavery - Simple, conservative slave read for ActiveRecord
+# Slavery - Simple, conservative slave reads for ActiveRecord
 
-Slavery is a simple, easy to use plugin for ActiveRecord that enables conservative slave reads, which means it doesn't automatically redirect all SELECTs to slaves. Instead, it lets you specify `Slavery.on_slave { User.count }` to send a particular query to a slave.
+Slavery is a simple, easy to use plugin for ActiveRecord that enables conservative slave reads, which means it doesn't automatically redirect all SELECTs to slaves. Instead, it lets you specify `Slavery.on_slave` to send a particular query to a slave.
 
 Probably you just start off with one single database. As your app grows, you would move to master-slave replication for redundancy. At this point, all queries still go to the master and slaves are just backups. With that configuration, it's tempting to run some long-running queries on the slave. And that's exactly what Slavery does.
 
@@ -34,7 +34,7 @@ development_slave:
 
 By convention, config keys with `[env]_slave` are automatically used for slave reads.
 
-Notice that you just copied the settings for `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.
+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.
 
@@ -69,21 +69,23 @@ development_slave:
   database: myapp_development
 ```
 
-With MySQL, `GRANT SELECT` creates the user.
+With MySQL, `GRANT SELECT` creates a read-only user.
 
 ```SQL
 GRANT SELECT ON *.* TO 'readonly'@'localhost';
 ```
 
-With this setting, writes on slave should raises an exception.
+With this user, writes on slave should raises an exception.
 
 ```ruby
 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.
+
 ## Database failure
 
-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 recover or rebuild the failed one.
+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.
 
 In such an event, you don't want to manually remove `Slavery.on_slave` from your code. Instead, just put the following line in `config/initializers/slavery.rb`.
 
@@ -91,7 +93,7 @@ In such an event, you don't want to manually remove `Slavery.on_slave` from your
 Slavely.disabled = true
 ```
 
-With this line, Slavery stops connection switching and all queries go to the new master database.
+With this line, Slavery stops connection switching and all queries go to the new master.
 
 ## Support for non-Rails apps
 
@@ -100,6 +102,8 @@ If you're using ActiveRecord in a non-Rails app (e.g. Sinatra), be sure to set `
 ```ruby
 Slavery.env = 'development'
 
+ActiveRecord::Base.send(:include, Slavery)
+
 ActiveRecord::Base.configurations = {
   'development' =>        { adapter: 'mysql2', ... },
   'development_slave' =>  { adapter: 'mysql2', ... }

data/lib/slavery.rb

@@ -62,7 +62,10 @@ module Slavery
     end
 
     def slaveryable?
-      inside_transaction = master_connection.open_transactions > 0
+      base_transaction_depth = defined?(ActiveSupport::TestCase) &&
+        ActiveSupport::TestCase.respond_to?(:use_transactional_fixtures) &&
+        ActiveSupport::TestCase.try(:use_transactional_fixtures) ? 1 : 0
+      inside_transaction = master_connection.open_transactions > base_transaction_depth
       raise Error.new('on_slave cannot be used inside transaction block!') if inside_transaction
 
       !Slavery.disabled

data/lib/slavery/version.rb

@@ -1,3 +1,3 @@
 module Slavery
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

data/slavery.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |gem|
   gem.version       = Slavery::VERSION
   gem.authors       = ['Kenn Ejima']
   gem.email         = ['kenn.ejima@gmail.com']
-  gem.description   = %q{Simple, conservative slave read for ActiveRecord}
-  gem.summary       = %q{Simple, conservative slave read for ActiveRecord}
+  gem.description   = %q{Simple, conservative slave reads for ActiveRecord}
+  gem.summary       = %q{Simple, conservative slave reads for ActiveRecord}
   gem.homepage      = 'https://github.com/kenn/slavery'
 
   gem.files         = `git ls-files`.split($/)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slavery
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -59,7 +59,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Simple, conservative slave read for ActiveRecord
+description: Simple, conservative slave reads for ActiveRecord
 email:
 - kenn.ejima@gmail.com
 executables: []
@@ -98,11 +98,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.19
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Simple, conservative slave read for ActiveRecord
+summary: Simple, conservative slave reads for ActiveRecord
 test_files:
 - spec/slavery_spec.rb
 - spec/spec_helper.rb
-has_rdoc: