paper_trail 14.0.0 → 17.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8442e35802b28551f1ab7275a3e6a14fed55edcba6c1aa9beeff5e65a2a92626
-  data.tar.gz: 3014b42bde912764165fc14a8974b14cc16cdf9643a1f8c9af23083a4479c50d
+  metadata.gz: ce4b87054886d17b9dea51dfcf6e9ddc948eaf331417b8dc5b992793e177a670
+  data.tar.gz: 32f2ff0f24978fe54e08a65dfe8c83ec023eaaf9ab676c0f791b398907a8fc80
 SHA512:
-  metadata.gz: 57f5248c0e5d448dd20e88530f06e74fddcf641c1f13f6b9d7e33ef54305168e5f0bb34322c4db7b0b9b5fe9c7c988116a72b17605500061c43ffc67f0519f9d
-  data.tar.gz: 6d84306539336b774e8b9cd5f1f2412fa59752c6ceb3033af6be9652045e19d5e11f95555f47cdde3742bf18e6165addcde3e3d5a5b2c7b8df7ecc908b16d6eb
+  metadata.gz: 772518531867cafb80017ebbb42837412fc67b80ec9416cfc9269595084e266f312609115171868b4124747769f1aba03fd5ee1b932691b52128aaec6fa2c583
+  data.tar.gz: 3b28ed9bbbf1fef2eac6d106c5fedcb1566b88d7877782e115130f4f8386f5e6bf60f4123edc1518e41478b918fac9c371c98fea5e0b49745fcd384cffa85baa

data/lib/generators/paper_trail/install/USAGE

@@ -1,3 +1,31 @@
 Description:
   Generates (but does not run) a migration to add a versions table. Also generates an initializer
-  file for configuring PaperTrail. See section 5.c. Generators in README.md for more information.
+  file for configuring PaperTrail. Can be customized by providing a Version class name.
+  See section 5.c. Generators in README.md for more information.
+
+Examples:
+  rails generate paper_trail:install
+
+  This will create:
+    db/migrate/[TIMESTAMP]_create_versions.rb
+    config/initializers/paper_trail.rb
+
+  rails generate paper_trail:install --with-changes
+
+  This will create:
+    db/migrate/[TIMESTAMP]_create_versions.rb
+    db/migrate/[TIMESTAMP]_add_object_changes_to_versions.rb
+    config/initializers/paper_trail.rb
+
+  rails generate paper_trail:install CommentVersion
+
+  This will create:
+    db/migrate/[TIMESTAMP]_create_comment_versions.rb
+    config/initializers/paper_trail.rb
+
+  rails generate paper_trail:install ProductVersion --with-changes --uuid
+
+  This will create:
+    db/migrate/[TIMESTAMP]_create_product_versions.rb
+    db/migrate/[TIMESTAMP]_add_object_changes_to_product_versions.rb
+    config/initializers/paper_trail.rb

data/lib/generators/paper_trail/install/install_generator.rb

@@ -27,18 +27,21 @@ module PaperTrail
       desc: "Use uuid instead of bigint for item_id type (use only if tables use UUIDs)"
     )
 
-    desc "Generates (but does not run) a migration to add a versions table." \
-         "  See section 5.c. Generators in README.md for more information."
+    desc "Generates (but does not run) a migration to add a versions table. " \
+         "Can be customized by providing a Version class name. " \
+         "See section 5.c. Generators in README.md for more information."
 
     def create_migration_file
+      # Use the table_name to create the proper migration filename
       add_paper_trail_migration(
-        "create_versions",
+        "create_#{table_name}",
         item_type_options: item_type_options,
         versions_table_options: versions_table_options,
-        item_id_type_options: item_id_type_options
+        item_id_type_options: item_id_type_options,
+        version_table_primary_key_type: version_table_primary_key_type
       )
       if options.with_changes?
-        add_paper_trail_migration("add_object_changes_to_versions")
+        add_paper_trail_migration("add_object_changes_to_#{table_name}")
       end
     end
 
@@ -49,6 +52,15 @@ module PaperTrail
       options.uuid? ? "string" : "bigint"
     end
 
+    # To use uuid for version table primary key
+    def version_table_primary_key_type
+      if options.uuid?
+        ", id: :uuid"
+      else
+        ""
+      end
+    end
+
     # MySQL 5.6 utf8mb4 limit is 191 chars for keys used in indexes.
     # See https://github.com/paper-trail-gem/paper_trail/issues/651
     def item_type_options

data/lib/generators/paper_trail/install/templates/add_object_changes_to_versions.rb.erb

@@ -1,12 +1,12 @@
 # This migration adds the optional `object_changes` column, in which PaperTrail
 # will store the `changes` diff for each update event. See the readme for
 # details.
-class AddObjectChangesToVersions < ActiveRecord::Migration<%= migration_version %>
+class AddObjectChangesTo<%= version_class_name.pluralize %> < ActiveRecord::Migration<%= migration_version %>
   # The largest text column available in all supported RDBMS.
   # See `create_versions.rb` for details.
   TEXT_BYTES = 1_073_741_823
 
   def change
-    add_column :versions, :object_changes, :text, limit: TEXT_BYTES
+    add_column :<%= table_name %>, :object_changes, :text, limit: TEXT_BYTES
   end
 end

data/lib/generators/paper_trail/install/templates/create_versions.rb.erb

@@ -1,6 +1,6 @@
-# This migration creates the `versions` table, the only schema PT requires.
+# This migration creates the `<%= table_name %>` table for the <%= version_class_name %> class.
 # All other migrations PT provides are optional.
-class CreateVersions < ActiveRecord::Migration<%= migration_version %>
+class Create<%= version_class_name.pluralize %> < ActiveRecord::Migration<%= migration_version %>
 
   # The largest text column available in all supported RDBMS is
   # 1024^3 - 1 bytes, roughly one gibibyte.  We specify a size
@@ -9,12 +9,10 @@ class CreateVersions < ActiveRecord::Migration<%= migration_version %>
   TEXT_BYTES = 1_073_741_823
 
   def change
-    create_table :versions<%= versions_table_options %> do |t|
-      t.string   :item_type<%= item_type_options %>
-      t.<%= item_id_type_options %>   :item_id,   null: false
-      t.string   :event,     null: false
+    create_table :<%= table_name %><%= versions_table_options %><%= version_table_primary_key_type %> do |t|
+      # Consider using bigint type for performance if you are going to store only numeric ids.
+      # t.bigint   :whodunnit
       t.string   :whodunnit
-      t.text     :object, limit: TEXT_BYTES
 
       # Known issue in MySQL: fractional second precision
       # -------------------------------------------------
@@ -32,7 +30,12 @@ class CreateVersions < ActiveRecord::Migration<%= migration_version %>
       # MySQL users should use the following line for `created_at`
       # t.datetime :created_at, limit: 6
       t.datetime :created_at
+
+      t.<%= item_id_type_options %>   :item_id,   null: false
+      t.string   :item_type<%= item_type_options %>
+      t.string   :event,     null: false
+      t.text     :object, limit: TEXT_BYTES
     end
-    add_index :versions, %i[item_type item_id]
+    add_index :<%= table_name %>, %i[item_type item_id]
   end
 end

data/lib/generators/paper_trail/migration_generator.rb

@@ -8,6 +8,10 @@ module PaperTrail
   class MigrationGenerator < ::Rails::Generators::Base
     include ::Rails::Generators::Migration
 
+    # Define arguments for the generator
+    argument :version_class_name, type: :string, default: "Version",
+      desc: "The name of the Version class (e.g., CommentVersion)"
+
     def self.next_migration_number(dirname)
       ::ActiveRecord::Generators::Base.next_migration_number(dirname)
     end
@@ -19,10 +23,17 @@ module PaperTrail
       if self.class.migration_exists?(migration_dir, template)
         ::Kernel.warn "Migration already exists: #{template}"
       else
+        # Map the dynamic template name to the actual template file
+        template_file = map_template_name(template)
+
         migration_template(
-          "#{template}.rb.erb",
+          "#{template_file}.rb.erb",
           "db/migrate/#{template}.rb",
-          { migration_version: migration_version }.merge(extra_options)
+          {
+            migration_version: migration_version,
+            table_name: table_name,
+            version_class_name: version_class_name
+          }.merge(extra_options)
         )
       end
     end
@@ -34,5 +45,21 @@ module PaperTrail
         ActiveRecord::VERSION::MINOR
       )
     end
+
+    # Convert Version class name to table name using Rails conventions
+    def table_name
+      version_class_name.underscore.pluralize
+    end
+
+    # Map the dynamic template name to the actual template file
+    def map_template_name(template)
+      if template.start_with?("create_")
+        "create_versions"
+      elsif template.start_with?("add_object_changes_to_")
+        "add_object_changes_to_versions"
+      else
+        template
+      end
+    end
   end
 end

