paper_trail 3.0.6 → 4.2.0

data/test/unit/inheritance_column_test.rb

@@ -1,7 +1,6 @@
 require 'test_helper'
 
 class InheritanceColumnTest < ActiveSupport::TestCase
-
   context 'STI models' do
     setup do
       @animal = Animal.create :name => 'Animal'
@@ -28,16 +27,17 @@ class InheritanceColumnTest < ActiveSupport::TestCase
 
       # 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

data/test/unit/model_test.rb

@@ -1,4 +1,5 @@
 require 'test_helper'
+require 'time_travel_helper'
 
 class HasPaperTrailModelTest < ActiveSupport::TestCase
 
@@ -191,9 +192,8 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
       assert @widget.live?
     end
 
-
     context 'which is then created' do
-      setup { @widget.update_attributes :name => 'Henry' }
+      setup { @widget.update_attributes :name => 'Henry', :created_at => Time.now - 1.day }
 
       should 'have one previous version' do
         assert_equal 1, @widget.versions.length
@@ -212,10 +212,14 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
         assert @widget.live?
       end
 
+      should "use the widget `updated_at` as the version's `created_at`" do
+        assert_equal @widget.updated_at.to_i, @widget.versions.first.created_at.to_i
+      end
+
       should 'have changes' do
 
-        #TODO Postgres does not appear to pass back ActiveSupport::TimeWithZone, 
-        # so chosing the lowest common denominator to test. 
+        #TODO Postgres does not appear to pass back ActiveSupport::TimeWithZone,
+        # so chosing the lowest common denominator to test.
 
         changes = {
           'name'       => [nil, 'Henry'],
@@ -224,8 +228,8 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
           'id'         => [nil, @widget.id]
         }
 
-        assert_equal Time, @widget.versions.last.changeset['updated_at'][1].class
-        assert_equal changes, @widget.versions.last.changeset
+        assert_kind_of Time, @widget.versions.last.changeset['updated_at'][1]
+        assert_changes_equal changes, @widget.versions.last.changeset
       end
 
       context 'and then updated without any changes' do
@@ -301,13 +305,13 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
           should 'not copy the has_one association by default when reifying' do
             reified_widget = @widget.versions.last.reify
             assert_equal @wotsit, reified_widget.wotsit  # association hasn't been affected by reifying
-            assert_equal @wotsit, @widget.wotsit  # confirm that the association is correct
+            assert_equal @wotsit, @widget.wotsit(true)  # confirm that the association is correct
           end
 
           should 'copy the has_one association when reifying with :has_one => true' do
             reified_widget = @widget.versions.last.reify(:has_one => true)
             assert_nil reified_widget.wotsit  # wotsit wasn't there at the last version
-            assert_equal @wotsit, @widget.wotsit  # wotsit came into being on the live object
+            assert_equal @wotsit, @widget.wotsit(true)  # wotsit should still exist on live object
           end
         end
 
@@ -328,6 +332,31 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
           end
         end
 
+        context 'and has many associated polymorphic objects' do
+          setup do
+            @f0 = @widget.whatchamajiggers.create :name => 'f-zero'
+            @f1 = @widget.whatchamajiggers.create :name => 'f-zero'
+            @reified_widget = @widget.versions.last.reify
+          end
+
+          should 'copy the has_many associations when reifying' do
+            assert_equal @widget.whatchamajiggers.length, @reified_widget.whatchamajiggers.length
+            assert_same_elements @widget.whatchamajiggers, @reified_widget.whatchamajiggers
+
+            assert_equal @widget.versions.length, @reified_widget.versions.length
+            assert_same_elements @widget.versions, @reified_widget.versions
+          end
+        end
+
+        context 'polymorphic objects by themselves' do
+          setup do
+            @widget = Whatchamajigger.new :name => 'f-zero'
+          end
+
+          should 'not fail with a nil pointer on the polymorphic association' do
+            @widget.save!
+          end
+        end
 
         context 'and then destroyed' do
           setup do
@@ -346,7 +375,7 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
 
           should 'be available in its previous version' do
             assert_equal @widget.id, @reified_widget.id
-            assert_equal @widget.attributes, @reified_widget.attributes
+            assert_attributes_equal @widget.attributes, @reified_widget.attributes
           end
 
           should 'be re-creatable from its previous version' do
@@ -413,7 +442,7 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
     end
 
     should 'handle decimals' do
-      assert_in_delta 2.71828, @previous.a_decimal, 0.00001
+      assert_in_delta 2.7183, @previous.a_decimal, 0.0001
     end
 
     should 'handle datetimes' do
@@ -442,7 +471,7 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
         @last = @widget.versions.last
       end
 
-      teardown do 
+      teardown do
         restore_schema
       end
 
