paper_trail 5.2.3 → 6.0.0

data/lib/paper_trail/version_concern.rb

@@ -74,8 +74,8 @@ module PaperTrail
           return where(arel_table[primary_key].gt(obj.id)).order(arel_table[primary_key].asc)
         end
 
-        obj = obj.send(PaperTrail.timestamp_field) if obj.is_a?(self)
-        where(arel_table[PaperTrail.timestamp_field].gt(obj)).order(timestamp_sort_order)
+        obj = obj.send(:created_at) if obj.is_a?(self)
+        where(arel_table[:created_at].gt(obj)).order(timestamp_sort_order)
       end
 
       # Returns versions before `obj`.
@@ -90,22 +90,22 @@ module PaperTrail
           return where(arel_table[primary_key].lt(obj.id)).order(arel_table[primary_key].desc)
         end
 
-        obj = obj.send(PaperTrail.timestamp_field) if obj.is_a?(self)
-        where(arel_table[PaperTrail.timestamp_field].lt(obj)).
+        obj = obj.send(:created_at) if obj.is_a?(self)
+        where(arel_table[:created_at].lt(obj)).
           order(timestamp_sort_order("desc"))
       end
 
       def between(start_time, end_time)
         where(
-          arel_table[PaperTrail.timestamp_field].gt(start_time).
-          and(arel_table[PaperTrail.timestamp_field].lt(end_time))
+          arel_table[:created_at].gt(start_time).
+          and(arel_table[:created_at].lt(end_time))
         ).order(timestamp_sort_order)
       end
 
       # Defaults to using the primary key as the secondary sort order if
       # possible.
       def timestamp_sort_order(direction = "asc")
-        [arel_table[PaperTrail.timestamp_field].send(direction.downcase)].tap do |array|
+        [arel_table[:created_at].send(direction.downcase)].tap do |array|
           array << arel_table[primary_key].send(direction.downcase) if primary_key_is_int?
         end
       end

data/lib/paper_trail/version_number.rb

@@ -1,9 +1,9 @@
 module PaperTrail
   # :nodoc:
   module VERSION
-    MAJOR = 5
-    MINOR = 2
-    TINY = 3
+    MAJOR = 6
+    MINOR = 0
+    TINY = 0
     PRE = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".").freeze

data/lib/paper_trail.rb

@@ -72,21 +72,12 @@ module PaperTrail
 
     # Set the field which records when a version was created.
     # @api public
-    # @deprecated
-    def timestamp_field=(field_name)
-      ::ActiveSupport::Deprecation.warn(
-        "PaperTrail.timestamp_field= is deprecated without replacement." \
-          "See https://github.com/airblade/paper_trail/pull/861 for discussion",
-        caller(1)
+    def timestamp_field=(_field_name)
+      raise(
+        "PaperTrail.timestamp_field= has been removed, without replacement. " \
+          "It is no longer configurable. The timestamp field in the versions table " \
+          "must now be named created_at."
       )
-      PaperTrail.config.timestamp_field = field_name
-    end
-
-    # Returns the field which records when a version was created.
-    # @api public
-    # @deprecated
-    def timestamp_field
-      PaperTrail.config.timestamp_field
     end
 
     # Sets who is responsible for any changes that occur. You would normally use

data/paper_trail.gemspec

@@ -20,7 +20,8 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = ">= 1.3.6"
   s.required_ruby_version = ">= 1.9.3"
 
-  s.add_dependency "activerecord", [">= 3.0", "< 6.0"]
+  # Rails does not follow semver, makes breaking changes in minor versions.
+  s.add_dependency "activerecord", [">= 4.0", "< 5.2"]
   s.add_dependency "request_store", "~> 1.1"
 
   s.add_development_dependency "appraisal", "~> 2.1"

data/spec/models/widget_spec.rb

@@ -14,13 +14,28 @@ describe Widget, type: :model do
       widget.update_attributes!(name: "Bob")
     end
 
-    it "is possible to do assertions on versions" do
+    it "is possible to do assertions on version attributes" do
       expect(widget).to have_a_version_with name: "Leonard", an_integer: 1
       expect(widget).to have_a_version_with an_integer: 1
       expect(widget).to have_a_version_with name: "Tom"
     end
   end
 
+  describe "`have_a_version_with_changes` matcher", versioning: true do
+    before do
+      widget.update_attributes!(name: "Leonard", an_integer: 2)
+      widget.update_attributes!(name: "Tom")
+      widget.update_attributes!(name: "Bob")
+    end
+
+    it "is possible to do assertions on version changes" do
+      expect(widget).to have_a_version_with_changes name: "Leonard", an_integer: 2
+      expect(widget).to have_a_version_with_changes an_integer: 2
+      expect(widget).to have_a_version_with_changes name: "Tom"
+      expect(widget).to have_a_version_with_changes name: "Bob"
+    end
+  end
+
   describe "versioning option" do
     context "enabled", versioning: true do
       it "should enable versioning" do
@@ -238,8 +253,6 @@ describe Widget, type: :model do
       end
 
       describe "#whodunnit" do
-        it { is_expected.to respond_to(:whodunnit) }
-
         context "no block given" do
           it "should raise an error" do
             expect {

data/test/dummy/app/models/song.rb

@@ -1,7 +1,6 @@
 # Example from 'Overwriting default accessors' in ActiveRecord::Base.
 class Song < ActiveRecord::Base
   has_paper_trail
-  attr_accessor :name
 
   # Uses an integer of seconds to hold the length of the song
   def length=(minutes)
@@ -12,30 +11,36 @@ class Song < ActiveRecord::Base
     read_attribute(:length) / 60
   end
 
-  # override attributes hashes like some libraries do
-  def attributes_with_name
-    if name
-      attributes_without_name.merge(name: name)
-    else
-      attributes_without_name
+  if ActiveRecord::VERSION::MAJOR >= 5
+    attribute :name, :string
+  else
+    attr_accessor :name
+
+    # override attributes hashes like some libraries do
+    def attributes_with_name
+      if name
+        attributes_without_name.merge(name: name)
+      else
+        attributes_without_name
+      end
     end
-  end
 
-  # `alias_method_chain` is deprecated in rails 5, but we cannot use the
-  # suggested replacement, `Module#prepend`, because we still support ruby 1.9.
-  alias attributes_without_name attributes
-  alias attributes attributes_with_name
+    # `alias_method_chain` is deprecated in rails 5, but we cannot use the
+    # suggested replacement, `Module#prepend`, because we still support ruby 1.9.
+    alias attributes_without_name attributes
+    alias attributes attributes_with_name
 
-  def changed_attributes_with_name
-    if name
-      changed_attributes_without_name.merge(name: name)
-    else
-      changed_attributes_without_name
+    def changed_attributes_with_name
+      if name
+        changed_attributes_without_name.merge(name: name)
+      else
+        changed_attributes_without_name
+      end
     end
-  end
 
-  # `alias_method_chain` is deprecated in rails 5, but we cannot use the
-  # suggested replacement, `Module#prepend`, because we still support ruby 1.9.
-  alias changed_attributes_without_name changed_attributes
-  alias changed_attributes changed_attributes_with_name
+    # `alias_method_chain` is deprecated in rails 5, but we cannot use the
+    # suggested replacement, `Module#prepend`, because we still support ruby 1.9.
+    alias changed_attributes_without_name changed_attributes
+    alias changed_attributes changed_attributes_with_name
+  end
 end

data/test/test_helper.rb

@@ -88,19 +88,6 @@ module ActiveSupport
   end
 end
 
-#
-# Helpers
-#
-
-def change_schema
-  ActiveRecord::Migration.verbose = false
-  ActiveRecord::Schema.define do
-    add_column :versions, :custom_created_at, :datetime
-  end
-  ActiveRecord::Migration.verbose = true
-  reset_version_class_column_info!
-end
-
 # Wrap args in a hash to support the ActionController::TestCase and
 # ActionDispatch::Integration HTTP request method switch to keyword args
 # (see https://github.com/rails/rails/blob/master/actionpack/CHANGELOG.md)
@@ -112,16 +99,27 @@ def params_wrapper(args)
   end
 end
 
-def reset_version_class_column_info!
-  PaperTrail::Version.connection.schema_cache.clear!
-  PaperTrail::Version.reset_column_information
-end
+module CleanupCallbacks
+  def cleanup_callbacks(target, type)
+    original_callbacks = nil
 
-def restore_schema
-  ActiveRecord::Migration.verbose = false
-  ActiveRecord::Schema.define do
-    remove_column :versions, :custom_created_at
+    setup do
+      if ActiveRecord::VERSION::MAJOR > 3
+        original_callbacks = target.send(:get_callbacks, type).deep_dup
+      else
+        # While this defeats the purpose of targeted callback
+        # cleanup, callbacks were incredibly difficult to modify
+        # prior to Rails 4, and Rails internal callbacks were only
+        # used for autosaving associations in Rails 3. Our tests
+        # don't care whether a Fluxor's widget is autosaved.
+        target.reset_callbacks(type)
+      end
+    end
+
+    teardown do
+      if original_callbacks
+        target.send(:set_callbacks, type, original_callbacks)
+      end
+    end
   end
-  ActiveRecord::Migration.verbose = true
-  reset_version_class_column_info!
 end

data/test/unit/associations_test.rb

@@ -785,7 +785,7 @@ class AssociationsTest < ActiveSupport::TestCase
           setup { @wotsit_0 = @wotsit.versions.last.reify(belongs_to: true) }
 
           should "see the associated as it was at the time" do
-            assert_equal nil, @wotsit_0.widget
+            assert_nil @wotsit_0.widget
           end
 
           should "not persist changes to the live association" do

data/test/unit/cleaner_test.rb

@@ -148,41 +148,4 @@ class PaperTrailCleanerTest < ActiveSupport::TestCase
       end
     end
   end # clean_versions! method
-
-  context "Custom timestamp field" do
-    setup do
-      change_schema
-      populate_db!
-      # now mess with the timestamps
-      @animals.each do |animal|
-        animal.versions.reverse.each_with_index do |version, index|
-          version.update_attribute(:custom_created_at, Time.now.utc + index.days)
-        end
-      end
-      PaperTrail.timestamp_field = :custom_created_at
-      @animals.map { |a| a.versions.reload } # reload the `versions` association for each animal
-    end
-
-    teardown do
-      PaperTrail.timestamp_field = :created_at
-      restore_schema
-    end
-
-    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|
-          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
-      assert_equal 9, PaperTrail::Version.count
-      PaperTrail.clean_versions!
-      assert_equal 9, PaperTrail::Version.count
-    end
-  end
 end

data/test/unit/inheritance_column_test.rb

@@ -27,14 +27,12 @@ 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).
-        order(PaperTrail.timestamp_field)
+      dog_versions = PaperTrail::Version.where(item_id: @dog.id).order(:created_at)
       assert_equal 4, dog_versions.count
       assert_nil dog_versions.first.reify
       assert_equal %w(NilClass Dog Dog Dog), dog_versions.map { |v| v.reify.class.name }
 
-      cat_versions = PaperTrail::Version.where(item_id: @cat.id).
-        order(PaperTrail.timestamp_field)
+      cat_versions = PaperTrail::Version.where(item_id: @cat.id).order(:created_at)
       assert_equal 4, cat_versions.count
       assert_nil cat_versions.first.reify
       assert_equal %w(NilClass Cat Cat Cat), cat_versions.map { |v| v.reify.class.name }

data/test/unit/model_test.rb

@@ -2,6 +2,8 @@ require "test_helper"
 require "time_travel_helper"
 
 class HasPaperTrailModelTest < ActiveSupport::TestCase
+  extend CleanupCallbacks
+
   context "A record with defined 'only' and 'ignore' attributes" do
     setup { @article = Article.create }
 
@@ -135,7 +137,7 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
         end
 
         should "have removed the skipped attributes when saving the previous version" do
-          assert_equal nil, PaperTrail.serializer.load(@old_article.object)["file_upload"]
+          assert_nil PaperTrail.serializer.load(@old_article.object)["file_upload"]
         end
 
         should "have kept the non-skipped attributes in the previous version" do
@@ -517,16 +519,9 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
 
     context "after a column is removed from the record's schema" do
       setup do
-        change_schema
-        Widget.connection.schema_cache.clear!
-        Widget.reset_column_information
         @last = @widget.versions.last
       end
 
-      teardown do
-        restore_schema
-      end
-
       should "reify previous version" do
         assert_kind_of Widget, @last.reify
       end
@@ -1291,6 +1286,11 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
 
   context "The `on` option" do
     context "on create" do
+      cleanup_callbacks(Fluxor, :create)
+      cleanup_callbacks(Fluxor, :update)
+      cleanup_callbacks(Fluxor, :destroy)
+      cleanup_callbacks(Fluxor, :save)
+
       setup do
         Fluxor.instance_eval <<-END
           has_paper_trail :on => [:create]
@@ -1299,16 +1299,20 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
         @fluxor.update_attributes name: "blah"
         @fluxor.destroy
       end
+
       should "only have a version for the create event" do
         assert_equal 1, @fluxor.versions.length
         assert_equal "create", @fluxor.versions.last.event
       end
     end
+
     context "on update" do
+      cleanup_callbacks(Fluxor, :create)
+      cleanup_callbacks(Fluxor, :update)
+      cleanup_callbacks(Fluxor, :destroy)
+      cleanup_callbacks(Fluxor, :save)
+
       setup do
-        Fluxor.reset_callbacks :create
-        Fluxor.reset_callbacks :update
-        Fluxor.reset_callbacks :destroy
         Fluxor.instance_eval <<-END
           has_paper_trail :on => [:update]
         END
@@ -1316,16 +1320,20 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
         @fluxor.update_attributes name: "blah"
         @fluxor.destroy
       end
+
       should "only have a version for the update event" do
         assert_equal 1, @fluxor.versions.length
         assert_equal "update", @fluxor.versions.last.event
       end
     end
+
     context "on destroy" do
+      cleanup_callbacks(Fluxor, :create)
+      cleanup_callbacks(Fluxor, :update)
+      cleanup_callbacks(Fluxor, :destroy)
+      cleanup_callbacks(Fluxor, :save)
+
       setup do
-        Fluxor.reset_callbacks :create
-        Fluxor.reset_callbacks :update
-        Fluxor.reset_callbacks :destroy
         Fluxor.instance_eval <<-END
           has_paper_trail :on => [:destroy]
         END
@@ -1333,16 +1341,20 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
         @fluxor.update_attributes name: "blah"
         @fluxor.destroy
       end
+
       should "only have a version for the destroy event" do
         assert_equal 1, @fluxor.versions.length
         assert_equal "destroy", @fluxor.versions.last.event
       end
     end
+
     context "on []" do
+      cleanup_callbacks(Fluxor, :create)
+      cleanup_callbacks(Fluxor, :update)
+      cleanup_callbacks(Fluxor, :destroy)
+      cleanup_callbacks(Fluxor, :save)
+
       setup do
-        Fluxor.reset_callbacks :create
-        Fluxor.reset_callbacks :update
-        Fluxor.reset_callbacks :destroy
         Fluxor.instance_eval <<-END
           has_paper_trail :on => []
         END
@@ -1363,11 +1375,14 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
         assert_equal 1, @fluxor.versions.length
       end
     end
+
     context "allows a symbol to be passed" do
+      cleanup_callbacks(Fluxor, :create)
+      cleanup_callbacks(Fluxor, :update)
+      cleanup_callbacks(Fluxor, :destroy)
+      cleanup_callbacks(Fluxor, :save)
+
       setup do
-        Fluxor.reset_callbacks :create
-        Fluxor.reset_callbacks :update
-        Fluxor.reset_callbacks :destroy
         Fluxor.instance_eval <<-END
           has_paper_trail :on => :create
         END
@@ -1375,6 +1390,7 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
         @fluxor.update_attributes name: "blah"
         @fluxor.destroy
       end
+
       should "only have a version for hte create event" do
         assert_equal 1, @fluxor.versions.length
         assert_equal "create", @fluxor.versions.last.event
@@ -1420,10 +1436,12 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
 
   context "custom events" do
     context "on create" do
+      cleanup_callbacks(Fluxor, :create)
+      cleanup_callbacks(Fluxor, :update)
+      cleanup_callbacks(Fluxor, :destroy)
+      cleanup_callbacks(Fluxor, :save)
+
       setup do
-        Fluxor.reset_callbacks :create
-        Fluxor.reset_callbacks :update
-        Fluxor.reset_callbacks :destroy
         Fluxor.instance_eval <<-END
           has_paper_trail :on => [:create]
         END
@@ -1431,16 +1449,20 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
         @fluxor.update_attributes name: "blah"
         @fluxor.destroy
       end
+
       should "only have a version for the created event" do
         assert_equal 1, @fluxor.versions.length
         assert_equal "created", @fluxor.versions.last.event
       end
     end
+
     context "on update" do
+      cleanup_callbacks(Fluxor, :create)
+      cleanup_callbacks(Fluxor, :update)
+      cleanup_callbacks(Fluxor, :destroy)
+      cleanup_callbacks(Fluxor, :save)
+
       setup do
-        Fluxor.reset_callbacks :create
-        Fluxor.reset_callbacks :update
-        Fluxor.reset_callbacks :destroy
         Fluxor.instance_eval <<-END
           has_paper_trail :on => [:update]
         END
@@ -1448,16 +1470,20 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
         @fluxor.update_attributes name: "blah"
         @fluxor.destroy
       end
+
       should "only have a version for the name_updated event" do
         assert_equal 1, @fluxor.versions.length
         assert_equal "name_updated", @fluxor.versions.last.event
       end
     end
+
     context "on destroy" do
+      cleanup_callbacks(Fluxor, :create)
+      cleanup_callbacks(Fluxor, :update)
+      cleanup_callbacks(Fluxor, :destroy)
+      cleanup_callbacks(Fluxor, :save)
+
       setup do
-        Fluxor.reset_callbacks :create
-        Fluxor.reset_callbacks :update
-        Fluxor.reset_callbacks :destroy
         Fluxor.instance_eval <<-END
           has_paper_trail :on => [:destroy]
         END
@@ -1465,6 +1491,7 @@ class HasPaperTrailModelTest < ActiveSupport::TestCase
         @fluxor.update_attributes name: "blah"
         @fluxor.destroy
       end
+
       should "only have a version for the destroy event" do
         assert_equal 1, @fluxor.versions.length
         assert_equal "destroyed", @fluxor.versions.last.event