full_clone 0.0.9 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c5671e38cbd5b3f7214be72da4d3e5d183a41d7d
-  data.tar.gz: 174f1e3f0e7279565e2843a88e59665df9c184b2
+SHA256:
+  metadata.gz: 5c4bb3ef9f2dcd49d155858bcc4a198ee0e6c3410b49e406ba93f0185ebfac86
+  data.tar.gz: e81fefb70bb156809382a11018341ba30df8548e2d065b5bfe780f277285f213
 SHA512:
-  metadata.gz: 6871aaf141f6c9c4c44cc9b3ab6fca0d56b39544a7fe7b0b87f96ea554d5ee8cd01636bf0dcd2d0c9bf2e67f5875ff4104d0f72887287ba73270d3d90fec8da0
-  data.tar.gz: ee7830f9882649c34c2d063638fe08b0391855d11c732ca81010158d915841191ddbc08d9a4afe22e398af5909d6404c9a7b4dd765325247a582be7bee3cabe2
+  metadata.gz: 272c5e4919f5db8acb9a9c5b5f075df9a8ea161a7876ddb84de7d9bc17c96694b583efc917ee882133eddc95574de38f12cb9487d2d079d1dfb55a578c2eda32
+  data.tar.gz: abe36357abdf599f5d25408603175446d8e80a3bc5643816b62232a01109611aa175abe93d52ce02e0ebc065e2aca9b653907f46e9aa7777a6bdc46376f16d54

data/README.md

@@ -6,6 +6,8 @@ cloned copy. The full_clone method digs deep and makes copies of these internal
 variables, not just arrays and hashes. It also allows classes to specify an
 exclusion list of variables that are not to be processed.
 
+New for version 0.0.10, now 84% faster (at least full_dup was in my tests).
+
 This comprehensive approach creates another issue to be resolved. In Ruby, if an
 attempt is made to clone an immutable data item like a number, an error occurs.
 The justification for this uncharacteristic strictness is not at all clear, but
@@ -13,8 +15,9 @@ it does mean that the clone operation must be applied with great care.
 
 Unlike the standard clone method, the full\_clone method does not throw an
 exception when it sees un-clonable value objects like 42 or true. These values
-simply return themselves. This is correct because those types of objects do
-not _need_ to be cloned. 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-clone
@@ -116,3 +119,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_clone.gemspec

@@ -17,9 +17,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   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_clone.rb

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

data/lib/full_clone/array.rb

@@ -1,21 +1,26 @@
-class Array
+# coding: utf-8
 
-  #The full_clone method for arrays.
-  def full_clone(progress={})
-    progress[object_id] = result = clone
-    exclude = full_clone_exclude
+# Add full_clone support to all arrays.
+class Array
 
+  # Do a full_clone with no exclusions
+  def full_clone_no_exclusions(progress)
     each_index do |name|
+      value = self[name]
+      value = progress[value.object_id] || value.full_clone(progress)
+      self[name] = value
+    end
+  end
 
+  # Do a full_clone with exclusions
+  def full_clone_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_clone(progress)
-        result[name] = value
+        self[name] = value
       end
-
     end
-
-    result
   end
 
 end

data/lib/full_clone/hash.rb

@@ -1,21 +1,26 @@
-class Hash
+# coding: utf-8
 
-  #The full_clone method for structs.
-  def full_clone(progress={})
-    progress[object_id] = result = clone
-    exclude = full_clone_exclude
+# Add full_clone support to all hashes.
+class Hash
 
+  # Do a full_clone with no exclusions
+  def full_clone_no_exclusions(progress)
     each_key do |name|
+      value = self[name]
+      value = progress[value.object_id] || value.full_clone(progress)
+      self[name] = value
+    end
+  end
 
+  # Do a full_clone with exclusions
+  def full_clone_with_exclusions(progress, exclude)
+    each_key do |name|
       unless exclude.include?(name)
-        value = result[name]
+        value = self[name]
         value = progress[value.object_id] || value.full_clone(progress)
-        result[name] = value
+        self[name] = value
       end
-
     end
-
-    result
   end
 
 end

data/lib/full_clone/object.rb

@@ -1,3 +1,6 @@
+# coding: utf-8
+
+# Add full_clone support to all objects.
 class Object
 
   #By default, no instance variables are excluded.
@@ -5,22 +8,38 @@ class Object
     []
   end
 
-  #The full_clone method for most objects.
+  #The common part of the full_clone method.
   def full_clone(progress={})
     progress[object_id] = result = clone
     exclude = full_clone_exclude
 
+    if exclude.empty?
+      result.full_clone_no_exclusions(progress)
+    else
+      result.full_clone_with_exclusions(progress, exclude)
+    end
+
+    result
+  end
+
+  # Do a full_clone with no exclusions
+  def full_clone_no_exclusions(progress)
     instance_variables.each do |name|
+      value = instance_variable_get(name)
+      value = progress[value.object_id] || value.full_clone(progress)
+      instance_variable_set(name, value)
+    end
+  end
 
+  # Do a full_clone with exclusions
+  def full_clone_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_clone(progress)
-        result.instance_variable_set(name, value)
+        instance_variable_set(name, value)
       end
-
     end
-
-    result
   end
 
 end

data/lib/full_clone/struct.rb

@@ -1,21 +1,26 @@
-class Struct
+# coding: utf-8
 
-  #The full_clone method for structs.
-  def full_clone(progress={})
-    progress[object_id] = result = clone
-    exclude = full_clone_exclude
+# Add full_clone support to the struct class.
+class Struct
 
+  # Do a full_clone with no exclusions
+  def full_clone_no_exclusions(progress)
     members.each do |name|
+      value = self[name]
+      value = progress[value.object_id] || value.full_clone(progress)
+      self[name] = value
+    end
+  end
 
+  # Do a full_clone with exclusions
+  def full_clone_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_clone(progress)
-        result[name] = value
+        self[name] = value
       end
-
     end
-
-    result
   end
 
 end

data/lib/full_clone/use_clone.rb

@@ -0,0 +1,23 @@
+# coding: utf-8
+
+# A mixin for cloning use Ruby clone.
+module FullCloneClone
+  def full_clone(_progress=nil)
+    clone
+  end
+end
+
+# String full clone support.
+class String
+  include FullCloneClone
+end
+
+# Enumerator full clone support.
+class Enumerator
+  include FullCloneClone
+end
+
+# Matchdata full clone support.
+class MatchData
+  include FullCloneClone
+end

data/lib/full_clone/use_self.rb

@@ -0,0 +1,43 @@
+# coding: utf-8
+
+# A mixin for cloning as self.
+module FullCloneSelf
+  def full_clone(_progress=nil)
+    self
+  end
+end
+
+# Numeric supports full clone.
+class Numeric
+  include FullCloneSelf
+end
+
+# NilClass supports full clone.
+class NilClass
+  include FullCloneSelf
+end
+
+# TrueClass supports full clone.
+class TrueClass
+  include FullCloneSelf
+end
+
+# FalseClass supports full clone.
+class FalseClass
+  include FullCloneSelf
+end
+
+# Symbols support full clone.
+class Symbol
+  include FullCloneSelf
+end
+
+# Regular expressions support full clone.
+class Regexp
+  include FullCloneSelf
+end
+
+# Threads support full clone.
+class Thread
+  include FullCloneSelf
+end

data/lib/full_clone/version.rb

@@ -1,3 +1,3 @@
 module FullClone
-  VERSION = "0.0.9"
+  VERSION = "1.0.3"
 end

data/rakefile.rb

@@ -12,6 +12,11 @@ Rake::TestTask.new do |t|
   t.verbose    = false
 end
 
+desc "Run a scan for smelly code!"
+task :reek do |t|
+  `reek --no-color lib > reek.txt`
+end
+
 desc "Run an IRB Session with full_clone loaded."
 task :console do
   system "ruby irbt.rb local"

data/reek.txt

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

data/test/array_tests.rb

@@ -3,14 +3,10 @@
 require_relative '../lib/full_clone'
 gem              'minitest'
 require          'minitest/autorun'
-require          'minitest_visible'
 
 #Test the monkey patches applied to the Object class.
 class ArrayFullCloneTester < Minitest::Test
 
-  #Track mini-test progress.
-  include MinitestVisible
-
   def test_basic_deep_cloning
     sa = "North"
     simple1 = [sa, 5, nil]
@@ -18,7 +14,7 @@ class ArrayFullCloneTester < Minitest::Test
 
     assert_equal(simple1[0], simple2[0])
     assert_equal(simple1[1], 5)
-    assert_equal(simple1[2], nil)
+    assert_nil(simple1[2])
     refute_equal(simple1[0].object_id, simple2[0].object_id)
 
     sa << "West"
@@ -38,7 +34,7 @@ class ArrayFullCloneTester < Minitest::Test
 
     assert_equal(simple1[0], simple2[0])
     assert_equal(simple1[1], 5)
-    assert_equal(simple1[2], nil)
+    assert_nil(simple1[2])
     assert_equal(simple1[0].object_id, simple2[0].object_id)
   end
 

data/test/deep_clone_tests.rb

@@ -3,14 +3,10 @@
 require_relative '../lib/full_clone'
 gem              'minitest'
 require          'minitest/autorun'
-require          'minitest_visible'
 
 #Test the monkey patches applied to the Object class.
 class FullCloneTester < Minitest::Test
 
-  #Track mini-test progress.
-  include MinitestVisible
-
   def test_for_safe_value_cloning
     assert_equal((6).full_clone, 6)
     assert_equal((6).full_clone.object_id, (6).object_id)
@@ -24,7 +20,7 @@ class FullCloneTester < Minitest::Test
     assert_equal((false).full_clone, false)
     assert_equal((false).full_clone.object_id, (false).object_id)
 