@@ -455,7 +484,7 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
         assert_equal    'The quick brown fox',       @last.reify.a_text
         assert_equal    42,                          @last.reify.an_integer
         assert_in_delta 153.01,                      @last.reify.a_float,   0.001
-        assert_in_delta 2.71828,                     @last.reify.a_decimal, 0.00001
+        assert_in_delta 2.7183,                      @last.reify.a_decimal, 0.0001
         assert_equal    @date_time.to_time.utc.to_i, @last.reify.a_datetime.to_time.utc.to_i
         assert_equal    @time.utc.to_i,              @last.reify.a_time.utc.to_i
         assert_equal    @date,                       @last.reify.a_date
@@ -567,9 +596,9 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
 
       should 'track who made the change' do
         assert_equal 'Alice', @version.whodunnit
-        assert_nil   @version.originator
+        assert_nil   @version.paper_trail_originator
         assert_equal 'Alice', @version.terminator
-        assert_equal 'Alice', @widget.originator
+        assert_equal 'Alice', @widget.paper_trail_originator
       end
 
       context 'when a record is updated' do
@@ -581,9 +610,9 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
 
         should 'track who made the change' do
           assert_equal 'Bob',   @version.whodunnit
-          assert_equal 'Alice', @version.originator
+          assert_equal 'Alice', @version.paper_trail_originator
           assert_equal 'Bob',   @version.terminator
-          assert_equal 'Bob',   @widget.originator
+          assert_equal 'Bob',   @widget.paper_trail_originator
         end
 
         context 'when a record is destroyed' do
@@ -595,9 +624,9 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
 
           should 'track who made the change' do
             assert_equal 'Charlie', @version.whodunnit
-            assert_equal 'Bob',     @version.originator
+            assert_equal 'Bob',     @version.paper_trail_originator
             assert_equal 'Charlie', @version.terminator
-            assert_equal 'Charlie', @widget.originator
+            assert_equal 'Charlie', @widget.paper_trail_originator
           end
         end
       end
@@ -646,7 +675,7 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
     should 'should return the correct originator' do
       PaperTrail.whodunnit = 'Ben'
       @foo.update_attribute(:name, 'Geoffrey')
-      assert_equal PaperTrail.whodunnit, @foo.originator
+      assert_equal PaperTrail.whodunnit, @foo.paper_trail_originator
     end
 
     context 'when destroyed' do
@@ -731,7 +760,7 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
       should 'return versions in the time period' do
         assert_equal ['Fidget'], @widget.versions_between(20.days.ago, 10.days.ago).map(&:name)
         assert_equal ['Widget', 'Fidget'], @widget.versions_between(45.days.ago, 10.days.ago).map(&:name)
-        assert_equal ['Fidget', 'Digit'], @widget.versions_between(16.days.ago, 1.minute.ago).map(&:name)
+        assert_equal ['Fidget', 'Digit', 'Digit'], @widget.versions_between(16.days.ago, 1.minute.ago).map(&:name)
         assert_equal [], @widget.versions_between(60.days.ago, 45.days.ago).map(&:name)
       end
     end
@@ -795,8 +824,8 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
         assert_equal @article.action_data_provider_method, @article.versions.last.action
       end
 
-      should 'store dynamic meta data based on an attribute of the item prior to creation' do
-        assert_equal nil, @article.versions.last.title
+      should 'store dynamic meta data based on an attribute of the item at creation' do
+        assert_equal @initial_title, @article.versions.last.title
       end
 
 
@@ -927,7 +956,7 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
       count = PaperTrail::Version.count
       @book.authors.create :name => 'Tolstoy'
       assert_equal 2, PaperTrail::Version.count - count
-      assert_same_elements [Person.last, Authorship.last], [PaperTrail::Version.all[-2].item, PaperTrail::Version.last.item]
+      assert_same_elements [Person.last, Authorship.last], [PaperTrail::Version.order(:id).to_a[-2].item, PaperTrail::Version.last.item]
     end
 
     should 'store version on join destroy' do
@@ -949,90 +978,10 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
     end
   end
 
-
-  context 'A model with a has_one association' do
-    setup { @widget = Widget.create :name => 'widget_0' }
-
-    context 'before the associated was created' do
-      setup do
-        @widget.update_attributes :name => 'widget_1'
-        @wotsit = @widget.create_wotsit :name => 'wotsit_0'
-      end
-
-      context 'when reified' do
-        setup { @widget_0 = @widget.versions.last.reify(:has_one => 1) }
-
-        should 'see the associated as it was at the time' do
-          assert_nil @widget_0.wotsit
-        end
-      end
-    end
-
-    context 'where the association is created between model versions' do
-      setup do
-        @wotsit = @widget.create_wotsit :name => 'wotsit_0'
-        make_last_version_earlier @wotsit
-
-        @widget.update_attributes :name => 'widget_1'
-      end
-
-      context 'when reified' do
-        setup { @widget_0 = @widget.versions.last.reify(:has_one => 1) }
-
-        should 'see the associated as it was at the time' do
-          assert_equal 'wotsit_0', @widget_0.wotsit.name
-        end
-      end
-
-      context 'and then the associated is updated between model versions' do
-        setup do
-          @wotsit.update_attributes :name => 'wotsit_1'
-          make_last_version_earlier @wotsit
-          @wotsit.update_attributes :name => 'wotsit_2'
-          make_last_version_earlier @wotsit
-
-          @widget.update_attributes :name => 'widget_2'
-          @wotsit.update_attributes :name => 'wotsit_3'
-        end
-
-        context 'when reified' do
-          setup { @widget_1 = @widget.versions.last.reify(:has_one => 1) }
-
-          should 'see the associated as it was at the time' do
-            assert_equal 'wotsit_2', @widget_1.wotsit.name
-          end
-        end
-
-        context 'when reified opting out of has_one reification' do
-          setup { @widget_1 = @widget.versions.last.reify(:has_one => false) }
-
-          should 'see the associated as it is live' do
-            assert_equal 'wotsit_3', @widget_1.wotsit.name
-          end
-        end
-      end
-
-      context 'and then the associated is destroyed between model versions' do
-        setup do
-          @wotsit.destroy
-          make_last_version_earlier @wotsit
-
-          @widget.update_attributes :name => 'widget_3'
-        end
-
-        context 'when reified' do
-          setup { @widget_2 = @widget.versions.last.reify(:has_one => 1) }
-
-          should 'see the associated as it was at the time' do
-            assert_nil @widget_2.wotsit
-          end
-        end
-      end
-    end
-  end
-
   context 'When an attribute has a custom serializer' do
-    setup { @person = Person.new(:time_zone => "Samoa") }
+    setup do
+      @person = Person.new(:time_zone => "Samoa")
+    end
 
     should "be an instance of ActiveSupport::TimeZone" do
       assert_equal ActiveSupport::TimeZone, @person.time_zone.class
@@ -1052,12 +1001,14 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
       should 'version.object_changes attribute should have stored the value returned by the attribute serializer' do
         as_stored_in_version = HashWithIndifferentAccess[YAML::load(@person.versions.last.object_changes)]
         assert_equal [nil, 'Samoa'], as_stored_in_version[:time_zone]
-        assert_equal @person.instance_variable_get(:@attributes)['time_zone'].serialized_value, as_stored_in_version[:time_zone].last
+        serialized_value = Person::TimeZoneSerializer.dump(@person.time_zone)
+        assert_equal serialized_value, as_stored_in_version[:time_zone].last
       end
 
       # Tests for unserialization:
       should 'version.changeset should convert the attribute value back to its original, unserialized value' do
-        assert_equal @person.instance_variable_get(:@attributes)['time_zone'].unserialized_value, @person.versions.last.changeset[:time_zone].last
+        unserialized_value = Person::TimeZoneSerializer.load(@person.time_zone)
+        assert_equal unserialized_value, @person.versions.last.changeset[:time_zone].last
       end
       should "record.changes (before save) returns the original, unserialized values" do
         assert_equal [NilClass, ActiveSupport::TimeZone], @changes_before_save[:time_zone].map(&:class)
@@ -1069,7 +1020,7 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
 
       context 'when that attribute is updated' do
         setup do
-          @attribute_value_before_change = @person.instance_variable_get(:@attributes)['time_zone']
+          @attribute_value_before_change = @person.time_zone
           @person.assign_attributes({ :time_zone => 'Pacific Time (US & Canada)' })
           @changes_before_save = @person.changes.dup
           @person.save!
@@ -1078,7 +1029,7 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
         # Tests for serialization:
         # Before the serialized attributes fix, the object/object_changes value that was stored was ridiculously long (58723).
         should 'version.object should not have stored the default, ridiculously long (to_yaml) serialization of the TimeZone object' do
-          assert @person.versions.last.object.        length < 105, "object         length was #{@person.versions.last.object        .length}"
+          assert @person.versions.last.object.length < 105, "object length was #{@person.versions.last.object.length}"
         end
         # Need an additional clause to detect what version of ActiveRecord is being used for this test because AR4 injects the `updated_at` column into the changeset for updates to models
         should 'version.object_changes should not have stored the default, ridiculously long (to_yaml) serialization of the TimeZone object' do
@@ -1088,20 +1039,24 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
         should 'version.object attribute should have stored the value returned by the attribute serializer' do
           as_stored_in_version = HashWithIndifferentAccess[YAML::load(@person.versions.last.object)]
           assert_equal 'Samoa', as_stored_in_version[:time_zone]
-          assert_equal @attribute_value_before_change.serialized_value, as_stored_in_version[:time_zone]
+          serialized_value = Person::TimeZoneSerializer.dump(@attribute_value_before_change)
+          assert_equal serialized_value, as_stored_in_version[:time_zone]
         end
         should 'version.object_changes attribute should have stored the value returned by the attribute serializer' do
           as_stored_in_version = HashWithIndifferentAccess[YAML::load(@person.versions.last.object_changes)]
           assert_equal ['Samoa', 'Pacific Time (US & Canada)'], as_stored_in_version[:time_zone]
-          assert_equal @person.instance_variable_get(:@attributes)['time_zone'].serialized_value, as_stored_in_version[:time_zone].last
+          serialized_value = Person::TimeZoneSerializer.dump(@person.time_zone)
+          assert_equal serialized_value, as_stored_in_version[:time_zone].last
         end
 
         # Tests for unserialization:
         should 'version.reify should convert the attribute value back to its original, unserialized value' do
-          assert_equal @attribute_value_before_change.unserialized_value, @person.versions.last.reify.time_zone
+          unserialized_value = Person::TimeZoneSerializer.load(@attribute_value_before_change)
+          assert_equal unserialized_value, @person.versions.last.reify.time_zone
         end
         should 'version.changeset should convert the attribute value back to its original, unserialized value' do
-          assert_equal @person.instance_variable_get(:@attributes)['time_zone'].unserialized_value, @person.versions.last.changeset[:time_zone].last
+          unserialized_value = Person::TimeZoneSerializer.load(@person.time_zone)
+          assert_equal unserialized_value, @person.versions.last.changeset[:time_zone].last
         end
         should "record.changes (before save) returns the original, unserialized values" do
           assert_equal [ActiveSupport::TimeZone, ActiveSupport::TimeZone], @changes_before_save[:time_zone].map(&:class)
@@ -1165,6 +1120,21 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
     should 'return "overwritten" value on reified instance' do
       assert_equal 4, @song.versions.last.reify.length
     end
+
+    context 'Has a virtual attribute injected into the ActiveModel::Dirty changes' do
+      setup do
+        @song.name = 'Good Vibrations'
+        @song.save
+        @song.name = 'Yellow Submarine'
+      end
+
+      should 'return persist the changes on the live instance properly' do
+        assert_equal 'Yellow Submarine', @song.name
+      end
+      should 'return "overwritten" virtual attribute on the reified instance' do
+        assert_equal 'Good Vibrations', @song.versions.last.reify.name
+      end
+    end
   end
 
 
@@ -1252,6 +1222,31 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
         assert_equal 'destroy', @fluxor.versions.last.event
       end
     end
+    context 'on []' do
+      setup do
+        Fluxor.reset_callbacks :create
+        Fluxor.reset_callbacks :update
+        Fluxor.reset_callbacks :destroy
+        Fluxor.instance_eval <<-END
+          has_paper_trail :on => []
+        END
+        @fluxor = Fluxor.create
+        @fluxor.update_attributes :name => 'blah'
+      end
+
+      teardown do
+        @fluxor.destroy
+      end
+
+      should 'not have any versions' do
+        assert_equal 0, @fluxor.versions.length
+      end
+
+      should 'still respond to touch_with_version' do
+        @fluxor.touch_with_version
+        assert_equal 1, @fluxor.versions.length
+      end
+    end
     context 'allows a symbol to be passed' do
       setup do
         Fluxor.reset_callbacks :create
@@ -1375,15 +1370,4 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
       assert_equal 3, @widget.versions.size
     end
   end
-
-  private
-
-  # Updates `model`'s last version so it looks like the version was
-  # created 2 seconds ago.
-  def make_last_version_earlier(model)
-    PaperTrail::Version.record_timestamps = false
-    model.versions.last.update_attributes :created_at => 2.seconds.ago
-    PaperTrail::Version.record_timestamps = true
-  end
-
 end

data/test/unit/protected_attrs_test.rb

@@ -35,9 +35,10 @@ class ProtectedAttrsTest < ActiveSupport::TestCase
       end
 
       should 'the previous version should contain right attributes' do
-        # For some reason this test seems to be broken in JRuby 1.9 mode in the test env even though it works in the console. WTF?
-        unless ActiveRecord::VERSION::MAJOR >= 4 && defined?(JRUBY_VERSION) && RUBY_VERSION.to_f >= 1.9
-          assert_equal @widget.previous_version.attributes, @initial_attributes
+        # For some reason this test seems to be broken in JRuby 1.9 mode in the
+        # test env even though it works in the console. WTF?
+        unless ActiveRecord::VERSION::MAJOR >= 4 && defined?(JRUBY_VERSION) && RUBY_VERSION >= '1.9'
+          assert_attributes_equal @widget.previous_version.attributes, @initial_attributes
         end
       end
     end