active_record_shards 2.8.0 → 3.0.0.beta1

data/lib/active_record_shards/arel_engine.rb

@@ -0,0 +1,13 @@
+if ActiveRecord::VERSION::MAJOR == 3 && ActiveRecord::VERSION::MINOR == 0
+  class ActiveRecord::Base
+    def self.arel_engine
+      @arel_engine ||= begin
+        if self == ActiveRecord::Base
+          Arel::Table.engine
+        else
+          connection_handler.connection_pools[connection_pool_name] ? self : superclass.arel_engine
+        end
+      end
+    end
+  end
+end

data/lib/active_record_shards/connection_handler.rb

@@ -0,0 +1,11 @@
+ActiveRecord::ConnectionAdapters::ConnectionHandler.class_eval do
+  if ActiveRecord::VERSION::MAJOR >= 4
+    def retrieve_connection_pool(klass)
+      class_to_pool[klass.connection_pool_name] ||= pool_for(klass)
+    end
+  else
+    def retrieve_connection_pool(klass)
+      (@class_to_pool || @connection_pools)[klass.connection_pool_name]
+    end
+  end
+end

data/lib/active_record_shards/connection_pool.rb

@@ -1,55 +1,32 @@
-ActiveRecord::ConnectionAdapters::ConnectionHandler.class_eval do
-  # The only difference here is that we use klass.connection_pool_name
-  # instead of klass.name as the pool key
-  def retrieve_connection_pool(klass)
-    pool = (@class_to_pool || @connection_pools)[klass.connection_pool_name]
-    return pool if pool
-    return nil if ActiveRecord::Base == klass
-    retrieve_connection_pool klass.superclass
-  end
-
-  def remove_connection(klass)
-    # rails 2: @connection_pools is a hash of klass.name => pool
-    # rails 3: @connection_pools is a hash of pool.spec => pool
-    #          @class_to_pool is a hash of klass.name => pool
-    #
-    if @class_to_pool
-      pool = @class_to_pool.delete(klass.connection_pool_name)
-      @connection_pools.delete(pool.spec) if pool
-    else
-      pool = @connection_pools.delete(klass.connection_pool_name)
-      @connection_pools.delete_if { |key, value| value == pool }
-    end
-
-    return nil unless pool
-
-    pool.disconnect! if pool
-    pool.spec.config if pool
-  end
-end
-
-ActiveRecord::Base.singleton_class.class_eval do
-  def establish_connection_with_connection_pool_name(spec = nil)
-    case spec
-    when ActiveRecord::Base::ConnectionSpecification
-      connection_handler.establish_connection(connection_pool_name, spec)
-    else
-      establish_connection_without_connection_pool_name(spec)
-    end
-  end
-  alias_method_chain :establish_connection, :connection_pool_name
-end
+module ActiveRecordShards
+  ConnectionPoolNameDecorator = Struct.new(:name)
 
-# old_code.sub('name', 'connection_pool_name')
-if ActiveRecord::VERSION::MAJOR == 3 && ActiveRecord::VERSION::MINOR == 0
-  class ActiveRecord::Base
-    def self.arel_engine
-      @arel_engine ||= begin
-        if self == ActiveRecord::Base
-          Arel::Table.engine
-        else
-          connection_handler.connection_pools[connection_pool_name] ? self : superclass.arel_engine
+  # It overrides given connection handler methods (they differ depend on
+  # Rails version).
+  #
+  # It takes the first argument, ActiveRecord::Base object or
+  # String (connection_pool_name), converts it in Struct object and
+  # passes to the original method.
+  #
+  # Example:
+  #   methods_to_override = [:establish_connection, :remove_connection]
+  #   ActiveRecordShards.override_connection_handler_methods(methods_to_override)
+  #
+  def self.override_connection_handler_methods(method_names)
+    method_names.each do |method_name|
+      ActiveRecord::ConnectionAdapters::ConnectionHandler.class_eval do
+        define_method("#{method_name}_with_connection_pool_name") do |*args|
+          unless args[0].is_a? ConnectionPoolNameDecorator
+            name = if args[0].is_a? String
+                     args[0]
+                   else
+                     args[0].connection_pool_name
+                   end
+            args[0] = ConnectionPoolNameDecorator.new(name)
+          end
+          send("#{method_name}_without_connection_pool_name", *args)
         end
+        alias_method_chain method_name, :connection_pool_name
       end
     end
   end

data/lib/active_record_shards/connection_specification.rb

@@ -1,7 +1,6 @@
 class ActiveRecord::Base
-
   def self.establish_connection(spec = ENV["DATABASE_URL"])
-    resolver = ConnectionSpecification::Resolver.new spec, configurations
+    resolver = ActiveRecordShards::ConnectionSpecification::Resolver.new spec, configurations
     spec = resolver.spec
 
     unless respond_to?(spec.adapter_method)
@@ -10,6 +9,11 @@ class ActiveRecord::Base
 
     remove_connection
     specification_cache[connection_pool_name] = spec
-    connection_handler.establish_connection connection_pool_name, spec
+
+    if ActiveRecord::VERSION::STRING >= "4.0.0"
+      connection_handler.establish_connection self, spec
+    else
+      connection_handler.establish_connection connection_pool_name, spec
+    end
   end
 end

data/lib/active_record_shards/connection_switcher.rb

@@ -95,7 +95,11 @@ module ActiveRecordShards
       if self == ActiveRecord::Base || !switch_to_slave || options[:construct_ro_scope] == false
         yield
       else
-        with_scope({:find => {:readonly => true}}, &block)
+        if ActiveRecord::VERSION::MAJOR == 2
+          with_scope({:find => {:readonly => true}}, &block)
+        else
+          readonly.scoping(&block)
+        end
       end
     ensure
       @disallow_slave -= 1 if which == :master
@@ -174,11 +178,11 @@ module ActiveRecordShards
       # connection adapter ourselves.
       specification_cache[name] ||= begin
         if ActiveRecord::VERSION::STRING >= "3.2.0"
-          resolver = ActiveRecord::Base::ConnectionSpecification::Resolver.new spec, configurations
+          resolver = ActiveRecordShards::ConnectionSpecification::Resolver.new spec, configurations
           resolver.spec
         else
           autoload_adapter(spec['adapter'])
-          ActiveRecord::Base::ConnectionSpecification.new(spec, "#{spec['adapter']}_connection")
+          ActiveRecordShards::ConnectionSpecification.new(spec, "#{spec['adapter']}_connection")
         end
       end
 
@@ -198,7 +202,13 @@ module ActiveRecordShards
     end
 
     def connected_to_shard?
-      connection_handler.connection_pools.has_key?(connection_pool_key)
+      if ActiveRecord::VERSION::MAJOR == 4
+        specs_to_pools = Hash[connection_handler.connection_pool_list.map { |pool| [pool.spec, pool] }]
+      else
+        specs_to_pools = connection_handler.connection_pools
+      end
+
+      specs_to_pools.has_key?(connection_pool_key)
     end
 
     def columns_with_default_shard

data/lib/active_record_shards/default_slave_patches.rb

@@ -1,32 +1,23 @@
 module ActiveRecordShards
   module DefaultSlavePatches
-    def self.wrap_method_in_on_slave(class_method, base, method)
+    CLASS_SLAVE_METHODS = [ :find_by_sql, :count_by_sql,  :calculate, :find_one, :find_some, :find_every, :quote_value, :sanitize_sql_hash_for_conditions, :exists? ]
 
