paper_trail 9.2.0 → 14.0.0

data/lib/paper_trail/record_trail.rb

@@ -1,72 +1,14 @@
 # frozen_string_literal: true
 
+require "paper_trail/events/create"
+require "paper_trail/events/destroy"
+require "paper_trail/events/update"
+
 module PaperTrail
   # Represents the "paper trail" for a single record.
   class RecordTrail
-    DPR_TOUCH_WITH_VERSION = <<-STR.squish.freeze
-      my_model.paper_trail.touch_with_version is deprecated, please use
-      my_model.paper_trail.save_with_version, which is slightly different. It's
-      a save, not a touch, so make sure you understand the difference by reading
-      the ActiveRecord documentation for both.
-    STR
-    DPR_WHODUNNIT = <<-STR.squish.freeze
-      my_model_instance.paper_trail.whodunnit('John') is deprecated,
-      please use PaperTrail.request(whodunnit: 'John')
-    STR
-    DPR_WITHOUT_VERSIONING = <<-STR
-      my_model_instance.paper_trail.without_versioning is deprecated, without
-      an exact replacement. To disable versioning for a particular model,
-
-      ```
-      PaperTrail.request.disable_model(Banana)
-      # changes to Banana model do not create versions,
-      # but eg. changes to Kiwi model do.
-      PaperTrail.request.enable_model(Banana)
-      ```
-
-      Or, you may want to disable all models,
-
-      ```
-      PaperTrail.request.enabled = false
-      # no versions created
-      PaperTrail.request.enabled = true
-
-      # or, with a block,
-      PaperTrail.request(enabled: false) do
-        # no versions created
-      end
-      ```
-    STR
-
-    RAILS_GTE_5_1 = ::ActiveRecord.gem_version >= ::Gem::Version.new("5.1.0.beta1")
-
     def initialize(record)
       @record = record
-      @in_after_callback = false
-    end
-
-    def attributes_before_change(is_touch)
-      Hash[@record.attributes.map do |k, v|
-        if @record.class.column_names.include?(k)
-          [k, attribute_in_previous_version(k, is_touch)]
-        else
-          [k, v]
-        end
-      end]
-    end
-
-    def changed_and_not_ignored
-      ignore = @record.paper_trail_options[:ignore].dup
-      # Remove Hash arguments and then evaluate whether the attributes (the
-      # keys of the hash) should also get pushed into the collection.
-      ignore.delete_if do |obj|
-        obj.is_a?(Hash) &&
-          obj.each { |attr, condition|
-            ignore << attr if condition.respond_to?(:call) && condition.call(@record)
-          }
-      end
-      skip = @record.paper_trail_options[:skip]
-      changed_in_latest_version - ignore - skip
     end
 
     # Invoked after rollbacks to ensure versions records are not created for
@@ -83,108 +25,12 @@ module PaperTrail
       @record.send("#{@record.class.version_association_name}=", nil)
     end
 
-    # Determines whether it is appropriate to generate a new version
-    # instance. A timestamp-only update (e.g. only `updated_at` changed) is
-    # considered notable unless an ignored attribute was also changed.
-    def changed_notably?
-      if ignored_attr_has_changed?
-        timestamps = @record.send(:timestamp_attributes_for_update_in_model).map(&:to_s)
-        (notably_changed - timestamps).any?
-      else
-        notably_changed.any?
-      end
-    end
-
-    # @api private
-    def changes
-      notable_changes = changes_in_latest_version.delete_if { |k, _v|
-        !notably_changed.include?(k)
-      }
-      AttributeSerializers::ObjectChangesAttribute.
-        new(@record.class).
-        serialize(notable_changes)
-      notable_changes.to_hash
-    end
-
-    # Is PT enabled for this particular record?
-    # @api private
-    def enabled?
-      PaperTrail.enabled? &&
-        PaperTrail.request.enabled? &&
-        PaperTrail.request.enabled_for_model?(@record.class)
-    end
-
-    # Not sure why, but this method was mentioned in the README in the past,
-    # so we need to deprecate it properly.
-    # @deprecated
-    def enabled_for_model?
-      ::ActiveSupport::Deprecation.warn(
-        "MyModel#paper_trail.enabled_for_model? is deprecated, use " \
-        "PaperTrail.request.enabled_for_model?(MyModel) instead.",
-        caller(1)
-      )
-      PaperTrail.request.enabled_for_model?(@record.class)
-    end
-
-    # An attributed is "ignored" if it is listed in the `:ignore` option
-    # and/or the `:skip` option.  Returns true if an ignored attribute has
-    # changed.
-    def ignored_attr_has_changed?
-      ignored = @record.paper_trail_options[:ignore] + @record.paper_trail_options[:skip]
-      ignored.any? && (changed_in_latest_version & ignored).any?
-    end
-
     # Returns true if this instance is the current, live one;
     # returns false if this instance came from a previous version.
     def live?
       source_version.nil?
     end
 
