standby 4.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6dca656d9e0b7b23ba371c78eece948316152faa75952dfba92567b4f6cd7e79
-  data.tar.gz: f8c9f94c39debceb101f69207ebefba5b1dd7092ec58f53713846782f87b32fc
+  metadata.gz: ed313fd2c207aef137a574816b7574d6614d5c2446f2d733aa7d08d2a40b6382
+  data.tar.gz: cda7f21a3cf9aa71c84da0cf8e985e965bd78fde3a21b5e57a8902a0e4b581a4
 SHA512:
-  metadata.gz: 93b848675402550dd940ee266f31f8c533ff27bf7f99663ff1e8c538d5dbec0a4c9e2615ec253a074f453cc89abfea95536af62640bff9e77dd326a3772db709
-  data.tar.gz: 48eb1b450fbf589cc5a13e65f5fdd2ed1689ad5a346e26670fead52b522abfa73d35659b97032651e2819a3d1dddbd3ac57463a1d876aa48dc9cb80dc8d6f8d6
+  metadata.gz: 3e9d7d67ea19465e263e36a7c6318e9f4de15b6c9f53dd1a0e51e6782b1118c2c0e3352b213c687b44ffc2da5d87cc5aa9a270b7e3cea2b3f64b86be4d9d74e5
+  data.tar.gz: 4d07f9692a78f4777814282ee120d9ac6df6ad0e723555758f1bb29062082158460728579c2666e3def498a8eaead6b29b4bc344beab76c9d50f6f41a62c5856

data/.github/workflows/ci.yml

@@ -0,0 +1,24 @@
+name: ci
+on: [pull_request, push]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - "2.7"
+        rails_version:
+          - "7.0"
+          - "6.1"
+          - "5.2"
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_GEMFILE: gemfiles/rails${{ matrix.rails_version }}.gemfile
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - run: bundle exec rake

data/.gitignore

@@ -12,11 +12,8 @@ doc/
 lib/bundler/man
 pkg
 rdoc
+spec/db
 spec/reports
 test/tmp
 test/version_tmp
 tmp
-
-test_db
-test_standby_one
-test_standby_two

data/README.md

@@ -1,6 +1,6 @@
 # Standby - Read from standby databases for ActiveRecord (formerly Slavery)
 