-      if class_method
-        base_methods = (base.methods | base.private_methods).map(&:to_sym)
-      else
-        base_methods = (base.instance_methods | base.private_instance_methods).map(&:to_sym)
-      end
-
-      return unless base_methods.include?(method)
-      _, method, punctuation = method.to_s.match(/^(.*?)([\?\!]?)$/).to_a
-      base.class_eval <<-RUBY, __FILE__, __LINE__ + 1
-        #{class_method ? "class << self" : ""}
-          def #{method}_with_default_slave#{punctuation}(*args, &block)
-            on_slave_unless_tx do
-              #{method}_without_default_slave#{punctuation}(*args, &block)
+    def self.extended(base)
+      base_methods = (base.methods | base.private_methods).map(&:to_sym)
+      (CLASS_SLAVE_METHODS & base_methods).each do |slave_method|
+        _, slave_method, punctuation = slave_method.to_s.match(/^(.*?)([\?\!]?)$/).to_a
+        base.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          class << self
+            def #{slave_method}_with_default_slave#{punctuation}(*args, &block)
+              on_slave_unless_tx do
+                #{slave_method}_without_default_slave#{punctuation}(*args, &block)
+              end
             end
-          end
-
-          alias_method_chain :#{method}#{punctuation}, :default_slave
-        #{class_method ? "end" : ""}
-      RUBY
-    end
 
-    CLASS_SLAVE_METHODS = [ :find_by_sql, :count_by_sql,  :calculate, :find_one, :find_some, :find_every, :quote_value, :sanitize_sql_hash_for_conditions, :exists?, :table_exists? ]
-
-    def self.extended(base)
-      CLASS_SLAVE_METHODS.each { |m| ActiveRecordShards::DefaultSlavePatches.wrap_method_in_on_slave(true, base, m) }
+            alias_method_chain :#{slave_method}#{punctuation}, :default_slave
+          end
+        RUBY
+      end
 
       base.class_eval do
         # fix ActiveRecord to do the right thing, and use our aliased quote_value
@@ -67,10 +58,33 @@ module ActiveRecordShards
           end
 
           alias_method_chain :transaction, :slave_off
+
+
+          def table_exists_with_default_slave?(*args)
+            on_slave_unless_tx(*args) { table_exists_without_default_slave?(*args) }
+          end
+
+          alias_method_chain :table_exists?, :default_slave
         end
       end
-      ActiveRecordShards::DefaultSlavePatches.wrap_method_in_on_slave(false, ActiveRecord::Associations::HasAndBelongsToManyAssociation, :construct_sql)
-      ActiveRecordShards::DefaultSlavePatches.wrap_method_in_on_slave(false, ActiveRecord::Associations::HasAndBelongsToManyAssociation, :construct_find_options!)
+
+
+      ActiveRecord::Associations::HasAndBelongsToManyAssociation.class_eval do
+        def construct_sql_with_default_slave(*args, &block)
+          on_slave_unless_tx do
+            construct_sql_without_default_slave(*args, &block)
+          end
+        end
+
+        def construct_find_options_with_default_slave!(*args, &block)
+          on_slave_unless_tx do
+            construct_find_options_without_default_slave!(*args, &block)
+          end
+        end
+
+        alias_method_chain :construct_sql,           :default_slave if respond_to?(:construct_sql)
+        alias_method_chain :construct_find_options!, :default_slave if respond_to?(:construct_find_options!)
+      end
     end
 
     def on_slave_unless_tx(&block)
@@ -83,23 +97,20 @@ module ActiveRecordShards
 
     module ActiveRelationPatches
       def self.included(base)
-        ActiveRecordShards::DefaultSlavePatches.wrap_method_in_on_slave(false, base, :calculate)
-        ActiveRecordShards::DefaultSlavePatches.wrap_method_in_on_slave(false, base, :exists?)
-        ActiveRecordShards::DefaultSlavePatches.wrap_method_in_on_slave(false, base, :pluck)
+        base.send :alias_method_chain, :calculate, :default_slave
+        base.send :alias_method_chain, :exists?, :default_slave
       end
 
       def on_slave_unless_tx
         @klass.on_slave_unless_tx { yield }
       end
-    end
 
-    module HasAndBelongsToManyPreloaderPatches
-      def self.included(base)
-        ActiveRecordShards::DefaultSlavePatches.wrap_method_in_on_slave(false, base, :records_for) rescue nil
+      def calculate_with_default_slave(*args, &block)
+        on_slave_unless_tx { calculate_without_default_slave(*args, &block) }
       end
 