data/lib/generators/paper_trail/update_item_subtype/templates/update_versions_for_item_subtype.rb.erb

@@ -1,6 +1,6 @@
 # This migration updates existing `versions` that have `item_type` that refers to
 # the base_class, and changes them to refer to the subclass instead.
-class UpdateVersionsForItemSubtype < ActiveRecord::Migration<%= migration_version %>
+class Update<%= version_class_name.pluralize %>ForItemSubtype < ActiveRecord::Migration<%= migration_version %>
   include ActionView::Helpers::TextHelper
   def up
 <%=
@@ -18,7 +18,8 @@ class UpdateVersionsForItemSubtype < ActiveRecord::Migration<%= migration_versio
   #   # Versions of item_type "Plant" with IDs between 42 and 1337 will be updated based on `genus`
   #   hints = {"Animal"=>{1..4=>"species"}, "Plant"=>{42..1337=>"genus"}}
   hint_descriptions = ""
-  hints = args.inject(Hash.new{|h, k| h[k] = {}}) do |s, v|
+  # Use @hints over args to not break the test itself since args could now include --version_class_name=CommentVersion
+  hints = (@hints || []).inject(Hash.new{|h, k| h[k] = {}}) do |s, v|
     klass, column, range = parse_custom_entry(v)
     hint_descriptions << "    # Versions of item_type \"#{klass}\" with IDs between #{
       range.first} and #{range.last} will be updated based on \`#{column}\`\n"
@@ -32,7 +33,7 @@ class UpdateVersionsForItemSubtype < ActiveRecord::Migration<%= migration_versio
 %>
     # Find all ActiveRecord models mentioned in existing versions
     changes = Hash.new { |h, k| h[k] = [] }
-    model_names = PaperTrail::Version.select(:item_type).distinct
+    model_names = <%= fully_qualified_version_class_name %>.select(:item_type).distinct
     model_names.map(&:item_type).each do |model_name|
       hint = hints[model_name] if defined?(hints)
       begin
@@ -40,7 +41,7 @@ class UpdateVersionsForItemSubtype < ActiveRecord::Migration<%= migration_versio
         # Actually implements an inheritance_column?  (Usually "type")
         has_inheritance_column = klass.columns.map(&:name).include?(klass.inheritance_column)
         # Find domain of types stored in PaperTrail versions
-        PaperTrail::Version.where(item_type: model_name, item_subtype: nil).select(:id, :object, :object_changes).each do |obj|
+        <%= fully_qualified_version_class_name %>.where(item_type: model_name, item_subtype: nil).select(:id, :object, :object_changes).each do |obj|
           if (object_detail = PaperTrail.serializer.load(obj.object || obj.object_changes))
             is_found = false
             subtype_name = nil
@@ -72,11 +73,11 @@ class UpdateVersionsForItemSubtype < ActiveRecord::Migration<%= migration_versio
       v.sort.each do |id|
         block_of_ids << id
         if (id_count += 1) % 100 == 0
-          num_updated += PaperTrail::Version.where(id: block_of_ids).update_all(item_subtype: k)
+          num_updated += <%= fully_qualified_version_class_name %>.where(id: block_of_ids).update_all(item_subtype: k)
           block_of_ids = []
         end
       end
-      num_updated += PaperTrail::Version.where(id: block_of_ids).update_all(item_subtype: k)
+      num_updated += <%= fully_qualified_version_class_name %>.where(id: block_of_ids).update_all(item_subtype: k)
       if num_updated > 0
         say "Associated #{pluralize(num_updated, 'record')} to #{k}", subitem: true
       end

data/lib/generators/paper_trail/update_item_subtype/update_item_subtype_generator.rb

@@ -7,13 +7,34 @@ module PaperTrail
   class UpdateItemSubtypeGenerator < MigrationGenerator
     source_root File.expand_path("templates", __dir__)
 
+    # Remove the inherited version_class_name argument as we use an option instead
+    remove_argument :version_class_name
+
+    argument :hints, type: :array, default: [], banner: "hint1 hint2"
+
+    class_option :version_class_name,
+      type: :string,
+      default: "Version",
+      aliases: ["-v"],
+      desc: "The name of the Version class (e.g., CommentVersion)"
+
     desc(
-      "Generates (but does not run) a migration to update item_subtype for "\
+      "Generates (but does not run) a migration to update item_subtype for " \
       "STI entries in an existing versions table."
     )
 
     def create_migration_file
-      add_paper_trail_migration("update_versions_for_item_subtype", sti_type_options: options)
+      add_paper_trail_migration("update_#{table_name}_for_item_subtype", sti_type_options: options)
+    end
+
+    # Return the version class name from options
+    def version_class_name
+      options[:version_class_name]
+    end
+
+    # Return the fully qualified class name for use in ERB templates
+    def fully_qualified_version_class_name
+      version_class_name == "Version" ? "PaperTrail::Version" : version_class_name
     end
   end
 end

data/lib/paper_trail/attribute_serializers/cast_attribute_serializer.rb

@@ -32,7 +32,7 @@ module PaperTrail
         if defined_enums[attr] && val.is_a?(::String)
           # Because PT 4 used to save the string version of enums to `object_changes`
           val
-        elsif rails_gte_7_0? && val.is_a?(ActiveRecord::Type::Time::Value)
+        elsif val.is_a?(ActiveRecord::Type::Time::Value)
           # Because Rails 7 time attribute throws a delegation error when you deserialize
           # it with the factory.
           # See ActiveRecord::Type::Time::Value crashes when loaded from YAML on rails 7.0
@@ -43,10 +43,6 @@ module PaperTrail
         end
       end
 
-      def rails_gte_7_0?
-        ::ActiveRecord.gem_version >= ::Gem::Version.new("7.0.0")
-      end
-
       def serialize(attr, val)
         AttributeSerializerFactory.for(@klass, attr).serialize(val)
       end

data/lib/paper_trail/attribute_serializers/object_attribute.rb

@@ -8,6 +8,9 @@ module PaperTrail
     class ObjectAttribute
       def initialize(model_class)
         @model_class = model_class
+
+        # ActiveRecord since 7.0 has a built-in encryption mechanism
+        @encrypted_attributes = @model_class.encrypted_attributes&.map(&:to_s)
       end
 
       def serialize(attributes)
@@ -23,14 +26,18 @@ module PaperTrail
       # Modifies `attributes` in place.
       # TODO: Return a new hash instead.
       def alter(attributes, serialization_method)
-        # Don't serialize before values before inserting into columns of type
+        # Don't serialize non-encrypted before values before inserting into columns of type
         # `JSON` on `PostgreSQL` databases.
-        return attributes if object_col_is_json?
+        attributes_to_serialize =
+          object_col_is_json? ? attributes.slice(*@encrypted_attributes) : attributes
+        return attributes if attributes_to_serialize.blank?
 
         serializer = CastAttributeSerializer.new(@model_class)
-        attributes.each do |key, value|
+        attributes_to_serialize.each do |key, value|
           attributes[key] = serializer.send(serialization_method, key, value)
         end
+
+        attributes
       end
 
       def object_col_is_json?

data/lib/paper_trail/attribute_serializers/object_changes_attribute.rb

@@ -8,6 +8,9 @@ module PaperTrail
     class ObjectChangesAttribute
       def initialize(item_class)
         @item_class = item_class
+
+        # ActiveRecord since 7.0 has a built-in encryption mechanism
+        @encrypted_attributes = @item_class.encrypted_attributes&.map(&:to_s)
       end
 
       def serialize(changes)
@@ -23,17 +26,21 @@ module PaperTrail
       # Modifies `changes` in place.
       # TODO: Return a new hash instead.
       def alter(changes, serialization_method)
-        # Don't serialize before values before inserting into columns of type
+        # Don't serialize non-encrypted before values before inserting into columns of type
         # `JSON` on `PostgreSQL` databases.
-        return changes if object_changes_col_is_json?
+        changes_to_serialize =
+          object_changes_col_is_json? ? changes.slice(*@encrypted_attributes) : changes.clone
+        return changes if changes_to_serialize.blank?
 
         serializer = CastAttributeSerializer.new(@item_class)
-        changes.clone.each do |key, change|
+        changes_to_serialize.each do |key, change|
           # `change` is an Array with two elements, representing before and after.
           changes[key] = Array(change).map do |value|
             serializer.send(serialization_method, key, value)
           end
         end
+
+        changes
       end
 
       def object_changes_col_is_json?

data/lib/paper_trail/compatibility.rb

