archival_record 2.0.0

data/test/fixtures/deprecated_warning_archival.rb

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

data/test/fixtures/exploder.rb

@@ -0,0 +1,10 @@
+# archival_id     - integer
+# archive_number  - string
+# archived_at     - datetime
+class Exploder < ActiveRecord::Base
+
+  archival_record
+
+  belongs_to :archival
+
+end

data/test/fixtures/independent_archival.rb

@@ -0,0 +1,11 @@
+# name           - string
+# archival_id    - integer
+# archive_number - string
+# archived_at    - datetime
+class IndependentArchival < ActiveRecord::Base
+
+  archival_record
+
+  belongs_to :archival
+
+end

data/test/fixtures/missing_archive_number.rb

@@ -0,0 +1,7 @@
+# name           - string
+# archived_at    - datetime
+class MissingArchiveNumber < ActiveRecord::Base
+
+  archival_record
+
+end

data/test/fixtures/missing_archived_at.rb

@@ -0,0 +1,7 @@
+# name           - string
+# archive_number - string
+class MissingArchivedAt < ActiveRecord::Base
+
+  archival_record
+
+end

data/test/fixtures/plain.rb

@@ -0,0 +1,7 @@
+# name        - string
+# archival_id - integer
+class Plain < ActiveRecord::Base
+
+  belongs_to :archival
+
+end

data/test/fixtures/poly.rb

@@ -0,0 +1,11 @@
+# archiveable_id   - integer
+# archiveable_type - string
+# archive_number   - string
+# archived_at      - datetime
+class Poly < ActiveRecord::Base
+
+  archival_record
+
+  belongs_to :archiveable, polymorphic: true
+
+end

data/test/fixtures/readonly_when_archived.rb

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

data/test/polymorphic_test.rb

@@ -0,0 +1,50 @@
+require_relative "test_helper"
+
+class PolymorphicTest < ActiveSupport::TestCase
+
+  test "archive item with polymorphic association" do
+    archival = Archival.create!
+    poly = archival.polys.create!
+    archival.archive!
+
+    assert archival.reload.archived?
+    assert poly.reload.archived?
+  end
+
+  test "does not archive polymorphic association of different item with same id" do
+    archival = Archival.create!
+    another_polys_holder = AnotherPolysHolder.create!(id: archival.id)
+    poly = another_polys_holder.polys.create!
+    archival.archive!
+
+    assert_not poly.reload.archived?
+  end
+
+  test "unarchive item with polymorphic association" do
+    archive_attributes = {
+      archive_number: "test",
+      archived_at: Time.now
+    }
+    archival = Archival.create!(archive_attributes)
+    poly = archival.polys.create!(archive_attributes)
+    archival.unarchive!
+
+    assert_not archival.reload.archived?
+    assert_not poly.reload.archived?
+  end
+
+  test "does not unarchive polymorphic association of different item with same id" do
+    archive_attributes = {
+      archive_number: "test",
+      archived_at: Time.now
+    }
+
+    archival = Archival.create!(archive_attributes)
+    another_polys_holder = AnotherPolysHolder.create!(archive_attributes.merge(id: archival.id))
+    poly = another_polys_holder.polys.create!(archive_attributes)
+    archival.unarchive!
+
+    assert poly.reload.archived?
+  end
+
+end

data/test/readonly_when_archived_test.rb

@@ -0,0 +1,24 @@
+require_relative "test_helper"
+
+class ReadonlyWhenArchivedTest < ActiveSupport::TestCase
+
+  test "archival_record objects can normally be altered after archive" do
+    archival = Archival.create!(name: "original")
+    archival.archive!
+    archival.name = "updated"
+    archival.save!
+
+    assert_equal "updated", archival.reload.name
+  end
+
+  test "archival_record marked as readonly_when_archived cannot be updated after archive" do
+    archival = ReadonlyWhenArchived.create!(name: "original")
+    archival.archive!
+    archival.name = "updated"
+
+    assert_not archival.save
+    assert_equal "Cannot modify an archived record.",
+                 archival.errors.full_messages.first
+  end
+
+end

data/test/relations_test.rb

