paper_trail 9.1.1 → 9.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aff3701e63c6bfcf374c2a62f04f60e2067f2cf4a5cd6fc0000dc2c62f16ba09
-  data.tar.gz: 0d93bec07cca4894a0336e7e8c05877f8fcd9a27e363052da47aa4617850e392
+  metadata.gz: a2e53b5f5457783341505d9c0341c5fdc93c52191644db689260311c6c63de72
+  data.tar.gz: bd94edaeb1bd3ca9d329b925241c1fe8774e7f058e64f82e06411e04397833ae
 SHA512:
-  metadata.gz: 037ae894bcfb07a7221832497b7d457d2c827c1dcca7a03ac5469a22fbb8a854b5a0e3062e9b0f304976538b0504f10951dcbbdf7fdc7da868f12543ad3b07d8
-  data.tar.gz: acdd0a1482780e1c680a886666b74d1444f788ac707b63ea5d9f91afa59b9f3faf1fb1fc829a599ed9100b7ac4b8bc96eb143d43b9d323e9674e0a3cf9d68952
+  metadata.gz: 63d9377e20237a70d024e857f64dcd089126efc5bbce13f4dffc65a1c9f4d8210426269bfb60af9bdcdaa7d23211c2359d3a8676ceaa3346b0d0e414cd813ffd
+  data.tar.gz: 952ea2469901473c0fe66b5b5e6aaaf65070957c0211147c60372c5a172029415aea87c93c6daac2c00243a087aa4135ca304b0ac69ad0f32a1a4fb940543e50

data/lib/generators/paper_trail/install_generator.rb

@@ -23,12 +23,6 @@ module PaperTrail
       default: false,
       desc: "Store changeset (diff) with each version"
     )
-    class_option(
-      :with_associations,
-      type: :boolean,
-      default: false,
-      desc: "Store transactional IDs to support association restoration"
-    )
 
     desc "Generates (but does not run) a migration to add a versions table." \
          "  Also generates an initializer file for configuring PaperTrail"
@@ -36,18 +30,6 @@ module PaperTrail
     def create_migration_file
       add_paper_trail_migration("create_versions")
       add_paper_trail_migration("add_object_changes_to_versions") if options.with_changes?
-      if options.with_associations?
-        add_paper_trail_migration("create_version_associations")
-        add_paper_trail_migration("add_transaction_id_column_to_versions")
-      end
-    end
-
-    def create_initializer
-      create_file(
-        "config/initializers/paper_trail.rb",
-        "PaperTrail.config.track_associations = #{!!options.with_associations?}\n",
-        "PaperTrail.config.association_reify_error_behaviour = :error"
-      )
     end
 
     def self.next_migration_number(dirname)

data/lib/paper_trail.rb

@@ -21,7 +21,6 @@ require "paper_trail/has_paper_trail"
 require "paper_trail/record_history"
 require "paper_trail/reifier"
 require "paper_trail/request"
-require "paper_trail/version_association_concern"
 require "paper_trail/version_concern"
 require "paper_trail/version_number"
 require "paper_trail/serializers/json"
@@ -45,16 +44,6 @@ module PaperTrail
   extend PaperTrail::Cleaner
 
   class << self
-    # @api private
-    def clear_transaction_id
-      ::ActiveSupport::Deprecation.warn(
-        "PaperTrail.clear_transaction_id is deprecated, " \
-        "use PaperTrail.request.clear_transaction_id",
-        caller(1)
-      )
-      request.clear_transaction_id
-    end
-
     # Switches PaperTrail on or off, for all threads.
     # @api public
     def enabled=(value)
@@ -207,29 +196,6 @@ module PaperTrail
       PaperTrail.config.serializer
     end
 
