safe_dup 0.0.8 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a1fa2f5d277d5480f6b45c11dbc355badc3cd56
-  data.tar.gz: ca7ff2caadc69bcb635e31292cd1677b9f354be3
+  metadata.gz: 6543761fe95e533d5fad84baf23bfe063d1b6c2c
+  data.tar.gz: 4594e1016d11089e90aeb6ea7749fa19a149e1bc
 SHA512:
-  metadata.gz: eef8ee0f8eb380f082276c531d2a1b37b2e6847f2db6903d2d46811b2bb66fe31d0c0c0d605561bcfa8fc432d49d674cb744c9546e489925e395ff6264a73dda
-  data.tar.gz: a2ded1a54ee443f2c3cd21a804fd2bf5a10654128bc1c2b261533197f9405301293ee16b5158259dd23edd9279e9a094c43c5094370d0d9e67f9656d5ce1567b
+  metadata.gz: 9ceba90d313e5e620433d5f12ca232712c4c46adb813eebb39a9ab152c1af5c2af2da3b201992c98ba25a838f9732cc189bf7026e80ffd9454bc3c559d9e7d5d
+  data.tar.gz: 299e3a57d4f6cc37f3cb0b0b2c435c3e28618972b354c3ab855203b37c9fd906b9c3104149b3f92a09aecf432c5881f5fb9ab238f604d4ac671dfe26ca9275a3

data/README.md

@@ -7,8 +7,9 @@ it does mean that the dup operation must be applied with great care.
 
 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 dupd. 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.
 
 On a note about performance, this gem does not just rescue the exceptions
 normally generated by dup, it prevents them from occurring and wasting time
@@ -171,6 +172,21 @@ end
     Dup with the safe dup method:   450557.6 i/s
     Dup with standard dup method:    39436.6 i/s - 11.42x slower
 
+#### Results: ruby 2.3.3p222 (2016-11-21 revision 56859) [i386-mingw32]
+    Warming up --------------------------------------
+    Dup with standard clone method
+                             5.866k i/100ms
+    Dup with the safe clone method
+                            23.721k i/100ms
+    Calculating -------------------------------------
+    Dup with standard clone method
+                             70.492k (± 0.4%) i/s -    357.826k in   5.076221s
+    Dup with the safe clone method
+                            523.478k (± 1.1%) i/s -      2.633M in   5.030544s
+
+    Comparison:
+    Dup with the safe clone method:   523477.8 i/s
+    Dup with standard clone method:    70491.9 i/s - 7.43x  slower
 
 
 Overall: Shorter code  _and_ faster. Winner, winner, chicken dinner!

data/lib/safe_dup.rb

@@ -2,47 +2,52 @@
 
 require_relative "safe_dup/version"
 
-# Now you too can dup without fear of annoying exceptions!
-
+# Now you too can dup objects without fear of annoying exceptions!
 class Object
-  #By default, reference types use the clone method.
+  #By default, reference types use the dup method.
   def safe_dup
     dup
   end
 end
 
-#For value types, just return self!
+# For value types, just return self!
 module SafeDup
   def safe_dup
     self
   end
 end
 
-#Update the Ruby value types.
+# Numeric can now safe dup.
 class Numeric
   include SafeDup
 end
 
+# NilClass can now safe dup.
 class NilClass
   include SafeDup
 end
 
+# TrueClass can now safe dup.
 class TrueClass
   include SafeDup
 end
 
+# FalseClass can now safe dup.
 class FalseClass
   include SafeDup
 end
 
+# Symbols can now safe dup.
 class Symbol
   include SafeDup
 end
 
+# Regular expressions can now safe dup.
 class Regexp
   include SafeDup
 end
 
+# Threads can now safe dup.
 class Thread
   include SafeDup
 end

data/lib/safe_dup/version.rb

@@ -1,3 +1,3 @@
 module SafeDup
-  VERSION = "0.0.8"
+  VERSION = "1.0.0"
 end

data/rakefile.rb

@@ -8,6 +8,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 "Fire up an IRB session with safe_dup preloaded."
 task :console do
   system "ruby irbt.rb local"

data/reek.txt

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

data/safe_dup.gemspec

@@ -22,4 +22,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: safe_dup
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  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 safer version of the dup method that avoids unnecessary exceptions.
 email:
 - peter.c.camilleri@gmail.com
@@ -83,6 +97,7 @@ files:
 - lib/safe_dup.rb
 - lib/safe_dup/version.rb
 - rakefile.rb
+- reek.txt
 - safe_dup.gemspec
 - test/safe_dup_tests.rb
 homepage: https://github.com/PeterCamilleri/safe_dup