magic_multi_connections 1.0.0 → 1.2.1

data/Manifest.txt

@@ -1,32 +1,43 @@
-CHANGELOG.txt
-History.txt
-Manifest.txt
-README.txt
-Rakefile
-lib/ext_active_record/connection_specification.rb
-lib/magic_multi_connections.rb
-lib/magic_multi_connections/connected.rb
-lib/magic_multi_connections/module.rb
-lib/magic_multi_connections/version.rb
-scripts/txt2html
-scripts/txt2js
-setup.rb
-test/connections/native_postgresql/connection.rb
-test/fixtures/contact_repository.rb
-test/fixtures/db_definitions/postgresql.sql
-test/fixtures/people.yml
-test/fixtures/person.rb
-test/test_helper.rb
-test/test_magic_multi_connections.rb
-test/test_parent_module.rb
-test/test_preexisting_module.rb
-website/index.html
-website/index.txt
-website/javascripts/rounded_corners_lite.inc.js
-website/stylesheets/screen.css
-website/template.js
-website/template.rhtml
-website/version-raw.js
-website/version-raw.txt
-website/version.js
-website/version.txt
+CHANGELOG.txt
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/ext_active_record/association_extensions.rb
+lib/ext_active_record/connection_specification.rb
+lib/magic_multi_connections.rb
+lib/magic_multi_connections/connected.rb
+lib/magic_multi_connections/module.rb
+lib/magic_multi_connections/version.rb
+scripts/txt2html
+scripts/txt2js
+setup.rb
+test/connections/native_mysql/connection.rb
+test/connections/native_postgresql/connection.rb
+test/fixtures/address.rb
+test/fixtures/addresses.yml
+test/fixtures/assignment.rb
+test/fixtures/classified.rb
+test/fixtures/contact_repository.rb
+test/fixtures/db_definitions/mysql.sql
+test/fixtures/db_definitions/postgresql.sql
+test/fixtures/habit.rb
+test/fixtures/paycheck.rb
+test/fixtures/people.yml
+test/fixtures/person.rb
+test/fixtures/soldier.rb
+test/test_helper.rb
+test/test_magic_multi_connections.rb
+test/test_mmc_associations.rb
+test/test_parent_module.rb
+test/test_preexisting_module.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.js
+website/template.rhtml
+website/version-raw.js
+website/version-raw.txt
+website/version.js
+website/version.txt

data/Rakefile

@@ -11,7 +11,7 @@ require 'hoe'
 include FileUtils
 require File.join(File.dirname(__FILE__), 'lib', 'magic_multi_connections', 'version')
 
-AUTHOR = "nicwilliams"  # can also be an array of Authors
+AUTHOR = "Dr Nic Williams"  # can also be an array of Authors
 EMAIL = "drnicwilliams@gmail.com"
 DESCRIPTION = "Your ActiveRecord classes can be accessed within multiple modules, each which targets a different DB connection"
 GEM_NAME = "magic_multi_connections" # what ppl will type to install your gem
@@ -22,7 +22,7 @@ HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
 NAME = "magic_multi_connections"
 REV = nil # UNCOMMENT IF REQUIRED: File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil
 VERS = ENV['VERSION'] || (MagicMultiConnection::VERSION::STRING + (REV ? ".#{REV}" : ""))
-                          CLEAN.include ['**/.*.sw?', '*.gem', '.config']
+CLEAN.include ['**/.*.sw?', '*.gem', '.config', 'debug.log']
 RDOC_OPTS = ['--quiet', '--title', "magic_multi_connections documentation",
     "--opname", "index.html",
     "--line-numbers", 
@@ -64,24 +64,30 @@ end
 SCHEMA_PATH = File.join(File.dirname(__FILE__), *%w(test fixtures db_definitions))
 
 
-desc 'Build the PostgreSQL test databases'
-task :build_postgresql_databases do 
-  sh %{ createdb "#{GEM_NAME}_unittest" }
-  sh %{ psql "#{GEM_NAME}_unittest" -f #{File.join(SCHEMA_PATH, 'postgresql.sql')} }
-  sh %{ createdb "#{GEM_NAME}_extra_unittest" }
-  sh %{ psql "#{GEM_NAME}_extra_unittest" -f #{File.join(SCHEMA_PATH, 'postgresql.sql')} }
-end
+namespace :postgresql do
+  desc 'Build the PostgreSQL test databases'
+  task :build_databases do 
+    sh %{ createdb "#{GEM_NAME}_unittest" }
+    sh %{ psql "#{GEM_NAME}_unittest" -f #{File.join(SCHEMA_PATH, 'postgresql.sql')} }
+    sh %{ createdb "#{GEM_NAME}_extra_unittest" }
+    sh %{ psql "#{GEM_NAME}_extra_unittest" -f #{File.join(SCHEMA_PATH, 'postgresql.sql')} }
+  end
+
+  desc 'Drop the PostgreSQL test databases'
+  task :drop_databases do 
+    sh %{ dropdb "#{GEM_NAME}_unittest" }
+    sh %{ dropdb "#{GEM_NAME}_extra_unittest" }
+  end
 
-desc 'Drop the PostgreSQL test databases'
-task :drop_postgresql_databases do 
-  sh %{ dropdb "#{GEM_NAME}_unittest" }
-  sh %{ dropdb "#{GEM_NAME}_extra_unittest" }
+  desc 'Rebuild the PostgreSQL test databases'
+  task :rebuild_databases => [:drop_databases, :build_databases]
 end
 
-desc 'Rebuild the PostgreSQL test databases'
+desc 'Build the PostgreSQL test databases'
+task :build_postgresql_databases   => 'postgresql:build_databases'
+task :drop_postgresql_databases    => 'postgresql:drop_databases'
 task :rebuild_postgresql_databases => [:drop_postgresql_databases, :build_postgresql_databases]
 
-
 desc 'Generate website files'
 task :website_generate do
   sh %{ ruby scripts/txt2html website/index.txt > website/index.html }

data/lib/ext_active_record/association_extensions.rb

@@ -0,0 +1,90 @@
+#raise "STOP"
+
+module ActiveRecord
+  module Reflection
+    
+    # This will add the 'mirrors_owner_db_connection' property to
+    # the Association Reflection object.
+    class AssociationReflection
+      
+      def mirror_db_connection
+        return :default unless self.options.key?(:mirror_db_connection)
+        self.options.key?(:mirror_db_connection)
+      end
+    
+      def mirror_db_connection=(value)
+        self.options[:mirror_db_connection] = value
+      end
+      
+    end
+  end
+  
+  module Associations
+    module ClassMethods
+      
+      def create_has_many_reflection(association_id, options, &extension)
+          options.assert_valid_keys(
+            :class_name, :table_name, :foreign_key,
+            :exclusively_dependent, :dependent,
+            :select, :conditions, :include, :order, :group, :limit, :offset,
+            :as, :through, :source, :source_type,
+            :uniq,
+            :finder_sql, :counter_sql, 
+            :before_add, :after_add, :before_remove, :after_remove, 
+            :extend,
+            :mirror_db_connection
+          )
+
+          options[:extend] = create_extension_module(association_id, extension) if block_given?
+
+          create_reflection(:has_many, association_id, options, self)
+        end
+
+        def create_has_one_reflection(association_id, options)
+          options.assert_valid_keys(
+            :class_name, :foreign_key, :remote, :conditions, :order, :include, :dependent, :counter_cache, :extend, :as,
+            :mirror_db_connection
+          )
+
+          create_reflection(:has_one, association_id, options, self)
+        end
+
+        def create_belongs_to_reflection(association_id, options)
+          options.assert_valid_keys(
+            :class_name, :foreign_key, :foreign_type, :remote, :conditions, :order, :include, :dependent, 
+            :counter_cache, :extend, :polymorphic,
+            :mirror_db_connection
+          )
+          
+          reflection = create_reflection(:belongs_to, association_id, options, self)
+
+          if options[:polymorphic]
+            reflection.options[:foreign_type] ||= reflection.class_name.underscore + "_type"
+          end
+
+          reflection
+        end
+        
+        def create_has_and_belongs_to_many_reflection(association_id, options, &extension)
+          options.assert_valid_keys(
+            :class_name, :table_name, :join_table, :foreign_key, :association_foreign_key, 
+            :select, :conditions, :include, :order, :group, :limit, :offset,
+            :uniq, 
+            :finder_sql, :delete_sql, :insert_sql,
+            :before_add, :after_add, :before_remove, :after_remove, 
+            :extend,
+            :mirror_db_connection
+          )
+
+          options[:extend] = create_extension_module(association_id, extension) if block_given?
+
+          reflection = create_reflection(:has_and_belongs_to_many, association_id, options, self)
+
+          reflection.options[:join_table] ||= join_table_name(undecorated_table_name(self.to_s), undecorated_table_name(reflection.class_name))
+          
+          reflection
+        end
+      
+    end
+  end
+end

data/lib/magic_multi_connections.rb

@@ -1,21 +1,22 @@
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
-
-unless defined?(ActiveSupport) && defined?(ActiveRecord)
-  begin
-    require 'active_support'  
-    require 'active_record'  
-  rescue LoadError
-    require 'rubygems'
-    require 'active_support'
-    require 'active_record'  
-  end
-end
-
-module MagicMultiConnection
-end
-
-require 'magic_multi_connections/version'
-require 'magic_multi_connections/connected'
-require 'magic_multi_connections/module'
-require 'ext_active_record/connection_specification'
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+unless defined?(ActiveSupport) && defined?(ActiveRecord)
+  begin
+    require 'active_support'  
+    require 'active_record'  
+  rescue LoadError
+    require 'rubygems'
+    require 'active_support'
+    require 'active_record'  
+  end
+end
+
+module MagicMultiConnection
+end
+
+require 'magic_multi_connections/version'
+require 'magic_multi_connections/connected'
+require 'magic_multi_connections/module'
+require 'ext_active_record/connection_specification'
+require 'ext_active_record/association_extensions'

data/lib/magic_multi_connections/connected.rb

@@ -1,29 +1,91 @@
-module MagicMultiConnection::Connected
-  def self.included(base)
-    base.instance_eval <<-EOS
-      alias :pre_connected_const_missing :const_missing
-  
-      def const_missing(const_id)
-        return pre_connected_const_missing(const_id) rescue nil
-        target_class = "::\#{const_id}".constantize rescue nil
-        raise NameError.new("uninitialized constant \#{const_id}") unless target_class
-        klass = create_class const_id, target_class
-        klass.establish_connection self.connection_spec
-        klass
-      end
-
-      def create_class(class_name, superclass = Object, &block)
-        klass = Class.new superclass, &block
-        self.const_set class_name, klass
-      end
-    EOS
-    base.extend(ClassMethods)
-  end
-  
-  module ClassMethods
-    def establish_connection_on(klass)
-      klass.establish_connection self.connection_spec
-    end
-  end
-end
-
+module MagicMultiConnection::Connected
+  def self.included(base)
+    base.instance_eval do
+      alias :pre_connected_const_missing :const_missing
+      
+      def namespace_reflections_mirror_db
+        @namespace_reflections_mirror_db
+      end
+  
+      def namespace_reflections_mirror_db=(value)
+        if value
+          warn "DEPRACATION WARNING: Automatic namespace associations will be removed in the next major release of this gem. Please use explicit association statments."
+        end
+        @namespace_reflections_mirror_db = value
+      end
+  
+      def const_missing(const_id)
+        # return pre_connected_const_missing(const_id) rescue nil
+        target_class = "#{self.parent_module}::#{const_id}".constantize rescue nil
+        raise NameError.new("uninitialized constant \{const_id}") unless target_class
+        
+        # The code below is used to solve an issue with the acts_as_versioned
+        # plugin.  Because the acts_as_versioned plugin creates a 'Version' model
+        # in the namespace of the class itself, the mmc method const_missing() will
+        # never get called.  To get around this issue I have modified the acts_as_versioned
+        # plugin so that it uses the inherited() method and forces a new ActiveRecord object
+        # to be created.  That inheritance method relies on mmc_owner function created below.
+        mmc_owner = self
+        klass = create_class const_id, target_class do
+          @@mmc_owner = mmc_owner
+          def self.mmc_owner
+            @@mmc_owner
+          end
+        end        
+        klass.establish_connection self.connection_spec
+        klass
+      end
+
+      def create_class(class_name, superclass = Object, &block)
+        klass = Class.new superclass, &block
+        result = self.const_set(class_name, klass)
+        
+        # Cycle through all reflections, and redefine those reflections
+        # for all relationships where the ActiveRecord Object follows one
+        # of the two following conditions: 
+        # 1. The module is set to mirror relationships for the namespace, the reflection object is in
+        #    the reflection owner's namespace and the mirror_db_connection object is not explicitly set
+        # 2. The reflections mirror_db_connection is explicitly set to true.
+        parent_mod = self.parent_module
+        superclass.reflections.each do |reflection_name, reflection|
+          
+          # First do a check to see if code is using a depracated method
+          # of associations:
+          reflection_mirrors_db = false
+          if reflection.mirror_db_connection == true
+            reflection_mirrors_db = true
+          elsif (reflection.mirror_db_connection == :default && 
+                 namespace_reflections_mirror_db &&
+                 Regexp.new("(::|^)#{parent_mod.to_s}(::|$)") =~ reflection.klass.to_s)
+            warn "DEPRACATION WARNING: Automatic namespace associations will be removed in the next major release of this gem. Please use explicit association statments."
+            reflection_mirrors_db = true
+          end
+          
+          if reflection_mirrors_db
+            # redefine the reflection
+            new_class_name = reflection.class_name.sub(parent_mod.to_s, "::#{self.name}").gsub("::::", "::")
+            new_options = reflection.options.dup
+            new_options[:class_name] = new_class_name
+            case reflection.macro
+            when :has_one, :has_many, :belongs_to
+              new_options[:foreign_key] ||= reflection.primary_key_name
+            when :has_and_belongs_to_many
+              
+            end
+            
+            klass.send reflection.macro, reflection_name, new_options
+          end         
+        end
+        result      
+      end
+    end
+    base.extend(ClassMethods)
+  end
+  
+  module ClassMethods
+    def establish_connection_on(klass)
+      klass.establish_connection self.connection_spec
+    end
+  end
+end
+

data/lib/magic_multi_connections/module.rb

@@ -1,26 +1,27 @@
-class Module
-  attr_accessor :connection_spec
-  
-  def establish_connection(connection_spec)
-    include MagicMultiConnection::Connected
-    instance_variable_set '@connection_spec', connection_spec
-    update_active_records
-  end
-  
-  def parent_module
-    parent = self.name.split('::')[0..-2].join('::')
-    parent = 'Object' if parent.blank?
-    parent.constantize
-  end
-  
-  private 
-  def update_active_records
-    self.constants.each do |c_str|
-      c = "#{self.name}::#{c_str}".constantize
-      next unless c.is_a? Class
-      next unless c.new.is_a? ActiveRecord::Base
-      c.establish_connection connection_spec
-    end
-  end
-end
-
+class Module
+  attr_accessor :connection_spec
+  
+  def establish_connection(connection_spec, namespace_reflections_mirror_db = true)
+    include MagicMultiConnection::Connected
+    instance_variable_set '@connection_spec', connection_spec
+    instance_variable_set '@namespace_reflections_mirror_db', namespace_reflections_mirror_db
+    update_active_records
+  end
+  
+  def parent_module
+    parent = self.name.split('::')[0..-2].join('::')
+    parent = 'Object' if parent.blank?
+    parent.constantize
+  end
+  
+  private 
+  def update_active_records
+    self.constants.each do |c_str|
+      c = "#{self.name}::#{c_str}".constantize
+      next unless c.is_a? Class
+      next unless c.new.is_a? ActiveRecord::Base
+      c.establish_connection connection_spec
+    end
+  end
+end
+