paper_trail 4.0.0 → 5.1.0

data/test/unit/cleaner_test.rb

@@ -1,71 +1,71 @@
-require 'test_helper'
+require "test_helper"
 
 class PaperTrailCleanerTest < ActiveSupport::TestCase
-
   def populate_db!
     @animals = [@animal = Animal.new, @dog = Dog.new, @cat = Cat.new]
     @animals.each do |animal|
-      3.times { animal.update_attribute(:name, Faker::Name.name) }
+      3.times { animal.update_attribute(:name, FFaker::Name.name) }
     end
   end
 
-  context '`clean_versions!` method' do
-    setup { self.populate_db! }
+  context "`clean_versions!` method" do
+    setup { populate_db! }
 
-    should 'Baseline' do
+    should "Baseline" do
       assert_equal 9, PaperTrail::Version.count
       @animals.each { |animal| assert_equal 3, animal.versions.size }
     end
 
-    should 'be extended by `PaperTrail` module' do
+    should "be extended by `PaperTrail` module" do
       assert_respond_to PaperTrail, :clean_versions!
     end
 
-    context 'No options provided' do
-      should 'removes extra versions for each item' do
+    context "No options provided" do
+      should "removes extra versions for each item" do
         PaperTrail.clean_versions!
         assert_equal 3, PaperTrail::Version.count
         @animals.each { |animal| assert_equal 1, animal.versions.size }
       end
 
-      should 'removes the earliest version(s)' do
-        most_recent_version_names = @animals.map { |animal| animal.versions.last.reify.name }
+      should "removes the earliest version(s)" do
+        before = @animals.map { |animal| animal.versions.last.reify.name }
         PaperTrail.clean_versions!
-        assert_equal most_recent_version_names, @animals.map { |animal| animal.versions.last.reify.name }
+        after = @animals.map { |animal| animal.versions.last.reify.name }
+        assert_equal before, after
       end
     end
 
-    context '`:keeping` option' do
-      should 'modifies the number of versions ommitted from destruction' do
-        PaperTrail.clean_versions!(:keeping => 2)
+    context "`:keeping` option" do
+      should "modifies the number of versions ommitted from destruction" do
+        PaperTrail.clean_versions!(keeping: 2)
         assert_equal 6, PaperTrail::Version.all.count
         @animals.each { |animal| assert_equal 2, animal.versions.size }
       end
     end
 
-    context '`:date` option' do
+    context "`:date` option" do
       setup do
         @animal.versions.each { |ver| ver.update_attribute(:created_at, ver.created_at - 1.day) }
         @date = @animal.versions.first.created_at.to_date
-        @animal.update_attribute(:name, Faker::Name.name)
+        @animal.update_attribute(:name, FFaker::Name.name)
       end
 
-      should 'restrict the versions destroyed to those that were created on the date provided' do
+      should "restrict the versions destroyed to those that were created on the date provided" do
         assert_equal 10, PaperTrail::Version.count
         assert_equal 4, @animal.versions.size
         assert_equal 3, @animal.versions_between(@date, @date + 1.day).size
-        PaperTrail.clean_versions!(:date => @date)
+        PaperTrail.clean_versions!(date: @date)
         assert_equal 8, PaperTrail::Version.count
-        assert_equal 2, @animal.versions(true).size
+        assert_equal 2, @animal.versions.reload.size
         assert_equal @date, @animal.versions.first.created_at.to_date
         assert_not_same @date, @animal.versions.last.created_at.to_date
       end
     end
 
-    context '`:item_id` option' do
-      context 'single ID received' do
-        should 'restrict the versions destroyed to the versions for the Item with that ID' do
-          PaperTrail.clean_versions!(:item_id => @animal.id)
+    context "`:item_id` option" do
+      context "single ID received" do
+        should "restrict the versions destroyed to the versions for the Item with that ID" do
+          PaperTrail.clean_versions!(item_id: @animal.id)
           assert_equal 1, @animal.versions.size
           assert_equal 7, PaperTrail::Version.count
         end
@@ -73,7 +73,7 @@ class PaperTrailCleanerTest < ActiveSupport::TestCase
 
       context "collection of ID's received" do
         should "restrict the versions destroyed to the versions for the Item with those ID's" do
-          PaperTrail.clean_versions!(:item_id => [@animal.id, @dog.id])
+          PaperTrail.clean_versions!(item_id: [@animal.id, @dog.id])
           assert_equal 1, @animal.versions.size
           assert_equal 1, @dog.versions.size
           assert_equal 5, PaperTrail::Version.count
@@ -81,72 +81,78 @@ class PaperTrailCleanerTest < ActiveSupport::TestCase
       end
     end
 
-    context 'options combinations' do # additional tests to cover combinations of options
-      context '`:date`' do
+    context "options combinations" do # additional tests to cover combinations of options
+      context "`:date`" do
         setup do
           [@animal, @dog].each do |animal|
             animal.versions.each { |ver| ver.update_attribute(:created_at, ver.created_at - 1.day) }
-            animal.update_attribute(:name, Faker::Name.name)
+            animal.update_attribute(:name, FFaker::Name.name)
           end
           @date = @animal.versions.first.created_at.to_date
         end
 
-        should 'Baseline' do
+        should "Baseline" do
           assert_equal 11, PaperTrail::Version.count
           [@animal, @dog].each do |animal|
             assert_equal 4, animal.versions.size
-            assert_equal 3, animal.versions.between(@date, @date+1.day).size
+            assert_equal 3, animal.versions.between(@date, @date + 1.day).size
           end
         end
 
-        context 'and `:keeping`' do
-          should 'restrict cleaning properly' do
-            PaperTrail.clean_versions!(:date => @date, :keeping => 2)
+        context "and `:keeping`" do
+          should "restrict cleaning properly" do
+            PaperTrail.clean_versions!(date: @date, keeping: 2)
             [@animal, @dog].each do |animal|
-              animal.versions.reload # reload the association to pick up the destructions made by the `Cleaner`
+              # reload the association to pick up the destructions made by the `Cleaner`
+              animal.versions.reload
               assert_equal 3, animal.versions.size
-              assert_equal 2, animal.versions.between(@date, @date+1.day).size
+              assert_equal 2, animal.versions.between(@date, @date + 1.day).size
             end
-            assert_equal 9, PaperTrail::Version.count # ensure that the versions for the `@cat` instance wasn't touched
+            # ensure that the versions for the `@cat` instance wasn't touched
+            assert_equal 9, PaperTrail::Version.count
           end
         end
 
-        context 'and `:item_id`' do
-          should 'restrict cleaning properly' do
-            PaperTrail.clean_versions!(:date => @date, :item_id => @dog.id)
-            @dog.versions.reload # reload the association to pick up the destructions made by the `Cleaner`
+        context "and `:item_id`" do
+          should "restrict cleaning properly" do
+            PaperTrail.clean_versions!(date: @date, item_id: @dog.id)
+            # reload the association to pick up the destructions made by the `Cleaner`
+            @dog.versions.reload
             assert_equal 2, @dog.versions.size
-            assert_equal 1, @dog.versions.between(@date, @date+1.day).size
-            assert_equal 9, PaperTrail::Version.count # ensure the versions for other animals besides `@animal` weren't touched
+            assert_equal 1, @dog.versions.between(@date, @date + 1.day).size
+            # ensure the versions for other animals besides `@animal` weren't touched
+            assert_equal 9, PaperTrail::Version.count
           end
         end
 
-        context ', `:item_id`, and `:keeping`' do
-          should 'restrict cleaning properly' do
-            PaperTrail.clean_versions!(:date => @date, :item_id => @dog.id, :keeping => 2)
-            @dog.versions.reload # reload the association to pick up the destructions made by the `Cleaner`
+        context ", `:item_id`, and `:keeping`" do
+          should "restrict cleaning properly" do
+            PaperTrail.clean_versions!(date: @date, item_id: @dog.id, keeping: 2)
+            # reload the association to pick up the destructions made by the `Cleaner`
+            @dog.versions.reload
             assert_equal 3, @dog.versions.size
-            assert_equal 2, @dog.versions.between(@date, @date+1.day).size
-            assert_equal 10, PaperTrail::Version.count # ensure the versions for other animals besides `@animal` weren't touched
+            assert_equal 2, @dog.versions.between(@date, @date + 1.day).size
+            # ensure the versions for other animals besides `@animal` weren't touched
+            assert_equal 10, PaperTrail::Version.count
           end
         end
       end
 
-      context '`:keeping` and `:item_id`' do
-        should 'restrict cleaning properly' do
-          PaperTrail.clean_versions!(:keeping => 2, :item_id => @animal.id)
+      context "`:keeping` and `:item_id`" do
+        should "restrict cleaning properly" do
+          PaperTrail.clean_versions!(keeping: 2, item_id: @animal.id)
           assert_equal 2, @animal.versions.size
-          assert_equal 8, PaperTrail::Version.count # ensure the versions for other animals besides `@animal` weren't touched
+          # ensure the versions for other animals besides `@animal` weren't touched
+          assert_equal 8, PaperTrail::Version.count
         end
       end
     end
-
   end # clean_versions! method
 
   context "Custom timestamp field" do
     setup do
       change_schema
