active_record_shards 3.15.2 → 3.19.0

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'active_record_shards/connection_pool'
 require 'active_record_shards/connection_handler'
 require 'active_record_shards/connection_specification'

data/lib/active_record_shards/schema_dumper_extension.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module ActiveRecordShards
   module SchemaDumperExtension
     def dump(stream)
@@ -23,15 +24,15 @@ module ActiveRecordShards
     def shard_header(stream)
       define_params = @version ? "version: #{@version}" : ""
 
-      stream.puts <<HEADER
+      stream.puts <<~HEADER
 
 
-# This section generated by active_record_shards
+        # This section generated by active_record_shards
 
-ActiveRecord::Base.on_all_shards do
-ActiveRecord::Schema.define(#{define_params}) do
+        ActiveRecord::Base.on_all_shards do
+        ActiveRecord::Schema.define(#{define_params}) do
 
-HEADER
+      HEADER
     end
 
     def shard_trailer(stream)

data/lib/active_record_shards/shard_selection.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+
 module ActiveRecordShards
   class ShardSelection
     NO_SHARD = :_no_shard
     cattr_accessor :default_shard
 
     def initialize
-      @on_slave = false
+      @on_replica = false
       @shard = nil
     end
 
@@ -21,17 +22,17 @@ module ActiveRecordShards
         end
       end
 
-      def shard_name(klass = nil, try_slave = true)
+      def shard_name(klass = nil, try_replica = true)
         the_shard = shard(klass)
 
         @shard_names ||= {}
         @shard_names[ActiveRecordShards.rails_env] ||= {}
         @shard_names[ActiveRecordShards.rails_env][the_shard] ||= {}
-        @shard_names[ActiveRecordShards.rails_env][the_shard][try_slave] ||= {}
-        @shard_names[ActiveRecordShards.rails_env][the_shard][try_slave][@on_slave] ||= begin
+        @shard_names[ActiveRecordShards.rails_env][the_shard][try_replica] ||= {}
+        @shard_names[ActiveRecordShards.rails_env][the_shard][try_replica][@on_replica] ||= begin
           s = ActiveRecordShards.rails_env.dup
           s << "_shard_#{the_shard}" if the_shard
-          s << "_slave"              if @on_slave && try_slave
+          s << "_replica"            if @on_replica && try_replica
           s
         end
       end
@@ -46,7 +47,7 @@ module ActiveRecordShards
         end
       end
 
-      PRIMARY = "primary".freeze
+      PRIMARY = "primary"
       def resolve_connection_name(sharded:, configurations:)
         resolved_shard = sharded ? shard : nil
         env = ActiveRecordShards.rails_env
@@ -54,11 +55,11 @@ module ActiveRecordShards
         @connection_names ||= {}
         @connection_names[env] ||= {}
         @connection_names[env][resolved_shard] ||= {}
-        @connection_names[env][resolved_shard][@on_slave] ||= begin
+        @connection_names[env][resolved_shard][@on_replica] ||= begin
           name = env.dup
           name << "_shard_#{resolved_shard}" if resolved_shard
-          if @on_slave && configurations["#{name}_slave"]
-            "#{name}_slave"
+          if @on_replica && configurations["#{name}_replica"]
+            "#{name}_replica"
           else
             # ActiveRecord always names its default connection pool 'primary'
             # while everything else is named by the configuration name
@@ -73,16 +74,18 @@ module ActiveRecordShards
       @shard = (new_shard || NO_SHARD)
     end
 
-    def on_slave?
-      @on_slave
+    def on_replica?
+      @on_replica
     end
+    alias_method :on_slave?, :on_replica?
 
-    def on_slave=(new_slave)
-      @on_slave = (new_slave == true)
+    def on_replica=(new_replica)
+      @on_replica = (new_replica == true)
     end
+    alias_method :on_slave=, :on_replica=
 
     def options
-      { shard: @shard, slave: @on_slave }
+      { shard: @shard, replica: @on_replica }
     end
   end
 end

data/lib/active_record_shards/shard_support.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module ActiveRecordShards
   class ShardSupport
     class ShardEnumerator

data/lib/active_record_shards/sql_comments.rb

@@ -1,16 +1,19 @@
-# show which connection was picked to debug master/slave slowness when both servers are the same
+# show which connection was picked to debug primary/replica slowness when both servers are the same
 module ActiveRecordShards
   module SqlComments
     module Methods
       def execute(query, name = nil)
-        slave = ActiveRecord::Base.current_shard_selection.on_slave?
-        query += " /* #{slave ? 'slave' : 'master'} */"
+        shard = ActiveRecord::Base.current_shard_selection.shard
+        shard_text = shard ? "shard #{shard}" : 'unsharded'
+        replica = ActiveRecord::Base.current_shard_selection.on_replica?
+        replica_text = replica ? 'replica' : 'primary'
+        query = "/* #{shard_text} #{replica_text} */ " + query
         super(query, name)
       end
     end
 
     def self.enable
-      ActiveRecord::Base.on_slave do
+      ActiveRecord::Base.on_replica do
         ActiveRecord::Base.on_shard(nil) do
           ActiveRecord::Base.connection.class.prepend(Methods)
         end

data/lib/active_record_shards/tasks.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'active_record_shards'
 
 %w[db:drop db:create db:abort_if_pending_migrations db:reset db:test:purge].each do |name|
@@ -8,15 +9,16 @@ end
 namespace :db do
   desc 'Drops the database for the current RAILS_ENV including shards'
   task drop: :load_config do
-    ActiveRecord::Base.configurations.each do |key, conf|
-      next if !key.starts_with?(ActiveRecordShards.rails_env) || key.ends_with?("_slave")
+    ActiveRecord::Base.configurations.to_h.each do |key, conf|
+      next if !key.start_with?(ActiveRecordShards.rails_env) || key.end_with?("_replica", "_slave")
+
       begin
         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"
-      rescue StandardError => error
-        $stderr.puts error, *error.backtrace
-        $stderr.puts "Couldn't drop #{conf['database']}"
+      rescue StandardError => e
+        warn e, *e.backtrace
+        warn "Couldn't drop #{conf['database']}"
       end
     end
   end
@@ -28,8 +30,9 @@ 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.each do |key, conf|
-      next if !key.starts_with?(ActiveRecordShards.rails_env) || key.ends_with?("_slave")
+    ActiveRecord::Base.configurations.to_h.each do |key, conf|
+      next if !key.start_with?(ActiveRecordShards.rails_env) || key.end_with?("_replica", "_slave")
+
       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
@@ -37,11 +40,11 @@ namespace :db do
         symbolized_configuration[:charset] = symbolized_configuration[:encoding]
 
         ActiveRecordShards::Tasks.root_connection(conf).create_database(conf['database'], symbolized_configuration)
-      rescue ActiveRecord::StatementInvalid => ex
-        if ex.message.include?('database exists')
+      rescue ActiveRecord::StatementInvalid => e
+        if e.message.include?('database exists')
           puts "#{conf['database']} already exists"
         else
-          raise ex
+          raise e
         end
       end
     end
@@ -52,7 +55,10 @@ namespace :db do
   task abort_if_pending_migrations: :environment do
     if defined? ActiveRecord
       pending_migrations =
-        if ActiveRecord::VERSION::STRING >= "5.2.0"
+        if ActiveRecord::VERSION::MAJOR >= 6
+          migrations = ActiveRecord::MigrationContext.new(ActiveRecord::Migrator.migrations_paths, ActiveRecord::SchemaMigration).migrations
+          ActiveRecord::Migrator.new(:up, migrations, ActiveRecord::SchemaMigration).pending_migrations
+        elsif ActiveRecord::VERSION::STRING >= "5.2.0"
           migrations = ActiveRecord::MigrationContext.new(ActiveRecord::Migrator.migrations_paths).migrations
           ActiveRecord::Migrator.new(:up, migrations).pending_migrations
         else
@@ -60,9 +66,9 @@ namespace :db do
         end
 
       if pending_migrations.any?
-        $stderr.puts "You have #{pending_migrations.size} pending migrations:"
+        warn "You have #{pending_migrations.size} pending migrations:"
         pending_migrations.each do |pending_migration|
-          $stderr.puts '  %4d %s' % [pending_migration.version, pending_migration.name]
+          warn '  %4d %s' % [pending_migration.version, pending_migration.name]
         end
         abort %(Run "rake db:migrate" to update your database then try again.)
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_record_shards
 version: !ruby/object:Gem::Version
-  version: 3.15.2
+  version: 3.19.0
 platform: ruby
 authors:
 - Benjamin Quorning
@@ -10,10 +10,10 @@ authors:
 - Mick Staugaard
 - Eric Chapweske
 - Ben Osheroff
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-10-11 00:00:00.000000000 Z
+date: 2021-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -24,7 +24,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -34,7 +34,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -44,7 +44,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -54,37 +54,37 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bump
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: mysql2
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.10.0
 - !ruby/object:Gem::Dependency
-  name: bump
+  name: minitest-rg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -98,21 +98,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: 1.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -126,48 +126,62 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest-rg
+  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: mocha
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 0.77.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 0.77.0
 - !ruby/object:Gem::Dependency
-  name: phenix
+  name: rubocop-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        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
@@ -184,11 +198,13 @@ 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-4-2.rb
@@ -201,7 +217,7 @@ homepage: https://github.com/zendesk/active_record_shards
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -216,8 +232,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.16
+signing_key:
 specification_version: 4
 summary: Simple database switching for ActiveRecord.
 test_files: []