yam-db-charmer 1.7.01 → 1.7.4.0

data/.gitignore

@@ -2,3 +2,5 @@
 /pkg
 .DS_Store
 /_site
+*.swo
+*.swp

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

@@ -16,7 +16,7 @@ For more information on the project, you can check out our web site at http://ko
 == Installation
 
 There are two options when approaching +DbCharmer+ installation:
-* using the gem (recommended and the only way of using it with Rails 3.0+)
+* using the gem (recommended and the only way of using it with Rails 3.2+)
 * install as a Rails plugin (works in Rails 2.x only)
 
 To install as a gem, add this to your Gemfile:
@@ -276,7 +276,7 @@ This option could be used to disable automated slave reads on your models so tha
 call <tt>on_slave</tt> or use other methods to enable slave reads when you need it. Example:
 
   class User < ActiveRecord::Base
-    db_magic :slave => slave01, :forced_slave_reads => false
+    db_magic :slave => slave01, :force_slave_reads => false
   end
 
 2) <tt>force_slave_reads</tt> +ActionController+ class method. This method could be used to
@@ -582,17 +582,17 @@ the DbCharmer Users Group mailing list:
 
 == What Ruby and Rails implementations does it work for?
 
-We have a continuous integration setup for this gem on with Rails 2.2, 2.3 and 3.0 using a few
+We have a continuous integration setup for this gem on with Rails 2.3, 3.0, 3.1 and 3.2 using a few
 different versions of Ruby. For more information about the build matrix please visit
 http://github.com/kovyrin/db-charmer-sandbox web site.
 
-In addition to CI testing, we use this gem in production on Scribd.com (one of the largest RoR
+In addition to CI testing, this gem is used in production on Scribd.com (one of the largest RoR
 sites in the world) with Ruby Enterprise Edition and Rails 2.2, Rails 2.3, Sinatra and plain
 Rack applications.
 
-Starting with version 1.7.0 we support Rails 3.0, but until further notice we consider it a
+Starting with version 1.7.0 we support Rails 3.0-3.2, but until further notice we consider it a
 beta-quality feature since we do not run any production software on this version of Rails. If you
-run your application on Rails 3.0, please contact the author.
+run your application on Rails 3.x and having any issues with the gem, please contact the author.
 
 
 == Who are the authors?
@@ -605,8 +605,12 @@ Other contributors who have helped with the development of this library are (alp
 * Allen Madsen
 * Andrew Geweke
 * Ashley Martens
+* Cauê Guerra
+* David Dai
 * Dmytro Shteflyuk
 * Eric Lindvall
+* Eugene Pimenov
+* Jonathan Viney
 * Gregory Man
 * Michael Birk
 * Tyler McMullen

data/db-charmer.gemspec

@@ -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.0'
+  s.add_dependency 'activerecord', '~> 3.0'
 
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'yard'

data/lib/db_charmer/action_controller/force_slave_reads.rb

@@ -4,7 +4,7 @@ module DbCharmer
 
       module ClassMethods
         @@db_charmer_force_slave_reads_actions = {}
-        def force_slave_reads(params)
+        def force_slave_reads(params = {})
           @@db_charmer_force_slave_reads_actions[self.name] = {
             :except => params[:except] ? [*params[:except]].map(&:to_s) : [],
             :only => params[:only] ? [*params[:only]].map(&:to_s) : []
@@ -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/connection_switching.rb

@@ -1,6 +1,7 @@
 module DbCharmer
   module ActiveRecord
     module ConnectionSwitching
+
       def establish_real_connection_if_exists(name, should_exist = false)
         name = name.to_s
 
@@ -34,11 +35,22 @@ 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
 
       #-----------------------------------------------------------------------------------------------------------------
       def coerce_to_connection_proxy(conn, should_exist = true)
+        #Rails.logger.debug "coerce_to_connection_proxy: conn class=#{conn.class}"
         return nil if conn.nil?
 
         if conn.kind_of?(Symbol) || conn.kind_of?(String)
@@ -70,11 +82,16 @@ module DbCharmer
           db_charmer_connection_proxy.set_real_connection(new_conn)
         end
 
+        # Set schema name as table_name_prefix
+        set_schema_table_name_prefix(conn) if self.respond_to? :set_schema_table_name_prefix
+
+
         self.db_charmer_connection_proxy = new_conn
         self.hijack_connection!
 
         # self.reset_column_information
       end
+      
 
     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,90 @@ 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)
+              s = "Switching connection to "
+              if db_name.is_a?(Hash)
+                s << db_name[:connection_name]
+                s << ", schema #{db_name[:schema_name]}" if db_name[:schema_name]
+              else
+                s << db_name.inspect
+              end
+              announce s
+              # 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 +97,52 @@ module DbCharmer
           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}"
+        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
+
+          s = "Switching connection to "
+          if db_name.is_a?(Hash)
+            s << db_name[:connection_name]
+            s << ", schema #{db_name[:schema_name]}" if db_name[:schema_name]
+          else
+            s << db_name.inspect
+          end
+          announce s
           # 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/active_record/multi_db_proxy.rb

@@ -29,7 +29,16 @@ module DbCharmer
         def on_db(con, proxy_target = nil)
           proxy_target ||= self
 
+          # This is for the block_schema_map method.
+          # Setting the table_name_prefix is done in switch_connection_to
+          # but we don't go through switch_connection_to when the connection is set
+          # outside of shard_for.
+          if self.respond_to? :set_schema_table_name_prefix
+            self.set_schema_table_name_prefix(con)
+          end
+          
           # Chain call
+          #Rails.logger.debug "MultiDbProxy#on_db: con=#{con} proxy_target=#{proxy_target}"
           return OnDbProxy.new(proxy_target, con) unless block_given?
 
           # Block call

data/lib/db_charmer/connection_factory.rb

@@ -24,6 +24,14 @@ module DbCharmer
       @@connection_classes[connection_name] ||= establish_connection_to_db(connection_name, config)
     end
 
+    def self.reset_connection(connection_name)
+      connection_name = connection_name.to_s
+      if @@connection_classes[connection_name]
+        @@connection_classes[connection_name].disconnect!
+        @@connection_classes.delete(connection_name)
+      end
+    end
+
     # Establish connection with a specified name
     def self.establish_connection(connection_name, should_exist = true)
       abstract_class = generate_abstract_class(connection_name, should_exist)

data/lib/db_charmer/rails3/active_record/relation_method.rb

@@ -12,9 +12,14 @@ module DbCharmer
       # Create a relation object and initialize its default connection
       def relation_with_db_charmer(*args, &block)
         relation_without_db_charmer(*args, &block).tap do |rel|
-          rel.db_charmer_connection = self.connection
+          rel.db_charmer_connection = self.retrieve_connection
           rel.db_charmer_enable_slaves = self.db_charmer_slaves.any?
           rel.db_charmer_connection_is_forced = !db_charmer_top_level_connection?
+
+          # The relation may have been memoized at a time when the schema
+          # was different. Reset the schema here to use the value saved in the model
+          # (which might have been updated previously when fetching the connection).
+          rel.table.name = self.table_name
         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