-    assert_equal((nil).full_clone, nil)
+    assert_nil((nil).full_clone)
     assert_equal((nil).full_clone.object_id, (nil).object_id)
 
     rex = /ABC/

data/test/hash_tests.rb

@@ -3,14 +3,10 @@
 require_relative '../lib/full_clone'
 gem              'minitest'
 require          'minitest/autorun'
-require          'minitest_visible'
 
 #Test the monkey patches applied to the Object class.
 class HashFullCloneTester < Minitest::Test
 
-  #Track mini-test progress.
-  include MinitestVisible
-
   def test_basic_deep_cloning
     sa = "North"
     simple1 = {iva: sa, ivb: 5, ivc: nil}
@@ -18,7 +14,7 @@ class HashFullCloneTester < Minitest::Test
 
     assert_equal(simple1[:iva], simple2[:iva])
     assert_equal(simple1[:ivb], 5)
-    assert_equal(simple1[:ivc], nil)
+    assert_nil(simple1[:ivc])
     refute_equal(simple1[:iva].object_id, simple2[:iva].object_id)
 
     sa << "West"
@@ -38,7 +34,7 @@ class HashFullCloneTester < Minitest::Test
 
     assert_equal(simple1[:iva], simple2[:iva])
     assert_equal(simple1[:ivb], 5)
-    assert_equal(simple1[:ivc], nil)
+    assert_nil(simple1[:ivc])
     assert_equal(simple1[:iva].object_id, simple2[:iva].object_id)
   end
 

data/test/object_tests.rb

@@ -3,7 +3,6 @@
 require_relative '../lib/full_clone'
 gem              'minitest'
 require          'minitest/autorun'
-require          'minitest_visible'
 
 #Test the monkey patches applied to the Object class.
 class ObjectFullCloneTester < Minitest::Test
@@ -18,9 +17,6 @@ class ObjectFullCloneTester < Minitest::Test
     end
   end
 
-  #Track mini-test progress.
-  include MinitestVisible
-
   def test_basic_deep_cloning
     sa = "North"
     simple1 = SimpleClass.new(sa, 5, nil)
@@ -28,7 +24,7 @@ class ObjectFullCloneTester < Minitest::Test
 
     assert_equal(simple1.iva, simple2.iva)
     assert_equal(simple1.ivb, 5)
-    assert_equal(simple1.ivc, nil)
+    assert_nil(simple1.ivc)
     refute_equal(simple1.iva.object_id, simple2.iva.object_id)
 
     sa << "West"
@@ -48,7 +44,7 @@ class ObjectFullCloneTester < Minitest::Test
 
     assert_equal(simple1.iva, simple2.iva)
     assert_equal(simple1.ivb, 5)
-    assert_equal(simple1.ivc, nil)
+    assert_nil(simple1.ivc)
     assert_equal(simple1.iva.object_id, simple2.iva.object_id)
   end
 

data/test/struct_tests.rb

@@ -3,16 +3,12 @@
 require_relative '../lib/full_clone'
 gem              'minitest'
 require          'minitest/autorun'
-require          'minitest_visible'
 
 #Test the monkey patches applied to the Object class.
 class StructFullCloneTester < Minitest::Test
 
   SimpleStruct = Struct.new(:iva, :ivb, :ivc)
 
-  #Track mini-test progress.
-  include MinitestVisible
-
   def test_basic_deep_cloning
     sa = "North"
     simple1 = SimpleStruct.new(sa, 5, nil)
@@ -20,7 +16,7 @@ class StructFullCloneTester < Minitest::Test
 
     assert_equal(simple1.iva, simple2.iva)
     assert_equal(simple1.ivb, 5)
-    assert_equal(simple1.ivc, nil)
+    assert_nil(simple1.ivc)
     refute_equal(simple1.iva.object_id, simple2.iva.object_id)
 
     sa << "West"
@@ -40,7 +36,7 @@ class StructFullCloneTester < Minitest::Test
 
     assert_equal(simple1.iva, simple2.iva)
     assert_equal(simple1.ivb, 5)
-    assert_equal(simple1.ivc, nil)
+    assert_nil(simple1.ivc)
     assert_equal(simple1.iva.object_id, simple2.iva.object_id)
   end
 

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: full_clone
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  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) clone variant that performs a deep, recursive
   copy.
 email:
@@ -86,8 +86,11 @@ files:
 - lib/full_clone/hash.rb
 - lib/full_clone/object.rb
 - lib/full_clone/struct.rb
+- lib/full_clone/use_clone.rb
+- lib/full_clone/use_self.rb
 - lib/full_clone/version.rb
 - rakefile.rb
+- reek.txt
 - test/array_tests.rb
 - test/deep_clone_tests.rb
 - test/hash_tests.rb
@@ -112,8 +115,7 @@ 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 clone variant that performs a deep copy.
@@ -123,4 +125,3 @@ test_files:
 - test/hash_tests.rb
 - test/object_tests.rb
 - test/struct_tests.rb
-has_rdoc: