active_record_slave 1.0.0 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 85a394f332c93d140dda4319bd811a50332bbb3a
+  data.tar.gz: 9eb811c94d7d43de483569245d587530a7a4725f
+SHA512:
+  metadata.gz: 00eb5c81081b4c205843f7a65aa7fef94f4e6614f35dfb662b0832bb2ec79813dd25fc50edb7aaa8cd612d545bf0eeb9053383d6653ee021d22fe702bce13402
+  data.tar.gz: 3e9ffeb4eb9cbe4bfea45ad2450af2c420a49b4095680a45baaa9e607d1fd49fed600d57f9b24be673da6698518eb75c36df0eed497d98251071605e3762f47f

data/README.md

@@ -3,7 +3,7 @@ active_record_slave
 
 ActiveRecord drop-in solution to efficiently redirect reads to slave databases
 
-* http://github.com/ClarityServices/active_record_slave
+* http://github.com/reidmorrison/active_record_slave
 
 ## Introduction
 
@@ -20,18 +20,24 @@ database to ensure data consistency.
 * Transaction aware. Detects when a query is inside of a transaction and sends
   those reads to the master
 * Lightweight footprint
-* No overhead when a slave is not configured
-* Minimal overhead when redirecting reads to the slave
+* 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 'Slave: ' prefix to indicate which SQL statements are going
+* Debug logs include a prefix of 'Slave: ' to indicate which SQL statements are going
   to the slave database
 
 ### Example showing Slave redirected read
-    r = Role.where(:name => "manager").first
-    r.description = 'Manager'
-    r.save!
+
+```ruby
+# Read from the slave database
+r = Role.where(:name => "manager").first
+r.description = 'Manager'
+
+# Save changes back to the master database
+r.save!
+```
 
 Log file output:
 
@@ -39,11 +45,14 @@ Log file output:
     03-13-12 05:56:22 pm,[2608],b[0],[0],  AREL (12.0ms)  UPDATE `roles` SET `description` = 'Manager' WHERE `roles`.`id` = 5
 
 ### Example showing how reads within a transaction go to the master
-    Role.transaction do
-      r = Role.where(:name => "manager").first
-      r.description = 'Manager'
-      r.save!
-    end
+
+```ruby
+Role.transaction do
+  r = Role.where(:name => "manager").first
+  r.description = 'Manager'
+  r.save!
+end
+```
 
 Log file output:
 
