safe_dup 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 551e1417893bcf4fea7633327e7c9af155d8ba9e
+  data.tar.gz: 093304018762e3b0bf48c4e2619fa18efe62c14b
+SHA512:
+  metadata.gz: c0d22238e157ff8d7a6077ccb1bfc5d5bad41a8cbc10d3227b4bff6a26b2c5609731ccc385f59915286e8da081fbd494d3a97584ab869e774ce95c22204c0376
+  data.tar.gz: 242874925de15eaf0a13f72b0677436ed96022e6ab46ed264362355aebd05ddff84cc297b5bbc19f219009e3bce52c1139d6eeb866d21882f9ca257a4321a87e

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in safe_dup.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Peter Camilleri
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,159 @@
+# 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.
+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.
+
+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!
+
+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
+in the first place.
+
+Finally, this gem does not monkey patch the behavior of the clone 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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'safe_dup'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install safe_dup
+
+## Usage
+
+    require 'safe_dup'
+
+then, in those places where regular clone was problematic, use:
+
+    foo = my_object.safe_dup
+
+instead of
+
+    begin
+      foo = my_object.clone
+    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.
+
+## Performance
+A reasonable question to raise is "How does safe clone 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:
+
+```ruby
+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("Clone with standard clone method") { X.use_dup }
+  x.report("Clone with the safe clone method") { X.use_safe_dup }
+  x.compare!
+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
+    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
+
+    Comparison:
+    Clone with the safe clone method:   534740.1 i/s
+    Clone with standard clone method:    12956.6 i/s - 41.27x 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
+    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
+
+    Comparison:
+    Clone with the safe clone method:   569236.4 i/s
+    Clone with standard clone method:    54491.3 i/s - 10.45x 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
+    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
+
+    Comparison:
+    Clone with the safe clone method:   481524.1 i/s
+    Clone with standard clone method:    40075.6 i/s - 12.02x slower
+
+
+Overall: Shorter code  _and_ faster. Winner, winner, chicken dinner!
+
+## Contributing
+
+#### Plan A
+
+1. Fork it ( https://github.com/PeterCamilleri/safe_dup/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+#### Plan B
+
+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.
+

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rake/testtask'
+require "bundler/gem_tasks"
+
+#Run the unit test suite.
+Rake::TestTask.new do |t|
+  #List out all the test files.
+  t.test_files = ["test/safe_dup_tests.rb"]
+  t.verbose    = false
+end
+
+desc "What version of full_clone is this?"
+task :vers do |t|
+  puts
+  puts "safe_dup version = #{SafeDup::VERSION}"
+end

data/lib/safe_dup/version.rb

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

data/lib/safe_dup.rb

@@ -0,0 +1,21 @@
+
+require_relative "safe_dup/version"
+
+class Object
+  #By default, reference types use the clone method.
+  def safe_dup; self.dup; end
+end
+
+#For value types, just return self!
+module SafeDup
+  def safe_dup; self; end
+end
+
+#Update the Ruby value types.
+class Numeric;    include SafeDup; end
+class NilClass;   include SafeDup; end
+class TrueClass;  include SafeDup; end
+class FalseClass; include SafeDup; end
+class Symbol;     include SafeDup; end
+class Regexp;     include SafeDup; end
+

data/safe_dup.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'safe_dup/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "safe_dup"
+  spec.version       = SafeDup::VERSION
+  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.homepage      = "http://teuthida-technologies.com/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'minitest_visible', ">= 0.1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'minitest', "~> 5"
+end

data/test/safe_dup_tests.rb

@@ -0,0 +1,54 @@
+# coding: utf-8
+
+require_relative '../lib/safe_dup'
+gem              'minitest'
+require          'minitest/autorun'
+require          'minitest_visible'
+
+#Test the monkey patches applied to the Object class.
+class SafeDupTester < Minitest::Test
+
+  #Track mini-test progress.
+  include MinitestVisible
+
+  def test_for_safe_value_cloning
+    assert_equal((6).safe_dup, 6)
+    assert_equal((6).safe_dup.object_id, (6).object_id)
+
+    assert_equal((:foo).safe_dup, :foo)
+    assert_equal((:foo).safe_dup.object_id, (:foo).object_id)
+
+    assert_equal((true).safe_dup, true)
+    assert_equal((true).safe_dup.object_id, (true).object_id)
+
+    assert_equal((false).safe_dup, false)
+    assert_equal((false).safe_dup.object_id, (false).object_id)
+
+    assert_equal((nil).safe_dup, nil)
+    assert_equal((nil).safe_dup.object_id, (nil).object_id)
+
+    rex = /ABC/
+    assert_equal(rex.safe_dup, rex)
+    assert_equal(rex.safe_dup.object_id, rex.object_id)
+  end
+
+  def test_for_reference_cloning
+    str = "test"
+    assert_equal(str.safe_dup, str)
+    refute_equal(str.safe_dup.object_id, str.object_id)
+
+    arra = [1,2,3]
+    arrb = arra.safe_dup
+    assert_equal(arrb, arra)
+    refute_equal(arrb.object_id, arra.object_id)
+
+    arrb << 4
+    assert_equal([1,2,3],   arra)
+    assert_equal([1,2,3,4], arrb)
+
+    lam = lambda { puts 'hello world'}
+    refute_equal(lam.safe_dup.object_id, lam.object_id)
+
+  end
+
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: safe_dup
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Peter Camilleri
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-06 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.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !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: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+description: A safer version of the clone method.
+email:
+- peter.c.camilleri@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/safe_dup.rb
+- lib/safe_dup/version.rb
+- safe_dup.gemspec
+- test/safe_dup_tests.rb
+homepage: http://teuthida-technologies.com/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A safer version of the dup method that avoids unnecessary exceptions.
+test_files:
+- test/safe_dup_tests.rb
+has_rdoc: