acts_as_archival 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 57fc429ad5b01bdcf06307addddfbfbcaa6d9c28
-  data.tar.gz: cd104110c549dd3e187c7e0095e22b1c4ba59fda
+SHA256:
+  metadata.gz: 0453a0ad7518b6953ccc8fd43220c553177f41af9adf664c17ffc79b863ea08b
+  data.tar.gz: 71ae456902253a456381a61b6db990c3406e55c388c0d4cf61997015820b00ba
 SHA512:
-  metadata.gz: 67046bb797b64b2b7de8079f4b95a1c55e1a07d92614711a775ff372931997f156139ad6aa920d7bd2398d9376c5f06834c25a4404dd524728eb0602c659ee7b
-  data.tar.gz: 24cf648a878a16eba6b089bf60504f2609386cd4a39735e6e163e6ffe48d70a50830005fb4ac58a303f87ae73854c3b608cab6dd8669e1bafd340ab95b555e4d
+  metadata.gz: 913f3ba460d1bf0d214f9a1971fae666ab381d28f2177b07f93d6be7dc5d96ea3e9b2446de382292cbe1f861b13c0e7e1ace5dbe2b1787232eef2dde52848431
+  data.tar.gz: 928fb526a60d9c8c244c61a062095ba456be6124a20f6cc34240ec15dee6423229ac6ee179380d33ff946e84a97f98e9fc962b89bc90b84c0007f41e4cb9797e

data/.travis.yml

@@ -9,6 +9,7 @@ rvm:
   - 2.2.6
   - 2.3.3
   - 2.4.0
+  - 2.5.1
 
 gemfile:
   - gemfiles/rails_4.1.gemfile
@@ -30,3 +31,5 @@ matrix:
       gemfile: gemfiles/rails_5.1.gemfile
     - rvm: 2.4.0
       gemfile: gemfiles/rails_4.1.gemfile
+    - rvm: 2.5.1
+      gemfile: gemfiles/rails_4.1.gemfile

data/Appraisals

@@ -1,15 +1,19 @@
-appraise "rails-4.1" do
-  gem "rails", "~> 4.1.0"
-end
-
 appraise "rails-4.2" do
   gem "rails", "~> 4.2.0"
+  gem "sqlite3", "~> 1.3.13"
 end
 
 appraise "rails-5.0" do
   gem "rails", "~> 5.0.0"
+  gem "sqlite3", "~> 1.3.13"
 end
 
 appraise "rails-5.1" do
   gem "rails", "~> 5.1.0"
+  gem "sqlite3", "~> 1.4.1"
+end
+
+appraise "rails-5.2" do
+  gem "rails", "~> 5.2.0"
+  gem "sqlite3", "~> 1.4.1"
 end

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## 1.4.0 - July 10, 2019
+* **BREAKING CHANGE** drop support for rails 4.1
+* **BUGFIX** polymorphic associations that are archived/unarchived can be acted on safely if they share the same ID.
+* add support officially for rails 5.2
+* sqlite upgrades for various rails
+* new methods `#archive_all!` and `#unarchive_all` that can be called off scopes
+
+
 ## 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)
 

data/README.md

@@ -79,6 +79,25 @@ r.archived_at                    # => nil
 r.archived?                      # => false
 ```
 
+### Relations
+
+```ruby
+Hole.create!
+Hole.create!
+Hole.create!
+
+holes = Hole.all
+
+# All records in the relation will be archived with the same archive_number.
+# Dependent/Destroy relationships will be archived, and callbacks will still be honored.
+holes.archive_all!              # => [array of Hole records in the relation]
+
+holes.first.archive_number      # => "b56876de48a5dcfe71b2c13eec15e4a2"
+holes.last.archive_number       # => "b56876de48a5dcfe71b2c13eec15e4a2"
+
+holes.unarchive_all!            # => [array of Hole records in the relation]
+```
+
 ### Scopes
 
 ``` ruby
@@ -144,8 +163,8 @@ end
 
 #### Halting the callback chain
 
-* Rails 4.1/4.2 - the callback method should return a `false`/`nil` value.
-* Rails 5x - the callback should `throw(:abort)`/`raise(:abort)`.
+* Rails 4.2 - the callback method should return a `false`/`nil` value.
+* Rails 5.x - the callback should `throw(:abort)`/`raise(:abort)`.
 
 ## Caveats
 