-    # Updates `data` from the model's `meta` option and from `controller_info`.
-    # Metadata is always recorded; that means all three events (create, update,
-    # destroy) and `update_columns`.
-    # @api private
-    def merge_metadata_into(data)
-      merge_metadata_from_model_into(data)
-      merge_metadata_from_controller_into(data)
-    end
-
-    # Updates `data` from `controller_info`.
-    # @api private
-    def merge_metadata_from_controller_into(data)
-      data.merge(PaperTrail.request.controller_info || {})
-    end
-
-    # Updates `data` from the model's `meta` option.
-    # @api private
-    def merge_metadata_from_model_into(data)
-      @record.paper_trail_options[:meta].each do |k, v|
-        data[k] = model_metadatum(v, data[:event])
-      end
-    end
-
-    # Given a `value` from the model's `meta` option, returns an object to be
-    # persisted. The `value` can be a simple scalar value, but it can also
-    # be a symbol that names a model method, or even a Proc.
-    # @api private
-    def model_metadatum(value, event)
-      if value.respond_to?(:call)
-        value.call(@record)
-      elsif value.is_a?(Symbol) && @record.respond_to?(value, true)
-        # If it is an attribute that is changing in an existing object,
-        # be sure to grab the current version.
-        if event != "create" &&
-            @record.has_attribute?(value) &&
-            attribute_changed_in_latest_version?(value)
-          attribute_in_previous_version(value, false)
-        else
-          @record.send(value)
-        end
-      else
-        value
-      end
-    end
-
     # Returns the object (not a Version) as it became next.
     # NOTE: if self (the item) was not reified from a version, i.e. it is the
     #  "live" item, we return nil.  Perhaps we should return self instead?
@@ -195,30 +41,6 @@ module PaperTrail
       nil
     end
 
-    def notably_changed
-      only = @record.paper_trail_options[:only].dup
-      # Remove Hash arguments and then evaluate whether the attributes (the
-      # keys of the hash) should also get pushed into the collection.
-      only.delete_if do |obj|
-        obj.is_a?(Hash) &&
-          obj.each { |attr, condition|
-            only << attr if condition.respond_to?(:call) && condition.call(@record)
-          }
-      end
-      only.empty? ? changed_and_not_ignored : (changed_and_not_ignored & only)
-    end
-
-    # Returns hash of attributes (with appropriate attributes serialized),
-    # omitting attributes to be skipped.
-    #
-    # @api private
-    def object_attrs_for_paper_trail(is_touch)
-      attrs = attributes_before_change(is_touch).
-        except(*@record.paper_trail_options[:skip])
-      AttributeSerializers::ObjectAttribute.new(@record.class).serialize(attrs)
-      attrs
-    end
-
     # Returns who put `@record` into its current state.
     #
     # @api public
@@ -234,28 +56,15 @@ module PaperTrail
     end
 
     def record_create
-      @in_after_callback = true
       return unless enabled?
-      versions_assoc = @record.send(@record.class.versions_association_name)
-      versions_assoc.create! data_for_create
-    ensure
-      @in_after_callback = false
-    end
 
