acts_as_archival 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e65cd1c6413e55892031258572cc4ca7e9730cd2
-  data.tar.gz: 671ceee75185386dd88546f5d31415005cba818b
+  metadata.gz: 57fc429ad5b01bdcf06307addddfbfbcaa6d9c28
+  data.tar.gz: cd104110c549dd3e187c7e0095e22b1c4ba59fda
 SHA512:
-  metadata.gz: ebc7ccc3c16ca1f0b13361e5c94763ef57ebc4399061bacadb4c1fbff032da8ab7f5e29dca1cc8f4241f7ebf00f797ad890ae29246dd19e5d5bfb9efd4e7936f
-  data.tar.gz: f6966a53472207bc16ca83b6e2c5cd990b8200249c0780abd85e1fe19682d9c77c27dcd89014d0b1bc561f6ee1ad4856bdd93c8fb5f171155b5dae34f548132a
+  metadata.gz: 67046bb797b64b2b7de8079f4b95a1c55e1a07d92614711a775ff372931997f156139ad6aa920d7bd2398d9376c5f06834c25a4404dd524728eb0602c659ee7b
+  data.tar.gz: 24cf648a878a16eba6b089bf60504f2609386cd4a39735e6e163e6ffe48d70a50830005fb4ac58a303f87ae73854c3b608cab6dd8669e1bafd340ab95b555e4d

data/.travis.yml

@@ -14,7 +14,7 @@ gemfile:
   - gemfiles/rails_4.1.gemfile
   - gemfiles/rails_4.2.gemfile
   - gemfiles/rails_5.0.gemfile
-  - gemfiles/rails_5.1.beta.gemfile
+  - gemfiles/rails_5.1.gemfile
 
 before_install:
   - gem update --system
@@ -23,12 +23,10 @@ before_install:
 
 matrix:
   fast_finish: true
-  allow_failures:
-    - gemfile: gemfiles/rails_5.1.beta.gemfile
   exclude:
     - rvm: 2.1.10
       gemfile: gemfiles/rails_5.0.gemfile
     - rvm: 2.1.10
-      gemfile: gemfiles/rails_5.1.beta.gemfile
+      gemfile: gemfiles/rails_5.1.gemfile
     - rvm: 2.4.0
       gemfile: gemfiles/rails_4.1.gemfile

data/Appraisals

@@ -7,9 +7,9 @@ appraise "rails-4.2" do
 end
 
 appraise "rails-5.0" do
-  gem "rails", "~> 5.0", ">= 5.0.2"
+  gem "rails", "~> 5.0.0"
 end
 
-appraise "rails-5.1.beta" do
-  gem 'rails', '~> 5.1.0.beta1'
+appraise "rails-5.1" do
+  gem "rails", "~> 5.1.0"
 end

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # CHANGELOG
 
+## 1.3.0 - October 21, 2017
+* deprecate `#archive` and `#unarchive` in favor of `#archive!` and `#unarchive!` [#36](https://github.com/expectedbehavior/acts_as_archival/pull/36)
+
 ## 1.2.0 - March 19, 2017
 * **BREAKING CHANGE** the utility instance and class method `is_archival?` is now `archival?`. `is_archival?` is deprecated and will be removed
 * hard dependency on rails 4.1+ – this shouldn't break anything since it was de facto before, but worth mentioning

data/README.md

@@ -41,7 +41,7 @@ _If you're stuck on Rails 4.0x/3x/2x, check out the older tags/branches, which a
 ``` ruby
 class Hole < ActiveRecord::Base
   acts_as_archival
-  has_many :rats, :dependent => :destroy
+  has_many :rats, dependent: :destroy
 end
 
 class Rat < ActiveRecord::Base
@@ -54,11 +54,11 @@ end
 ``` ruby
 h = Hole.create                  #
 h.archived?                      # => false
-h.archive                        # => true
+h.archive!                       # => true
 h.archived?                      # => true
 h.archive_number                 # => "b56876de48a5dcfe71b2c13eec15e4a2"
 h.archived_at                    # => Thu, 01 Jan 2012 01:49:21 -0400
-h.unarchive                      # => true
+h.unarchive!                     # => true
 h.archived?                      # => false
 h.archive_number                 # => nil
 h.archived_at                    # => nil
@@ -69,11 +69,11 @@ h.archived_at                    # => nil
 ``` ruby
 h = Hole.create                  #
 r = h.rats.create                #
-h.archive                        # => true
+h.archive!                       # => true
 h.archive_number                 # => "b56876de48a5dcfe71b2c13eec15e4a2"
 r.archived_at                    # => Thu, 01 Jan 2012 01:52:12 -0400
 r.archived?                      # => true
-h.unarchive                      # => true
+h.unarchive!                     # => true
 h.archive_number                 # => nil
 r.archived_at                    # => nil
 r.archived?                      # => false
@@ -85,7 +85,7 @@ r.archived?                      # => false
 h = Hole.create
 Hole.archived.size               # => 0
 Hole.unarchived.size             # => 1
-h.archive
+h.archive!
 Hole.archived.size               # => 1
 Hole.unarchived.size             # => 0
 ```
@@ -103,16 +103,16 @@ Hole.is_archival?             # => true # deprecated
 ### Options
 
 When defining an AAA model, it is is possible to make it unmodifiable
-when it is archived by passing `:readonly_when_archived => true` to the
+when it is archived by passing `readonly_when_archived: true` to the
 `acts_as_archival` call in your model.
 
 ``` ruby
 class CantTouchThis < ActiveRecord::Base
-  acts_as_archival :readonly_when_archived => true
+  acts_as_archival readonly_when_archived: true
 end
 
-record = CantTouchThis.create(:foo => "bar")
-record.archive                               # => true
+record = CantTouchThis.create(foo: "bar")
+record.archive!                              # => true
 record.foo = "I want this to work"
 record.save                                  # => false
 record.errors.full_messages.first            # => "Cannot modify an archived record."
@@ -126,12 +126,16 @@ AAA models have four additional callbacks to do any necessary cleanup or other p
 class Hole < ActiveRecord::Base
   acts_as_archival
 
+  # runs before #archive!
   before_archive :some_method_before_archiving
 
+  # runs after #archive!
   after_archive :some_method_after_archiving
 
+  # runs before #unarchive!
   before_unarchive :some_method_before_unarchiving
 
+  # runs after #unarchive!
   after_unarchive :some_method_after_unarchiving
 
   # ... implement those methods

data/gemfiles/rails_5.0.gemfile

@@ -2,6 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 5.0", ">= 5.0.2"
+gem "rails", "~> 5.0.0"
 
 gemspec :path => "../"

data/gemfiles/{rails_5.1.beta.gemfile → rails_5.1.gemfile}

@@ -2,6 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 5.1.0.beta1"
+gem "rails", "~> 5.1.0"
 
 gemspec :path => "../"

data/lib/acts_as_archival/version.rb

@@ -1,5 +1,5 @@
 module ActsAsArchival
 
-  VERSION = "1.2.0".freeze
+  VERSION = "1.3.0".freeze
 
 end

data/lib/expected_behavior/acts_as_archival.rb

@@ -105,6 +105,14 @@ module ExpectedBehavior
       end
 
       def archive(head_archive_number = nil)
+        ActiveSupport::Deprecation.warn <<-EOS.strip_heredoc.gsub(/\s+/, " ")
+          '.archive' is deprecated and will be removed in future versions of acts_as_archival.
+          Please use '.archive!' instead.
+        EOS
+        archive!(head_archive_number)
+      end
+
+      def archive!(head_archive_number = nil)
         execute_archival_action(:archive) do
           unless archived?
             head_archive_number ||= Digest::MD5.hexdigest("#{self.class.name}#{id}")
@@ -117,6 +125,14 @@ module ExpectedBehavior
       end
 
       def unarchive(head_archive_number = nil)
+        ActiveSupport::Deprecation.warn <<-EOS.strip_heredoc.gsub(/\s+/, " ")
+          '.unarchive' is deprecated and will be removed in future versions of acts_as_archival.
+          Please use '.unarchive!' instead.
+        EOS
+        unarchive!(head_archive_number)
+      end
+
+      def unarchive!(head_archive_number = nil)
         execute_archival_action(:unarchive) do
           if archived?
             head_archive_number ||= archive_number

data/lib/expected_behavior/association_operation/archive.rb

@@ -7,7 +7,7 @@ module ExpectedBehavior
 
         def act_on_archivals(archivals)
           archivals.unarchived.find_each do |related_record|
-            raise ActiveRecord::Rollback unless related_record.archive(head_archive_number)
+            raise ActiveRecord::Rollback unless related_record.archive!(head_archive_number)
           end
         end
 

data/lib/expected_behavior/association_operation/unarchive.rb

@@ -7,7 +7,7 @@ module ExpectedBehavior
 
         def act_on_archivals(scope)
           scope.archived.where(archive_number: head_archive_number).find_each do |related_record|
-            raise ActiveRecord::Rollback unless related_record.unarchive(head_archive_number)
+            raise ActiveRecord::Rollback unless related_record.unarchive!(head_archive_number)
           end
         end
 

data/test/ambiguous_table_test.rb

@@ -5,7 +5,7 @@ class AmbiguousTableTest < ActiveSupport::TestCase
   test "no ambiguous table problem" do
     archival = Archival.create!
     child = archival.archivals.create!
-    child.archive
+    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

data/test/application_record_test.rb

@@ -6,13 +6,13 @@ if defined?(ApplicationRecord)
 
     test "archive archives the record" do
       archival = ApplicationRecordRow.create!
-      archival.archive
+      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
+      archival.unarchive!
       assert_not archival.reload.archived?
     end
 

data/test/associations_test.rb

@@ -5,7 +5,7 @@ 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
+    archival.archive!
 
     assert archival.reload.archived?
     assert child.reload.archived?
@@ -14,7 +14,7 @@ class AssociationsTest < ActiveSupport::TestCase
   test "archive acts on all objects in the 'has_' relationship" do
     archival = Archival.create!
     children = [archival.archivals.create!, archival.archivals.create!]
-    archival.archive
+    archival.archive!
 
     assert archival.reload.archived?
     assert children.map(&:reload).all?(&:archived?)
@@ -24,8 +24,8 @@ class AssociationsTest < ActiveSupport::TestCase
     archival = Archival.create!
     archival.archivals.create!
     prearchived_child = archival.archivals.create!
-    prearchived_child.archive
-    archival.archive
+    prearchived_child.archive!
+    archival.archive!
 
     assert_not_equal archival.archive_number, prearchived_child.reload.archive_number
   end
@@ -33,7 +33,7 @@ class AssociationsTest < ActiveSupport::TestCase
   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
+    archival.archive!
 
     assert     archival.reload.archived?
     assert_not non_dependent_child.reload.archived?
@@ -42,7 +42,7 @@ class AssociationsTest < ActiveSupport::TestCase
   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
+    archival.archive!
 
     assert archival.archived?
     assert plain.reload
@@ -51,7 +51,7 @@ class AssociationsTest < ActiveSupport::TestCase
   test "archive sets the object hierarchy to all have the same archive_number" do
     archival = Archival.create!
     child = archival.archivals.create!
-    archival.archive
+    archival.archive!
     expected_digest = Digest::MD5.hexdigest("Archival#{archival.id}")
 
     assert_equal expected_digest, archival.archive_number
@@ -61,8 +61,8 @@ class AssociationsTest < ActiveSupport::TestCase
   test "unarchive acts on child objects" do
     archival = Archival.create!
     child = archival.archivals.create!
-    archival.archive
-    archival.unarchive
+    archival.archive!
+    archival.unarchive!
 
     assert_not archival.archived?
     assert_not child.reload.archived?
@@ -72,9 +72,9 @@ class AssociationsTest < ActiveSupport::TestCase
     archival = Archival.create!
     child = archival.archivals.create!
     prearchived_child = archival.archivals.create!
-    prearchived_child.archive
-    archival.archive
-    archival.unarchive
+    prearchived_child.archive!
+    archival.archive!
+    archival.unarchive!
 
     assert_not archival.archived?
     assert_not child.reload.archived?
@@ -84,9 +84,9 @@ class AssociationsTest < ActiveSupport::TestCase
   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
+    archival.archive!
+    independent.archive!(archival.archive_number)
+    archival.unarchive!
 
     assert_not archival.reload.archived?
     assert_not independent.reload.archived?
@@ -95,8 +95,8 @@ class AssociationsTest < ActiveSupport::TestCase
   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
+    prearchived_child.archive!
+    archival.unarchive!
 
     assert prearchived_child.reload.archived?
   end

data/test/basic_test.rb

@@ -4,43 +4,43 @@ class BasicTest < ActiveSupport::TestCase
 
   test "archive archives the record" do
     archival = Archival.create!
-    archival.archive
+    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
+    archival.unarchive!
     assert_equal false, archival.reload.archived?
   end
 
   test "archive returns true on success" do
     normal = Archival.create!
-    assert_equal true, normal.archive
+    assert_equal true, normal.archive!
   end
 
   test "archive returns false on failure" do
     readonly = Archival.create!
     readonly.readonly!
-    assert_equal false, readonly.archive
+    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
+    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
+    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
+    archival.archive!
     sleep(0.001)
     after = DateTime.now
     assert before < archival.archived_at.to_datetime
@@ -49,16 +49,16 @@ class BasicTest < ActiveSupport::TestCase
 
   test "archive sets the archive number to the md5 hexdigest for the model and id that is archived" do
     archival = Archival.create!
-    archival.archive
+    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
+    archived.archive!
     initial_number = archived.archive_number
-    archived.reload.archive
+    archived.reload.archive!
     second_number = archived.archive_number
     assert_equal initial_number, second_number
   end

data/test/callbacks_test.rb

@@ -7,7 +7,7 @@ class CallbacksTest < ActiveSupport::TestCase
       archival = CallbackArchival5.create
       archival.set_this_value = "a test string"
       assert_nil archival.settable_field
-      archival.archive
+      archival.archive!
       assert_equal "a test string", archival.reload.settable_field
     end
 
@@ -16,7 +16,7 @@ class CallbacksTest < ActiveSupport::TestCase
       archival.set_this_value = "a test string"
       archival.pass_callback = false
       assert_nil archival.settable_field
-      archival.archive
+      archival.archive!
       assert_nil archival.reload.settable_field
     end
   else
@@ -24,7 +24,7 @@ class CallbacksTest < ActiveSupport::TestCase
       archival = CallbackArchival4.create
       archival.set_this_value = "a test string"
       assert_nil archival.settable_field
-      archival.archive
+      archival.archive!
       assert_equal "a test string", archival.reload.settable_field
     end
 
@@ -33,7 +33,7 @@ class CallbacksTest < ActiveSupport::TestCase
       archival.set_this_value = "a test string"
       archival.pass_callback = false
       assert_nil archival.settable_field
-      archival.archive
+      archival.archive!
       assert_nil archival.reload.settable_field
     end
   end

data/test/deep_nesting_test.rb

@@ -6,7 +6,7 @@ class DeepNestingTest < ActiveSupport::TestCase
     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?
@@ -22,7 +22,7 @@ class DeepNestingTest < ActiveSupport::TestCase
     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?

data/test/polymorphic_test.rb

@@ -5,7 +5,7 @@ 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?
@@ -18,7 +18,7 @@ class PolymorphicTest < ActiveSupport::TestCase
     }
     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?

data/test/readonly_when_archived_test.rb

@@ -4,7 +4,7 @@ class ReadonlyWhenArchivedTest < ActiveSupport::TestCase
 
   test "acts_as_archival objects can normally be altered after archive" do
     archival = Archival.create!(name: "original")
-    archival.archive
+    archival.archive!
     archival.name = "updated"
     archival.save!
 
@@ -13,7 +13,7 @@ class ReadonlyWhenArchivedTest < ActiveSupport::TestCase
 
   test "acts_as_archival marked as readonly_when_archived cannot be updated after archive" do
     archival = ReadonlyWhenArchived.create!(name: "original")
-    archival.archive
+    archival.archive!
     archival.name = "updated"
 
     assert_not archival.save

data/test/scope_test.rb

@@ -10,15 +10,15 @@ class ScopeTest < ActiveSupport::TestCase
   end
 
   test "simple archived scope" do
-    Archival.create!.archive
-    Archival.create!.archive
+    Archival.create!.archive!
+    Archival.create!.archive!
 
     assert_equal 2, Archival.archived.count
   end
 
   test "mixed scopes" do
     Archival.create!
-    Archival.create!.archive
+    Archival.create!.archive!
 
     assert_equal 1, Archival.archived.count
     assert_equal 1, Archival.unarchived.count
@@ -26,8 +26,8 @@ class ScopeTest < ActiveSupport::TestCase
 
   test "simple archived_from_archive_number" do
     archive_number = "TEST-IT"
-    Archival.create!.archive(archive_number)
-    Archival.create!.archive(archive_number)
+    Archival.create!.archive!(archive_number)
+    Archival.create!.archive!(archive_number)
 
     assert_equal 2, Archival.archived_from_archive_number(archive_number).count
   end
@@ -35,16 +35,16 @@ class ScopeTest < ActiveSupport::TestCase
   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)
+    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
+    Archival.create!.archive!(archive_number)
+    Archival.create!.archive!
 
     assert_equal 1, Archival.archived_from_archive_number(archive_number).count
   end
@@ -69,7 +69,7 @@ class ScopeTest < ActiveSupport::TestCase
     Archival.create!(name: "Bobby")
     Archival.create!(name: "Sue")
     bob = Archival.create!(name: "Bob")
-    bob.archive
+    bob.archive!
     assert_equal 3, Archival.bobs.count
     assert_equal 3, Archival.unarchived.count
     assert_equal 2, Archival.bobs.unarchived.count
@@ -83,7 +83,7 @@ class ScopeTest < ActiveSupport::TestCase
     parent.archivals.create!
     parent.archivals.create!
     child = parent.archivals.create!
-    child.archive
+    child.archive!
     assert_equal 3, parent.archivals.count
     assert_equal 1, parent.archivals.archived.count
     assert_equal 2, parent.archivals.unarchived.count

data/test/through_association_test.rb

@@ -6,7 +6,7 @@ class ThroughAssociationTest < ActiveSupport::TestCase
     archival = Archival.create!
     bridge   = archival.archival_kids.create!
     through  = bridge.archival_grandkids.create!
-    archival.archive
+    archival.archive!
 
     assert archival.reload.archived?
     assert bridge.reload.archived?

data/test/transaction_test.rb

@@ -7,9 +7,9 @@ class TransactionTest < ActiveSupport::TestCase
     archival = Archival.create!
     exploder = archival.exploders.create!
     any_instance_of(Exploder) do |canary|
-      stub(canary).archive { raise "Rollback Imminent" }
+      stub(canary).archive! { raise "Rollback Imminent" }
     end
-    archival.archive
+    archival.archive!
 
     assert_not archival.archived?, "If this failed, you might be trying to test on a system that doesn't support nested transactions"
     assert_not exploder.reload.archived?
@@ -19,10 +19,10 @@ class TransactionTest < ActiveSupport::TestCase
     archival = Archival.create!
     exploder = archival.exploders.create!
     any_instance_of(Exploder) do |canary|
-      stub(canary).unarchive { raise "Rollback Imminent" }
+      stub(canary).unarchive! { raise "Rollback Imminent" }
     end
-    archival.archive
-    archival.unarchive
+    archival.archive!
+    archival.unarchive!
 
     assert archival.reload.archived?
     assert exploder.reload.archived?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_archival
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Joel Meador
@@ -16,7 +16,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-19 00:00:00.000000000 Z
+date: 2017-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -167,7 +167,7 @@ files:
 - gemfiles/rails_4.1.gemfile
 - gemfiles/rails_4.2.gemfile
 - gemfiles/rails_5.0.gemfile
-- gemfiles/rails_5.1.beta.gemfile
+- gemfiles/rails_5.1.gemfile
 - init.rb
 - lib/acts_as_archival.rb
 - lib/acts_as_archival/version.rb