archival_record 2.0.2 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 749d93406c2538c8252af9f61e801c7ff88d5d28e2f17b7c77f469958b02f1af
-  data.tar.gz: d98a6d346829cd376b87d39d42ea11893ca4508f9ecef47bd76042ca16e9960b
+  metadata.gz: de698cb4c6c28dbc975343cbb8c64040423a401fe1963486e4d43feacdaf70fd
+  data.tar.gz: 423dc258212a7b8ff4fb78a6acc29bc979846820c50263859e0d9d2a9e634c81
 SHA512:
-  metadata.gz: 9efc50a111d529028ef245000cb16fd0839153633c573da55e1b4a000051d9e222d64308f64c38a50e87deca1ac5f1ff930ad1cf2fe46aaa3edc3408aaabdbaa
-  data.tar.gz: 49a8420bbe12026628fff779c0a8592b2b9285e86ac28b18421afc52159321b77f1e01a51f0aef05610fb805d1bb4229707aa0d4d1085f57383ce93831fe9b19
+  metadata.gz: a24054ef6cd9fc3ed12233e10e11fa194e26f72499534925bdd4d4bad05b9245bb994763ba6b449b7100e48dda00ce30de641b51f9d6a797697fba2805335f84
+  data.tar.gz: 3dab3e39d40c31fcfe60129b8eb9a3fb420be3ece65c18a7bfa3da367026b9c44ecee1e4b721ea71bd28cc85920308d427d391ddab10e2a0a82e1e2203e9ff30

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,20 @@
 # CHANGELOG
 
+## 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
+
+## 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.1)
+      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.
@@ -21,23 +20,23 @@ Gemfile:
 
 `gem "archival_record"`
 
-Any models you want to be archival should have the columns `archive_number` (String) and `archived_at` (DateTime).
+Any models you want to be archival should have the columns `archive_number` (`String`) and `archived_at` (`DateTime`).
 
 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.
 
-_If you're stuck on Rails 4.0x/3x/2x, check out the older tags/branches, which are no longer in active development._
+_If you're stuck on Rails 5x/4x/3x/2x, check out the older tags/branches, which are no longer in active development._
 
 ## 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.1".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