@@ -190,6 +209,8 @@ ActsAsParanoid and PermanentRecords were both inspirations for this:
 * Anthony Panozzo
 * Aaron Milam
 * Anton Rieder
+* Josh Menden
+* Sergey Gnuskov
 
 Thanks!
 

data/acts_as_archival.gemspec

@@ -14,7 +14,12 @@ Gem::Specification.new do |gem|
                      "Dave Woodward",
                      "Miles Sterrett",
                      "James Hill",
-                     "Maarten Claes"]
+                     "Maarten Claes",
+                     "Anthony Panozzo",
+                     "Aaron Milam",
+                     "Anton Rieder",
+                     "Josh Menden",
+                     "Sergey Gnuskov"]
   gem.email       = ["joel@expectedbehavior.com",
                      "matt@expectedbehavior.com",
                      "jason@expectedbehavior.com",
@@ -32,8 +37,8 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "database_cleaner"
   gem.add_development_dependency "rake"
   gem.add_development_dependency "rr"
-  gem.add_development_dependency "sqlite3"
   gem.add_development_dependency "rubocop", "~> 0.47.1"
+  gem.add_development_dependency "sqlite3"
 
   gem.description = <<-END
 *Atomic archiving/unarchiving for ActiveRecord-based apps*

data/gemfiles/rails_4.2.gemfile

@@ -3,5 +3,6 @@
 source "https://rubygems.org"
 
 gem "rails", "~> 4.2.0"
+gem "sqlite3", "~> 1.3.13"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails_5.0.gemfile

@@ -3,5 +3,6 @@
 source "https://rubygems.org"
 
 gem "rails", "~> 5.0.0"
+gem "sqlite3", "~> 1.3.13"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails_5.1.gemfile

@@ -3,5 +3,6 @@
 source "https://rubygems.org"
 
 gem "rails", "~> 5.1.0"
+gem "sqlite3", "~> 1.4.1"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/{rails_4.1.gemfile → rails_5.2.gemfile}

@@ -2,6 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 4.1.0"
+gem "rails", "~> 5.2.0"
+gem "sqlite3", "~> 1.4.1"
 
-gemspec :path => "../"
+gemspec path: "../"

data/lib/acts_as_archival.rb

@@ -15,3 +15,5 @@ else
   ActiveRecord::Base.send :include, ExpectedBehavior::ActsAsArchival
   ActiveRecord::Base.send :include, ExpectedBehavior::ActsAsArchivalActiveRecordMethods
 end
+
+ActiveRecord::Relation.send :include, ExpectedBehavior::ActsAsArchivalActiveRecordMethods::ARRelationMethods

data/lib/acts_as_archival/version.rb

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

data/lib/expected_behavior/acts_as_archival_active_record_methods.rb

@@ -36,5 +36,24 @@ module ExpectedBehavior
 
     end
 
+    module ARRelationMethods
+
+      def archive_all!
+        error_message = "The #{klass} must implement 'act_on_archivals' in order to call `archive_all!`"
+        raise NotImplementedError.new(error_message) unless archival?
+
+        head_archive_number = Digest::MD5.hexdigest("#{klass}#{Time.now.utc.to_i}")
+        each { |record| record.archive!(head_archive_number) }.tap { reset }
+      end
+
+      def unarchive_all!
+        error_message = "The #{klass} must implement 'act_on_archivals' in order to call `unarchive_all!`"
+        raise NotImplementedError.new(error_message) unless archival?
+
+        each(&:unarchive!).tap { reset }
+      end
+
+    end
+
   end
 end

data/lib/expected_behavior/association_operation/base.rb

@@ -36,7 +36,11 @@ module ExpectedBehavior
 
         def act_on_association(association)
           key = association.respond_to?(:foreign_key) ? association.foreign_key : association.primary_key_name
-          scope = association.klass.where(key => model.id)
+          scope_conditions = { key => model.id }
+          # polymorphic associations need a type so we don't accidentally act on multiple associated objects
+          # that have the same ID
+          scope_conditions[association.type] = model.class.base_class.name if association.type
+          scope = association.klass.where(scope_conditions)
           act_on_archivals(scope)
         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/polymorphic_test.rb

@@ -11,6 +11,15 @@ class PolymorphicTest < ActiveSupport::TestCase
     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",
@@ -24,4 +33,18 @@ class PolymorphicTest < ActiveSupport::TestCase
     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/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/schema.rb

@@ -1,4 +1,11 @@
 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

data/test/scope_test.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 require_relative "test_helper"
 
 class ScopeTest < ActiveSupport::TestCase
@@ -50,15 +51,15 @@ class ScopeTest < ActiveSupport::TestCase
   end
 
   test "table_name is set to 'legacy'" do
-    # ActiveRecord 4.2 changed the output by one space (╯°□°）╯︵ ┻━┻
-    spaces = if (ActiveRecord.version <=> Gem::Version.new("4.2.0")) >= 0
-               " "
-             else
-               "  "
-             end
-    archived_sql = "SELECT \"legacy\".* FROM \"legacy\"#{spaces}" \
+    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)'
-    unarchived_sql = "SELECT \"legacy\".* FROM \"legacy\"#{spaces}" \
+      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

