safe_dup 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 551e1417893bcf4fea7633327e7c9af155d8ba9e
-  data.tar.gz: 093304018762e3b0bf48c4e2619fa18efe62c14b
+  metadata.gz: cf5c446b84f98473efdc4be779f14f01cbb39c54
+  data.tar.gz: bcdeb89a7674518782642ed1a89c744bf7063782
 SHA512:
-  metadata.gz: c0d22238e157ff8d7a6077ccb1bfc5d5bad41a8cbc10d3227b4bff6a26b2c5609731ccc385f59915286e8da081fbd494d3a97584ab869e774ce95c22204c0376
-  data.tar.gz: 242874925de15eaf0a13f72b0677436ed96022e6ab46ed264362355aebd05ddff84cc297b5bbc19f219009e3bce52c1139d6eeb866d21882f9ca257a4321a87e
+  metadata.gz: 8ed82120fb15e78532bd33d0be142e0efe6a203d8142ad0b54ccd6e89fde735dd5fa29c58c298fc4d5fad9a38880b1a451628efe7f25f7a99ff76f9256e57127
+  data.tar.gz: 091a6a95d5073f772ab074c9878d5047acb48573b84a069c1d391661b5baa46f4d3373633575812bd488731dc3c47705d9799abff47fddd0eca122c96f4fca3d

data/README.md

@@ -1,20 +1,20 @@
 # SafeDup
 
-This tiny gem implements a version of clone called safe\_clone. In Ruby, if an
-attempt is made to clone an immutable data item like a number, an error occurs.
+This tiny gem implements a version of dup called safe_dup. In Ruby, if an
+attempt is made to dup an immutable data item like a number, an error occurs.
 The justification for this uncharacteristic strictness is not at all clear, but
-it does mean that the clone operation must be applied with great care.
+it does mean that the dup operation must be applied with great care.
 
-Unlike the standard clone method, the safe\_clone method does not throw an
+Unlike the standard dup method, the safe\_dup method does not throw an
 exception when sent to 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!
+not _need_ to be dupd. Instead of having a fit, the code just works!
 
 On a note about performance, this gem does not just rescue the exceptions
-normally generated by clone, it prevents them from occurring and wasting time
+normally generated by dup, it prevents them from occurring and wasting time
 in the first place.
 
-Finally, this gem does not monkey patch the behavior of the clone method.
+Finally, this gem does not monkey patch the behavior of the dup method.
 Modifying such a crucial method was considered too risky. Instead, the
 safe_dup method is introduced. This is done to reduce the possibility of
 breaking existing code that often occurs when monkey patching goes too far.
@@ -37,26 +37,26 @@ Or install it yourself as:
 
     require 'safe_dup'
 
-then, in those places where regular clone was problematic, use:
+then, in those places where regular dup was problematic, use:
 
     foo = my_object.safe_dup
 
 instead of
 
     begin
-      foo = my_object.clone
+      foo = my_object.dup
     rescue TypeError
       foo = my_object
     end
 
-It is actually pretty easy to determine where safe\_clone needs to be used. It's
-those places where the clone method is generating unwanted exceptions.
+It is actually pretty easy to determine where safe_dup needs to be used. It's
+those places where the dup method is generating unwanted exceptions.
 
 ## Performance
-A reasonable question to raise is "How does safe clone compare with just
+A reasonable question to raise is "How does safe\_dup compare with just
 catching the exception and handling it?" The benchmark sets a a realistic
 scenario where an array (whose contents may be varied) is having its
-_contents_ cloned. The benchmarking code follows:
+_contents_ duplicated. The benchmarking code follows:
 
 ```ruby
 require "benchmark/ips"
@@ -81,8 +81,8 @@ end
 X = ["Test", :test, 43, true, nil, false]
 
 Benchmark.ips do |x|
-  x.report("Clone with standard clone method") { X.use_dup }
-  x.report("Clone with the safe clone method") { X.use_safe_dup }
+  x.report("Dup with standard dup method") { X.use_dup }
+  x.report("Dup with the safe dup method") { X.use_safe_dup }
   x.compare!
 end
 ```
@@ -90,54 +90,54 @@ end
 #### Results: ruby 1.9.3p484 (2013-11-22) [i386-mingw32]
     C:\Sites\safe_dup>ruby bench\bench.rb
     Warming up --------------------------------------
-    Clone with standard clone method
-                             1.247k i/100ms
-    Clone with the safe clone method
-                            35.027k i/100ms
+    Dup with standard dup method
+                             1.245k i/100ms
+    Dup with the safe dup method
+                            34.118k i/100ms
     Calculating -------------------------------------
