acts_as_archival 1.1.1 → 2.0.0

data/test/deep_nesting_test.rb

@@ -1,11 +1,12 @@
 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
+    archival.archive!
     assert archival.reload.archived?
     assert child.reload.archived?
     assert grandchild.reload.archived?
@@ -15,15 +16,16 @@ class DeepNestingTest < ActiveSupport::TestCase
 
   test "unarchiving deeply nested items doesn't blow up" do
     archival_attributes = {
-      :archived_at => Time.now,
-      :archive_number => "test"
+      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
+    archival.unarchive!
     assert_not archival.reload.archived?
     assert_not child.reload.archived?
     assert_not grandchild.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
+
+  acts_as_archival
+
+  has_many :polys, dependent: :destroy, as: :archiveable
+
+end

data/test/fixtures/application_record.rb

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

data/test/fixtures/application_record_row.rb

@@ -1,6 +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
+
     acts_as_archival
+
   end
 end

data/test/fixtures/archival.rb

@@ -3,15 +3,17 @@
 # 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 :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, lambda { where(:name => ["Bob", "Bobby", "Robert"]) }
+  scope :bobs, -> { where(name: %w[Bob Bobby Robert]) }
+
 end

data/test/fixtures/archival_grandkid.rb

@@ -2,6 +2,8 @@
 # archive_number  - string
 # archived_at     - datetime
 class ArchivalGrandkid < ActiveRecord::Base
+
   acts_as_archival
   belongs_to :archival_kid
+
 end

data/test/fixtures/archival_kid.rb

@@ -2,7 +2,9 @@
 # archive_number  - string
 # archived_at     - datetime
 class ArchivalKid < ActiveRecord::Base
+
   acts_as_archival
   belongs_to :archival
-  has_many :archival_grandkids, :dependent => :destroy
+  has_many :archival_grandkids, dependent: :destroy
+
 end

data/test/fixtures/archival_table_name.rb

@@ -2,6 +2,8 @@
 # archive_number - string
 # archived_at    - datetime
 class ArchivalTableName < ActiveRecord::Base
+
   self.table_name = "legacy"
   acts_as_archival
+
 end

data/test/fixtures/callback_archival_4.rb

@@ -1,4 +1,5 @@
 class CallbackArchival4 < ActiveRecord::Base
+
   acts_as_archival
 
   attr_accessor :set_this_value,
@@ -14,4 +15,5 @@ class CallbackArchival4 < ActiveRecord::Base
   private def conditional_callback_passer
     pass_callback || pass_callback.nil?
   end
+
 end

data/test/fixtures/callback_archival_5.rb

@@ -1,6 +1,7 @@
 # necessary for ApplicationRecord
 if defined?(ApplicationRecord)
   class CallbackArchival5 < ApplicationRecord
+
     acts_as_archival
 
     attr_accessor :set_this_value,
@@ -14,7 +15,9 @@ if defined?(ApplicationRecord)
     end
 
     private def conditional_callback_passer
-      throw(:abort) unless (pass_callback || pass_callback.nil?)
+      # we want to throw only for the value false
+      throw(:abort) unless pass_callback || pass_callback.nil?
     end
+
   end
 end

data/test/fixtures/exploder.rb

@@ -2,6 +2,8 @@
 # archive_number  - string
 # archived_at     - datetime
 class Exploder < ActiveRecord::Base
+
   acts_as_archival
   belongs_to :archival
+
 end

data/test/fixtures/independent_archival.rb

@@ -3,6 +3,8 @@
 # archive_number - string
 # archived_at    - datetime
 class IndependentArchival < ActiveRecord::Base
+
   acts_as_archival
   belongs_to :archival
+
 end

data/test/fixtures/missing_archive_number.rb

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

data/test/fixtures/missing_archived_at.rb

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

data/test/fixtures/plain.rb

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

data/test/fixtures/poly.rb

@@ -3,6 +3,8 @@
 # archive_number   - string
 # archived_at      - datetime
 class Poly < ActiveRecord::Base
+
   acts_as_archival
-  belongs_to :archiveable, :polymorphic => true
+  belongs_to :archiveable, polymorphic: true
+
 end

data/test/fixtures/readonly_when_archived.rb

@@ -2,5 +2,7 @@
 # archive_number - string
 # archived_at    - datetime
 class ReadonlyWhenArchived < ActiveRecord::Base
-  acts_as_archival :readonly_when_archived => true
+
+  acts_as_archival readonly_when_archived: true
+
 end

data/test/polymorphic_test.rb

@@ -1,25 +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
+    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
+      archive_number: "test",
+      archived_at: Time.now
     }
     archival = Archival.create!(archive_attributes)
     poly = archival.polys.create!(archive_attributes)
-    archival.unarchive
+    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

@@ -1,9 +1,10 @@
 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 = Archival.create!(name: "original")
+    archival.archive!
     archival.name = "updated"
     archival.save!
 
@@ -11,12 +12,13 @@ class ReadonlyWhenArchivedTest < ActiveSupport::TestCase
   end
 
   test "acts_as_archival marked as readonly_when_archived cannot be updated after archive" do
-    archival = ReadonlyWhenArchived.create!(:name => "original")
-    archival.archive
+    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

@@ -1,13 +1,15 @@
 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?
+
+  test "archival class responds correctly to 'archival?'" do
+    assert     Archival.archival?
+    assert_not Plain.archival?
   end
 
-  test "archival object responds correctly to 'is_archival?'" do
-    assert     Archival.new.is_archival?
-    assert_not Plain.new.is_archival?
+  test "archival object responds correctly to 'archival?'" do
+    assert     Archival.new.archival?
+    assert_not Plain.new.archival?
   end
+
 end

data/test/schema.rb

@@ -1,103 +1,90 @@
-# Rails 4.0 and before do not deal correctly with newer versions of mysql, so we're
-# gonna force a non-null primary ID for old versions of Rails just as new ones do.
-if (ActiveRecord.version <=> Gem::Version.new("4.1.0")) < 0
-  class ActiveRecord::ConnectionAdapters::Mysql2Adapter
-    NATIVE_DATABASE_TYPES[:primary_key] = "int(11) auto_increment PRIMARY KEY"
+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
-end
 
-ActiveRecord::Schema.define(:version => 1) do
-  create_table :archivals, :force => true do |t|
+  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|
+  create_table :exploders, force: true do |t|
     t.column :archival_id, :integer
     t.column :archive_number, :string
     t.column :archived_at, :datetime
   end
 
-  ###
-  # The classes above are used to test database-specific
-  # things in PG and MySQL, and we don't need to do all
-  # the tests there.
-  if "SQLite" == ActiveRecord::Base.connection.adapter_name
-    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 :archival_kids, force: true do |t|
+    t.column :archival_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 :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 :plains, :force => true do |t|
-      t.column :name, :string
-      t.column :archival_id, :integer
-    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 :mass_attribute_protecteds, :force => true do |t|
-      t.column :name, :string
-      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 :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_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 :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 :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 :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 :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_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 :callback_archival5s, force: true do |t|
+    t.column :settable_field, :string
+    t.column :archive_number, :string
+    t.column :archived_at, :datetime
   end
 end