-    # @api public
-    def transaction?
-      ::ActiveRecord::Base.connection.open_transactions.positive?
-    end
-
-    # @deprecated
-    def transaction_id
-      ::ActiveSupport::Deprecation.warn(
-        "PaperTrail.transaction_id is deprecated without replacement.",
-        caller(1)
-      )
-      request.transaction_id
-    end
-
-    # @deprecated
-    def transaction_id=(id)
-      ::ActiveSupport::Deprecation.warn(
-        "PaperTrail.transaction_id= is deprecated without replacement.",
-        caller(1)
-      )
-      request.transaction_id = id
-    end
-
     # Returns PaperTrail's global configuration object, a singleton. These
     # settings affect all threads.
     # @api private
@@ -262,3 +228,7 @@ if defined?(::Rails)
 else
   require "paper_trail/frameworks/active_record"
 end
+
+# https://github.com/paper-trail-gem/paper_trail/issues/1070
+# https://github.com/westonganger/paper_trail-association_tracking/issues/2
+require "paper_trail-association_tracking"

data/lib/paper_trail/config.rb

@@ -7,26 +7,9 @@ module PaperTrail
   # Global configuration affecting all threads. Some thread-specific
   # configuration can be found in `paper_trail.rb`, others in `controller.rb`.
   class Config
-    DPR_TRACK_ASSOC = <<~STR
-      Association tracking is an endangered feature. For the past three or four
-      years it has been an experimental feature, not recommended for production.
-      It has a long list of known issues
-      (https://github.com/paper-trail-gem/paper_trail#4b1-known-issues) and has no
-      regular volunteers caring for it.
-
-      If you don't use this feature, I strongly recommend disabling it.
-
-      If you do use this feature, please head over to
-      https://github.com/paper-trail-gem/paper_trail/issues/1070 and volunteer to work
-      on the known issues.
-
-      If we can't make a serious dent in the list of known issues over the next
-      few years, then I'm inclined to delete it, though that would make me sad
-      because I've put dozens of hours into it, and I know others have too.
-    STR
-
     include Singleton
-    attr_accessor :serializer, :version_limit, :association_reify_error_behaviour
+    attr_accessor :serializer, :version_limit, :association_reify_error_behaviour,
+      :object_changes_adapter
 
     def initialize
       # Variables which affect all threads, whose access is synchronized.
@@ -37,30 +20,6 @@ module PaperTrail
       @serializer = PaperTrail::Serializers::YAML
     end
 
-    def track_associations=(value)
-      @track_associations = !!value
-      if @track_associations
-        ::ActiveSupport::Deprecation.warn(DPR_TRACK_ASSOC, caller(1))
-      end
-    end
-
-    # As of PaperTrail 5, `track_associations?` defaults to false. Tracking
-    # associations is an experimental feature so we recommend setting
-    # PaperTrail.config.track_associations = false in your
-    # config/initializers/paper_trail.rb
-    #
-    # In PT 4, we checked `PaperTrail::VersionAssociation.table_exists?`
-    # here, but that proved to be problematic in situations when the database
-    # connection had not been established, or when the database does not exist
-    # yet (as with `rake db:create`).
-    def track_associations?
-      if @track_associations.nil?
-        false
-      else
-        @track_associations
-      end
-    end
-
     # Indicates whether PaperTrail is on or off. Default: true.
     def enabled
       @mutex.synchronize { !!@enabled }

data/lib/paper_trail/frameworks/active_record.rb

@@ -2,5 +2,4 @@
 
 # This file only needs to be loaded if the gem is being used outside of Rails,
 # since otherwise the model(s) will get loaded in via the `Rails::Engine`.
-require "paper_trail/frameworks/active_record/models/paper_trail/version_association"
 require "paper_trail/frameworks/active_record/models/paper_trail/version"

data/lib/paper_trail/frameworks/active_record/models/paper_trail/version.rb

@@ -4,9 +4,12 @@ require "paper_trail/version_concern"
 
 module PaperTrail
   # This is the default ActiveRecord model provided by PaperTrail. Most simple
-  # applications will only use this and its partner, `VersionAssociation`, but
-  # it is possible to sub-class, extend, or even do without this model entirely.
-  # See the readme for details.
+  # applications will use this model as-is, but it is possible to sub-class,
+  # extend, or even do without this model entirely. See documentation section
+  # 6.a. Custom Version Classes.
+  #
+  # The paper_trail-association_tracking gem provides a related model,
+  # `VersionAssociation`.
   class Version < ::ActiveRecord::Base
     include PaperTrail::VersionConcern
   end

data/lib/paper_trail/model_config.rb

@@ -141,9 +141,8 @@ module PaperTrail
       @model_class.send :include, ::PaperTrail::Model::InstanceMethods
       setup_options(options)
       setup_associations(options)
-      setup_transaction_callbacks
+      @model_class.after_rollback { paper_trail.clear_rolled_back_versions }
       setup_callbacks_from_options options[:on]
-      setup_callbacks_for_habtm options[:join_tables]
     end
 
     def version_class
@@ -169,11 +168,6 @@ module PaperTrail
         ::ActiveRecord::Base.belongs_to_required_by_default
     end
 
-    def habtm_assocs_not_skipped
-      @model_class.reflect_on_all_associations(:has_and_belongs_to_many).
-        reject { |a| @model_class.paper_trail_options[:skip].include?(a.name.to_s) }
-    end
-
     def setup_associations(options)
       @model_class.class_attribute :version_association_name
       @model_class.version_association_name = options[:version] || :version
@@ -199,33 +193,12 @@ module PaperTrail
       )
     end
 
-    # Adds callbacks to record changes to habtm associations such that on save
-    # the previous version of the association (if changed) can be reconstructed.
-    def setup_callbacks_for_habtm(join_tables)
-      @model_class.send :attr_accessor, :paper_trail_habtm
-      @model_class.class_attribute :paper_trail_save_join_tables
-      @model_class.paper_trail_save_join_tables = Array.wrap(join_tables)
-      habtm_assocs_not_skipped.each(&method(:setup_habtm_change_callbacks))
-    end
-
     def setup_callbacks_from_options(options_on = [])
       options_on.each do |event|
         public_send("on_#{event}")
       end
     end
 
-    def setup_habtm_change_callbacks(assoc)
-      assoc_name = assoc.name
-      %w[add remove].each do |verb|
-        @model_class.send(:"before_#{verb}_for_#{assoc_name}").send(
-          :<<,
-          lambda do |*args|
-            update_habtm_state(assoc_name, :"before_#{verb}", args[-2], args.last)
-          end
-        )
-      end
-    end
-
     def setup_options(options)
       @model_class.class_attribute :paper_trail_options
       @model_class.paper_trail_options = options.dup
@@ -242,29 +215,5 @@ module PaperTrail
         @model_class.paper_trail_options[:save_changes] = true
       end
     end
-
-    # Reset the transaction id when the transaction is closed.
-    def setup_transaction_callbacks
-      @model_class.after_commit { PaperTrail.request.clear_transaction_id }
-      @model_class.after_rollback { PaperTrail.request.clear_transaction_id }
-      @model_class.after_rollback { paper_trail.clear_rolled_back_versions }
-    end
-
-    def update_habtm_state(name, callback, model, assoc)
-      model.paper_trail_habtm ||= {}
-      model.paper_trail_habtm[name] ||= { removed: [], added: [] }
-      state = model.paper_trail_habtm[name]
-      assoc_id = assoc.id
-      case callback
-      when :before_add
-        state[:added] |= [assoc_id]
-        state[:removed] -= [assoc_id]
-      when :before_remove
-        state[:removed] |= [assoc_id]
-        state[:added] -= [assoc_id]
-      else
-        raise "Invalid callback: #{callback}"
-      end
-    end
   end
 end

data/lib/paper_trail/queries/versions/where_object_changes.rb

@@ -23,6 +23,11 @@ module PaperTrail
 
         # @api private
         def execute
+          if PaperTrail.config.object_changes_adapter
+            return PaperTrail.config.object_changes_adapter.where_object_changes(
+              @version_model_class, @attributes
+            )
+          end
           case @version_model_class.columns_hash["object_changes"].type
           when :jsonb
             jsonb

data/lib/paper_trail/record_trail.rb

