acts_as_archival 1.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6a53308c0484db785c8114be2103ada7b0844fe2
-  data.tar.gz: c52734e4fa86de33fcdfc162cb40ac21b99bedcd
+SHA256:
+  metadata.gz: 1f9de47af7c26b8d78744f6f150523da886cc3e72f3adfdf2c43489f92dd29d7
+  data.tar.gz: eb8710dc7dd90dfb876b83e61f9d08ac01003d734950f9554abd24d91e428875
 SHA512:
-  metadata.gz: 414a8242172fa875dbe4c2387103e4e48461894271b0dd49487ab8397301261ea1da012435c63fec2056138646df5b0d74a7eb9fb5f429083aa389081989c09e
-  data.tar.gz: be3195952d4aa822ee9cfa73fa80e521d7607728dd8fca65f246177329bde01fb6d6c54b540d49e05d78130c7cdb7daee0579f8849ec9eed67b0b410cc0ee318
+  metadata.gz: e16b3e95c07251f5f5c1dcd2b960e76ffc3f41241c7601b9cb7923e1f89bbc3c4aa21be46ad2b55ebce502933a3d6171ed1a57874857001a653db984822d8176
+  data.tar.gz: 9b818f82e6072dde8e0f7e1a621dd7593b918cb696738a0b1750b2357ab732250e18ae5d008813f3b8dc8204447df0f37e98561532343105c89682cd46a9a3c8

data/.gitignore

@@ -4,7 +4,7 @@
 bin
 vendor/bundle
 *.gem
-*emfile.lock
+gemfiles/*.lock
 pkg/*
 .DS_Store
 *.sqlite3

data/.rubocop.yml

@@ -0,0 +1,71 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  Exclude:
+    - vendor/**/*
+    - gemfiles/**/*
+  TargetRubyVersion: 2.4
+  NewCops: enable
+
+
+################
+# Layout Rules #
+################
+Layout/EmptyLinesAroundClassBody:
+  EnforcedStyle: empty_lines_except_namespace
+
+Layout/EmptyLinesAroundModuleBody:
+  EnforcedStyle: empty_lines_except_namespace
+
+Layout/LineLength:
+  Max: 140
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: space
+
+
+################
+# Code Metrics #
+################
+Metrics/BlockLength:
+  Exclude:
+    - 'test/schema.rb'
+    - '*.gemspec'
+
+Metrics/AbcSize:
+  Max: 25
+
+Metrics/MethodLength:
+  Max: 10
+  CountComments: false
+
+
+###############
+# Style Rules #
+###############
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+# ¯\_(ツ)_/¯
+# ʕノ•ᴥ•ʔノ ︵ ┻━┻
+# ( ͡° ͜ʖ ͡°)
+Style/AsciiComments:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: never
+
+Style/HashSyntax:
+  EnforcedStyle: ruby19
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/.rubocop_todo.yml

@@ -0,0 +1,98 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-04-28 17:17:25 +0200 using RuboCop version 0.82.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Layout/EmptyLineAfterMagicComment:
+  Exclude:
+    - 'acts_as_archival.gemspec'
+    - 'test/scope_test.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment, EnforcedStyleForExponentOperator.
+# SupportedStylesForExponentOperator: space, no_space
+Layout/SpaceAroundOperators:
+  Exclude:
+    - 'test/deep_nesting_test.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Lint/ScriptPermission:
+  Exclude:
+    - 'Rakefile'
+
+# Offense count: 7
+# Cop supports --auto-correct.
+Lint/SendWithMixinArgument:
+  Exclude:
+    - 'init.rb'
+    - 'lib/acts_as_archival.rb'
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: lowercase, uppercase
+Naming/HeredocDelimiterCase:
+  Exclude:
+    - 'lib/expected_behavior/acts_as_archival.rb'
+
+# Offense count: 3
+# Configuration parameters: ForbiddenDelimiters.
+# ForbiddenDelimiters: (?-mix:(^|\s)(EO[A-Z]{1}|END)(\s|$))
+Naming/HeredocDelimiterNaming:
+  Exclude:
+    - 'acts_as_archival.gemspec'
+    - 'lib/expected_behavior/acts_as_archival.rb'
+
+# Offense count: 12
+# Configuration parameters: EnforcedStyle, AllowModifiersOnSymbols.
+# SupportedStyles: inline, group
+Style/AccessModifierDeclarations:
+  Exclude:
+    - 'lib/expected_behavior/acts_as_archival.rb'
+    - 'test/fixtures/callback_archival_4.rb'
+    - 'test/fixtures/callback_archival_5.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/Encoding:
+  Exclude:
+    - 'acts_as_archival.gemspec'
+    - 'test/scope_test.rb'
+
+# Offense count: 1
+Style/EvalWithLocation:
+  Exclude:
+    - 'lib/expected_behavior/acts_as_archival.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/ExpandPathArguments:
+  Exclude:
+    - 'acts_as_archival.gemspec'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/IfUnlessModifier:
+  Exclude:
+    - 'test/test_helper.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: implicit, explicit
+Style/RescueStandardError:
+  Exclude:
+    - 'lib/expected_behavior/acts_as_archival.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: MinSize.
+# SupportedStyles: percent, brackets
+Style/SymbolArray:
+  EnforcedStyle: brackets

data/.travis.yml

@@ -0,0 +1,23 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
+
+gemfile:
+  - gemfiles/rails_5.0.gemfile
+  - gemfiles/rails_5.1.gemfile
+  - gemfiles/rails_5.2.gemfile
+  - gemfiles/rails_6.0.gemfile
+
+before_install:
+  - gem update --system
+
+matrix:
+  fast_finish: true
+  exclude:
+    - gemfile: gemfiles/rails_6.0.gemfile
+      rvm: 2.4

data/Appraisals

@@ -1,12 +1,12 @@
-appraise "rails-4.1" do
-  gem "rails", "~> 4.1.0"
-  gem "mysql2", ">= 0.3.13", "< 0.4"
+appraise "rails-5.2" do
+  gem "rails", "~> 5.2.0"
+  gem "sqlite3", "~> 1.4.1"
 end
 
-appraise "rails-4.2" do
-  gem "rails", "~> 4.2.0"
+appraise "rails-6.0" do
+  gem "rails", "~> 6.0.0"
 end
 
-appraise "rails-5.0" do
-  gem "rails", "~> 5.0.0.beta3"
+appraise "rails-6.1" do
+  gem "rails", "~> 6.1"
 end

data/CHANGELOG.md

@@ -1,5 +1,34 @@
 # CHANGELOG
 
