active_record_shards 4.0.0.beta4 → 4.0.0.beta5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2de0f94bb1444db60049ab7f90c2f984cd3d45ab
-  data.tar.gz: 9bb7fb07f9299ef507306ce8ed589a26b1535df5
+  metadata.gz: 635a833192fb641e710ff4bf7b30380023936a1a
+  data.tar.gz: 8fa608a3b2f2f692b20b8445a4a21d879b88688f
 SHA512:
-  metadata.gz: 3cd39f4712671a92461b1e6840146fd67e01051e7adc0597d8a0065008c4522b99769d06b0e828ca2b36098013403be3aaa0d041ff53100decc133fd38673a6a
-  data.tar.gz: d668ee2c261bfda7b0461696899a2cc3d5a680f141988c633f1b9dff802db68c5d602037fc50cd66829e6eba3b6052aa5e7a0c2de181aa67c497f4860f7697fa
+  metadata.gz: 2ea40014c08f3670c4155e721d05abcab31eb366b6761a02fb1386710288d9f9ca59ea8f2580da0d71d4f502ede737775952f3f0a47140f7527e6a2eabf49716
+  data.tar.gz: 6343baabe62a1a3007a8cacd42eea95873e0a7f5713249e8d65c1b0ba16f6b0850eaf5429b06fa5ba7dc7f4e6641d38342fe3a30a57a4b00bd1f67cc0951ad8e

data/lib/active_record_shards.rb

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
 require 'active_record'
 require 'active_record/base'
+require 'active_record_shards/base_config'
+require 'active_record_shards/connection_resolver'
 require 'active_record_shards/configuration_parser'
 require 'active_record_shards/model'
-require 'active_record_shards/sharded_model'
+require 'active_record_shards/slave_db'
 require 'active_record_shards/shard_selection'
+require 'active_record_shards/no_shard_selection'
 require 'active_record_shards/connection_switcher'
+require 'active_record_shards/sharded_model'
 require 'active_record_shards/association_collection_connection_selection'
 require 'active_record_shards/default_slave_patches'
 
@@ -18,9 +22,10 @@ module ActiveRecordShards
   end
 end
 
+ActiveRecord::Base.extend(ActiveRecordShards::BaseConfig)
 ActiveRecord::Base.extend(ActiveRecordShards::ConfigurationParser)
 ActiveRecord::Base.extend(ActiveRecordShards::Model)
-ActiveRecord::Base.extend(ActiveRecordShards::ConnectionSwitcher)
+ActiveRecord::Base.extend(ActiveRecordShards::SlaveDb)
 ActiveRecord::Base.extend(ActiveRecordShards::DefaultSlavePatches)
 ActiveRecord::Relation.include(ActiveRecordShards::DefaultSlavePatches::ActiveRelationPatches)
 ActiveRecord::Associations::CollectionProxy.include(ActiveRecordShards::AssociationCollectionConnectionSelection)

data/lib/active_record_shards/base_config.rb

@@ -0,0 +1,26 @@
+module ActiveRecordShards
+  module BaseConfig
+    def connection_config
+      { shard: nil, sharded: false }
+    end
+
+    def connection_specification_name
+      name = connection_resolver.resolve_connection_name(connection_config)
+
+      unless configurations[name] || name == "primary"
+        raise ActiveRecord::AdapterNotSpecified, "No database defined by #{name} in your database config. (configurations: #{configurations.inspect})"
+      end
+
+      name
+    end
+
+    def connection_resolver
+      Thread.current[:connection_resolver] ||=
+        ActiveRecordShards::ConnectionResolver.new(configurations)
+    end
+
+    def reset_connection_resolver
+      Thread.current[:connection_resolver] = nil
+    end
+  end
+end

data/lib/active_record_shards/connection_resolver.rb

@@ -0,0 +1,31 @@
+module ActiveRecordShards
+  class ConnectionResolver
+    attr_reader :configurations
+
+    def initialize(configurations)
+      @configurations = configurations
+    end
+
+    PRIMARY = "primary".freeze
+    def resolve_connection_name(slave:, shard:, sharded:)
+      resolved_shard = sharded ? shard : nil
+
+      if !resolved_shard && !slave
+        return PRIMARY
+      end
+
+      @shard_names ||= {}
+      @shard_names[ActiveRecordShards.rails_env] ||= {}
+      @shard_names[ActiveRecordShards.rails_env][resolved_shard] ||= {}
+      @shard_names[ActiveRecordShards.rails_env][resolved_shard][slave] ||= begin
+        s = ActiveRecordShards.rails_env.dup
+        s << "_shard_#{resolved_shard}" if resolved_shard
+
+        if slave && configurations["#{s}_slave"] # fall back to master connection
+          s << "_slave"
+        end
+        s
+      end
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
 module ActiveRecordShards
-  module ConnectionSwitcher
+  module BaseConfig
     private
 
     def ensure_shard_connection

data/lib/active_record_shards/connection_switcher-5-1.rb

@@ -1,5 +1,5 @@
 module ActiveRecordShards
-  module ConnectionSwitcher
+  module BaseConfig
     private
 
     def ensure_shard_connection

data/lib/active_record_shards/connection_switcher.rb

@@ -14,11 +14,11 @@ module ActiveRecordShards
     end
 
     def on_shard(shard)
-      old_options = current_shard_selection.options
-      switch_connection(shard: shard) if supports_sharding?
+      old_selection = current_shard_selection
+      switch_connection(ShardSelection.new(shard)) if supports_sharding?
       yield
     ensure
-      switch_connection(old_options)
+      switch_connection(old_selection)
     end
 
     def on_first_shard
@@ -31,101 +31,33 @@ module ActiveRecordShards
     end
 
     def on_all_shards
-      old_options = current_shard_selection.options
+      old_selection = current_shard_selection
       if supports_sharding?
         shard_names.map do |shard|
-          switch_connection(shard: shard)
+          switch_connection(ShardSelection.new(shard))
           yield(shard)
         end
       else
         [yield]
       end
     ensure
-      switch_connection(old_options)
+      switch_connection(old_selection)
     end
 
-    def on_slave_if(condition, &block)
-      condition ? on_slave(&block) : yield
-    end
-
-    def on_slave_unless(condition, &block)
-      on_slave_if(!condition, &block)
-    end
-
-    def on_master_if(condition, &block)
-      condition ? on_master(&block) : yield
-    end
-
-    def on_master_unless(condition, &block)
-      on_master_if(!condition, &block)
-    end
-
-    def on_master_or_slave(which, &block)
-      if block_given?
-        on_cx_switch_block(which, &block)
-      else
-        MasterSlaveProxy.new(self, which)
-      end
-    end
-
-    # Executes queries using the slave database. Fails over to master if no slave is found.
-    # if you want to execute a block of code on the slave you can go:
-    #   Account.on_slave do
-    #     Account.first
-    #   end
-    # the first account will be found on the slave DB
-    #
-    # For one-liners you can simply do
-    #   Account.on_slave.first
-    def on_slave(&block)
-      on_master_or_slave(:slave, &block)
-    end
-
-    def on_master(&block)
-      on_master_or_slave(:master, &block)
-    end
-
-    def on_cx_switch_block(which, force: false, construct_ro_scope: nil, &block)
-      @disallow_slave ||= 0
-      @disallow_slave += 1 if which == :master
-
-      switch_to_slave = force || @disallow_slave.zero?
-      old_options = current_shard_selection.options
-
-      switch_connection(slave: switch_to_slave)
-
-      # we avoid_readonly_scope to prevent some stack overflow problems, like when
-      # .columns calls .with_scope which calls .columns and onward, endlessly.
-      if self == ActiveRecord::Base || !switch_to_slave || construct_ro_scope == false
-        yield
-      else
-        readonly.scoping(&block)
-      end
-    ensure
-      @disallow_slave -= 1 if which == :master
-      switch_connection(old_options) if old_options
-    end
-
-    def connection_specification_name
-      name = current_shard_selection.resolve_connection_name(sharded: is_sharded?, configurations: configurations)
-
-      unless configurations[name] || name == "primary"
-        raise ActiveRecord::AdapterNotSpecified, "No database defined by #{name} in your database config. (configurations: #{configurations.inspect})"
-      end
-
-      name
+    def connection_config
+      super.merge(current_shard_selection.connection_config.merge(sharded: is_sharded?))
     end
 
     def supports_sharding?
       shard_names.any?
     end
 
-    def on_slave?
-      current_shard_selection.on_slave?
+    def current_shard_selection
+      Thread.current[:shard_selection] ||= NoShardSelection.new
     end
 
-    def current_shard_selection
-      Thread.current[:shard_selection] ||= ShardSelection.new(shard_names.first)
+    def current_shard_selection=(shard_selection)
+      Thread.current[:shard_selection] = shard_selection
     end
 
     def current_shard_id
@@ -145,25 +77,25 @@ module ActiveRecordShards
       config[SHARD_NAMES_CONFIG_KEY]
     end
 
+    def table_exists_with_default_shard?
+      with_default_shard { table_exists_without_default_shard? }
+    end
+
     private
 
-    def switch_connection(options)
-      if options.any?
-        if options.key?(:shard)
-          unless config = configurations[shard_env]
-            raise "Did not find #{shard_env} in configurations, did you forget to add it to your database config? (configurations: #{configurations.inspect})"
-          end
-          unless config['shard_names'].include?(options[:shard])
-            raise "Did not find shard #{options[:shard]} in configurations"
-          end
-          current_shard_selection.shard = options[:shard]
+    def switch_connection(selection)
+      if selection.is_a?(ShardSelection)
+        unless config = configurations[shard_env]
+          raise "Did not find #{shard_env} in configurations, did you forget to add it to your database config? (configurations: #{configurations.inspect})"
         end
-
-        if options.key?(:slave)
-          current_shard_selection.on_slave = options[:slave]
+        unless config['shard_names'].include?(selection.shard)
+          raise "Did not find shard #{selection.shard} in configurations"
         end
+        self.current_shard_selection = selection
 
         ensure_shard_connection
+      else
+        self.current_shard_selection = selection
       end
     end
 
@@ -183,10 +115,6 @@ module ActiveRecordShards
       with_default_shard { load_schema_without_default_shard! }
     end
 
-    def table_exists_with_default_shard?
-      with_default_shard { table_exists_without_default_shard? }
-    end
-
     class MasterSlaveProxy
       def initialize(target, which)
         @target = target

data/lib/active_record_shards/default_slave_patches.rb

@@ -26,13 +26,13 @@ module ActiveRecordShards
     end
 
     def columns_with_force_slave(*args, &block)
-      on_cx_switch_block(:slave, construct_ro_scope: false, force: true) do
+      force_cx_switch_slave_block 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
+      force_cx_switch_slave_block do
         table_exists_without_force_slave?(*args, &block)
       end
     end

data/lib/active_record_shards/model.rb

@@ -38,23 +38,18 @@ module ActiveRecordShards
     end
 
     module InstanceMethods
-      def initialize_shard_and_slave
-        @from_slave = !!self.class.current_shard_selection.options[:slave]
-        @from_shard = self.class.current_shard_selection.options[:shard]
+      def initialize_slave
+        @from_slave = !!self.class.current_slave_selection
       end
 
       def from_slave?
         @from_slave
       end
-
-      def from_shard
-        @from_shard
-      end
     end
 
     def self.extended(base)
       base.send(:include, InstanceMethods)
-      base.after_initialize :initialize_shard_and_slave
+      base.after_initialize :initialize_slave
     end
   end
 end

data/lib/active_record_shards/no_shard_selection.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+module ActiveRecordShards
+  class NoShardSelection
+    class NoShardSelected < RuntimeError; end
+
+    def shard
+      raise NoShardSelected, "Missing shard information on connection"
+    end
+
+    def connection_config
+      raise NoShardSelected, "No shard selected, can't connect"
+    end
+  end
+end

data/lib/active_record_shards/shard_selection.rb

@@ -1,52 +1,14 @@
 # frozen_string_literal: true
 module ActiveRecordShards
   class ShardSelection
-    def initialize(shard)
-      @on_slave = false
-      self.shard = shard
-    end
-
-    def shard
-      raise "Missing shard information on connection" unless @shard
-      @shard
-    end
-
-    PRIMARY = "primary".freeze
-    def resolve_connection_name(sharded:, configurations:)
-      resolved_shard = sharded ? shard : nil
-
-      if !resolved_shard && !@on_slave
-        return PRIMARY
-      end
-
-      @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
+    attr_reader :shard
 
-        if @on_slave && configurations["#{s}_slave"] # fall back to master connection
-          s << "_slave"
-        end
-        s
-      end
-    end
-
-    def shard=(new_shard)
-      @shard = Integer(new_shard)
-    end
-
-    def on_slave?
-      @on_slave
-    end
-
-    def on_slave=(new_slave)
-      @on_slave = (new_slave == true)
+    def initialize(shard)
+      @shard = Integer(shard)
     end
 
-    def options
-      { shard: @shard, slave: @on_slave }
+    def connection_config
+      { shard: shard }
     end
   end
 end

data/lib/active_record_shards/shard_support.rb

@@ -5,7 +5,7 @@ module ActiveRecordShards
       include Enumerable
 
       def each(&block)
-        ActiveRecord::Base.on_all_shards(&block)
+        ActiveRecordShards::ShardedModel.on_all_shards(&block)
       end
     end
 

data/lib/active_record_shards/sharded_model.rb

@@ -1,9 +1,25 @@
 module ActiveRecordShards
   module Ext
     module ShardedModel
