full_dup 0.0.5 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e29b1fda9c75d8b3d58009be5e0a05cdbb4900d0
-  data.tar.gz: 12eaab0453df9c9929cba76476eef2afe49f5768
+SHA256:
+  metadata.gz: 5780661f9225891467a4552a1b065627b67c21f5619566e7038cfcbf50b8c148
+  data.tar.gz: ff40d94205773a95baccc9feaa4c6c9a287ed89f5b12b3b9e1f8cb5000506c17
 SHA512:
-  metadata.gz: d528171d9e4b7fd69372df61f51d50e90a67357275e3735692fceb3c8fbe26b3afe8a311fd26eecc5dead476693fbdee927dc0a6c6cf669b18ed7af3c164d5f0
-  data.tar.gz: d2922af5bc54fb610c6ebcf752df513e1f86c4f92185bbbb30dd94f90f18ff2726b38d5b32e4ed83b59f0b47db75f3e871ec32c4d97998b5c80ebfdf9f8794b7
+  metadata.gz: 779b609572b851269a75014bedadd06c8443b4041562cf05046c75717f877a6a6d7e136ac967751a7af368d37ba588993e2066e92e3742949978b5328b9fa0c6
+  data.tar.gz: fd1f6a258c8d494b196e6e228689a23127f7b4618fec197621d5b0b7fe8c322f635824ed37cb90b169d541992e298fbe51b3f5d1968ffd3b8572ab5d9ce17852

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
 
@@ -122,3 +166,14 @@ broken!
 
 Go to the GitHub repository and raise an issue calling attention to some
 aspect that could use some TLC or a suggestion or an idea.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](./LICENSE.txt).
+
+## Code of Conduct
+
+Everyone interacting in the fully_freeze project’s codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the
+[code of conduct](./CODE_OF_CONDUCT.md).

data/full_dup.gemspec

@@ -17,8 +17,8 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test)/}) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "rake", "~> 12.0"
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "bundler", ">= 2.1.0"
   spec.add_development_dependency 'minitest', "~> 5.7"
-  spec.add_development_dependency 'minitest_visible', "~> 0.1"
+  spec.add_development_dependency 'reek', "~> 5.0.2"
 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

data/lib/full_dup/array.rb

@@ -1,23 +1,26 @@
 # coding: utf-8
 
+# Add full_dup support to the array class.
 class Array
 
-  #The full_dup method for arrays.
-  def full_dup(progress={})
-    progress[object_id] = result = dup
-    exclude = full_dup_exclude
-
+  # Do a full_dup with no exclusions
+  def full_dup_no_exclusions(progress)
     each_index do |name|
+      value = self[name]
+      value = progress[value.object_id] || value.full_dup(progress)
+      self[name] = value
+    end
+  end
 
+  # Do a full_dup with exclusions
+  def full_dup_with_exclusions(progress, exclude)
+    each_index do |name|
       unless exclude.include?(name)
-        value = result[name]
+        value = self[name]
         value = progress[value.object_id] || value.full_dup(progress)
-        result[name] = value
+        self[name] = value
       end
-
     end
-
-    result
   end
 
 end

data/lib/full_dup/hash.rb

@@ -1,23 +1,26 @@
-# coding: utf-8
-
-class Hash
-
-  #The full_dup method for hashes.
-  def full_dup(progress={})
-    progress[object_id] = result = dup
-    exclude = full_dup_exclude
-
-    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
-
-    result
-  end
-
-end
+# coding: utf-8
+
+# Add full_dup support to the hash class.
+class Hash
+
+  # Do a full_dup with no exclusions
+  def full_dup_no_exclusions(progress)
+    each_key do |name|
+      value = self[name]
+      value = progress[value.object_id] || value.full_dup(progress)
+      self[name] = value
+    end
+  end
+
+  # Do a full_dup with exclusions
+  def full_dup_with_exclusions(progress, exclude)
+    each_key do |name|
+      unless exclude.include?(name)
+        value = self[name]
+        value = progress[value.object_id] || value.full_dup(progress)
+        self[name] = value
+      end
+    end
+  end
+
+end

data/lib/full_dup/object.rb

@@ -1,5 +1,6 @@
 # coding: utf-8
 
+# Add full_dup support to the object class.
 class Object
 
   #By default, no instance variables are excluded.
@@ -7,22 +8,38 @@ class Object
     []
   end
 
-  #The full_dup method for most objects.
+  #The common part of the full_dup.
   def full_dup(progress={})
     progress[object_id] = result = dup
     exclude = full_dup_exclude
 