@@ -0,0 +1,63 @@
+require_relative "test_helper"
+
+class RelationsTest < ActiveSupport::TestCase
+
+  test "archive_all! archives all records in an AR Association" do
+    3.times { Archival.create! }
+
+    archivals = Archival.all
+    archivals.archive_all!
+    assert archivals.first.archived?
+    assert archivals.last.archived?
+  end
+
+  test "archive_all! archives all records with the same archival number" do
+    3.times { Archival.create! }
+
+    archivals = Archival.all
+    archivals.archive_all!
+    assert_equal archivals.first.archive_number, archivals.last.archive_number
+  end
+
+  test "archive_all! archives children records" do
+    3.times do
+      parent = Archival.create!
+      2.times do
+        parent.archivals.create!
+      end
+    end
+
+    parents = Archival.all
+    parents.archive_all!
+
+    assert parents.first.archivals.first.archived?
+    assert parents.first.archivals.last.archived?
+  end
+
+  test "unarchive_all! unarchives all records in an AR Assocation" do
+    3.times { Archival.create! }
+
+    archivals = Archival.all
+    archivals.archive_all!
+    archivals.unarchive_all!
+    assert_not archivals.first.archived?
+    assert_not archivals.last.archived?
+  end
+
+  test "unarchive_all! unarchives children records" do
+    3.times do
+      parent = Archival.create!
+      2.times do
+        parent.archivals.create!
+      end
+    end
+
+    parents = Archival.all
+    parents.archive_all!
+    parents.unarchive_all!
+
+    assert_not parents.first.archivals.first.archived?
+    assert_not parents.first.archivals.last.archived?
+  end
+
+end

data/test/responds_test.rb

@@ -0,0 +1,15 @@
+require_relative "test_helper"
+
+class RespondsTest < ActiveSupport::TestCase
+
+  test "archival class responds correctly to 'archival?'" do
+    assert     Archival.archival?
+    assert_not Plain.archival?
+  end
+
+  test "archival object responds correctly to 'archival?'" do
+    assert     Archival.new.archival?
+    assert_not Plain.new.archival?
+  end
+
+end

data/test/schema.rb

@@ -0,0 +1,96 @@
+ActiveRecord::Schema.define(version: 1) do
+  create_table :another_polys_holders, force: true do |t|
+    t.column :name, :string
+    t.column :archival_id, :integer
+    t.column :archive_number, :string
+    t.column :archived_at, :datetime
+  end
+
+  create_table :archivals, force: true do |t|
+    t.column :name, :string
+    t.column :archival_id, :integer
+    t.column :archive_number, :string
+    t.column :archived_at, :datetime
+  end
+
+  create_table :exploders, force: true do |t|
+    t.column :archival_id, :integer
+    t.column :archive_number, :string
+    t.column :archived_at, :datetime
+  end
+
+  create_table :archival_kids, force: true do |t|
+    t.column :archival_id, :integer
+    t.column :archive_number, :string
+    t.column :archived_at, :datetime
+  end
+
+  create_table :archival_grandkids, force: true do |t|
+    t.column :archival_kid_id, :integer
+    t.column :archive_number, :string
+    t.column :archived_at, :datetime
+  end
+
+  create_table :independent_archivals, force: true do |t|
+    t.column :name, :string
+    t.column :archival_id, :integer
+    t.column :archive_number, :string
+    t.column :archived_at, :datetime
+  end
+
+  create_table :plains, force: true do |t|
+    t.column :name, :string
+    t.column :archival_id, :integer
+  end
+
+  create_table :readonly_when_archiveds, force: true do |t|
+    t.column :name, :string
+    t.column :archive_number, :string
+    t.column :archived_at, :datetime
+  end
+
+  create_table :missing_archived_ats, force: true do |t|
+    t.column :name, :string
+    t.column :archive_number, :string
+  end
+
+  create_table :missing_archive_numbers, force: true do |t|
+    t.column :name, :string
+    t.column :archived_at, :datetime
+  end
+
+  create_table :polys, force: true do |t|
+    t.references :archiveable, polymorphic: true
+    t.column :archive_number, :string
+    t.column :archived_at, :datetime
+  end
+
+  create_table :legacy, force: true do |t|
+    t.column :name, :string
+    t.column :archive_number, :string
+    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|
+    t.column :settable_field, :string
+    t.column :archive_number, :string
+    t.column :archived_at, :datetime
+  end
+
+  create_table :deprecated_warning_archivals, force: true do |t|
+    t.column :archival_id, :integer
+    t.column :archive_number, :string
+    t.column :archived_at, :datetime
+  end
+end

