deep_cloneable 1.1.0 → 1.2.0

data/.gitignore

@@ -19,3 +19,5 @@ rdoc
 pkg
 
 ## PROJECT::SPECIFIC
+
+test/debug.log

data/README.rdoc

@@ -37,6 +37,18 @@ And include the gem in your apps config
 
 === Cloning really deep with multiple associations
    pirate.clone :include => [:mateys, {:treasures => :gold_pieces}]
+
+=== Cloning really deep with multiple associations and a dictionary
+
+A dictionary ensures that models are not cloned multiple times when it is associated to nested models. 
+When using a dictionary, ensure recurring associations are cloned first:
+
+  pirate.clone :include => [:mateys, {:treasures => [:matey, :gold_pieces], :use_dictionary => true }]    
+
+If this is not an option for you, it is also possible to populate the dictionary manually in advance:
+
+  dict = { :mateys => {} }
+  pirate.mateys.each{|m| dict[:mateys][m] = m.clone }
    
 === Cloning a model without an attribute
    pirate.clone :except => :name

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.2.0

data/deep_cloneable.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{deep_cloneable}
-  s.version = "1.1.0"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Reinier de Lange"]
-  s.date = %q{2010-10-19}
+  s.date = %q{2010-10-20}
   s.description = %q{Extends the functionality of ActiveRecord::Base#clone to perform a deep clone that includes user specified associations. }
   s.email = %q{r.j.delange@nedforce.nl}
   s.extra_rdoc_files = [

data/lib/deep_cloneable.rb

@@ -17,7 +17,20 @@ class ActiveRecord::Base
     # 
     # ==== Cloning really deep with multiple associations
     #    pirate.clone :include => [:mateys, {:treasures => :gold_pieces}]
-    #    
+    #
+    # ==== Cloning really deep with multiple associations and a dictionary
+    #
+    # A dictionary ensures that models are not cloned multiple times when it is associated to nested models. 
+    # When using a dictionary, ensure recurring associations are cloned first:
+    #
+    #    pirate.clone :include => [:mateys, {:treasures => [:matey, :gold_pieces], :use_dictionary => true }]    
+    #
+    # If this is not an option for you, it is also possible to populate the dictionary manually in advance:
+    #
+    #    dict = { :mateys => {} }
+    #    pirate.mateys.each{|m| dict[:mateys][m] = m.clone }
+    #    pirate.clone :include => [:mateys, {:treasures => [:matey, :gold_pieces], :dictionary => dict }]    
+    #   
     # ==== Cloning a model without an attribute
     #    pirate.clone :except => :name
     #  
@@ -28,7 +41,16 @@ class ActiveRecord::Base
     #    pirate.clone :include => :parrot, :except => [:name, { :parrot => [:name] }]
     # 
     def clone(options = {})
-      kopy = super()
+      dict = options[:dictionary]
+      dict ||= {} if options.delete(:use_dictionary)
+      
+      kopy = unless dict
+        super()
+      else
+        tableized_class = self.class.name.tableize.to_sym
+        dict[tableized_class] ||= {}
+        dict[tableized_class][self] ||= super()
+      end
 
       deep_exceptions = {}
       if options[:except]
@@ -48,6 +70,7 @@ class ActiveRecord::Base
           
           opts = deep_associations.blank? ? {} : {:include => deep_associations}
           opts.merge!(:except => deep_exceptions[association]) if deep_exceptions[association]
+          opts.merge!(:dictionary => dict) if dict
         
           association_reflection = self.class.reflect_on_association(association)          
           cloned_object = case association_reflection.macro

data/test/schema.rb

@@ -18,6 +18,7 @@ ActiveRecord::Schema.define(:version => 1) do
   create_table :treasures, :force => true do |t|
     t.column :found_at, :string
     t.column :pirate_id, :integer
+    t.column :matey_id, :integer    
   end
   
   create_table :gold_pieces, :force => true do |t|

data/test/test_deep_cloneable.rb

@@ -7,7 +7,7 @@ class TestDeepCloneable < Test::Unit::TestCase
     @jack  = Pirate.create(:name => 'Jack Sparrow', :nick_name => 'Captain Jack', :age => 30)
     @polly = Parrot.create(:name => 'Polly', :pirate => @jack)
     @john = Matey.create(:name => 'John', :pirate => @jack)
-    @treasure = Treasure.create(:found_at => 'Isla del Muerte', :pirate => @jack)
+    @treasure = Treasure.create(:found_at => 'Isla del Muerte', :pirate => @jack, :matey => @john)
     @gold_piece = GoldPiece.create(:treasure => @treasure)
   end
 
@@ -76,4 +76,24 @@ class TestDeepCloneable < Test::Unit::TestCase
     assert_not_nil @jack.parrot.name
     assert_nil clone.parrot.name    
   end
+  
+  def test_should_not_double_clone_when_using_dictionary
+    current_matey_count = Matey.count
+    clone = @jack.clone(:include => [:mateys, { :treasures => :matey }], :use_dictionary => true)
+    clone.save!
+
+    assert_equal current_matey_count + 1, Matey.count
+  end
+  
+  def test_should_not_double_clone_when_using_manual_dictionary
+    current_matey_count = Matey.count
+    
+    dict = { :mateys => {} }
+    @jack.mateys.each{|m| dict[:mateys][m] = m.clone }
+      
+    clone = @jack.clone(:include => [:mateys, { :treasures => :matey }], :dictionary => dict)
+    clone.save!
+
+    assert_equal current_matey_count + 1, Matey.count
+  end  
 end

data/test/test_helper.rb

@@ -10,9 +10,9 @@ require 'active_record'
 require 'active_record/fixtures'
 require File.dirname(__FILE__) + '/../init.rb'
 
-class GoldPiece < ActiveRecord::Base; belongs_to :treasure end
-class Matey < ActiveRecord::Base; belongs_to :pirate end
-class Parrot < ActiveRecord::Base; belongs_to :pirate end
+class GoldPiece < ActiveRecord::Base; belongs_to :treasure  end
+class Matey < ActiveRecord::Base;     belongs_to :pirate    end
+class Parrot < ActiveRecord::Base;    belongs_to :pirate    end
 
 class Pirate < ActiveRecord::Base
   has_many :mateys
@@ -23,6 +23,7 @@ end
 
 class Treasure < ActiveRecord::Base
   belongs_to :pirate  
+  belongs_to :matey
   has_many :gold_pieces
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: deep_cloneable
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 31
   prerelease: false
   segments: 
   - 1
-  - 1
+  - 2
   - 0
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Reinier de Lange
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-19 00:00:00 +02:00
+date: 2010-10-20 00:00:00 +02:00
 default_executable: 
 dependencies: []