safe_dup 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf5c446b84f98473efdc4be779f14f01cbb39c54
-  data.tar.gz: bcdeb89a7674518782642ed1a89c744bf7063782
+  metadata.gz: c853b9fa3c84641d0a931c20bb808415cabe1eae
+  data.tar.gz: 803608d0f50cc8002f5528001bb7d8bff0c10058
 SHA512:
-  metadata.gz: 8ed82120fb15e78532bd33d0be142e0efe6a203d8142ad0b54ccd6e89fde735dd5fa29c58c298fc4d5fad9a38880b1a451628efe7f25f7a99ff76f9256e57127
-  data.tar.gz: 091a6a95d5073f772ab074c9878d5047acb48573b84a069c1d391661b5baa46f4d3373633575812bd488731dc3c47705d9799abff47fddd0eca122c96f4fca3d
+  metadata.gz: cdf8de453fc428b4025592c6d8c3ace6aa5e439ae96e124abdc2072cd55d247e3dc1027213224ba8bbfeda584a5c7b34a1a901fb3aab4968da6dc787a396df35
+  data.tar.gz: e2d4a33e4e06e55c9b4c7a737c08103926626fe22ee4799b141e089bf91e10107b37c71c52b861b81002dd51883646284bbb480db4b8bc50759949920d9168d0

data/README.md

@@ -19,6 +19,28 @@ 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.
 
+## Family Overview
+
+This gem is a member of a family of four gems that all provide data copying
+services in a safe, easy to use format. The following outlines the available
+gems and how to chose from among them.
+
+Depth / Action | Need to copy all. | Need to copy data only.
+---------------|------------------------------|------------
+Need a shallow copy | require 'safe\_clone' | require 'safe\_dup'
+Need a full copy    | require 'full\_clone' | require 'full\_dup'
+
+<br>**Notes**
+* Since none of these gems override the default clone and dup
+methods, the default behaviors remain available. Further, if multiple,
+differing requirements exists, more than one family member gem may be
+employed in the same project without fear of conflict.
+* If multiple family gems are employed, they will each need to be installed and
+required into the application. See below for details.
+* Meta-data attributes include the frozen status and singleton methods. However
+the tainted status is always copied.
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -33,6 +55,11 @@ Or install it yourself as:
 
     $ gem install safe_dup
 
+The safe_dup gem is at: ( https://rubygems.org/gems/safe_dup )
+<br>The safe_clone gem is at: ( https://rubygems.org/gems/safe_clone )
+<br>The full_dup gem is at: ( https://rubygems.org/gems/full_dup )
+<br>The full_clone gem is at: ( https://rubygems.org/gems/full_clone )
+
 ## Usage
 
     require 'safe_dup'
@@ -52,6 +79,12 @@ instead of
 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.
 
+## Demo
+
+A test bed for experimenting with the safe_dup gem is available as a rake task:
+
+    $ rake console
+
 ## Performance
 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

data/irbt.rb

@@ -0,0 +1,20 @@
+# coding: utf-8
+# An IRB + safe_dup test bed
+
+require 'irb'
+$force_alias_read_line_module = true
+require 'mini_readline'
+
+puts "Starting an IRB console with safe_dup loaded."
+
+if ARGV[0] == 'local'
+  require_relative 'lib/safe_dup'
+  puts "safe_dup loaded locally: #{SafeDup::VERSION}"
+
+  ARGV.shift
+else
+  require 'safe_dup'
+  puts "safe_dup loaded from gem: #{SafeDup::VERSION}"
+end
+
+IRB.start

data/lib/safe_dup/version.rb

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

data/{Rakefile → rakefile.rb}

@@ -8,7 +8,12 @@ Rake::TestTask.new do |t|
   t.verbose    = false
 end
 
-desc "What version of full_clone is this?"
+desc "Fire up an IRB session with safe_dup preloaded."
+task :console do
+  system "ruby irbt.rb local"
+end
+
+desc "What version of safe_dup is this?"
 task :vers do |t|
   puts
   puts "safe_dup version = #{SafeDup::VERSION}"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: safe_dup
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-06 00:00:00.000000000 Z
+date: 2016-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest_visible
@@ -77,10 +77,11 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - bench/bench.rb
+- irbt.rb
 - lib/safe_dup.rb
 - lib/safe_dup/version.rb
+- rakefile.rb
 - safe_dup.gemspec
 - test/safe_dup_tests.rb
 homepage: http://teuthida-technologies.com/