data/test/scope_test.rb

@@ -0,0 +1,92 @@
+require_relative "test_helper"
+
+class ScopeTest < ActiveSupport::TestCase
+
+  test "simple unarchived scope" do
+    Archival.create!
+    Archival.create!
+
+    assert_equal 2, Archival.unarchived.count
+  end
+
+  test "simple archived scope" do
+    Archival.create!.archive!
+    Archival.create!.archive!
+
+    assert_equal 2, Archival.archived.count
+  end
+
+  test "mixed scopes" do
+    Archival.create!
+    Archival.create!.archive!
+
+    assert_equal 1, Archival.archived.count
+    assert_equal 1, Archival.unarchived.count
+  end
+
+  test "simple archived_from_archive_number" do
+    archive_number = "TEST-IT"
+    Archival.create!.archive!(archive_number)
+    Archival.create!.archive!(archive_number)
+
+    assert_equal 2, Archival.archived_from_archive_number(archive_number).count
+  end
+
+  test "negative archived_from_archive_number" do
+    archive_number = "TEST-IT"
+    bogus_number = "BROKE-IT"
+    Archival.create!.archive!(archive_number)
+    Archival.create!.archive!(archive_number)
+
+    assert_equal 0, Archival.archived_from_archive_number(bogus_number).count
+  end
+
+  test "mixed archived_from_archive_number" do
+    archive_number = "TEST-IT"
+    Archival.create!.archive!(archive_number)
+    Archival.create!.archive!
+
+    assert_equal 1, Archival.archived_from_archive_number(archive_number).count
+  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
+    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
+
+  test "combines with other scope properly" do
+    Archival.create!(name: "Robert")
+    Archival.create!(name: "Bobby")
+    Archival.create!(name: "Sue")
+    bob = Archival.create!(name: "Bob")
+    bob.archive!
+    assert_equal 3, Archival.bobs.count
+    assert_equal 3, Archival.unarchived.count
+    assert_equal 2, Archival.bobs.unarchived.count
+    assert_equal 2, Archival.unarchived.bobs.count
+    assert_equal 1, Archival.bobs.archived.count
+    assert_equal 1, Archival.archived.bobs.count
+  end
+
+  test "scopes combine with relations correctly" do
+    parent = Archival.create!
+    parent.archivals.create!
+    parent.archivals.create!
+    child = parent.archivals.create!
+    child.archive!
+    assert_equal 3, parent.archivals.count
+    assert_equal 1, parent.archivals.archived.count
+    assert_equal 2, parent.archivals.unarchived.count
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,91 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + "/../lib")
+
+require "bundler/setup"
+require "minitest/autorun"
+require "minitest/pride"
+
+require "active_record"
+require "database_cleaner"
+
+require "archival_record"
+
+ActiveSupport::TestCase.test_order = :random if ActiveSupport::TestCase.respond_to?(:test_order=)
+
+def prepare_for_tests
+  setup_logging
+  setup_database_cleaner
+  create_test_tables
+  require_test_classes
+end
+
+def setup_logging
+  require "logger"
+  logfile = File.dirname(__FILE__) + "/debug.log"
+  ActiveRecord::Base.logger = Logger.new(logfile)
+end
+
+def setup_database_cleaner
+  DatabaseCleaner.strategy = :truncation
+  ActiveSupport::TestCase.send(:setup) do
+    DatabaseCleaner.clean
+  end
+end
+
+def sqlite_config
+  {
+    adapter: "sqlite3",
+    database: "archival_record_test.sqlite3",
+    pool: 5,
+    timeout: 5000
+  }
+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)
+end
+
+BASE_FIXTURE_CLASSES = %I[
+  another_polys_holder
+  archival
+  archival_kid
+  archival_grandkid
+  archival_table_name
+  exploder
+  independent_archival
+  missing_archived_at
+  missing_archive_number
+  plain
+  poly
+  readonly_when_archived
+  deprecated_warning_archival
+].freeze
+
+RAILS_4_FIXTURE_CLASSES = %I[
+  callback_archival_4
+].freeze
+
+RAILS_5_FIXTURE_CLASSES = %I[
+  application_record
+  application_record_row
+  callback_archival_5
+].freeze
+
+def require_test_classes
+  ActiveSupport::Inflector.inflections do |inflect|
+    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}" }
+end
+
+prepare_for_tests