deep_cloneable 2.3.0 → 3.1.0

data/lib/deep_cloneable/skip_validations.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module DeepCloneable
+  module SkipValidations
+    def perform_validations(options = {})
+      options[:validate] = false
+      super(options)
+    end
+  end
+end

data/lib/deep_cloneable/version.rb

@@ -0,0 +1,3 @@
+module DeepCloneable
+  VERSION = '3.1.0'
+end

data/readme.md

@@ -6,25 +6,35 @@ This gem gives every ActiveRecord::Base object the possibility to do a deep clon
 
 ## Requirements
 
-* Ruby 1.8.7, 1.9.2, 1.9.3, 2.0.0, 2.1.5, 2.2.2, 2.3.0 (tested)
-* Activerecord 3.1, 3.2, 4.0, 4.1, 4.2, 5.0.0.1 (tested)
-* Rails 2.x/3.0 users, please check out the 'rails2.x-3.0' branch
+- Ruby 1.9.3, 2.0.0, 2.1.5, 2.2.2, 2.3.0, 2.4.4, 2.5.5, 2.6.3 (tested)
+- TruffleRuby 20.2.0
+- Activerecord 3.1, 3.2, 4.0, 4.1, 4.2, 5.0, 5.1, 5.2, 6.0 (tested)
+- Rails 2.x/3.0 users, please check out the 'rails2.x-3.0' branch
 
 ## Installation
 
-* Add deep_cloneable to your Gemfile:
+- Add deep_cloneable to your Gemfile:
 
 ```ruby
-gem 'deep_cloneable', '~> 2.3.0'
+gem 'deep_cloneable', '~> 3.1.0'
 ```
 
-## Upgrading from v1
+## Upgrade details
+
+### Upgrading from v2
+
+There are two breaking changes that you might need to pay attention to:
+
+- When using an optional block (see below), the block used to be evaluated before `deep_cloneable` had performed its changes (inclusions, exclusions, includes). In v3, the block is evaluated after all processing has been done, just before the copy is about to be returned.
+- When a defined association is not found, `deep_cloneable` raises an exception. The exception class has changed namespace: the class definition used to be `ActiveRecord::Base::DeepCloneable::AssociationNotFoundException` and this has changed to `DeepCloneable::AssociationNotFoundException`.
+
+### Upgrading from v1
 
 The `dup` method with arguments has been replaced in deep_cloneable 2 by the method `deep_clone`. Please update your sources accordingly.
 
 ## Usage
 
-The `deep_clone` method supports a couple options that can be specified by passing an options hash. Without options, the behaviour is the same as ActiveRecord's  [`dup`](http://apidock.com/rails/ActiveRecord/Core/dup) method.
+The `deep_clone` method supports a couple options that can be specified by passing an options hash. Without options, the behaviour is the same as ActiveRecord's [`dup`](http://apidock.com/rails/ActiveRecord/Core/dup) method.
 
 ### Association inclusion
 
@@ -76,6 +86,7 @@ pirate.deep_clone include: [ :mateys, { treasures: [ :matey, :gold_pieces ] } ],
 The `deep_clone` method supports both `except` and `only` for specifying which attributes should be duped:
 
 #### Exceptions
+
 ```ruby
 # Single exception
 pirate.deep_clone except: :name
@@ -88,6 +99,7 @@ pirate.deep_clone include: :parrot, except: [ :name, { parrot: [ :name ] } ]
 ```
 
 #### Inclusions
+
 ```ruby
 # Single attribute inclusion
 pirate.deep_clone only: :name
@@ -100,6 +112,19 @@ pirate.deep_clone include: :parrot, only: [ :name, { parrot: [ :name ] } ]
 
 ```
 
+### Pre- and postprocessor
+
+You can specify a pre- and/or a postprocessor to modify a duped object after duplication:
+
+```ruby
+pirate.deep_clone(include: :parrot, preprocessor: ->(original, kopy) { kopy.cloned_from_id = original.id if kopy.respond_to?(:cloned_from_id) })
+pirate.deep_clone(include: :parrot, postprocessor: ->(original, kopy) { kopy.cloned_from_id = original.id if kopy.respond_to?(:cloned_from_id) })
+```
+
+_Note_: Specifying a postprocessor is essentially the same as specifying an optional block (see below).
+
+_Note_: Using `deep_clone` with a processors will pass all associated objects that are being cloned to the processor, so be sure to check whether the object actually responds to your method of choice.
+
 ### Optional Block
 
 Pass a block to `deep_clone` to modify a duped object after duplication:
@@ -110,22 +135,94 @@ pirate.deep_clone include: :parrot do |original, kopy|
 end
 ```
 
-*Note*: Using `deep_clone` with a block will also pass the associated objects that are being cloned to the block, so be sure to check whether the object actually responds to your method of choice.
+_Note_: Using `deep_clone` with a block will also pass the associated objects that are being cloned to the block, so be sure to check whether the object actually responds to your method of choice.
 
-### Cloning models with files associated through Carrierwave
+### Cloning models with files
+
+#### Carrierwave
 
 If you are cloning models that have associated files through Carrierwave these will not get transferred automatically. To overcome the issue you need to explicitly set the file attribute.
 
 Easiest solution is to add the code in a clone block as described above.
+
 ```ruby
 pirate.deep_clone include: :parrot do |original, kopy|
   kopy.thumbnail = original.thumbnail
 end
 ```
 
+#### ActiveStorage
+
+For ActiveStorage, you have two options: you can either make a full copy, or share data blobs between two records.
+
+##### Full copy example
+
+```ruby
+# Rails 5.2, has_one_attached example 1
+pirate.deep_clone include: [:parrot, :avatar_attachment, :avatar_blob]
+
+# Rails 5.2, has_one_attached example 2
+pirate.deep_clone include: :parrot do |original, kopy|
+  if kopy.is_a?(Pirate) && original.avatar.attached?
+    attachment = original.avatar
+    kopy.avatar.attach \
+      :io           => StringIO.new(attachment.download),
+      :filename     => attachment.filename,
+      :content_type => attachment.content_type
+  end
+end
+
+# Rails 5.2, has_many_attached example 1 (attach one by one)
+pirate.deep_clone include: :parrot do |original, kopy|
+  if kopy.is_a?(Pirate) && original.crew_members_images.attached?
+    original.crew_members_images.each do |attachment|
+      kopy.crew_members_images.attach \
+        :io           => StringIO.new(attachment.download),
+        :filename     => attachment.filename,
+        :content_type => attachment.content_type
+    end
+  end
+end
+
+# Rails 5.2, has_many_attached example 2 (attach bulk)
+pirate.deep_clone include: :parrot do |original, kopy|
+  if kopy.is_a?(Pirate) && original.crew_members_images.attached?
+    all_attachments_arr = original.crew_members_images.map do |attachment|
+      {
+        :io           => StringIO.new(attachment.download),
+        :filename     => attachment.filename,
+        :content_type => attachment.content_type
+      }
+    end
+    kopy.crew_members_images.attach(all_attachments_arr) # attach all at once
+  end
+end
+
+# Rails 6
+pirate.deep_clone include: :parrot do |original, kopy|
+  if kopy.is_a?(Pirate) && original.avatar.attached?
+    original.avatar.open do |tempfile|
+      kopy.avatar.attach({
+        io: File.open(tempfile.path),
+        filename: original.avatar.blob.filename,
+        content_type: original.avatar.blob.content_type
+      })
+    end
+  end
+end
+```
+
+##### Shallow copy example
+
+```ruby
+pirate.deep_clone include: :parrot do |original, kopy|
+  kopy.avatar.attach(original.avatar.blob) if kopy.is_a?(Pirate) && original.avatar.attached?
+end
+```
+
 ### Skipping missing associations
 
-By default, deep_cloneable will throw a `ActiveRecord::Base::DeepCloneable::AssociationNotFoundException` error when an association cannot be found. You can also skip missing associations by specifying `skip_missing_associations` if needed, for example when you have associations on some (but not all) subclasses of an STI model:
+By default, deep_cloneable will throw a `DeepCloneable::AssociationNotFoundException` error when an association cannot be found. You can also skip missing associations by specifying `skip_missing_associations` if needed, for example when you have associations on some (but not all) subclasses of an STI model:
 
 ```ruby
 pirate.deep_clone include: [:parrot, :rum], skip_missing_associations: true
