full_clone 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6356656d26f8c77cdeec7f5eac9d764e4a398623
-  data.tar.gz: 4eaa1c261d356c755cfe5f64f95d08a26bb700ae
+  metadata.gz: e9209ed1e6cb951c55c56e47f7bf00868f6a651a
+  data.tar.gz: 1d56f766fe6dbf6ef71fd5599c9a78f7965acf42
 SHA512:
-  metadata.gz: 0116b825408bb0554e0a6d6cbcf7ba0219add96b12ad80a3a813e928781f595b961631d7ed97e17d14ee2b9825373e01c80073cd809777cca9382d97f76f83fd
-  data.tar.gz: 81b56106d08a3374e90b203d212e26dfcdf4a088bc52c54a8bb860461beeb1814bb8cd8312b34f42f4cb06bb35b052161f7448bfd846a8d99a5c9687b09e6de3
+  metadata.gz: 65a6910868cfa6e8e8ddd56fee61e885e42fd3d5a8ea9d7a71b88d71e91f6072888c793193bd8aeaaa7208dc55b9f890b1bd185fed4825898d2634ff642174ff
+  data.tar.gz: b012aacf6dc4e175b93279cb67834d73c4447d7435e57f9f9881f4753d5fcfd8367b0f15b9bef30080668444acb713d40147a992269df6526cc616f7829feb42

data/README.md

@@ -6,6 +6,46 @@ cloned copy. The full_clone method digs deep and makes copies of these internal
 variables, not just arrays and hashes. It also allows classes to specify an
 exclusion list of variables that are not to be processed.
 
+This comprehensive approach creates another issue to be resolved. 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 full\_clone method does not throw an
+exception when it sees 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!
+
+Another issue that this gem deals with is that of data with looping reference
+chains. To handle this, the code tracks object ID values and does not re-clone
+data that has already been cloned. Thus even nasty edge cases are handled
+without any special effort on the part of the application programmer.
+
+## 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:
 
     gem 'full_clone'
@@ -18,6 +58,11 @@ Or install it yourself as:
 
     $ gem install full_clone
 
+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 'full_clone'
@@ -33,10 +78,20 @@ instead of
 To exclude some instance variables from the deep cloning process, define a
 full_clone_exclude method in the required class:
 
-    def full_clone_exclude
-      [:@bad_var1, :@bad_var2, :@bad_var_etc]
-    end
-
+```ruby
+def full_clone_exclude
+  [:@bad_var1, :@bad_var2, :@bad_var_etc]
+end
+```
+This also can be applied to arrays and hashes. In this case, it is possible to
+define a singleton method on the cloned data. Then the exclude method would
+return an array of array indexes or hash keys to be omitted from the full clone
+recursion. Here is an example that never clones the first two elements of the
+array:
+
+```ruby
+my_array.define_singleton_method(:full_clone_exclude) { [0, 1] }
+```
 
 ## Notes
 
@@ -49,8 +104,15 @@ broken!
 
 ## Contributing
 
-1. Fork it
+#### Plan A
+
+1. Fork it ( https://github.com/PeterCamilleri/full_clone/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 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/full_clone.gemspec

@@ -14,11 +14,11 @@ 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.1.0"
+  spec.add_development_dependency 'mini_readline', ">= 0.4.8"
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency 'minitest', "~> 4.7.5"

data/irbt.rb

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

data/lib/full_clone/version.rb

@@ -1,3 +1,3 @@
 module FullClone
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/full_clone.rb

@@ -1,3 +1,5 @@
+# coding: utf-8
+
 require_relative 'full_clone/version'
 require_relative 'full_clone/object'
 require_relative 'full_clone/array'

data/{Rakefile → rakefile.rb}

@@ -12,9 +12,13 @@ Rake::TestTask.new do |t|
   t.verbose    = false
 end
 
+desc "Run an IRB Session with full_clone loaded."
+task :console do
+  system "ruby irbt.rb local"
+end
+
 desc "What version of full_clone is this?"
 task :vers do |t|
   puts
   puts "full_clone version = #{FullClone::VERSION}"
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: full_clone
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Peter Camilleri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-18 00:00:00.000000000 Z
+date: 2016-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest_visible
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: mini_readline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.8
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -78,14 +92,15 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - full_clone.gemspec
+- irbt.rb
 - lib/full_clone.rb
 - lib/full_clone/array.rb
 - lib/full_clone/hash.rb
 - lib/full_clone/object.rb
 - lib/full_clone/struct.rb
 - lib/full_clone/version.rb
+- rakefile.rb
 - test/array_tests.rb
 - test/deep_clone_tests.rb
 - test/hash_tests.rb