active_record_shards 3.17.0 → 4.0.0.beta1

data/lib/active_record_shards/default_slave_patches.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
-
 module ActiveRecordShards
   module DefaultSlavePatches
-    def self.wrap_method_in_on_slave(class_method, base, method, force_on_slave: false)
+    def self.wrap_method_in_on_slave(class_method, base, method)
       base_methods =
         if class_method
           base.methods + base.private_methods
@@ -11,14 +10,11 @@ module ActiveRecordShards
         end
 
       return unless base_methods.include?(method)
-
       _, method, punctuation = method.to_s.match(/^(.*?)([\?\!]?)$/).to_a
-      # _ALWAYS_ on slave, or only for on `on_slave_by_default = true` models?
-      wrapper = force_on_slave ? 'force_on_slave' : 'on_slave_unless_tx'
       base.class_eval <<-RUBY, __FILE__, __LINE__ + 1
         #{class_method ? 'class << self' : ''}
           def #{method}_with_default_slave#{punctuation}(*args, &block)
-            #{wrapper} do
+            on_slave_unless_tx do
               #{method}_without_default_slave#{punctuation}(*args, &block)
             end
           end
@@ -29,6 +25,18 @@ module ActiveRecordShards
       RUBY
     end
 
+    def columns_with_force_slave(*args, &block)
+      on_cx_switch_block(:slave, construct_ro_scope: false, force: true) do
+        columns_without_force_slave(*args, &block)
+      end
+    end
+
+    def table_exists_with_force_slave?(*args, &block)
+      on_cx_switch_block(:slave, construct_ro_scope: false, force: true) do
+        table_exists_without_force_slave?(*args, &block)
+      end
+    end
+
     def transaction_with_slave_off(*args, &block)
       if on_slave_by_default?
         begin
@@ -48,35 +56,30 @@ module ActiveRecordShards
       def quote_value(*args, &block)
         self.class.quote_value(*args, &block)
       end
+
+      def reload_with_slave_off(*args, &block)
+        self.class.on_master { reload_without_slave_off(*args, &block) }
+      end
     end
 
-    CLASS_SLAVE_METHODS = [
-      :calculate,
-      :count_by_sql,
-      :exists?,
-      :find_by_sql,
-      :find_every,
-      :find_one,
-      :find_some
-    ].freeze
-
-    CLASS_FORCE_SLAVE_METHODS = [
-      :columns,
-      :replace_bind_variable,
-      :replace_bind_variables,
-      :sanitize_sql_array,
-      :sanitize_sql_hash_for_assignment,
-      :table_exists?
-    ].freeze
+    CLASS_SLAVE_METHODS = [:find_by_sql, :count_by_sql, :calculate, :find_one, :find_some, :find_every, :exists?].freeze
 
     def self.extended(base)
       CLASS_SLAVE_METHODS.each { |m| ActiveRecordShards::DefaultSlavePatches.wrap_method_in_on_slave(true, base, m) }
-      CLASS_FORCE_SLAVE_METHODS.each { |m| ActiveRecordShards::DefaultSlavePatches.wrap_method_in_on_slave(true, base, m, force_on_slave: true) }
 
       base.class_eval do
         include InstanceMethods
 
+        alias_method :reload_without_slave_off, :reload
+        alias_method :reload, :reload_with_slave_off
+
         class << self
+          alias_method :columns_without_force_slave, :columns
+          alias_method :columns, :columns_with_force_slave
+
+          alias_method :table_exists_without_force_slave?, :table_exists?
+          alias_method :table_exists?, :table_exists_with_force_slave?
+
           alias_method :transaction_without_slave_off, :transaction
           alias_method :transaction, :transaction_with_slave_off
         end
@@ -87,41 +90,30 @@ module ActiveRecordShards
       end
     end
 
-    def on_slave_unless_tx(&block)
+    def on_slave_unless_tx
       if on_slave_by_default? && !Thread.current[:_active_record_shards_slave_off]
-        on_slave(&block)
+        on_slave { yield }
       else
         yield
       end
     end
 
