safe_clone 0.0.2 → 0.0.3

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZjYyZTMxZmFkMzBkOGYzYjA4OTAxMmI4Mjc0NTgzODE1ODZkYzdiOQ==
-  data.tar.gz: !binary |-
-    NTE2OTc1ZjViZmM2YzhiMDcwNzRlZjcyMTlhYjllZjRhODgxMjE4ZQ==
+SHA1:
+  metadata.gz: c270e1501f513581f54e24e995dac45a3674108b
+  data.tar.gz: a0e903a567fb2cea836e8a9813dfed29a6004b34
 SHA512:
-  metadata.gz: !binary |-
-    MzJhZjE5MzBjYzliNDlmM2JjOTUwZDIxMGJiYzE1NWZhMzZhYjA4MDgwNmQx
-    ZjgzYzYwODcxMGE3OWM4OTdmMjE4NGJmZDFhNmRhZGJhYzRmYmYyYzA5ZWUz
-    Yjk1ZjliMTYyZDA3NGIzYjBkMDA4MTZlOGYwZGMzODA2NjBlOTg=
-  data.tar.gz: !binary |-
-    NDczYjU3MWMwNjA0MmQ3Njk3Y2U2MjA1MjYzN2E3NjYyYjRlYmI5ZTIwZmE3
-    MTk2N2MxZjg1NGEwYWYyZmY2YjIyNGJlOWQyMDJiMmM0MjBiMTc2ZTU1NTFi
-    MTAwM2ZhMzA3ODNhNjIxMGM1NTliNDYxZTZmYmNhMDUwYjRlZmI=
+  metadata.gz: 57187deeb43c0dcc62f6cc503a596445e834aae18d3d378ac15a927e1f88a2cb58282d91a472597327c78eb81b744b3d4b29b728a354ac849d01d794c2e527e6
+  data.tar.gz: 61af8a6ea50fb4bbe924ca3e0e45a54a6802c2eae32b36cc666db9389d450777769414ef0f7b3728e9f67ac36aad305c89d5a636ab2c573f5c962fe806ea2b5b

data/README.md

@@ -1,10 +1,10 @@
 # SafeClone
 
-This tiny gem implements a version of clone called safe_clone. Unlike the
-standard clone method, the safe_clone method does not throw ant exception
-when sent to un-clonable objects like 42 or true. These simply return
-themselves and this is correct because those types of objects do not NEED
-to be cloned. Instead of blowing up in a hissy fit, the code just works!
+This tiny gem implements a version of clone called safe\_clone. Unlike the
+standard clone method, the safe\_clone 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!
 
 ## Installation
 
@@ -30,8 +30,80 @@ then, in those places where regular clone was problematic, use:
 
 instead of
 
-    foo = my_object.clone
+    begin
+      foo = my_object.clone
+    rescue TypeError
+      foo = my_object
+    end
 
+Further, when benchmarked under
+
+    ruby 1.9.3p484 (2013-11-22) [i386-mingw32]
+
+the following results are observed:
+
+    C:\Sites\safe_clone>ruby bench\bench.rb
+    Warming up --------------------------------------
+    Clone with standard clone method
+                             6.424k i/100ms
+    Clone with the safe clone method
+                            97.476k i/100ms
+    Calculating -------------------------------------
+    Clone with standard clone method
+                             72.460k (± 8.5%) i/s -    366.168k
+    Clone with the safe clone method
+                              4.690M (±33.3%) i/s -     20.957M
+
+    Comparison:
+    Clone with the safe clone method:  4690305.8 i/s
+    Clone with standard clone method:    72460.2 i/s - 64.73x slower
+
+With:
+
+    ruby 2.1.6p336 (2015-04-13 revision 50298) [i386-mingw32]
+
+the following results are observed:
+
+    C:\Sites\safe_clone>ruby bench\bench.rb
+    Warming up --------------------------------------
+    Clone with standard clone method
+                            20.607k i/100ms
+    Clone with the safe clone method
+                           107.236k i/100ms
+    Calculating -------------------------------------
+    Clone with standard clone method
+                            298.041k (±11.1%) i/s -      1.484M
+    Clone with the safe clone method
+                              4.934M (±34.5%) i/s -     22.091M
+
+    Comparison:
+    Clone with the safe clone method:  4933871.9 i/s
+    Clone with standard clone method:   298041.4 i/s - 16.55x slower
+
+And with:
+
+    ruby 2.2.3p173 (2015-08-18 revision 51636) [i386-cygwin]
+
+we get:
+
+    $ ruby bench/bench.rb
+    Warming up --------------------------------------
+    Clone with standard clone method
+                            15.876k i/100ms
+    Clone with the safe clone method
+                            70.638k i/100ms
+    Calculating -------------------------------------
+    Clone with standard clone method
+                            219.593k (±10.7%) i/s -      1.095M
+    Clone with the safe clone method
+                              4.525M (± 0.9%) i/s -     22.675M
+
+    Comparison:
+    Clone with the safe clone method:  4524862.8 i/s
+    Clone with standard clone method:   219593.0 i/s - 20.61x slower
+
+
+Overall: Shorter code  _and_ faster. Winner, winner, chicken dinner!
 
 ## Contributing
 

