archival_record 3.0.0 → 4.0.0

data/lib/archival_record_core/association_operation/base.rb

@@ -3,6 +3,21 @@ module ArchivalRecordCore
     module AssociationOperation
       class Base
 
+        ACTIVE_RECORD_REQUIREMENT_DESTROY_ASYNC = Gem::Requirement.new(">= 6.1.0")
+
+        # :destroy_async was added as an option in rails 6.1 but seems very buggy there
+        # wrt to configuration
+        DEPENDENT_OPTIONS_TO_OPERATE_ON_RAILS_6_0 = %i[
+          destroy
+          delete_all
+        ].freeze
+
+        DEPENDENT_OPTIONS_TO_OPERATE_ON_RAILS = %i[
+          destroy
+          destroy_async
+          delete_all
+        ].freeze
+
         attr_reader :model, :head_archive_number
 
         def initialize(model, head_archive_number)
@@ -32,8 +47,16 @@ module ArchivalRecordCore
             association.options[:through].nil?
         end
 
-        def association_conditions_met?(_association)
-          true
+        def dependent_options_to_operate_on
+          if ACTIVE_RECORD_REQUIREMENT_DESTROY_ASYNC.satisfied_by?(ActiveRecord.version)
+            DEPENDENT_OPTIONS_TO_OPERATE_ON_RAILS
+          else
+            DEPENDENT_OPTIONS_TO_OPERATE_ON_RAILS_6_0
+          end
+        end
+
+        def association_conditions_met?(association)
+          dependent_options_to_operate_on.include?(association.options[:dependent])
         end
 
         def act_on_association(association)

data/shell.nix

@@ -0,0 +1,41 @@
+{
+  lib ? import <lib> {},
+  pkgs ? import (fetchTarball channel:nixos-24.11) {}
+}:
+
+let
+
+  # define packages to install with special handling for OSX
+  basePackages = [
+    pkgs.gnumake
+    pkgs.gcc
+    pkgs.readline
+    pkgs.zlib
+    pkgs.libxml2
+    pkgs.libiconv
+    pkgs.libffi
+    pkgs.openssl
+    pkgs.curl
+    pkgs.git
+
+    pkgs.sqlite
+
+    pkgs.ruby_3_2
+    pkgs.bundler
+  ];
+
+  inputs = basePackages
+    ++ [ pkgs.bashInteractive ]
+    ++ pkgs.lib.optionals pkgs.stdenv.isLinux [ pkgs.inotify-tools ]
+    ++ pkgs.lib.optionals pkgs.stdenv.isDarwin (with pkgs.darwin.apple_sdk.frameworks; [
+        CoreFoundation
+        CoreServices
+      ]);
+
+in pkgs.mkShell {
+  buildInputs = inputs;
+
+  shellHook = ''
+    export APP_HOME=$(pwd);
+  '';
+}

data/test/associations_test.rb

@@ -11,6 +11,26 @@ class AssociationsTest < ActiveSupport::TestCase
     assert child.reload.archived?
   end
 
+  if ActiveRecord.version >= Gem::Version.new("6.1.0")
+    test "archive archives 'has_' associated archival objects that are dependent destroy_async" do
+      archival = Archival.create!
+      child = archival.archivals_destroy_async.create!
+      archival.archive!
+
+      assert archival.reload.archived?
+      assert child.reload.archived?
+    end
+  end
+
+  test "archive archives 'has_' associated archival objects that are dependent delete_all" do
+    archival = Archival.create!
+    child = archival.archivals_delete.create!
+    archival.archive!
+
+    assert archival.reload.archived?
+    assert child.reload.archived?
+  end
+
   test "archive acts on all objects in the 'has_' relationship" do
     archival = Archival.create!
     children = [archival.archivals.create!, archival.archivals.create!]
@@ -81,7 +101,7 @@ class AssociationsTest < ActiveSupport::TestCase
     assert     prearchived_child.reload.archived?
   end
 
-  test "unarchive acts on 'has_' associated non-dependent_destroy objects" do
+  test "unarchive does not act on 'has_' associated non-dependent_destroy objects" do
     archival = Archival.create!
     independent = archival.independent_archivals.create!
     archival.archive!
@@ -89,7 +109,7 @@ class AssociationsTest < ActiveSupport::TestCase
     archival.unarchive!
 
     assert_not archival.reload.archived?
-    assert_not independent.reload.archived?
+    assert independent.reload.archived?
   end
 
   test "unarchive doesn't unarchive associated objects if the head object is already unarchived" do

data/test/bogus_relation_test.rb

@@ -0,0 +1,22 @@
+require_relative "test_helper"
+
+class BogusRelationTest < ActiveSupport::TestCase
+
+  test "does not successfully archive" do
+    archival = BogusRelation.create!
+    stub(ApplicationRecord.logger).error(
+      satisfy do |arg|
+        if arg.is_a?(String)
+          arg.match?(/\ASQLite3::SQLException: no such column: bogus_relations.bogus_relation_id/)
+        elsif arg.is_a?(Array)
+          arg.join.match?(%r{gems/activerecord}) # this is gonna be in the stack trace somewhere
+        else
+          raise "unexpected logging"
+        end
+      end
+    )
+    assert_not archival.archive!
+    assert_not archival.reload.archived?
+  end
+
+end

data/test/callbacks_test.rb

@@ -2,40 +2,21 @@ require_relative "test_helper"
 
 class CallbacksTest < ActiveSupport::TestCase
 
-  if defined?(ApplicationRecord)
-    test "can set a value as part of archiving" do
-      archival = CallbackArchival5.create
-      archival.set_this_value = "a test string"
-      assert_nil archival.settable_field
-      archival.archive!
-      assert_equal "a test string", archival.reload.settable_field
-    end
-
-    test "can be halted" do
-      archival = CallbackArchival5.create
-      archival.set_this_value = "a test string"
-      archival.pass_callback = false
-      assert_nil archival.settable_field
-      archival.archive!
-      assert_nil archival.reload.settable_field
-    end
-  else
-    test "can set a value as part of archiving" do
-      archival = CallbackArchival4.create
-      archival.set_this_value = "a test string"
-      assert_nil archival.settable_field
-      archival.archive!
-      assert_equal "a test string", archival.reload.settable_field
-    end
+  test "can set a value as part of archiving" do
+    archival = CallbackArchival.create
+    archival.set_this_value = "a test string"
+    assert_nil archival.settable_field
+    archival.archive!
+    assert_equal "a test string", archival.reload.settable_field
+  end
 
-    test "can be halted" do
-      archival = CallbackArchival4.create
-      archival.set_this_value = "a test string"
-      archival.pass_callback = false
-      assert_nil archival.settable_field
-      archival.archive!
-      assert_nil archival.reload.settable_field
-    end
+  test "can be halted" do
+    archival = CallbackArchival.create
+    archival.set_this_value = "a test string"
+    archival.pass_callback = false
+    assert_nil archival.settable_field
+    archival.archive!
+    assert_nil archival.reload.settable_field
   end
 
 end

data/test/exception_test.rb

@@ -0,0 +1,9 @@
+class ExceptionTest < ActiveSupport::TestCase
+
+  test "raises an exception when given that option" do
+    readonly = ExceptionRaiser.create!(archived_at: Time.now.utc, archive_number: "1")
+    readonly.readonly!
+    assert_raises(ActiveRecord::ReadOnlyRecord) { readonly.unarchive! }
+  end
+
+end

data/test/fixtures/another_polys_holder.rb

@@ -2,7 +2,7 @@
 # archival_id    - integer
 # archive_number - string
 # archived_at    - datetime
-class AnotherPolysHolder < ActiveRecord::Base
+class AnotherPolysHolder < ApplicationRecord
 
   archival_record
 

data/test/fixtures/archival.rb

@@ -2,18 +2,24 @@
 # archival_id    - integer
 # archive_number - string
 # archived_at    - datetime
-class Archival < ActiveRecord::Base
+class Archival < ApplicationRecord
 
   archival_record
 
-  has_many :archivals,          dependent: :destroy
-  has_many :archival_kids,      dependent: :destroy
-  has_many :archival_grandkids, dependent: :destroy, through: :archival_kids
-  has_many :exploders,          dependent: :destroy
-  has_many :plains,             dependent: :destroy
-  has_many :polys,              dependent: :destroy, as: :archiveable
+  has_many :archivals, dependent: :destroy
+  if ActiveRecord.version >= Gem::Version.new("6.1.0")
+    has_many :archivals_destroy_async, dependent: :destroy_async, class_name: "Archival"
+  end
+  has_many :archivals_delete,        dependent: :delete_all, class_name: "Archival"
+  has_many :archival_kids,           dependent: :destroy
+  has_many :archival_grandkids,      dependent: :destroy, through: :archival_kids
+  has_many :exploders,               dependent: :destroy
+  has_many :plains,                  dependent: :destroy
+  has_many :polys,                   dependent: :destroy, as: :archiveable
   has_many :independent_archivals
 
+  has_and_belongs_to_many :many_many_archivals
+
   scope :bobs, -> { where(name: %w[Bob Bobby Robert]) }
 
 end

data/test/fixtures/archival_grandkid.rb

@@ -1,7 +1,7 @@
 # archival_kid_id - integer
 # archive_number  - string
 # archived_at     - datetime
-class ArchivalGrandkid < ActiveRecord::Base
+class ArchivalGrandkid < ApplicationRecord
 
   archival_record
 

data/test/fixtures/archival_kid.rb

@@ -1,7 +1,7 @@
 # archival_id     - integer
 # archive_number  - string
 # archived_at     - datetime
-class ArchivalKid < ActiveRecord::Base
+class ArchivalKid < ApplicationRecord
 
   archival_record
 

data/test/fixtures/archival_table_name.rb

@@ -1,7 +1,7 @@
 # name           - string
 # archive_number - string
 # archived_at    - datetime
-class ArchivalTableName < ActiveRecord::Base
+class ArchivalTableName < ApplicationRecord
 
   self.table_name = "legacy"
 

data/test/fixtures/bogus_relation.rb

@@ -0,0 +1,6 @@
+class BogusRelation < ApplicationRecord
+
+  archival_record
+  has_many :bogus_relations, dependent: :destroy
+
+end

data/test/fixtures/{callback_archival4.rb → callback_archival.rb}

@@ -1,4 +1,4 @@
-class CallbackArchival4 < ActiveRecord::Base
+class CallbackArchival < ApplicationRecord
 
   archival_record
 
@@ -13,7 +13,8 @@ class CallbackArchival4 < ActiveRecord::Base
   end
 
   private def conditional_callback_passer
-    pass_callback || pass_callback.nil?
+    # we want to throw only for the value false
+    throw(:abort) unless pass_callback || pass_callback.nil?
   end
 
 end

data/test/fixtures/deprecated_warning_archival.rb

@@ -1,7 +1,7 @@
 # archival_id    - integer
 # archive_number - string
 # archived_at    - datetime
-class DeprecatedWarningArchival < ActiveRecord::Base
+class DeprecatedWarningArchival < ApplicationRecord
 
   # This should throw a deprecation warning
   acts_as_archival

data/test/fixtures/exception_raiser.rb

@@ -0,0 +1,11 @@
+# name           - string
+# archival_id    - integer
+# archive_number - string
+# archived_at    - datetime
+class ExceptionRaiser < ApplicationRecord
+
+  self.table_name = :archivals
+
+  archival_record raise_on_error: true
+
+end

data/test/fixtures/explicit_act_on_dependents_archival.rb

@@ -1,6 +1,6 @@
 # archive_number                - string
 # archived_at                   - datetime
-class ExplicitActOnDependentsArchival < ActiveRecord::Base
+class ExplicitActOnDependentsArchival < ApplicationRecord
 
   archival_record archive_dependents: true
 

data/test/fixtures/exploder.rb

@@ -1,7 +1,7 @@
 # archival_id     - integer
 # archive_number  - string
 # archived_at     - datetime
-class Exploder < ActiveRecord::Base
+class Exploder < ApplicationRecord
 
   archival_record
 

data/test/fixtures/ignorable_dependent.rb

@@ -1,7 +1,7 @@
 # ignore_dependents_archival_id - integer
 # archive_number                - string
 # archived_at                   - datetime
-class IgnorableDependent < ActiveRecord::Base
+class IgnorableDependent < ApplicationRecord
 
   archival_record
 

data/test/fixtures/ignore_dependents_archival.rb

@@ -1,6 +1,6 @@
 # archive_number - string
 # archived_at    - datetime
-class IgnoreDependentsArchival < ActiveRecord::Base
+class IgnoreDependentsArchival < ApplicationRecord
 
   archival_record archive_dependents: false
 

data/test/fixtures/independent_archival.rb

@@ -2,7 +2,7 @@
 # archival_id    - integer
 # archive_number - string
 # archived_at    - datetime
-class IndependentArchival < ActiveRecord::Base
+class IndependentArchival < ApplicationRecord
 
   archival_record
 

data/test/fixtures/many_many_archival.rb

@@ -0,0 +1,9 @@
+# archive_number - string
+# archived_at    - datetime
+class ManyManyArchival < ApplicationRecord
+
+  archival_record
+
+  has_and_belongs_to_many :archivals
+
+end

data/test/fixtures/missing_archive_number.rb

@@ -1,6 +1,6 @@
 # name           - string
 # archived_at    - datetime
-class MissingArchiveNumber < ActiveRecord::Base
+class MissingArchiveNumber < ApplicationRecord
 
   archival_record
 

data/test/fixtures/missing_archived_at.rb

@@ -1,6 +1,6 @@
 # name           - string
 # archive_number - string
-class MissingArchivedAt < ActiveRecord::Base
+class MissingArchivedAt < ApplicationRecord
 
   archival_record
 

data/test/fixtures/nonignorable_dependent.rb

@@ -1,7 +1,7 @@
 # explicit_act_on_dependents_archival_id - integer
 # archive_number                         - string
 # archived_at                            - datetime
-class NonignorableDependent < ActiveRecord::Base
+class NonignorableDependent < ApplicationRecord
 
   archival_record
 

data/test/fixtures/plain.rb

@@ -1,6 +1,6 @@
 # name        - string
 # archival_id - integer
-class Plain < ActiveRecord::Base
+class Plain < ApplicationRecord
 
   belongs_to :archival
 

data/test/fixtures/poly.rb

@@ -2,7 +2,7 @@
 # archiveable_type - string
 # archive_number   - string
 # archived_at      - datetime
-class Poly < ActiveRecord::Base
+class Poly < ApplicationRecord
 
   archival_record
 

data/test/fixtures/readonly_when_archived.rb

@@ -1,7 +1,7 @@
 # name           - string
 # archive_number - string
 # archived_at    - datetime
-class ReadonlyWhenArchived < ActiveRecord::Base
+class ReadonlyWhenArchived < ApplicationRecord
 
   archival_record readonly_when_archived: true
 

data/test/performance/the_test.rb

@@ -0,0 +1,29 @@
+require_relative "../test_helper"
+
+module Performance
+  class TheTest < ActiveSupport::TestCase
+
+    ### What is this?
+    ### Well currently it's a testing harness for checking indices but it's useful to have a
+    ### test to check things out. And this is that.
+
+    # test "performance tester" do
+    #   puts "please hold, we are making ~10K records"
+
+    #   percent_to_archive = 20
+    #   records_to_make = 10_000
+
+    #   records_to_make.times do
+    #     archival = Archival.create!
+    #     archival.archive! if rand(100) <= percent_to_archive
+    #   end
+
+    #   # Archival.archived.explain
+    #   # Archival.unarchived.explain
+    #   # binding.pry
+
+    #   assert "we did it"
+    # end
+
+  end
+end

data/test/schema.rb

@@ -13,6 +13,9 @@ ActiveRecord::Schema.define(version: 1) do
     t.column :archived_at, :datetime
   end
 
+  add_index(:archivals, :archive_number)
+  add_index(:archivals, :archived_at)
+
   create_table :exploders, force: true do |t|
     t.column :archival_id, :integer
     t.column :archive_number, :string
@@ -71,18 +74,7 @@ ActiveRecord::Schema.define(version: 1) do
     t.column :archived_at, :datetime
   end
 
-  create_table :application_record_rows, force: true do |t|
-    t.column :archive_number, :string
-    t.column :archived_at, :datetime
-  end
-
-  create_table :callback_archival4s, force: true do |t|
-    t.column :settable_field, :string
-    t.column :archive_number, :string
-    t.column :archived_at, :datetime
-  end
-
-  create_table :callback_archival5s, force: true do |t|
+  create_table :callback_archivals, force: true do |t|
     t.column :settable_field, :string
     t.column :archive_number, :string
     t.column :archived_at, :datetime
@@ -115,4 +107,19 @@ ActiveRecord::Schema.define(version: 1) do
     t.column :archive_number, :string
     t.column :archived_at, :datetime
   end
