full_clone 0.0.10 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97944e660887dfe2a84d165cb26d2dc6e97b8b40
-  data.tar.gz: 9e03f91b6587a868fec985a1955c8d3697af0015
+  metadata.gz: 8385b340fff44a74cd9d7331d4736d3cfcb6ef3e
+  data.tar.gz: 83549c5119a63deafacb4b8f4c22cff46d8569ed
 SHA512:
-  metadata.gz: 8bbbad200de9137bdb3ab810fdddbba2dd7b0e0eb993d7aaef6409ab1817e8f6efcab2b8eeb17d2e102a9cabab0da1b175209452a469fd2cf54da103ff081691
-  data.tar.gz: 9bada8380789f7227a6a809a1bf9393fb8ba1e035e9446adb1c6df7b90eaf3ef9474dfaeac3ec267035f965f7e95d52862c1028d25abc34879b7971bfa3cf9e3
+  metadata.gz: 6ae12b3a5d8825a09973da6264d044612f421b682aa242cabb4efd428f89f119970a19284b796079fe5f17bb876cd11c352b3512c92f4482ee89f799333eecdf
+  data.tar.gz: 43352b509b4bc3ee5eb6c47b48cdf194b9bc9eb0523f54126acbb79151bf77f9d47045c4e5059c438a97f1be7097cba9fffc8835ed0ac5ea3b7acdb8e7b77116

data/README.md

@@ -15,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

data/full_clone.gemspec

@@ -21,5 +21,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   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/array.rb

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

data/lib/full_clone/hash.rb

@@ -1,27 +1,26 @@
+# coding: utf-8
+
+# Add full_clone support to all hashes.
 class Hash
 
-  #The full_clone method for structs.
-  def full_clone(progress={})
-    progress[object_id] = result = clone
-    exclude = full_clone_exclude
+  # 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
 
-    if exclude.empty?
-      each_key do |name|
-        value = result[name]
+  # Do a full_clone with exclusions
+  def full_clone_with_exclusions(progress, exclude)
+    each_key do |name|
+      unless exclude.include?(name)
+        value = self[name]
         value = progress[value.object_id] || value.full_clone(progress)
-        result[name] = value
-      end
-    else
-      each_key do |name|
-        unless exclude.include?(name)
-          value = result[name]
-          value = progress[value.object_id] || value.full_clone(progress)
-          result[name] = value
-        end
+        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,28 +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?
-      instance_variables.each do |name|
-        value = result.instance_variable_get(name)
-        value = progress[value.object_id] || value.full_clone(progress)
-        result.instance_variable_set(name, value)
-      end
+      result.full_clone_no_exclusions(progress)
     else
-      instance_variables.each do |name|
-        unless exclude.include?(name)
-          value = result.instance_variable_get(name)
-          value = progress[value.object_id] || value.full_clone(progress)
-          result.instance_variable_set(name, value)
-        end
-      end
+      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 = instance_variable_get(name)
+        value = progress[value.object_id] || value.full_clone(progress)
+        instance_variable_set(name, value)
+      end
+    end
+  end
+
 end

data/lib/full_clone/struct.rb

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

data/lib/full_clone/use_clone.rb

@@ -1,19 +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

@@ -1,36 +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.10"
+  VERSION = "1.0.0"
 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: full_clone
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 1.0.0
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-06 00:00:00.000000000 Z
+date: 2018-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.2
 description: A (safe/no exceptions) clone variant that performs a deep, recursive
   copy.
 email:
@@ -90,6 +104,7 @@ files:
 - 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