-    # Returns data for record create
-    # @api private
-    def data_for_create
-      data = {
-        event: @record.paper_trail_event || "create",
-        whodunnit: PaperTrail.request.whodunnit
-      }
-      if @record.respond_to?(:updated_at)
-        data[:created_at] = @record.updated_at
-      end
-      if record_object_changes? && changed_notably?
-        data[:object_changes] = recordable_object_changes(changes)
+      build_version_on_create(in_after_callback: true).tap do |version|
+        version.save!
+        # Because the version object was created using version_class.new instead
+        # of versions_assoc.build?, the association cache is unaware. So, we
+        # invalidate the `versions` association cache with `reset`.
+        versions.reset
       end
-      merge_metadata_into(data)
     end
 
     # `recording_order` is "after" or "before". See ModelConfig#on_destroy.
@@ -264,138 +73,49 @@ module PaperTrail
     # @return - The created version object, so that plugins can use it, e.g.
     # paper_trail-association_tracking
     def record_destroy(recording_order)
-      @in_after_callback = recording_order == "after"
-      if enabled? && !@record.new_record?
-        version = @record.class.paper_trail.version_class.create(data_for_destroy)
-        if version.errors.any?
-          log_version_errors(version, :destroy)
-        else
-          @record.send("#{@record.class.version_association_name}=", version)
-          @record.send(@record.class.versions_association_name).reset
-          version
-        end
-      end
-    ensure
-      @in_after_callback = false
-    end
+      return unless enabled? && !@record.new_record?
+      in_after_callback = recording_order == "after"
+      event = Events::Destroy.new(@record, in_after_callback)
 
-    # Returns data for record destroy
-    # @api private
-    def data_for_destroy
-      data = {
-        item_id: @record.id,
-        item_type: @record.class.base_class.name,
-        event: @record.paper_trail_event || "destroy",
-        object: recordable_object(false),
-        whodunnit: PaperTrail.request.whodunnit
-      }
-      merge_metadata_into(data)
-    end
-
-    # Returns a boolean indicating whether to store serialized version diffs
-    # in the `object_changes` column of the version record.
-    # @api private
-    def record_object_changes?
-      @record.paper_trail_options[:save_changes] &&
-        @record.class.paper_trail.version_class.column_names.include?("object_changes")
-    end
+      # Merge data from `Event` with data from PT-AT. We no longer use
+      # `data_for_destroy` but PT-AT still does.
+      data = event.data.merge(data_for_destroy)
 
-    # @api private
-    # @return - The created version object, so that plugins can use it, e.g.
-    # paper_trail-association_tracking
-    def record_update(force:, in_after_callback:, is_touch:)
-      @in_after_callback = in_after_callback
-      if enabled? && (force || changed_notably?)
-        versions_assoc = @record.send(@record.class.versions_association_name)
-        version = versions_assoc.create(data_for_update(is_touch))
-        if version.errors.any?
-          log_version_errors(version, :update)
-        else
-          version
-        end
-      end
-    ensure
-      @in_after_callback = false
-    end
-
-    # Used during `record_update`, returns a hash of data suitable for an AR
-    # `create`. That is, all the attributes of the nascent `Version` record.
-    #
-    # @api private
-    def data_for_update(is_touch)
-      data = {
-        event: @record.paper_trail_event || "update",
-        object: recordable_object(is_touch),
-        whodunnit: PaperTrail.request.whodunnit
-      }
-      if @record.respond_to?(:updated_at)
-        data[:created_at] = @record.updated_at
-      end
-      if record_object_changes?
-        data[:object_changes] = recordable_object_changes(changes)
-      end
-      merge_metadata_into(data)
-    end
-
-    # @api private
-    # @return - The created version object, so that plugins can use it, e.g.
-    # paper_trail-association_tracking
-    def record_update_columns(changes)
-      return unless enabled?
-      versions_assoc = @record.send(@record.class.versions_association_name)
-      version = versions_assoc.create(data_for_update_columns(changes))
+      version = @record.class.paper_trail.version_class.create(data)
       if version.errors.any?
-        log_version_errors(version, :update)
+        log_version_errors(version, :destroy)
       else
+        assign_and_reset_version_association(version)
         version
       end
     end
 
