active_record_shards 3.11.0 → 3.19.0

data/lib/active_record_shards.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'active_record'
 require 'active_record/base'
 require 'active_record_shards/configuration_parser'
@@ -7,7 +8,8 @@ require 'active_record_shards/shard_selection'
 require 'active_record_shards/connection_switcher'
 require 'active_record_shards/association_collection_connection_selection'
 require 'active_record_shards/migration'
-require 'active_record_shards/default_slave_patches'
+require 'active_record_shards/default_replica_patches'
+require 'active_record_shards/schema_dumper_extension'
 
 module ActiveRecordShards
   def self.rails_env
@@ -21,17 +23,119 @@ end
 ActiveRecord::Base.extend(ActiveRecordShards::ConfigurationParser)
 ActiveRecord::Base.extend(ActiveRecordShards::Model)
 ActiveRecord::Base.extend(ActiveRecordShards::ConnectionSwitcher)
-ActiveRecord::Base.extend(ActiveRecordShards::DefaultSlavePatches)
-ActiveRecord::Relation.include(ActiveRecordShards::DefaultSlavePatches::ActiveRelationPatches)
+ActiveRecord::Base.extend(ActiveRecordShards::DefaultReplicaPatches)
+ActiveRecord::Relation.include(ActiveRecordShards::DefaultReplicaPatches::ActiveRelationPatches)
 ActiveRecord::Associations::CollectionProxy.include(ActiveRecordShards::AssociationCollectionConnectionSelection)
+ActiveRecord::Associations::Builder::HasAndBelongsToMany.include(ActiveRecordShards::DefaultReplicaPatches::Rails41HasAndBelongsToManyBuilderExtension)
+ActiveRecord::SchemaDumper.prepend(ActiveRecordShards::SchemaDumperExtension)
 
 case "#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"
-when '3.2'
-  require 'active_record_shards/patches-3-2'
 when '4.2'
   require 'active_record_shards/patches-4-2'