@@ -133,14 +230,14 @@ pirate.deep_clone include: [:parrot, :rum], skip_missing_associations: true
 
 ### 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
+- 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.
+- 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.
+- Send me a pull request. Bonus points for topic branches.
 
 ### Copyright
 
-Copyright © 2017 Reinier de Lange. See LICENSE for details.
+Copyright © 2021 Reinier de Lange. See LICENSE for details.

metadata

@@ -1,78 +1,62 @@
 --- !ruby/object:Gem::Specification
 name: deep_cloneable
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Reinier de Lange
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-06-14 00:00:00.000000000 Z
+date: 2021-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 5.2.0
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 5.2.0
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
 description: 'Extends the functionality of ActiveRecord::Base#dup to perform a deep
   clone that includes user specified associations. '
-email: r.j.delange@nedforce.nl
+email: rjdelange@icloud.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE
-- readme.md
 files:
-- ".document"
-- ".travis.yml"
 - Appraisals
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - Rakefile
-- VERSION
 - deep_cloneable.gemspec
-- gemfiles/3.1.gemfile
-- gemfiles/3.1.gemfile.lock
-- gemfiles/3.2.gemfile
-- gemfiles/3.2.gemfile.lock
-- gemfiles/4.0.gemfile
-- gemfiles/4.0.gemfile.lock
-- gemfiles/4.1.gemfile
-- gemfiles/4.1.gemfile.lock
-- gemfiles/4.2.gemfile
-- gemfiles/4.2.gemfile.lock
-- gemfiles/5.0.gemfile
-- gemfiles/5.0.gemfile.lock
 - init.rb
 - lib/deep_cloneable.rb
+- lib/deep_cloneable/association_not_found_exception.rb
+- lib/deep_cloneable/deep_clone.rb
+- lib/deep_cloneable/skip_validations.rb
+- lib/deep_cloneable/version.rb
 - readme.md
-- test/database.yml
-- test/models.rb
-- test/schema.rb
-- test/test_deep_cloneable.rb
-- test/test_helper.rb
-homepage: http://github.com/moiristo/deep_cloneable
+homepage: https://github.com/moiristo/deep_cloneable
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -80,16 +64,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: This gem gives every ActiveRecord::Base object the possibility to do a deep
   clone.

data/.document

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

data/.travis.yml

@@ -1,50 +0,0 @@
-language: ruby
-
-sudo: false
-cache: bundler
-
-rvm:
-  - 1.8.7
-  - 1.9.2
-  - 1.9.3
-  - 2.0.0
-  - 2.1.5
-  - 2.2.2
-  - 2.3.0
-
-gemfile:
-  - gemfiles/3.1.gemfile
-  - gemfiles/3.2.gemfile
-  - gemfiles/4.0.gemfile
-  - gemfiles/4.1.gemfile
-  - gemfiles/4.2.gemfile
-  - gemfiles/5.0.gemfile
-
-matrix:
-  exclude:
-    - rvm: 1.8.7
-      gemfile: gemfiles/4.0.gemfile
-    - rvm: 1.8.7
-      gemfile: gemfiles/4.1.gemfile
-    - rvm: 1.8.7
-      gemfile: gemfiles/4.2.gemfile
-    - rvm: 1.8.7
-      gemfile: gemfiles/5.0.gemfile
-    - rvm: 1.9.2
-      gemfile: gemfiles/4.0.gemfile
-    - rvm: 1.9.2
-      gemfile: gemfiles/4.1.gemfile
-    - rvm: 1.9.2
-      gemfile: gemfiles/4.2.gemfile
-    - rvm: 1.9.2
-      gemfile: gemfiles/5.0.gemfile
-    - rvm: 1.9.3
-      gemfile: gemfiles/5.0.gemfile
-    - rvm: 2.0.0
-      gemfile: gemfiles/5.0.gemfile
-    - rvm: 2.1.5
-      gemfile: gemfiles/5.0.gemfile
-    - rvm: 2.2.2
-      gemfile: gemfiles/3.1.gemfile
-    - rvm: 2.3.0
-      gemfile: gemfiles/3.1.gemfile

data/VERSION

@@ -1 +0,0 @@
-2.3.0

data/gemfiles/3.1.gemfile

@@ -1,20 +0,0 @@
-# This file was generated by Appraisal
-
-source "http://rubygems.org"
-
-gem "activerecord", "~> 3.1.0"
-gem "i18n", "~> 0.6.5", :group => :test
-gem "highline", "~> 1.6.0", :group => :test
-gem "rake", "~> 10.4", :group => :test
-gem "rack", "~> 1.6", :group => :test
-gem "git", "~> 1.2.9", :group => :test
-gem "minitest", :group => :test
-gem "appraisal", :group => :test
-gem "sqlite3", :group => :test
-gem "rdoc", ">= 2.4.2", :group => :test
-gem "nokogiri", "~> 1.5.0", :group => :test
-gem "addressable", "~> 2.3.8"
-
-group :test do
-  gem "jeweler"
-end

data/gemfiles/3.1.gemfile.lock

@@ -1,86 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    activemodel (3.1.12)
-      activesupport (= 3.1.12)
-      builder (~> 3.0.0)
-      i18n (~> 0.6)
-    activerecord (3.1.12)
-      activemodel (= 3.1.12)
-      activesupport (= 3.1.12)
-      arel (~> 2.2.3)
-      tzinfo (~> 0.3.29)
-    activesupport (3.1.12)
-      multi_json (~> 1.0)
-    addressable (2.3.8)
-    appraisal (2.1.0)
-      bundler
-      rake
-      thor (>= 0.14.0)
-    arel (2.2.3)
-    builder (3.0.4)
-    faraday (0.8.9)
-      multipart-post (~> 1.2.0)
-    git (1.2.9.1)
-    github_api (0.10.1)
-      addressable
-      faraday (~> 0.8.1)
-      hashie (>= 1.2)
-      multi_json (~> 1.4)
-      nokogiri (~> 1.5.2)
-      oauth2
-    hashie (3.4.6)
-    highline (1.6.21)
-    i18n (0.6.11)
-    jeweler (2.1.1)
-      builder
-      bundler (>= 1.0)
-      git (>= 1.2.5)
-      github_api
-      highline (>= 1.6.15)
-      nokogiri (>= 1.5.10)
-      rake
-      rdoc
-      semver
-    json (1.8.3)
-    jwt (1.5.4)
-    minitest (5.9.0)
-    multi_json (1.12.1)
-    multi_xml (0.5.5)
-    multipart-post (1.2.0)
-    nokogiri (1.5.11)
-    oauth2 (1.2.0)
-      faraday (>= 0.8, < 0.10)
-      jwt (~> 1.0)
-      multi_json (~> 1.3)
-      multi_xml (~> 0.5)
-      rack (>= 1.2, < 3)
-    rack (1.6.4)
-    rake (10.5.0)
-    rdoc (4.2.2)
-      json (~> 1.4)
-    semver (1.0.1)
-    sqlite3 (1.3.11)
-    thor (0.19.1)
-    tzinfo (0.3.51)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activerecord (~> 3.1.0)
-  addressable (~> 2.3.8)
-  appraisal
-  git (~> 1.2.9)
-  highline (~> 1.6.0)
-  i18n (~> 0.6.5)
-  jeweler
-  minitest
-  nokogiri (~> 1.5.0)
-  rack (~> 1.6)
-  rake (~> 10.4)
-  rdoc (>= 2.4.2)
-  sqlite3
-
-BUNDLED WITH
-   1.11.2