active_record_shards 5.0.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07a2ae4e9b397abcc455655266c9d66c76af160e56ea963b401a130589f3f48c
-  data.tar.gz: 45993e917fb0585637c72f89d6bee77f805e0192efb6ca3f476e86929d9192ab
+  metadata.gz: 15b0d33ae1fec065fc2c2763f52bf5385da900ddbc3d8b55089ac6f1f99f9b1c
+  data.tar.gz: 61de1ca1ad18611d9eb059dcec55eb85e4de55c965dd3ee33c60088a5d68f4f2
 SHA512:
-  metadata.gz: 16309006259fadb5b3851ea470d8859618c2df4d10555e5ecb50c257d538ac3f36c69490a33547bc7e53e6a2962d5985623176021b5f0866f9a35973138000cc
-  data.tar.gz: d23f2ae22180be953ba4a8bbb23000f73901ecf7950cae95858d371eec24bf01f2e7d6ee0c7225e8bbe2f76490261baae4059193718ae3cb17ffd78ab338f852
+  metadata.gz: 90e52914b1a63fbfb633882f60f2c2020a057b7ad16530c5800cc44f2e88d551c638fcdc31615f2c1c13d4fd031148ce568a10d4776c0082b0c917e9c7ee8dba
+  data.tar.gz: 8b215a24c9c0e1ff79e75499b9d47976b0143095023c0ec2a1ab4c03cc5e9c048957ef63703fe2a8eef5b92c72b3d156a95662ac3367a67ec6324f9527142913

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 & 7.0 installation
+
+Rails 6.1 & 7.0 are **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-6-1.rb

@@ -0,0 +1,31 @@
+module ActiveRecordShards
+  module ConnectionSwitcher
+    def connection_specification_name
+      name = current_shard_selection.resolve_connection_name(sharded: is_sharded?, configurations: configurations)
+
+      @_ars_connection_specification_names ||= {}
+      unless @_ars_connection_specification_names.include?(name)
+        unless configurations.configs_for(env_name: name, include_replicas: true).any? || name == "ActiveRecord::Base"
+          raise ActiveRecord::AdapterNotSpecified, "No database defined by #{name} in your database config. (configurations: #{configurations.configurations.map(&:env_name).inspect})"
+        end
+
+        @_ars_connection_specification_names[name] = true
+      end
+
+      name
+    end
+
+    private
+
+    def ensure_shard_connection
+      # See if we've connected before. If not, call `#establish_connection`
+      # so that ActiveRecord can resolve connection_specification_name to an
+      # ARS connection.
+      spec_name = connection_specification_name
+
+      pool = connection_handler.retrieve_connection_pool(spec_name)
+
+      connection_handler.establish_connection(spec_name.to_sym) if pool.nil?
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+module ActiveRecordShards
+  module ConnectionSwitcher
+    def connection_specification_name
+      name = current_shard_selection.resolve_connection_name(sharded: is_sharded?, configurations: configurations)
+
+      @_ars_connection_specification_names ||= {}
+      unless @_ars_connection_specification_names.include?(name)
+        unless configurations.configs_for(env_name: name, include_hidden: true).any? || name == "ActiveRecord::Base"
+          raise ActiveRecord::AdapterNotSpecified, "No database defined by #{name} in your database config. (configurations: #{configurations.configurations.map(&:env_name).inspect})"
+        end
+
+        @_ars_connection_specification_names[name] = true
+      end
+
+      name
+    end
+
+    private
+
+    def ensure_shard_connection
+      # See if we've connected before. If not, call `#establish_connection`
+      # so that ActiveRecord can resolve connection_specification_name to an
+      # ARS connection.
+      spec_name = connection_specification_name
+
+      pool = connection_handler.retrieve_connection_pool(spec_name)
+
+      connection_handler.establish_connection(spec_name.to_sym) if pool.nil?
+    end
+  end
+end

data/lib/active_record_shards/connection_switcher.rb

@@ -4,7 +4,12 @@ require 'active_record_shards/shard_support'
 
 module ActiveRecordShards
   module ConnectionSwitcher
-    SHARD_NAMES_CONFIG_KEY = 'shard_names'
+    case "#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"
+    when '6.1', '7.0'
+      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 +19,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
@@ -145,7 +145,15 @@ module ActiveRecordShards
     def config_for_env
       @_ars_config_for_env ||= {}
       @_ars_config_for_env[shard_env] ||= begin
-        unless config = configurations[shard_env]
+        case "#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"
+        when '7.0'
+          config = configurations.configs_for(env_name: shard_env, include_hidden: true).first.configuration_hash
+        when '6.1'
+          config = configurations.configs_for(env_name: shard_env, include_replicas: true).first.configuration_hash
+        else
+          config = configurations[shard_env]
+        end
+        unless config
           raise "Did not find #{shard_env} in configurations, did you forget to add it to your database config? (configurations: #{configurations.to_h.keys.inspect})"
         end
 
@@ -211,6 +219,10 @@ when '5.1', '5.2'
   require 'active_record_shards/connection_switcher-5-1'
 when '6.0'
   require 'active_record_shards/connection_switcher-6-0'
+when '6.1'
+  require 'active_record_shards/connection_switcher-6-1'
+when '7.0'
+  require 'active_record_shards/connection_switcher-7-0'
 else
   raise "ActiveRecordShards is not compatible with #{ActiveRecord::VERSION::STRING}"
 end

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,11 +14,15 @@ module ActiveRecordShards
       if @shard.nil? || @shard == NO_SHARD
         nil
       else
-        @shard || self.class.default_shard
+        @shard || self.class.ars_default_shard
       end
     end
-
-    PRIMARY = "primary"
+    case "#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"
+    when '6.1', '7.0'
+      PRIMARY = "ActiveRecord::Base"
+    else
+      PRIMARY = "primary"
+    end
     def resolve_connection_name(sharded:, configurations:)
       resolved_shard = sharded ? shard : nil
       env = ActiveRecordShards.app_env
@@ -29,7 +33,17 @@ module ActiveRecordShards
       @connection_names[env][resolved_shard][@on_replica] ||= begin
         name = env.dup
         name << "_shard_#{resolved_shard}" if resolved_shard
-        if @on_replica && configurations["#{name}_replica"]
+        replica_config = begin
+          case "#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"
+          when '7.0'
+            configurations.configs_for(env_name: "#{name}_replica", include_hidden: true).any?
+          when '6.1'
+            configurations.configs_for(env_name: "#{name}_replica", include_replicas: true).any?
+          else
+            configurations["#{name}_replica"]
+          end
+        end
+        if @on_replica && replica_config
           "#{name}_replica"
         else
           # ActiveRecord always names its default connection pool 'primary'

data/lib/active_record_shards/tasks.rb

@@ -9,10 +9,24 @@ end
 namespace :db do
   desc 'Drops the database for the current RAILS_ENV including shards'
   task drop: :load_config do
-    ActiveRecord::Base.configurations.to_h.each do |key, conf|
+    configurations = begin
+      case "#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"
+      when '6.1', '7.0'
+        ActiveRecord::Base.configurations.configurations.map { |configuration| [configuration.env_name, configuration.configuration_hash] }
+      else
+        ActiveRecord::Base.configurations.to_h
+      end
+    end
+
+    configurations.each do |key, conf|
       next if !key.start_with?(ActiveRecordShards.app_env) || key.end_with?("_replica")
 
       begin
+        case "#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"
+        when '6.1', '7.0'
+          conf = conf.stringify_keys
+        end
+
         ActiveRecordShards::Tasks.root_connection(conf).drop_database(conf['database'])
       # rescue ActiveRecord::NoDatabaseError # TODO: exists in AR but never is raised here ...
       #   $stderr.puts "Database '#{conf['database']}' does not exist"
@@ -30,13 +44,26 @@ namespace :db do
 
   desc "Create the database defined in config/database.yml for the current RAILS_ENV including shards"
   task create: :load_config do
-    ActiveRecord::Base.configurations.to_h.each do |key, conf|
+    configurations = begin
+      case "#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"
+      when '6.1', '7.0'
+        ActiveRecord::Base.configurations.configurations.map { |configuration| [configuration.env_name, configuration.configuration_hash] }
+      else
+        ActiveRecord::Base.configurations.to_h
+      end
+    end
+    configurations.each do |key, conf|
       next if !key.start_with?(ActiveRecordShards.app_env) || key.end_with?("_replica")
 
       begin
         # MysqlAdapter takes charset instead of encoding in Rails 4.2 or greater
         # https://github.com/rails/rails/blob/4-2-stable/activerecord/lib/active_record/tasks/mysql_database_tasks.rb#L85-L96
         symbolized_configuration = conf.symbolize_keys
+        case "#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"
+        when '6.1', '7.0'
+          conf = conf.stringify_keys
+        end
+
         symbolized_configuration[:charset] = symbolized_configuration[:encoding]
 
         ActiveRecordShards::Tasks.root_connection(conf).create_database(conf['database'], symbolized_configuration)
@@ -94,15 +121,26 @@ module ActiveRecordShards
       def root_connection(conf)
         conf = conf.merge('database' => nil)
         spec = spec_for(conf)
-
-        ActiveRecord::Base.send("#{conf['adapter']}_connection", spec.config)
+        case "#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"
+        when '6.1', '7.0'
+          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)
+        case "#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}"
+        when '7.0'
+          ActiveRecord::Base.connection_handler.send(:resolve_pool_config, conf, ActiveRecord::Base, ActiveRecord::Base.current_role, ActiveRecord::Base.current_shard)
+        when '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', '7.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)
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_record_shards
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.2.0
 platform: ruby
 authors:
 - Benjamin Quorning
@@ -10,10 +10,10 @@ authors:
 - Mick Staugaard
 - Eric Chapweske
 - Ben Osheroff
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-06 00:00:00.000000000 Z
+date: 2022-10-11 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.1'
   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.1'
 - !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.1'
   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.1'
 - !ruby/object:Gem::Dependency
   name: bump
   requirement: !ruby/object:Gem::Requirement
@@ -197,8 +197,11 @@ files:
 - lib/active_record_shards/configuration_parser.rb
 - lib/active_record_shards/connection_switcher-5-1.rb
 - lib/active_record_shards/connection_switcher-6-0.rb
+- lib/active_record_shards/connection_switcher-6-1.rb
+- lib/active_record_shards/connection_switcher-7-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
@@ -210,7 +213,7 @@ homepage: https://github.com/zendesk/active_record_shards
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -225,8 +228,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: Simple database switching for ActiveRecord.
 test_files: []