full_dup 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3a2ac1723116c886af7e561cc4acafef3d1620b6
+  data.tar.gz: 0517dc2b0e8be07b4711f82386fee829b94fb356
+SHA512:
+  metadata.gz: 0ebf965592c3fbf954ce912223bf7952cbda2c966e6668d15e7469e620a3f7c12cc1339ac48e28e968a9b9d0a55f59918e858bce82a3e89f4fe1a6be7f67ffa1
+  data.tar.gz: 35ffdbd1d46ece617723785367fec7d63d3ff00094ec1d9fa0b2c6fc3da65d7f094202a189b3125eed922e7036686c287be876ab5ed54b4afe44a11b71fc5c93

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in full_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,96 @@
+# FullDup
+
+The standard dup method creates a fresh instance of most (non-scalar) objects
+but does not process internal state. This internal state remains aliased in the
+duplicated copy. The full_dup 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 dup 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 dup operation must be applied with great care.
+
+Unlike the standard dup method, the full\_dup method does not throw an
+exception when it sees un-duppable value objects like 42 or true. These values
+simply return themselves. This is correct because those types of objects do
+not _need_ to be duped. 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-dup
+data that has already been duped. Thus even nasty edge cases are handled
+without any special effort on the part of the application programmer.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'full_dup'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install full_dup
+
+    require 'full_dup'
+
+then, in those places where regular dup was problematic, use:
+
+    foo = my_object.full_dup
+
+instead of
+
+    foo = my_object.dup
+
+To exclude some instance variables from the deep duplicating process, define a
+full_dup_exclude method in the required class:
+
+```ruby
+def full_dup_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 duped data. Then the exclude method would
+return an array of array indexes or hash keys to be omitted from the full dup
+recursion. Here is an example that never dupes the first two elements of the
+array:
+
+```ruby
+my_array.define_singleton_method(:full_dup_exclude) { [0, 1] }
+```
+<br>**Possible Red Flag** There is a catch here. The dup method does _not_
+duplicate singleton methods (unlike the clone method). Thus any duplicates
+made in this manner will lose the attached full_dup_exclude method. If it is
+important to retain singleton methods, consider using the full_clone gem
+instead.
+
+## Notes
+
+The full_dup gem tracks its progress and handles data objects that
+contain loops, cycles, and other forms of recursion. In order to do this,
+it relies heavily on the object_id property of the data being copied.
+If object_id is broken, then full_dup and hashes and ... will also be
+broken!
+
+
+## Contributing
+
+#### Plan A
+
+1. Fork it ( https://github.com/PeterCamilleri/full_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 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_dup.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'full_dup/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "full_dup"
+  spec.version       = FullDup::VERSION
+  spec.authors       = ["Peter Camilleri"]
+  spec.email         = ["peter.c.camilleri@gmail.com"]
+
+  spec.description   = "A (safe/no exceptions) dup variant that performs a deep, recursive copy."
+  spec.summary       = "A dup variant that performs a deep copy."
+  spec.homepage      = "http://teuthida-technologies.com/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  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', "~> 4.7.5"
+end

data/lib/full_dup.rb

@@ -0,0 +1,37 @@
+# coding: utf-8
+
+require_relative 'full_dup/version'
+require_relative 'full_dup/object'
+require_relative 'full_dup/array'
+require_relative 'full_dup/hash'
+require_relative 'full_dup/struct'
+
+module FullDup
+  def full_dup(_progress={})
+    self
+  end
+end
+
+class Numeric
+  include FullDup
+end
+
+class NilClass
+  include FullDup
+end
+
+class TrueClass
+  include FullDup
+end
+
+class FalseClass
+  include FullDup
+end
+
+class Symbol
+  include FullDup
+end
+
+class Regexp
+  include FullDup
+end

data/lib/full_dup/array.rb

@@ -0,0 +1,23 @@
+# coding: utf-8
+
+class Array
+
+  #The full_dup method for arrays.
+  def full_dup(progress={})
+    progress[object_id] = result = dup
+    exclude = full_dup_exclude
+
+    each_index do |name|
+
+      unless exclude.include?(name)
+        value = result[name]
+        value = progress[value.object_id] || value.full_dup(progress)
+        result[name] = value
+      end
+
+    end
+
+    result
+  end
+
+end

data/lib/full_dup/hash.rb

@@ -0,0 +1,23 @@
+# coding: utf-8
+
+class Hash
+
+  #The full_dup method for hashes.
+  def full_dup(progress={})
+    progress[object_id] = result = dup
+    exclude = full_dup_exclude
+
+    each_key do |name|
+
+      unless exclude.include?(name)
+        value = result[name]
+        value = progress[value.object_id] || value.full_dup(progress)
+        result[name] = value
+      end
+
+    end
+
+    result
+  end
+
+end

data/lib/full_dup/object.rb

@@ -0,0 +1,28 @@
+# coding: utf-8
+
+class Object
+
+  #By default, no instance variables are excluded.
+  def full_dup_exclude
+    []
+  end
+
+  #The full_dup method for most objects.
+  def full_dup(progress={})
+    progress[object_id] = result = dup
+    exclude = full_dup_exclude
+
+    instance_variables.each do |name|
+
+      unless exclude.include?(name)
+        value = result.instance_variable_get(name)
+        value = progress[value.object_id] || value.full_dup(progress)
+        result.instance_variable_set(name, value)
+      end
+
+    end
+
+    result
+  end
+
+end

data/lib/full_dup/struct.rb

@@ -0,0 +1,23 @@
+# coding: utf-8
+
+class Struct
+
+  #The full_dup method for structs.
+  def full_dup(progress={})
+    progress[object_id] = result = dup
+    exclude = full_dup_exclude
+
+    members.each do |name|
+
+      unless exclude.include?(name)
+        value = result[name]
+        value = progress[value.object_id] || value.full_dup(progress)
+        result[name] = value
+      end
+
+    end
+
+    result
+  end
+
+end

data/lib/full_dup/version.rb

@@ -0,0 +1,5 @@
+# coding: utf-8
+
+module FullDup
+  VERSION = "0.0.1"
+end

data/rakefile.rb

@@ -0,0 +1,22 @@
+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/full_dup_tests.rb",
+                  "test/object_tests.rb",
+                  "test/array_tests.rb",
+                  "test/hash_tests.rb",
+                  "test/struct_tests.rb"]
+
+  t.verbose = false
+  t.warning = true
+end
+
+desc "What version of full_dup is this?"
+task :vers do |t|
+  puts
+  puts "full_dup version = #{FullDup::VERSION}"
+end
+

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: full_dup
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Peter Camilleri
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-14 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: 4.7.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.5
+description: A (safe/no exceptions) dup variant that performs a deep, recursive copy.
+email:
+- peter.c.camilleri@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- full_dup.gemspec
+- lib/full_dup.rb
+- lib/full_dup/array.rb
+- lib/full_dup/hash.rb
+- lib/full_dup/object.rb
+- lib/full_dup/struct.rb
+- lib/full_dup/version.rb
+- rakefile.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 dup variant that performs a deep copy.
+test_files: []
+has_rdoc: