archival_record 2.0.0

data/script/setup

@@ -0,0 +1,9 @@
+#!/bin/sh
+set -e
+cd "`dirname \"$0\"`/.."
+
+echo "\n---=== Bundling ===---"
+bundle install
+
+echo "\n---=== Setting up various rails versions for testing ===---"
+bundle exec appraisal install

data/test/ambiguous_table_test.rb

@@ -0,0 +1,16 @@
+require_relative "test_helper"
+
+class AmbiguousTableTest < ActiveSupport::TestCase
+
+  test "no ambiguous table problem" do
+    archival = Archival.create!
+    child = archival.archivals.create!
+    child.archive!
+
+    # this is a bug fix for a problem wherein table names weren't being
+    # namespaced, so if a table joined against itself, incorrect SQL was
+    # generated
+    assert_equal 1, Archival.unarchived.joins(:archivals).count
+  end
+
+end

data/test/application_record_test.rb

@@ -0,0 +1,20 @@
+require_relative "test_helper"
+
+# Rails 5 introduced a new base class, and this is gonna test that
+if defined?(ApplicationRecord)
+  class ApplicationRecordTest < ActiveSupport::TestCase
+
+    test "archive archives the record" do
+      archival = ApplicationRecordRow.create!
+      archival.archive!
+      assert archival.reload.archived?
+    end
+
+    test "unarchive unarchives archival records" do
+      archival = ApplicationRecordRow.create!(archived_at: Time.now, archive_number: 1)
+      archival.unarchive!
+      assert_not archival.reload.archived?
+    end
+
+  end
+end

data/test/associations_test.rb

@@ -0,0 +1,104 @@
+require_relative "test_helper"
+
+class AssociationsTest < ActiveSupport::TestCase
+
+  test "archive archives 'has_' associated archival objects that are dependent destroy" do
+    archival = Archival.create!
+    child = archival.archivals.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!]
+    archival.archive!
+
+    assert archival.reload.archived?
+    assert children.map(&:reload).all?(&:archived?)
+  end
+
+  test "archive does not act on already archived objects" do
+    archival = Archival.create!
+    archival.archivals.create!
+    prearchived_child = archival.archivals.create!
+    prearchived_child.archive!
+    archival.archive!
+
+    assert_not_equal archival.archive_number, prearchived_child.reload.archive_number
+  end
+
+  test "archive does not archive 'has_' associated archival objects that are not dependent destroy" do
+    archival = Archival.create!
+    non_dependent_child = archival.independent_archivals.create!
+    archival.archive!
+
+    assert     archival.reload.archived?
+    assert_not non_dependent_child.reload.archived?
+  end
+
+  test "archive doesn't do anything to associated dependent destroy models that are non-archival" do
+    archival = Archival.create!
+    plain = archival.plains.create!
+    archival.archive!
+
+    assert archival.archived?
+    assert plain.reload
+  end
+
+  test "archive sets the object hierarchy to all have the same archive_number" do
+    archival = Archival.create!
+    child = archival.archivals.create!
+    archival.archive!
+    expected_digest = Digest::MD5.hexdigest("Archival#{archival.id}")
+
+    assert_equal expected_digest, archival.archive_number
+    assert_equal expected_digest, child.reload.archive_number
+  end
+
+  test "unarchive acts on child objects" do
+    archival = Archival.create!
+    child = archival.archivals.create!
+    archival.archive!
+    archival.unarchive!
+
+    assert_not archival.archived?
+    assert_not child.reload.archived?
+  end
+
+  test "unarchive does not act on already archived objects" do
+    archival = Archival.create!
+    child = archival.archivals.create!
+    prearchived_child = archival.archivals.create!
+    prearchived_child.archive!
+    archival.archive!
+    archival.unarchive!
+
+    assert_not archival.archived?
+    assert_not child.reload.archived?
+    assert     prearchived_child.reload.archived?
+  end
+
+  test "unarchive acts on 'has_' associated non-dependent_destroy objects" do
+    archival = Archival.create!
+    independent = archival.independent_archivals.create!
+    archival.archive!
+    independent.archive!(archival.archive_number)
+    archival.unarchive!
+
+    assert_not archival.reload.archived?
+    assert_not independent.reload.archived?
+  end
+
+  test "unarchive doesn't unarchive associated objects if the head object is already unarchived" do
+    archival = Archival.create!
+    prearchived_child = archival.archivals.create!
+    prearchived_child.archive!
+    archival.unarchive!
+
+    assert prearchived_child.reload.archived?
+  end
+
+end

data/test/basic_test.rb

@@ -0,0 +1,66 @@
+require_relative "test_helper"
+
+class BasicTest < ActiveSupport::TestCase
+
+  test "archive archives the record" do
+    archival = Archival.create!
+    archival.archive!
+    assert_equal true, archival.reload.archived?
+  end
+
+  test "unarchive unarchives archival records" do
+    archival = Archival.create!(archived_at: Time.now, archive_number: 1)
+    archival.unarchive!
+    assert_equal false, archival.reload.archived?
+  end
+
+  test "archive returns true on success" do
+    normal = Archival.create!
+    assert_equal true, normal.archive!
+  end
+
+  test "archive returns false on failure" do
+    readonly = Archival.create!
+    readonly.readonly!
+    assert_equal false, readonly.archive!
+  end
+
+  test "unarchive returns true on success" do
+    normal = Archival.create!(archived_at: Time.now, 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.readonly!
+    assert_equal false, readonly.unarchive!
+  end
+
+  test "archive sets archived_at to the time of archiving" do
+    archival = Archival.create!
+    before = DateTime.now
+    sleep(0.001)
+    archival.archive!
+    sleep(0.001)
+    after = DateTime.now
+    assert before < archival.archived_at.to_datetime
+    assert after > archival.archived_at.to_datetime
+  end
+
+  test "archive sets the archive number to the md5 hexdigest for the model and id that is archived" do
+    archival = Archival.create!
+    archival.archive!
+    expected_digest = Digest::MD5.hexdigest("#{archival.class.name}#{archival.id}")
+    assert_equal expected_digest, archival.archive_number
+  end
+
+  test "archive on archived object doesn't alter the archive_number" do
+    archived = Archival.create
+    archived.archive!
+    initial_number = archived.archive_number
+    archived.reload.archive!
+    second_number = archived.archive_number
+    assert_equal initial_number, second_number
+  end
+
+end

data/test/callbacks_test.rb

@@ -0,0 +1,41 @@
+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 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
+  end
+
+end

data/test/column_test.rb

@@ -0,0 +1,17 @@
+require_relative "test_helper"
+
+class ColumnTest < ActiveSupport::TestCase
+
+  test "archival_record raises during create if missing archived_at column" do
+    assert_raises(ArchivalRecordCore::ArchivalRecord::MissingArchivalColumnError) do
+      MissingArchivedAt.create!(name: "foo-foo")
+    end
+  end
+
+  test "archival_record raises during create if missing archive_number column" do
+    assert_raises(ArchivalRecordCore::ArchivalRecord::MissingArchivalColumnError) do
+      MissingArchiveNumber.create!(name: "rover")
+    end
+  end
+
+end

data/test/deep_nesting_test.rb

@@ -0,0 +1,35 @@
+require_relative "test_helper"
+
+class DeepNestingTest < ActiveSupport::TestCase
+
+  test "archiving deeply nested items" do
+    archival = Archival.create!
+    child = archival.archivals.create!
+    grandchild = child.archivals.create!
+
+    archival.archive!
+
+    assert archival.reload.archived?
+    assert child.reload.archived?
+    assert grandchild.reload.archived?
+    assert_equal archival.archive_number, child.archive_number
+    assert_equal archival.archive_number, grandchild.archive_number
+  end
+
+  test "unarchiving deeply nested items doesn't blow up" do
+    archival_attributes = {
+      archived_at: Time.now,
+      archive_number: "test"
+    }
+    archival = Archival.create!(archival_attributes)
+    child = archival.archivals.create!(archival_attributes)
+    grandchild = child.archivals.create!(archival_attributes)
+
+    archival.unarchive!
+
+    assert_not archival.reload.archived?
+    assert_not child.reload.archived?
+    assert_not grandchild.reload.archived?
+  end
+
+end

data/test/deprecated_warning_archival_test.rb

@@ -0,0 +1,11 @@
+require_relative "test_helper"
+
+class DeprecatedWarningArchivalTest < ActiveSupport::TestCase
+
+  test "models with 'acts_as_archival' instead of 'archival_record' can still archive a record" do
+    archival = DeprecatedWarningArchival.create!
+    archival.archive!
+    assert_equal true, archival.reload.archived?
+  end
+
+end

data/test/fixtures/another_polys_holder.rb

@@ -0,0 +1,11 @@
+# name           - string
+# archival_id    - integer
+# archive_number - string
+# archived_at    - datetime
+class AnotherPolysHolder < ActiveRecord::Base
+
+  archival_record
+
+  has_many :polys, dependent: :destroy, as: :archiveable
+
+end

data/test/fixtures/application_record.rb

@@ -0,0 +1,5 @@
+class ApplicationRecord < ActiveRecord::Base
+
+  self.abstract_class = true
+
+end

data/test/fixtures/application_record_row.rb

@@ -0,0 +1,8 @@
+# Rails 5 introduced a new base class, and this is gonna be used in the tests of that
+if defined?(ApplicationRecord)
+  class ApplicationRecordRow < ApplicationRecord
+
+    archival_record
+
+  end
+end

data/test/fixtures/archival.rb

@@ -0,0 +1,19 @@
+# name           - string
+# archival_id    - integer
+# archive_number - string
+# archived_at    - datetime
+class Archival < ActiveRecord::Base
+
+  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 :independent_archivals
+
+  scope :bobs, -> { where(name: %w[Bob Bobby Robert]) }
+
+end

data/test/fixtures/archival_grandkid.rb

@@ -0,0 +1,10 @@
+# archival_kid_id - integer
+# archive_number  - string
+# archived_at     - datetime
+class ArchivalGrandkid < ActiveRecord::Base
+
+  archival_record
+
+  belongs_to :archival_kid
+
+end

data/test/fixtures/archival_kid.rb

@@ -0,0 +1,11 @@
+# archival_id     - integer
+# archive_number  - string
+# archived_at     - datetime
+class ArchivalKid < ActiveRecord::Base
+
+  archival_record
+
+  belongs_to :archival
+  has_many :archival_grandkids, dependent: :destroy
+
+end

data/test/fixtures/archival_table_name.rb

@@ -0,0 +1,10 @@
+# name           - string
+# archive_number - string
+# archived_at    - datetime
+class ArchivalTableName < ActiveRecord::Base
+
+  self.table_name = "legacy"
+
+  archival_record
+
+end

data/test/fixtures/callback_archival_4.rb

@@ -0,0 +1,19 @@
+class CallbackArchival4 < ActiveRecord::Base
+
+  archival_record
+
+  attr_accessor :set_this_value,
+                :pass_callback
+
+  before_archive :set_value,
+                 :conditional_callback_passer
+
+  private def set_value
+    self.settable_field = set_this_value
+  end
+
+  private def conditional_callback_passer
+    pass_callback || pass_callback.nil?
+  end
+
+end

data/test/fixtures/callback_archival_5.rb

@@ -0,0 +1,23 @@
+# necessary for ApplicationRecord
+if defined?(ApplicationRecord)
+  class CallbackArchival5 < ApplicationRecord
+
+    archival_record
+
+    attr_accessor :set_this_value,
+                  :pass_callback
+
+    before_archive :set_value,
+                   :conditional_callback_passer
+
+    private def set_value
+      self.settable_field = set_this_value
+    end
+
+    private def conditional_callback_passer
+      # we want to throw only for the value false
+      throw(:abort) unless pass_callback || pass_callback.nil?
+    end
+
+  end
+end