-      def on_slave_unless_tx
-        klass.on_slave_unless_tx { yield }
+      def exists_with_default_slave?(*args, &block)
+        on_slave_unless_tx { exists_without_default_slave?(*args, &block) }
       end
     end
   end

data/lib/active_record_shards.rb

@@ -8,11 +8,24 @@ require 'active_record_shards/association_collection_connection_selection'
 require 'active_record_shards/connection_pool'
 require 'active_record_shards/migration'
 require 'active_record_shards/default_slave_patches'
+require 'active_record_shards/arel_engine'
+require 'active_record_shards/connection_handler'
 
 if ActiveRecord::VERSION::STRING >= "3.2.0"
   require 'active_record_shards/connection_specification'
 end
 
+if ActiveRecord::VERSION::STRING >= "4.0.0"
+  methods_to_override = [:establish_connection, :remove_connection, :pool_for,
+                         :pool_from_any_process_for]
+  ActiveRecordShards::ConnectionSpecification = ActiveRecord::ConnectionAdapters::ConnectionSpecification
+else
+  methods_to_override = [:remove_connection]
+  ActiveRecordShards::ConnectionSpecification = ActiveRecord::Base::ConnectionSpecification
+end
+
+ActiveRecordShards.override_connection_handler_methods(methods_to_override)
+
 ActiveRecord::Base.extend(ActiveRecordShards::ConfigurationParser)
 ActiveRecord::Base.extend(ActiveRecordShards::Model)
 ActiveRecord::Base.extend(ActiveRecordShards::ConnectionSwitcher)
@@ -22,10 +35,6 @@ if ActiveRecord.const_defined?(:Relation)
   ActiveRecord::Relation.send(:include, ActiveRecordShards::DefaultSlavePatches::ActiveRelationPatches)
 end
 
-if ActiveRecord::Associations.const_defined?(:Preloader)
-  ActiveRecord::Associations::Preloader::HasAndBelongsToMany.send(:include, ActiveRecordShards::DefaultSlavePatches::HasAndBelongsToManyPreloaderPatches)
-end
-
 if ActiveRecord::VERSION::STRING >= "3.1.0"
   ActiveRecord::Associations::CollectionProxy.send(:include, ActiveRecordShards::AssociationCollectionConnectionSelection)
 else
@@ -39,3 +48,15 @@ module ActiveRecordShards
     env ||= ENV['RAILS_ENV']
   end
 end
+
+ActiveRecord::Base.singleton_class.class_eval do
+  def establish_connection_with_connection_pool_name(spec = nil)
+    case spec
+    when ActiveRecordShards::ConnectionSpecification
+      connection_handler.establish_connection(connection_pool_name, spec)
+    else
+      establish_connection_without_connection_pool_name(spec)
+    end
+  end
+  alias_method_chain :establish_connection, :connection_pool_name
+end

data/test/connection_switching_test.rb

@@ -233,7 +233,6 @@ describe "connection switching" do
       end
 
       it "execute the block on all shard masters" do
-        @database_names
         assert_equal([ActiveRecord::Base.connection.select_value("SELECT DATABASE()")], @database_names)
       end
     end
@@ -244,7 +243,11 @@ describe "connection switching" do
 
       before do
         ActiveRecord::Base.configurations.delete('test_slave')
-        ActiveRecord::Base.connection_handler.connection_pools.clear
+        if ActiveRecord::VERSION::MAJOR == 4
+          ActiveRecord::Base.connection_handler.connection_pool_list.clear
+        else
+          ActiveRecord::Base.connection_handler.connection_pools.clear
+        end
         ActiveRecord::Base.establish_connection('test')
       end
 
@@ -380,19 +383,13 @@ describe "connection switching" do
         end
       end
 
+      # TODO: make all this stuff rails 3 compatible.
       describe "with finds routed to the slave by default" do
         before do
           Account.on_slave_by_default = true
-          Person.on_slave_by_default = true
           Account.connection.execute("INSERT INTO accounts (id, name, created_at, updated_at) VALUES(1000, 'master_name', '2009-12-04 20:18:48', '2009-12-04 20:18:48')")
           Account.on_slave.connection.execute("INSERT INTO accounts (id, name, created_at, updated_at) VALUES(1000, 'slave_name', '2009-12-04 20:18:48', '2009-12-04 20:18:48')")
           Account.on_slave.connection.execute("INSERT INTO accounts (id, name, created_at, updated_at) VALUES(1001, 'slave_name2', '2009-12-04 20:18:48', '2009-12-04 20:18:48')")
-
-          Person.connection.execute("REPLACE INTO people(id, name) VALUES(10, 'master person')")
-          Person.on_slave.connection.execute("REPLACE INTO people(id, name) VALUES(20, 'slave person')")
-
-          Account.connection.execute("INSERT INTO account_people(account_id, person_id) VALUES(1000, 10)")
-          Account.on_slave.connection.execute("INSERT INTO account_people(account_id, person_id) VALUES(1001, 20)")
         end
 
         it "find() by default on the slave" do
@@ -451,21 +448,8 @@ describe "connection switching" do
           assert AccountInherited.on_slave_by_default?
         end
 
-        it "will :include things via has_and_belongs associations correctly" do
-          a = Account.first(:conditions => "id = 1001", :include => :people)
-          assert a.people.size > 0
-          assert_equal 'slave person', a.people.first.name
-        end
-
-        if ActiveRecord::VERSION::MAJOR >= 3 && ActiveRecord::VERSION::MINOR >= 2
-          it "supports .pluck" do
-            assert_equal ["slave_name", "slave_name2"], Account.pluck(:name)
-          end
-        end
-
         after do
           Account.on_slave_by_default = false
-          Person.on_slave_by_default = false
         end
       end
     end
@@ -518,4 +502,14 @@ describe "connection switching" do
       assert_using_database('ars_test_alternative', Email)
     end
   end
+
+  it "raises an exception if a connection is not found" do
+    ActiveRecord::Base.on_shard(0) do
+      ActiveRecord::Base.connection_handler.remove_connection(Ticket)
+      assert_raises(ActiveRecord::ConnectionNotEstablished) do
+        ActiveRecord::Base.connection_handler.retrieve_connection_pool(Ticket)
+        assert_using_database('ars_test_shard0', Ticket)
+      end
+    end
+  end
 end

data/test/models.rb

@@ -4,7 +4,6 @@ class Account < ActiveRecord::Base
 
   has_many :tickets
   has_many :account_things
-  has_and_belongs_to_many :people, :join_table => 'account_people'
 end
 
 class AccountThing < ActiveRecord::Base
@@ -37,4 +36,3 @@ end
 class User < Person
 end
 
-

data/test/schema.rb

@@ -12,11 +12,6 @@ ActiveRecord::Schema.define(:version => 1) do
     t.boolean "enabled", :default => true
   end
 
-  create_table "account_people", :force => true, :id => false do |t|
-    t.integer "account_id"
-    t.integer "person_id"
-  end
-
   create_table "emails", :force => true do |t|
     t.string   "from"
     t.string   "to"

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: active_record_shards
 version: !ruby/object:Gem::Version
-  version: 2.8.0
-  prerelease: 
+  version: 3.0.0.beta1
+  prerelease: 6
 platform: ruby
 authors:
 - Mick Staugaard
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-22 00:00:00.000000000 Z
+date: 2013-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -21,9 +21,9 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.3.5
-    - - <
+    - - <=
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -32,9 +32,9 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.3.5
-    - - <
+    - - <=
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '4.1'
 description: Easily run queries on shard and slave databases.
 email:
 - mick@staugaard.com
@@ -44,8 +44,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/active_record_shards/arel_engine.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.rb
@@ -81,18 +83,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -479183148352030802
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: -479183148352030802
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -112,3 +108,4 @@ test_files:
 - test/migrator_test.rb
 - test/models.rb
 - test/schema.rb
+has_rdoc: