full_dup 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e29b1fda9c75d8b3d58009be5e0a05cdbb4900d0
-  data.tar.gz: 12eaab0453df9c9929cba76476eef2afe49f5768
+  metadata.gz: 20cf85cb4234f06a7460867e7ea8106d39354c23
+  data.tar.gz: d6a798fe6cd7b325372d97b70b1502229f30fb09
 SHA512:
-  metadata.gz: d528171d9e4b7fd69372df61f51d50e90a67357275e3735692fceb3c8fbe26b3afe8a311fd26eecc5dead476693fbdee927dc0a6c6cf669b18ed7af3c164d5f0
-  data.tar.gz: d2922af5bc54fb610c6ebcf752df513e1f86c4f92185bbbb30dd94f90f18ff2726b38d5b32e4ed83b59f0b47db75f3e871ec32c4d97998b5c80ebfdf9f8794b7
+  metadata.gz: 1dfd98c630f82771af60cc0edc6db998258e1e6dcdbc39062a8129194244c34e725df68bfaa12b63a5feb1d8d10fd5e16c0b707902e1ed7a1de716d697ccb344
+  data.tar.gz: e47dcb7ba1044b94894e45c2241722dfee313b5b51ae93e32a1865945b6fa3d1221425e14a39704dd4402d383d392683095337df49557fca9225aac55611955e

data/README.md

@@ -1,5 +1,12 @@
 # FullDup
 
+The full_dup gem adds the full_dup method to all objects descended from the
+Object class. While this gem makes extensive use of monkey patching, it does
+not modify the behaviour of any existing methods. This is done to minimize
+the risk of breaking any existing code.
+
+New for version 0.0.6, now 84% faster (at least in my tests).
+
 The standard dup method creates a fresh instance of most (non-scalar) objects
 but does not process internal state. This internal state remains aliased in the
 duplicated copy. The full_dup method digs deep and makes copies of these
@@ -13,13 +20,24 @@ it does mean that the dup operation must be applied with great care.
 
 Unlike the standard dup method, the full\_dup method does not throw an
 exception when it sees un-duppable value objects like 42 or true. These values
-simply return themselves. This is correct because those types of objects do
-not _need_ to be duped. Instead of having a fit, the code just works!
+simply return themselves. This is deemed correct because those types of objects
+are immutable and do not need to be duped. Instead of raising an exception,
+the code returns the immutable object instead.
 
 Another issue that this gem deals with is that of data with looping reference
 chains. To handle this, the code tracks object ID values and does not re-dup
 data that has already been duped. Thus even nasty edge cases are handled
-without any special effort on the part of the application programmer.
+without any special effort on the part of the application programmer. Note though
+that this also means that it is important that the object id be correctly
+implemented. Fortunately, this is done by default in Ruby.
+
+If you wish to implement your own object id for your own special classes:
+1. Don't! If object_id is broken,
+then full_dup (and a whole lot of other things too) will also be broken!
+2. It's all on you to do as good a job as Ruby. Like the Ruby object id method,
+your method must create id values that are unique to each object and are perfectly
+repeatable for that object.
+3. Really DON'T! I have never found a valid reason for doing so. I doubt that one exists.
 
 ## Family Overview
 
@@ -93,20 +111,46 @@ array:
 ```ruby
 my_array.define_singleton_method(:full_dup_exclude) { [0, 1] }
 ```
-<br>**Possible Red Flag** There is a catch here. The dup method does _not_
-duplicate singleton methods (unlike the clone method). Thus any duplicates
-made in this manner will lose the attached full_dup_exclude method. If it is
-important to retain singleton methods, consider using the full_clone gem
-instead.
+<br>**Possible Red Flag** There is a catch here. The dup and full_dup methods
+do not duplicate singleton methods (unlike the clone and full_clone methods).
+Thus any duplicates made in this manner will lose the attached full_dup_exclude
+method. If it is important to retain singleton methods, consider using the
+full_clone gem instead.
 
-## Notes
+### irbt
 
-The full_dup gem tracks its progress and handles data objects that
-contain loops, cycles, and other forms of recursion. In order to do this,
-it relies heavily on the object_id property of the data being copied.
-If object_id is broken, then full_dup and hashes and ... will also be
-broken!
+The root folder of the full_dup gem contains the file irbt.rb. This program
+opens up the irb repl with the full_dup gem preloaded and is useful for trying
+out the gem interactively.
 
+By default, irbt will load the system gem version of full dup. The following
+interactive session demonstrates the difference between dup and full_dup
+
+```
+C:\Sites\full_dup>ruby irbt.rb
+Starting an IRB console with full_dup loaded.
+full_dup loaded from gem: 0.0.5
+irb(main):001:0> a = ["a", "b", "c"]
+=> ["a", "b", "c"]
+irb(main):002:0> b = a.dup
+=> ["a", "b", "c"]
+irb(main):003:0> c = a.full_dup
+=> ["a", "b", "c"]
+irb(main):004:0> a[0] << "foo"
+=> "afoo"
+irb(main):005:0> a
+=> ["afoo", "b", "c"]
+irb(main):006:0> b
+=> ["afoo", "b", "c"]
+irb(main):007:0> c
+=> ["a", "b", "c"]
+irb(main):008:0>
+```
+To load the local copy of full_dup use:
+```
+>ruby irbt.rb local #optional irb args go here.
+#etc etc etc...
+```
 
 ## Contributing
 

data/lib/full_dup/array.rb

@@ -7,14 +7,20 @@ class Array
     progress[object_id] = result = dup
     exclude = full_dup_exclude
 
-    each_index do |name|
-
-      unless exclude.include?(name)
+    if exclude.empty?
+      each_index do |name|
         value = result[name]
         value = progress[value.object_id] || value.full_dup(progress)
         result[name] = value
       end
-
+    else
+      each_index do |name|
+        unless exclude.include?(name)
+          value = result[name]
+          value = progress[value.object_id] || value.full_dup(progress)
+          result[name] = value
+        end
+      end
     end
 
     result

data/lib/full_dup/hash.rb

@@ -7,14 +7,20 @@ class Hash
     progress[object_id] = result = dup
     exclude = full_dup_exclude
 
-    each_key do |name|
-
-      unless exclude.include?(name)
+    if exclude.empty?
+      each_key do |name|
         value = result[name]
         value = progress[value.object_id] || value.full_dup(progress)
         result[name] = value
       end
-
+    else
+      each_key do |name|
+        unless exclude.include?(name)
+          value = result[name]
+          value = progress[value.object_id] || value.full_dup(progress)
+          result[name] = value
+        end
+      end
     end
 
     result

data/lib/full_dup/object.rb

@@ -12,14 +12,20 @@ class Object
     progress[object_id] = result = dup
     exclude = full_dup_exclude
 
-    instance_variables.each do |name|
-
-      unless exclude.include?(name)
+    if exclude.empty?
+      instance_variables.each do |name|
         value = result.instance_variable_get(name)
         value = progress[value.object_id] || value.full_dup(progress)
         result.instance_variable_set(name, value)
       end
-
+    else
+      instance_variables.each do |name|
+        unless exclude.include?(name)
+          value = result.instance_variable_get(name)
+          value = progress[value.object_id] || value.full_dup(progress)
+          result.instance_variable_set(name, value)
+        end
+      end
     end
 
     result

data/lib/full_dup/struct.rb

@@ -7,14 +7,20 @@ class Struct
     progress[object_id] = result = dup
     exclude = full_dup_exclude
 
-    members.each do |name|
-
-      unless exclude.include?(name)
+    if exclude.empty?
+      members.each do |name|
         value = result[name]
         value = progress[value.object_id] || value.full_dup(progress)
         result[name] = value
       end
-
+    else
+      members.each do |name|
+        unless exclude.include?(name)
+          value = result[name]
+          value = progress[value.object_id] || value.full_dup(progress)
+          result[name] = value
+        end
+      end
     end
 
     result

data/lib/full_dup/use_dup.rb

@@ -0,0 +1,19 @@
+# coding: utf-8
+
+module FullDupDup
+  def full_dup(_progress=nil)
+    dup
+  end
+end
+
+class String
+  include FullDupDup
+end
+
+class Enumerator
+  include FullDupDup
+end
+
+class MatchData
+  include FullDupDup
+end

data/lib/full_dup/use_self.rb

@@ -0,0 +1,36 @@
+# coding: utf-8
+
+module FullDupSelf
+  def full_dup(_progress=nil)
+    self
+  end
+end
+
+class Numeric
+  include FullDupSelf
+end
+
+class NilClass
+  include FullDupSelf
+end
+
+class TrueClass
+  include FullDupSelf
+end
+
+class FalseClass
+  include FullDupSelf
+end
+
+class Symbol
+  include FullDupSelf
+end
+
+class Regexp
+  include FullDupSelf
+end
+
+class Thread
+  include FullDupSelf
+end
+

data/lib/full_dup/version.rb

@@ -1,5 +1,5 @@
 # coding: utf-8
 
 module FullDup
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/full_dup.rb

@@ -1,37 +1,12 @@
 # coding: utf-8
 
+# A deep, safe, recursive variant of the dup method. The full_dup method.
+
+require_relative 'full_dup/use_self'
+require_relative 'full_dup/use_dup'
 require_relative 'full_dup/version'
 require_relative 'full_dup/object'
 require_relative 'full_dup/array'
 require_relative 'full_dup/hash'
 require_relative 'full_dup/struct'
 
-module FullDup
-  def full_dup(_progress={})
-    self
-  end
-end
-
-class Numeric
-  include FullDup
-end
-
-class NilClass
-  include FullDup
-end
-
-class TrueClass
-  include FullDup
-end
-
-class FalseClass
-  include FullDup
-end
-
-class Symbol
-  include FullDup
-end
-
-class Regexp
-  include FullDup
-end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: full_dup
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-13 00:00:00.000000000 Z
+date: 2018-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -85,6 +85,8 @@ files:
 - lib/full_dup/hash.rb
 - lib/full_dup/object.rb
 - lib/full_dup/struct.rb
+- lib/full_dup/use_dup.rb
+- lib/full_dup/use_self.rb
 - lib/full_dup/version.rb
 - rakefile.rb
 homepage: https://github.com/PeterCamilleri/full_dup
@@ -107,9 +109,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: A dup variant that performs a deep copy.
 test_files: []
-has_rdoc: