db-charmer 1.7.0 → 1.7.1

data/CHANGES

@@ -1,3 +1,11 @@
+1.7.1 (2012-04-22):
+
+Beta feature: Rails 3.1 and 3.2 support
+
+Thanks to the community (and Eugene Pimenov aka @libc in particular) we now have support
+for Rails versions up to 3.2.1, including new migrations classes.
+
+----------------------------------------------------------------------------------------
 1.7.0 (2011-08-29):
 
 Beta feature: Rails 3 support

data/README.rdoc

@@ -1,6 +1,6 @@
 = DB Charmer - ActiveRecord Connection Magic Plugin
 
-+DbCharmer+ is a simple yet powerful plugin for ActiveRecord that significantly extends its ability to work with 
++DbCharmer+ is a simple yet powerful plugin for ActiveRecord that significantly extends its ability to work with
 multiple databases and/or database servers. The major features we add to ActiveRecord are:
 
 1. Simple management for AR model connections (+switch_connection_to+ method)
@@ -292,7 +292,7 @@ send their reads to slaves. Example:
 
 3) <tt>force_slave_reads!</tt> +ActionController+ instance method, that could be used within
 your actions or in controller filters to temporarily switch your models to forced slave reads
-mode. This method could be useful for cases when the same actions could be called by logged-in 
+mode. This method could be useful for cases when the same actions could be called by logged-in
 and anonymous users. Then you could authorize users in <tt>before_filter</tt> and call
 <tt>force_slave_reads!</tt> method for anonymous page views.
 
@@ -419,7 +419,7 @@ tables with hundreds of millions to billions of rows and allows relatively easy
 to be implemented on top.
 
 4) +db_block_group_map+ - really similar to the +db_block_map+ method with a single difference: this method
-allows you to have a set of databases (table groups) on each server and every group would be handled as a 
+allows you to have a set of databases (table groups) on each server and every group would be handled as a
 separate shard of data. This approach is really useful for pre-sharding of your data before scaling your
 application out. You can easily start with one server, having 10-20-50 separate databases, and then
 move those databases to different servers as you see your database outgrow one machine.

data/db-charmer.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
 
   s.authors       = [ 'Oleksiy Kovyrin' ]
   s.email         = 'alexey@kovyrin.net'
-  s.homepage      = 'http://github.com/kovyrin/db-charmer'
+  s.homepage      = 'http://kovyrin.github.com/db-charmer'
   s.summary       = 'ActiveRecord Connections Magic (slaves, multiple connections, etc)'
   s.description   = 'DbCharmer is a Rails plugin (and gem) that could be used to manage AR model connections, implement master/slave query schemes, sharding and other magic features many high-scale applications need.'
 
@@ -20,8 +20,8 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files = [ 'LICENSE', 'README.rdoc' ]
 
   # Dependencies
-  s.add_dependency 'activesupport', '< 3.1'
-  s.add_dependency 'activerecord', '< 3.1'
+  s.add_dependency 'activesupport', '<= 3.2.3'
+  s.add_dependency 'activerecord', '<= 3.2.3'
 
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'yard'

data/lib/db_charmer.rb

@@ -14,6 +14,11 @@ module DbCharmer
     ::ActiveRecord::VERSION::MAJOR > 2
   end
 
+  # Used in all Rails3.1-specific places
+  def self.rails31?
+    rails3? && ::ActiveRecord::VERSION::MINOR >= 1
+  end
+
   # Used in all Rails2-specific places
   def self.rails2?
     ::ActiveRecord::VERSION::MAJOR == 2
@@ -134,32 +139,49 @@ end
 
 # Enable connection proxy for associations
 # WARNING: Inject methods to association class right here (they proxy include calls somewhere else, so include does not work)
-module ActiveRecord
-  module Associations
-    class AssociationProxy
-      def proxy?
-        true
-      end
+association_proxy_class = DbCharmer.rails31? ? ActiveRecord::Associations::CollectionProxy : ActiveRecord::Associations::AssociationProxy
+association_proxy_class.class_eval do
+  def proxy?
+    true
+  end
 
-      def on_db(con, proxy_target = nil, &block)
-        proxy_target ||= self
-        @reflection.klass.on_db(con, proxy_target, &block)
-      end
+  if DbCharmer.rails31?
+    def on_db(con, proxy_target = nil, &block)
+      proxy_target ||= self
+      @association.klass.on_db(con, proxy_target, &block)
+    end
 
-      def on_slave(con = nil, &block)
-        @reflection.klass.on_slave(con, self, &block)
-      end
+    def on_slave(con = nil, &block)
+      @association.klass.on_slave(con, self, &block)
+    end
 
-      def on_master(&block)
-        @reflection.klass.on_master(self, &block)
-      end
+    def on_master(&block)
+      @association.klass.on_master(self, &block)
+    end
+  else
+    def on_db(con, proxy_target = nil, &block)
+      proxy_target ||= self
+      @reflection.klass.on_db(con, proxy_target, &block)
+    end
+
+    def on_slave(con = nil, &block)
+      @reflection.klass.on_slave(con, self, &block)
+    end
+
+    def on_master(&block)
+      @reflection.klass.on_master(self, &block)
     end
   end
 end
 
 # Enable multi-db migrations
 require 'db_charmer/active_record/migration/multi_db_migrations'
-ActiveRecord::Migration.extend(DbCharmer::ActiveRecord::Migration::MultiDbMigrations)
+ActiveRecord::Migration.send(:include, DbCharmer::ActiveRecord::Migration::MultiDbMigrations)
+
+if DbCharmer.rails31?
+  require 'db_charmer/rails31/active_record/migration/command_recorder'
+  ActiveRecord::Migration::CommandRecorder.send(:include, DbCharmer::ActiveRecord::Migration::CommandRecorder)
+end
 
 # Enable the magic
 if DbCharmer.rails3?
@@ -173,11 +195,19 @@ require 'db_charmer/active_record/db_magic'
 ActiveRecord::Base.extend(DbCharmer::ActiveRecord::DbMagic)
 
 # Setup association preload magic
-require 'db_charmer/active_record/association_preload'
-ActiveRecord::Base.extend(DbCharmer::ActiveRecord::AssociationPreload)
+if DbCharmer.rails31?
+  require 'db_charmer/rails31/active_record/preloader/association'
+  ActiveRecord::Associations::Preloader::Association.send(:include, DbCharmer::ActiveRecord::Preloader::Association)
+  require 'db_charmer/rails31/active_record/preloader/has_and_belongs_to_many'
+  ActiveRecord::Associations::Preloader::HasAndBelongsToMany.send(:include, DbCharmer::ActiveRecord::Preloader::HasAndBelongsToMany)
+else
+  require 'db_charmer/active_record/association_preload'
+  ActiveRecord::Base.extend(DbCharmer::ActiveRecord::AssociationPreload)
+
+  # Open up really useful API method
+  ActiveRecord::AssociationPreload::ClassMethods.send(:public, :preload_associations)
+end
 
-# Open up really useful API method
-ActiveRecord::AssociationPreload::ClassMethods.send(:public, :preload_associations)
 
 class ::ActiveRecord::Base
   class << self

data/lib/db_charmer/action_controller/force_slave_reads.rb

@@ -55,7 +55,7 @@ module DbCharmer
 
       protected
 
-        class_eval <<-EOF
+        class_eval <<-EOF, __FILE__, __LINE__+1
           def #{DISPATCH_METHOD}_with_forced_slave_reads(*args, &block)
             DbCharmer.with_controller(self) do
               #{DISPATCH_METHOD}_without_forced_slave_reads(*args, &block)

data/lib/db_charmer/active_record/association_preload.rb

@@ -7,7 +7,8 @@ module DbCharmer
         ASSOCIATION_TYPES.each do |association_type|
           base.class_eval <<-EOF, __FILE__, __LINE__ + 1
             def self.preload_#{association_type}_association(records, reflection, preload_options = {})
-              if self.db_charmer_top_level_connection? || self.db_charmer_default_connection != reflection.klass.db_charmer_default_connection
+              if self.db_charmer_top_level_connection? || reflection.options[:polymorphic] ||
+                    self.db_charmer_default_connection != reflection.klass.db_charmer_default_connection
                 return super(records, reflection, preload_options)
               end
               reflection.klass.on_db(self) do

data/lib/db_charmer/active_record/connection_switching.rb

@@ -34,6 +34,16 @@ module DbCharmer
             db_charmer_remapped_connection || db_charmer_connection_proxy || connection_without_magic
           end
           alias_method_chain :connection, :magic
+
+          def connection_pool_with_magic
+            abstract_connection_class = connection.abstract_connection_class rescue nil # respond_to? doesn't work on connection_proxy...
+            if abstract_connection_class
+              connection_handler.retrieve_connection_pool(abstract_connection_class) || connection_pool_without_magic
+            else
+              connection_pool_without_magic
+            end
+          end
+          alias_method_chain :connection_pool, :magic
         end
       end
 

data/lib/db_charmer/active_record/db_magic.rb

@@ -38,9 +38,15 @@ module DbCharmer
       def setup_children_magic(opt)
         self.db_charmer_opts = opt.clone
 
-        def self.inherited(child)
-          child.db_magic(self.db_charmer_opts)
-          super
+        unless self.respond_to?(:inherited_with_db_magic)
+          class << self
+            def inherited_with_db_magic(child)
+              o = inherited_without_db_magic(child)
+              child.db_magic(self.db_charmer_opts)
+              o
+            end
+            alias_method_chain :inherited, :db_magic
+          end
         end
       end
 
@@ -82,4 +88,3 @@ module DbCharmer
     end
   end
 end
-

data/lib/db_charmer/active_record/migration/multi_db_migrations.rb

@@ -3,23 +3,84 @@ module DbCharmer
     module Migration
       module MultiDbMigrations
 
-        def self.extended(base)
-          class << base
-            alias_method_chain :migrate, :db_wrapper
+        def self.append_features(base)
+          return false if base < self
+          super
+          base.extend const_get("ClassMethods") if const_defined?("ClassMethods")
+
+          base.class_eval do
+            if DbCharmer.rails31?
+              alias_method_chain :migrate, :db_wrapper
+            else
+              class << self
+                alias_method_chain :migrate, :db_wrapper
+              end
+            end
           end
         end
 
-        @@multi_db_names = {}
-        def multi_db_names
-          @@multi_db_names[self.name] || @@multi_db_names['ActiveRecord::Migration']
-        end
+        module ClassMethods
+          @@multi_db_names = {}
+          def multi_db_names
+            @@multi_db_names[self.name] || @@multi_db_names['ActiveRecord::Migration']
+          end
+
+          def multi_db_names=(names)
+            @@multi_db_names[self.name] = names
+          end
+
+          unless DbCharmer.rails31?
+            def migrate_with_db_wrapper(direction)
+              if names = multi_db_names
+                names.each do |multi_db_name|
+                  on_db(multi_db_name) do
+                    migrate_without_db_wrapper(direction)
+                  end
+                end
+              else
+                migrate_without_db_wrapper(direction)
+              end
+            end
+
+            def on_db(db_name)
+              name = db_name.is_a?(Hash) ? db_name[:connection_name] : db_name.inspect
+              announce "Switching connection to #{name}"
+              # Switch connection
+              old_proxy = ::ActiveRecord::Base.db_charmer_connection_proxy
+              db_name = nil if db_name == :default
+              ::ActiveRecord::Base.switch_connection_to(db_name, DbCharmer.connections_should_exist?)
+              # Yield the block
+              yield
+            ensure
+              # Switch it back
+              ::ActiveRecord::Base.verify_active_connections!
+              announce "Switching connection back"
+              ::ActiveRecord::Base.switch_connection_to(old_proxy)
+            end
+          end
+
+          def db_magic(opts = {})
+            # Collect connections from all possible options
+            conns = [ opts[:connection], opts[:connections] ]
+            conns << shard_connections(opts[:sharded_connection]) if opts[:sharded_connection]
+
+            # Get a unique set of connections
+            conns = conns.flatten.compact.uniq
+            raise ArgumentError, "No connection name - no magic!" unless conns.any?
+
+            # Save connections
+            self.multi_db_names = conns
+          end
 
-        def multi_db_names=(names)
-          @@multi_db_names[self.name] = names
+          # Return a list of connections to shards in a sharded connection
+          def shard_connections(conn_name)
+            conn = DbCharmer::Sharding.sharded_connection(conn_name)
+            conn.shard_connections
+          end
         end
 
         def migrate_with_db_wrapper(direction)
-          if names = multi_db_names
+          if names = self.class.multi_db_names
             names.each do |multi_db_name|
               on_db(multi_db_name) do
                 migrate_without_db_wrapper(direction)
@@ -30,41 +91,46 @@ module DbCharmer
           end
         end
 
-        def on_db(db_name)
+        def record_on_db(db_name, block)
+          recorder = ::ActiveRecord::Migration::CommandRecorder.new(DbCharmer::ConnectionFactory.connect(db_name))
+          old_recorder, @connection = @connection, recorder
+          block.call
+          old_recorder.record :on_db, [db_name, @connection]
+          @connection = old_recorder
+        end
+
+        def replay_commands_on_db(name, commands)
+          on_db(name) do
+            commands.each do |cmd, args|
+              send(cmd, *args)
+            end
+          end
+        end
+
+        def on_db(db_name, &block)
+          if @connection.is_a?(::ActiveRecord::Migration::CommandRecorder)
+            record_on_db(db_name, block)
+            return
+          end
+
           name = db_name.is_a?(Hash) ? db_name[:connection_name] : db_name.inspect
           announce "Switching connection to #{name}"
           # Switch connection
-          old_proxy = ::ActiveRecord::Base.db_charmer_connection_proxy
+          old_connection, old_proxy = @connection, ::ActiveRecord::Base.db_charmer_connection_proxy
           db_name = nil if db_name == :default
           ::ActiveRecord::Base.switch_connection_to(db_name, DbCharmer.connections_should_exist?)
           # Yield the block
-          yield
+          ::ActiveRecord::Base.connection_pool.with_connection do |conn|
+            @connection = conn
+            yield
+          end
         ensure
+          @connection = old_connection
           # Switch it back
           ::ActiveRecord::Base.verify_active_connections!
           announce "Switching connection back"
           ::ActiveRecord::Base.switch_connection_to(old_proxy)
         end
-
-        def db_magic(opts = {})
-          # Collect connections from all possible options
-          conns = [ opts[:connection], opts[:connections] ]
-          conns << shard_connections(opts[:sharded_connection]) if opts[:sharded_connection]
-
-          # Get a unique set of connections
-          conns = conns.flatten.compact.uniq
-          raise ArgumentError, "No connection name - no magic!" unless conns.any?
-
-          # Save connections
-          self.multi_db_names = conns
-        end
-
-        # Return a list of connections to shards in a sharded connection
-        def shard_connections(conn_name)
-          conn = DbCharmer::Sharding.sharded_connection(conn_name)
-          conn.shard_connections
-        end
-
       end
     end
   end

data/lib/db_charmer/rails31/active_record/migration/command_recorder.rb

@@ -0,0 +1,11 @@
+module DbCharmer
+  module ActiveRecord
+    module Migration
+      module CommandRecorder
+        def invert_on_db(args)
+          [:replay_commands_on_db, [args.first, args[1].inverse]]
+        end
+      end
+    end
+  end
+end

data/lib/db_charmer/rails31/active_record/preloader/association.rb

@@ -0,0 +1,21 @@
+module DbCharmer
+  module ActiveRecord
+    module Preloader
+      module Association
+        extend ActiveSupport::Concern
+        included do
+          alias_method_chain :build_scope, :db_magic
+        end
+
+        def build_scope_with_db_magic
+          if model.db_charmer_top_level_connection? || reflection.options[:polymorphic] ||
+              model.db_charmer_default_connection != klass.db_charmer_default_connection
+            build_scope_without_db_magic
+          else
+            build_scope_without_db_magic.on_db(model)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/db_charmer/rails31/active_record/preloader/has_and_belongs_to_many.rb

@@ -0,0 +1,23 @@
+module DbCharmer
+  module ActiveRecord
+    module Preloader
+      module HasAndBelongsToMany
+        extend ActiveSupport::Concern
+        included do
+          alias_method_chain :records_for, :db_magic
+        end
+
+        def records_for_with_db_magic(ids)
+          if model.db_charmer_top_level_connection? || reflection.options[:polymorphic] ||
+              model.db_charmer_default_connection != klass.db_charmer_default_connection
+            records_for_without_db_magic(ids)
+          else
+            klass.on_db(model) do
+              records_for_without_db_magic(ids)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/db_charmer/sharding/connection.rb

@@ -22,7 +22,7 @@ module DbCharmer
       def support_default_shard?
         sharder.respond_to?(:support_default_shard?) && sharder.support_default_shard?
       end
-      
+
       def default_connection
         @default_connection ||= DbCharmer::Sharding::StubConnection.new(self)
       end

data/lib/db_charmer/sharding/method/db_block_map.rb

@@ -201,7 +201,7 @@ module DbCharmer
 
         # Prepare model for working with our shards table
         def prepare_shard_model
-          ShardInfo.set_table_name(shards_table)
+          ShardInfo.table_name = shards_table
           ShardInfo.switch_connection_to(connection)
         end
 

data/lib/db_charmer/version.rb

@@ -2,7 +2,7 @@ module DbCharmer
   module Version
     MAJOR = 1
     MINOR = 7
-    PATCH = 0
+    PATCH = 1
     BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: db-charmer
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 9
   prerelease: 
   segments: 
   - 1
   - 7
-  - 0
-  version: 1.7.0
+  - 1
+  version: 1.7.1
 platform: ruby
 authors: 
 - Oleksiy Kovyrin
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-29 00:00:00 Z
+date: 2012-04-22 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activesupport
@@ -23,13 +23,14 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - <
+    - - <=
       - !ruby/object:Gem::Version 
-        hash: 5
+        hash: 9
         segments: 
         - 3
-        - 1
-        version: "3.1"
+        - 2
+        - 3
+        version: 3.2.3
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -38,13 +39,14 @@ dependencies:
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - <
+    - - <=
       - !ruby/object:Gem::Version 
-        hash: 5
+        hash: 9
         segments: 
         - 3
-        - 1
-        version: "3.1"
+        - 2
+        - 3
+        version: 3.2.3
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -128,6 +130,9 @@ files:
 - lib/db_charmer/rails3/active_record/master_slave_routing.rb
 - lib/db_charmer/rails3/active_record/relation/connection_routing.rb
 - lib/db_charmer/rails3/active_record/relation_method.rb
+- lib/db_charmer/rails31/active_record/migration/command_recorder.rb
+- lib/db_charmer/rails31/active_record/preloader/association.rb
+- lib/db_charmer/rails31/active_record/preloader/has_and_belongs_to_many.rb
 - lib/db_charmer/sharding.rb
 - lib/db_charmer/sharding/connection.rb
 - lib/db_charmer/sharding/method.rb
@@ -138,7 +143,7 @@ files:
 - lib/db_charmer/sharding/stub_connection.rb
 - lib/db_charmer/version.rb
 - lib/tasks/databases.rake
-homepage: http://github.com/kovyrin/db-charmer
+homepage: http://kovyrin.github.com/db-charmer
 licenses: []
 
 post_install_message: 
@@ -167,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.8
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: ActiveRecord Connections Magic (slaves, multiple connections, etc)