+    if exclude.empty?
+      result.full_dup_no_exclusions(progress)
+    else
+      result.full_dup_with_exclusions(progress, exclude)
+    end
+
+    result
+  end
+
+  # Do a full_dup with no exclusions
+  def full_dup_no_exclusions(progress)
     instance_variables.each do |name|
+      value = instance_variable_get(name)
+      value = progress[value.object_id] || value.full_dup(progress)
+      instance_variable_set(name, value)
+    end
+  end
 
+  # Do a full_dup with exclusions
+  def full_dup_with_exclusions(progress, exclude)
+    instance_variables.each do |name|
       unless exclude.include?(name)
-        value = result.instance_variable_get(name)
+        value = instance_variable_get(name)
         value = progress[value.object_id] || value.full_dup(progress)
-        result.instance_variable_set(name, value)
+        instance_variable_set(name, value)
       end
-
     end
-
-    result
   end
 
 end

data/lib/full_dup/struct.rb

@@ -1,23 +1,26 @@
 # coding: utf-8
 
+# Add full_dup support to the struct class.
 class Struct
 
-  #The full_dup method for structs.
-  def full_dup(progress={})
-    progress[object_id] = result = dup
-    exclude = full_dup_exclude
-
+  # Do a full_dup with no exclusions
+  def full_dup_no_exclusions(progress)
     members.each do |name|
+      value = self[name]
+      value = progress[value.object_id] || value.full_dup(progress)
+      self[name] = value
+    end
+  end
 
+  # Do a full_dup with exclusions
+  def full_dup_with_exclusions(progress, exclude)
+    members.each do |name|
       unless exclude.include?(name)
-        value = result[name]
+        value = self[name]
         value = progress[value.object_id] || value.full_dup(progress)
-        result[name] = value
+        self[name] = value
       end
-
     end
-
-    result
   end
 
 end

data/lib/full_dup/use_dup.rb

@@ -0,0 +1,23 @@
+# coding: utf-8
+
+# The mixin for classes where dup is just simple dup.
+module FullDupDup
+  def full_dup(_progress=nil)
+    dup
+  end
+end
+
+# Strings answer dup.
+class String
+  include FullDupDup
+end
+
+# Enumerators answer dup.
+class Enumerator
+  include FullDupDup
+end
+
+# MatchData answer dup.
+class MatchData
+  include FullDupDup
+end

data/lib/full_dup/use_self.rb

@@ -0,0 +1,44 @@
+# coding: utf-8
+
+# A mixin for classes where the dup is the object itself.
+module FullDupSelf
+  def full_dup(_progress=nil)
+    self
+  end
+end
+
+# Numerics answer self.
+class Numeric
+  include FullDupSelf
+end
+
+# NilClass objects (nil) answer self.
+class NilClass
+  include FullDupSelf
+end
+
+# TrueClass objects (true) answer self.
+class TrueClass
+  include FullDupSelf
+end
+
+# FalseClass objects (false) answer self.
+class FalseClass
+  include FullDupSelf
+end
+
+# Symbols answer self.
+class Symbol
+  include FullDupSelf
+end
+
+# Regular expressions answer self.
+class Regexp
+  include FullDupSelf
+end
+
+# Threads answer self.
+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 = "1.0.3".freeze
 end

data/rakefile.rb

@@ -14,6 +14,11 @@ Rake::TestTask.new do |t|
   t.warning = true
 end
 
+desc "Run a scan for smelly code!"
+task :reek do |t|
+  `reek --no-color lib > reek.txt`
+end
+
 desc "Fire up an IRB session with full_dup preloaded."
 task :console do
   system "ruby irbt.rb local"

data/reek.txt

@@ -0,0 +1 @@
+0 total warnings

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: full_dup
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 1.0.3
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-13 00:00:00.000000000 Z
+date: 2021-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -53,19 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.7'
 - !ruby/object:Gem::Dependency
-  name: minitest_visible
+  name: reek
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 5.0.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 5.0.2
 description: A (safe/no exceptions) dup variant that performs a deep, recursive copy.
 email:
 - peter.c.camilleri@gmail.com
@@ -85,8 +85,11 @@ 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
+- reek.txt
 homepage: https://github.com/PeterCamilleri/full_dup
 licenses:
 - MIT
@@ -106,10 +109,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 3.2.17
 signing_key: 
 specification_version: 4
 summary: A dup variant that performs a deep copy.
 test_files: []
-has_rdoc: