acts_as_archival 0.6.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 175bbdb26230acbbbee4329bda6dd6bfc6eae3d5
-  data.tar.gz: d07f9da7b94fa39b6768cb369e20f7f84ddd4585
+  metadata.gz: cff5862053f75da82a37e18eb5f014118fcc4702
+  data.tar.gz: a3289e80a677888517c5862d4905f2cbb44aad0f
 SHA512:
-  metadata.gz: 995e99fa5c849235e10b5b7588cf1fa62fcb97271833ca941462d832769fd32ffbefd02f3d0f9dbacdb6bd0bb3c0bfd65b2fd6ea08425d937cd7e42aa82ecc27
-  data.tar.gz: 00f416f9999d273e490d56aad4309f3b639518a4868c904fb79d7f3a747b0c6b70df4c108646e8b91205ffc14d7f77d594d069c6bb912b4c0ee04cf92bd2f81c
+  metadata.gz: 175eb9267a176e8047d4f23b6e5bd4c3c25e496f4ce4bcb61d61ccafd93ae5fddf2f6b9a9ece625a68bd76df83c82cb8e6b110ccec1ad958f37663aeeed11eba
+  data.tar.gz: f9abce355fe369749c02bf609ad2abfbfad7e482fb3393c3d12bdf9ef13b99fd80afdaa0ad83bcb9e512ae57f3527510d8279a4f8989f269a0b1a055fbdadf73

data/CHANGELOG.md

@@ -1,4 +1,7 @@
-# Changes!
+# CHANGELOG
+
+## 1.0.0
+* **BREAKING CHANGE** make `#archived?` return an actual boolean value
 
 ## 0.6.1
 * Fix deprecation warnings on Rails 4.1

data/README.md

@@ -15,6 +15,10 @@ Additionally, other plugins generally screw with how
 `destroy`/`delete` work.  We don't because we actually want to be able
 to destroy records.
 
+## Maintenance
+
+You might read the commit logs and think "This must be abandonware! This hasn't been updated in 2y!" But! This is a mature project that solves a specific problem in ActiveRecord. It tends to only be updated when a new major version of ActiveRecord comes out and hence the infrequent updates.
+
 ## Install
 
 Gemfile:
@@ -27,7 +31,7 @@ i.e. `rails g migration AddAAAToPost archive_number archived_at:datetime`
 
 Any dependent-destroy AAA model associated to an AAA model will be archived with its parent.
 
-_If you're stuck on Rails 3.0x/2, check out the available branches._
+_If you're stuck on Rails 3x/2x, check out the available branches, which are no longer in active development._
 
 ## Example
 
@@ -48,7 +52,7 @@ end
 h = Hole.create                  #
 h.archived?                      # => false
 h.archive                        # => true
-h.archived?                      # => "b56876de48a5dcfe71b2c13eec15e4a2"
+h.archived?                      # => true
 h.archive_number                 # => "b56876de48a5dcfe71b2c13eec15e4a2"
 h.archived_at                    # => Thu, 01 Jan 2012 01:49:21 -0400
 h.unarchive                      # => true
@@ -65,7 +69,7 @@ r = h.rats.create                #
 h.archive                        # => true
 h.archive_number                 # => "b56876de48a5dcfe71b2c13eec15e4a2"
 r.archive_number                 # => "b56876de48a5dcfe71b2c13eec15e4a2"
-r.archived?                      # => "b56876de48a5dcfe71b2c13eec15e4a2"
+r.archived?                      # => true
 h.unarchive                      # => true
 h.archive_number                 # => nil
 r.archive_number                 # => nil
@@ -109,6 +113,30 @@ record.save                                  # => false
 record.errors.full_messages.first            # => "Cannot modify an archived record."
 ```
 
+### Callbacks
+
+AAA models have four additional callbacks to do any necessary cleanup or other processing before and after archiving and unarchiving, and can additionally halt the archive callback chain.
+
+``` ruby
+class Hole < ActiveRecord::Base
+  acts_as_archival
+
+  before_archive :some_method_before_archiving
+
+  after_archive :some_method_after_archiving
+
+  before_unarchive :some_method_before_unarchiving
+
+  after_unarchive :some_method_before_unarchiving
+
+  # ... implement those methods
+end
+```
+
+#### Halting the callback chain
+
+The callback method should return a `false` value.
+
 ## Caveats
 
 1. This will only work on associations that are dependent destroy. It
@@ -153,4 +181,4 @@ ActsAsParanoid and PermanentRecords were both inspirations for this:
 
 Thanks!
 
-*Copyright (c) 2009-2013 Expected Behavior, LLC, released under the MIT license*
+*Copyright (c) 2009-2016 Expected Behavior, LLC, released under the MIT license*

data/acts_as_archival.gemspec

@@ -16,10 +16,8 @@ Gem::Specification.new do |gem|
                      "James Hill",
                      "Maarten Claes"]
   gem.email       = ["joel@expectedbehavior.com",
-                     "michael@expectedbehavior.com",
                      "matt@expectedbehavior.com",
                      "jason@expectedbehavior.com",
-                     "tyler@expectedbehavior.com",
                      "nathan@expectedbehavior.com"]
   gem.homepage    = "http://github.com/expectedbehavior/acts_as_archival"
 

data/lib/acts_as_archival/version.rb

@@ -1,3 +1,3 @@
 module ActsAsArchival
-  VERSION = "0.6.1"
+  VERSION = "1.0.0"
 end

data/lib/expected_behavior/acts_as_archival.rb

@@ -55,7 +55,7 @@ module ExpectedBehavior
       end
 
       def archived?
-        self.archived_at? && self.archive_number
+        !!(self.archived_at? && self.archive_number)
       end
 
       def archive(head_archive_number=nil)

data/test/basic_test.rb

@@ -4,13 +4,13 @@ class BasicTest < ActiveSupport::TestCase
   test "archive archives the record" do
     archival = Archival.create!
     archival.archive
-    assert archival.reload.archived?
+    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_not archival.reload.archived?
+    assert_equal false, archival.reload.archived?
   end
 
   test "archive returns true on success" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_archival
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Joel Meador
@@ -16,7 +16,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-24 00:00:00.000000000 Z
+date: 2016-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -160,10 +160,8 @@ description: |
   don't because we actually want to be able to destroy records.
 email:
 - joel@expectedbehavior.com
-- michael@expectedbehavior.com
 - matt@expectedbehavior.com
 - jason@expectedbehavior.com
-- tyler@expectedbehavior.com
 - nathan@expectedbehavior.com
 executables: []
 extensions: []
@@ -240,7 +238,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Atomic archiving/unarchiving for ActiveRecord-based apps