archival_record 2.0.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 749d93406c2538c8252af9f61e801c7ff88d5d28e2f17b7c77f469958b02f1af
-  data.tar.gz: d98a6d346829cd376b87d39d42ea11893ca4508f9ecef47bd76042ca16e9960b
+  metadata.gz: d4b5a4d0030a23027b25b835935225c690a2d5badb2c80e1d37a145fd583e55c
+  data.tar.gz: 4a2e5a720bdab5cf97297cc66d9289f1beeced5d6c632d5c969816467a9928a4
 SHA512:
-  metadata.gz: 9efc50a111d529028ef245000cb16fd0839153633c573da55e1b4a000051d9e222d64308f64c38a50e87deca1ac5f1ff930ad1cf2fe46aaa3edc3408aaabdbaa
-  data.tar.gz: 49a8420bbe12026628fff779c0a8592b2b9285e86ac28b18421afc52159321b77f1e01a51f0aef05610fb805d1bb4229707aa0d4d1085f57383ce93831fe9b19
+  metadata.gz: a989cbb3679373d79edec6e55f8393ba1c32ea8ee4cdea237b848a867208d436127cfb7465d50344c2fa45a05bb32917d2acd8282d010523c721fd3b7731285c
+  data.tar.gz: 4cefa4eac2f34e69c40029979760173db1c1d24852b3db8368e077fb60a78a592597d876f4ebc4875c4312f81bea55cab6b39cadce0fc05ecdee586951e678d4

data/.gitignore

@@ -3,8 +3,11 @@
 .bundle
 bin
 vendor/bundle
+.nix-bundler
 *.gem
 gemfiles/*.lock
 pkg/*
 .DS_Store
 *.sqlite3
+*.sqlite3-shm
+*.sqlite3-wal

data/.gitlab-ci.yml

@@ -0,0 +1,20 @@
+image: "ruby:3.2"
+
+before_script:
+  - apt-get update -qq && apt-get install -y -qq sqlite3 libsqlite3-dev nodejs
+  - ruby -v
+  - which ruby
+  - gem install bundler --no-document
+  - bundle install --jobs $(nproc)  "${FLAGS[@]}"
+  - bundle install --gemfile=gemfiles/rails_6.0.gemfile
+  - bundle install --gemfile=gemfiles/rails_6.1.gemfile
+  - bundle install --gemfile=gemfiles/rails_7.0.gemfile
+  - bundle install --gemfile=gemfiles/rails_7.1.gemfile
+
+rake:
+  script:
+    - bundle exec rake
+
+appraisal:
+  script:
+    - bundle exec appraisal rake

data/.rubocop.yml

@@ -1,10 +1,13 @@
 inherit_from: .rubocop_todo.yml
+require:
+  - rubocop-rails
+  - rubocop-rake
 
 AllCops:
   Exclude:
     - vendor/**/*
     - gemfiles/**/*
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 3.0
   NewCops: enable
 
 
@@ -17,9 +20,6 @@ Layout/EmptyLinesAroundClassBody:
 Layout/EmptyLinesAroundModuleBody:
   EnforcedStyle: empty_lines_except_namespace
 
-Layout/LineLength:
-  Max: 140
-
 Layout/SpaceInsideHashLiteralBraces:
   EnforcedStyle: space
 
@@ -52,6 +52,7 @@ Style/Alias:
 Style/AsciiComments:
   Enabled: false
 
+# TODO: class documentation
 Style/Documentation:
   Enabled: false
 
@@ -66,9 +67,10 @@ Style/FrozenStringLiteralComment:
 
 Style/HashSyntax:
   EnforcedStyle: ruby19
+  EnforcedShorthandSyntax: always
 
 Style/RaiseArgs:
-  EnforcedStyle: compact
+  EnforcedStyle: exploded
 
 Style/StringLiterals:
   EnforcedStyle: double_quotes

data/.rubocop_todo.yml

@@ -1,14 +1,7 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-08-03 13:04:37 -0400 using RuboCop version 0.82.0.
+# on 2024-06-11 01:38:42 UTC using RuboCop version 1.64.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 7
-# Cop supports --auto-correct.
-Lint/SendWithMixinArgument:
-  Exclude:
-    - 'init.rb'
-    - 'lib/archival_record.rb'

data/Appraisals

@@ -1,18 +1,15 @@
-appraise "rails-5.0" do
-  gem "rails", "~> 5.0.0"
-  gem "sqlite3", "~> 1.3.13"
+appraise "rails-6.0" do
+  gem "rails", "~> 6.0.0"
 end
 
-appraise "rails-5.1" do
-  gem "rails", "~> 5.1.0"
-  gem "sqlite3", "~> 1.4.1"
+appraise "rails-6.1" do
+  gem "rails", "~> 6.1.0"
 end
 
-appraise "rails-5.2" do
-  gem "rails", "~> 5.2.0"
-  gem "sqlite3", "~> 1.4.1"
+appraise "rails-7.0" do
+  gem "rails", "~> 7.0.0"
 end
 
-appraise "rails-6.0" do
-  gem "rails", "~> 6.0.0"
+appraise "rails-7.1" do
+  gem "rails", "~> 7.1.0"
 end

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # CHANGELOG
 
+## 3.0.0 - June 10, 2024
+* **BREAKING CHANGE** Drop support for rails 5 - see `rails__4.x-and-5.x` branch for relevant code
+* **BREAKING CHANGE** Drop support for Ruby 2.x
+* **ADDED** new option for `archival_record` called `archive_dependents` which can control whether `dependent: :destroy` records are archived with their parent
+* lots of cleanup of code, particularly the way `ApplicationRecord` gets patched
+* remove travis-ci, use gitlab pipelines
+
+## 2.0.2 - August 4, 2020
+* fixing travis
+* updating git hosting link
+
 ## 2.0.1 - August 3, 2020
 * Add security policy
 * Update depenedent gems: archival_record (:D oops) and rubocop, and dependencies

data/Gemfile.lock

@@ -1,60 +1,92 @@
 PATH
   remote: .
   specs:
-    archival_record (2.0.0)
-      activerecord (>= 5.0)
+    archival_record (3.0.0)
+      activerecord (>= 6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.0.3.2)
-      activesupport (= 6.0.3.2)
-    activerecord (6.0.3.2)
-      activemodel (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
-    activesupport (6.0.3.2)
+    activemodel (7.1.3.4)
+      activesupport (= 7.1.3.4)
+    activerecord (7.1.3.4)
+      activemodel (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
+      timeout (>= 0.4.0)
+    activesupport (7.1.3.4)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    appraisal (2.3.0)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    appraisal (2.5.0)
       bundler
       rake
       thor (>= 0.14.0)
-    ast (2.4.1)
-    concurrent-ruby (1.1.6)
-    database_cleaner (1.8.5)
-    i18n (1.8.5)
+    ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.8)
+    concurrent-ruby (1.3.3)
+    connection_pool (2.4.1)
+    database_cleaner (2.0.2)
+      database_cleaner-active_record (>= 2, < 3)
+    database_cleaner-active_record (2.1.0)
+      activerecord (>= 5.a)
+      database_cleaner-core (~> 2.0.0)
+    database_cleaner-core (2.0.1)
+    drb (2.2.1)
+    i18n (1.14.5)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.1)
-    parallel (1.19.2)
-    parser (2.7.1.4)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    mini_portile2 (2.8.7)
+    minitest (5.23.1)
+    mutex_m (0.2.0)
+    parallel (1.25.1)
+    parser (3.3.2.0)
       ast (~> 2.4.1)
-    rainbow (3.0.0)
-    rake (13.0.1)
-    regexp_parser (1.7.1)
-    rexml (3.2.4)
-    rr (1.2.1)
-    rubocop (0.88.0)
+      racc
+    racc (1.8.0)
+    rack (3.0.11)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.9.2)
+    rexml (3.2.9)
+      strscan
+    rr (3.1.0)
+    rubocop (1.64.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 2.7.1.1)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
-      rexml
-      rubocop-ast (>= 0.1.0, < 1.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.3.0)
-      parser (>= 2.7.1.4)
-    ruby-progressbar (1.10.1)
-    sqlite3 (1.4.2)
-    thor (1.0.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.7.0)
-    zeitwerk (2.4.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-rails (2.25.0)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.33.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    ruby-progressbar (1.13.0)
+    sqlite3 (1.7.3)
+      mini_portile2 (~> 2.8.0)
+    strscan (3.1.0)
+    thor (1.3.1)
+    timeout (0.4.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
 
 PLATFORMS
   ruby
@@ -66,7 +98,9 @@ DEPENDENCIES
   rake
   rr
   rubocop
-  sqlite3
+  rubocop-rails
+  rubocop-rake
+  sqlite3 (< 2)
 
 BUNDLED WITH
-   2.1.4
+   2.5.11

data/LICENSE

@@ -1,8 +1,11 @@
-Copyright for portions of project ArchivalRecord are held by Expected Behavior, 2009-2020 as part of project ActsAsArchival. All other copyright for project ArchivalRecord are held by Joel Meador, 2020.
+Copyright for portions of project ArchivalRecord are held by Expected Behavior,
+2009-2020 as part of project ActsAsArchival.
+
+All other copyright for project ArchivalRecord are held by Joel Meador, 2020.
 
 -----
 
-LICENSE for [ArchivalRecord](https://github.com/janxious/archival_record/)
+LICENSE for [ArchivalRecord](https://gitlab.com/joelmeador/archival_record/)
 
 Copyright (c) 2020 Joel Meador
 

data/README.md

@@ -1,8 +1,5 @@
 # ArchivalRecord
 
-[![Build Status](https://travis-ci.org/janxious/archival_record.svg?branch=main)](https://travis-ci.org/janxious/archival_record)
-[![Gem Version](https://badge.fury.io/rb/archival_record.svg)](https://badge.fury.io/rb/archival_record)
-
 Atomically archive object trees in your ActiveRecord models.
 
 `acts_as_paranoid` and similar plugins/gems work on a record-by-record basis and made it difficult to restore records atomically (or archive them, for that matter).
@@ -11,6 +8,8 @@ Because the `#archive!` and `#unarchive!` methods are in transactions, and every
 
 Additionally, other plugins generally change how `destroy`/`delete` work. ArchivalRecord does not, and thus one can destroy records like normal.
 
+_This is a fork of [ActsAsArchival](https://github.com/expectedbehavior/acts_as_archival/)._
+
 ## Maintenance
 
 You might read the commit logs and think "This must be abandonware! This hasn't been updated in 2y!" But! This is a mature project that solves a specific problem in ActiveRecord. It tends to only be updated when a new major version of ActiveRecord comes out and hence the infrequent updates.
@@ -32,12 +31,12 @@ _If you're stuck on Rails 4.0x/3x/2x, check out the older tags/branches, which a
 ## Example
 
 ``` ruby
-class Hole < ActiveRecord::Base
+class Hole < ApplicationRecord
   archival_record
   has_many :rats, dependent: :destroy
 end
 
-class Rat < ActiveRecord::Base
+class Rat < ApplicationRecord
   archival_record
 end
 ```
@@ -112,12 +111,13 @@ Hole.archival?                # => true
 
 ### Options
 
+#### `readonly_when_archived`
 When defining an ArchivalRecord model, it is is possible to make it unmodifiable
 when it is archived by passing `readonly_when_archived: true` to the
-`archival_record` call in your model.
+`archival_record` call in your model. The default value of this option is `false`.
 
 ``` ruby
-class CantTouchThis < ActiveRecord::Base
+class CantTouchThis < ApplicationRecord
   archival_record readonly_when_archived: true
 end
 
@@ -128,12 +128,32 @@ record.save                                  # => false
 record.errors.full_messages.first            # => "Cannot modify an archived record."
 ```
 
+#### `archive_dependents`
+When defining an ArchivalRecord model, it is possible to deactivate archiving/unarchiving for `dependent: :destroy` relationships that are tied to ArchivalRecord models by passing `archive_dependents: false` to the `archival_record` call in your model. The default value of this option is `true`.
+
+``` ruby
+class WillArchive < ApplicationRecord
+  archival_record archive_dependents: false
+  has_many :wont_archives, dependent: :destroy
+end
+class WontArchive < ApplicationRecord
+  archival_record
+end
+
+record = WillArchive.create
+wont_archive = record.wont_archives.create
+record.archive!
+
+record.archived?       # => true
+wont_archive.archived? # => false
+```
+
 ### Callbacks
 
 ArchivalRecord models have four additional callbacks to do any necessary cleanup or other processing before and after archiving and unarchiving, and can additionally halt the archive callback chain.
 
 ``` ruby
-class Hole < ActiveRecord::Base
+class Hole < ApplicationRecord
   archival_record
 
   # runs before #archive!
@@ -160,8 +180,12 @@ end
 ## Caveats
 
 1. This will only work on associations that are dependent destroy. It
-should be trival to change that or make it optional.
-1. If you would like to work on this, you will need to setup sqlite on your development machine. Alternately, you can disable specific dev dependencies in the gemspec and test_helper and ask for help.
+should be trivial to change that or make it optional.
+1. If you would like to work on this, you will need to setup sqlite on your development machine. Alternately, you can deactivate specific dev dependencies in the gemspec and test_helper and ask for help.
+
+## Compatibility with ActsAsArchival
+
+For now, the `acts_as_archival` class method can be used, though it will print a deprecation warning. This is to allow users to transition without trouble to this library if they choose to.
 
 ## Testing
 

data/archival_record.gemspec

@@ -3,40 +3,44 @@ $LOAD_PATH.push File.expand_path("lib", __dir__)
 require "archival_record/version"
 
 Gem::Specification.new do |gem|
-  gem.name        = "archival_record"
-  gem.summary     = "Atomic archiving/unarchiving for ActiveRecord"
-  gem.version     = ArchivalRecord::VERSION
-  gem.authors     = ["Joel Meador",
-                     "Michael Kuehl",
-                     "Matthew Gordon",
-                     "Vojtech Salbaba",
-                     "David Jones",
-                     "Dave Woodward",
-                     "Miles Sterrett",
-                     "James Hill",
-                     "Maarten Claes",
-                     "Anthony Panozzo",
-                     "Aaron Milam",
-                     "Anton Rieder",
-                     "Josh Menden",
-                     "Sergey Gnuskov",
-                     "Elijah Miller"]
-  gem.email       = ["joel.meador+archival_record@gmail.com"]
-  gem.homepage    = "https://gitlab.com/joelmeador/archival_record/"
-
-  gem.files         = `git ls-files`.split("\n")
-  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name     = "archival_record"
+  gem.summary  = "Atomic archiving/unarchiving for ActiveRecord"
+  gem.version  = ArchivalRecord::VERSION
+  gem.authors  = ["Joel Meador",
+                  "Michael Kuehl",
+                  "Matthew Gordon",
+                  "Vojtech Salbaba",
+                  "David Jones",
+                  "Dave Woodward",
+                  "Miles Sterrett",
+                  "James Hill",
+                  "Maarten Claes",
+                  "Anthony Panozzo",
+                  "Aaron Milam",
+                  "Anton Rieder",
+                  "Josh Menden",
+                  "Sergey Gnuskov",
+                  "Elijah Miller"]
+  gem.email    = ["joel.meador+archival_record@gmail.com"]
+  gem.homepage = "https://gitlab.com/joelmeador/archival_record/"
+  gem.licenses = ['MIT']
+
+  gem.files = `git ls-files`.split("\n")
   gem.require_paths = ["lib"]
-  gem.required_ruby_version = ">= 2.4"
+  gem.required_ruby_version = ">= 3.0"
 
-  gem.add_dependency "activerecord", ">= 5.0"
+  gem.add_dependency("activerecord", ">= 6.0")
 
-  gem.add_development_dependency "appraisal"
-  gem.add_development_dependency "database_cleaner"
-  gem.add_development_dependency "rake"
-  gem.add_development_dependency "rr"
-  gem.add_development_dependency "rubocop"
-  gem.add_development_dependency "sqlite3"
+  # rubocop:disable Gemspec/DevelopmentDependencies
+  gem.add_development_dependency("appraisal")
+  gem.add_development_dependency("database_cleaner")
+  gem.add_development_dependency("rake")
+  gem.add_development_dependency("rr")
+  gem.add_development_dependency("rubocop")
+  gem.add_development_dependency("rubocop-rails")
+  gem.add_development_dependency("rubocop-rake")
+  gem.add_development_dependency("sqlite3", "< 2")
+  # rubocop:enable Gemspec/DevelopmentDependencies
 
   gem.description =
     <<~DESCRIPTION
@@ -48,4 +52,5 @@ Gem::Specification.new do |gem|
 
       Additionally, other plugins generally change how destroy/delete work. ArchivalRecord does not, and thus one can destroy records like normal.
     DESCRIPTION
+  gem.metadata["rubygems_mfa_required"] = "true"
 end

data/gemfiles/{rails_5.1.gemfile → rails_6.1.gemfile}

@@ -2,7 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 5.1.0"
-gem "sqlite3", "~> 1.4.1"
+gem "rails", "~> 6.1.0"
 
 gemspec path: "../"

data/gemfiles/{rails_5.2.gemfile → rails_7.0.gemfile}

@@ -2,7 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 5.2.0"
-gem "sqlite3", "~> 1.4.1"
+gem "rails", "~> 7.0.0"
 
 gemspec path: "../"

data/gemfiles/{rails_5.0.gemfile → rails_7.1.gemfile}

@@ -2,7 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 5.0.0"
-gem "sqlite3", "~> 1.3.13"
+gem "rails", "~> 7.1.0"
 
 gemspec path: "../"

data/init.rb

@@ -1,3 +1,3 @@
 # Include hook code here
-ActiveRecord::Base.send :include, ArchivalRecordCore::ArchivalRecordActiveRecordMethods
-ActiveRecord::Base.send :include, ArchivalRecordCore::ArchivalRecord
+ActiveSupport.on_load(:active_record) { include ArchivalRecordCore::ArchivalRecordActiveRecordMethods }
+ActiveSupport.on_load(:active_record) { include ArchivalRecordCore::ArchivalRecord }

data/lib/archival_record/version.rb

@@ -1,5 +1,5 @@
 module ArchivalRecord
 
-  VERSION = "2.0.2".freeze
+  VERSION = "3.0.0".freeze
 
 end

data/lib/archival_record.rb

@@ -9,11 +9,11 @@ require "archival_record_core/archival_record_active_record_methods"
 
 # This assumes a fully Rails 5 compatible set of ActiveRecord models
 if defined?(ApplicationRecord)
-  ApplicationRecord.send :include, ArchivalRecordCore::ArchivalRecord
-  ApplicationRecord.send :include, ArchivalRecordCore::ArchivalRecordActiveRecordMethods
+  ApplicationRecord.include ArchivalRecordCore::ArchivalRecord
+  ApplicationRecord.include ArchivalRecordCore::ArchivalRecordActiveRecordMethods
 else
-  ActiveRecord::Base.send :include, ArchivalRecordCore::ArchivalRecord
-  ActiveRecord::Base.send :include, ArchivalRecordCore::ArchivalRecordActiveRecordMethods
+  ActiveSupport.on_load(:active_record) { include ArchivalRecordCore::ArchivalRecord }
+  ActiveSupport.on_load(:active_record) { include ArchivalRecordCore::ArchivalRecordActiveRecordMethods }
 end
 
-ActiveRecord::Relation.send :include, ArchivalRecordCore::ArchivalRecordActiveRecordMethods::ARRelationMethods
+ActiveRecord::Relation.include ArchivalRecordCore::ArchivalRecordActiveRecordMethods::ARRelationMethods

data/lib/archival_record_core/archival_record.rb

@@ -3,17 +3,18 @@ module ArchivalRecordCore
 
     require "digest/md5"
 
-    unless defined?(MissingArchivalColumnError) == "constant" && MissingArchivalColumnError.class == Class
+    unless defined?(MissingArchivalColumnError) == "constant" && MissingArchivalColumnError.instance_of?(Class)
       MissingArchivalColumnError = Class.new(ActiveRecord::ActiveRecordError)
     end
-    unless defined?(CouldNotArchiveError) == "constant" && CouldNotArchiveError.class == Class
+    unless defined?(CouldNotArchiveError) == "constant" && CouldNotArchiveError.instance_of?(Class)
       CouldNotArchiveError = Class.new(ActiveRecord::ActiveRecordError)
     end
-    unless defined?(CouldNotUnarchiveError) == "constant" && CouldNotUnarchiveError.class == Class
+    unless defined?(CouldNotUnarchiveError) == "constant" && CouldNotUnarchiveError.instance_of?(Class)
       CouldNotUnarchiveError = Class.new(ActiveRecord::ActiveRecordError)
     end
 
     def self.included(base)
+      super
       base.extend ActMethods
     end
 
@@ -24,6 +25,8 @@ module ArchivalRecordCore
 
         include InstanceMethods
 
+        setup_options(options)
+
         setup_validations(options)
 
         setup_scopes
@@ -33,10 +36,17 @@ module ArchivalRecordCore
 
       # Deprecated: Please use `archival_record` instead
       def acts_as_archival(options = {})
-        ActiveSupport::Deprecation.warn("`acts_as_archival` is deprecated.  Please use `archival_record` instead.")
+        ActiveSupport::Deprecation.new("3.0", "ArchivalRecord")
         archival_record(options)
       end
 
+      private def setup_options(options)
+        default_options = { readonly_when_archived: false, archive_dependents: true }
+        options.reverse_merge!(default_options)
+
+        define_method(:archive_dependents?) { options[:archive_dependents] }
+      end
+
       private def setup_validations(options)
         before_validation :raise_if_not_archival
         validate :readonly_when_archived if options[:readonly_when_archived]
@@ -73,6 +83,12 @@ module ArchivalRecordCore
       private def define_callback_dsl_method(callbackable_type, action)
         # rubocop:disable Security/Eval
         eval <<-END_CALLBACKS, binding, __FILE__, __LINE__ + 1
+          # unless defined?(before_archive)
+          #   def before_archive(*args, &blk)
+          #     set_callback(:archive, :before, *args, &blk)
+          #   end
+          # end
+
           unless defined?(#{callbackable_type}_#{action})
             def #{callbackable_type}_#{action}(*args, &blk)
               set_callback(:#{action}, :#{callbackable_type}, *args, &blk)
@@ -99,7 +115,8 @@ module ArchivalRecordCore
         missing_columns << "archived_at" unless respond_to?(:archived_at)
         return if missing_columns.blank?
 
-        raise MissingArchivalColumnError.new("Add '#{missing_columns.join "', '"}' column(s) to '#{self.class.name}' to make it archival")
+        raise(MissingArchivalColumnError,
+              "Add '#{missing_columns.join "', '"}' column(s) to '#{self.class.name}' to make it archival")
       end
 
       def archived?
@@ -138,24 +155,20 @@ module ArchivalRecordCore
         AssociationOperation::Unarchive.new(self, head_archive_number).execute
       end
 
-      private def execute_archival_action(action)
+      private def execute_archival_action(action, &block)
+        execution_result = false
         self.class.transaction do
-          # rubocop: disable Style/RescueStandardError
-          begin
-            success = run_callbacks(action) { yield }
-            return !!success
-          rescue => e
-            handle_archival_action_exception(e)
-          end
-          # rubocop: enable Style/RescueStandardError
+          execution_result = !!run_callbacks(action, &block)
+        rescue StandardError => e
+          handle_archival_action_exception(e)
         end
-        false
+        execution_result
       end
 
       private def handle_archival_action_exception(exception)
         ActiveRecord::Base.logger.try(:debug, exception.message)
         ActiveRecord::Base.logger.try(:debug, exception.backtrace)
-        raise ActiveRecord::Rollback
+        raise(ActiveRecord::Rollback)
       end
 
     end

data/lib/archival_record_core/archival_record_active_record_methods.rb

@@ -2,6 +2,7 @@ module ArchivalRecordCore
   module ArchivalRecordActiveRecordMethods
 
     def self.included(base)
+      super
       base.extend ARClassMethods
       base.send :include, ARInstanceMethods
     end
@@ -26,7 +27,7 @@ module ArchivalRecordCore
 
       def archive_all!
         error_message = "The #{klass} must implement 'act_on_archivals' in order to call `archive_all!`"
-        raise NotImplementedError.new(error_message) unless archival?
+        raise(NotImplementedError, error_message) unless archival?
 
         head_archive_number = Digest::MD5.hexdigest("#{klass}#{Time.now.utc.to_i}")
         each { |record| record.archive!(head_archive_number) }.tap { reset }
@@ -34,7 +35,7 @@ module ArchivalRecordCore
 
       def unarchive_all!
         error_message = "The #{klass} must implement 'act_on_archivals' in order to call `unarchive_all!`"
-        raise NotImplementedError.new(error_message) unless archival?
+        raise(NotImplementedError, error_message) unless archival?
 
         each(&:unarchive!).tap { reset }
       end

data/lib/archival_record_core/association_operation/base.rb

@@ -11,8 +11,10 @@ module ArchivalRecordCore
         end
 
         def execute
+          return unless model.archive_dependents?
+
           each_archivable_association do |association|
-            act_on_association(association) if association_conditions_met? association
+            act_on_association(association) if association_conditions_met?(association)
           end
         end
 
@@ -45,7 +47,7 @@ module ArchivalRecordCore
         end
 
         def act_on_archivals(_scope)
-          raise NotImplementedError.new("The #{self.class} hasn't implemented 'act_on_archivals(scope)'")
+          raise(NotImplementedError, "The #{self.class} hasn't implemented 'act_on_archivals(scope)'")
         end
 
       end

data/test/application_record_test.rb

@@ -11,7 +11,7 @@ if defined?(ApplicationRecord)
     end
 
     test "unarchive unarchives archival records" do
-      archival = ApplicationRecordRow.create!(archived_at: Time.now, archive_number: 1)
+      archival = ApplicationRecordRow.create!(archived_at: Time.now.utc, archive_number: 1)
       archival.unarchive!
       assert_not archival.reload.archived?
     end

data/test/archive_dependents_option_test.rb

@@ -0,0 +1,54 @@
+require_relative "test_helper"
+
+class ArchiveDependentsOptionTest < ActiveSupport::TestCase
+
+  test "archive_dependents option will leave dependent archival records alone when parent is archived" do
+    archival = IgnoreDependentsArchival.create!
+    child = archival.ignorable_dependents.create!
+
+    assert archival.archival?
+    assert child.archival?
+
+    archival.archive!
+
+    assert archival.reload.archived?
+    assert_not child.reload.archived?
+  end
+
+  test "archive_dependents option will leave dependent archival records alone when parent is unarchived" do
+    archival = IgnoreDependentsArchival.create!
+    child = archival.ignorable_dependents.create!
+
+    assert archival.archival?
+    assert child.archival?
+
+    # This is simulating an unlikely scenario where the option has been added after records have been
+    # archived as a set but we want to unarchive after adding the option.
+    archival.archive!
+    child.update!(archived_at: archival.archived_at, archive_number: archival.archive_number)
+
+    archival.unarchive!
+
+    assert_not archival.reload.archived?
+    assert child.reload.archived?
+  end
+
+  test "archive_dependents option will work normally if set to true" do
+    archival = ExplicitActOnDependentsArchival.create!
+    child = archival.nonignorable_dependents.create!
+
+    assert archival.archival?
+    assert child.archival?
+
+    archival.archive!
+
+    assert archival.reload.archived?
+    assert child.reload.archived?
+
+    archival.unarchive!
+
+    assert_not archival.reload.archived?
+    assert_not child.reload.archived?
+  end
+
+end

data/test/basic_test.rb

@@ -9,7 +9,7 @@ class BasicTest < ActiveSupport::TestCase
   end
 
   test "unarchive unarchives archival records" do
-    archival = Archival.create!(archived_at: Time.now, archive_number: 1)
+    archival = Archival.create!(archived_at: Time.now.utc, archive_number: 1)
     archival.unarchive!
     assert_equal false, archival.reload.archived?
   end
@@ -26,23 +26,23 @@ class BasicTest < ActiveSupport::TestCase
   end
 
   test "unarchive returns true on success" do
-    normal = Archival.create!(archived_at: Time.now, archive_number: "1")
+    normal = Archival.create!(archived_at: Time.now.utc, archive_number: "1")
     assert_equal true, normal.unarchive!
   end
 
   test "unarchive returns false on failure" do
-    readonly = Archival.create!(archived_at: Time.now, archive_number: "1")
+    readonly = Archival.create!(archived_at: Time.now.utc, archive_number: "1")
     readonly.readonly!
     assert_equal false, readonly.unarchive!
   end
 
   test "archive sets archived_at to the time of archiving" do
     archival = Archival.create!
-    before = DateTime.now
+    before = DateTime.now.utc
     sleep(0.001)
     archival.archive!
     sleep(0.001)
-    after = DateTime.now
+    after = DateTime.now.utc
     assert before < archival.archived_at.to_datetime
     assert after > archival.archived_at.to_datetime
   end

data/test/deep_nesting_test.rb

@@ -18,7 +18,7 @@ class DeepNestingTest < ActiveSupport::TestCase
 
   test "unarchiving deeply nested items doesn't blow up" do
     archival_attributes = {
-      archived_at: Time.now,
+      archived_at: Time.now.utc,
       archive_number: "test"
     }
     archival = Archival.create!(archival_attributes)

data/test/fixtures/explicit_act_on_dependents_archival.rb

@@ -0,0 +1,9 @@
+# archive_number                - string
+# archived_at                   - datetime
+class ExplicitActOnDependentsArchival < ActiveRecord::Base
+
+  archival_record archive_dependents: true
+
+  has_many :nonignorable_dependents, dependent: :destroy
+
+end

data/test/fixtures/ignorable_dependent.rb

@@ -0,0 +1,10 @@
+# ignore_dependents_archival_id - integer
+# archive_number                - string
+# archived_at                   - datetime
+class IgnorableDependent < ActiveRecord::Base
+
+  archival_record
+
+  belongs_to :ignore_dependents_archival
+
+end

data/test/fixtures/ignore_dependents_archival.rb

@@ -0,0 +1,9 @@
+# archive_number - string
+# archived_at    - datetime
+class IgnoreDependentsArchival < ActiveRecord::Base
+
+  archival_record archive_dependents: false
+
+  has_many :ignorable_dependents, dependent: :destroy
+
+end

data/test/fixtures/nonignorable_dependent.rb

@@ -0,0 +1,10 @@
+# explicit_act_on_dependents_archival_id - integer
+# archive_number                         - string
+# archived_at                            - datetime
+class NonignorableDependent < ActiveRecord::Base
+
+  archival_record
+
+  belongs_to :explicit_act_on_dependents_archival
+
+end

data/test/polymorphic_test.rb

@@ -23,7 +23,7 @@ class PolymorphicTest < ActiveSupport::TestCase
   test "unarchive item with polymorphic association" do
     archive_attributes = {
       archive_number: "test",
-      archived_at: Time.now
+      archived_at: Time.now.utc
     }
     archival = Archival.create!(archive_attributes)
     poly = archival.polys.create!(archive_attributes)
@@ -36,7 +36,7 @@ class PolymorphicTest < ActiveSupport::TestCase
   test "does not unarchive polymorphic association of different item with same id" do
     archive_attributes = {
       archive_number: "test",
-      archived_at: Time.now
+      archived_at: Time.now.utc
     }
 
     archival = Archival.create!(archive_attributes)

data/test/relations_test.rb

@@ -34,7 +34,7 @@ class RelationsTest < ActiveSupport::TestCase
     assert parents.first.archivals.last.archived?
   end
 
-  test "unarchive_all! unarchives all records in an AR Assocation" do
+  test "unarchive_all! unarchives all records in an AR association" do
     3.times { Archival.create! }
 
     archivals = Archival.all

data/test/schema.rb

@@ -93,4 +93,26 @@ ActiveRecord::Schema.define(version: 1) do
     t.column :archive_number, :string
     t.column :archived_at, :datetime
   end
+
+  create_table :ignore_dependents_archivals, force: true do |t|
+    t.column :archive_number, :string
+    t.column :archived_at, :datetime
+  end
+
+  create_table :ignorable_dependents, force: true do |t|
+    t.column :ignore_dependents_archival_id, :integer
+    t.column :archive_number, :string
+    t.column :archived_at, :datetime
+  end
+
+  create_table :explicit_act_on_dependents_archivals, force: true do |t|
+    t.column :archive_number, :string
+    t.column :archived_at, :datetime
+  end
+
+  create_table :nonignorable_dependents, force: true do |t|
+    t.column :explicit_act_on_dependents_archival_id, :integer
+    t.column :archive_number, :string
+    t.column :archived_at, :datetime
+  end
 end

data/test/scope_test.rb

@@ -52,14 +52,14 @@ class ScopeTest < ActiveSupport::TestCase
   test "table_name is set to 'legacy'" do
     archived_sql =
       if ActiveRecord.version >= Gem::Version.new("5.2.0")
-        "SELECT \"legacy\".* FROM \"legacy\" " \
-        'WHERE "legacy"."archived_at" IS NOT NULL AND "legacy"."archive_number" IS NOT NULL'
+        'SELECT "legacy".* FROM "legacy" ' \
+          'WHERE "legacy"."archived_at" IS NOT NULL AND "legacy"."archive_number" IS NOT NULL'
       else
-        "SELECT \"legacy\".* FROM \"legacy\" " \
-        'WHERE ("legacy"."archived_at" IS NOT NULL) AND ("legacy"."archive_number" IS NOT NULL)'
+        'SELECT "legacy".* FROM "legacy" ' \
+          'WHERE ("legacy"."archived_at" IS NOT NULL) AND ("legacy"."archive_number" IS NOT NULL)'
       end
-    unarchived_sql = "SELECT \"legacy\".* FROM \"legacy\" " \
-        'WHERE "legacy"."archived_at" IS NULL AND "legacy"."archive_number" IS NULL'
+    unarchived_sql = 'SELECT "legacy".* FROM "legacy" ' \
+                     'WHERE "legacy"."archived_at" IS NULL AND "legacy"."archive_number" IS NULL'
     assert_equal archived_sql, ArchivalTableName.archived.to_sql
     assert_equal unarchived_sql, ArchivalTableName.unarchived.to_sql
   end

data/test/test_helper.rb

@@ -1,4 +1,4 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__) + "/../lib")
+$LOAD_PATH.unshift("#{File.dirname(__FILE__)}/../lib")
 
 require "bundler/setup"
 require "minitest/autorun"
@@ -20,7 +20,7 @@ end
 
 def setup_logging
   require "logger"
-  logfile = File.dirname(__FILE__) + "/debug.log"
+  logfile = "#{File.dirname(__FILE__)}/debug.log"
   ActiveRecord::Base.logger = Logger.new(logfile)
 end
 
@@ -40,8 +40,11 @@ def sqlite_config
   }
 end
 
+def schema_file
+  "#{File.dirname(__FILE__)}/schema.rb"
+end
+
 def create_test_tables
-  schema_file = File.dirname(__FILE__) + "/schema.rb"
   puts "** Loading schema for SQLite"
   ActiveRecord::Base.establish_connection(sqlite_config)
   load(schema_file) if File.exist?(schema_file)
@@ -61,16 +64,20 @@ BASE_FIXTURE_CLASSES = %I[
   poly
   readonly_when_archived
   deprecated_warning_archival
+  ignore_dependents_archival
+  ignorable_dependent
+  explicit_act_on_dependents_archival
+  nonignorable_dependent
 ].freeze
 
 RAILS_4_FIXTURE_CLASSES = %I[
-  callback_archival_4
+  callback_archival4
 ].freeze
 
 RAILS_5_FIXTURE_CLASSES = %I[
   application_record
   application_record_row
-  callback_archival_5
+  callback_archival5
 ].freeze
 
 def require_test_classes

data/test/transaction_test.rb

@@ -11,7 +11,8 @@ class TransactionTest < ActiveSupport::TestCase
     end
     archival.archive!
 
-    assert_not archival.archived?, "If this failed, you might be trying to test on a system that doesn't support nested transactions"
+    failure_reason = "If this failed, you might be trying to test on a system that doesn't support nested transactions"
+    assert_not archival.archived?, failure_reason
     assert_not exploder.reload.archived?
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: archival_record
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 3.0.0
 platform: ruby
 authors:
 - Joel Meador
@@ -19,10 +19,10 @@ authors:
 - Josh Menden
 - Sergey Gnuskov
 - Elijah Miller
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-04 00:00:00.000000000 Z
+date: 1980-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -109,7 +109,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -122,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 description: |
   *Atomic archiving/unarchiving for ActiveRecord*
 
@@ -137,9 +165,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".gitlab-ci.yml"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
-- ".travis.yml"
 - Appraisals
 - CHANGELOG.md
 - Gemfile
@@ -149,10 +177,10 @@ files:
 - Rakefile
 - SECURITY.md
 - archival_record.gemspec
-- gemfiles/rails_5.0.gemfile
-- gemfiles/rails_5.1.gemfile
-- gemfiles/rails_5.2.gemfile
 - gemfiles/rails_6.0.gemfile
+- gemfiles/rails_6.1.gemfile
+- gemfiles/rails_7.0.gemfile
+- gemfiles/rails_7.1.gemfile
 - init.rb
 - lib/archival_record.rb
 - lib/archival_record/version.rb
@@ -164,6 +192,7 @@ files:
 - script/setup
 - test/ambiguous_table_test.rb
 - test/application_record_test.rb
+- test/archive_dependents_option_test.rb
 - test/associations_test.rb
 - test/basic_test.rb
 - test/callbacks_test.rb
@@ -177,13 +206,17 @@ files:
 - test/fixtures/archival_grandkid.rb
 - test/fixtures/archival_kid.rb
 - test/fixtures/archival_table_name.rb
-- test/fixtures/callback_archival_4.rb
-- test/fixtures/callback_archival_5.rb
+- test/fixtures/callback_archival4.rb
+- test/fixtures/callback_archival5.rb
 - test/fixtures/deprecated_warning_archival.rb
+- test/fixtures/explicit_act_on_dependents_archival.rb
 - test/fixtures/exploder.rb
+- test/fixtures/ignorable_dependent.rb
+- test/fixtures/ignore_dependents_archival.rb
 - test/fixtures/independent_archival.rb
 - test/fixtures/missing_archive_number.rb
 - test/fixtures/missing_archived_at.rb
+- test/fixtures/nonignorable_dependent.rb
 - test/fixtures/plain.rb
 - test/fixtures/poly.rb
 - test/fixtures/readonly_when_archived.rb
@@ -197,9 +230,11 @@ files:
 - test/through_association_test.rb
 - test/transaction_test.rb
 homepage: https://gitlab.com/joelmeador/archival_record/
-licenses: []
-metadata: {}
-post_install_message: 
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -207,49 +242,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.4.22
+signing_key:
 specification_version: 4
 summary: Atomic archiving/unarchiving for ActiveRecord
-test_files:
-- test/ambiguous_table_test.rb
-- test/application_record_test.rb
-- test/associations_test.rb
-- test/basic_test.rb
-- test/callbacks_test.rb
-- test/column_test.rb
-- test/deep_nesting_test.rb
-- test/deprecated_warning_archival_test.rb
-- test/fixtures/another_polys_holder.rb
-- test/fixtures/application_record.rb
-- test/fixtures/application_record_row.rb
-- test/fixtures/archival.rb
-- test/fixtures/archival_grandkid.rb
-- test/fixtures/archival_kid.rb
-- test/fixtures/archival_table_name.rb
-- test/fixtures/callback_archival_4.rb
-- test/fixtures/callback_archival_5.rb
-- test/fixtures/deprecated_warning_archival.rb
-- test/fixtures/exploder.rb
-- test/fixtures/independent_archival.rb
-- test/fixtures/missing_archive_number.rb
-- test/fixtures/missing_archived_at.rb
-- test/fixtures/plain.rb
-- test/fixtures/poly.rb
-- test/fixtures/readonly_when_archived.rb
-- test/polymorphic_test.rb
-- test/readonly_when_archived_test.rb
-- test/relations_test.rb
-- test/responds_test.rb
-- test/schema.rb
-- test/scope_test.rb
-- test/test_helper.rb
-- test/through_association_test.rb
-- test/transaction_test.rb
+test_files: []

data/.travis.yml

@@ -1,23 +0,0 @@
-language: ruby
-cache: bundler
-
-rvm:
-  - 2.4
-  - 2.5
-  - 2.6
-  - 2.7
-
-gemfile:
-  - gemfiles/rails_5.0.gemfile
-  - gemfiles/rails_5.1.gemfile
-  - gemfiles/rails_5.2.gemfile
-  - gemfiles/rails_6.0.gemfile
-
-before_install:
-  - gem update --system
-
-matrix:
-  fast_finish: true
-  exclude:
-    - gemfile: gemfiles/rails_6.0.gemfile
-      rvm: 2.4