@@ -45,34 +45,6 @@ module PaperTrail
       @in_after_callback = false
     end
 
-    # Utility method for reifying. Anything executed inside the block will
-    # appear like a new record.
-    #
-    # > .. as best as I can tell, the purpose of
-    # > appear_as_new_record was to attempt to prevent the callbacks in
-    # > AutosaveAssociation (which is the module responsible for persisting
-    # > foreign key changes earlier than most people want most of the time
-    # > because backwards compatibility or the maintainer hates himself or
-    # > something) from running. By also stubbing out persisted? we can
-    # > actually prevent those. A more stable option might be to use suppress
-    # > instead, similar to the other branch in reify_has_one.
-    # > -Sean Griffin (https://github.com/paper-trail-gem/paper_trail/pull/899)
-    #
-    # @api private
-    def appear_as_new_record
-      @record.instance_eval {
-        alias :old_new_record? :new_record?
-        alias :new_record? :present?
-        alias :old_persisted? :persisted?
-        alias :persisted? :nil?
-      }
-      yield
-      @record.instance_eval {
-        alias :new_record? :old_new_record?
-        alias :persisted? :old_persisted?
-      }
-    end
-
     def attributes_before_change(is_touch)
       Hash[@record.attributes.map do |k, v|
         if @record.class.column_names.include?(k)
@@ -265,9 +237,7 @@ module PaperTrail
       @in_after_callback = true
       return unless enabled?
       versions_assoc = @record.send(@record.class.versions_association_name)
-      version = versions_assoc.create! data_for_create
-      update_transaction_id(version)
-      save_associations(version)
+      versions_assoc.create! data_for_create
     ensure
       @in_after_callback = false
     end
@@ -285,13 +255,14 @@ module PaperTrail
       if record_object_changes? && changed_notably?
         data[:object_changes] = recordable_object_changes(changes)
       end
-      add_transaction_id_to(data)
       merge_metadata_into(data)
     end
 
     # `recording_order` is "after" or "before". See ModelConfig#on_destroy.
     #
     # @api private
+    # @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?
@@ -301,8 +272,7 @@ module PaperTrail
         else
           @record.send("#{@record.class.version_association_name}=", version)
           @record.send(@record.class.versions_association_name).reset
-          update_transaction_id(version)
-          save_associations(version)
+          version
         end
       end
     ensure
@@ -319,7 +289,6 @@ module PaperTrail
         object: recordable_object(false),
         whodunnit: PaperTrail.request.whodunnit
       }
-      add_transaction_id_to(data)
       merge_metadata_into(data)
     end
 
@@ -331,6 +300,9 @@ module PaperTrail
         @record.class.paper_trail.version_class.column_names.include?("object_changes")
     end
 
+    # @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?)
@@ -339,8 +311,7 @@ module PaperTrail
         if version.errors.any?
           log_version_errors(version, :update)
         else
-          update_transaction_id(version)
-          save_associations(version)
+          version
         end
       end
     ensure
@@ -363,11 +334,12 @@ module PaperTrail
       if record_object_changes?
         data[:object_changes] = recordable_object_changes(changes)
       end
-      add_transaction_id_to(data)
       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)
@@ -375,8 +347,7 @@ module PaperTrail
       if version.errors.any?
         log_version_errors(version, :update)
       else
-        update_transaction_id(version)
-        save_associations(version)
+        version
       end
     end
 
@@ -391,7 +362,6 @@ module PaperTrail
       if record_object_changes?
         data[:object_changes] = recordable_object_changes(changes)
       end
-      add_transaction_id_to(data)
       merge_metadata_into(data)
     end
 
@@ -418,6 +388,10 @@ module PaperTrail
     #
     # @api private
     def recordable_object_changes(changes)
+      if PaperTrail.config.object_changes_adapter
+        changes = PaperTrail.config.object_changes_adapter.diff(changes)
+      end
+
       if @record.class.paper_trail.version_class.object_changes_col_is_json?
         changes
       else
@@ -434,39 +408,6 @@ module PaperTrail
       end
     end
 