-[![Build Status](https://travis-ci.org/kenn/slavery.svg)](https://travis-ci.org/kenn/slavery)
+![Build Status](https://github.com/kenn/standby/actions/workflows/ci.yml/badge.svg)
 
 Standby is a simple, easy to use gem for ActiveRecord that enables conservative reading from standby databases, which means it won't automatically redirect all SELECTs to standbys.
 
@@ -155,13 +155,10 @@ Update your Gemfile
 gem 'standby'
 ```
 
-Replace `Slavery` with `Standby`, `on_slave` with `on_standby`, and `on_master` with `on_primary`.
+Then
 
-```sh
-grep -e Slavery **/*.rake **/*.rb -s -l | xargs sed -i "" "s|Slavery|Standby|g"
-grep -e on_slave **/*.rake **/*.rb -s -l | xargs sed -i "" "s|on_slave|on_standby|g"
-grep -e on_master **/*.rake **/*.rb -s -l | xargs sed -i "" "s|on_master|on_primary|g"
-```
+* Replace `Slavery` with `Standby`, `on_slave` with `on_standby`, and `on_master` with `on_primary`
+* Update keys in `database.yml` (e.g. `development_slave` to `development_standby`)
 
 ## Upgrading from version 2 to version 3
 

data/Rakefile

@@ -1,4 +1,4 @@
-# require 'bundler/gem_tasks'
+require 'bundler/gem_helper'
 Bundler::GemHelper.install_tasks(name: 'standby')
 
 # RSpec

data/gemfiles/rails4.2.gemfile

@@ -1,5 +1,9 @@
 source "https://rubygems.org"
 
+gemspec name: 'standby', path: '../'
+
 gem 'activerecord', '~> 4.2'
 
-gemspec :path => '../'
+group :development, :test do
+  gem 'sqlite3', '~> 1.3.6'
+end

data/gemfiles/rails5.2.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec name: 'standby', path: '../'
+
+gem 'activerecord', '~> 5.2'

data/gemfiles/rails6.1.gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 6.1'
+gem 'sqlite3', '~> 1.4'
+
+# Rails 6.1 compat with Ruby 3.4+ (these were removed from default gems)
+gem 'logger'
+gem 'mutex_m'
+gem 'bigdecimal'
+gem 'base64'
+gem 'drb'
+
+gemspec name: 'standby', path: '../'

data/gemfiles/rails7.0.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec name: 'standby', path: '../'
+
+gem 'activerecord', '~> 7.0'

data/lib/standby/active_record/base.rb

@@ -1,8 +1,18 @@
 module ActiveRecord
   class Base
     class << self
+      alias_method :connection_pool_without_standby, :connection_pool
       alias_method :connection_without_standby, :connection
 
+      def connection_pool
+        case Thread.current[:_standby]
+        when :primary, NilClass
+          connection_pool_without_standby
+        else
+          Standby.connection_holder(Thread.current[:_standby]).connection_pool_without_standby
+        end
+      end
+
       def connection
         case Thread.current[:_standby]
         when :primary, NilClass

data/lib/standby/active_record/log_subscriber.rb

@@ -1,12 +1,21 @@
+require 'standby/version'
+
 module ActiveRecord
   class LogSubscriber
 
     alias_method :debug_without_standby, :debug
 
     def debug(msg)
-      db = Standby.disabled ? "" : color("[#{Thread.current[:_standby] || "primary"}]", ActiveSupport::LogSubscriber::GREEN, true)
+      db = Standby.disabled ? '' : log_header
       debug_without_standby(db + msg)
     end
 
+    def log_header
+      if Standby.version_gte?('7.1')
+        color("[#{Thread.current[:_standby] || "primary"}]", ActiveSupport::LogSubscriber::GREEN, bold: true)
+      else
+        color("[#{Thread.current[:_standby] || "primary"}]", ActiveSupport::LogSubscriber::GREEN, true)
+      end
+    end
   end
 end

data/lib/standby/active_record/relation.rb

@@ -1,19 +1,18 @@
+module ExecQueriesWithStandbyTarget
+  # Supports queries like User.on_standby.to_a
+  def exec_queries
+    if standby_target
+      Standby.on_standby(standby_target) { super }
+    else
+      super
+    end
+  end
+end
+
 module ActiveRecord
   class Relation
     attr_accessor :standby_target
 
-    # Supports queries like User.on_standby.to_a
-    alias_method :exec_queries_without_standby, :exec_queries
-
-    def exec_queries
-      if standby_target
-        Standby.on_standby(standby_target) { exec_queries_without_standby }
-      else
-        exec_queries_without_standby
-      end
-    end
-
-
     # Supports queries like User.on_standby.count
     alias_method :calculate_without_standby, :calculate
 
@@ -26,3 +25,5 @@ module ActiveRecord
     end
   end
 end
+
+ActiveRecord::Relation.prepend(ExecQueriesWithStandbyTarget)

data/lib/standby/connection_holder.rb

@@ -5,8 +5,15 @@ module Standby
     class << self
       # for delayed activation
       def activate(target)
-        spec = ActiveRecord::Base.configurations["#{ActiveRecord::ConnectionHandling::RAILS_ENV.call}_#{target}"]
-        raise Error.new("Standby target '#{target}' is invalid!") if spec.nil?
+        env_name = "#{ActiveRecord::ConnectionHandling::RAILS_ENV.call}_#{target}"
+        # Rails 6.1+ exposes DatabaseConfigurations helpers; older versions still use hash access.
+        if ActiveRecord::Base.configurations.respond_to?(:find_db_config)
+          spec = ActiveRecord::Base.configurations.find_db_config(env_name)&.configuration_hash
+        else
+          spec = ActiveRecord::Base.configurations[env_name]
+        end
+        raise Error, "Standby target '#{target}' is invalid!" if spec.nil?
+
         establish_connection spec
       end
     end
@@ -15,13 +22,15 @@ module Standby
   class << self
     def connection_holder(target)
       klass_name = "Standby#{target.to_s.camelize}ConnectionHolder"
-      standby_connections[klass_name] ||= begin
-        klass = Class.new(Standby::ConnectionHolder) do
-          self.abstract_class = true
+      standby_connections[klass_name] || standby_connections_mutex.synchronize do
+        standby_connections[klass_name] ||= begin
+          klass = Class.new(Standby::ConnectionHolder) do
+            self.abstract_class = true
+          end
+          Object.const_set(klass_name, klass)
+          klass.activate(target)
+          klass
         end
-        Object.const_set(klass_name, klass)
-        klass.activate(target)
-        klass
       end
     end
   end

data/lib/standby/version.rb

@@ -1,3 +1,9 @@
 module Standby
-  VERSION = '4.0.0'
+  VERSION = '5.1.0'
+
+  class << self
+    def version_gte?(version)
+      Gem::Version.new(ActiveRecord.version) >= Gem::Version.new(version)
+    end
+  end
 end

data/lib/standby.rb

@@ -1,3 +1,4 @@
+require 'logger'
 require 'active_record'
 require 'standby/version'
 require 'standby/base'
@@ -10,11 +11,18 @@ require 'standby/active_record/relation'
 require 'standby/active_record/log_subscriber'
 
 module Standby
+  @standby_connections = {}
+  @standby_connections_mutex = Mutex.new
+
   class << self
     attr_accessor :disabled
 
     def standby_connections
-      @standby_connections ||= {}
+      @standby_connections
+    end
+
+    def standby_connections_mutex
+      @standby_connections_mutex
     end
 
     def on_standby(name = :null_state, &block)

data/spec/configuration_spec.rb

@@ -3,8 +3,15 @@ require 'spec_helper'
 describe 'configuration' do
   before do
     # Backup connection and configs
-    @backup_conn = Standby.instance_variable_get :@standby_connections
-    @backup_config = ActiveRecord::Base.configurations.dup
+    @backup_conn = (Standby.instance_variable_get(:@standby_connections) || {}).dup
+    # Rails 6.1+ wraps configurations in ActiveRecord::DatabaseConfigurations.
+    if ActiveRecord::Base.configurations.respond_to?(:configs_for)
+      @backup_config = ActiveRecord::Base.configurations.configs_for.map do |config|
+        [config.env_name, config.configuration_hash]
+      end.to_h
+    else
+      @backup_config = ActiveRecord::Base.configurations.dup
+    end
     @backup_disabled = Standby.disabled
     @backup_conn.each_key do |klass_name|
       Object.send(:remove_const, klass_name) if Object.const_defined?(klass_name)
@@ -20,15 +27,56 @@ describe 'configuration' do
   end
 
   it 'raises error if standby configuration not specified' do
-    ActiveRecord::Base.configurations['test_standby'] = nil
+    # Rails 6.1+ no longer supports mutating configurations via hash-style access.
+    if ActiveRecord::Base.configurations.respond_to?(:configs_for)
+      ActiveRecord::Base.configurations = @backup_config.merge({ 'test_standby' => {} })
+    else
+      ActiveRecord::Base.configurations['test_standby'] = nil
+    end
 
     expect { Standby.on_standby { User.count } }.to raise_error(Standby::Error)
   end
 
   it 'connects to primary if standby configuration is disabled' do
-    ActiveRecord::Base.configurations['test_standby'] = nil
+    # Rails 6.1+ no longer supports mutating configurations via hash-style access.
+    if ActiveRecord::Base.configurations.respond_to?(:configs_for)
+      ActiveRecord::Base.configurations = @backup_config.merge({ 'test_standby' => {} })
+    else
+      ActiveRecord::Base.configurations['test_standby'] = nil
+    end
     Standby.disabled = true
 
     expect(Standby.on_standby { User.count }).to be 2
   end
+
+  it 'initializes a standby connection holder once under contention' do
+    entered_activate = Queue.new
+    release_activate = Queue.new
+    call_count = 0
+
+    allow(Standby::ConnectionHolder).to receive(:activate).and_wrap_original do |original, target|
+      call_count += 1
+      if call_count == 1
+        entered_activate << true
+        release_activate.pop
+      end
+
+      original.call(target)
+    end
+
+    t1 = Thread.new { Standby.connection_holder(:standby) }
+    entered_activate.pop
+
+    t2 = Thread.new { Standby.connection_holder(:standby) }
+
+    expect(t2.join(0.1)).to be_nil
+    expect(call_count).to eq(1)
+
+    release_activate << true
+
+    [t1, t2].each(&:join)
+
+    expect(Standby.connection_holder(:standby).name).to eq('StandbyStandbyConnectionHolder')
+    expect(call_count).to eq(1)
+  end
 end

data/spec/spec_helper.rb

@@ -6,19 +6,20 @@ ENV['RACK_ENV'] = 'test'
 require 'standby'
 
 ActiveRecord::Base.configurations = {
-  'test'            =>  { 'adapter' => 'sqlite3', 'database' => 'test_db' },
-  'test_standby'      =>  { 'adapter' => 'sqlite3', 'database' => 'test_standby_one' },
-  'test_standby_two'  =>  { 'adapter' => 'sqlite3', 'database' => 'test_standby_two'},
+  'test'            =>  { 'adapter' => 'sqlite3', 'database' => 'spec/db/test_db' },
+  'test_standby'      =>  { 'adapter' => 'sqlite3', 'database' => 'spec/db/test_standby_one' },
+  'test_standby_two'  =>  { 'adapter' => 'sqlite3', 'database' => 'spec/db/test_standby_two'},
   'test_standby_url'  =>  'postgres://root:@localhost:5432/test_standby'
 }
 
 # Prepare databases
 class User < ActiveRecord::Base
   has_many :items
+  attr_accessor :name
 end
 
 class Item < ActiveRecord::Base
-  belongs_to :user
+  belongs_to :user, inverse_of: :items
 end
 
 class Seeder
@@ -51,7 +52,11 @@ class Seeder
   end
 
   def connect(env)
+    ActiveRecord::Base.connection_pool.disconnect! if ActiveRecord::Base.connected?
     ActiveRecord::Base.establish_connection(env)
+    return unless ActiveRecord::Base.connection.adapter_name == 'SQLite'
+
+    ActiveRecord::Base.connection.execute('PRAGMA journal_mode=DELETE')
   end
 end
 

data/spec/{slavery_spec.rb → standby_spec.rb}

@@ -104,4 +104,10 @@ describe Standby do
     expect(User.on_standby(:two).where(nil).to_a.size).to be 0
     expect(User.on_standby.where(nil).to_a.size).to be 1
   end
+
+  it 'does not interfere with setting inverses' do
+    user = User.first
+    user.update(name: 'a different name')
+    expect(user.items.first.user.name).to eq('a different name')
+  end
 end

data/standby.gemspec

@@ -16,9 +16,11 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^exe/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
+  gem.required_ruby_version = '>= 2.0'
 
-  gem.add_runtime_dependency 'activerecord', '>= 3.0.0'
+  gem.add_runtime_dependency 'activerecord', '>= 3.0.0', '< 8.0'
 
+  gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'sqlite3'
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: standby
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Kenn Ejima
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-26 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -17,6 +16,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +26,23 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -59,17 +78,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
-- gemfiles/rails3.2.gemfile
 - gemfiles/rails4.2.gemfile
-- gemfiles/rails4.gemfile
+- gemfiles/rails5.2.gemfile
+- gemfiles/rails6.1.gemfile
+- gemfiles/rails7.0.gemfile
 - lib/standby.rb
 - lib/standby/active_record/base.rb
 - lib/standby/active_record/connection_handling.rb
@@ -80,16 +100,14 @@ files:
 - lib/standby/error.rb
 - lib/standby/transaction.rb
 - lib/standby/version.rb
-- slavery.gemspec
 - spec/active_record/log_subscriber_spec.rb
 - spec/configuration_spec.rb
-- spec/slavery_spec.rb
 - spec/spec_helper.rb
+- spec/standby_spec.rb
 - standby.gemspec
 homepage: https://github.com/kenn/standby
 licenses: []
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -97,20 +115,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Read from stand-by databases for ActiveRecord
 test_files:
 - spec/active_record/log_subscriber_spec.rb
 - spec/configuration_spec.rb
-- spec/slavery_spec.rb
 - spec/spec_helper.rb
+- spec/standby_spec.rb

data/.travis.yml

@@ -1,13 +0,0 @@
-language: ruby
-
-rvm:
- - 2.2.2
- - 2.3.3
-
-gemfile:
-  - Gemfile
-  - gemfiles/rails3.2.gemfile
-  - gemfiles/rails4.gemfile
-  - gemfiles/rails4.2.gemfile
-
-script: bundle exec rspec spec

data/gemfiles/rails3.2.gemfile

@@ -1,9 +0,0 @@
-source "https://rubygems.org"
-
-gem 'activerecord', '~> 3.2'
-
-group :development, :test do
-  gem 'test-unit', '~> 3.0'
-end
-
-gemspec :path => '../'

data/gemfiles/rails4.gemfile

@@ -1,5 +0,0 @@
-source "https://rubygems.org"
-
-gem 'activerecord', '~> 4.0.0'
-
-gemspec :path => '../'

data/slavery.gemspec

@@ -1,27 +0,0 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'standby/version'
-
-Gem::Specification.new do |gem|
-  gem.post_install_message = 'The slavery gem has been deprecated and has ' \
-                             'been replaced by standby. Please switch to ' \
-                             'standby as soon as possible.'
-  gem.name          = 'slavery'
-  gem.version       = Standby::VERSION
-  gem.authors       = ['Kenn Ejima']
-  gem.email         = ['kenn.ejima@gmail.com']
-  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($/)
-  gem.executables   = gem.files.grep(%r{^exe/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ['lib']
-
-  gem.add_runtime_dependency 'activerecord', '>= 3.0.0'
-
-  gem.add_development_dependency 'rspec'
-  gem.add_development_dependency 'sqlite3'
-end