deep_clonable 1.0.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Justin Balthrop
+
+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.rdoc

@@ -0,0 +1,47 @@
+= DeepClonable
+
+DeepClonable is an extension that adds deep clone support to any Class. Just call
+deep_clonable in the class definition. You can also define special behavior when cloning
+by overriding the clone_fields method if you want, but by default, all Arrays and Hashes
+will be deep cloned.
+
+== Usage:
+
+  class Foo
+    deep_clonable
+    
+    attr_reader :array
+    
+    def initialize(array)
+      @array = array
+    end
+    
+    def clone_fields
+      # Only deep clone a single variable, all other variables will be just be copied directly.
+      @array = @array.clone
+    end
+  end
+
+  foo = Foo.new([1,2,3])
+  bar = Foo.clone
+
+  foo.array
+  # => [1,2,3]
+
+  bar.array
+  # => [1,2,3]
+
+  bar.array << 4
+  bar.array
+  # => [1,2,3,4]
+
+  foo.array
+  # => [1,2,3]
+
+== Install:
+
+  sudo gem install ninjudd-deep_clonable -s http://gems.github.com
+
+== License:
+
+Copyright (c) 2008 Justin Balthrop, Geni.com; Published under The MIT License, see LICENSE

data/Rakefile

@@ -0,0 +1,44 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "deep_clonable"
+    s.summary = %Q{Add support for deep cloning to objects}
+    s.email = "code@justinbalthrop.com"
+    s.homepage = "http://github.com/ninjudd/deep_clonable"
+    s.description = "	Add support for deep cloning to objects"
+    s.authors = ["Justin Balthrop"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'deep_clonable'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |t|
+    t.libs << 'test'
+    t.test_files = FileList['test/**/*_test.rb']
+    t.verbose = true
+  end
+rescue LoadError
+end
+
+task :default => :test

data/VERSION.yml

@@ -0,0 +1,5 @@
+--- 
+:build: 
+:patch: 2
+:major: 1
+:minor: 0

data/deep_clonable.gemspec

@@ -0,0 +1,49 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{deep_clonable}
+  s.version = "1.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Justin Balthrop"]
+  s.date = %q{2010-04-13}
+  s.description = %q{	Add support for deep cloning to objects}
+  s.email = %q{code@justinbalthrop.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "deep_clonable.gemspec",
+     "lib/deep_clonable.rb",
+     "test/deep_clonable_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/ninjudd/deep_clonable}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Add support for deep cloning to objects}
+  s.test_files = [
+    "test/deep_clonable_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/deep_clonable.rb

@@ -0,0 +1,58 @@
+class Class
+  def deep_clonable
+    include DeepClonable::InstanceMethods
+    extend  DeepClonable::ClassMethods
+  end
+end
+
+module DeepClonable
+  module InstanceMethods
+    def clone
+      cloned_object = super
+      cloned_object.clone_fields
+      cloned_object
+    end
+    
+    def dup
+      cloned_object = super
+      cloned_object.clone_fields
+      cloned_object
+    end
+
+    # You can override clone_fields in your class to do deep clone in place.
+    # As it is, all Arrays and Hashes are deep cloned.
+    def clone_fields
+      instance_variables.each do |variable|
+        value = instance_variable_get(variable)
+        if value.kind_of?(Array) or value.kind_of?(Hash) or value.kind_of?(DeepClonable::InstanceMethods)
+          instance_variable_set(variable, value.clone)
+        end
+      end
+    end
+  end
+
+  module ClassMethods
+    # Use this to define cloning version of the given in-place methods.
+    #
+    # This method supports a common idiom where you create in-place and 
+    # cloning versions of most operations. This method allows you to 
+    # define only the in-place version (with the trailing bang (!),
+    # that part is important) and specify the cloning versions by name
+    # using this method.
+    def clone_method(clone_method_name, method_name = nil)
+      clone_method_name = clone_method_name.to_s.gsub(/\!$/,'')
+      method_name ||= "#{clone_method_name}!"
+      class_eval %{
+        def #{clone_method_name}(*args)
+          object = self.clone
+          object.#{method_name}(*args)
+          if block_given?
+            yield object
+          else
+            object
+          end
+        end
+      }
+    end
+  end
+end

data/test/deep_clonable_test.rb

@@ -0,0 +1,41 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class TestClass
+  deep_clonable
+  
+  attr_reader :num
+  
+  def initialize(n)
+    @num = n
+  end
+  
+  clone_method :+, :add!
+  def add!(other)
+    @num += other.num
+  end
+
+  clone_method :invert
+  def invert!
+    @num = -(@num)
+  end
+end
+
+class DeepClonableTest < Test::Unit::TestCase
+  should 'clone method' do
+    a = TestClass.new(10)
+    b = a.invert
+    
+    assert_equal 10,  a.num
+    assert_equal 10, -b.num
+  end
+
+  should 'clone method with rename' do
+    a = TestClass.new(10)
+    b = TestClass.new(20)
+    c = a + b
+    
+    assert_equal 30, c.num
+    assert_equal 20, b.num
+    assert_equal 10, a.num
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib/')
+require 'deep_clonable'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: deep_clonable
+version: !ruby/object:Gem::Version 
+  version: 1.0.2
+platform: ruby
+authors: 
+- Justin Balthrop
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-13 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: "\tAdd support for deep cloning to objects"
+email: code@justinbalthrop.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- deep_clonable.gemspec
+- lib/deep_clonable.rb
+- test/deep_clonable_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/ninjudd/deep_clonable
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Add support for deep cloning to objects
+test_files: 
+- test/deep_clonable_test.rb
+- test/test_helper.rb