data/test/test_helper.rb

@@ -50,6 +50,7 @@ def create_test_tables
 end
 
 BASE_FIXTURE_CLASSES = [
+  :another_polys_holder,
   :archival,
   :archival_kid,
   :archival_grandkid,
@@ -79,9 +80,9 @@ def require_test_classes
   end
 
   fixtures = if ActiveRecord::VERSION::MAJOR >= 4
-               RAILS_5_FIXTURE_CLASSES + BASE_FIXTURE_CLASSES
+               RAILS_5_FIXTURE_CLASSES
              else
-               RAILS_4_FIXTURE_CLASSES + BASE_FIXTURE_CLASSES
+               RAILS_4_FIXTURE_CLASSES
              end
 
   fixtures += BASE_FIXTURE_CLASSES

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_archival
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Joel Meador
@@ -13,10 +13,15 @@ authors:
 - Miles Sterrett
 - James Hill
 - Maarten Claes
+- Anthony Panozzo
+- Aaron Milam
+- Anton Rieder
+- Josh Menden
+- Sergey Gnuskov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-21 00:00:00.000000000 Z
+date: 2019-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -103,33 +108,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.47.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.47.1
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.47.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.47.1
+        version: '0'
 description: |
   *Atomic archiving/unarchiving for ActiveRecord-based apps*
 
@@ -164,10 +169,10 @@ files:
 - README.md
 - Rakefile
 - acts_as_archival.gemspec
-- gemfiles/rails_4.1.gemfile
 - gemfiles/rails_4.2.gemfile
 - gemfiles/rails_5.0.gemfile
 - gemfiles/rails_5.1.gemfile
+- gemfiles/rails_5.2.gemfile
 - init.rb
 - lib/acts_as_archival.rb
 - lib/acts_as_archival/version.rb
@@ -184,6 +189,7 @@ files:
 - test/callbacks_test.rb
 - test/column_test.rb
 - test/deep_nesting_test.rb
+- test/fixtures/another_polys_holder.rb
 - test/fixtures/application_record.rb
 - test/fixtures/application_record_row.rb
 - test/fixtures/archival.rb
@@ -201,6 +207,7 @@ files:
 - test/fixtures/readonly_when_archived.rb
 - test/polymorphic_test.rb
 - test/readonly_when_archived_test.rb
+- test/relations_test.rb
 - test/responds_test.rb
 - test/schema.rb
 - test/scope_test.rb
@@ -225,8 +232,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Atomic archiving/unarchiving for ActiveRecord-based apps
@@ -238,6 +244,7 @@ test_files:
 - test/callbacks_test.rb
 - test/column_test.rb
 - test/deep_nesting_test.rb
+- test/fixtures/another_polys_holder.rb
 - test/fixtures/application_record.rb
 - test/fixtures/application_record_row.rb
 - test/fixtures/archival.rb
@@ -255,6 +262,7 @@ test_files:
 - test/fixtures/readonly_when_archived.rb
 - test/polymorphic_test.rb
 - test/readonly_when_archived_test.rb
+- test/relations_test.rb
 - test/responds_test.rb
 - test/schema.rb
 - test/scope_test.rb