deep_cloneable 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Reinier de Lange
+
+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,58 @@
+= Deep_cloneable
+
+This gem gives every ActiveRecord::Base object the possibility to do a deep clone. It is a rails3 upgrade of the deep_cloning plugin (http://github.com/openminds/deep_cloning).
+
+== Requirements
+
+* Activerecord, tested with Rails 3.
+
+== Installation
+ 
+* Install by adding the gem to your Gemfile
+
+  gem 'deep_cloneable'
+ 
+* Rails 2:
+
+  gem install deep_cloneable
+
+And include the gem in your apps config
+
+  config.gem 'deep_cloneable'
+
+* Or install as a plugin if you must:
+
+  ./script/plugin install git://github.com/moiristo/deep_cloneable.git
+
+== Example
+
+=== Cloning a model without an attribute
+   pirate.clone :except => :name
+ 
+=== Cloning a model without multiple attributes
+   pirate.clone :except => [:name, :nick_name]
+=== Cloning one single association
+   pirate.clone :include => :mateys
+
+=== Cloning multiple associations
+   pirate.clone :include => [:mateys, :treasures]
+
+=== Cloning really deep
+   pirate.clone :include => {:treasures => :gold_pieces}
+
+=== Cloning really deep with multiple associations
+   pirate.clone :include => [:mateys, {:treasures => :gold_pieces}]
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Reinier de Lange. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "deep_cloneable"
+    gem.summary = %Q{This gem gives every ActiveRecord::Base object the possibility to do a deep clone.}
+    gem.description = %Q{Extends the functionality of ActiveRecord::Base#clone to perform a deep clone that includes user specified associations. }
+    gem.email = "r.j.delange@nedforce.nl"
+    gem.homepage = "http://github.com/moiristo/deep_cloneable"
+    gem.authors = ["Reinier de Lange"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "deep_cloneable #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/deep_cloneable.gemspec

@@ -0,0 +1,55 @@
+# 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_cloneable}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Reinier de Lange"]
+  s.date = %q{2010-10-18}
+  s.description = %q{Extends the functionality of ActiveRecord::Base#clone to perform a deep clone that includes user specified associations. }
+  s.email = %q{r.j.delange@nedforce.nl}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "deep_cloneable.gemspec",
+     "init.rb",
+     "lib/deep_cloneable.rb",
+     "test/database.yml",
+     "test/schema.rb",
+     "test/test_deep_cloneable.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/moiristo/deep_cloneable}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{This gem gives every ActiveRecord::Base object the possibility to do a deep clone.}
+  s.test_files = [
+    "test/schema.rb",
+     "test/test_deep_cloneable.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::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/init.rb

@@ -0,0 +1 @@
+require 'deep_cloneable'

data/lib/deep_cloneable.rb

@@ -0,0 +1,57 @@
+class ActiveRecord::Base
+  module DeepCloneable
+    # clones an ActiveRecord model. 
+    # if passed the :include option, it will deep clone the given associations
+    # if passed the :except option, it won't clone the given attributes
+    #
+    # === Usage:
+    # 
+    # ==== Cloning a model without an attribute
+    #   pirate.clone :except => :name
+    # 
+    # ==== Cloning a model without multiple attributes
+    #   pirate.clone :except => [:name, :nick_name]
+    # ==== Cloning one single association
+    #   pirate.clone :include => :mateys
+    #
+    # ==== Cloning multiple associations
+    #   pirate.clone :include => [:mateys, :treasures]
+    #
+    # ==== Cloning really deep
+    #   pirate.clone :include => {:treasures => :gold_pieces}
+    #
+    # ==== Cloning really deep with multiple associations
+    #   pirate.clone :include => [:mateys, {:treasures => :gold_pieces}]
+    # 
+    def clone(options = {})
+      kopy = super()
+    
+      if options[:except]
+        Array(options[:except]).each do |attribute|
+          kopy.send(:write_attribute, attribute, attributes_from_column_definition[attribute.to_s])
+        end
+      end
+    
+      if options[:include]
+        Array(options[:include]).each do |association, deep_associations|
+          if (association.kind_of? Hash)
+            deep_associations = association[association.keys.first]
+            association = association.keys.first
+          end
+          opts = deep_associations.blank? ? {} : {:include => deep_associations}
+          cloned_object = case self.class.reflect_on_association(association).macro
+                          when :belongs_to, :has_one
+                            self.send(association) && self.send(association).clone(opts)
+                          when :has_many, :has_and_belongs_to_many
+                            self.send(association).collect { |obj| obj.clone(opts) }
+                          end
+          kopy.send("#{association}=", cloned_object)
+        end
+      end
+
+      return kopy
+    end
+  end
+  
+  include DeepCloneable
+end

data/test/database.yml

@@ -0,0 +1,6 @@
+sqlite: 
+  adapter: sqlite 
+  database: ":memory:"
+sqlite3: 
+  adapter: sqlite3 
+  database: ":memory:"

data/test/schema.rb

@@ -0,0 +1,26 @@
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :pirates, :force => true do |t|
+    t.column :name, :string
+    t.column :nick_name, :string, :default => 'no nickname'
+    t.column :age, :string
+  end
+  
+  create_table :parrots, :force => true do |t|
+    t.column :name, :string
+    t.column :pirate_id, :integer
+  end
+  
+  create_table :mateys, :force => true do |t|
+    t.column :name, :string
+    t.column :pirate_id, :integer
+  end
+  
+  create_table :treasures, :force => true do |t|
+    t.column :found_at, :string
+    t.column :pirate_id, :integer
+  end
+  
+  create_table :gold_pieces, :force => true do |t|
+    t.column :treasure_id, :integer
+  end
+end

data/test/test_deep_cloneable.rb

@@ -0,0 +1,71 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class TestDeepCloneable < Test::Unit::TestCase
+  load_schema
+
+  def setup
+    @jack  = Pirate.create(:name => 'Jack Sparrow', :nick_name => 'Captain Jack', :age => 30)
+    @polly = Parrot.create(:name => 'Polly', :pirate => @jack)
+    @john = Matey.create(:name => 'John', :pirate => @jack)
+    @treasure = Treasure.create(:found_at => 'Isla del Muerte', :pirate => @jack)
+    @gold_piece = GoldPiece.create(:treasure => @treasure)
+  end
+
+  def test_single_clone_exception
+    clone = @jack.clone(:except => :name)
+    assert clone.save
+    assert_equal @jack.name, @jack.clone.name # Old behaviour
+    assert_nil clone.name
+    assert_equal @jack.nick_name, clone.nick_name
+  end
+  
+  def test_multiple_clone_exception
+    clone = @jack.clone(:except => [:name, :nick_name])
+    assert clone.save
+    assert_nil clone.name
+    assert_equal 'no nickname', clone.nick_name
+    assert_equal @jack.age, clone.age
+  end
+  
+  def test_single_include_association
+    clone = @jack.clone(:include => :mateys)
+    assert clone.save
+    assert_equal 1, clone.mateys.size
+  end
+  
+  def test_multiple_include_association
+    clone = @jack.clone(:include => [:mateys, :treasures])
+    assert clone.save
+    assert_equal 1, clone.mateys.size
+    assert_equal 1, clone.treasures.size
+  end
+  
+  def test_deep_include_association
+    clone = @jack.clone(:include => {:treasures => :gold_pieces})
+    assert clone.save
+    assert_equal 1, clone.treasures.size
+    assert_equal 1, clone.gold_pieces.size
+  end
+  
+  def test_multiple_and_deep_include_association
+    clone = @jack.clone(:include => {:treasures => :gold_pieces, :mateys => {}})
+    assert clone.save
+    assert_equal 1, clone.treasures.size
+    assert_equal 1, clone.gold_pieces.size
+    assert_equal 1, clone.mateys.size
+  end
+  
+  def test_multiple_and_deep_include_association_with_array
+    clone = @jack.clone(:include => [{:treasures => :gold_pieces}, :mateys])
+    assert clone.save
+    assert_equal 1, clone.treasures.size
+    assert_equal 1, clone.gold_pieces.size
+    assert_equal 1, clone.mateys.size
+  end
+  
+  def test_with_belongs_to_relation
+    clone = @jack.clone(:include => :parrot)
+    assert clone.save
+    assert_not_equal clone.parrot, @jack.parrot
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'test/unit'
+require 'pp'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+Gem.activate 'activerecord'
+require 'active_record'
+require 'active_record/fixtures'
+require File.dirname(__FILE__) + '/../init.rb'
+
+class GoldPiece < ActiveRecord::Base; belongs_to :treasure end
+class Matey < ActiveRecord::Base; belongs_to :pirate end
+class Parrot < ActiveRecord::Base; belongs_to :pirate end
+
+class Pirate < ActiveRecord::Base
+  has_many :mateys
+  has_many :treasures
+  has_many :gold_pieces, :through => :treasures
+  has_one :parrot
+end
+
+class Treasure < ActiveRecord::Base
+  belongs_to :pirate  
+  has_many :gold_pieces
+end
+
+def load_schema
+  config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+  ActiveRecord::Base.logger = ActiveSupport::BufferedLogger.new(File.dirname(__FILE__) + "/debug.log")
+  db_adapter = ENV['DB']
+  # no db passed, try one of these fine config-free DBs before bombing.
+  db_adapter ||= begin
+    require 'rubygems'
+    require 'sqlite'
+    'sqlite'
+  rescue MissingSourceFile
+    begin
+      require 'sqlite3'
+      'sqlite3'
+    rescue MissingSourceFile
+    end
+  end
+
+  if db_adapter.nil?
+    raise "No DB Adapter selected. Pass the DB= option to pick one, or install Sqlite or Sqlite3."
+  end
+  ActiveRecord::Base.establish_connection(config[db_adapter])
+  load(File.dirname(__FILE__) + "/schema.rb")
+end 

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: deep_cloneable
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Reinier de Lange
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-18 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: "Extends the functionality of ActiveRecord::Base#clone to perform a deep clone that includes user specified associations. "
+email: r.j.delange@nedforce.nl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- deep_cloneable.gemspec
+- init.rb
+- lib/deep_cloneable.rb
+- test/database.yml
+- test/schema.rb
+- test/test_deep_cloneable.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/moiristo/deep_cloneable
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: This gem gives every ActiveRecord::Base object the possibility to do a deep clone.
+test_files: 
+- test/schema.rb
+- test/test_deep_cloneable.rb
+- test/test_helper.rb