data/bench/bench.rb

@@ -0,0 +1,22 @@
+require "benchmark/ips"
+require 'safe_clone'
+
+def use_clone
+  x = 42
+  y = begin
+        x.clone
+      rescue
+        x
+      end
+end
+
+def use_safe_clone
+  x = 42
+  y = x.safe_clone
+end
+
+Benchmark.ips do |x|
+  x.report("Clone with standard clone method") { use_clone }
+  x.report("Clone with the safe clone method") { use_safe_clone }
+  x.compare!
+end

data/lib/safe_clone/version.rb

@@ -1,3 +1,3 @@
 module SafeClone
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/safe_clone.rb

@@ -1,38 +1,19 @@
 require "safe_clone/version"
 
-module SafeClone
-  def safe_clone
-    self
-  end
-end
-
 class Object
-  def safe_clone
-    self.clone
-  end
-end
-
-class Numeric
-  include SafeClone
-end
-
-class NilClass
-  include SafeClone
+  #By default, reference types use the clone method.
+  def safe_clone; self.clone; end
 end
 
-class TrueClass
-  include SafeClone
-end
-
-class FalseClass
-  include SafeClone
-end
-
-class Symbol
-  include SafeClone
-end
-
-class Regexp
-  include SafeClone
+#For value types, just return self!
+module SafeClone
+  def safe_clone; self; end
 end
 
+#Update the Ruby value types.
+class Numeric;    include SafeClone; end
+class NilClass;   include SafeClone; end
+class TrueClass;  include SafeClone; end
+class FalseClass; include SafeClone; end
+class Symbol;     include SafeClone; end
+class Regexp;     include SafeClone; end

data/safe_clone.gemspec

@@ -14,12 +14,13 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
-# spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_development_dependency 'minitest_visible', ">= 0.0.2"
+
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency 'minitest', "~> 4.7.5"
+  spec.add_development_dependency 'minitest', "~> 5"
 
 end

data/test/safe_clone_tests.rb

@@ -1,23 +1,15 @@
 # coding: utf-8
 
 require_relative '../lib/safe_clone'
+gem              'minitest'
 require          'minitest/autorun'
+require          'minitest_visible'
 
 #Test the monkey patches applied to the Object class.
-class SafeCloneTester < MiniTest::Unit::TestCase
+class SafeCloneTester < Minitest::Test
 
-  #Special initialize to track rake progress.
-  def initialize(*all)
-    $do_this_only_one_time = "" unless defined? $do_this_only_one_time
-
-    if $do_this_only_one_time != __FILE__
-      puts
-      puts "Running test file: #{File.split(__FILE__)[1]}"
-      $do_this_only_one_time = __FILE__
-    end
-
-    super(*all)
-  end
+  #Track mini-test progress.
+  MinitestVisible.track self, __FILE__
 
   def test_for_safe_value_cloning
     assert_equal((6).safe_clone, 6)

metadata

@@ -1,57 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: safe_clone
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-04 00:00:00.000000000 Z
+date: 2016-02-16 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest_visible
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.7.5
+        version: '5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.7.5
+        version: '5'
 description: A safer version of the clone method that avoids unnecessary exceptions.
 email:
 - peter.c.camilleri@gmail.com
@@ -59,11 +73,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bench/bench.rb
 - lib/safe_clone.rb
 - lib/safe_clone/version.rb
 - safe_clone.gemspec
@@ -78,17 +93,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.4
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A safer version of the clone method.