active_record_shards 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07a2ae4e9b397abcc455655266c9d66c76af160e56ea963b401a130589f3f48c
-  data.tar.gz: 45993e917fb0585637c72f89d6bee77f805e0192efb6ca3f476e86929d9192ab
+  metadata.gz: aa6b8faea89614322485e584a2e63f9cb7b6ee505c641c68dcf239337776230a
+  data.tar.gz: eb5038c548eecf373a19e811d0354df3c535b6f6f9bfa5cca9140e6d4dbe2994
 SHA512:
-  metadata.gz: 16309006259fadb5b3851ea470d8859618c2df4d10555e5ecb50c257d538ac3f36c69490a33547bc7e53e6a2962d5985623176021b5f0866f9a35973138000cc
-  data.tar.gz: d23f2ae22180be953ba4a8bbb23000f73901ecf7950cae95858d371eec24bf01f2e7d6ee0c7225e8bbe2f76490261baae4059193718ae3cb17ffd78ab338f852
+  metadata.gz: 3b06434d4f484e2d8ea3cceaa98e535712c41b7ac9b2fece389ca25a21e1d0f6249b5c4e85a6206b8718784b9150477b26247de8f667439486dab8d0abf4ef30
+  data.tar.gz: 6453444d52019b1f296df12d96085abaabc40af5bf7595ed2077104efcec8bc7dcda7d43164efb254d09922c67690584e68f6c711d74cefe6de4d16fbe390bab

data/README.md

@@ -7,6 +7,8 @@ switch between database connections. We've made the implementation very small, a
 
 ActiveRecord Shards has been used and tested on Rails 5.x and 6.0, and has in some form or another been used in production on large Rails apps for several years.
 
