deep_dive 0.2.9 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 078a5ab756c6c3a1de100e5222e33ca0acaade74
-  data.tar.gz: 268f32b7ec06114b44ad8239fad854746675edaa
+  metadata.gz: 142b15ce3e57aefd6e65e5f7efbb29b1fb2f3eef
+  data.tar.gz: 3fbe5520d074ea2aa56d4834fd57b09216dcac8d
 SHA512:
-  metadata.gz: 0980b00d72b524e0e822caa36df7a3a5d6493366f649c14fabd614295d913d53e4657bf7f683186d5c31136cbc687dc263cb79fc021e1548e833bee143f3b4d3
-  data.tar.gz: 7a04f372cafd0e546c2d3b2831e7b76cffa6122c09708bdc6661ae043e526f364b6cedf17b0d4c60c2932403506b1257934d08c19c8e3e13414c25170b2a4aac
+  metadata.gz: 21500cd72ec277fbfb2c6605620f1b94cddcb83602ba6fe69bbd524c5d8a957162f264d7afff09d60c05eba5b68bf6a82979a2181ee6554efb68d5b97e0a3bb7
+  data.tar.gz: 078789351c3fffad438e160a3a0dc20f4d3f9264543be979a667f7e581742e2d83215c5dcd65605a6c8ffcd0bd4d6afbbb54ef498a932748c9303aa38569fde5

data/.semver

@@ -1,5 +1,5 @@
 ---
 :major: 0
-:minor: 2
-:patch: 9
+:minor: 3
+:patch: 0
 :special: ''

data/README.rdoc

@@ -87,6 +87,21 @@ which will basically do a deep dup of @foo.
 Please see spec/lib/deep_dive/deep_dive_spec.rb for a more comprehensve example
 of the above. Better documentation will be supplied shortly.
 
+=== Patching
+In some rare circumstances, you may need to patch an instance
+variable in your object graph during deep copying. Like for
+instance, when a child object is being cloned seprately from a different
+parent to be associated with a new parent.
+
+We introduce patching. The instance variable
+
+ @foo.parent = @oldparent
+ pf = @foo.dclone parent: @newparent
+ pf.parent.should == @newparent
+
+And all variables named "parent" in the object graph will
+pick up the new reference.
+
 == Note Well
 
 DeepDive is expected to undergo rapid evolution until it hits 1.0.0. I will take
@@ -94,8 +109,11 @@ every effort to keep the API backwards compatable until then.
 
 == Release Notes
 
-2014-07-27 0.2.0 -- Implemented the exclusion block,
-                    made gem restrictive to Ruby 2.x and higher.
+2015-07-07 0.3.0 -- Added debugging and deep patching based on 
+instance variable names.
+
+2014-07-27 0.2.0 -- Implemented the exclusion block, 
+made gem restrictive to Ruby 2.x and higher.
 
 == Copyright
 

data/deep_dive.gemspec

@@ -2,11 +2,11 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: deep_dive 0.2.9 ruby lib
+# stub: deep_dive 0.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "deep_dive"
-  s.version = "0.2.9"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]

data/lib/deep_dive/deep_dive.rb

@@ -28,13 +28,18 @@ module DeepDive
 
   module API
     # #ddup is a Deep Dive's replacement for #dup.
-    def ddup
-      _replicate dupit: true
+    def ddup(**patch)
+      _replicate dupit: true, patch: _patch_at(**patch)
     end
 
     # #dclone is Deep Dive's replacement for #clone.
-    def dclone
-      _replicate dupit: false
+    def dclone(**patch)
+      _replicate dupit: false, patch: _patch_at(**patch)
+    end
+
+    # Do not use. Internal only.
+    def _patch_at(**p)
+      Hash[p.map{|k, v| ["@#{k}".to_sym, v]}]
     end
   end
 
@@ -48,8 +53,11 @@ module DeepDive
     include API
   end
 
+
   # Not meant to be called externally. Use either ddup or dclone.
-  def _replicate(dupit: true, oc: {})
+  # The patch list will take the value and use that wherver 
+  # it finds the key instance variable down the object graph.
+  def _replicate(dupit: true, oc: {}, patch: {})
     unless oc.member? self
       puts "DeepDive: replicating #{self.class}:<#{self.object_id.to_s(16)}>" if DeepDive::verbose?
 
@@ -58,6 +66,7 @@ module DeepDive
                         else
                           clone
                         end