-    # Returns data for record_update_columns
-    # @api private
-    def data_for_update_columns(changes)
-      data = {
-        event: @record.paper_trail_event || "update",
-        object: recordable_object(false),
-        whodunnit: PaperTrail.request.whodunnit
-      }
-      if record_object_changes?
-        data[:object_changes] = recordable_object_changes(changes)
-      end
-      merge_metadata_into(data)
-    end
-
-    # Returns an object which can be assigned to the `object` attribute of a
-    # nascent version record. If the `object` column is a postgres `json`
-    # column, then a hash can be used in the assignment, otherwise the column
-    # is a `text` column, and we must perform the serialization here, using
-    # `PaperTrail.serializer`.
-    #
     # @api private
-    def recordable_object(is_touch)
-      if @record.class.paper_trail.version_class.object_col_is_json?
-        object_attrs_for_paper_trail(is_touch)
-      else
-        PaperTrail.serializer.dump(object_attrs_for_paper_trail(is_touch))
-      end
-    end
+    # @param force [boolean] Insert a `Version` even if `@record` has not
+    #   `changed_notably?`.
+    # @param in_after_callback [boolean] True when called from an `after_update`
+    #   or `after_touch` callback.
+    # @param is_touch [boolean] True when called from an `after_touch` callback.
+    # @return - The created version object, so that plugins can use it, e.g.
+    # paper_trail-association_tracking
+    def record_update(force:, in_after_callback:, is_touch:)
+      return unless enabled?
 
-    # Returns an object which can be assigned to the `object_changes`
-    # attribute of a nascent version record. If the `object_changes` column is
-    # a postgres `json` column, then a hash can be used in the assignment,
-    # otherwise the column is a `text` column, and we must perform the
-    # serialization here, using `PaperTrail.serializer`.
-    #
-    # @api private
-    def recordable_object_changes(changes)
-      if PaperTrail.config.object_changes_adapter
-        changes = PaperTrail.config.object_changes_adapter.diff(changes)
-      end
+      version = build_version_on_update(
+        force: force,
+        in_after_callback: in_after_callback,
+        is_touch: is_touch
+      )
+      return unless version
 
-      if @record.class.paper_trail.version_class.object_changes_col_is_json?
-        changes
+      if version.save
+        # Because the version object was created using version_class.new instead
+        # of versions_assoc.build?, the association cache is unaware. So, we
+        # invalidate the `versions` association cache with `reset`.
+        versions.reset
+        version
       else
-        PaperTrail.serializer.dump(changes)
+        log_version_errors(version, :update)
       end
     end
 
@@ -420,56 +140,20 @@ module PaperTrail
       version
     end
 
-    # Mimics the `touch` method from `ActiveRecord::Persistence` (without
-    # actually calling `touch`), but also creates a version.
-    #
-    # A version is created regardless of options such as `:on`, `:if`, or
-    # `:unless`.
-    #
-    # This is an "update" event. That is, we record the same data we would in
-    # the case of a normal AR `update`.
-    #
-    # Some advanced PT users disable all callbacks (eg. `has_paper_trail(on:
-    # [])`) and use only this method, giving them complete control over when
-    # version records are inserted. It's unclear under which specific
-    # circumstances this technique should be adopted.
-    #
-    # @deprecated
-    def touch_with_version(name = nil)
-      ::ActiveSupport::Deprecation.warn(DPR_TOUCH_WITH_VERSION, caller(1))
-      unless @record.persisted?
-        raise ::ActiveRecord::ActiveRecordError, "can not touch on a new record object"
-      end
-      attributes = @record.send :timestamp_attributes_for_update_in_model
-      attributes << name if name
-      current_time = @record.send :current_time_from_proper_timezone
-      attributes.each { |column|
-        @record.send(:write_attribute, column, current_time)
-      }
-      ::PaperTrail.request(enabled: false) do
-        @record.save!(validate: false)
-      end
-      record_update(force: true, in_after_callback: false, is_touch: false)
-    end
-
     # Save, and create a version record regardless of options such as `:on`,
     # `:if`, or `:unless`.
     #