-      self.populate_db!
+      populate_db!
       # now mess with the timestamps
       @animals.each do |animal|
         animal.versions.reverse.each_with_index do |version, index|
@@ -154,7 +160,7 @@ class PaperTrailCleanerTest < ActiveSupport::TestCase
         end
       end
       PaperTrail.timestamp_field = :custom_created_at
-      @animals.map { |a| a.versions(true) } # reload the `versions` association for each animal
+      @animals.map { |a| a.versions.reload } # reload the `versions` association for each animal
     end
 
     teardown do
@@ -162,18 +168,18 @@ class PaperTrailCleanerTest < ActiveSupport::TestCase
       restore_schema
     end
 
-    should 'Baseline' do
+    should "Baseline" do
       assert_equal 9, PaperTrail::Version.count
       @animals.each do |animal|
         assert_equal 3, animal.versions.size
-        animal.versions.each_cons(2) do |a,b|
-          a.created_at.to_date == b.created_at.to_date
-          a.custom_created_at.to_date != b.custom_created_at.to_date
+        animal.versions.each_cons(2) do |a, b|
+          assert_equal a.created_at.to_date, b.created_at.to_date
+          assert_not_equal a.custom_created_at.to_date, b.custom_created_at.to_date
         end
       end
     end
 
-    should 'group by `PaperTrail.timestamp_field` when seperating the versions by date to clean' do
+    should "group by `PaperTrail.timestamp_field` when seperating the versions by date to clean" do
       assert_equal 9, PaperTrail::Version.count
       PaperTrail.clean_versions!
       assert_equal 9, PaperTrail::Version.count

data/test/unit/inheritance_column_test.rb

@@ -1,43 +1,43 @@
-require 'test_helper'
+require "test_helper"
 
 class InheritanceColumnTest < ActiveSupport::TestCase
-
-  context 'STI models' do
+  context "STI models" do
     setup do
-      @animal = Animal.create :name => 'Animal'
-      @animal.update_attributes :name => 'Animal from the Muppets'
-      @animal.update_attributes :name => 'Animal Muppet'
+      @animal = Animal.create name: "Animal"
+      @animal.update_attributes name: "Animal from the Muppets"
+      @animal.update_attributes name: "Animal Muppet"
       @animal.destroy
 
-      @dog = Dog.create :name => 'Snoopy'
-      @dog.update_attributes :name => 'Scooby'
-      @dog.update_attributes :name => 'Scooby Doo'
+      @dog = Dog.create name: "Snoopy"
+      @dog.update_attributes name: "Scooby"
+      @dog.update_attributes name: "Scooby Doo"
       @dog.destroy
 
-      @cat = Cat.create :name => 'Garfield'
-      @cat.update_attributes :name => 'Garfield (I hate Mondays)'
-      @cat.update_attributes :name => 'Garfield The Cat'
+      @cat = Cat.create name: "Garfield"
+      @cat.update_attributes name: "Garfield (I hate Mondays)"
+      @cat.update_attributes name: "Garfield The Cat"
       @cat.destroy
     end
 
-    should 'work with custom STI inheritance column' do
+    should "work with custom STI inheritance column" do
       assert_equal 12, PaperTrail::Version.count
       assert_equal 4, @animal.versions.count
       assert_nil @animal.versions.first.reify
-      @animal.versions[1..-1].each { |v| assert_equal 'Animal', v.reify.class.name }
+      @animal.versions[1..-1].each { |v| assert_equal "Animal", v.reify.class.name }
 
       # For some reason `@dog.versions` doesn't include the final `destroy` version.
       # Neither do `@dog.versions.scoped` nor `@dog.versions(true)` nor `@dog.versions.reload`.
-      dog_versions = PaperTrail::Version.where(:item_id => @dog.id)
+      dog_versions = PaperTrail::Version.where(item_id: @dog.id).
+        order(PaperTrail.timestamp_field)
       assert_equal 4, dog_versions.count
       assert_nil dog_versions.first.reify
-      dog_versions[1..-1].each { |v| assert_equal 'Dog', v.reify.class.name }
+      assert_equal %w(NilClass Dog Dog Dog), dog_versions.map { |v| v.reify.class.name }
 
-      cat_versions = PaperTrail::Version.where(:item_id => @cat.id)
+      cat_versions = PaperTrail::Version.where(item_id: @cat.id).
+        order(PaperTrail.timestamp_field)
       assert_equal 4, cat_versions.count
       assert_nil cat_versions.first.reify
-      cat_versions[1..-1].each { |v| assert_equal 'Cat', v.reify.class.name }
+      assert_equal %w(NilClass Cat Cat Cat), cat_versions.map { |v| v.reify.class.name }
     end
   end
-
 end