-    def force_on_slave(&block)
-      on_cx_switch_block(:slave, construct_ro_scope: false, force: true, &block)
-    end
-
     module ActiveRelationPatches
       def self.included(base)
-        [:calculate, :exists?, :pluck, :load].each do |m|
+        [:calculate, :exists?, :pluck, :find_with_associations].each do |m|
           ActiveRecordShards::DefaultSlavePatches.wrap_method_in_on_slave(false, base, m)
         end
-
-        if ActiveRecord::VERSION::MAJOR == 4
-          # `where` and `having` clauses call `create_binds`, which will use the master connection
-          ActiveRecordShards::DefaultSlavePatches.wrap_method_in_on_slave(false, base, :create_binds, force_on_slave: true)
-        end
-
-        ActiveRecordShards::DefaultSlavePatches.wrap_method_in_on_slave(false, base, :to_sql, force_on_slave: true)
       end
 
-      def on_slave_unless_tx(&block)
-        @klass.on_slave_unless_tx(&block)
+      def on_slave_unless_tx
+        @klass.on_slave_unless_tx { yield }
       end
     end
 
     # in rails 4.1+, they create a join class that's used to pull in records for HABTM.
     # this simplifies the hell out of our existence, because all we have to do is inerit on-slave-by-default
     # down from the parent now.
-    module Rails41HasAndBelongsToManyBuilderExtension
+    module HasAndBelongsToManyBuilderExtension
       def self.included(base)
         base.class_eval do
           alias_method :through_model_without_inherit_default_slave_from_lhs, :through_model
@@ -135,8 +127,8 @@ module ActiveRecordShards
           left_reflection.klass.on_slave_by_default?
         end
 
-        # also transfer the sharded-ness of the left table to the join model
-        model.not_sharded unless model.left_reflection.klass.is_sharded?
+        model.extend(ActiveRecordShards::Ext::ShardedModel) if model.left_reflection.klass.is_sharded?
+
         model
       end
     end

data/lib/active_record_shards/model.rb

@@ -3,25 +3,14 @@
 module ActiveRecordShards
   module Model
     def not_sharded
-      if self != ActiveRecord::Base && self != base_class
-        raise "You should only call not_sharded on direct descendants of ActiveRecord::Base"
-      end
-
-      self.sharded = false
+      ActiveSupport::Deprecation.warn("Calling not_sharded is deprecated. "\
+                                      "Please ensure to still read from the "\
+                                      "account db slave after removing the "\
+                                      "call.")
     end
 
     def is_sharded? # rubocop:disable Naming/PredicateName
-      if self == ActiveRecord::Base
-        sharded != false && supports_sharding?
-      elsif self == base_class
-        if sharded.nil?
-          ActiveRecord::Base.is_sharded?
-        else
-          sharded != false
-        end
-      else
-        base_class.is_sharded?
-      end
+      false
     end
 
     def on_slave_by_default?
@@ -62,9 +51,5 @@ module ActiveRecordShards
       base.send(:include, InstanceMethods)
       base.after_initialize :initialize_shard_and_slave
     end
-
-    private
-
-    attr_accessor :sharded
   end
 end

data/lib/active_record_shards/shard_selection.rb

@@ -1,77 +1,40 @@
 # frozen_string_literal: true
-
 module ActiveRecordShards
   class ShardSelection
-    NO_SHARD = :_no_shard
-    cattr_accessor :default_shard
-
-    def initialize
+    def initialize(shard)
       @on_slave = false
-      @shard = nil
+      self.shard = shard
     end
 
-    if ActiveRecord::VERSION::MAJOR < 5
-
-      def shard(klass = nil)
-        if (@shard || self.class.default_shard) && (klass.nil? || klass.is_sharded?)
-          if @shard == NO_SHARD
-            nil
-          else
-            @shard || self.class.default_shard
-          end
-        end
-      end
-
-      def shard_name(klass = nil, try_slave = 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
-          s = ActiveRecordShards.rails_env.dup
-          s << "_shard_#{the_shard}" if the_shard
-          s << "_slave"              if @on_slave && try_slave
-          s
-        end
-      end
+    def shard
+      raise "Missing shard information on connection" unless @shard
+      @shard
+    end
 
-    else
+    PRIMARY = "primary".freeze
+    def resolve_connection_name(sharded:, configurations:)
+      resolved_shard = sharded ? shard : nil
 
-      def shard
-        if @shard.nil? || @shard == NO_SHARD
-          nil
-        else
-          @shard || self.class.default_shard
-        end
+      if !resolved_shard && !@on_slave
+        return PRIMARY
       end
 
-      PRIMARY = "primary"
-      def resolve_connection_name(sharded:, configurations:)
-        resolved_shard = sharded ? shard : nil
-        env = ActiveRecordShards.rails_env
+      @shard_names ||= {}
+      @shard_names[ActiveRecordShards.rails_env] ||= {}
+      @shard_names[ActiveRecordShards.rails_env][resolved_shard] ||= {}
+      @shard_names[ActiveRecordShards.rails_env][resolved_shard][@on_slave] ||= begin
+        s = ActiveRecordShards.rails_env.dup
+        s << "_shard_#{resolved_shard}" if resolved_shard
 
-        @connection_names ||= {}
-        @connection_names[env] ||= {}
-        @connection_names[env][resolved_shard] ||= {}
-        @connection_names[env][resolved_shard][@on_slave] ||= begin
-          name = env.dup
-          name << "_shard_#{resolved_shard}" if resolved_shard
-          if @on_slave && configurations["#{name}_slave"]
-            "#{name}_slave"
-          else
-            # ActiveRecord always names its default connection pool 'primary'
-            # while everything else is named by the configuration name
-            resolved_shard ? name : PRIMARY
-          end
+        if @on_slave && configurations["#{s}_slave"] # fall back to master connection
+          s << "_slave"
         end
+        s
       end
-
     end
 
     def shard=(new_shard)
-      @shard = (new_shard || NO_SHARD)
+      @shard = Integer(new_shard)
     end
 
     def on_slave?

data/lib/active_record_shards/shard_support.rb

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

data/lib/active_record_shards/sharded_model.rb

@@ -0,0 +1,15 @@
+module ActiveRecordShards
+  module Ext
+    module ShardedModel
+      def is_sharded? # rubocop:disable Naming/PredicateName
+        true
+      end
+    end
+  end
+
+  class ShardedModel < ActiveRecord::Base
+    self.abstract_class = true
+
+    extend ActiveRecordShards::Ext::ShardedModel
+  end
+end

data/lib/active_record_shards/sql_comments.rb

@@ -10,11 +10,7 @@ module ActiveRecordShards
     end
 
     def self.enable
-      ActiveRecord::Base.on_slave do
-        ActiveRecord::Base.on_shard(nil) do
-          ActiveRecord::Base.connection.class.prepend(Methods)
-        end
-      end
+      ActiveRecord::Base.connection.class.prepend(Methods)
     end
   end
 end

data/lib/active_record_shards/tasks.rb

@@ -1,5 +1,4 @@
 # 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|
@@ -9,16 +8,15 @@ 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|
+    ActiveRecord::Base.configurations.each do |key, conf|
       next if !key.starts_with?(ActiveRecordShards.rails_env) || key.ends_with?("_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 => e
-        warn e, *e.backtrace
-        warn "Couldn't drop #{conf['database']}"
+      rescue StandardError => error
+        $stderr.puts error, *error.backtrace
+        $stderr.puts "Couldn't drop #{conf['database']}"
       end
     end
   end
@@ -30,21 +28,20 @@ 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|
+    ActiveRecord::Base.configurations.each do |key, conf|
       next if !key.starts_with?(ActiveRecordShards.rails_env) || key.ends_with?("_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
+        # MysqlAdapter takes charset instead of encoding in Rails 4
+        # https://github.com/rails/rails/commit/78b30fed9336336694fb2cb5d2825f95800b541c
         symbolized_configuration = conf.symbolize_keys
         symbolized_configuration[:charset] = symbolized_configuration[:encoding]
 
         ActiveRecordShards::Tasks.root_connection(conf).create_database(conf['database'], symbolized_configuration)
-      rescue ActiveRecord::StatementInvalid => e
-        if e.message.include?('database exists')
+      rescue ActiveRecord::StatementInvalid => ex
+        if ex.message.include?('database exists')
           puts "#{conf['database']} already exists"
         else
-          raise e
+          raise ex
         end
       end
     end
@@ -55,20 +52,12 @@ namespace :db do
   task abort_if_pending_migrations: :environment do
     if defined? ActiveRecord
       pending_migrations =
-        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
-          ActiveRecord::Base.on_shard(nil) { ActiveRecord::Migrator.open(ActiveRecord::Migrator.migrations_paths).pending_migrations }
-        end
+        ActiveRecord::Base.on_shard(nil) { ActiveRecord::Migrator.open(ActiveRecord::Migrator.migrations_paths).pending_migrations }
 
       if pending_migrations.any?
-        warn "You have #{pending_migrations.size} pending migrations:"
+        puts "You have #{pending_migrations.size} pending migrations:"
         pending_migrations.each do |pending_migration|
-          warn '  %4d %s' % [pending_migration.version, pending_migration.name]
+          puts '  %4d %s' % [pending_migration.version, pending_migration.name]
         end
         abort %(Run "rake db:migrate" to update your database then try again.)
       end
@@ -92,20 +81,12 @@ end
 
 module ActiveRecordShards
   module Tasks
-    class << self
-      def root_connection(conf)
-        conf = conf.merge('database' => nil)
-        spec = spec_for(conf)
-
-        ActiveRecord::Base.send("#{conf['adapter']}_connection", spec.config)
-      end
-
-      private
-
-      def spec_for(conf)
-        resolver = ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver.new(ActiveRecord::Base.configurations)
-        resolver.spec(conf)
-      end
+    def self.root_connection(conf)
+      # this will trigger rails to load the adapter
+      conf = conf.merge('database' => nil)
+      resolver = ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver.new(ActiveRecord::Base.configurations)
+      resolver.spec(conf)
+      ActiveRecord::Base.send("#{conf['adapter']}_connection", conf)
     end
   end
 end

metadata

@@ -1,62 +1,47 @@
 --- !ruby/object:Gem::Specification
 name: active_record_shards
 version: !ruby/object:Gem::Version
-  version: 3.17.0
+  version: 4.0.0.beta1
 platform: ruby
 authors:
-- Benjamin Quorning
-- Gabe Martin-Dempesy
-- Pierre Schambacher
 - Mick Staugaard
 - Eric Chapweske
 - Ben Osheroff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-02 00:00:00.000000000 Z
+date: 2017-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.2'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.2'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.2'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.2'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: bump
+  name: wwtd
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -70,21 +55,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.10.0
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.10.0
+        version: '12.0'
 - !ruby/object:Gem::Dependency
-  name: minitest-rg
+  name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -98,21 +83,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mocha
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.4.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.4.0
-- !ruby/object:Gem::Dependency
-  name: mysql2
+  name: bump
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -126,81 +97,80 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: phenix
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.50.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.50.0
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   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: rubocop
+  name: minitest-rg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.77.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.77.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-minitest
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-performance
+  name: phenix
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.1
+        version: 0.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.1
+        version: 0.2.0
 description: Easily run queries on shard and slave 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: []
@@ -209,20 +179,14 @@ files:
 - lib/active_record_shards.rb
 - lib/active_record_shards/association_collection_connection_selection.rb
 - lib/active_record_shards/configuration_parser.rb
-- 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-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_slave_patches.rb
-- lib/active_record_shards/migration.rb
 - lib/active_record_shards/model.rb
-- lib/active_record_shards/patches-4-2.rb
-- lib/active_record_shards/schema_dumper_extension.rb
 - lib/active_record_shards/shard_selection.rb
 - lib/active_record_shards/shard_support.rb
+- lib/active_record_shards/sharded_model.rb
 - lib/active_record_shards/sql_comments.rb
 - lib/active_record_shards/tasks.rb
 homepage: https://github.com/zendesk/active_record_shards
@@ -235,16 +199,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.1.1
+rubyforge_project: 
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Simple database switching for ActiveRecord.