@@ -17,8 +17,8 @@ module PaperTrail
   # newer rails versions. Most PT users should avoid incompatible rails
   # versions.
   module Compatibility
-    ACTIVERECORD_GTE = ">= 6.0" # enforced in gemspec
-    ACTIVERECORD_LT = "< 7.1" # not enforced in gemspec
+    ACTIVERECORD_GTE = ">= 7.1" # enforced in gemspec
+    ACTIVERECORD_LT = "< 8.2" # not enforced in gemspec
 
     E_INCOMPATIBLE_AR = <<-EOS
       PaperTrail %s is not compatible with ActiveRecord %s. We allow PT

data/lib/paper_trail/config.rb

@@ -14,7 +14,8 @@ module PaperTrail
       :object_changes_adapter,
       :serializer,
       :version_limit,
-      :has_paper_trail_defaults
+      :has_paper_trail_defaults,
+      :version_error_behavior
     )
 
     def initialize
@@ -25,6 +26,7 @@ module PaperTrail
       # Variables which affect all threads, whose access is *not* synchronized.
       @serializer = PaperTrail::Serializers::YAML
       @has_paper_trail_defaults = {}
+      @version_error_behavior = :legacy
     end
 
     # Indicates whether PaperTrail is on or off. Default: true.

data/lib/paper_trail/events/base.rb

@@ -157,7 +157,7 @@ module PaperTrail
       # @api private
       def ignored_attr_has_changed?
         ignored = calculated_ignored_array + @record.paper_trail_options[:skip]
-        ignored.any? && (changed_in_latest_version & ignored).any?
+        ignored.any? && changed_in_latest_version.intersect?(ignored)
       end
 
       # Rails 5.1 changed the API of `ActiveRecord::Dirty`. See

data/lib/paper_trail/frameworks/active_record.rb

@@ -3,7 +3,7 @@
 # Either ActiveRecord has already been loaded by the Lazy Load Hook in our
 # Railtie, or else we load it now.
 require "active_record"
-::PaperTrail::Compatibility.check_activerecord(::ActiveRecord.gem_version)
+PaperTrail::Compatibility.check_activerecord(ActiveRecord.gem_version)
 
 # Now we can load the parts of PT that depend on AR.
 require "paper_trail/has_paper_trail"

data/lib/paper_trail/frameworks/cucumber.rb

@@ -5,7 +5,7 @@ Before do
   PaperTrail.enabled = false
   PaperTrail.request.enabled = true
   PaperTrail.request.whodunnit = nil
-  PaperTrail.request.controller_info = {} if defined?(::Rails)
+  PaperTrail.request.controller_info = {} if defined?(Rails)
 end
 
 module PaperTrail

data/lib/paper_trail/frameworks/rails/railtie.rb

@@ -10,7 +10,7 @@ module PaperTrail
     # We specify `before: "load_config_initializers"` to ensure that the PT
     # initializer happens before "app initializers" (those defined in
     # the app's `config/initalizers`).
-    initializer "paper_trail", before: "load_config_initializers" do
+    initializer "paper_trail", before: "load_config_initializers" do |app|
       # `on_load` is a "lazy load hook". It "declares a block that will be
       # executed when a Rails component is fully loaded". (See
       # `active_support/lazy_load_hooks.rb`)
@@ -25,6 +25,10 @@ module PaperTrail
       ActiveSupport.on_load(:active_record) do
         require "paper_trail/frameworks/active_record"
       end
+
+      if Gem::Version.new(::Rails::VERSION::STRING) >= Gem::Version.new("7.1")
+        app.deprecators[:paper_trail] = PaperTrail.deprecator
+      end
     end
   end
 end

data/lib/paper_trail/frameworks/rspec.rb

@@ -5,24 +5,24 @@ require "rspec/matchers"
 require "paper_trail/frameworks/rspec/helpers"
 
 RSpec.configure do |config|
-  config.include ::PaperTrail::RSpec::Helpers::InstanceMethods
-  config.extend ::PaperTrail::RSpec::Helpers::ClassMethods
+  config.include PaperTrail::RSpec::Helpers::InstanceMethods
+  config.extend PaperTrail::RSpec::Helpers::ClassMethods
 
   config.before(:each) do
-    ::PaperTrail.enabled = false
-    ::PaperTrail.request.enabled = true
-    ::PaperTrail.request.whodunnit = nil
-    ::PaperTrail.request.controller_info = {} if defined?(::Rails) && defined?(::RSpec::Rails)
+    PaperTrail.enabled = false
+    PaperTrail.request.enabled = true
+    PaperTrail.request.whodunnit = nil
+    PaperTrail.request.controller_info = {} if defined?(Rails) && defined?(RSpec::Rails)
   end
 
   config.before(:each, versioning: true) do
-    ::PaperTrail.enabled = true
+    PaperTrail.enabled = true
   end
 end
 
 RSpec::Matchers.define :be_versioned do
   # check to see if the model has `has_paper_trail` declared on it
-  match { |actual| actual.is_a?(::PaperTrail::Model::InstanceMethods) }
+  match { |actual| actual.is_a?(PaperTrail::Model::InstanceMethods) }
 end
 
 RSpec::Matchers.define :have_a_version_with do |attributes|

data/lib/paper_trail/has_paper_trail.rb

@@ -53,6 +53,10 @@ module PaperTrail
       #   - A Hash - options passed to `has_many`, plus `name:` and `scope:`.
       # - :version - The name to use for the method which returns the version
       #   the instance was reified from. Default is `:version`.
+      # - :synchronize_version_creation_timestamp - By default, paper trail
+      #   sets the `created_at` field for a new Version equal to the `updated_at`
+      #   column of the model being updated. If you instead want `created_at` to
+      #   populate with the current timestamp, set this option to `false`.
       #
       # Plugins like the experimental `paper_trail-association_tracking` gem
       # may accept additional options.
@@ -64,6 +68,8 @@ module PaperTrail
       #
       # @api public
       def has_paper_trail(options = {})
+        raise Error, "has_paper_trail must be called only once" if self < InstanceMethods
+
         defaults = PaperTrail.config.has_paper_trail_defaults
         paper_trail.setup(defaults.merge(options))
       end

data/lib/paper_trail/model_config.rb

@@ -4,7 +4,7 @@ module PaperTrail
   # Configures an ActiveRecord model, mostly at application boot time, but also
   # sometimes mid-request, with methods like enable/disable.
   class ModelConfig
-    E_CANNOT_RECORD_AFTER_DESTROY = <<-STR.strip_heredoc.freeze
+    E_CANNOT_RECORD_AFTER_DESTROY = <<~STR
       paper_trail.on_destroy(:after) is incompatible with ActiveRecord's
       belongs_to_required_by_default. Use on_destroy(:before)
       or disable belongs_to_required_by_default.