+## 2.0.0 – (UNRELEASED)
+
+* **BREAKING CHANGE** Drop support for Rails 4.2
+* **BREAKING CHANGE** Drop support for Rails 5.0
+* **BREAKING CHANGE** Drop support for Rails 5.1
+* **BREAKING CHANGE** Removed deprecated methods
+* Fix Rails 6 deprecation warnings
+* Add offical support for Rails 6.1
+
+## 1.4.0 - July 10, 2019
+* **BREAKING CHANGE** drop support for rails 4.1
+* **BREAKING CHANGE** drop support for Ruby <2.4
+* **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)
+
+## 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
+* minor refactoring through most code
+* much work done to make automatic checks worthwhile (travis/rubocop)
+* general test cleanup
+* drop hard dependency on mysql and postresql in tests
+
 ## 1.1.1 - April 10, 2016
 * Update the way the `::unarchived` scope is generated using `::not` instead of manually building SQL, which should be better for complex queries
 

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    acts_as_archival (2.0.0)
+      activerecord (>= 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activerecord (6.1.4.1)
+      activemodel (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activesupport (6.1.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    assertions-eb (1.7.3)
+    ast (2.4.0)
+    concurrent-ruby (1.1.9)
+    database_cleaner (1.8.4)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    minitest (5.14.4)
+    parallel (1.19.1)
+    parser (2.7.1.1)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rexml (3.2.4)
+    rr (1.2.1)
+    rubocop (0.82.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    ruby-progressbar (1.10.1)
+    sqlite3 (1.4.2)
+    thor (1.0.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  acts_as_archival!
+  appraisal
+  assertions-eb
+  database_cleaner
+  rake
+  rr
+  rubocop (~> 0.82.0)
+  sqlite3
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -1,5 +1,8 @@
 # ActsAsArchival
 
+[![Build Status](https://travis-ci.org/expectedbehavior/acts_as_archival.svg?branch=master)](https://travis-ci.org/expectedbehavior/acts_as_archival)
+[![Gem Version](https://badge.fury.io/rb/acts_as_archival.svg)](https://badge.fury.io/rb/acts_as_archival)
+
 Atomically archive object trees in your activerecord models.
 
 We had the problem that acts_as_paranoid and similar plugins/gems
@@ -38,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
@@ -51,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
@@ -66,23 +69,42 @@ h.archived_at                    # => nil
 ``` ruby
 h = Hole.create                  #
 r = h.rats.create                #
-h.archive                        # => true
+h.archive!                       # => true
 h.archive_number                 # => "b56876de48a5dcfe71b2c13eec15e4a2"
-r.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.archive_number                 # => nil
+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
 h = Hole.create
 Hole.archived.size               # => 0
 Hole.unarchived.size             # => 1
-h.archive
+h.archive!
 Hole.archived.size               # => 1
 Hole.unarchived.size             # => 0
 ```
@@ -91,23 +113,23 @@ Hole.unarchived.size             # => 0
 
 ``` ruby
 h = Hole.create                  #
-h.is_archival?                   # => true
-Hole.is_archival?                # => true
+h.archival?                   # => true
+Hole.archival?                # => true
 ```
 
 ### 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."
@@ -121,13 +143,17 @@ 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
 
-  after_unarchive :some_method_before_unarchiving
+  # runs after #unarchive!
+  after_unarchive :some_method_after_unarchiving
 
   # ... implement those methods
 end
@@ -135,14 +161,14 @@ 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
 
 1. This will only work on associations that are dependent destroy. It
 should be trival to change that or make it optional.
-1. If you would like to work on this, you will need to setup sqlite, postgres, and mysql on your development machine. Alternately, you can disable specific dev dependencies in the gemspec and test_helper and ask for help.
+1. If you would like to work on this, you will need to setup sqlite on your development machine. Alternately, you can disable specific dev dependencies in the gemspec and test_helper and ask for help.
 
 ## Testing
 
@@ -178,8 +204,12 @@ ActsAsParanoid and PermanentRecords were both inspirations for this:
 * Miles Sterrett
 * James Hill
 * Maarten Claes
+* Anthony Panozzo
 * Aaron Milam
+* Anton Rieder
+* Josh Menden
+* Sergey Gnuskov
 
 Thanks!
 
-*Copyright (c) 2009-2016 Expected Behavior, LLC, released under the MIT license*
+*Copyright (c) 2009-2017 Expected Behavior, LLC, released under the MIT license*

data/Rakefile

@@ -1,13 +1,16 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "rubocop/rake_task"
 
-desc "Default: run unit tests."
-task :default => :test
+RuboCop::RakeTask.new
+
+desc "Default: run all available test suites."
+task default: [:rubocop, :test]
 
 desc "Test the acts_as_archival plugin."
 Rake::TestTask.new(:test) do |t|
-  t.libs    << "test"
+  t.libs << "test"
   t.pattern = "test/**/*_test.rb"
   t.verbose = true
 end

data/acts_as_archival.gemspec

@@ -4,7 +4,7 @@ require "acts_as_archival/version"
 
 Gem::Specification.new do |gem|
   gem.name        = "acts_as_archival"
-  gem.summary     = %q{Atomic archiving/unarchiving for ActiveRecord-based apps}
+  gem.summary     = "Atomic archiving/unarchiving for ActiveRecord-based apps"
   gem.version     = ActsAsArchival::VERSION
   gem.authors     = ["Joel Meador",
                      "Michael Kuehl",
@@ -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",
@@ -24,31 +29,32 @@ Gem::Specification.new do |gem|
   gem.files         = `git ls-files`.split("\n")
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   gem.require_paths = ["lib"]
+  gem.required_ruby_version = ">= 2.4"
 
-  gem.add_dependency "activerecord"
+  gem.add_dependency "activerecord", ">= 5.0"
 
   gem.add_development_dependency "appraisal"
   gem.add_development_dependency "assertions-eb"
   gem.add_development_dependency "database_cleaner"
-  gem.add_development_dependency "mysql2"
-  gem.add_development_dependency "pg"
   gem.add_development_dependency "rake"
   gem.add_development_dependency "rr"
+  gem.add_development_dependency "rubocop", "~> 0.82.0"
   gem.add_development_dependency "sqlite3"
 
-  gem.description = <<-END
-*Atomic archiving/unarchiving for ActiveRecord-based apps*
+  gem.description =
+    <<~END
+      *Atomic archiving/unarchiving for ActiveRecord-based apps*
 
-We had the problem that acts_as_paranoid and similar plugins/gems always work on
-a record by record basis and made it very difficult to restore records
-atomically (or archive them, for that matter).
+      We had the problem that acts_as_paranoid and similar plugins/gems always work on
+      a record by record basis and made it very difficult to restore records
+      atomically (or archive them, for that matter).
 
-Because the archive and unarchive methods are in transactions, and every
-archival record involved gets the same archive number upon archiving, you can
-easily restore or remove an entire set of records without having to worry about
-partial deletion or restoration.
+      Because the archive and unarchive methods are in transactions, and every
+      archival record involved gets the same archive number upon archiving, you can
+      easily restore or remove an entire set of records without having to worry about
+      partial deletion or restoration.
 
-Additionally, other plugins generally screw with how destroy/delete work.  We
-don't because we actually want to be able to destroy records.
-END
+      Additionally, other plugins generally screw with how destroy/delete work. We
+      don't because we actually want to be able to destroy records.
+    END
 end

data/gemfiles/rails_5.2.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 5.2.0"
+gem "sqlite3", "~> 1.4.1"
+
+gemspec path: "../"

data/gemfiles/{rails_4.2.gemfile → rails_6.0.gemfile}

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

data/gemfiles/{rails_5.0.gemfile → rails_6.1.gemfile}

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

data/lib/acts_as_archival/version.rb

@@ -1,3 +1,5 @@
 module ActsAsArchival
-  VERSION = "1.1.1"
+
+  VERSION = "2.0.0".freeze
+
 end

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