+
+  create_table :bogus_relations, force: true do |t|
+    t.column :archive_number, :string
+    t.column :archived_at, :datetime
+  end
+
+  create_table :many_many_archivals, force: true do |t|
+    t.column :archive_number, :string
+    t.column :archived_at, :datetime
+  end
+
+  create_table :archivals_many_many_archivals, force: true do |t|
+    t.column :archival_id, :integer
+    t.column :many_many_archival_id, :integer
+  end
 end

data/test/scope_test.rb

@@ -50,16 +50,10 @@ class ScopeTest < ActiveSupport::TestCase
   end
 
   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'
-      else
-        'SELECT "legacy".* FROM "legacy" ' \
-          'WHERE ("legacy"."archived_at" IS NOT NULL) AND ("legacy"."archive_number" IS NOT NULL)'
-      end
+    archived_sql = 'SELECT "legacy".* FROM "legacy" ' \
+                   'WHERE "legacy"."archive_number" IS NOT NULL'
     unarchived_sql = 'SELECT "legacy".* FROM "legacy" ' \
-                     'WHERE "legacy"."archived_at" IS NULL AND "legacy"."archive_number" IS NULL'
+                     'WHERE "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,10 +1,17 @@
 $LOAD_PATH.unshift("#{File.dirname(__FILE__)}/../lib")
 
 require "bundler/setup"
+# you might be tempted to alphabetize this list of requires, but you should not.
+# and logger definitely needs to go first or nearly first.
+require "logger"
+
 require "minitest/autorun"
 require "minitest/pride"
+require "pry"
 
+require "active_job"
 require "active_record"
+require_relative "application_record"
 require "database_cleaner"
 
 require "archival_record"
@@ -12,6 +19,7 @@ require "archival_record"
 ActiveSupport::TestCase.test_order = :random if ActiveSupport::TestCase.respond_to?(:test_order=)
 
 def prepare_for_tests
+  setup_active_job if ActiveRecord.version >= Gem::Version.new("6.1.0")
   setup_logging
   setup_database_cleaner
   create_test_tables
@@ -19,9 +27,15 @@ def prepare_for_tests
 end
 
 def setup_logging
-  require "logger"
+  return if ENV["AR_LOGGER"] != "1"
+
   logfile = "#{File.dirname(__FILE__)}/debug.log"
-  ActiveRecord::Base.logger = Logger.new(logfile)
+  ApplicationRecord.logger = Logger.new(logfile)
+end
+
+def setup_active_job
+  # usually rails does this for you but we don't have rails do we
+  ActiveRecord::Base.destroy_association_async_job = ActiveRecord::DestroyAssociationAsyncJob
 end
 
 def setup_database_cleaner
@@ -46,38 +60,32 @@ end
 
 def create_test_tables
   puts "** Loading schema for SQLite"
-  ActiveRecord::Base.establish_connection(sqlite_config)
+  ApplicationRecord.establish_connection(sqlite_config)
   load(schema_file) if File.exist?(schema_file)
 end
 
-BASE_FIXTURE_CLASSES = %I[
+FIXTURE_CLASSES = %I[
   another_polys_holder
   archival
-  archival_kid
   archival_grandkid
+  archival_kid
   archival_table_name
+  bogus_relation
+  callback_archival
+  deprecated_warning_archival
+  exception_raiser
+  explicit_act_on_dependents_archival
   exploder
+  ignorable_dependent
+  ignore_dependents_archival
   independent_archival
-  missing_archived_at
+  many_many_archival
   missing_archive_number
+  missing_archived_at
+  nonignorable_dependent
   plain
   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_archival4
-].freeze
-
-RAILS_5_FIXTURE_CLASSES = %I[
-  application_record
-  application_record_row
-  callback_archival5
 ].freeze
 
 def require_test_classes
@@ -85,14 +93,7 @@ def require_test_classes
     inflect.irregular "poly", "polys"
   end
 
-  fixtures = if ActiveRecord::VERSION::MAJOR >= 4
-               RAILS_5_FIXTURE_CLASSES
-             else
-               RAILS_4_FIXTURE_CLASSES
-             end
-
-  fixtures += BASE_FIXTURE_CLASSES
-  fixtures.each { |test_class_file| require_relative "fixtures/#{test_class_file}" }
+  FIXTURE_CLASSES.each { |test_class_file| require_relative "fixtures/#{test_class_file}" }
 end
 
 prepare_for_tests