acts_as_archival 1.1.1 → 1.2.0

data/lib/expected_behavior/acts_as_archival_active_record_methods.rb

@@ -1,20 +1,40 @@
 module ExpectedBehavior
   module ActsAsArchivalActiveRecordMethods
+
     def self.included(base)
       base.extend ARClassMethods
       base.send :include, ARInstanceMethods
     end
 
     module ARClassMethods
+
+      def archival?
+        included_modules.include?(ExpectedBehavior::ActsAsArchival::InstanceMethods)
+      end
+
+      # rubocop:disable Style/PredicateName
       def is_archival?
-        self.included_modules.include?(ExpectedBehavior::ActsAsArchival::InstanceMethods)
+        ActiveSupport::Deprecation.warn(".is_archival? is deprecated in favor of .archival?")
+        archival?
       end
+      # rubocop:enable Style/PredicateName
+
     end
 
     module ARInstanceMethods
+
+      def archival?
+        self.class.archival?
+      end
+
+      # rubocop:disable Style/PredicateName
       def is_archival?
-        self.class.is_archival?
+        ActiveSupport::Deprecation.warn("#is_archival? is deprecated in favor of #archival?")
+        archival?
       end
+      # rubocop:enable Style/PredicateName
+
     end
+
   end
 end

data/lib/expected_behavior/association_operation/base.rb

@@ -1,8 +1,8 @@
 module ExpectedBehavior
   module ActsAsArchival
     module AssociationOperation
-
       class Base
+
         attr_reader :model, :head_archive_number
 
         def initialize(model, head_archive_number)
@@ -19,18 +19,18 @@ module ExpectedBehavior
         protected
 
         def each_archivable_association
-          self.model.class.reflect_on_all_associations.each do |association|
+          model.class.reflect_on_all_associations.each do |association|
             yield(association) if archivable_association?(association)
           end
         end
 
         def archivable_association?(association)
           association.macro.to_s =~ /^has/ &&
-            association.klass.is_archival? &&
+            association.klass.archival? &&
             association.options[:through].nil?
         end
 
-        def association_conditions_met?(association)
+        def association_conditions_met?(_association)
           true
         end
 
@@ -40,12 +40,11 @@ module ExpectedBehavior
           act_on_archivals(scope)
         end
 
-        def act_on_archivals(scope)
-          raise NotImplementedError,
-            "The #{self.class} hasn't implemented 'act_on_archivals(scope)'"
+        def act_on_archivals(_scope)
+          raise NotImplementedError.new("The #{self.class} hasn't implemented 'act_on_archivals(scope)'")
         end
-      end
 
+      end
     end
   end
 end

data/lib/expected_behavior/association_operation/unarchive.rb

@@ -6,7 +6,7 @@ module ExpectedBehavior
         protected
 
         def act_on_archivals(scope)
-          scope.archived.where(:archive_number => head_archive_number).find_each do |related_record|
+          scope.archived.where(archive_number: head_archive_number).find_each do |related_record|
             raise ActiveRecord::Rollback unless related_record.unarchive(head_archive_number)
           end
         end

data/script/setup

@@ -5,8 +5,5 @@ cd "`dirname \"$0\"`/.."
 echo "\n---=== Bundling ===---"
 bundle install
 
-echo "\n---=== Setting up test databases ===---"
-script/db_setup
-
 echo "\n---=== Setting up various rails versions for testing ===---"
 bundle exec appraisal install

data/test/ambiguous_table_test.rb

@@ -1,6 +1,7 @@
 require_relative "test_helper"
 
 class AmbiguousTableTest < ActiveSupport::TestCase
+
   test "no ambiguous table problem" do
     archival = Archival.create!
     child = archival.archivals.create!
@@ -11,4 +12,5 @@ class AmbiguousTableTest < ActiveSupport::TestCase
     # generated
     assert_equal 1, Archival.unarchived.joins(:archivals).count
   end
+
 end

data/test/application_record_test.rb

@@ -3,6 +3,7 @@ require_relative "test_helper"
 # Rails 5 introduced a new base class, and this is gonna test that
 if defined?(ApplicationRecord)
   class ApplicationRecordTest < ActiveSupport::TestCase
+
     test "archive archives the record" do
       archival = ApplicationRecordRow.create!
       archival.archive
@@ -10,9 +11,10 @@ if defined?(ApplicationRecord)
     end
 
     test "unarchive unarchives archival records" do
-      archival = ApplicationRecordRow.create!(:archived_at => Time.now, :archive_number => 1)
+      archival = ApplicationRecordRow.create!(archived_at: Time.now, archive_number: 1)
       archival.unarchive
       assert_not archival.reload.archived?
     end
+
   end
 end

data/test/associations_test.rb

@@ -1,6 +1,7 @@
 require_relative "test_helper"
 
 class AssociationsTest < ActiveSupport::TestCase
+
   test "archive archives 'has_' associated archival objects that are dependent destroy" do
     archival = Archival.create!
     child = archival.archivals.create!
@@ -99,4 +100,5 @@ class AssociationsTest < ActiveSupport::TestCase
 
     assert prearchived_child.reload.archived?
   end
+
 end

data/test/basic_test.rb

@@ -1,6 +1,7 @@
 require_relative "test_helper"
 
 class BasicTest < ActiveSupport::TestCase
+
   test "archive archives the record" do
     archival = Archival.create!
     archival.archive
@@ -8,7 +9,7 @@ class BasicTest < ActiveSupport::TestCase
   end
 
   test "unarchive unarchives archival records" do
-    archival = Archival.create!(:archived_at => Time.now, :archive_number => 1)
+    archival = Archival.create!(archived_at: Time.now, archive_number: 1)
     archival.unarchive
     assert_equal false, archival.reload.archived?
   end
@@ -25,12 +26,12 @@ class BasicTest < ActiveSupport::TestCase
   end
 
   test "unarchive returns true on success" do
-    normal = Archival.create!(:archived_at => Time.now, :archive_number => "1")
+    normal = Archival.create!(archived_at: Time.now, archive_number: "1")
     assert_equal true, normal.unarchive
   end
 
   test "unarchive returns false on failure" do
-    readonly = Archival.create!(:archived_at => Time.now, :archive_number => "1")
+    readonly = Archival.create!(archived_at: Time.now, archive_number: "1")
     readonly.readonly!
     assert_equal false, readonly.unarchive
   end
@@ -43,7 +44,7 @@ class BasicTest < ActiveSupport::TestCase
     sleep(0.001)
     after = DateTime.now
     assert before < archival.archived_at.to_datetime
-    assert after  > archival.archived_at.to_datetime
+    assert after > archival.archived_at.to_datetime
   end
 
   test "archive sets the archive number to the md5 hexdigest for the model and id that is archived" do
@@ -61,4 +62,5 @@ class BasicTest < ActiveSupport::TestCase
     second_number = archived.archive_number
     assert_equal initial_number, second_number
   end
+
 end

data/test/callbacks_test.rb

@@ -1,6 +1,7 @@
 require_relative "test_helper"
 
 class CallbacksTest < ActiveSupport::TestCase
+
   if defined?(ApplicationRecord)
     test "can set a value as part of archiving" do
       archival = CallbackArchival5.create
@@ -11,7 +12,7 @@ class CallbacksTest < ActiveSupport::TestCase
     end
 
     test "can be halted" do
-      archival = archival = CallbackArchival5.create
+      archival = CallbackArchival5.create
       archival.set_this_value = "a test string"
       archival.pass_callback = false
       assert_nil archival.settable_field
@@ -28,7 +29,7 @@ class CallbacksTest < ActiveSupport::TestCase
     end
 
     test "can be halted" do
-      archival = archival = CallbackArchival4.create
+      archival = CallbackArchival4.create
       archival.set_this_value = "a test string"
       archival.pass_callback = false
       assert_nil archival.settable_field
@@ -36,4 +37,5 @@ class CallbacksTest < ActiveSupport::TestCase
       assert_nil archival.reload.settable_field
     end
   end
+
 end

data/test/column_test.rb

@@ -1,15 +1,17 @@
 require_relative "test_helper"
 
 class ColumnTest < ActiveSupport::TestCase
+
   test "acts_as_archival raises during create if missing archived_at column" do
-    assert_raises(ExpectedBehavior::ActsAsArchival::MissingArchivalColumnError) {
-      MissingArchivedAt.create!(:name => "foo-foo")
-    }
+    assert_raises(ExpectedBehavior::ActsAsArchival::MissingArchivalColumnError) do
+      MissingArchivedAt.create!(name: "foo-foo")
+    end
   end
 
   test "acts_as_archival raises during create if missing archive_number column" do
-    assert_raises(ExpectedBehavior::ActsAsArchival::MissingArchivalColumnError) {
-      MissingArchiveNumber.create!(:name => "rover")
-    }
+    assert_raises(ExpectedBehavior::ActsAsArchival::MissingArchivalColumnError) do
+      MissingArchiveNumber.create!(name: "rover")
+    end
   end
+
 end

data/test/deep_nesting_test.rb

@@ -1,6 +1,7 @@
 require_relative "test_helper"
 
 class DeepNestingTest < ActiveSupport::TestCase
+
   test "archiving deeply nested items" do
     archival   = Archival.create!
     child      = archival.archivals.create!
@@ -15,8 +16,8 @@ class DeepNestingTest < ActiveSupport::TestCase
 
   test "unarchiving deeply nested items doesn't blow up" do
     archival_attributes = {
-      :archived_at => Time.now,
-      :archive_number => "test"
+      archived_at: Time.now,
+      archive_number: "test"
     }
     archival   = Archival.create!(archival_attributes)
     child      = archival.archivals.create!(archival_attributes)
@@ -26,4 +27,5 @@ class DeepNestingTest < ActiveSupport::TestCase
     assert_not child.reload.archived?
     assert_not grandchild.reload.archived?
   end
+
 end

data/test/fixtures/application_record.rb

@@ -1,3 +1,5 @@
 class ApplicationRecord < ActiveRecord::Base
+
   self.abstract_class = true
+
 end

data/test/fixtures/application_record_row.rb

@@ -1,6 +1,8 @@
 # Rails 5 introduced a new base class, and this is gonna be used in the tests of that
 if defined?(ApplicationRecord)
   class ApplicationRecordRow < ApplicationRecord
+
     acts_as_archival
+
   end
 end

data/test/fixtures/archival.rb

@@ -3,15 +3,17 @@
 # archive_number - string
 # archived_at    - datetime
 class Archival < ActiveRecord::Base
+
   acts_as_archival
 
-  has_many :archivals,          :dependent => :destroy
-  has_many :archival_kids,      :dependent => :destroy
-  has_many :archival_grandkids, :dependent => :destroy, :through => :archival_kids
-  has_many :exploders,          :dependent => :destroy
-  has_many :plains,             :dependent => :destroy
-  has_many :polys,              :dependent => :destroy, :as => :archiveable
+  has_many :archivals,          dependent: :destroy
+  has_many :archival_kids,      dependent: :destroy
+  has_many :archival_grandkids, dependent: :destroy, through: :archival_kids
+  has_many :exploders,          dependent: :destroy
+  has_many :plains,             dependent: :destroy
+  has_many :polys,              dependent: :destroy, as: :archiveable
   has_many :independent_archivals
 
-  scope :bobs, lambda { where(:name => ["Bob", "Bobby", "Robert"]) }
+  scope :bobs, -> { where(name: %w[Bob Bobby Robert]) }
+
 end

data/test/fixtures/archival_grandkid.rb

@@ -2,6 +2,8 @@
 # archive_number  - string
 # archived_at     - datetime
 class ArchivalGrandkid < ActiveRecord::Base
+
   acts_as_archival
   belongs_to :archival_kid
+
 end

data/test/fixtures/archival_kid.rb

@@ -2,7 +2,9 @@
 # archive_number  - string
 # archived_at     - datetime
 class ArchivalKid < ActiveRecord::Base
+
   acts_as_archival
   belongs_to :archival
-  has_many :archival_grandkids, :dependent => :destroy
+  has_many :archival_grandkids, dependent: :destroy
+
 end

data/test/fixtures/archival_table_name.rb

@@ -2,6 +2,8 @@
 # archive_number - string
 # archived_at    - datetime
 class ArchivalTableName < ActiveRecord::Base
+
   self.table_name = "legacy"
   acts_as_archival
+
 end

data/test/fixtures/callback_archival_4.rb

@@ -1,4 +1,5 @@
 class CallbackArchival4 < ActiveRecord::Base
+
   acts_as_archival
 
   attr_accessor :set_this_value,
@@ -14,4 +15,5 @@ class CallbackArchival4 < ActiveRecord::Base
   private def conditional_callback_passer
     pass_callback || pass_callback.nil?
   end
+
 end

data/test/fixtures/callback_archival_5.rb

@@ -1,6 +1,7 @@
 # necessary for ApplicationRecord
 if defined?(ApplicationRecord)
   class CallbackArchival5 < ApplicationRecord
+
     acts_as_archival
 
     attr_accessor :set_this_value,
@@ -14,7 +15,9 @@ if defined?(ApplicationRecord)
     end
 
     private def conditional_callback_passer
-      throw(:abort) unless (pass_callback || pass_callback.nil?)
+      # we want to throw only for the value false
+      throw(:abort) unless pass_callback || pass_callback.nil?
     end
+
   end
 end

data/test/fixtures/exploder.rb

@@ -2,6 +2,8 @@
 # archive_number  - string
 # archived_at     - datetime
 class Exploder < ActiveRecord::Base
+
   acts_as_archival
   belongs_to :archival
+
 end

data/test/fixtures/independent_archival.rb

@@ -3,6 +3,8 @@
 # archive_number - string
 # archived_at    - datetime
 class IndependentArchival < ActiveRecord::Base
+
   acts_as_archival
   belongs_to :archival
+
 end

data/test/fixtures/missing_archive_number.rb

@@ -1,5 +1,7 @@
 # name           - string
 # archived_at    - datetime
 class MissingArchiveNumber < ActiveRecord::Base
+
   acts_as_archival
+
 end

data/test/fixtures/missing_archived_at.rb

@@ -1,5 +1,7 @@
 # name           - string
 # archive_number - string
 class MissingArchivedAt < ActiveRecord::Base
+
   acts_as_archival
+
 end

data/test/fixtures/plain.rb

@@ -1,5 +1,7 @@
 # name        - string
 # archival_id - integer
 class Plain < ActiveRecord::Base
+
   belongs_to :archival
+
 end