+      def self.extended(base)
+        base.extend(ActiveRecordShards::ConnectionSwitcher)
+        base.send(:include, InstanceMethods)
+        base.after_initialize :initialize_shard
+      end
+
       def is_sharded? # rubocop:disable Naming/PredicateName
         true
       end
+
+      module InstanceMethods
+        def initialize_shard
+          @from_shard = self.class.current_shard_selection.shard
+        end
+
+        def from_shard
+          @from_shard
+        end
+      end
     end
   end
 

data/lib/active_record_shards/slave_db.rb

@@ -0,0 +1,105 @@
+module ActiveRecordShards
+  module SlaveDb
+    def on_slave_if(condition, &block)
+      condition ? on_slave(&block) : yield
+    end
+
+    def on_slave_unless(condition, &block)
+      on_slave_if(!condition, &block)
+    end
+
+    def on_master_if(condition, &block)
+      condition ? on_master(&block) : yield
+    end
+
+    def on_master_unless(condition, &block)
+      on_master_if(!condition, &block)
+    end
+
+    def on_master_or_slave(which, &block)
+      if block_given?
+        on_cx_switch_block(which, &block)
+      else
+        MasterSlaveProxy.new(self, which)
+      end
+    end
+
+    def on_slave?
+      current_slave_selection
+    end
+
+    # Executes queries using the slave database. Fails over to master if no slave is found.
+    # if you want to execute a block of code on the slave you can go:
+    #   Account.on_slave do
+    #     Account.first
+    #   end
+    # the first account will be found on the slave DB
+    #
+    # For one-liners you can simply do
+    #   Account.on_slave.first
+    def on_slave(&block)
+      on_master_or_slave(:slave, &block)
+    end
+
+    def on_master(&block)
+      on_master_or_slave(:master, &block)
+    end
+
+    def force_cx_switch_slave_block
+      old_options = current_slave_selection
+      switch_slave_connection(slave: true)
+      yield
+    ensure
+      switch_slave_connection(slave: old_options)
+    end
+
+    def on_cx_switch_block(which, &block)
+      @disallow_slave ||= 0
+      @disallow_slave += 1 if which == :master
+
+      switch_to_slave = @disallow_slave.zero?
+      old_options = current_slave_selection
+
+      switch_slave_connection(slave: switch_to_slave)
+
+      # we avoid_readonly_scope to prevent some stack overflow problems, like when
+      # .columns calls .with_scope which calls .columns and onward, endlessly.
+      if self == ActiveRecord::Base || !switch_to_slave
+        yield
+      else
+        readonly.scoping(&block)
+      end
+    ensure
+      @disallow_slave -= 1 if which == :master
+      switch_slave_connection(slave: old_options)
+    end
+
+    def current_slave_selection=(on_slave)
+      Thread.current[:slave_selection] = on_slave
+    end
+
+    def current_slave_selection
+      Thread.current[:slave_selection] ||= false
+    end
+
+    def connection_config
+      super.merge(slave: current_slave_selection)
+    end
+
+    def switch_slave_connection(options)
+      self.current_slave_selection = options[:slave]
+      ensure_shard_connection
+    end
+
+    class MasterSlaveProxy
+      def initialize(target, which)
+        @target = target
+        @which = which
+      end
+
+      def method_missing(method, *args, &block) # rubocop:disable Style/MethodMissing
+        @target.on_master_or_slave(@which) { @target.send(method, *args, &block) }
+      end
+    end
+  end
+end

data/lib/active_record_shards/sql_comments.rb

@@ -3,7 +3,7 @@ module ActiveRecordShards
   module SqlComments
     module Methods
       def execute(query, name = nil)
-        slave = ActiveRecord::Base.current_shard_selection.on_slave?
+        slave = ActiveRecord::Base.current_slave_selection
         query += " /* #{slave ? 'slave' : 'master'} */"
         super(query, name)
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_record_shards
 version: !ruby/object:Gem::Version
-  version: 4.0.0.beta4
+  version: 4.0.0.beta5
 platform: ruby
 authors:
 - Mick Staugaard
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-31 00:00:00.000000000 Z
+date: 2017-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -178,15 +178,19 @@ files:
 - README.md
 - lib/active_record_shards.rb
 - lib/active_record_shards/association_collection_connection_selection.rb
+- lib/active_record_shards/base_config.rb
 - lib/active_record_shards/configuration_parser.rb
+- lib/active_record_shards/connection_resolver.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/model.rb
+- lib/active_record_shards/no_shard_selection.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/slave_db.rb
 - lib/active_record_shards/sql_comments.rb
 - lib/active_record_shards/tasks.rb
 homepage: https://github.com/zendesk/active_record_shards