archival_record 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 872aa8e89098dc62a3c40fb1053d8805bf5f030fc3a1fd5afbb650538d8b0b85
+  data.tar.gz: f8e64e5749c3bed043382924acaa9bacb456800d2be63f8dbc451bd7525716fa
+SHA512:
+  metadata.gz: 7bc263147bcb996649a41d533da229fe0a7d6dcee2b7b8bdbd101dee5ccb20c3ea23cdc786e4f274a4ce4a8ec5f994f4770251d2ca8bc1dd677edbd9e88a564b
+  data.tar.gz: 1685b46aa236bd9feb1e3c6b6827cbdc71bb912323b216f81513e2060e78c7292dcb49072a8fede38a0fbeff09a1ca2da5e2beee777a89fb2adba16ea2f20928

data/.gitignore

@@ -0,0 +1,10 @@
+*~
+*.log
+.bundle
+bin
+vendor/bundle
+*.gem
+gemfiles/*.lock
+pkg/*
+.DS_Store
+*.sqlite3

data/.rubocop.yml

@@ -0,0 +1,74 @@
+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/AccessModifierDeclarations:
+  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,14 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-08-03 13:04:37 -0400 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: 7
+# Cop supports --auto-correct.
+Lint/SendWithMixinArgument:
+  Exclude:
+    - 'init.rb'
+    - 'lib/archival_record.rb'

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

@@ -0,0 +1,18 @@
+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
+
+appraise "rails-6.0" do
+  gem "rails", "~> 6.0.0"
+end

data/CHANGELOG.md

@@ -0,0 +1,96 @@
+# CHANGELOG
+
+
+## 2.0.0 – August 3, 2020
+
+* **BREAKING CHANGE** Drop support for Rails 4.2
+* **BREAKING CHANGE** Removed deprecated methods
+* Fix Rails 6 deprecation warnings
+* Renamed gem to [ArchivalRecord](https://github.com/janxious/archival_record/)
+* `acts_as_archival` becomes `archival_record` in models with a deprecation warning.
+
+-------
+
+The Changelog below applies to versions of [ActsAsArchival](https://github.com/expectedbehavior/acts_as_archival/).
+
+## 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
+
+## 1.1.0 - April 10, 2016
+* **BREAKING CHANGE** obsolete mainline rails 3 and rails 4.0.x support because: they are EOL'ed for > 1y
+* add rails 4.2 automated tests
+* add rails 5 support
+* test and document callbacks better - Thanks, Aaron Milam
+* **BUGFIX** remove a bunch of deprecations
+* **BUGFIX** improve compatibility with various new versions of software like mysql when testing
+
+## 1.0.0 - April 5, 2016
+* **BREAKING CHANGE** make `#archived?` return an actual boolean value
+
+## 0.6.1 - July 24, 2014
+* Fix deprecation warnings on Rails 4.1
+* Test suite now runs against multiple versions of Rails
+* Fully automated test suite setup
+
+## 0.6.0 - April 14, 2014
+* **BREAKING CHANGE** (possibly): Some refactoring to modern gem module idioms instead of old school plugins
+* Officially support PostgreSQL
+* Switch default testing to use sqlite, mysql, and postgres instead of just mysql
+* Major upgrades to test suite
+
+## 0.5.3 - May 17, 2013
+* Major refactoring of archiving/unarchiving logic into nice command classes instead of big ball of ARec voodoo. Thanks, Marten Claes!
+
+## 0.5.2
+* **BREAKING CHANGE** (possibly): removed the scope constants, so if you were using them, you should stop
+* **BUGFIX** fix scoping combinations with relations for Rails 4
+* More changes to support Rails 4
+
+## 0.5.1
+* update to use .table_name for archived scope
+
+## 0.5.0
+* Rails 4.0.0b1 support. Thanks, James Hill!
+
+## 0.4.5
+* possibly allow rails 2&3 to work when dealing with associations
+* add some logging when archive/unarchive doesn't work
+
+## 0.4.4
+* **BUGFIX** Callbacks were being called twice because of how we were defining them
+
+## 0.4.3
+* Fix spelling error
+
+## 0.4.2
+* Change homepage to the github repo
+
+## 0.4.1
+* remove explicit activesupport gem'ing
+* update documentation for using plugin version with rails 3.0x
+
+## 0.4.0
+* **BUGFIX**: when `archive`/`unarchive` fail, they now return false instead of nil
+* Rails 3.2 compatibility -- **Possibly Rails 3.0 incompatible due to ARec differences**
+* Gemified!
+* Super Duper Major test re-organization

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    archival_record (1.4.0)
+      activerecord (>= 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activerecord (6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.0)
+    concurrent-ruby (1.1.6)
+    database_cleaner (1.8.4)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    minitest (5.14.1)
+    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)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  archival_record!
+  database_cleaner
+  rake
+  rr
+  rubocop (~> 0.82.0)
+  sqlite3
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,56 @@
+Copyright for portions of project ArchivalRecord are held by Expected Behavior, 2009-2020 as part of project ActsAsArchival. All other copyright for project ArchivalRecord are held by Joel Meador, 2020.
+
+-----
+
+LICENSE for [ArchivalRecord](https://github.com/janxious/archival_record/)
+
+Copyright (c) 2020 Joel Meador
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+
+-----
+
+ORIGINAL LICENSE for [ActsAsArchival](https://github.com/expectedbehavior/acts_as_archival/)
+
+Copyright (c) 2009-2013 Expected Behavior
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,209 @@
+# ArchivalRecord
+
+[![Build Status](https://travis-ci.org/janxious/archival_record.svg?branch=master)](https://travis-ci.org/janxious/archival_record)
+[![Gem Version](https://badge.fury.io/rb/archival_record.svg)](https://badge.fury.io/rb/archival_record)
+
+Atomically archive object trees in your ActiveRecord models.
+
+`acts_as_paranoid` and similar plugins/gems work on a record-by-record basis and made it 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.
+
+Additionally, other plugins generally change how `destroy`/`delete` work. ArchivalRecord does not, and thus one can destroy records like normal.
+
+## 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:
+
+`gem "archival_record"`
+
+Any models you want to be archival should have the columns `archive_number` (String) and `archived_at` (DateTime).
+
+i.e. `rails g migration AddArchivalRecordToPost archive_number archived_at:datetime`
+
+Any dependent-destroy ArchivalRecord model associated to an ArchivalRecord model will be archived with its parent.
+
+_If you're stuck on Rails 4.0x/3x/2x, check out the older tags/branches, which are no longer in active development._
+
+## Example
+
+``` ruby
+class Hole < ActiveRecord::Base
+  archival_record
+  has_many :rats, dependent: :destroy
+end
+
+class Rat < ActiveRecord::Base
+  archival_record
+end
+```
+
+### Simple interactions & scopes
+
+``` ruby
+h = Hole.create                  #
+h.archived?                      # => false
+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.archived?                      # => false
+h.archive_number                 # => nil
+h.archived_at                    # => nil
+```
+
+### Associations
+
+``` ruby
+h = Hole.create                  #
+r = h.rats.create                #
+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.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!
+Hole.archived.size               # => 1
+Hole.unarchived.size             # => 0
+```
+
+### Utility methods
+
+``` ruby
+h = Hole.create                  #
+h.archival?                   # => true
+Hole.archival?                # => true
+```
+
+### Options
+
+When defining an ArchivalRecord model, it is is possible to make it unmodifiable
+when it is archived by passing `readonly_when_archived: true` to the
+`archival_record` call in your model.
+
+``` ruby
+class CantTouchThis < ActiveRecord::Base
+  archival_record readonly_when_archived: true
+end
+
+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."
+```
+
+### Callbacks
+
+ArchivalRecord 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
+  archival_record
+
+  # 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
+end
+```
+
+#### Halting the callback chain
+
+* 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 on your development machine. Alternately, you can disable specific dev dependencies in the gemspec and test_helper and ask for help.
+
+## Testing
+
+Running the tests should be as easy as:
+
+```  bash
+script/setup                 # bundles, makes databases with permissions
+rake                         # run tests on latest Rails
+appraisal rake               # run tests on all versions of Rails
+```
+
+Check out [more on appraisal](https://github.com/thoughtbot/appraisal#usage) if you need to add new versions of things or run into a version bug.
+
+## Help Wanted
+
+We'd love to have your help making this better! If you have ideas for features this should implement or you think the code sucks, let us know. And PRs are greatly appreciated. :+1:
+
+## Thanks
+
+ActsAsParanoid and PermanentRecords were both inspirations for this:
+
+* http://github.com/technoweenie/acts_as_paranoid
+* http://github.com/fastestforward/permanent_records
+
+## Contributors
+
+* Joel Meador
+* Michael Kuehl
+* Matthew Gordon
+* Vojtech Salbaba
+* David Jones
+* Dave Woodward
+* Miles Sterrett
+* James Hill
+* Maarten Claes
+* Anthony Panozzo
+* Aaron Milam
+* Anton Rieder
+* Josh Menden
+* Sergey Gnuskov
+* Elijah Miller
+
+Thanks!
+
+[MIT-Licensed](LICENSE)