acts_as_archival 0.4.0

data/test/ambiguous_table_test.rb

@@ -0,0 +1,12 @@
+require_relative "test_helper"
+
+class AmbiguousTableTest < ActiveSupport::TestCase
+  # test against the problem fixed in http://github.com/DarkTatka/acts_as_archival/commit/63d0a2532a15d7a6ab41d081e1591108a5ea9b37
+  test "no ambiguous table problem" do
+    archival = Archival.create!(:name => "TEST")
+    child = archival.archivals.create!
+    child.archive
+
+    assert_equal 1, Archival.unarchived.count(:joins => :archivals)
+  end
+end

data/test/associations_test.rb

@@ -0,0 +1,102 @@
+require_relative "test_helper"
+
+class ActsAsArchivalTest < 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!
+    child = 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,64 @@
+require_relative "test_helper"
+
+class BasicTest < ActiveSupport::TestCase
+  test "archive archives the record" do
+    archival = Archival.create!
+
+    archival.archive
+    assert archival.archived?
+  end
+
+  test "unarchive unarchives archival records" do
+    archival = Archival.create!(:archived_at => Time.now, :archive_number => 1)
+    archival.unarchive
+
+    assert_not archival.archived?
+  end
+
+  test "archive returns true on success, false on failure" do
+    archival = Archival.create!
+    readonly = Archival.create!
+    readonly.readonly!
+
+    assert_equal true,  archival.archive
+    assert_equal false, readonly.archive
+  end
+
+  test "unarchive returns true on success, false on failure" do
+    archived = Archival.create!(:archived_at => Time.now, :archive_number => "1")
+    readonly = Archival.create!(:archived_at => Time.now, :archive_number => "2")
+    readonly.readonly!
+
+    assert_equal true,  archived.unarchive
+    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_between before, 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/column_test.rb

@@ -0,0 +1,15 @@
+require_relative "test_helper"
+
+class ColumnTest < ActiveSupport::TestCase
+  test "acts_as_archival raises during create if missing archived_at column" do
+    assert_raises(ExpectedBehavior::ActsAsArchival::MissingArchivalColumnError) {
+      MissingArchivedAt.create!(:name => "foo-foo")
+    }
+  end
+
+  test "acts_as_archival raises during create if missing archive_number column" do
+    assert_raises(ExpectedBehavior::ActsAsArchival::MissingArchivalColumnError) {
+      MissingArchiveNumber.create!(:name => "rover")
+    }
+  end
+end

data/test/database.yml

@@ -0,0 +1,8 @@
+adapter: mysql2
+encoding: utf8
+reconnect: false
+database: aaa_test
+pool: 5
+username: archival_tester
+password: perspicacious
+socket: /tmp/mysql.sock

data/test/deep_nesting_test.rb

@@ -0,0 +1,29 @@
+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?
+  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/fixtures/archival.rb

@@ -0,0 +1,15 @@
+# name           - string
+# archival_id    - integer
+# archive_number - string
+# archived_at    - datetime
+class Archival < ActiveRecord::Base
+  acts_as_archival
+
+  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
+end

data/test/fixtures/archival_grandkid.rb

@@ -0,0 +1,4 @@
+class ArchivalGrandkid < ActiveRecord::Base
+  acts_as_archival
+  belongs_to :archival_kid
+end

data/test/fixtures/archival_kid.rb

@@ -0,0 +1,5 @@
+class ArchivalKid < ActiveRecord::Base
+  acts_as_archival
+  belongs_to :archival
+  has_many :archival_grandkids, :dependent => :destroy
+end

data/test/fixtures/exploder.rb

@@ -0,0 +1,5 @@
+class Exploder < ActiveRecord::Base
+  acts_as_archival
+
+  belongs_to :archival
+end

data/test/fixtures/independent_archival.rb

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

data/test/fixtures/mass_attribute_protected.rb

@@ -0,0 +1,4 @@
+class MassAttributeProtected < ActiveRecord::Base
+  acts_as_archival
+  attr_accessible :name
+end

data/test/fixtures/missing_archive_number.rb

@@ -0,0 +1,3 @@
+class MissingArchiveNumber < ActiveRecord::Base
+  acts_as_archival
+end

data/test/fixtures/missing_archived_at.rb

@@ -0,0 +1,3 @@
+class MissingArchivedAt < ActiveRecord::Base
+  acts_as_archival
+end

data/test/fixtures/plain.rb

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

data/test/fixtures/poly.rb

@@ -0,0 +1,9 @@
+# -*- coding: utf-8 -*-
+# archiveable_id   - integer
+# archiveable_type - string
+# archive_number   - string
+# archived_at      - datetime
+class Poly < ActiveRecord::Base
+  acts_as_archival
+  belongs_to :archiveable, :polymorphic => true
+end

data/test/fixtures/readonly_when_archived.rb

@@ -0,0 +1,3 @@
+class ReadonlyWhenArchived < ActiveRecord::Base
+  acts_as_archival :readonly_when_archived => true
+end

data/test/mass_attribute_test.rb

@@ -0,0 +1,18 @@
+require_relative "test_helper"
+
+class MassAttributeTest < ActiveSupport::TestCase
+  test "archive works when attr_accessible present" do
+    archival = MassAttributeProtected.create(:color => "pink")
+    archival.archive
+
+    assert archival.reload.archived?
+  end
+
+  test "unarchive works when attr_accessible present" do
+    archival = MassAttributeProtected.create(:color => "pink")
+    archival.archive
+    archival.unarchive
+
+    assert_not archival.reload.archived?
+  end
+end

data/test/polymorphic_test.rb

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

data/test/readonly_when_archived_test.rb

@@ -0,0 +1,22 @@
+require_relative "test_helper"
+
+class ReadonlyWhenArchivedTest < ActiveSupport::TestCase
+  test "acts_as_archival 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 "acts_as_archival 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 modifify an archived record.",
+                 archival.errors.full_messages.first
+  end
+end

data/test/responds_test.rb

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

data/test/schema.rb

@@ -0,0 +1,67 @@
+ActiveRecord::Schema.define(:version => 1) do
+
+  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 :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 :exploders, :force => true do |t|
+    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 :mass_attribute_protecteds, :force => true do |t|
+    t.column :name, :string
+    t.column :archive_number, :string
+    t.column :archived_at, :datetime
+  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
+end