+Rails 6.1 introduced new connection handling and support for sharding. Apps are encouraged to migrate to the native sharding logic but ActiveRecord Shards supports Rails 6.1 when `legacy_connection_handling` is set to `true`. For more information see [Rails 6.1 installation](#rails-61-installation) and Rails' [multiple databases guide](https://guides.rubyonrails.org/active_record_multiple_databases.html).
+
 - [Installation](#installation)
 - [Configuration](#configuration)
 - [Migrations](#migrations)
@@ -22,6 +24,22 @@ ActiveRecord Shards has been used and tested on Rails 5.x and 6.0, and has in so
 
 and make sure to require 'active\_record\_shards' in some way.
 
+### Rails 6.1 installation
+
+Rails 6.1 is **only** supported with `legacy_connection_handling` set to `true`.
+
+Enable the legacy handling in your configuration files e.g. `config/application.rb` by setting:
+
+``` Ruby
+config.active_record.legacy_connection_handling = true
+```
+
+or
+
+``` Ruby
+ActiveRecord::Base.legacy_connection_handling = true
+```
+
 ## Configuration
 
 Add the replica and shard configuration to config/database.yml:

data/lib/active_record_shards/connection_switcher.rb

@@ -4,7 +4,11 @@ require 'active_record_shards/shard_support'
 
 module ActiveRecordShards
   module ConnectionSwitcher
-    SHARD_NAMES_CONFIG_KEY = 'shard_names'
+    if "#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}" == '6.1'
+      SHARD_NAMES_CONFIG_KEY = :shard_names
+    else
+      SHARD_NAMES_CONFIG_KEY = 'shard_names'
+    end
 
     def self.extended(base)
       base.singleton_class.send(:alias_method, :load_schema_without_default_shard!, :load_schema!)
@@ -14,11 +18,6 @@ module ActiveRecordShards
       base.singleton_class.send(:alias_method, :table_exists?, :table_exists_with_default_shard?)
     end
 
-    def default_shard=(new_default_shard)
-      ActiveRecordShards::ShardSelection.default_shard = new_default_shard
-      switch_connection(shard: new_default_shard)
-    end
-
     def on_primary_db(&block)
       on_shard(nil, &block)
     end
@@ -209,7 +208,7 @@ end
 case "#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"
 when '5.1', '5.2'
   require 'active_record_shards/connection_switcher-5-1'
-when '6.0'
+when '6.0', '6.1'
   require 'active_record_shards/connection_switcher-6-0'
 else
   raise "ActiveRecordShards is not compatible with #{ActiveRecord::VERSION::STRING}"

data/lib/active_record_shards/default_shard.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module ActiveRecordShards
+  module DefaultShard
+    def default_shard=(new_default_shard)
+      if ars_shard_type?(new_default_shard)
+        ActiveRecordShards::ShardSelection.ars_default_shard = new_default_shard
+        switch_connection(shard: new_default_shard)
+      else
+        super
+      end
+    end
+
+    private
+
+    def ars_shard_type?(shard)
+      return true if ActiveRecord.version < Gem::Version.new('6.1')
+      return true if shard.nil?
+      return true if shard == :_no_shard
+      return true if shard.is_a?(Integer)
+
+      false
+    end
+  end
+end
+
+ActiveRecord::Base.singleton_class.prepend(ActiveRecordShards::DefaultShard)

data/lib/active_record_shards/shard_selection.rb

@@ -3,7 +3,7 @@
 module ActiveRecordShards
   class ShardSelection
     NO_SHARD = :_no_shard
-    cattr_accessor :default_shard
+    cattr_accessor :ars_default_shard
 
     def initialize
       @on_replica = false
@@ -14,7 +14,7 @@ module ActiveRecordShards
       if @shard.nil? || @shard == NO_SHARD
         nil
       else
-        @shard || self.class.default_shard
+        @shard || self.class.ars_default_shard
       end
     end
 

data/lib/active_record_shards/tasks.rb

@@ -94,15 +94,22 @@ module ActiveRecordShards
       def root_connection(conf)
         conf = conf.merge('database' => nil)
         spec = spec_for(conf)
-
-        ActiveRecord::Base.send("#{conf['adapter']}_connection", spec.config)
+        if "#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}" == '6.1'
+          ActiveRecord::Base.send("#{conf['adapter']}_connection", spec.db_config.configuration_hash)
+        else
+          ActiveRecord::Base.send("#{conf['adapter']}_connection", spec.config)
+        end
       end
 
       private
 
       def spec_for(conf)
-        resolver = ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver.new(ActiveRecord::Base.configurations)
-        resolver.spec(conf)
+        if "#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}" == '6.1'
+          ActiveRecord::Base.connection_handler.send(:resolve_pool_config, conf, ActiveRecord::Base)
+        else
+          resolver = ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver.new(ActiveRecord::Base.configurations)
+          resolver.spec(conf)
+        end
       end
     end
   end

data/lib/active_record_shards.rb

@@ -9,6 +9,7 @@ require 'active_record_shards/connection_switcher'
 require 'active_record_shards/association_collection_connection_selection'
 require 'active_record_shards/migration'
 require 'active_record_shards/default_replica_patches'
+require 'active_record_shards/default_shard'
 require 'active_record_shards/schema_dumper_extension'
 
 module ActiveRecordShards
@@ -61,7 +62,7 @@ when '5.2'
 
   # 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'
+when '6.0', '6.1'
   # 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)
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_record_shards
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Benjamin Quorning
@@ -13,7 +13,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-06 00:00:00.000000000 Z
+date: 2022-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -24,7 +24,7 @@ dependencies:
         version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -34,7 +34,7 @@ dependencies:
         version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -44,7 +44,7 @@ dependencies:
         version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -54,7 +54,7 @@ dependencies:
         version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: bump
   requirement: !ruby/object:Gem::Requirement
@@ -199,6 +199,7 @@ files:
 - lib/active_record_shards/connection_switcher-6-0.rb
 - lib/active_record_shards/connection_switcher.rb
 - lib/active_record_shards/default_replica_patches.rb
+- lib/active_record_shards/default_shard.rb
 - lib/active_record_shards/migration.rb
 - lib/active_record_shards/model.rb
 - lib/active_record_shards/schema_dumper_extension.rb