archival_record 3.0.1 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de698cb4c6c28dbc975343cbb8c64040423a401fe1963486e4d43feacdaf70fd
-  data.tar.gz: 423dc258212a7b8ff4fb78a6acc29bc979846820c50263859e0d9d2a9e634c81
+  metadata.gz: a75201e40595114329b5ecf7f2e790a37c57a94640755fc50fc2d330f2065056
+  data.tar.gz: 7fa088f8c71f94aa613807d0f493178db771b993c41f1a0b266665940137eea9
 SHA512:
-  metadata.gz: a24054ef6cd9fc3ed12233e10e11fa194e26f72499534925bdd4d4bad05b9245bb994763ba6b449b7100e48dda00ce30de641b51f9d6a797697fba2805335f84
-  data.tar.gz: 3dab3e39d40c31fcfe60129b8eb9a3fb420be3ece65c18a7bfa3da367026b9c44ecee1e4b721ea71bd28cc85920308d427d391ddab10e2a0a82e1e2203e9ff30
+  metadata.gz: e5b6fb27d71b390549bbbcb50de73c000432521083f662e1f77ffdea2904b6782df8f54cc54a088946a6aacd4cf104e5c9d531e9a5d88851aca954ab74f5062c
+  data.tar.gz: d0daae3db6a6841c4185c0be8d25e0459df61f21b3d41c0f898cb18b06bcc9ac4a9d6867ee0f73c4246b08850aca8bad095df3ef05f5b8bf54ec33e4e2d3b836

data/.envrc

@@ -0,0 +1,9 @@
+PATH_add bin
+
+use nix
+
+mkdir -p .nix-bundler
+
+export BUNDLE_PATH=./vendor/bundle
+export PATH=$PWD/bin:$PATH
+export AR_LOGGER=0

data/.gitignore

@@ -3,7 +3,7 @@
 .bundle
 bin
 vendor/bundle
-.nix-bundler
+gemfiles/vendor/bundle
 *.gem
 gemfiles/*.lock
 pkg/*

data/.rubocop.yml

@@ -1,5 +1,4 @@
-inherit_from: .rubocop_todo.yml
-require:
+plugins:
   - rubocop-rails
   - rubocop-rake
 
@@ -54,7 +53,7 @@ Style/AsciiComments:
 
 # TODO: class documentation
 Style/Documentation:
-  Enabled: false
+  Enabled: true
 
 Style/DoubleNegation:
   Enabled: false

data/Appraisals

@@ -1,15 +1,29 @@
 appraise "rails-6.0" do
   gem "rails", "~> 6.0.0"
+  gem "sqlite3", "< 2"
+  gem "logger"
 end
 
 appraise "rails-6.1" do
   gem "rails", "~> 6.1.0"
+  gem "sqlite3", "< 2"
+  gem "logger"
 end
 
 appraise "rails-7.0" do
   gem "rails", "~> 7.0.0"
+  gem "sqlite3", "< 2"
+  gem "logger"
 end
 
 appraise "rails-7.1" do
   gem "rails", "~> 7.1.0"
 end
+
+appraise "rails-7.2" do
+  gem "rails", "~> 7.2.0"
+end
+
+appraise "rails-8.0" do
+  gem "rails", "~> 8.0.0"
+end

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # CHANGELOG
 
+## 4.0.1 - March 25, 2025
+* Fixing links on rubygems.org to point to codeberg since that config move to [metadata](https://guides.rubygems.org/specification-reference/#metadata) in the past couple years
+
+## 4.0.0 - March 19, 2025
+* **BREAKING CHANGE** `unarchive` behavior changed if you had non-`dependent: :destroy` `has_many` relationship but equal archive numbers on archived records before, the associated record would be unarchived. Now it won't. *You probably weren't doing this. If you were, why? How did you find out you could? Did you intend to? Anyway I broke it for you if you did find this extremely odd edge case. Sorry.* see: https://codeberg.org/joelmeador/archival_record/commit/19e02708f5ec97aa9b56a51cb7a84283e73e65aa
+* **BREAKING CHANGE** `archive` and `unarchive` now will act on `has_many` relations that are marked as `dependent: :delete_all` and `dependent: :destroy_async` in addition to `dependent: :destroy`. see: https://codeberg.org/joelmeador/archival_record/commit/685d7c6abb123422f2f8665252b99423dada305a
+* added explicit Rails 7.1, 7.2, 8.0 support
+* move from gitlab -> codeberg, remove CI because who needs it
+* update main dev gemfile to active record 8 and clean up sqlite situation
+* simplify the built-in scopes for `archived`/`unarchived` to only check `archive_number`. see: https://codeberg.org/joelmeador/archival_record/commit/36febe5bfab0a3638b7fa21718ca87e2e3e82c09
+* Added `raise_on_error` option to main `archival_record` method to optionally not swallow exceptions that previously were. see: https://codeberg.org/joelmeador/archival_record/commit/ca99dac35f33d9f89bd10cf9846d975ab34a467a
+
 ## 3.0.1 - June 10, 2024
 * a few more tidying items like fixing up some raw sql in a query to be arel
 * changing a logging method to use error instead of debug so it surfaces more easily
@@ -10,6 +22,7 @@
 * **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
+* updated all gems that could be updated to latest
 
 ## 2.0.2 - August 4, 2020
 * fixing travis
@@ -17,7 +30,7 @@
 
 ## 2.0.1 - August 3, 2020
 * Add security policy
-* Update depenedent gems: archival_record (:D oops) and rubocop, and dependencies
+* Update depenedent gems: `archival_record` (:D oops) and `rubocop`, and their dependencies
 
 ## 2.0.0 – August 3, 2020
 
@@ -25,7 +38,7 @@
 * **BREAKING CHANGE** Removed deprecated methods
 * Fix Rails 6 deprecation warnings
 * Renamed gem to [ArchivalRecord](https://github.com/janxious/archival_record/)
-* `acts_as_archival` becomes `archival_record` in models with a deprecation warning.
+* `acts_as_archival` becomes `archival_record` in models with a deprecation warning for `acts_as_archival`.
 
 -------
 

data/Gemfile.lock

@@ -1,106 +1,126 @@
 PATH
   remote: .
   specs:
-    archival_record (3.0.1)
+    archival_record (4.0.0)
       activerecord (>= 6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    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)
+    activejob (8.0.2)
+      activesupport (= 8.0.2)
+      globalid (>= 0.3.6)
+    activemodel (8.0.2)
+      activesupport (= 8.0.2)
+    activerecord (8.0.2)
+      activemodel (= 8.0.2)
+      activesupport (= 8.0.2)
       timeout (>= 0.4.0)
-    activesupport (7.1.3.4)
+    activesupport (8.0.2)
       base64
+      benchmark (>= 0.3)
       bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+      concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
       drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      mutex_m
-      tzinfo (~> 2.0)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
     appraisal (2.5.0)
       bundler
       rake
       thor (>= 0.14.0)
-    ast (2.4.2)
+    ast (2.4.3)
     base64 (0.2.0)
-    bigdecimal (3.1.8)
-    concurrent-ruby (1.3.3)
-    connection_pool (2.4.1)
-    database_cleaner (2.0.2)
+    benchmark (0.4.0)
+    bigdecimal (3.1.9)
+    coderay (1.1.3)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.0)
+    database_cleaner (2.1.0)
       database_cleaner-active_record (>= 2, < 3)
-    database_cleaner-active_record (2.1.0)
+    database_cleaner-active_record (2.2.0)
       activerecord (>= 5.a)
       database_cleaner-core (~> 2.0.0)
     database_cleaner-core (2.0.1)
     drb (2.2.1)
-    i18n (1.14.5)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.7)
       concurrent-ruby (~> 1.0)
-    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)
+    json (2.10.2)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
+    logger (1.6.6)
+    method_source (1.1.0)
+    mini_portile2 (2.8.8)
+    minitest (5.25.5)
+    parallel (1.26.3)
+    parser (3.3.7.1)
       ast (~> 2.4.1)
       racc
-    racc (1.8.0)
-    rack (3.0.11)
+    pry (0.15.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.8.1)
+    rack (3.1.12)
     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)
+    regexp_parser (2.10.0)
+    rr (3.1.1)
+    rubocop (1.74.0)
       json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.3)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.40.0)
       parser (>= 3.3.1.0)
-    rubocop-rails (2.25.0)
+    rubocop-rails (2.30.3)
       activesupport (>= 4.2.0)
+      lint_roller (~> 1.1)
       rack (>= 1.1)
-      rubocop (>= 1.33.0, < 2.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
-    rubocop-rake (0.6.0)
-      rubocop (~> 1.0)
+      rubocop (>= 1.72.1, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+    rubocop-rake (0.7.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1)
     ruby-progressbar (1.13.0)
-    sqlite3 (1.7.3)
+    securerandom (0.4.1)
+    sqlite3 (2.6.0)
       mini_portile2 (~> 2.8.0)
-    strscan (3.1.0)
-    thor (1.3.1)
-    timeout (0.4.1)
+    thor (1.3.2)
+    timeout (0.4.3)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.5.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    uri (1.0.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  activejob (>= 6.0)
   appraisal
   archival_record!
   database_cleaner
+  pry
   rake
   rr
   rubocop
   rubocop-rails
   rubocop-rake
-  sqlite3 (< 2)
+  sqlite3
 
 BUNDLED WITH
    2.5.11

data/LICENSE

@@ -5,7 +5,7 @@ All other copyright for project ArchivalRecord are held by Joel Meador, 2020.
 
 -----
 
-LICENSE for [ArchivalRecord](https://gitlab.com/joelmeador/archival_record/)
+LICENSE for [ArchivalRecord](https://codeberg.org/joelmeador/archival_record/)
 
 Copyright (c) 2020 Joel Meador
 

data/README.md

@@ -10,9 +10,9 @@ Additionally, other plugins generally change how `destroy`/`delete` work. Archiv
 
 _This is a fork of [ActsAsArchival](https://github.com/expectedbehavior/acts_as_archival/)._
 
-## Maintenance
+## Maintenance Schedule
 
-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.
+You might read the commit logs and think "This must be abandonware! This hasn't been updated in X years!" 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.
 
 ## Install
 
@@ -24,7 +24,7 @@ Any models you want to be archival should have the columns `archive_number` (`St
 
 i.e. `rails g migration AddArchivalRecordToPost archive_number archived_at:datetime`
 
-Any dependent-destroy ArchivalRecord model associated to an ArchivalRecord model will be archived with its parent.
+Any `dependent: :destroy`, `dependent: :delete_all`, or `dependent: :destroy_async` ArchivalRecord model associated to an ArchivalRecord model will be archived with its parent.
 
 _If you're stuck on Rails 5x/4x/3x/2x, check out the older tags/branches, which are no longer in active development._
 
@@ -60,15 +60,17 @@ h.archived_at                    # => nil
 
 ``` ruby
 h = Hole.create                  #
-r = h.rats.create                #
+rat = h.rats.create              #
 h.archive!                       # => true
 h.archive_number                 # => "b56876de48a5dcfe71b2c13eec15e4a2"
-r.archived_at                    # => Thu, 01 Jan 2012 01:52:12 -0400
-r.archived?                      # => true
+rat.archive_number               # => "b56876de48a5dcfe71b2c13eec15e4a2"
+rat.archived_at                  # => Thu, 01 Jan 2012 01:52:12 -0400
+rat.archived?                    # => true
 h.unarchive!                     # => true
 h.archive_number                 # => nil
-r.archived_at                    # => nil
-r.archived?                      # => false
+rat.archive_number               # => nil
+rat.archived_at                  # => nil
+rat.archived?                    # => false
 ```
 
 ### Relations
@@ -122,14 +124,17 @@ class CantTouchThis < ApplicationRecord
 end
 
 record = CantTouchThis.create(foo: "bar")
-record.archive!                              # => true
+record.archive!                   # => true
 record.foo = "I want this to work"
-record.save                                  # => false
-record.errors.full_messages.first            # => "Cannot modify an archived record."
+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`.
+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
@@ -148,6 +153,27 @@ record.archived?       # => true
 wont_archive.archived? # => false
 ```
 
+#### `raise_on_error`
+
+The default behavior of ArchivalRecord models when archiving or unarchiving and a `StandardError`
+is encountered during the transaction is to quietly roll back the transaction. If you would like
+an exception to occur instead - this is useful for debugging and maybe appropriate for production
+depending on your circumstances - you can set pass `raise_on_error: true` to the `archival_record`
+call in your model. The default value of this option is `false`.
+
+
+``` ruby
+class ExplodesWhenTouched < ApplicationRecord
+  archival_record raise_on_error: true
+end
+
+record = ExplodesWhenTouched.create(foo: "bar")
+record.archive!   # => true
+record.readonly!
+record.unarchive! # => raises ActiveRecord::ReadOnlyRecord
+```
+
+
 ### 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.
@@ -174,14 +200,12 @@ end
 
 #### Halting the callback chain
 
-* Rails 4.2 - the callback method should return a `false`/`nil` value.
-* Rails 5.x - the callback should `throw(:abort)`/`raise(:abort)`.
+* Rails 6.x+ - the callback should `throw(:abort)`/`raise(:abort)`.
 
 ## Caveats
 
-1. This will only work on associations that are dependent destroy. It
-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.
+1. This will only work on associations that are marked `dependent: :destroy`, `dependent: :delete_all`, or `dependent: :destroy_async`. It should be straightforward 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` or ask for help in an issue.
 
 ## Compatibility with ActsAsArchival
 
@@ -197,11 +221,17 @@ rake                         # run tests on latest Rails
 appraisal rake               # run tests on all versions of Rails
 ```
 
+If you need test logs, run with the env variable `AR_LOGGER` set to `1` i.e.
+
+``` bash
+AR_LOGGER=1 rake
+```
+
 Check out [more on appraisal](https://github.com/thoughtbot/appraisal#usage) if you need to add new versions of things or run into a version bug.
 
 ## Help Wanted
 
-We'd love to have your help making this better! If you have ideas for features this should implement or you think the code sucks, let us know. And PRs are greatly appreciated. :+1:
+I'd love to have your help making this better! If you have ideas for features this should implement or you think the code sucks, let us know. And PRs are greatly appreciated. :+1:
 
 ## Thanks
 
@@ -210,23 +240,25 @@ ActsAsParanoid and PermanentRecords were both inspirations for this:
 * http://github.com/technoweenie/acts_as_paranoid
 * http://github.com/fastestforward/permanent_records
 
-## Contributors
+## Contributors - Issues and Code!
 
 * Joel Meador
-* Michael Kuehl
-* Matthew Gordon
-* Vojtech Salbaba
-* David Jones
-* Dave Woodward
-* Miles Sterrett
-* James Hill
-* Maarten Claes
-* Anthony Panozzo
 * Aaron Milam
+* Anthony Panozzo
 * Anton Rieder
+* Dave Woodward
+* David Jones
+* Elijah Miller
+* James Hill
 * Josh Menden
+* Maarten Claes
+* Matthew Gordon
+* Michael Kuehl
+* Miles Sterrett
 * Sergey Gnuskov
-* Elijah Miller
+* Vojtech Salbaba
+* Lee Bernick
+* Chris Thornberry
 
 Thanks!
 

data/archival_record.gemspec

@@ -22,9 +22,7 @@ Gem::Specification.new do |gem|
                   "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 = ">= 3.0"
@@ -32,14 +30,16 @@ Gem::Specification.new do |gem|
   gem.add_dependency("activerecord", ">= 6.0")
 
   # rubocop:disable Gemspec/DevelopmentDependencies
+  gem.add_development_dependency("activejob", ">= 6.0")
   gem.add_development_dependency("appraisal")
   gem.add_development_dependency("database_cleaner")
+  gem.add_development_dependency("pry")
   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")
+  gem.add_development_dependency("sqlite3")
   # rubocop:enable Gemspec/DevelopmentDependencies
 
   gem.description =
@@ -52,5 +52,16 @@ 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"
+
+  gem.metadata = {
+    "bug_tracker_uri"       => "https://codeberg.org/joelmeador/archival_record/issues",
+    "changelog_uri"         => "https://codeberg.org/joelmeador/archival_record/src/branch/main/CHANGELOG.md",
+    "homepage_uri"          => "https://codeberg.org/joelmeador/archival_record/",
+    "rubygems_mfa_required" => "true",
+    "source_code_uri"       => "https://codeberg.org/joelmeador/archival_record/",
+    # "documentation_uri"     => "https://www.example.info/gems/bestgemever/0.0.1",
+    # "funding_uri"           => "https://example.com/donate"
+    # "mailing_list_uri"      => "https://groups.example.com/bestgemever",
+    # "wiki_uri"              => "https://example.com/user/bestgemever/wiki",
+  }
 end

data/gemfiles/rails_6.0.gemfile

@@ -3,5 +3,7 @@
 source "https://rubygems.org"
 
 gem "rails", "~> 6.0.0"
+gem "sqlite3", "< 2"
+gem "logger"
 
 gemspec path: "../"

data/gemfiles/rails_6.1.gemfile

@@ -3,5 +3,7 @@
 source "https://rubygems.org"
 
 gem "rails", "~> 6.1.0"
+gem "sqlite3", "< 2"
+gem "logger"
 
 gemspec path: "../"

data/gemfiles/rails_7.0.gemfile

@@ -3,5 +3,7 @@
 source "https://rubygems.org"
 
 gem "rails", "~> 7.0.0"
+gem "sqlite3", "< 2"
+gem "logger"
 
 gemspec path: "../"

data/gemfiles/rails_7.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 7.2.0"
+
+gemspec path: "../"

data/gemfiles/rails_8.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 8.0.0"
+
+gemspec path: "../"

data/lib/archival_record/version.rb

@@ -1,5 +1,5 @@
 module ArchivalRecord
 
-  VERSION = "3.0.1".freeze
+  VERSION = "4.0.1".freeze
 
 end

data/lib/archival_record.rb

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

data/lib/archival_record_core/archival_record.rb

@@ -1,4 +1,7 @@
+# Namespace for containing core extensions to active record
 module ArchivalRecordCore
+  # Primary holding module for defining our custom errors and the method installer that
+  # gets added to ApplicationRecord
   module ArchivalRecord
 
     require "digest/md5"
@@ -18,6 +21,8 @@ module ArchivalRecordCore
       base.extend ActMethods
     end
 
+    # this defines the class-level methods used to setup the archival record work on a given
+    # class.
     module ActMethods
 
       def archival_record(options = {})
@@ -41,10 +46,15 @@ module ArchivalRecordCore
       end
 
       private def setup_options(options)
-        default_options = { readonly_when_archived: false, archive_dependents: true }
+        default_options = {
+          readonly_when_archived: false,
+          archive_dependents: true,
+          raise_on_error: false
+        }
         options.reverse_merge!(default_options)
 
         define_method(:archive_dependents?) { options[:archive_dependents] }
+        define_method(:archival_raise_on_error?) { options[:raise_on_error] }
       end
 
       private def setup_validations(options)
@@ -53,8 +63,8 @@ module ArchivalRecordCore
       end
 
       private def setup_scopes
-        scope :archived, -> { where.not(archived_at: nil).where.not(archive_number: nil) }
-        scope :unarchived, -> { where(archived_at: nil, archive_number: nil) }
+        scope :archived, -> { where.not(archive_number: nil) }
+        scope :unarchived, -> { where(archive_number: nil) }
         scope :archived_from_archive_number,
               (lambda do |head_archive_number|
                  table = arel_table
@@ -87,6 +97,7 @@ module ArchivalRecordCore
       private def define_callback_dsl_method(callbackable_type, action)
         # rubocop:disable Security/Eval
         eval <<-END_CALLBACKS, binding, __FILE__, __LINE__ + 1
+          # The below block gets turned into something like this:
           # unless defined?(before_archive)
           #   def before_archive(*args, &blk)
           #     set_callback(:archive, :before, *args, &blk)
@@ -170,8 +181,11 @@ module ArchivalRecordCore
       end
 
       private def handle_archival_action_exception(exception)
-        ActiveRecord::Base.logger.try(:error, exception.message)
-        ActiveRecord::Base.logger.try(:error, exception.backtrace)
+        ApplicationRecord.logger.try(:error, exception.message)
+        ApplicationRecord.logger.try(:error, exception.backtrace)
+
+        raise if archival_raise_on_error?
+
         raise(ActiveRecord::Rollback)
       end