@@ -49,7 +49,7 @@ module PaperTrail
     def on_destroy(recording_order = "before")
       assert_valid_recording_order_for_on_destroy(recording_order)
       @model_class.send(
-        "#{recording_order}_destroy",
+        :"#{recording_order}_destroy",
         lambda do |r|
           return unless r.paper_trail.save_version?
           r.paper_trail.record_destroy(recording_order)
@@ -82,8 +82,9 @@ module PaperTrail
 
     # Adds a callback that records a version after a "touch" event.
     #
-    # Rails < 6.0 has a bug where dirty-tracking does not occur during
-    # a `touch`. (https://github.com/rails/rails/issues/33429) See also:
+    # Rails < 6.0 (no longer supported by PT) had a bug where dirty-tracking
+    # did not occur during a `touch`.
+    # (https://github.com/rails/rails/issues/33429) See also:
     # https://github.com/paper-trail-gem/paper_trail/issues/1121
     # https://github.com/paper-trail-gem/paper_trail/issues/1161
     # https://github.com/paper-trail-gem/paper_trail/pull/1285
@@ -155,7 +156,7 @@ module PaperTrail
       # @api private - `version_class_name`
       @model_class.class_attribute :version_class_name
       if options[:class_name]
-        ::ActiveSupport::Deprecation.warn(
+        PaperTrail.deprecator.warn(
           format(
             DPR_CLASS_NAME_OPTION,
             class_name: options[:class_name].inspect
@@ -191,7 +192,7 @@ module PaperTrail
     def ensure_versions_option_is_hash(options)
       unless options[:versions].is_a?(Hash)
         if options[:versions]
-          ::ActiveSupport::Deprecation.warn(
+          PaperTrail.deprecator.warn(
             format(
               DPR_PASSING_ASSOC_NAME_DIRECTLY_TO_VERSIONS_OPTION,
               versions_name: options[:versions].inspect
@@ -235,7 +236,7 @@ module PaperTrail
 
     def setup_callbacks_from_options(options_on = [])
       options_on.each do |event|
-        public_send("on_#{event}")
+        public_send(:"on_#{event}")
       end
     end
 

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

@@ -39,7 +39,7 @@ module PaperTrail
           values = []
           @attributes.each do |field, value|
             predicates.push "object->>? = ?"
-            values.concat([field, value.to_s])
+            values.push(field, value.to_s)
           end
           sql = predicates.join(" and ")
           @version_model_class.where(sql, *values)

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

@@ -53,7 +53,7 @@ module PaperTrail
             predicates.push(
               "((object_changes->>? ILIKE ?) OR (object_changes->>? ILIKE ?))"
             )
-            values.concat([field, "[#{value.to_json},%", field, "[%,#{value.to_json}]%"])
+            values.push(field, "[#{value.to_json},%", field, "[%,#{value.to_json}]%")
           end
           sql = predicates.join(" and ")
           @version_model_class.where(sql, *values)

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

@@ -46,7 +46,7 @@ module PaperTrail
             predicates.push(
               "(object_changes->>? ILIKE ?)"
             )
-            values.concat([field, "[#{value.to_json},%"])
+            values.push(field, "[#{value.to_json},%")
           end
           sql = predicates.join(" and ")
           @version_model_class.where(sql, *values)

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

@@ -46,7 +46,7 @@ module PaperTrail
             predicates.push(
               "(object_changes->>? ILIKE ?)"
             )
-            values.concat([field, "[%#{value.to_json}]"])
+            values.push(field, "[%#{value.to_json}]")
           end
           sql = predicates.join(" and ")
           @version_model_class.where(sql, *values)

data/lib/paper_trail/record_trail.rb

@@ -22,7 +22,7 @@ module PaperTrail
     # Invoked via`after_update` callback for when a previous version is
     # reified and then saved.
     def clear_version_instance
-      @record.send("#{@record.class.version_association_name}=", nil)
+      @record.send(:"#{@record.class.version_association_name}=", nil)
     end
 
     # Returns true if this instance is the current, live one;
@@ -64,6 +64,8 @@ module PaperTrail
         # of versions_assoc.build?, the association cache is unaware. So, we
         # invalidate the `versions` association cache with `reset`.
         versions.reset
+      rescue StandardError => e
+        handle_version_errors e, version, :create
       end
     end
 
@@ -81,12 +83,13 @@ module PaperTrail
       # `data_for_destroy` but PT-AT still does.
       data = event.data.merge(data_for_destroy)
 
-      version = @record.class.paper_trail.version_class.create(data)
-      if version.errors.any?
-        log_version_errors(version, :destroy)
-      else
+      version = @record.class.paper_trail.version_class.new(data)
+      begin
+        version.save!
         assign_and_reset_version_association(version)
         version
+      rescue StandardError => e
+        handle_version_errors e, version, :destroy
       end
     end
 
@@ -108,14 +111,15 @@ module PaperTrail
       )
       return unless version
 
-      if version.save
+      begin
+        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
-        log_version_errors(version, :update)
+      rescue StandardError => e
+        handle_version_errors e, version, :update
       end
     end
 
@@ -124,7 +128,7 @@ module PaperTrail
     def reset_timestamp_attrs_for_update_if_needed
       return if live?
       @record.send(:timestamp_attributes_for_update_in_model).each do |column|
-        @record.send("restore_#{column}!")
+        @record.send(:"restore_#{column}!")
       end
     end
 
@@ -198,7 +202,7 @@ module PaperTrail
 
     # @api private
     def assign_and_reset_version_association(version)
-      @record.send("#{@record.class.version_association_name}=", version)
+      @record.send(:"#{@record.class.version_association_name}=", version)
       @record.send(@record.class.versions_association_name).reset
     end
 
@@ -226,7 +230,8 @@ module PaperTrail
       # 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)
+      if @record.respond_to?(:updated_at) &&
+          @record.paper_trail_options[:synchronize_version_creation_timestamp] != false
         data[:created_at] = @record.updated_at
       end
 
@@ -285,6 +290,26 @@ module PaperTrail
       )
     end
 
+    # Centralized handler for version errors
+    # @api private
+    def handle_version_errors(e, version, action)
+      case PaperTrail.config.version_error_behavior
+      when :legacy
+        # legacy behavior was to raise on create and log on update/delete
+        if action == :create
+          raise e
+        else
+          log_version_errors(version, action)
+        end
+      when :log
+        log_version_errors(version, action)
+      when :exception
+        raise e
+      when :silent
+        # noop
+      end
+    end
+
     # @api private
     # @return - The created version object, so that plugins can use it, e.g.
     # paper_trail-association_tracking
@@ -297,11 +322,12 @@ module PaperTrail
       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 = versions_assoc.new(data)
+      begin
+        version.save!
         version
+      rescue StandardError => e
+        handle_version_errors e, version, :update
       end
     end
 

data/lib/paper_trail/reifier.rb

@@ -14,7 +14,7 @@ module PaperTrail
         attrs = version.object_deserialized
         model = init_model(attrs, options, version)
         reify_attributes(model, version, attrs)
-        model.send "#{model.class.version_association_name}=", version
+        model.send :"#{model.class.version_association_name}=", version
         model
       end
 
@@ -93,8 +93,8 @@ module PaperTrail
       def reify_attribute(k, v, model, version)
         if model.has_attribute?(k)
           model[k.to_sym] = v
-        elsif model.respond_to?("#{k}=")
-          model.send("#{k}=", v)
+        elsif model.respond_to?(:"#{k}=")
+          model.send(:"#{k}=", v)
         elsif version.logger
           version.logger.warn(
             "Attribute #{k} does not exist on #{version.item_type} (Version id: #{version.id})."

data/lib/paper_trail/serializers/yaml.rb

@@ -27,7 +27,7 @@ module PaperTrail
       # recent [memory optimizations](https://github.com/paper-trail-gem/paper_trail/pull/1189),
       # when coming from `recordable_object_changes`, it will be a `HashWithIndifferentAccess`.
       def dump(object)
-        object = object.to_hash if object.is_a?(HashWithIndifferentAccess)
+        object = object.to_hash if object.is_a?(ActiveSupport::HashWithIndifferentAccess)
         ::YAML.dump object
       end
 

data/lib/paper_trail/version_concern.rb

@@ -320,7 +320,7 @@ module PaperTrail
       end
 
       # First, deserialize the `object_changes` column.
-      changes = HashWithIndifferentAccess.new(object_changes_deserialized)
+      changes = ActiveSupport::HashWithIndifferentAccess.new(object_changes_deserialized)
 
       # The next step is, perhaps unfortunately, called "de-serialization",
       # and appears to be responsible for custom attribute serializers. For an

data/lib/paper_trail/version_number.rb

@@ -7,7 +7,7 @@ module PaperTrail
   # because of this confusion, but it's not worth the breaking change.
   # People are encouraged to use `PaperTrail.gem_version` instead.
   module VERSION
-    MAJOR = 14
+    MAJOR = 17
     MINOR = 0
     TINY = 0
 

data/lib/paper_trail.rb

@@ -114,6 +114,10 @@ module PaperTrail
     def version
       VERSION::STRING
     end
+
+    def deprecator
+      @deprecator ||= ActiveSupport::Deprecation.new("16.0", "PaperTrail")
+    end
   end
 end
 

metadata

@@ -1,16 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: paper_trail
 version: !ruby/object:Gem::Version
-  version: 14.0.0
+  version: 17.0.0
 platform: ruby
 authors:
 - Andy Stewart
 - Ben Atkins
 - Jared Beck
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-26 00:00:00.000000000 Z
+date: 2025-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -18,14 +17,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: request_store
   requirement: !ruby/object:Gem::Requirement
@@ -40,20 +39,90 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: benchmark
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: drb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: mutex_m
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.1
+        version: '2.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.1
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -116,14 +185,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: rails-controller-testing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.5
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -144,98 +227,98 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.2
+        version: 7.1.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.2
+        version: 7.1.1
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.22.2
+        version: '1.75'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.22.2
+        version: '1.75'
 - !ruby/object:Gem::Dependency
   name: rubocop-packaging
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.11.5
+        version: 1.24.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.11.5
+        version: 1.24.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.12.4
+        version: 2.30.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.12.4
+        version: 2.30.3
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: 3.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: 3.5.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -351,8 +434,9 @@ files:
 homepage: https://github.com/paper-trail-gem/paper_trail
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  changelog_uri: https://github.com/paper-trail-gem/paper_trail/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -360,15 +444,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Track changes to your models.
 test_files: []