paper_trail 15.1.0 → 16.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be00c0904aaf09dc94776bef79c7299fd37bedd37934a89c5bad1f4a52867217
-  data.tar.gz: 62c19b4b92194823d67a6273b8420005166436c588f9b41dcbd4d967bd8ee33d
+  metadata.gz: 0a834abeee917bf2c090c6ef7f6da09437b12aff37c0bcf94f8ff88ca1434203
+  data.tar.gz: 6fdf12293b452fe7dcce563e5f4547d9ae0081399b5cf6885308ea451f29b6ed
 SHA512:
-  metadata.gz: 9143b3f784331c3f93abd9e323a3baf5fed424da1c9b9af71c9c0df921be48511432178f89e360e176d4ecc41448a26632d2130c36d311b3ef1ff3a21ca13134
-  data.tar.gz: 2d7624ea240a460ff7e5a3c09297dd7c69f8a9487fbabcbd9c392267f7cb14bb83ee602fab2568181534002d3d77df09e8cd084b65136055ae44dbaf499477cf
+  metadata.gz: 82fbf4c2ec002d52ee5b4023cbef6a16ef5530e04852a4a3d65fb38b468395016db6230e2f89c199a13549bb9da98a1f53a2b29148a94455bc6470ea7912dcaf
+  data.tar.gz: 9944b2f2e66c9fdc10fe2ecf6f9c560b73da21e49d98504f826158e92faeef5b9cad7a4a1cb1f033217c1f66e230d4c8e2df034c4751298a93df5bf946ef108e

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

@@ -10,11 +10,9 @@ class CreateVersions < ActiveRecord::Migration<%= migration_version %>
 
   def change
     create_table :versions<%= versions_table_options %><%= version_table_primary_key_type %> do |t|
-      t.string   :item_type<%= item_type_options %>
-      t.<%= item_id_type_options %>   :item_id,   null: false
-      t.string   :event,     null: false
+      # 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,6 +30,11 @@ 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]
   end

data/lib/paper_trail/compatibility.rb

@@ -18,7 +18,7 @@ module PaperTrail
   # versions.
   module Compatibility
     ACTIVERECORD_GTE = ">= 6.1" # enforced in gemspec
-    ACTIVERECORD_LT = "< 7.2" # not enforced in gemspec
+    ACTIVERECORD_LT = "< 8.1" # 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/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/has_paper_trail.rb

@@ -68,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

@@ -156,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
@@ -192,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

data/lib/paper_trail/record_trail.rb

@@ -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
 
@@ -286,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
@@ -298,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/version_number.rb

@@ -7,8 +7,8 @@ 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 = 15
-    MINOR = 1
+    MAJOR = 16
+    MINOR = 0
     TINY = 0
 
     # Set PRE to nil unless it's a pre-release (beta, rc, etc.)

data/lib/paper_trail.rb

@@ -118,6 +118,10 @@ module PaperTrail
     def active_record_gte_7_0?
       @active_record_gte_7_0 ||= ::ActiveRecord.gem_version >= ::Gem::Version.new("7.0.0")
     end
+
+    def deprecator
+      @deprecator ||= ActiveSupport::Deprecation.new("16.0", "PaperTrail")
+    end
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paper_trail
 version: !ruby/object:Gem::Version
-  version: 15.1.0
+  version: 16.0.0
 platform: ruby
 authors:
 - Andy Stewart
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-22 00:00:00.000000000 Z
+date: 2024-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -46,14 +46,14 @@ dependencies:
     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
@@ -351,7 +351,8 @@ files:
 homepage: https://github.com/paper-trail-gem/paper_trail
 licenses:
 - MIT
-metadata: {}
+metadata:
+  changelog_uri: https://github.com/paper-trail-gem/paper_trail/blob/master/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -367,7 +368,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Track changes to your models.