-when '5.0', '5.1'
-  require 'active_record_shards/patches-5-0'
+
+  # https://github.com/rails/rails/blob/v4.2.11.3/activerecord/lib/active_record/associations/association.rb#L97
+  ActiveRecord::Associations::Association.prepend(ActiveRecordShards::DefaultReplicaPatches::AssociationsAssociationAssociationScopePatch)
+
+  # https://github.com/rails/rails/blob/v4.2.11.3/activerecord/lib/active_record/associations/singular_association.rb#L44-L53
+  ActiveRecord::Associations::SingularAssociation.prepend(ActiveRecordShards::DefaultReplicaPatches::AssociationsAssociationGetRecordsPatch)
+
+  # https://github.com/rails/rails/blob/v4.2.11.3/activerecord/lib/active_record/associations/collection_association.rb#L447-L456
+  ActiveRecord::Associations::CollectionAssociation.prepend(ActiveRecordShards::DefaultReplicaPatches::AssociationsAssociationGetRecordsPatch)
+
+  # https://github.com/rails/rails/blob/v4.2.11.3/activerecord/lib/active_record/associations/preloader/association.rb#L89
+  ActiveRecord::Associations::Preloader::Association.prepend(ActiveRecordShards::DefaultReplicaPatches::AssociationsPreloaderAssociationAssociatedRecordsByOwnerPatch)
+when '5.0'
+  # https://github.com/rails/rails/blob/v5.0.7/activerecord/lib/active_record/associations/association.rb#L97
+  ActiveRecord::Associations::Association.prepend(ActiveRecordShards::DefaultReplicaPatches::AssociationsAssociationAssociationScopePatch)
+
+  # https://github.com/rails/rails/blob/v5.0.7/activerecord/lib/active_record/associations/singular_association.rb#L56-L65
+  ActiveRecord::Associations::SingularAssociation.prepend(ActiveRecordShards::DefaultReplicaPatches::AssociationsAssociationGetRecordsPatch)
+
+  # https://github.com/rails/rails/blob/v5.0.7/activerecord/lib/active_record/associations/collection_association.rb#L442-L451
+  ActiveRecord::Associations::CollectionAssociation.prepend(ActiveRecordShards::DefaultReplicaPatches::AssociationsAssociationGetRecordsPatch)
+
+  # https://github.com/rails/rails/blob/v5.0.7/activerecord/lib/active_record/associations/preloader/association.rb#L120
+  ActiveRecord::Associations::Preloader::Association.prepend(ActiveRecordShards::DefaultReplicaPatches::AssociationsPreloaderAssociationLoadRecordsPatch)
+when '5.1'
+  # https://github.com/rails/rails/blob/v5.1.7/activerecord/lib/active_record/associations/association.rb#L97
+  ActiveRecord::Associations::Association.prepend(ActiveRecordShards::DefaultReplicaPatches::AssociationsAssociationAssociationScopePatch)
+
+  # https://github.com/rails/rails/blob/v5.1.7/activerecord/lib/active_record/associations/singular_association.rb#L41
+  ActiveRecord::Associations::SingularAssociation.prepend(ActiveRecordShards::DefaultReplicaPatches::AssociationsAssociationFindTargetPatch)
+
+  # https://github.com/rails/rails/blob/v5.1.7/activerecord/lib/active_record/associations/collection_association.rb#L305
+  ActiveRecord::Associations::CollectionAssociation.prepend(ActiveRecordShards::DefaultReplicaPatches::AssociationsAssociationFindTargetPatch)
+
+  # https://github.com/rails/rails/blob/v5.1.7/activerecord/lib/active_record/associations/preloader/association.rb#L120
+  ActiveRecord::Associations::Preloader::Association.prepend(ActiveRecordShards::DefaultReplicaPatches::AssociationsPreloaderAssociationLoadRecordsPatch)
+when '5.2'
+  # https://github.com/rails/rails/blob/v5.2.6/activerecord/lib/active_record/relation.rb#L530
+  # But the #exec_queries method also calls #connection, and I don't know if we should patch that one, too...
+  ActiveRecord::Relation.prepend(ActiveRecordShards::DefaultReplicaPatches::Rails52RelationPatches)
+
+  # https://github.com/rails/rails/blob/v5.2.6/activerecord/lib/active_record/associations/singular_association.rb#L42
+  ActiveRecord::Associations::SingularAssociation.prepend(ActiveRecordShards::DefaultReplicaPatches::AssociationsAssociationFindTargetPatch)
+
+  # https://github.com/rails/rails/blob/v5.2.6/activerecord/lib/active_record/associations/collection_association.rb#L308
+  ActiveRecord::Associations::CollectionAssociation.prepend(ActiveRecordShards::DefaultReplicaPatches::AssociationsAssociationFindTargetPatch)
+
+  # https://github.com/rails/rails/blob/v5.2.6/activerecord/lib/active_record/associations/preloader/association.rb#L96
+  ActiveRecord::Associations::Preloader::Association.prepend(ActiveRecordShards::DefaultReplicaPatches::AssociationsPreloaderAssociationLoadRecordsPatch)
+when '6.0'
+  # https://github.com/rails/rails/blob/v6.0.4/activerecord/lib/active_record/type_caster/connection.rb#L28
+  ActiveRecord::TypeCaster::Connection.prepend(ActiveRecordShards::DefaultReplicaPatches::TypeCasterConnectionConnectionPatch)
+
+  # https://github.com/rails/rails/blob/v6.0.4/activerecord/lib/active_record/schema.rb#L53-L54
+  ActiveRecord::Schema.prepend(ActiveRecordShards::DefaultReplicaPatches::SchemaDefinePatch)
+
+  # https://github.com/rails/rails/blob/v6.0.4/activerecord/lib/active_record/relation.rb#L739
+  # But the #exec_queries and #compute_cache_version methods also call #connection, and I don't know if we should patch those, too...
+  ActiveRecord::Relation.prepend(ActiveRecordShards::DefaultReplicaPatches::Rails52RelationPatches)
+
+  # https://github.com/rails/rails/blob/v6.0.4/activerecord/lib/active_record/associations/association.rb#L213
+  ActiveRecord::Associations::Association.prepend(ActiveRecordShards::DefaultReplicaPatches::AssociationsAssociationFindTargetPatch)
 else
   raise "ActiveRecordShards is not compatible with #{ActiveRecord::VERSION::STRING}"
 end
