deep_cloneable 3.0.0 → 3.1.0

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2019 Reinier de Lange
+Copyright (c) 2021 Reinier de Lange
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -1,25 +1,10 @@
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'bundler/setup'
 require 'appraisal'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = 'deep_cloneable'
-    gem.summary = %(This gem gives every ActiveRecord::Base object the possibility to do a deep clone.)
-    gem.description = %(Extends the functionality of ActiveRecord::Base#dup to perform a deep clone that includes user specified associations. )
-    gem.email = 'rjdelange@icloud.com'
-    gem.homepage = 'http://github.com/moiristo/deep_cloneable'
-    gem.authors = ['Reinier de Lange']
-    gem.license = 'MIT'
-    # 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'

data/deep_cloneable.gemspec

@@ -1,79 +1,21 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-# stub: deep_cloneable 3.0.0 ruby lib
+# frozen_string_literal: true
 
-Gem::Specification.new do |s|
-  s.name = "deep_cloneable".freeze
-  s.version = "3.0.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib".freeze]
-  s.authors = ["Reinier de Lange".freeze]
-  s.date = "2019-08-18"
-  s.description = "Extends the functionality of ActiveRecord::Base#dup to perform a deep clone that includes user specified associations. ".freeze
-  s.email = "rjdelange@icloud.com".freeze
-  s.extra_rdoc_files = [
-    "LICENSE"
-  ]
-  s.files = [
-    ".document",
-    ".rubocop.yml",
-    ".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",
-    "gemfiles/5.1.gemfile",
-    "gemfiles/5.1.gemfile.lock",
-    "gemfiles/5.2.gemfile",
-    "gemfiles/5.2.gemfile.lock",
-    "gemfiles/6.0.gemfile",
-    "gemfiles/6.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",
-    "readme.md",
-    "test/database.yml",
-    "test/models.rb",
-    "test/schema.rb",
-    "test/test_deep_cloneable.rb",
-    "test/test_helper.rb"
-  ]
-  s.homepage = "http://github.com/moiristo/deep_cloneable".freeze
-  s.licenses = ["MIT".freeze]
-  s.rubygems_version = "3.0.2".freeze
-  s.summary = "This gem gives every ActiveRecord::Base object the possibility to do a deep clone.".freeze
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
+$:.unshift File.expand_path('../lib', __FILE__)
+require 'deep_cloneable/version'
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<activerecord>.freeze, [">= 3.1.0", "< 7"])
-    else
-      s.add_dependency(%q<activerecord>.freeze, [">= 3.1.0", "< 7"])
-    end
-  else
-    s.add_dependency(%q<activerecord>.freeze, [">= 3.1.0", "< 7"])
-  end
+Gem::Specification.new do |s|
+  s.name = 'deep_cloneable'
+  s.version = DeepCloneable::VERSION
+  s.authors = ['Reinier de Lange']
+  s.description = 'Extends the functionality of ActiveRecord::Base#dup to perform a deep clone that includes user specified associations. '
+  s.summary = 'This gem gives every ActiveRecord::Base object the possibility to do a deep clone.'
+  s.email = 'rjdelange@icloud.com'
+  s.extra_rdoc_files = ['LICENSE']
+  s.files = Dir.glob('{bin/*,lib/**/*,[A-Z]*}')
+  s.homepage = 'https://github.com/moiristo/deep_cloneable'
+  s.licenses = ['MIT']
+  s.platform = Gem::Platform::RUBY
+  s.required_ruby_version = '>= 1.9.3'
+  s.require_paths = ['lib']
+  s.add_runtime_dependency('activerecord', ['>= 3.1.0', '< 7'])
 end
-

data/init.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'deep_cloneable'

data/lib/deep_cloneable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_record'
 require 'active_support/lazy_load_hooks'
 require 'active_support/core_ext/array/wrap'

data/lib/deep_cloneable/association_not_found_exception.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DeepCloneable
   class AssociationNotFoundException < StandardError
   end

data/lib/deep_cloneable/deep_clone.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DeepCloneable
   module DeepClone
     # Deep dups an ActiveRecord model. See README.rdoc
@@ -5,7 +7,7 @@ module DeepCloneable
       options = args[0] || {}
 
       dictionary = options[:dictionary]
-      dictionary ||= {} if options.delete(:use_dictionary)
+      dictionary ||= {} if options[:use_dictionary]
 
       kopy = if dictionary
                find_in_dictionary_or_dup(dictionary)
@@ -13,6 +15,8 @@ module DeepCloneable
                dup
              end
 
+      options[:preprocessor].call(self, kopy) if options.key?(:preprocessor)
+
       deep_exceptions = {}
       if options[:except]
         exceptions = Array.wrap(options[:except])
@@ -44,13 +48,21 @@ module DeepCloneable
             association = association.keys.first
           end
 
-          if conditions_or_deep_associations.is_a?(Hash)
+          case conditions_or_deep_associations
+          when Hash
             conditions_or_deep_associations = conditions_or_deep_associations.dup
             conditions[:if]     = conditions_or_deep_associations.delete(:if)     if conditions_or_deep_associations[:if]
             conditions[:unless] = conditions_or_deep_associations.delete(:unless) if conditions_or_deep_associations[:unless]
-          elsif conditions_or_deep_associations.is_a?(Array)
-            conditions_or_deep_associations = conditions_or_deep_associations.dup
-            conditions_or_deep_associations.delete_if { |entry| conditions.merge!(entry) if entry.is_a?(Hash) && (entry.key?(:if) || entry.key?(:unless)) }
+          when Array
+            conditions_or_deep_associations = conditions_or_deep_associations.map { |entry| entry.is_a?(Hash) ? entry.dup : entry }
+            conditions_or_deep_associations.each_with_index do |entry, index|
+              if entry.is_a?(Hash)
+                conditions[:if] = entry.delete(:if) if entry[:if]
+                conditions[:unless] = entry.delete(:unless) if entry[:unless]
+              end
+
+              conditions_or_deep_associations.delete_at(index) if entry.empty?
+            end
           end
 
           dup_options = {}
@@ -59,7 +71,7 @@ module DeepCloneable
           dup_options[:only] = deep_onlinesses[association] if deep_onlinesses[association]
           dup_options[:dictionary] = dictionary if dictionary
 
-          [:skip_missing_associations, :validate].each do |option|
+          [:skip_missing_associations, :validate, :preprocessor, :postprocessor].each do |option|
             dup_options[option] = options[option] if options.key?(option)
           end
 
@@ -81,6 +93,7 @@ module DeepCloneable
       end
 
       yield(self, kopy) if block
+      options[:postprocessor].call(self, kopy) if options.key?(:postprocessor)
 
       kopy
     end

data/lib/deep_cloneable/skip_validations.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DeepCloneable
   module SkipValidations
     def perform_validations(options = {})

data/lib/deep_cloneable/version.rb

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

data/readme.md

@@ -6,16 +6,17 @@ This gem gives every ActiveRecord::Base object the possibility to do a deep clon
 
 ## Requirements
 
-* Ruby 1.9.3, 2.0.0, 2.1.5, 2.2.2, 2.3.0, 2.4.4, 2.5.5 (tested)
-* 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
+- 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', '~> 3.0.0'
+gem 'deep_cloneable', '~> 3.1.0'
 ```
 
 ## Upgrade details
@@ -24,8 +25,8 @@ gem 'deep_cloneable', '~> 3.0.0'
 
 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`.
+- 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
 
@@ -33,7 +34,7 @@ The `dup` method with arguments has been replaced in deep_cloneable 2 by the met
 
 ## 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
 
@@ -85,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
@@ -97,6 +99,7 @@ pirate.deep_clone include: :parrot, except: [ :name, { parrot: [ :name ] } ]
 ```
 
 #### Inclusions
+
 ```ruby
 # Single attribute inclusion
 pirate.deep_clone only: :name
@@ -109,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:
@@ -119,9 +135,7 @@ pirate.deep_clone include: :parrot do |original, kopy|
 end
 ```
 
-*Note*: The block is invoked before attributes are excluded.
-
-*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
 
@@ -130,6 +144,7 @@ end
 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
@@ -143,11 +158,52 @@ For ActiveStorage, you have two options: you can either make a full copy, or sha
 ##### 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?
-    ActiveStorage::Downloader.new(original.avatar).download_blob_to_tempfile do |tempfile|
+    original.avatar.open do |tempfile|
       kopy.avatar.attach({
-        io: tempfile,
+        io: File.open(tempfile.path),
         filename: original.avatar.blob.filename,
         content_type: original.avatar.blob.content_type
       })
@@ -156,7 +212,6 @@ pirate.deep_clone include: :parrot do |original, kopy|
 end
 ```
 
-
 ##### Shallow copy example
 
 ```ruby
@@ -175,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 © 2019 Reinier de Lange. See LICENSE for details.
+Copyright © 2021 Reinier de Lange. See LICENSE for details.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deep_cloneable
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Reinier de Lange
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-08-18 00:00:00.000000000 Z
+date: 2021-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -38,51 +38,25 @@ extensions: []
 extra_rdoc_files:
 - LICENSE
 files:
-- ".document"
-- ".rubocop.yml"
-- ".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
-- gemfiles/5.1.gemfile
-- gemfiles/5.1.gemfile.lock
-- gemfiles/5.2.gemfile
-- gemfiles/5.2.gemfile.lock
-- gemfiles/6.0.gemfile
-- gemfiles/6.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
@@ -90,15 +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: []
-rubygems_version: 3.0.2
-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.