-    Clone with standard clone method
-                             12.957k (± 5.8%) i/s -     64.844k
-    Clone with the safe clone method
-                            534.740k (± 8.9%) i/s -      2.662M
+    Dup with standard dup method
+                             12.862k (± 6.2%) i/s -     64.740k
+    Dup with the safe dup method
+                            533.927k (± 6.5%) i/s -      2.661M
 
     Comparison:
-    Clone with the safe clone method:   534740.1 i/s
-    Clone with standard clone method:    12956.6 i/s - 41.27x slower
+    Dup with the safe dup method:   533926.5 i/s
+    Dup with standard dup method:    12861.7 i/s - 41.51x slower
 
 #### Results: ruby 2.1.6p336 (2015-04-13 revision 50298) [i386-mingw32]
     C:\Sites\safe_dup>ruby bench\bench.rb
     Warming up --------------------------------------
-    Clone with standard clone method
-                             4.945k i/100ms
-    Clone with the safe clone method
-                            38.109k i/100ms
+    Dup with standard dup method
+                             4.969k i/100ms
+    Dup with the safe dup method
+                            38.025k i/100ms
     Calculating -------------------------------------
-    Clone with standard clone method
-                             54.491k (± 7.3%) i/s -    271.975k
-    Clone with the safe clone method
-                            569.236k (±10.2%) i/s -      2.820M
+    Dup with standard dup method
+                             54.786k (± 7.1%) i/s -    273.295k
+    Dup with the safe dup method
+                            567.814k (±10.1%) i/s -      2.814M
 
     Comparison:
-    Clone with the safe clone method:   569236.4 i/s
-    Clone with standard clone method:    54491.3 i/s - 10.45x slower
+    Dup with the safe dup method:   567814.3 i/s
+    Dup with standard dup method:    54785.8 i/s - 10.36x slower
 
 #### Results: ruby 2.2.3p173 (2015-08-18 revision 51636) [i386-cygwin]
-    Peter Camilleri@NCC1701G /cygdrive/c/sites/safe_dup
     $ ruby bench/bench.rb
     Warming up --------------------------------------
-    Clone with standard clone method
-                             3.698k i/100ms
-    Clone with the safe clone method
-                            28.999k i/100ms
+    Dup with standard dup method
+                             3.662k i/100ms
+    Dup with the safe dup method
+                            28.310k i/100ms
     Calculating -------------------------------------
-    Clone with standard clone method
-                             40.076k (± 5.1%) i/s -    203.390k
-    Clone with the safe clone method
-                            481.524k (±10.0%) i/s -      2.407M
+    Dup with standard dup method
+                             39.437k (± 6.1%) i/s -    197.748k
+    Dup with the safe dup method
+                            450.558k (± 3.9%) i/s -      2.265M
 
     Comparison:
-    Clone with the safe clone method:   481524.1 i/s
-    Clone with standard clone method:    40075.6 i/s - 12.02x slower
+    Dup with the safe dup method:   450557.6 i/s
+    Dup with standard dup method:    39436.6 i/s - 11.42x slower
+
 
 
 Overall: Shorter code  _and_ faster. Winner, winner, chicken dinner!

data/bench/bench.rb

@@ -0,0 +1,26 @@
+require "benchmark/ips"
+require 'safe_dup'
+
+class Array
+  def use_dup
+    self.map do |element|
+      begin
+        element.dup
+      rescue TypeError
+        element
+      end
+    end
+  end
+
+  def use_safe_dup
+    self.map {|element| element.safe_dup }
+  end
+end
+
+X = ["Test", :test, 43, true, nil, false]
+
+Benchmark.ips do |x|
+  x.report("Dup with standard clone method") { X.use_dup }
+  x.report("Dup with the safe clone method") { X.use_safe_dup }
+  x.compare!
+end

data/lib/safe_dup/version.rb

@@ -1,3 +1,3 @@
 module SafeDup
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/safe_dup.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Peter Camilleri"]
   spec.email         = ["peter.c.camilleri@gmail.com"]
 
-  spec.summary       = "A safer version of the dup method that avoids unnecessary exceptions."
-  spec.description   = "A safer version of the clone method."
+  spec.description   = "A safer version of the dup method that avoids unnecessary exceptions."
+  spec.summary       = "A safer version of the dup method."
   spec.homepage      = "http://teuthida-technologies.com/"
   spec.license       = "MIT"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: safe_dup
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Peter Camilleri
@@ -66,7 +66,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5'
-description: A safer version of the clone method.
+description: A safer version of the dup method that avoids unnecessary exceptions.
 email:
 - peter.c.camilleri@gmail.com
 executables: []
@@ -78,6 +78,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bench/bench.rb
 - lib/safe_dup.rb
 - lib/safe_dup/version.rb
 - safe_dup.gemspec
@@ -105,7 +106,7 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: A safer version of the dup method that avoids unnecessary exceptions.
+summary: A safer version of the dup method.
 test_files:
 - test/safe_dup_tests.rb
 has_rdoc: