kovyrin-db-charmer 1.0.1 → 1.1.0

data/README.rdoc

@@ -9,7 +9,7 @@
 5. Adds multiple databases migrations to ActiveRecord
 
 
-== Installation ==
+== Installation
 
 There are two options when approaching db-charmer installation:
 * using gem (recommended)
@@ -57,6 +57,11 @@ change would happen. This is really useful when in development mode or in tests
 create many different databases on your local machine and just want to put all your tables in one 
 database.
 
+Warning: All the connection switching calls would switch connection *only* for those classes the 
+method called on. You can't call the +switch_connection_to+ method and switch connection for a 
+base class in some hierarchy (for example, you can't switch AR::Base connection and see all your 
+models switched to the new connection, use classic +establish_connection+ instead).
+
 
 == Multiple DB Migrations
 
@@ -190,19 +195,51 @@ well: block and proxy.
 3) <tt>on_db(connection)</tt> - this method is what makes two previous methods possible. 
 It is used to switch a model's connection to some db for a short block of code 
 or even for one statement (two forms). It accepts the same range of values as 
-the +switch_connection_to+ method does.
+the +switch_connection_to+ method does. Example:
+
+  Comment.on_db(:olap).count
+  Post.on_db(:foo).find(:first)
+
+
+=== Associations Connection Management
+
+ActiveRecord models can have associations and with their own connections and it becomes
+pretty hard to manage connections in chained calls like <tt>User.posts.count</tt>. With
+class-only connection switching methods this call would look like the following if we'd
+want to count posts on a separate database:
+
+  Post.on_db(:olap) { User.posts.count }
+
+Apparently this is not the best way to write the code and we've implemented <tt>on_*</tt>
+methods on associations as well so you could do things like this:
+
+  @user.posts.on_db(:olap).count
+  @user.posts.on_slave.find(:title => 'Hello, world!')
+
+Notice: Since ActiveRecord associations implemented as proxies for resulting
+objects/collections, it is possible to use our connection switching methods even without
+chained methods:
+
+  @post.user.on_slave - would return post's author
+  @photo.owner.on_slave - would return photo's owner
 
 
 == Documentation
 
-For more information on the plugin internals, please check out the source code. All the plugin's code is covered with tests that were placed in a separate staging rails project located at http://github.com/kovyrin/db-charmer-sandbox. The project has unit tests for all or at least the most of the parts of plugin's code.
+For more information on the plugin internals, please check out the source code. All the plugin's
+code is covered with tests that were placed in a separate staging rails project located at
+http://github.com/kovyrin/db-charmer-sandbox. The project has unit tests for all or at least the
+most of the parts of plugin's code.
 
 
 == What Ruby and Rails implementations does it work for?
 
-We've tested the plugin on MRI 1.8.6 with Rails 2.3.3. After the initial testing phase we're going to deploy this code in production.
+We've tested the plugin on MRI 1.8.6 with Rails 2.2 and 2.3. We use it in production on Scribd.com 
+with MRI 1.8.6 and Rails 2.2.
 
 
 == Who are the authors?
 
-This plugin has been created in Scribd.com for our internal use and then the sources were opened for other people to use. All the code in this package has been developed by Alexey Kovyrin for Scribd.com and is released under the GPLv2 license. For more details, see the LICENSE file.
+This plugin has been created in Scribd.com for our internal use and then the sources were opened for
+other people to use. All the code in this package has been developed by Alexey Kovyrin for Scribd.com
+and is released under the GPLv2 license. For more details, see the LICENSE file.

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.1.0

data/db-charmer.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{db-charmer}
-  s.version = "1.0.1"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alexey Kovyrin"]
-  s.date = %q{2009-08-26}
+  s.date = %q{2009-09-18}
   s.description = %q{ActiveRecord Connections Magic (slaves, multiple connections, etc)}
   s.email = %q{alexey@kovyrin.net}
   s.extra_rdoc_files = [
@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
      "init.rb",
      "lib/db_charmer.rb",
      "lib/db_charmer/active_record_extensions.rb",
+     "lib/db_charmer/association_proxy.rb",
      "lib/db_charmer/connection_factory.rb",
      "lib/db_charmer/connection_proxy.rb",
      "lib/db_charmer/connection_switch.rb",

data/init.rb

@@ -1,4 +1 @@
-# Placeholder to satisfy Rails.
-#
-# Do NOT add any require statements to this file. Doing
-# so will cause Rails to load this plugin all of the time.
+require 'db_charmer'

data/lib/db_charmer/active_record_extensions.rb

@@ -13,31 +13,31 @@ module DbCharmer
       #-----------------------------------------------------------------------------
       @@db_charmer_opts = {}
       def db_charmer_opts=(opts)
-        @@db_charmer_opts[self.to_s] = opts
+        @@db_charmer_opts[self.name] = opts
       end
 
       def db_charmer_opts
-        @@db_charmer_opts[self.to_s] || {}
+        @@db_charmer_opts[self.name] || {}
       end
 
       #-----------------------------------------------------------------------------
       @@db_charmer_connection_proxies = {}
       def db_charmer_connection_proxy=(proxy)
-        @@db_charmer_connection_proxies[self.to_s] = proxy
+        @@db_charmer_connection_proxies[self.name] = proxy
       end
 
       def db_charmer_connection_proxy
-        @@db_charmer_connection_proxies[self.to_s]
+        @@db_charmer_connection_proxies[self.name]
       end
 
       #-----------------------------------------------------------------------------
       @@db_charmer_slaves = {}
       def db_charmer_slaves=(slaves)
-        @@db_charmer_slaves[self.to_s] = slaves
+        @@db_charmer_slaves[self.name] = slaves
       end
 
       def db_charmer_slaves
-        @@db_charmer_slaves[self.to_s] || []
+        @@db_charmer_slaves[self.name] || []
       end
 
       def db_charmer_random_slave
@@ -48,11 +48,11 @@ module DbCharmer
       #-----------------------------------------------------------------------------
       @@db_charmer_connection_levels = Hash.new(0)
       def db_charmer_connection_level=(level)
-        @@db_charmer_connection_levels[self.to_s] = level
+        @@db_charmer_connection_levels[self.name] = level
       end
 
       def db_charmer_connection_level
-        @@db_charmer_connection_levels[self.to_s] || 0
+        @@db_charmer_connection_levels[self.name] || 0
       end
 
       def db_charmer_top_level_connection?

data/lib/db_charmer/association_proxy.rb

@@ -0,0 +1,17 @@
+module DbCharmer
+  module AssociationProxy
+    module InstanceMethods
+      def on_db(con, &block)
+        @reflection.klass.on_db(con, self, &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
+end

data/lib/db_charmer/connection_factory.rb

@@ -8,18 +8,18 @@ module DbCharmer
 
     def self.connect(db_name, should_exist = false)
       @@connection_classes[db_name.to_s] ||= establish_connection(db_name.to_s, should_exist)
-      DbCharmer.logger.warn("ConnectionFactory.connect(#{db_name}) = #{@@connection_classes[db_name.to_s]}")
-      return @@connection_classes[db_name.to_s]
+#      DbCharmer.logger.warn("ConnectionFactory.connect(#{db_name}) = #{@@connection_classes[db_name.to_s]}")
+#      return @@connection_classes[db_name.to_s]
     end
 
     def self.establish_connection(db_name, should_exist = false)
-      DbCharmer.logger.debug("Creating a connection proxy for #{db_name}")
+#      DbCharmer.logger.debug("Creating a connection proxy for #{db_name}")
       abstract_class = generate_abstract_class(db_name, should_exist)
       DbCharmer::ConnectionProxy.new(abstract_class)
     end
 
     def self.generate_abstract_class(db_name, should_exist = false)
-      DbCharmer.logger.info("Generating abstract connection class for #{db_name}: #{abstract_connection_class_name db_name}")
+#      DbCharmer.logger.info("Generating abstract connection class for #{db_name}: #{abstract_connection_class_name db_name}")
 
       module_eval <<-EOF, __FILE__, __LINE__ + 1
         class #{abstract_connection_class_name db_name} < ActiveRecord::Base

data/lib/db_charmer/connection_proxy.rb

@@ -5,7 +5,6 @@ module DbCharmer
     end
 
     def method_missing(meth, *args, &block)
-      DbCharmer.logger.debug("Proxying #{meth} call to #{@abstract_connection_class}")
       @abstract_connection_class.retrieve_connection.send(meth, *args, &block)
     end
   end

data/lib/db_charmer/multi_db_migrations.rb

@@ -9,7 +9,7 @@ module DbCharmer
       def hijack_connection!
         class << self
           def connection
-            puts "DEBUG: Retrieving migration connection"
+#            puts "DEBUG: Retrieving migration connection"
             MigrationAbstractClass.connection
           end
         end

data/lib/db_charmer/multi_db_proxy.rb

@@ -16,16 +16,18 @@ module DbCharmer
     end
 
     module ClassMethods
-      def on_db(con)
+      def on_db(con, proxy_target = nil)
+        proxy_target ||= self
+        
         # Chain call
-        return OnDbProxy.new(self, con) unless block_given?
+        return OnDbProxy.new(proxy_target, con) unless block_given?
 
         # Block call
         begin
           self.db_charmer_connection_level += 1
           old_proxy = db_charmer_connection_proxy
           switch_connection_to(con, DbCharmer.migration_connections_should_exist?)
-          yield(self)
+          yield(proxy_target)
         ensure
           switch_connection_to(old_proxy)
           self.db_charmer_connection_level -= 1
@@ -34,14 +36,14 @@ module DbCharmer
     end
     
     module MasterSlaveClassMethods
-      def on_slave(con = nil, &block)
+      def on_slave(con = nil, proxy_target = nil, &block)
         con ||= db_charmer_random_slave
         raise ArgumentError, "No slaves found in the class and no slave connection given" unless con
-        on_db(con, &block)
+        on_db(con, proxy_target, &block)
       end
 
-      def on_master(&block)
-        on_db(nil, &block)
+      def on_master(proxy_target = nil, &block)
+        on_db(nil, proxy_target, &block)
       end
     end
   end

data/lib/db_charmer.rb

@@ -1,3 +1,5 @@
+puts "Loading DbCharmer..."
+
 module DbCharmer
   @@migration_connections_should_exist = Rails.env.production?
   mattr_accessor :migration_connections_should_exist
@@ -19,14 +21,13 @@ module DbCharmer
   end
 end
 
+puts "Extending AR..."
+
 require 'db_charmer/active_record_extensions'
 require 'db_charmer/connection_factory'
 require 'db_charmer/connection_proxy'
 require 'db_charmer/connection_switch'
-require 'db_charmer/db_magic'
-require 'db_charmer/finder_overrides'
-require 'db_charmer/multi_db_migrations'
-require 'db_charmer/multi_db_proxy'
+require 'db_charmer/association_proxy'
 
 # Enable misc AR extensions
 ActiveRecord::Base.extend(DbCharmer::ActiveRecordExtensions::ClassMethods)
@@ -36,6 +37,17 @@ ActiveRecord::Base.extend(DbCharmer::ConnectionSwitch::ClassMethods)
 
 # Enable connection proxy in AR
 ActiveRecord::Base.extend(DbCharmer::MultiDbProxy::ClassMethods)
+#ActiveRecord::Base.send(:include, DbCharmer::MultiDbProxy::InstanceMethods)
+
+# Enable connection proxy for associations
+ActiveRecord::Associations::AssociationProxy.send(:include, DbCharmer::AssociationProxy::InstanceMethods)
+
+puts "Doing the magic..."
+
+require 'db_charmer/db_magic'
+require 'db_charmer/finder_overrides'
+require 'db_charmer/multi_db_migrations'
+require 'db_charmer/multi_db_proxy'
 
 # Enable multi-db migrations
 ActiveRecord::Migration.extend(DbCharmer::MultiDbMigrations::ClassMethods)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: kovyrin-db-charmer
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors: 
 - Alexey Kovyrin
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-26 00:00:00 -07:00
+date: 2009-09-18 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,6 +42,7 @@ files:
 - init.rb
 - lib/db_charmer.rb
 - lib/db_charmer/active_record_extensions.rb
+- lib/db_charmer/association_proxy.rb
 - lib/db_charmer/connection_factory.rb
 - lib/db_charmer/connection_proxy.rb
 - lib/db_charmer/connection_switch.rb
@@ -51,6 +52,7 @@ files:
 - lib/db_charmer/multi_db_proxy.rb
 has_rdoc: false
 homepage: http://github.com/kovyrin/db-charmer
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -71,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: db-charmer 1.0.1