+
+require 'active_record_shards/deprecation'
+
+ActiveRecordShards::Deprecation.deprecate_methods(
+  ActiveRecordShards::AssociationCollectionConnectionSelection,
+  on_slave_if: :on_replica_if,
+  on_slave_unless: :on_replica_unless,
+  on_slave: :on_replica,
+  on_master: :on_primary,
+  on_master_if: :on_primary_if,
+  on_master_unless: :on_primary_unless
+)
+
+ActiveRecordShards::Deprecation.deprecate_methods(
+  ActiveRecordShards::ConnectionSwitcher,
+  on_slave_if: :on_replica_if,
+  on_slave_unless: :on_replica_unless,
+  on_master_or_slave: :on_primary_or_replica,
+  on_slave: :on_replica,
+  on_master: :on_primary,
+  on_master_if: :on_primary_if,
+  on_master_unless: :on_primary_unless,
+  on_slave?: :on_replica?
+)
+
+ActiveRecordShards::Deprecation.deprecate_methods(
+  ActiveRecordShards::DefaultReplicaPatches,
+  transaction_with_slave_off: :transaction_with_replica_off,
+  on_slave_unless_tx: :on_replica_unless_tx
+)
+
+ActiveRecordShards::Deprecation.deprecate_methods(
+  ActiveRecordShards::Model,
+  on_slave_by_default?: :on_replica_by_default?,
+  :on_slave_by_default= => :on_replica_by_default=
+)
+
+ActiveRecordShards::Deprecation.deprecate_methods(
+  ActiveRecordShards::ShardSelection,
+  on_slave?: :on_replica?,
+  :on_slave= => :on_replica=
+)

metadata

@@ -1,16 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: active_record_shards
 version: !ruby/object:Gem::Version
-  version: 3.11.0
+  version: 3.19.0
 platform: ruby
 authors:
+- Benjamin Quorning
+- Gabe Martin-Dempesy
+- Pierre Schambacher
 - Mick Staugaard
 - Eric Chapweske
 - Ben Osheroff
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-09-05 00:00:00.000000000 Z
+date: 2021-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -18,42 +21,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.16
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.16
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.16
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.16
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
-  name: wwtd
+  name: bump
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,21 +70,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: 5.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: 5.10.0
 - !ruby/object:Gem::Dependency
-  name: mysql2
+  name: minitest-rg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,94 +98,95 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bump
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
-  name: minitest-rg
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.77.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.77.0
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: rubocop-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
-  name: phenix
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 1.5.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
-description: Easily run queries on shard and slave databases.
+        version: 1.5.1
+description: Easily run queries on shard and replica databases.
 email:
+- bquorning@zendesk.com
+- gabe@zendesk.com
+- pschambacher@zendesk.com
 - mick@staugaard.com
-- eac@zendesk.com
-- ben@gimbo.net
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -194,16 +198,16 @@ files:
 - lib/active_record_shards/connection_handler.rb
 - lib/active_record_shards/connection_pool.rb
 - lib/active_record_shards/connection_specification.rb
-- lib/active_record_shards/connection_switcher-4-0.rb
+- lib/active_record_shards/connection_switcher-4-2.rb
 - lib/active_record_shards/connection_switcher-5-0.rb
 - lib/active_record_shards/connection_switcher-5-1.rb
 - lib/active_record_shards/connection_switcher.rb
+- lib/active_record_shards/default_replica_patches.rb
 - lib/active_record_shards/default_slave_patches.rb