+
       copy.instance_variables.map do |var|
         [var, instance_variable_get(var)]
       end.reject do |var, ob|
@@ -65,8 +74,15 @@ module DeepDive
       end.reject do |var, ob|
         self.class.excluded?(var, self)
       end.each do |var, value|
-        puts "DeepDive: rep instance var #{self.class}.#{var}(#{value.class}:<#{value.object_id.to_s(16)}>)" if DeepDive::verbose?
-        copy.instance_variable_set(var, value._replicate(oc: oc, dupit: dupit))
+        unless patch.member? var
+          puts "DeepDive: rep instance var #{self.class}.#{var}(#{value.class}:<#{value.object_id.to_s(16)}>)" if DeepDive::verbose?
+          copy.instance_variable_set(var, value._replicate(oc: oc, 
+                                                           dupit: dupit, 
+                                                           patch: patch))
+        else
+          puts "DeepDive: PATCH instance var #{self.class}.#{var}(#{patch[var].class}:<#{patch[var].object_id.to_s(16)}>)" if DeepDive::verbose?
+          copy.instance_variable_set(var, patch[var])
+        end
       end
     end
     oc[self]
@@ -76,9 +92,9 @@ module DeepDive
   # differently.
   module ::Enumerable
     # FIXME: clean up the code a bit, this could be better structured.
-    def _ob_maybe_repl(v: nil, dupit: nil, oc: nil)
+    def _ob_maybe_repl(v: nil, dupit: nil, oc: nil, patch: {})
       if v.respond_to? :_replicate
-        v._replicate(oc: oc, dupit: dupit)
+        v._replicate(oc: oc, dupit: dupit, patch: patch)
       else
         v
       end
@@ -91,7 +107,7 @@ module DeepDive
     # Here all the logic will be present to handle the "special case"
     # enumerables. Most notedly, Hash and Array will require special
     # treatment.
-    def _add(v: nil, dupit: nil, oc: nil)
+    def _add(v: nil, dupit: nil, oc: nil, patch: {})
       unless _pairs?
         case
           when self.kind_of?(::Set)
@@ -101,7 +117,7 @@ module DeepDive
             raise DeepDiveException.new("Don't know how to add new elements for class #{self.class}")
         end
       else
-        self[v.first] = _ob_maybe_repl(v: v.last, dupit: dupit, oc: oc)
+        self[v.first] = _ob_maybe_repl(v: v.last, dupit: dupit, oc: oc, patch: patch)
       end
     end
 
@@ -122,10 +138,10 @@ module DeepDive
     #
     # FIXME: We will initially not handle Enumberables that have instance variables.
     # FIXME: This issue will be addressed at a later date.
-    def _replicate(dupit: true, oc: {})
+    def _replicate(dupit: true, oc: {}, patch: {})
       unless oc.member? self
         self.inject(oc[self] = self.class.new) do |copy, v|
-          copy._add(v: v, dupit: dupit, oc: oc)
+          copy._add(v: v, dupit: dupit, oc: oc, patch: patch)
           copy
         end
       end
@@ -135,7 +151,7 @@ module DeepDive
 
   module CMeth
     @@exclusion = []
-    # exclusion list of instance variables to dup/clone
+    # exclusion list of instance variables to NOT dup/clone
     def exclude(*list, &block)
       @@exclusion << list.map { |s| "@#{s}".to_sym }
       @@exclusion.flatten!

data/spec/lib/deep_dive/deep_dive_spec.rb

@@ -30,6 +30,7 @@ describe DeepDive do
     @foo = Foo.new
     @bar = Bar.new
     @foobar = FooBar.new
+    @patch = FooBar.new
     @fbf = FooBarFoo.new
 
     @foobar.arr = [@foo, @bar, @foobar, "Just a string"]
@@ -48,7 +49,7 @@ describe DeepDive do
     @fbf.fc = @foobar
     @fbf.frecur = @fbf
     @fbf.fexcludeme = Foo.new
-    # DeepDive.verbose = true
+    DeepDive.verbose = true
   end
 
   context 'debugging' do
@@ -81,6 +82,11 @@ describe DeepDive do
       cfoo.a.should_not == @foo.a
     end
 
+    it 'patches' do
+      pf = @foo.dclone b: @patch
+      pf.b.should == @patch
+    end
+
     it 'handles hash cloning properly' do
       cfoo = @foo.dclone
       cfoo.h[1].should == "one"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: deep_dive
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 0.3.0
 platform: ruby
 authors:
 - Fred Mitchell