acts_as_archival 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a53308c0484db785c8114be2103ada7b0844fe2
-  data.tar.gz: c52734e4fa86de33fcdfc162cb40ac21b99bedcd
+  metadata.gz: e65cd1c6413e55892031258572cc4ca7e9730cd2
+  data.tar.gz: 671ceee75185386dd88546f5d31415005cba818b
 SHA512:
-  metadata.gz: 414a8242172fa875dbe4c2387103e4e48461894271b0dd49487ab8397301261ea1da012435c63fec2056138646df5b0d74a7eb9fb5f429083aa389081989c09e
-  data.tar.gz: be3195952d4aa822ee9cfa73fa80e521d7607728dd8fca65f246177329bde01fb6d6c54b540d49e05d78130c7cdb7daee0579f8849ec9eed67b0b410cc0ee318
+  metadata.gz: ebc7ccc3c16ca1f0b13361e5c94763ef57ebc4399061bacadb4c1fbff032da8ab7f5e29dca1cc8f4241f7ebf00f797ad890ae29246dd19e5d5bfb9efd4e7936f
+  data.tar.gz: f6966a53472207bc16ca83b6e2c5cd990b8200249c0780abd85e1fe19682d9c77c27dcd89014d0b1bc561f6ee1ad4856bdd93c8fb5f171155b5dae34f548132a

data/.rubocop.yml

@@ -0,0 +1,81 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  Exclude:
+    - vendor/**/*
+    - gemfiles/**/*
+
+
+################
+# Code Metrics #
+################
+Metrics/BlockLength:
+  Exclude:
+    - 'test/schema.rb'
+    - '*.gemspec'
+
+Metrics/AbcSize:
+  Max: 25
+
+Metrics/LineLength:
+  Max: 140
+
+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/EmptyLinesAroundClassBody:
+  EnforcedStyle: empty_lines_except_namespace
+
+Style/EmptyLinesAroundModuleBody:
+  EnforcedStyle: empty_lines_except_namespace
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: never
+
+Style/HashSyntax:
+  EnforcedStyle: ruby19
+
+# TODO: replace the [] below with default once a new version of
+#       rubocop comes out, since there is a PR for it:
+#       https://github.com/bbatsov/rubocop/pull/4038
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%':  '{}'
+    '%i': '[]'
+    '%I': '[]'
+    '%q': '{}'
+    '%Q': '{}'
+    '%r': '{}'
+    '%s': '[]'
+    '%w': '[]'
+    '%W': '[]'
+    '%x': '[]'
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: space
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/.rubocop_todo.yml

@@ -0,0 +1,7 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-03-19 11:19:20 -0400 using RuboCop version 0.47.1.
+# 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.

data/.travis.yml

@@ -0,0 +1,34 @@
+language: ruby
+sudo: false
+dist: trusty
+cache: bundler
+script: "bundle exec rake"
+
+rvm:
+  - 2.1.10
+  - 2.2.6
+  - 2.3.3
+  - 2.4.0
+
+gemfile:
+  - gemfiles/rails_4.1.gemfile
+  - gemfiles/rails_4.2.gemfile
+  - gemfiles/rails_5.0.gemfile
+  - gemfiles/rails_5.1.beta.gemfile
+
+before_install:
+  - gem update --system
+  - gem update bundler
+  - gem cleanup bundler
+
+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
+    - rvm: 2.4.0
+      gemfile: gemfiles/rails_4.1.gemfile

data/Appraisals

@@ -1,6 +1,5 @@
 appraise "rails-4.1" do
   gem "rails", "~> 4.1.0"
-  gem "mysql2", ">= 0.3.13", "< 0.4"
 end
 
 appraise "rails-4.2" do
@@ -8,5 +7,9 @@ appraise "rails-4.2" do
 end
 
 appraise "rails-5.0" do
-  gem "rails", "~> 5.0.0.beta3"
+  gem "rails", "~> 5.0", ">= 5.0.2"
+end
+
+appraise "rails-5.1.beta" do
+  gem 'rails', '~> 5.1.0.beta1'
 end

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## 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/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
@@ -68,11 +71,11 @@ h = Hole.create                  #
 r = h.rats.create                #
 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.archive_number                 # => nil
-r.archive_number                 # => nil
+r.archived_at                    # => nil
 r.archived?                      # => false
 ```
 
@@ -91,8 +94,10 @@ Hole.unarchived.size             # => 0
 
 ``` ruby
 h = Hole.create                  #
-h.is_archival?                   # => true
-Hole.is_archival?                # => true
+h.archival?                   # => true
+h.is_archival?                # => true # deprecated
+Hole.archival?                # => true
+Hole.is_archival?             # => true # deprecated
 ```
 
 ### Options
@@ -127,7 +132,7 @@ class Hole < ActiveRecord::Base
 
   before_unarchive :some_method_before_unarchiving
 
-  after_unarchive :some_method_before_unarchiving
+  after_unarchive :some_method_after_unarchiving
 
   # ... implement those methods
 end
@@ -142,7 +147,7 @@ end
 
 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 +183,10 @@ ActsAsParanoid and PermanentRecords were both inspirations for this:
 * Miles Sterrett
 * James Hill
 * Maarten Claes
+* Anthony Panozzo
 * Aaron Milam
+* Anton Rieder
 
 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",
@@ -25,16 +25,15 @@ Gem::Specification.new do |gem|
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   gem.require_paths = ["lib"]
 
-  gem.add_dependency "activerecord"
+  gem.add_dependency "activerecord", ">= 4.1"
 
   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 "sqlite3"
+  gem.add_development_dependency "rubocop", "~> 0.47.1"
 
   gem.description = <<-END
 *Atomic archiving/unarchiving for ActiveRecord-based apps*

data/gemfiles/rails_4.1.gemfile

@@ -3,6 +3,5 @@
 source "https://rubygems.org"
 
 gem "rails", "~> 4.1.0"
-gem "mysql2", ">= 0.3.13", "< 0.4"
 
 gemspec :path => "../"

data/gemfiles/rails_5.0.gemfile

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

data/gemfiles/rails_5.1.beta.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 5.1.0.beta1"
+
+gemspec :path => "../"

data/lib/acts_as_archival/version.rb

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

data/lib/expected_behavior/acts_as_archival.rb

@@ -1,113 +1,131 @@
 module ExpectedBehavior
   module ActsAsArchival
-    require 'digest/md5'
 
-    MissingArchivalColumnError = Class.new(ActiveRecord::ActiveRecordError) unless defined?(MissingArchivalColumnError) == 'constant' && MissingArchivalColumnError.class == Class
-    CouldNotArchiveError = Class.new(ActiveRecord::ActiveRecordError) unless defined?(CouldNotArchiveError) == 'constant' && CouldNotArchiveError.class == Class
-    CouldNotUnarchiveError = Class.new(ActiveRecord::ActiveRecordError) unless defined?(CouldNotUnarchiveError) == 'constant' && CouldNotUnarchiveError.class == Class
+    require "digest/md5"
+
+    unless defined?(MissingArchivalColumnError) == "constant" && MissingArchivalColumnError.class == Class
+      MissingArchivalColumnError = Class.new(ActiveRecord::ActiveRecordError)
+    end
+    unless defined?(CouldNotArchiveError) == "constant" && CouldNotArchiveError.class == Class
+      CouldNotArchiveError = Class.new(ActiveRecord::ActiveRecordError)
+    end
+    unless defined?(CouldNotUnarchiveError) == "constant" && CouldNotUnarchiveError.class == Class
+      CouldNotUnarchiveError = Class.new(ActiveRecord::ActiveRecordError)
+    end
 
     def self.included(base)
       base.extend ActMethods
     end
 
     module ActMethods
-      def acts_as_archival(options = { })
-        unless included_modules.include? InstanceMethods
-          include InstanceMethods
-
-          before_validation :raise_if_not_archival
-          validate :readonly_when_archived if options[:readonly_when_archived]
-
-          scope :archived, lambda { where.not(:archived_at => nil, :archive_number => nil) }
-          scope :unarchived, lambda { where(:archived_at => nil, :archive_number => nil) }
-          scope :archived_from_archive_number, lambda { |head_archive_number| where(['archived_at IS NOT NULL AND archive_number = ?', head_archive_number]) }
-
-          callbacks = ['archive','unarchive']
-          if ActiveSupport::VERSION::STRING >= '5'
-            define_callbacks(*[callbacks].flatten)
-          elsif ActiveSupport::VERSION::STRING >= '4'
-            define_callbacks(*[callbacks, {:terminator => -> (_, result) { result == false }}].flatten)
-          end
-          callbacks.each do |callback|
-            eval <<-end_callbacks
-              unless defined?(before_#{callback})
-                def before_#{callback}(*args, &blk)
-                  set_callback(:#{callback}, :before, *args, &blk)
-                end
-              end
-              unless defined?(after_#{callback})
-                def after_#{callback}(*args, &blk)
-                  set_callback(:#{callback}, :after, *args, &blk)
-                end
-              end
-            end_callbacks
+
+      def acts_as_archival(options = {})
+        return if included_modules.include?(InstanceMethods)
+
+        include InstanceMethods
+
+        setup_validations(options)
+
+        setup_scopes
+
+        setup_callbacks
+      end
+
+      private def setup_validations(options)
+        before_validation :raise_if_not_archival
+        validate :readonly_when_archived if options[:readonly_when_archived]
+      end
+
+      private def setup_scopes
+        scope :archived, -> { where.not(archived_at: nil, archive_number: nil) }
+        scope :unarchived, -> { where(archived_at: nil, archive_number: nil) }
+        scope :archived_from_archive_number, (lambda do |head_archive_number|
+          where(["archived_at IS NOT NULL AND archive_number = ?", head_archive_number])
+        end)
+      end
+
+      private def setup_callbacks
+        callbackable_actions = %w[archive unarchive]
+
+        setup_activerecord_callbacks(callbackable_actions)
+
+        define_callback_dsl_methods(callbackable_actions)
+      end
+
+      private def setup_activerecord_callbacks(callbackable_actions)
+        if ActiveSupport::VERSION::MAJOR >= 5
+          define_callbacks(*[callbackable_actions].flatten)
+        elsif ActiveSupport::VERSION::MAJOR >= 4
+          define_callbacks(*[callbackable_actions, { terminator: ->(_, result) { result == false } }].flatten)
+        end
+      end
+
+      private def define_callback_dsl_methods(callbackable_actions)
+        callbackable_actions.each do |action|
+          %w[before after].each do |callbackable_type|
+            define_callback_dsl_method(callbackable_type, action)
           end
         end
       end
 
+      private def define_callback_dsl_method(callbackable_type, action)
+        # rubocop:disable Security/Eval
+        eval <<-end_callbacks
+          unless defined?(#{callbackable_type}_#{action})
+            def #{callbackable_type}_#{action}(*args, &blk)
+              set_callback(:#{action}, :#{callbackable_type}, *args, &blk)
+            end
+          end
+        end_callbacks
+        # rubocop:enable Security/Eval
+      end
+
     end
 
     module InstanceMethods
 
       def readonly_when_archived
-        if self.archived? && self.changed? && !self.archived_at_changed? && !self.archive_number_changed?
-          self.errors.add(:base, "Cannot modify an archived record.")
-        end
+        readonly_attributes_changed = archived? && changed? && !archived_at_changed? && !archive_number_changed?
+        return unless readonly_attributes_changed
+
+        errors.add(:base, "Cannot modify an archived record.")
       end
 
       def raise_if_not_archival
         missing_columns = []
-        missing_columns << "archive_number" unless self.respond_to?(:archive_number)
-        missing_columns << "archived_at" unless self.respond_to?(:archived_at)
-        raise MissingArchivalColumnError.new("Add '#{missing_columns.join "', '"}' column(s) to '#{self.class.name}' to make it archival") unless missing_columns.blank?
+        missing_columns << "archive_number" unless respond_to?(:archive_number)
+        missing_columns << "archived_at" unless respond_to?(:archived_at)
+        return if missing_columns.blank?
+
+        raise MissingArchivalColumnError.new("Add '#{missing_columns.join "', '"}' column(s) to '#{self.class.name}' to make it archival")
       end
 
       def archived?
-        !!(self.archived_at? && self.archive_number)
+        !!(archived_at? && archive_number)
       end
 
-      def archive(head_archive_number=nil)
-        self.class.transaction do
-          begin
-            success = run_callbacks(:archive) do
-              unless self.archived?
-                head_archive_number ||= Digest::MD5.hexdigest("#{self.class.name}#{self.id}")
-                self.archive_associations(head_archive_number)
-                self.archived_at = DateTime.now
-                self.archive_number = head_archive_number
-                self.save!
-              end
-            end
-            return !!success
-          rescue => e
-            ActiveRecord::Base.logger.try(:debug, e.message)
-            ActiveRecord::Base.logger.try(:debug, e.backtrace)
-            raise ActiveRecord::Rollback
+      def archive(head_archive_number = nil)
+        execute_archival_action(:archive) do
+          unless archived?
+            head_archive_number ||= Digest::MD5.hexdigest("#{self.class.name}#{id}")
+            archive_associations(head_archive_number)
+            self.archived_at = DateTime.now
+            self.archive_number = head_archive_number
+            save!
           end
         end
-        false
       end
 
-      def unarchive(head_archive_number=nil)
-        self.class.transaction do
-          begin
-            success = run_callbacks(:unarchive) do
-              if self.archived?
-                head_archive_number ||= self.archive_number
-                self.archived_at = nil
-                self.archive_number = nil
-                self.save!
-                self.unarchive_associations(head_archive_number)
-              end
-            end
-            return !!success
-          rescue => e
-            ActiveRecord::Base.logger.try(:debug, e.message)
-            ActiveRecord::Base.logger.try(:debug, e.backtrace)
-            raise ActiveRecord::Rollback
+      def unarchive(head_archive_number = nil)
+        execute_archival_action(:unarchive) do
+          if archived?
+            head_archive_number ||= archive_number
+            self.archived_at = nil
+            self.archive_number = nil
+            save!
+            unarchive_associations(head_archive_number)
           end
         end
-        false
       end
 
       def archive_associations(head_archive_number)
@@ -117,6 +135,26 @@ module ExpectedBehavior
       def unarchive_associations(head_archive_number)
         AssociationOperation::Unarchive.new(self, head_archive_number).execute
       end
+
+      private def execute_archival_action(action)
+        self.class.transaction do
+          begin
+            success = run_callbacks(action) { yield }
+            return !!success
+          rescue => e
+            handle_archival_action_exception(e)
+          end
+        end
+        false
+      end
+
+      private def handle_archival_action_exception(exception)
+        ActiveRecord::Base.logger.try(:debug, exception.message)
+        ActiveRecord::Base.logger.try(:debug, exception.backtrace)
+        raise ActiveRecord::Rollback
+      end
+
     end
+
   end
 end