+- lib/active_record_shards/deprecation.rb
 - lib/active_record_shards/migration.rb
 - lib/active_record_shards/model.rb
-- lib/active_record_shards/patches-3-2.rb
 - lib/active_record_shards/patches-4-2.rb
-- lib/active_record_shards/patches-5-0.rb
 - lib/active_record_shards/schema_dumper_extension.rb
 - lib/active_record_shards/shard_selection.rb
 - lib/active_record_shards/shard_support.rb
@@ -213,24 +217,23 @@ homepage: https://github.com/zendesk/active_record_shards
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.2.16
+signing_key:
 specification_version: 4
 summary: Simple database switching for ActiveRecord.
 test_files: []

data/lib/active_record_shards/connection_switcher-4-0.rb

@@ -1,68 +0,0 @@
-module ActiveRecordShards
-  module ConnectionSwitcher
-    # Name of the connection pool. Used by ConnectionHandler to retrieve the current connection pool.
-    def connection_pool_name # :nodoc:
-      name = current_shard_selection.shard_name(self)
-
-      if configurations[name].nil? && on_slave?
-        current_shard_selection.shard_name(self, false)
-      else
-        name
-      end
-    end
-
-    private
-
-    def ensure_shard_connection
-      establish_shard_connection unless connected_to_shard?
-    end
-
-    def establish_shard_connection
-      name = connection_pool_name
-      spec = configurations[name]
-
-      if spec.nil?
-        raise ActiveRecord::AdapterNotSpecified, "No database defined by #{name} in database.yml"
-      end
-
-      # in 3.2 rails is asking for a connection pool in a map of these ConnectionSpecifications.  If we want to re-use connections,
-      # we need to re-use specs.
-
-      # note that since we're subverting the standard establish_connection path, we have to handle the funky autoloading of the
-      # connection adapter ourselves.
-      if ActiveRecord::VERSION::MAJOR >= 4
-        specification_cache[name] ||= begin
-          resolver = ActiveRecordShards::ConnectionSpecification::Resolver.new configurations
-          resolver.spec(spec)
-        end
-
-        connection_handler.establish_connection(self, specification_cache[name])
-      else
-        specification_cache[name] ||= begin
-          resolver = ActiveRecordShards::ConnectionSpecification::Resolver.new spec, configurations
-          resolver.spec
-        end
-
-        connection_handler.establish_connection(connection_pool_name, specification_cache[name])
-      end
-    end
-
-    def specification_cache
-      @@specification_cache ||= {}
-    end
-
-    def connection_pool_key
-      specification_cache[connection_pool_name]
-    end
-
-    def connected_to_shard?
-      if ActiveRecord::VERSION::MAJOR >= 4
-        specs_to_pools = Hash[connection_handler.connection_pool_list.map { |pool| [pool.spec, pool] }]
-      else
-        specs_to_pools = connection_handler.connection_pools
-      end
-
-      specs_to_pools.key?(connection_pool_key)
-    end
-  end
-end

data/lib/active_record_shards/patches-3-2.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-require 'active_record_shards/connection_pool'
-require 'active_record_shards/connection_handler'
-require 'active_record_shards/connection_specification'
-
-
-ActiveRecordShards::ConnectionSpecification = ActiveRecord::Base::ConnectionSpecification
-methods_to_override = [:remove_connection]
-ActiveRecordShards.override_connection_handler_methods(methods_to_override)
-
-ActiveRecord::Associations::Preloader::HasAndBelongsToMany.include(ActiveRecordShards::DefaultSlavePatches::HasAndBelongsToManyPreloaderPatches)

data/lib/active_record_shards/patches-5-0.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-
-
-require 'active_record_shards/schema_dumper_extension'
-
-
-
-
-
-ActiveRecord::Associations::Builder::HasAndBelongsToMany.include(ActiveRecordShards::DefaultSlavePatches::Rails41HasAndBelongsToManyBuilderExtension)
-
-ActiveRecord::SchemaDumper.prepend(ActiveRecordShards::SchemaDumperExtension)