-    # Arguments are passed to `save`.
+    # `in_after_callback`: Indicates if this method is being called within an
+    #                      `after` callback. Defaults to `false`.
+    # `options`: Optional arguments passed to `save`.
     #
     # This is an "update" event. That is, we record the same data we would in
     # the case of a normal AR `update`.
-    #
-    # In older versions of PaperTrail, a method named `touch_with_version` was
-    # used for this purpose. `save_with_version` is not exactly the same.
-    # First, the arguments are different. It passes all arguments to `save`.
-    # Second, it doesn't set any timestamp attributes prior to the `save` the
-    # way `touch_with_version` did.
-    def save_with_version(*args)
+    def save_with_version(in_after_callback: false, **options)
       ::PaperTrail.request(enabled: false) do
-        @record.save(*args)
+        @record.save(**options)
       end
-      record_update(force: true, in_after_callback: false, is_touch: false)
+      record_update(force: true, in_after_callback: in_after_callback, is_touch: false)
     end
 
     # Like the `update_column` method from `ActiveRecord::Persistence`, but also
@@ -483,9 +167,10 @@ module PaperTrail
     # creates a version to record those changes.
     # @api public
     def update_columns(attributes)
-      # `@record.update_columns` skips dirty tracking, so we can't just use `@record.changes` or
-      # @record.saved_changes` from `ActiveModel::Dirty`. We need to build our own hash with the
-      # changes that will be made directly to the database.
+      # `@record.update_columns` skips dirty-tracking, so we can't just use
+      # `@record.changes` or @record.saved_changes` from `ActiveModel::Dirty`.
+      # We need to build our own hash with the changes that will be made
+      # directly to the database.
       changes = {}
       attributes.each do |k, v|
         changes[k] = [@record[k], v]
@@ -509,101 +194,117 @@ module PaperTrail
       versions.collect { |version| version_at(version.created_at) }
     end
 
-    # Executes the given method or block without creating a new version.
-    # @deprecated
-    def without_versioning(method = nil)
-      ::ActiveSupport::Deprecation.warn(DPR_WITHOUT_VERSIONING, caller(1))
-      paper_trail_was_enabled = PaperTrail.request.enabled_for_model?(@record.class)
-      PaperTrail.request.disable_model(@record.class)
-      if method
-        if respond_to?(method)
-          public_send(method)
-        else
-          @record.send(method)
-        end
-      else
-        yield @record
-      end
-    ensure
-      PaperTrail.request.enable_model(@record.class) if paper_trail_was_enabled
-    end
+    private
 
-    # @deprecated
-    def whodunnit(value)
-      raise ArgumentError, "expected to receive a block" unless block_given?
-      ::ActiveSupport::Deprecation.warn(DPR_WHODUNNIT, caller(1))
-      ::PaperTrail.request(whodunnit: value) do
-        yield @record
-      end
+    # @api private
+    def assign_and_reset_version_association(version)
+      @record.send("#{@record.class.version_association_name}=", version)
+      @record.send(@record.class.versions_association_name).reset
     end
 
-    private
+    # @api private
+    def build_version_on_create(in_after_callback:)
+      event = Events::Create.new(@record, in_after_callback)
+
+      # Merge data from `Event` with data from PT-AT. We no longer use
+      # `data_for_create` but PT-AT still does.
+      data = event.data.merge!(data_for_create)
+
+      # Pure `version_class.new` reduces memory usage compared to `versions_assoc.build`
+      @record.class.paper_trail.version_class.new(data)
+    end
 
-    # Rails 5.1 changed the API of `ActiveRecord::Dirty`. See
-    # https://github.com/paper-trail-gem/paper_trail/pull/899
-    #
     # @api private
-    def attribute_changed_in_latest_version?(attr_name)
-      if @in_after_callback && RAILS_GTE_5_1
-        @record.saved_change_to_attribute?(attr_name.to_s)
-      else
-        @record.attribute_changed?(attr_name.to_s)
+    def build_version_on_update(force:, in_after_callback:, is_touch:)
+      event = Events::Update.new(@record, in_after_callback, is_touch, nil)
+      return unless force || event.changed_notably?
+      data = event.data
+
+      # Copy the (recently set) `updated_at` from the record to the `created_at`
+      # of the `Version`. Without this feature, these two timestamps would
+      # differ by a few milliseconds. To some people, it seems a little
+      # unnatural to tamper with creation timestamps in this way. But, this
+      # feature has existed for a long time, almost a decade now, and some users
+      # may rely on it now.
+      if @record.respond_to?(:updated_at)
+        data[:created_at] = @record.updated_at
       end
+
+      # Merge data from `Event` with data from PT-AT. We no longer use
+      # `data_for_update` but PT-AT still does. To save memory, we use `merge!`
+      # instead of `merge`.
+      data.merge!(data_for_update)
+
+      # Using `version_class.new` reduces memory usage compared to
+      # `versions_assoc.build`. It's a trade-off though. We have to clear
+      # the association cache (see `versions.reset`) and that could cause an
+      # additional query in certain applications.
+      @record.class.paper_trail.version_class.new(data)
     end
 
-    # Rails 5.1 changed the API of `ActiveRecord::Dirty`. See
-    # https://github.com/paper-trail-gem/paper_trail/pull/899
+    # PT-AT extends this method to add its transaction id.
     #
-    # Event can be any of the three (create, update, destroy).
+    # @api public
+    def data_for_create
+      {}
+    end
+
+    # PT-AT extends this method to add its transaction id.
     #
-    # @api private
-    def attribute_in_previous_version(attr_name, is_touch)
-      if RAILS_GTE_5_1
-        if @in_after_callback && !is_touch
-          # For most events, we want the original value of the attribute, before
-          # the last save.
-          @record.attribute_before_last_save(attr_name.to_s)
-        else
-          # We are either performing a `record_destroy` or a
-          # `record_update(is_touch: true)`.
-          @record.attribute_in_database(attr_name.to_s)
-        end
-      else
-        @record.attribute_was(attr_name.to_s)
-      end
+    # @api public
+    def data_for_destroy
+      {}
     end
 
-    # Rails 5.1 changed the API of `ActiveRecord::Dirty`. See
-    # https://github.com/paper-trail-gem/paper_trail/pull/899
+    # PT-AT extends this method to add its transaction id.
     #
-    # @api private
-    def changed_in_latest_version
-      if @in_after_callback && RAILS_GTE_5_1
-        @record.saved_changes.keys
-      else
-        @record.changed
-      end
+    # @api public
+    def data_for_update
+      {}
     end
 
-    # Rails 5.1 changed the API of `ActiveRecord::Dirty`. See
-    # https://github.com/paper-trail-gem/paper_trail/pull/899
+    # PT-AT extends this method to add its transaction id.
     #
+    # @api public
+    def data_for_update_columns
+      {}
+    end
+
+    # Is PT enabled for this particular record?
     # @api private
-    def changes_in_latest_version
-      if @in_after_callback && RAILS_GTE_5_1
-        @record.saved_changes
-      else
-        @record.changes
-      end
+    def enabled?
+      PaperTrail.enabled? &&
+        PaperTrail.request.enabled? &&
+        PaperTrail.request.enabled_for_model?(@record.class)
     end
 
     def log_version_errors(version, action)
       version.logger&.warn(
         "Unable to create version for #{action} of #{@record.class.name}" \
-          "##{@record.id}: " + version.errors.full_messages.join(", ")
+        "##{@record.id}: " + version.errors.full_messages.join(", ")
       )
     end
 
+    # @api private
+    # @return - The created version object, so that plugins can use it, e.g.
+    # paper_trail-association_tracking
+    def record_update_columns(changes)
+      return unless enabled?
+      data = Events::Update.new(@record, false, false, changes).data
+
+      # Merge data from `Event` with data from PT-AT. We no longer use
+      # `data_for_update_columns` but PT-AT still does.
+      data.merge!(data_for_update_columns)
+
+      versions_assoc = @record.send(@record.class.versions_association_name)
+      version = versions_assoc.create(data)
+      if version.errors.any?
+        log_version_errors(version, :update)
+      else
+        version
+      end
+    end
+
     def version
       @record.public_send(@record.class.version_association_name)
     end