@@ -82,18 +91,16 @@ D, [2012-11-06T19:43:26.891667 #89002] DEBUG -- :   SQL (0.4ms)  DELETE FROM "us
 D, [2012-11-06T19:43:26.892697 #89002] DEBUG -- :    (0.9ms)  commit transaction
 ```
 
+## Dependencies
 
-## Requirements
+* Tested on Rails 3 and Rails 4
 
-* ActiveRecord 3 or greater (Rails 3 or greater)
-
-May also work with Rails 2. Anyone want to give it a try and let me know?
-Happy to make it work with Rails 2 if anyone needs it
+See [.travis.yml](https://github.com/reidmorrison/active_record_slave/.travis.yml) for the list of tested Ruby platforms
 
 ## Note
 
-ActiveRecord::Base.execute is commonly used to perform custom SQL calls against
-the database that bypasses ActiveRecord. It is necessary to replace these calls
+ActiveRecord::Base.execute is sometimes used to perform custom SQL calls against
+the database to bypass ActiveRecord. It is necessary to replace these calls
 with the standard ActiveRecord::Base.select call for them to be picked up by
 active_record_slave and redirected to the slave.
 
@@ -111,62 +118,59 @@ along with all the usual ActiveRecord database configuration options.
 
 For Example:
 
-    development:
-      database: clarity_development
-      username: root
-      password:
-      encoding: utf8
-      adapter:  mysql
-      host:     127.0.0.1
-      pool:     20
-      slave:
-        database: clarity_development_replica
-        username: root
-        password:
-        encoding: utf8
-        adapter:  mysql
-        host:     127.0.0.1
-        pool:     20
+```yaml
+development:
+  database: myapp_development
+  username: root
+  password:
+  encoding: utf8
+  adapter:  mysql
+  host:     127.0.0.1
+  pool:     20
+  slave:
+    database: myapp_development_replica
+    username: root
+    password:
+    encoding: utf8
+    adapter:  mysql
+    host:     127.0.0.1
+    pool:     20
+```
 
 Sometimes it is useful to turn on slave reads per host, for example to activate
 slave reads only on the linux host 'batch':
 
-    development:
-      database: clarity_development
-      username: root
-      password:
-      encoding: utf8
-      adapter:  mysql
-      host:     127.0.0.1
-      pool:     20
-    <% if `hostname`.strip == 'batch' %>
-      slave:
-        database: clarity_development_replica
-        username: root
-        password:
-        encoding: utf8
-        adapter:  mysql
-        host:     127.0.0.1
-        pool:     20
-    <% end %>
-
-## Tests
-
-* active_record_slave is running in a large production system and was tested
-  directly as part of that solution
-* I welcome anyone that can submit tests to verify this gem in a standalone outside
-  environment
+```yaml
+development:
+  database: myapp_development
+  username: root
+  password:
+  encoding: utf8
+  adapter:  mysql
+  host:     127.0.0.1
+  pool:     20
+<% if `hostname`.strip == 'batch' %>
+  slave:
+    database: myapp_development_replica
+    username: root
+    password:
+    encoding: utf8
+    adapter:  mysql
+    host:     127.0.0.1
+    pool:     20
+<% end %>
+```
 
 ## Possible Future Enhancements
 
-* Support for multiple slaves (ask for it by submitting a ticket)
+* Support for multiple slaves (ask for it by submitting an issue)
 
 Meta
 ----
 
-* Code: `git clone git://github.com/ClarityServices/active_record_slave.git`
-* Home: <https://github.com/ClarityServices/active_record_slave>
-* Bugs: <https://github.com/ClarityServices/active_record_slave/issues>
+* 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>
 
 This project uses [Semantic Versioning](http://semver.org/).
@@ -179,7 +183,7 @@ Reid Morrison :: reidmo@gmail.com :: @reidmorrison
 License
 -------
 
-Copyright 2012 Clarity Services, Inc.
+Copyright 2012, 2013, 2014 Reid Morrison
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/Rakefile

@@ -1,28 +1,18 @@
-lib = File.expand_path('../lib/', __FILE__)
-$:.unshift lib unless $:.include?(lib)
-
 require 'rake/clean'
 require 'rake/testtask'
-require 'date'
+
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
 require 'active_record_slave/version'
 
-desc "Build gem"
-task :gem  do |t|
-  gemspec = Gem::Specification.new do |s|
-    s.name        = 'active_record_slave'
-    s.version     = ActiveRecordSlave::VERSION
-    s.platform    = Gem::Platform::RUBY
-    s.authors     = ['Reid Morrison']
-    s.email       = ['reidmo@gmail.com']
-    s.homepage    = 'https://github.com/ClarityServices/active_record_slave'
-    s.date        = Date.today.to_s
-    s.summary     = "ActiveRecord read from slave"
-    s.description = "ActiveRecordSlave is a library to seamlessly enable reading from database slaves in a Rails 3 project, written in Ruby."
-    s.files       = FileList["./**/*"].exclude(/.gem$/, /.log$/,/nbproject/,/sqlite3$/).map{|f| f.sub(/^\.\//, '')}
-    s.has_rdoc    = true
-    #s.add_dependency 'activerecord', '>= 3.0.0'
-  end
-  Gem::Builder.new(gemspec).build
+task :gem do
+  system "gem build active_record_slave.gemspec"
+end
+
+task :publish => :gem do
+  system "git tag -a v#{ActiveRecordSlave::VERSION} -m 'Tagging #{ActiveRecordSlave::VERSION}'"
+  system "git push --tags"
+  system "gem push active_record_slave-#{ActiveRecordSlave::VERSION}.gem"
+  system "rm active_record_slave-#{ActiveRecordSlave::VERSION}.gem"
 end
 
 desc "Run Test Suite"
@@ -34,3 +24,5 @@ task :test do
 
   Rake::Task['functional'].invoke
 end
+
+task :default => :test

data/lib/active_record_slave/active_record_slave.rb

@@ -34,14 +34,49 @@ module ActiveRecordSlave
   # Force reads for the supplied block to read from the master database
   # Only applies to calls made within the current thread
   def self.read_from_master
-    # Set :master indicator in thread local storage so that it is visible
-    # during the select call
-    current = Thread.current[:active_record_slave]
-    Thread.current[:active_record_slave] = :master
-    yield
-  ensure
-    Thread.current[:active_record_slave] = current
+    return yield if read_from_master?
+    begin
+      # Set :master indicator in thread local storage so that it is visible
+      # during the select call
+      read_from_master!
+      yield
+    ensure
+      read_from_slave!
+    end
   end
 
-end
+  if RUBY_VERSION.to_i >= 2
+    # Fibers have their own thread local variables so use thread_variable_get
+
+    # Whether this thread is currently forcing all reads to go against the master database
+    def self.read_from_master?
+      Thread.current.thread_variable_get(:active_record_slave) == :master
+    end
 
+    # Force all subsequent reads on this thread and any fibers called by this thread to go the master
+    def self.read_from_master!
+      Thread.current.thread_variable_set(:active_record_slave, :master)
+    end
+
+    # Subsequent reads on this thread and any fibers called by this thread can go to a slave
+    def self.read_from_slave!
+      Thread.current.thread_variable_set(:active_record_slave, nil)
+    end
+  else
+    # Whether this thread is currently forcing all reads to go against the master database
+    def self.read_from_master?
+      Thread.current[:active_record_slave] == :master
+    end
+
+    # Force all subsequent reads on this thread and any fibers called by this thread to go the master
+    def self.read_from_master!
+      Thread.current[:active_record_slave] = :master
+    end
+
+    # Subsequent reads on this thread and any fibers called by this thread can go to a slave
+    def self.read_from_slave!
+      Thread.current[:active_record_slave] = nil
+    end
+  end
+
+end

data/lib/active_record_slave/instance_methods.rb

@@ -5,7 +5,7 @@ module ActiveRecordSlave
     # Replace #select with one that calls the slave connection instead
     def select_with_slave_reader(sql, name = nil, *args)
       # Only read from slave when not in a transaction and when this is not already the slave connection
-      if (open_transactions == 0) && (Thread.current[:active_record_slave] != :master)
+      if (open_transactions == 0) && !ActiveRecordSlave.read_from_master?
         ActiveRecordSlave.read_from_master do
           Slave.connection.select(sql, "Slave: #{name || 'SQL'}", *args)
         end

data/lib/active_record_slave/version.rb

@@ -1,3 +1,3 @@
 module ActiveRecordSlave #:nodoc
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,62 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: active_record_slave
 version: !ruby/object:Gem::Version
-  version: 1.0.0
-  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors:
 - Reid Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-06 00:00:00.000000000 Z
-dependencies: []
-description: ActiveRecordSlave is a library to seamlessly enable reading from database
-  slaves in a Rails 3 project, written in Ruby.
+date: 2014-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sync_attr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: thread_safe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+description: 
 email:
 - reidmo@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- Gemfile
-- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/active_record_slave.rb
 - lib/active_record_slave/active_record_slave.rb
 - lib/active_record_slave/instance_methods.rb
 - lib/active_record_slave/railtie.rb
 - lib/active_record_slave/slave.rb
 - lib/active_record_slave/version.rb
-- lib/active_record_slave.rb
-- LICENSE.txt
-- Rakefile
-- README.md
 - test/active_record_slave_test.rb
 - test/database.yml
-homepage: https://github.com/ClarityServices/active_record_slave
-licenses: []
+homepage: https://github.com/reidmorrison/active_record_slave
+licenses:
+- Apache License V2.0
+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'
-      segments:
-      - 0
-      hash: -2259159571471524106
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
-summary: ActiveRecord read from slave
-test_files: []
+specification_version: 4
+summary: ActiveRecord drop-in solution to efficiently redirect reads to slave databases
+test_files:
+- test/active_record_slave_test.rb
+- test/database.yml

data/Gemfile

@@ -1,15 +0,0 @@
-source :rubygems
-
-group :test do
-  gem "shoulda"
-end
-
-gem "activerecord"
-platforms :ruby do
-  gem 'sqlite3'
-end
-
-platforms :jruby do
-  gem 'jdbc-sqlite3'
-  gem 'activerecord-jdbcsqlite3-adapter'
-end

data/Gemfile.lock

@@ -1,34 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    activemodel (3.2.8)
-      activesupport (= 3.2.8)
-      builder (~> 3.0.0)
-    activerecord (3.2.8)
-      activemodel (= 3.2.8)
-      activesupport (= 3.2.8)
-      arel (~> 3.0.2)
-      tzinfo (~> 0.3.29)
-    activesupport (3.2.8)
-      i18n (~> 0.6)
-      multi_json (~> 1.0)
-    arel (3.0.2)
-    builder (3.0.4)
-    i18n (0.6.1)
-    multi_json (1.3.7)
-    shoulda (3.3.2)
-      shoulda-context (~> 1.0.1)
-      shoulda-matchers (~> 1.4.1)
-    shoulda-context (1.0.1)
-    shoulda-matchers (1.4.1)
-      activesupport (>= 3.0.0)
-    sqlite3 (1.3.6)
-    tzinfo (0.3.35)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activerecord
-  shoulda
-  sqlite3