-    # Saves associations if the join table for `VersionAssociation` exists.
-    def save_associations(version)
-      return unless PaperTrail.config.track_associations?
-      save_bt_associations(version)
-      save_habtm_associations(version)
-    end
-
-    # Save all `belongs_to` associations.
-    # @api private
-    def save_bt_associations(version)
-      @record.class.reflect_on_all_associations(:belongs_to).each do |assoc|
-        save_bt_association(assoc, version)
-      end
-    end
-
-    # When a record is created, updated, or destroyed, we determine what the
-    # HABTM associations looked like before any changes were made, by using
-    # the `paper_trail_habtm` data structure. Then, we create
-    # `VersionAssociation` records for each of the associated records.
-    # @api private
-    def save_habtm_associations(version)
-      @record.class.reflect_on_all_associations(:has_and_belongs_to_many).each do |a|
-        next unless save_habtm_association?(a)
-        habtm_assoc_ids(a).each do |id|
-          PaperTrail::VersionAssociation.create(
-            version_id: version.transaction_id,
-            foreign_key_name: a.name,
-            foreign_key_id: id
-          )
-        end
-      end
-    end
-
     # AR callback.
     # @api private
     def save_version?
@@ -598,11 +539,6 @@ module PaperTrail
 
     private
 
-    def add_transaction_id_to(data)
-      return unless @record.class.paper_trail.version_class.column_names.include?("transaction_id")
-      data[:transaction_id] = PaperTrail.request.transaction_id
-    end
-
     # Rails 5.1 changed the API of `ActiveRecord::Dirty`. See
     # https://github.com/paper-trail-gem/paper_trail/pull/899
     #
@@ -661,16 +597,6 @@ module PaperTrail
       end
     end
 
-    # Given a HABTM association, returns an array of ids.
-    #
-    # @api private
-    def habtm_assoc_ids(habtm_assoc)
-      current = @record.send(habtm_assoc.name).to_a.map(&:id) # TODO: `pluck` would use less memory
-      removed = @record.paper_trail_habtm.try(:[], habtm_assoc.name).try(:[], :removed) || []
-      added = @record.paper_trail_habtm.try(:[], habtm_assoc.name).try(:[], :added) || []
-      current + removed - added
-    end
-
     def log_version_errors(version, action)
       version.logger&.warn(
         "Unable to create version for #{action} of #{@record.class.name}" \
@@ -678,44 +604,6 @@ module PaperTrail
       )
     end
 
-    # Save a single `belongs_to` association.
-    # @api private
-    def save_bt_association(assoc, version)
-      assoc_version_args = {
-        version_id: version.id,
-        foreign_key_name: assoc.foreign_key
-      }
-
-      if assoc.options[:polymorphic]
-        associated_record = @record.send(assoc.name) if @record.send(assoc.foreign_type)
-        if associated_record && PaperTrail.request.enabled_for_model?(associated_record.class)
-          assoc_version_args[:foreign_key_id] = associated_record.id
-        end
-      elsif PaperTrail.request.enabled_for_model?(assoc.klass)
-        assoc_version_args[:foreign_key_id] = @record.send(assoc.foreign_key)
-      end
-
-      if assoc_version_args.key?(:foreign_key_id)
-        PaperTrail::VersionAssociation.create(assoc_version_args)
-      end
-    end
-
-    # Returns true if the given HABTM association should be saved.
-    # @api private
-    def save_habtm_association?(assoc)
-      @record.class.paper_trail_save_join_tables.include?(assoc.name) ||
-        PaperTrail.request.enabled_for_model?(assoc.klass)
-    end
-
-    def update_transaction_id(version)
-      return unless @record.class.paper_trail.version_class.column_names.include?("transaction_id")
-      if PaperTrail.transaction? && PaperTrail.request.transaction_id.nil?
-        PaperTrail.request.transaction_id = version.id
-        version.transaction_id = version.id
-        version.save
-      end
-    end
-
     def version
       @record.public_send(@record.class.version_association_name)
     end