amoeba 3.2.0 → 3.4.0

data/amoeba.gemspec

@@ -1,23 +1,24 @@
 # -*- encoding: utf-8 -*-
-$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
 require 'amoeba/version'
 
 Gem::Specification.new do |s|
   s.name        = 'amoeba'
   s.version     = Amoeba::VERSION
-  s.authors     = ['Vaughn Draughon', 'Oleksandr Simonov']
-  s.email       = 'alex@simonov.me'
+  s.authors     = ['Vaughn Draughon', 'Oleksandr Simonov', 'Joseph Haig']
+  s.email       = 'josephhaig@gmail.com'
   s.homepage    = 'http://github.com/amoeba-rb/amoeba'
-  s.license     = 'BSD'
+  s.license     = 'BSD-2-Clause'
   s.summary     = 'Easy copying of rails models and their child associations.'
+  s.required_ruby_version = '>= 3.0'
 
-  s.description = <<-EOF
-An extension to ActiveRecord to allow the duplication method to also copy associated children, with recursive support for nested of grandchildren. The behavior is controllable with a simple DSL both on your rails models and on the fly, i.e. per instance. Numerous configuration styles and preprocessing directives are included for power and flexibility. Supports preprocessing of field values to prepend strings such as "Copy of ", to nullify or process field values with regular expressions. Supports most association types including has_one :through and has_many :through.
-
-Tags: copy child associations, copy nested children, copy associated child records, nested copy, copy associations, copy relations, copy relationships, duplicate associations, duplicate associated records, duplicate child records, duplicate children, copy all, duplicate all, clone child associations, clone nested children, clone associated child records, nested clone, clone associations, clone relations, clone relationships, cloning child associations, cloning nested children, cloning associated child records, deep_cloning, nested cloning, cloning associations, cloning relations, cloning relationships, cloning child associations, cloning nested children, cloning associated child records, nested cloning, cloning associations, cloning relations, cloning relationships, cloning child associations, cloning nested children, cloning associated child records, deep_cloning, nested cloning, cloning associations, cloning relations, cloning relationships, duplicate child associations, duplicate nested children, duplicate associated child records, nested duplicate, duplicate associations, duplicate relations, duplicate relationships, duplicate child associations, duplicate nested children, duplicate associated child records, deep_duplicate, nested duplicate, duplicate associations, duplicate relations, duplicate relationships, deep_copy, deep_clone, deep_cloning, deep clone, deep cloning, has_one, has_many, has_and_belongs_to_many
-EOF
+  s.description = <<~DESCRIPTION
+    An extension to ActiveRecord to allow the duplication method to also copy associated children, with recursive support for nested of grandchildren. The behavior is controllable with a simple DSL both on your rails models and on the fly, i.e. per instance. Numerous configuration styles and preprocessing directives are included for power and flexibility. Supports preprocessing of field values to prepend strings such as "Copy of ", to nullify or process field values with regular expressions. Supports most association types including has_one :through and has_many :through.
 
-  s.rubyforge_project = 'amoeba'
+    Tags: copy child associations, copy nested children, copy associated child records, nested copy, copy associations, copy relations, copy relationships, duplicate associations, duplicate associated records, duplicate child records, duplicate children, copy all, duplicate all, clone child associations, clone nested children, clone associated child records, nested clone, clone associations, clone relations, clone relationships, cloning child associations, cloning nested children, cloning associated child records, deep_cloning, nested cloning, cloning associations, cloning relations, cloning relationships, cloning child associations, cloning nested children, cloning associated child records, nested cloning, cloning associations, cloning relations, cloning relationships, cloning child associations, cloning nested children, cloning associated child records, deep_cloning, nested cloning, cloning associations, cloning relations, cloning relationships, duplicate child associations, duplicate nested children, duplicate associated child records, nested duplicate, duplicate associations, duplicate relations, duplicate relationships, duplicate child associations, duplicate nested children, duplicate associated child records, deep_duplicate, nested duplicate, duplicate associations, duplicate relations, duplicate relationships, deep_copy, deep_clone, deep_cloning, deep clone, deep cloning, has_one, has_many, has_and_belongs_to_many
+  DESCRIPTION
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -25,15 +26,15 @@ EOF
   s.require_paths = ['lib']
 
   # specify any dependencies here; for example:
-  s.add_development_dependency 'bundler', '>= 1.6.0'
-  s.add_development_dependency 'rspec', '>= 3.0.0'
+  s.add_development_dependency 'rspec', '~> 3.13.0'
+  s.add_development_dependency 'rubocop', '~> 1.71.0'
+  s.add_development_dependency 'rubocop-rake', '~> 0.6.0'
+  s.add_development_dependency 'rubocop-rspec', '~> 2.27.1'
 
   if RUBY_PLATFORM == 'java'
-    s.add_development_dependency 'activerecord-jdbc-adapter', '~> 61.0'
-    s.add_development_dependency 'activerecord-jdbcsqlite3-adapter', '~> 61.0'
-  else
-    s.add_development_dependency 'sqlite3', '>= 1.3'
+    s.add_development_dependency 'activerecord-jdbc-adapter', '= 70.1'
+    s.add_development_dependency 'activerecord-jdbcsqlite3-adapter', '= 70.1'
   end
 
-  s.add_dependency 'activerecord', '>= 4.2.0'
+  s.add_dependency 'activerecord', '>= 6.1.0'
 end

data/docs/contributing.md

@@ -0,0 +1,19 @@
+# Contributing to Amoeba
+
+Contributations to this project are welcome. The current needs are;
+
+* More structured documentation
+* [Refactoring tests](test_refactor.md)
+* Identifying and prioritising features that could be implemented from the long list of issues
+* Reviewing of pull requests
+
+## Some notes regarding pull requests
+
+When making code changes please include unit tests for any new code and ensure that all tests pass for supported versions of Ruby and Active Record. These tests are run automatically.
+
+Note that the tests are also run automatically for the current development branches of Ruby and Active Record. It is not necessary for all tests to pass in these cases and they are set up to always report as a success to avoid causing the whole pipeline to appear as failed[^1]. However;
+
+* Please try at least for new tests in the PR to pass unless there is an identifiable issue in the development version of either Ruby or Active Record.
+* For any new failures you see please consider raising an issue to have it fixed.
+
+[^1]: See [this issue](https://github.com/actions/runner/issues/2347) and [this discussion](https://github.com/orgs/community/discussions/15452) for a long-running discussion on the missing "allow failure" feature in Github Actions.

data/docs/test_refactor.md

@@ -0,0 +1,20 @@
+# Test refactor
+
+## Motivation
+
+This gem has been unmaintained for some time but is still used. This could
+cause problems if it becomes incompatible with new versions of Active Record.
+Additionally, there are lots of issues that have been raised and there could be
+other features of Active Record that should be supported. However, the tests
+not easy to understand as they generally comprise a large setup of data
+followed by multiple expectations with no indication of their purpose. A better
+structure for the tests would allow for making changes with more confidence.
+
+## Plan
+
+All of the tests are currently in `spec/lib/amoeba_spec.rb`. New tests will be
+created to mimic the modules so, for example;
+
+* `spec/lib/amoeba/cloner_spec.rb` to test the `Amoeba::Cloner` class.
+* `spec/lib/amoeba/macros/has_many_spec.rb` to test the
+  `Amoeba::Macros::HasMany` module.

data/gemfiles/activerecord_6.1.gemfile

@@ -1,18 +1,27 @@
+# frozen_string_literal: true
+
 # This file was generated by Appraisal
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "activerecord", "~> 6.1.0"
+gem 'activerecord', '~> 6.1.0'
+gem 'base64'
+gem 'benchmark'
+gem 'bigdecimal'
+gem 'concurrent-ruby', '<= 1.3.4'
+gem 'logger'
+gem 'mutex_m'
 
 group :development, :test do
-  gem "rake"
-  gem "coveralls", require: false
-  gem "sqlite3", "~> 1.4.0"
+  gem 'rake'
+  gem 'simplecov', '~> 0.21.2'
+  gem 'simplecov-lcov', '~> 0.8.0'
+  gem 'sqlite3', '~> 1.6.0'
 end
 
 group :local_development do
-  gem "pry"
-  gem "appraisal"
+  gem 'appraisal'
+  gem 'pry'
 end
 
-gemspec path: "../"
+gemspec path: '../'

data/gemfiles/activerecord_7.0.gemfile

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# This file was generated by Appraisal
+
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 7.0.0'
+gem 'concurrent-ruby', '<= 1.3.4'
+
+group :development, :test do
+  gem 'rake'
+  gem 'simplecov', '~> 0.21.2'
+  gem 'simplecov-lcov', '~> 0.8.0'
+  gem 'sqlite3', '~> 1.6.0'
+end
+
+group :local_development do
+  gem 'appraisal'
+  gem 'pry'
+end
+
+gemspec path: '../'

data/gemfiles/activerecord_7.1.gemfile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# This file was generated by Appraisal
+
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 7.1.0'
+
+group :development, :test do
+  gem 'rake'
+  gem 'simplecov', '~> 0.21.2'
+  gem 'simplecov-lcov', '~> 0.8.0'
+  gem 'sqlite3', '~> 1.6.0'
+end
+
+group :local_development do
+  gem 'appraisal'
+  gem 'pry'
+end
+
+gemspec path: '../'

data/gemfiles/activerecord_8.0.gemfile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# This file was generated by Appraisal
+
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 8.0.0'
+
+group :development, :test do
+  gem 'rake'
+  gem 'simplecov', '~> 0.21.2'
+  gem 'simplecov-lcov', '~> 0.8.0'
+  gem 'sqlite3', '~> 2.1.0'
+end
+
+group :local_development do
+  gem 'appraisal'
+  gem 'pry'
+end
+
+gemspec path: '../'

data/gemfiles/activerecord_8.1.gemfile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# This file was generated by Appraisal
+
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 8.1.0'
+
+group :development, :test do
+  gem 'rake'
+  gem 'simplecov', '~> 0.21.2'
+  gem 'simplecov-lcov', '~> 0.8.0'
+  gem 'sqlite3', '~> 2.1.0'
+end
+
+group :local_development do
+  gem 'appraisal'
+  gem 'pry'
+end
+
+gemspec path: '../'

data/gemfiles/activerecord_head.gemfile

@@ -1,24 +1,23 @@
-# This file was generated by Appraisal
+# frozen_string_literal: true
 
-source "https://rubygems.org"
+# This file was generated by Appraisal
 
-git "git://github.com/rails/arel.git" do
-  gem "arel"
-end
+source 'https://rubygems.org'
 
-git "git://github.com/rails/rails.git", branch: "main" do
-  gem "activerecord"
+git 'https://github.com/rails/rails.git', branch: 'main' do
+  gem 'activerecord'
 end
 
 group :development, :test do
-  gem "rake"
-  gem "coveralls", require: false
-  gem "sqlite3", "~> 1.4.0"
+  gem 'rake'
+  gem 'simplecov', '~> 0.21.2'
+  gem 'simplecov-lcov', '~> 0.8.0'
+  gem 'sqlite3', '~> 2.1.0'
 end
 
 group :local_development do
-  gem "pry"
-  gem "appraisal"
+  gem 'appraisal'
+  gem 'pry'
 end
 
-gemspec path: "../"
+gemspec path: '../'

data/gemfiles/jruby_activerecord_7.0.gemfile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# This file was generated by Appraisal
+
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 7.0.0'
+
+group :development, :test do
+  gem 'rake'
+  gem 'simplecov', '~> 0.21.2'
+  gem 'simplecov-lcov', '~> 0.8.0'
+end
+
+group :local_development do
+  gem 'appraisal'
+  gem 'pry'
+end
+
+gemspec path: '../'

data/gemfiles/jruby_activerecord_head.gemfile

@@ -1,28 +1,28 @@
-# This file was generated by Appraisal
+# frozen_string_literal: true
 
-source "https://rubygems.org"
+# This file was generated by Appraisal
 
-git "git://github.com/rails/arel.git" do
-  gem "arel"
-end
+source 'https://rubygems.org'
 
-git "git://github.com/rails/rails.git", branch: "main" do
-  gem "activerecord"
+git 'https://github.com/rails/rails.git', branch: 'main' do
+  gem 'activerecord'
 end
 
 group :development, :test do
-  git "git://github.com/jruby/activerecord-jdbc-adapter" do
-    gem "activerecord-jdbc-adapter"
-    gem "activerecord-jdbcsqlite3-adapter", glob: "activerecord-jdbcsqlite3-adapter/activerecord-jdbcsqlite3-adapter.gemspec"
+  git 'https://github.com/jruby/activerecord-jdbc-adapter' do
+    gem 'activerecord-jdbc-adapter'
+    gem 'activerecord-jdbcsqlite3-adapter',
+        glob: 'activerecord-jdbcsqlite3-adapter/activerecord-jdbcsqlite3-adapter.gemspec'
   end
 
-  gem "rake"
-  gem "coveralls", require: false
+  gem 'rake'
+  gem 'simplecov', '~> 0.21.2'
+  gem 'simplecov-lcov', '~> 0.8.0'
 end
 
 group :local_development do
-  gem "pry"
-  gem "appraisal"
+  gem 'appraisal'
+  gem 'pry'
 end
 
-gemspec path: "../"
+gemspec path: '../'

data/lib/amoeba/class_methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Amoeba
   module ClassMethods
     def amoeba(&block)

data/lib/amoeba/cloner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 
 module Amoeba
@@ -29,7 +31,7 @@ module Amoeba
     private
 
     def parenting_style
-      amoeba.upbringing ? amoeba.upbringing : _parent_amoeba.parenting
+      amoeba.upbringing || _parent_amoeba.parenting
     end
 
     def inherit_strict_parent_settings
@@ -47,9 +49,10 @@ module Amoeba
     end
 
     def inherit_parent_settings
-      return if !_parent_amoeba.inherit
-      return unless %w(strict relaxed submissive).include?(parenting_style.to_s)
-      __send__("inherit_#{parenting_style}_parent_settings".to_sym)
+      return unless _parent_amoeba.inherit
+      return unless %w[strict relaxed submissive].include?(parenting_style.to_s)
+
+      __send__(:"inherit_#{parenting_style}_parent_settings")
     end
 
     def apply_clones
@@ -67,12 +70,14 @@ module Amoeba
       # and old children on the copy
       return unless association.macro == :has_many ||
                     association.is_a?(::ActiveRecord::Reflection::ThroughReflection)
+
       amoeba.exclude_association(association.options[:through])
     end
 
     def follow_only_includes
       amoeba.includes.each do |include, options|
         next if options[:if] && !@old_object.send(options[:if])
+
         follow_association(include, @object_klass.reflect_on_association(include))
       end
     end
@@ -81,6 +86,7 @@ module Amoeba
       @object_klass.reflections.each do |name, association|
         exclude = amoeba.excludes[name.to_sym]
         next if exclude && (exclude.blank? || @old_object.send(exclude[:if]))
+
         follow_association(name, association)
       end
     end
@@ -108,8 +114,9 @@ module Amoeba
 
     def follow_association(relation_name, association)
       return unless amoeba.known_macros.include?(association.macro.to_sym)
+
       follow_klass = ::Amoeba::Macros.list[association.macro.to_sym]
-      follow_klass.new(self).follow(relation_name, association) if follow_klass
+      follow_klass&.new(self)&.follow(relation_name, association)
     end
 
     def process_overrides
@@ -120,7 +127,9 @@ module Amoeba
 
     def process_null_fields
       # nullify any fields the user has configured
-      amoeba.null_fields.each do |field_key|
+      amoeba.null_fields.each do |field_key, options|
+        next if options[:if] && !@old_object.send(options[:if])
+
         @new_object[field_key] = nil
       end
     end

data/lib/amoeba/config.rb

@@ -1,43 +1,27 @@
+# frozen_string_literal: true
+
 module Amoeba
   class Config
     DEFAULTS = {
-      enabled:        false,
-      inherit:        false,
-      do_preproc:     false,
-      parenting:      false,
-      raised:         false,
-      dup_method:     :dup,
-      remap_method:   nil,
-      includes:       {},
-      excludes:       {},
-      clones:         [],
+      enabled: false,
+      inherit: false,
+      do_preproc: false,
+      parenting: false,
+      raised: false,
+      dup_method: :dup,
+      remap_method: nil,
+      includes: {},
+      excludes: {},
+      clones: [],
       customizations: [],
-      overrides:      [],
-      null_fields:    [],
-      coercions:      {},
-      prefixes:       {},
-      suffixes:       {},
-      regexes:        {},
-      known_macros:   [:has_one, :has_many, :has_and_belongs_to_many]
-    }
-
-    # ActiveRecord 3.x have different implementation of deep_dup
-    if ::ActiveRecord::VERSION::MAJOR == 3
-      DEFAULTS.instance_eval do
-        def deep_dup
-          each_with_object(dup) do |(key, value), hash|
-            hash[key.deep_dup] = value.deep_dup
-          end
-        end
-      end
-      Object.class_eval do
-        def deep_dup
-          duplicable? ? dup : self
-        end
-      end
-    end
-
-    DEFAULTS.freeze
+      overrides: [],
+      null_fields: {},
+      coercions: {},
+      prefixes: {},
+      suffixes: {},
+      regexes: {},
+      known_macros: %i[has_one has_many has_and_belongs_to_many]
+    }.freeze
 
     DEFAULTS.each do |key, value|
       value.freeze if value.is_a?(Array) || value.is_a?(Hash)
@@ -53,7 +37,7 @@ module Amoeba
       @config = self.class::DEFAULTS.deep_dup
     end
 
-    alias_method :upbringing, :raised
+    alias upbringing raised
 
     def enable
       @config[:enabled] = true
@@ -110,7 +94,7 @@ module Amoeba
     def include_association(value = nil, options = {})
       enable
       @config[:excludes] = {}
-      value = value.is_a?(Array) ? Hash[value.map! { |v| [v, options] }] : { value => options }
+      value = value.is_a?(Array) ? value.map! { |v| [v, options] }.to_h : { value => options }
       push_value_to_hash(value, :includes)
     end
 
@@ -118,16 +102,10 @@ module Amoeba
       values.flatten.each { |v| include_association(v) }
     end
 
-    # TODO: remove this method in v3.0.0
-    def include_field(value = nil)
-      warn 'include_field is deprecated and will be removed in version 3.0.0; please use include_association instead'
-      include_association(value)
-    end
-
     def exclude_association(value = nil, options = {})
       enable
       @config[:includes] = {}
-      value = value.is_a?(Array) ? Hash[value.map! { |v| [v, options] }] : { value => options }
+      value = value.is_a?(Array) ? value.map! { |v| [v, options] }.to_h : { value => options }
       push_value_to_hash(value, :excludes)
     end
 
@@ -135,12 +113,6 @@ module Amoeba
       values.flatten.each { |v| exclude_association(v) }
     end
 
-    # TODO: remove this method in v3.0.0
-    def exclude_field(value = nil)
-      warn 'exclude_field is deprecated and will be removed in version 3.0.0; please use exclude_association instead'
-      exclude_association(value)
-    end
-
     def clone(value = nil)
       enable
       push_value_to_array(value, :clones)
@@ -151,8 +123,7 @@ module Amoeba
       push_value_to_array(value, :known_macros)
     end
 
-    { override: 'overrides', customize: 'customizations',
-      nullify: 'null_fields' }.each do |method, key|
+    { override: 'overrides', customize: 'customizations' }.each do |method, key|
       class_eval <<-EOS, __FILE__, __LINE__ + 1
         def #{method}(value = nil)             # def override(value = nil)
           @config[:do_preproc] = true          #   @config[:do_preproc] = true
@@ -161,6 +132,12 @@ module Amoeba
       EOS
     end
 
+    def nullify(value = nil, options = {})
+      @config[:do_preproc] = true
+      @config[:null_fields] = {} if value.is_a?(::Array)
+      push_value_to_hash(Array(value).to_h { |field| [field, options] }, :null_fields)
+    end
+
     { set: 'coercions', prepend: 'prefixes',
       append: 'suffixes', regex:   'regexes' }.each do |method, key|
       class_eval <<-EOS, __FILE__, __LINE__ + 1

data/lib/amoeba/instance_methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Amoeba
   module InstanceMethods
     def _parent_amoeba
@@ -10,6 +12,7 @@ module Amoeba
 
     def _first_superclass_with_amoeba
       return @_first_superclass_with_amoeba unless @_first_superclass_with_amoeba.nil?
+
       klass = self.class
       while klass.superclass < ::ActiveRecord::Base
         klass = klass.superclass

data/lib/amoeba/macros/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Amoeba
   module Macros
     class Base
@@ -8,7 +10,7 @@ module Amoeba
       end
 
       def follow(_relation_name, _association)
-        fail "#{self.class.name} doesn't implement `follow`!"
+        raise "#{self.class.name} doesn't implement `follow`!"
       end
 
       class << self
@@ -19,6 +21,7 @@ module Amoeba
 
       def remapped_relation_name(name)
         return name unless @cloner.amoeba.remap_method
+
         @old_object.__send__(@cloner.amoeba.remap_method, name.to_sym) || name
       end
     end

data/lib/amoeba/macros/has_and_belongs_to_many.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Amoeba
   module Macros
     class HasAndBelongsToMany < ::Amoeba::Macros::Base

data/lib/amoeba/macros/has_many.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Amoeba
   module Macros
     class HasMany < ::Amoeba::Macros::Base

data/lib/amoeba/macros/has_one.rb

@@ -1,10 +1,14 @@
+# frozen_string_literal: true
+
 module Amoeba
   module Macros
     class HasOne < ::Amoeba::Macros::Base
       def follow(relation_name, association)
         return if association.is_a?(::ActiveRecord::Reflection::ThroughReflection)
+
         old_obj = @old_object.__send__(relation_name)
         return unless old_obj
+
         copy_of_obj = old_obj.amoeba_dup(@options)
         copy_of_obj[:"#{association.foreign_key}"] = nil
         relation_name = remapped_relation_name(relation_name)

data/lib/amoeba/macros.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Amoeba
   module Macros
     extend self

data/lib/amoeba/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Amoeba
-  VERSION = '3.2.0'
+  VERSION = '3.4.0'
 end

data/lib/amoeba.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_record'
 require 'active_support/all'
 require 'amoeba/version'
@@ -14,5 +16,7 @@ require 'amoeba/instance_methods'
 module Amoeba
 end
 
-ActiveRecord::Base.send :extend, Amoeba::ClassMethods
-ActiveRecord::Base.send :include, Amoeba::InstanceMethods
+ActiveSupport.on_load :active_record do
+  extend Amoeba::ClassMethods
+  include Amoeba::InstanceMethods
+end