deep_dup 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d00f8bfe1ee27f10defaf6f00fd1da009bac911
-  data.tar.gz: 8f6c8f10cd798bf95e47df1bd5798caaee00d696
+  metadata.gz: ceac246a3817ea4e391592dbd51e7e56548d7eca
+  data.tar.gz: 41519b1a8812200f74a25706452c1155d9b1a8f5
 SHA512:
-  metadata.gz: 2f090c0109e6ab2fe5b7c2d5570de9aeed3cb0470b72e0584d3e9b000fc23c733a325efe3ce4f14dd82e448869bdbfc518d10db3c7eb9e2c1248a5a13410efc7
-  data.tar.gz: 9e73b27787434ee36d1504f0d8f1c49b317f6fd1ff87c8d1d53fce14f38b19f35403e59f90d16aad11a6e25ba8b035db70b2ecb6ed77839118932e7c3aa5408f
+  metadata.gz: 4b10b7fd154bf2490d69cb5944d1acf6f6865cf3c8fc4b9e4ed2c2ffd79ccab35c29e0d425fe55d11315450bc3088068f56294f0ea0b602b99256a986e40f0e7
+  data.tar.gz: a3bdef85413b1d39034d7e7c46e5b7e7c8086a7a112bbebc14cbc734aad9f691fdd65b513faff93bc1d7129ebd33aed6c97aa8479c9da523153caa9cf8130bfb

data/README.md

@@ -13,6 +13,10 @@ dupped = DeepDup.deep_dup('chunky')
 dupped = DeepDup.deep_dup(['chunky', [:bacon, { hi: 5 }]])
 dupped = DeepDup.deep_dup(['a', :a, 1, { bacon: { chunky: 'yeah' } }])
 dupped = DeepDup.deep_dup(SomeClass.new)
+
+array = [1, 2]
+array << array
+dupped = DeepDup.deep_dup(array)
 ```
 
 With monkey patching
@@ -24,6 +28,10 @@ dupped = 'chunky'.deep_dup
 dupped = ['chunky', [:bacon, { hi: 5 }]].deep_dup
 dupped = ['a', :a, 1, { bacon: { chunky: 'yeah' } }].deep_dup
 dupped = SomeClass.new.deep_dup
+
+array = [1, 2]
+array << array
+dupped = array.deep_dup
 ```
 ## Installation
 
@@ -54,3 +62,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/ollie/
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Credits
+
+Thanks [Ice Nine](https://github.com/dkubb/ice_nine) and [Rails](https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/object/duplicable.rb) for inspiration.

data/lib/deep_dup.rb

@@ -10,6 +10,10 @@ require 'deep_dup/version'
 #   dupped = DeepDup.deep_dup(['a', :a, 1, { bacon: { chunky: 'yeah' } }])
 #   dupped = DeepDup.deep_dup(SomeClass.new)
 #
+#   array = [1, 2]
+#   array << array
+#   dupped = DeepDup.deep_dup(array)
+#
 # @example With monkey patching
 #   require 'deep_dup/core_ext/object'
 #
@@ -17,6 +21,10 @@ require 'deep_dup/version'
 #   dupped = ['chunky', [:bacon, { hi: 5 }]].deep_dup
 #   dupped = ['a', :a, 1, { bacon: { chunky: 'yeah' } }].deep_dup
 #   dupped = SomeClass.new.deep_dup
+#
+#   array = [1, 2]
+#   array << array
+#   dupped = array.deep_dup
 module DeepDup
   # Deep duplicate any object.
   #
@@ -26,23 +34,67 @@ module DeepDup
   #   dupped = DeepDup.deep_dup(['a', :a, 1, { bacon: { chunky: 'yeah' } }])
   #   dupped = DeepDup.deep_dup(SomeClass.new)
   #
+  #   array = [1, 2]
+  #   array << array
+  #   dupped = DeepDup.deep_dup(array)
+  #
   # @param object [Object] Pretty much anything.
+  # @param cache  [Hash]   Cache +object_id+s to prevent stack overflow on
+  #                        recursive data structures.
   #
   # @return [Object] Dupped object if possible.
-  def self.deep_dup(object) # rubocop:disable Metrics/MethodLength
+  def self.deep_dup(object, cache = {}) # rubocop:disable Metrics/MethodLength
     case object
     when String
       object.dup
     when nil, false, true, Numeric, Symbol, Method
       object
     when Array
-      object.map { |item| deep_dup(item) }
+      cache_object(object, [], cache) do |new_object|
+        object.each do |item|
+          new_object << deep_dup(item, cache)
+        end
+      end
     when Hash
-      object.each.with_object({}) do |(key, value), hash|
-        hash[deep_dup(key)] = deep_dup(value)
+      cache_object(object, {}, cache) do |new_object|
+        object.each do |key, value|
+          new_object[deep_dup(key, cache)] = deep_dup(value, cache)
+        end
       end
     else # Object, Class
       object.dup
     end
   end
+
+  # Prevent infinite recursion on recursive data structures.
+  #
+  # Imagine an array that has only one item which is a reference to itself.
+  # When entering this method, the cache is empty so we create a new array
+  # and map the original object's id to this newly created object.
+  #
+  # We then give control back to +deep_dup+ so that it can go on and do the
+  # adding, which will call itself with the same array and enter this method
+  # again.
+  #
+  # But this time, since the object is the same, we know the duplicate object
+  # because we stored in in our little cache. So just go ahead and return it
+  # otherwise it would result in an infinite recursion.
+  #
+  # @param object     [Array, Hash] Original object reference.
+  # @param new_object [Array, Hash] The dupped object reference.
+  # @param cache      [Hash]        Map from original object_id to dupped object.
+  #
+  # @yieldparam new_object [Array, Hash] The dupped object reference.
+  #
+  # @return [Array, Hash] The dupped object.
+  def self.cache_object(object, new_object, cache)
+    object_id     = object.object_id
+    dupped_object = cache[object_id]      # Did we already visit this object?
+
+    return dupped_object if dupped_object # Yes, return it, prevent overflow.
+
+    cache[object_id] = new_object         # Map the original object id to the new object.
+    yield(new_object)                     # Let +deep_dup+ do the job.
+    new_object                            # Just return it to +deep_dup+.
+  end
 end

data/lib/deep_dup/core_ext/object.rb

@@ -13,6 +13,10 @@ module DeepDup
       #   dupped = ['a', :a, 1, { bacon: { chunky: 'yeah' } }].deep_dup
       #   dupped = SomeClass.new.deep_dup
       #
+      #   array = [1, 2]
+      #   array << array
+      #   dupped = array.deep_dup
+      #
       # @return [Object] Dupped object if possible.
       def deep_dup
         DeepDup.deep_dup(self)

data/lib/deep_dup/version.rb

@@ -1,4 +1,4 @@
 module DeepDup
   # Version number, happy now?
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: deep_dup
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Oldrich Vetesnik