paper_trail 10.1.0 → 11.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ac357832683a239eb259f30fea0d05701ddd634f
-  data.tar.gz: 1745e41be7c599090c4fd947822a30a6ad18b6ee
+SHA256:
+  metadata.gz: f8f7237a39b0645932b394ee0332846be680f6a725ed02c7a126aa892d840ccc
+  data.tar.gz: b0356d622a6e6f3ba0938c4d9fe0ff211b347a0c65e2d3a6574bc8bf5fb04df6
 SHA512:
-  metadata.gz: efa1906f7569fd7cb9eab56ad5d70daed5739714cd52197e97e2057cdb311b3016c3b36c3b4992c1cb75cc26ede53e42b481424fedc4fc40f47adc3902c7f772
-  data.tar.gz: b4e4976c7273d397ea6a657debd40b4aa4354bce68b59c7e70bb28cf928e46c210d4085e44314d3aa8b3d8889fb46762375987bf904a989751d732056f54b592
+  metadata.gz: 46ad3d73231d4ab6c3d978925e7b838af2697b2b998b9a7948d078266fbdbec33b6dbdcbfb93751f2aa961be6a3499f499a71d56e3fbc6138174cb752feae41a
+  data.tar.gz: 9ec2fc044229898aa2c5ab70dc41b549b6896c61af42633af0760e6b99aadd375f5f7e39160ad713131ecb439b0f5aff8cb6696f276f4c5225eb40e371f43035

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

@@ -25,10 +25,14 @@ module PaperTrail
          "  See section 5.c. Generators in README.md for more information."
 
     def create_migration_file
-      add_paper_trail_migration("create_versions",
+      add_paper_trail_migration(
+        "create_versions",
         item_type_options: item_type_options,
-        versions_table_options: versions_table_options)
-      add_paper_trail_migration("add_object_changes_to_versions") if options.with_changes?
+        versions_table_options: versions_table_options
+      )
+      if options.with_changes?
+        add_paper_trail_migration("add_object_changes_to_versions")
+      end
     end
 
     private

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

@@ -11,7 +11,7 @@ class CreateVersions < ActiveRecord::Migration<%= migration_version %>
   def change
     create_table :versions<%= versions_table_options %> do |t|
       t.string   :item_type<%= item_type_options %>
-      t.integer  :item_id,   null: false
+      t.bigint   :item_id,   null: false
       t.string   :event,     null: false
       t.string   :whodunnit
       t.text     :object, limit: TEXT_BYTES

data/lib/generators/paper_trail/migration_generator.rb

@@ -28,10 +28,11 @@ module PaperTrail
     end
 
     def migration_version
-      major = ActiveRecord::VERSION::MAJOR
-      if major >= 5
-        "[#{major}.#{ActiveRecord::VERSION::MINOR}]"
-      end
+      format(
+        "[%d.%d]",
+        ActiveRecord::VERSION::MAJOR,
+        ActiveRecord::VERSION::MINOR
+      )
     end
   end
 end

data/lib/paper_trail.rb

@@ -16,6 +16,7 @@ require "active_record"
 
 require "request_store"
 require "paper_trail/cleaner"
+require "paper_trail/compatibility"
 require "paper_trail/config"
 require "paper_trail/has_paper_trail"
 require "paper_trail/record_history"
@@ -125,6 +126,10 @@ module PaperTrail
   end
 end
 
+# We use the `on_load` "hook" instead of `ActiveRecord::Base.include` because we
+# don't want to cause all of AR to be autloaded yet. See
+# https://guides.rubyonrails.org/engines.html#what-are-on-load-hooks-questionmark
+# to learn more about `on_load`.
 ActiveSupport.on_load(:active_record) do
   include PaperTrail::Model
 end
@@ -141,3 +146,7 @@ if defined?(::Rails)
 else
   require "paper_trail/frameworks/active_record"
 end
+
+if defined?(::ActiveRecord)
+  ::PaperTrail::Compatibility.check_activerecord(::ActiveRecord.gem_version)
+end

data/lib/paper_trail/attribute_serializers/cast_attribute_serializer.rb

@@ -32,50 +32,18 @@ module PaperTrail
       end
     end
 
-    if ::ActiveRecord::VERSION::MAJOR >= 5
-      # This implementation uses AR 5's `serialize` and `deserialize`.
-      class CastAttributeSerializer
-        def serialize(attr, val)
-          AttributeSerializerFactory.for(@klass, attr).serialize(val)
-        end
-
-        def deserialize(attr, val)
-          if defined_enums[attr] && val.is_a?(::String)
-            # Because PT 4 used to save the string version of enums to `object_changes`
-            val
-          else
-            AttributeSerializerFactory.for(@klass, attr).deserialize(val)
-          end
-        end
+    # Uses AR 5's `serialize` and `deserialize`.
+    class CastAttributeSerializer
+      def serialize(attr, val)
+        AttributeSerializerFactory.for(@klass, attr).serialize(val)
       end
-    else
-      # This implementation uses AR 4.2's `type_cast_for_database`. For
-      # versions of AR < 4.2 we provide an implementation of
-      # `type_cast_for_database` in our shim attribute type classes,
-      # `NoOpAttribute` and `SerializedAttribute`.
-      class CastAttributeSerializer
-        def serialize(attr, val)
-          castable_val = val
-          if defined_enums[attr]
-            # `attr` is an enum. Find the number that corresponds to `val`. If `val` is
-            # a number already, there won't be a corresponding entry, just use `val`.
-            castable_val = defined_enums[attr][val] || val
-          end
-          @klass.type_for_attribute(attr).type_cast_for_database(castable_val)
-        end
 
-        def deserialize(attr, val)
-          if defined_enums[attr] && val.is_a?(::String)
-            # Because PT 4 used to save the string version of enums to `object_changes`
-            val
-          else
-            val = @klass.type_for_attribute(attr).type_cast_from_database(val)
-            if defined_enums[attr]
-              defined_enums[attr].key(val)
-            else
-              val
-            end
-          end
+      def deserialize(attr, val)
+        if defined_enums[attr] && val.is_a?(::String)
+          # Because PT 4 used to save the string version of enums to `object_changes`
+          val
+        else
+          AttributeSerializerFactory.for(@klass, attr).deserialize(val)
         end
       end
     end

data/lib/paper_trail/compatibility.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module PaperTrail
+  # Rails does not follow SemVer, makes breaking changes in minor versions.
+  # Breaking changes are expected, and are generally good for the rails
+  # ecosystem. However, they often require dozens of hours to fix, even with the
+  # [help of experts](https://github.com/paper-trail-gem/paper_trail/pull/899).
+  #
+  # It is not safe to assume that a new version of rails will be compatible with
+  # PaperTrail. PT is only compatible with the versions of rails that it is
+  # tested against. See `.travis.yml`.
+  #
+  # However, as of
+  # [#1213](https://github.com/paper-trail-gem/paper_trail/pull/1213) our
+  # gemspec allows installation with newer, incompatible rails versions. We hope
+  # this will make it easier for contributors to work on compatibility with
+  # newer rails versions. Most PT users should avoid incompatible rails
+  # versions.
+  module Compatibility
+    ACTIVERECORD_GTE = ">= 5.2" # enforced in gemspec
+    ACTIVERECORD_LT = "< 6.1" # not enforced in gemspec
+
+    E_INCOMPATIBLE_AR = <<-EOS
+      PaperTrail %s is not compatible with ActiveRecord %s. We allow PT
+      contributors to install incompatible versions of ActiveRecord, and this
+      warning can be silenced with an environment variable, but this is a bad
+      idea for normal use. Please install a compatible version of ActiveRecord
+      instead (%s). Please see the discussion in paper_trail/compatibility.rb
+      for details.
+    EOS
+
+    # Normal users need a warning if they accidentally install an incompatible
+    # version of ActiveRecord. Contributors can silence this warning with an
+    # environment variable.
+    def self.check_activerecord(ar_version)
+      raise ::TypeError unless ar_version.instance_of?(::Gem::Version)
+      return if ::ENV["PT_SILENCE_AR_COMPAT_WARNING"].present?
+      req = ::Gem::Requirement.new([ACTIVERECORD_GTE, ACTIVERECORD_LT])
+      unless req.satisfied_by?(ar_version)
+        ::Kernel.warn(
+          format(
+            E_INCOMPATIBLE_AR,
+            ::PaperTrail.gem_version,
+            ar_version,
+            req
+          )
+        )
+      end
+    end
+  end
+end

data/lib/paper_trail/config.rb

@@ -9,14 +9,6 @@ module PaperTrail
   class Config
     include Singleton
 
-    E_PT_AT_REMOVED = <<-EOS.squish
-      Association Tracking for PaperTrail has been extracted to a separate gem.
-      To use it, please add `paper_trail-association_tracking` to your Gemfile.
-      If you don't use it (most people don't, that's the default) and you set
-      `track_associations = false` somewhere (probably a rails initializer) you
-      can remove that line now.
-    EOS
-
     attr_accessor(
       :association_reify_error_behaviour,
       :object_changes_adapter,
@@ -43,30 +35,5 @@ module PaperTrail
     def enabled=(enable)
       @mutex.synchronize { @enabled = enable }
     end
-
-    # In PT 10, the paper_trail-association_tracking gem was changed from a
-    # runtime dependency to a development dependency. We raise an error about
-    # this for the people who don't read changelogs.
-    #
-    # We raise a generic RuntimeError instead of a specific PT error class
-    # because there is no known use case where someone would want to rescue
-    # this. If we think of such a use case in the future we can revisit this
-    # decision.
-    #
-    # @override If PT-AT is `require`d, it will replace this method with its
-    # own implementation.
-    def track_associations=(value)
-      if value
-        raise E_PT_AT_REMOVED
-      else
-        ::Kernel.warn(E_PT_AT_REMOVED)
-      end
-    end
-
-    # @override If PT-AT is `require`d, it will replace this method with its
-    # own implementation.
-    def track_associations?
-      raise E_PT_AT_REMOVED
-    end
   end
 end

data/lib/paper_trail/events/base.rb

@@ -59,14 +59,29 @@ module PaperTrail
       end
 
       # @api private
-      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]
+      def nonskipped_attributes_before_change(is_touch)
+        cache_changed_attributes do
+          record_attributes = @record.attributes.except(*@record.paper_trail_options[:skip])
+
+          record_attributes.each_key do |k|
+            if @record.class.column_names.include?(k)
+              record_attributes[k] = attribute_in_previous_version(k, is_touch)
+            end
           end
-        end]
+        end
+      end
+
+      # Rails 5.1 changed the API of `ActiveRecord::Dirty`.
+      # @api private
+      def cache_changed_attributes(&block)
+        if RAILS_GTE_5_1
+          # Everything works fine as it is
+          yield
+        else
+          # Any particular call to `changed_attributes` produces the huge memory allocation.
+          # Lets use the generic AR workaround for that.
+          @record.send(:cache_changed_attributes, &block)
+        end
       end
 
       # Rails 5.1 changed the API of `ActiveRecord::Dirty`. See
@@ -92,7 +107,7 @@ module PaperTrail
       end
 
       # @api private
-      def changed_and_not_ignored
+      def calculated_ignored_array
         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.
@@ -102,42 +117,18 @@ module PaperTrail
               ignore << attr if condition.respond_to?(:call) && condition.call(@record)
             }
         end
-        skip = @record.paper_trail_options[:skip]
-        (changed_in_latest_version - ignore) - skip
       end
 
-      # Rails 5.1 changed the API of `ActiveRecord::Dirty`. See
-      # https://github.com/paper-trail-gem/paper_trail/pull/899
-      #
       # @api private
-      def changed_in_latest_version
-        if @in_after_callback && RAILS_GTE_5_1
-          @record.saved_changes.keys
-        else
-          @record.changed
-        end
-      end
-
-      # @api private
-      def prepare_object_changes(changes)
-        changes = serialize_object_changes(changes)
-        changes = recordable_object_changes(changes)
-        changes
-      end
-
-      # @api private
-      def serialize_object_changes(changes)
-        AttributeSerializers::ObjectChangesAttribute.
-          new(@record.class).
-          serialize(changes)
-        changes.to_hash
+      def changed_and_not_ignored
+        skip = @record.paper_trail_options[:skip]
+        (changed_in_latest_version - calculated_ignored_array) - skip
       end
 
       # @api private
-      def notable_changes
-        changes_in_latest_version.delete_if { |k, _v|
-          !notably_changed.include?(k)
-        }
+      def changed_in_latest_version
+        # Memoized to reduce memory usage
+        @changed_in_latest_version ||= changes_in_latest_version.keys
       end
 
       # Rails 5.1 changed the API of `ActiveRecord::Dirty`. See
@@ -145,10 +136,13 @@ module PaperTrail
       #
       # @api private
       def changes_in_latest_version
-        if @in_after_callback && RAILS_GTE_5_1
-          @record.saved_changes
-        else
-          @record.changes
+        # Memoized to reduce memory usage
+        @changes_in_latest_version ||= begin
+          if @in_after_callback && RAILS_GTE_5_1
+            @record.saved_changes
+          else
+            @record.changes
+          end
         end
       end
 
@@ -158,7 +152,7 @@ module PaperTrail
       #
       # @api private
       def ignored_attr_has_changed?
-        ignored = @record.paper_trail_options[:ignore] + @record.paper_trail_options[:skip]
+        ignored = calculated_ignored_array + @record.paper_trail_options[:skip]
         ignored.any? && (changed_in_latest_version & ignored).any?
       end
 
@@ -220,18 +214,28 @@ module PaperTrail
         end
       end
 
+      # @api private
+      def notable_changes
+        changes_in_latest_version.delete_if { |k, _v|
+          !notably_changed.include?(k)
+        }
+      end
+
       # @api private
       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)
-            }
+        # Memoized to reduce memory usage
+        @notably_changed ||= begin
+          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
-        only.empty? ? changed_and_not_ignored : (changed_and_not_ignored & only)
       end
 
       # Returns hash of attributes (with appropriate attributes serialized),
@@ -239,12 +243,17 @@ module PaperTrail
       #
       # @api private
       def object_attrs_for_paper_trail(is_touch)
-        attrs = attributes_before_change(is_touch).
-          except(*@record.paper_trail_options[:skip])
+        attrs = nonskipped_attributes_before_change(is_touch)
         AttributeSerializers::ObjectAttribute.new(@record.class).serialize(attrs)
         attrs
       end
 
+      # @api private
+      def prepare_object_changes(changes)
+        changes = serialize_object_changes(changes)
+        recordable_object_changes(changes)
+      end
+
       # 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,
@@ -252,9 +261,14 @@ module PaperTrail
       # serialization here, using `PaperTrail.serializer`.
       #
       # @api private
+      # @param changes HashWithIndifferentAccess
       def recordable_object_changes(changes)
         if PaperTrail.config.object_changes_adapter&.respond_to?(:diff)
-          changes = PaperTrail.config.object_changes_adapter.diff(changes)
+          # We'd like to avoid the `to_hash` here, because it increases memory
+          # usage, but that would be a breaking change because
+          # `object_changes_adapter` expects a plain `Hash`, not a
+          # `HashWithIndifferentAccess`.
+          changes = PaperTrail.config.object_changes_adapter.diff(changes.to_hash)
         end
 
         if @record.class.paper_trail.version_class.object_changes_col_is_json?
@@ -293,6 +307,17 @@ module PaperTrail
           PaperTrail.serializer.dump(object_attrs_for_paper_trail(is_touch))
         end
       end
+
+      # @api private
+      def serialize_object_changes(changes)
+        AttributeSerializers::ObjectChangesAttribute.
+          new(@record.class).
+          serialize(changes)
+
+        # We'd like to convert this `HashWithIndifferentAccess` to a plain
+        # `Hash`, but we don't, to save memory.
+        changes
+      end
     end
   end
 end

data/lib/paper_trail/events/create.rb

@@ -13,6 +13,7 @@ module PaperTrail
       # @api private
       def data
         data = {
+          item: @record,
           event: @record.paper_trail_event || "create",
           whodunnit: PaperTrail.request.whodunnit
         }

data/lib/paper_trail/events/destroy.rb

@@ -22,13 +22,21 @@ module PaperTrail
           data[:object] = recordable_object(false)
         end
         if record_object_changes?
-          # Rails' implementation returns nothing on destroy :/
-          changes = @record.attributes.map { |attr, value| [attr, [value, nil]] }.to_h
-          data[:object_changes] = prepare_object_changes(changes)
+          data[:object_changes] = prepare_object_changes(notable_changes)
         end
         merge_item_subtype_into(data)
         merge_metadata_into(data)
       end
+
+      private
+
+      # Rails' implementation (eg. `@record.saved_changes`) returns nothing on
+      # destroy, so we have to build the hash we want.
+      #
+      # @override
+      def changes_in_latest_version
+        @record.attributes.map { |attr, value| [attr, [value, nil]] }.to_h
+      end
     end
   end
 end

data/lib/paper_trail/events/update.rb

@@ -25,6 +25,7 @@ module PaperTrail
       # @api private
       def data
         data = {
+          item: @record,
           event: @record.paper_trail_event || "update",
           whodunnit: PaperTrail.request.whodunnit
         }

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

@@ -25,9 +25,7 @@ module PaperTrail
       # @api public
       def user_for_paper_trail
         return unless defined?(current_user)
-        ActiveSupport::VERSION::MAJOR >= 4 ? current_user.try!(:id) : current_user.try(:id)
-      rescue NoMethodError
-        current_user
+        current_user.try(:id) || current_user
       end
 
       # Returns any information about the controller or request that you

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

@@ -4,11 +4,42 @@ module PaperTrail
   module Rails
     # See http://guides.rubyonrails.org/engines.html
     class Engine < ::Rails::Engine
+      DPR_CONFIG_ENABLED = <<~EOS.squish.freeze
+        The rails configuration option config.paper_trail.enabled is deprecated.
+        Please use PaperTrail.enabled= instead. People were getting confused
+        that PT has both, specifically regarding *when* each was happening. If
+        you'd like to keep config.paper_trail, join the discussion at
+        https://github.com/paper-trail-gem/paper_trail/pull/1176
+      EOS
+      private_constant :DPR_CONFIG_ENABLED
+      DPR_RUDELY_ENABLING = <<~EOS.squish.freeze
+        At some point early in the rails boot process, you have set
+        PaperTrail.enabled = false. PT's rails engine is now overriding your
+        setting, and setting it to true. We're not sure why, but this is how PT
+        has worked since 5.0, when the config.paper_trail.enabled option was
+        introduced. This is now deprecated. In the future, PT will not override
+        your setting. See
+        https://github.com/paper-trail-gem/paper_trail/pull/1176 for discussion.
+      EOS
+      private_constant :DPR_RUDELY_ENABLING
+
       paths["app/models"] << "lib/paper_trail/frameworks/active_record/models"
+
+      # --- Begin deprecated section ---
       config.paper_trail = ActiveSupport::OrderedOptions.new
       initializer "paper_trail.initialisation" do |app|
-        PaperTrail.enabled = app.config.paper_trail.fetch(:enabled, true)
+        enable = app.config.paper_trail[:enabled]
+        if enable.nil?
+          unless PaperTrail.enabled?
+            ::ActiveSupport::Deprecation.warn(DPR_RUDELY_ENABLING)
+            PaperTrail.enabled = true
+          end
+        else
+          ::ActiveSupport::Deprecation.warn(DPR_CONFIG_ENABLED)
+          PaperTrail.enabled = enable
+        end
       end
+      # --- End deprecated section ---
     end
   end
 end

data/lib/paper_trail/model_config.rb

@@ -18,6 +18,11 @@ module PaperTrail
       `abstract_class`. This is fine, but all application models must be
       configured to use concrete (not abstract) version models.
     STR
+    E_MODEL_LIMIT_REQUIRES_ITEM_SUBTYPE = <<~STR.squish.freeze
+      To use PaperTrail's per-model limit in your %s model, you must have an
+      item_subtype column in your versions table. See documentation sections
+      2.e.1 Per-model limit, and 4.b.1 The optional item_subtype column.
+    STR
     DPR_PASSING_ASSOC_NAME_DIRECTLY_TO_VERSIONS_OPTION = <<~STR.squish
       Passing versions association name as `has_paper_trail versions: %{versions_name}`
       is deprecated. Use `has_paper_trail versions: {name: %{versions_name}}` instead.
@@ -112,6 +117,7 @@ module PaperTrail
       @model_class.send :include, ::PaperTrail::Model::InstanceMethods
       setup_options(options)
       setup_associations(options)
+      check_presence_of_item_subtype_column(options)
       @model_class.after_rollback { paper_trail.clear_rolled_back_versions }
       setup_callbacks_from_options options[:on]
     end
@@ -122,10 +128,6 @@ module PaperTrail
 
     private
 
-    def active_record_gem_version
-      Gem::Version.new(ActiveRecord::VERSION::STRING)
-    end
-
     # Raises an error if the provided class is an `abstract_class`.
     # @api private
     def assert_concrete_activerecord_class(class_name)
@@ -135,8 +137,17 @@ module PaperTrail
     end
 
     def cannot_record_after_destroy?
-      Gem::Version.new(ActiveRecord::VERSION::STRING).release >= Gem::Version.new("5") &&
-        ::ActiveRecord::Base.belongs_to_required_by_default
+      ::ActiveRecord::Base.belongs_to_required_by_default
+    end
+
+    # Some options require the presence of the `item_subtype` column. Currently
+    # only `limit`, but in the future there may be others.
+    #
+    # @api private
+    def check_presence_of_item_subtype_column(options)
+      return unless options.key?(:limit)
+      return if version_class.item_subtype_column_present?
+      raise format(E_MODEL_LIMIT_REQUIRES_ITEM_SUBTYPE, @model_class.name)
     end
 
     def check_version_class_name(options)

data/lib/paper_trail/record_trail.rb

@@ -67,14 +67,14 @@ module PaperTrail
 
     def record_create
       return unless enabled?
-      event = Events::Create.new(@record, true)
 
-      # 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)
-
-      versions_assoc = @record.send(@record.class.versions_association_name)
-      versions_assoc.create!(data)
+      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
     end
 
     # PT-AT extends this method to add its transaction id.
@@ -119,19 +119,22 @@ module PaperTrail
     # paper_trail-association_tracking
     def record_update(force:, in_after_callback:, is_touch:)
       return unless enabled?
-      event = Events::Update.new(@record, in_after_callback, is_touch, nil)
-      return unless force || event.changed_notably?
 
-      # Merge data from `Event` with data from PT-AT. We no longer use
-      # `data_for_update` but PT-AT still does.
-      data = event.data.merge(data_for_update)
+      version = build_version_on_update(
+        force: force,
+        in_after_callback: in_after_callback,
+        is_touch: is_touch
+      )
+      return unless version
 
-      versions_assoc = @record.send(@record.class.versions_association_name)
-      version = versions_assoc.create(data)
-      if version.errors.any?
-        log_version_errors(version, :update)
-      else
+      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
+        log_version_errors(version, :update)
       end
     end
 
@@ -250,6 +253,35 @@ module PaperTrail
       @record.send(@record.class.versions_association_name).reset
     end
 
+    # @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
+
+    # @api private
+    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?
+
+      # 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 = event.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
+
     def log_version_errors(version, action)
       version.logger&.warn(
         "Unable to create version for #{action} of #{@record.class.name}" \

data/lib/paper_trail/reifier.rb

@@ -52,23 +52,23 @@ module PaperTrail
       # not the actual subclass. If `type` is present but empty, the class is
       # the base class.
       def init_model(attrs, options, version)
-        if options[:dup] != true && version.item
-          model = version.item
-          if options[:unversioned_attributes] == :nil
-            init_unversioned_attrs(attrs, model)
-          end
-        else
-          klass = version_reification_class(version, attrs)
-          # The `dup` option always returns a new object, otherwise we should
-          # attempt to look for the item outside of default scope(s).
-          find_cond = { klass.primary_key => version.item_id }
-          if options[:dup] || (item_found = klass.unscoped.where(find_cond).first).nil?
-            model = klass.new
-          elsif options[:unversioned_attributes] == :nil
-            model = item_found
-            init_unversioned_attrs(attrs, model)
-          end
+        klass = version_reification_class(version, attrs)
+
+        # The `dup` option and destroyed version always returns a new object,
+        # otherwise we should attempt to load item or to look for the item
+        # outside of default scope(s).
+        model = if options[:dup] == true || version.event == "destroy"
+                  klass.new
+                else
+                  find_cond = { klass.primary_key => version.item_id }
+
+                  version.item || klass.unscoped.where(find_cond).first || klass.new
+                end
+
+        if options[:unversioned_attributes] == :nil && !model.new_record?
+          init_unversioned_attrs(attrs, model)
         end
+
         model
       end
 
@@ -88,9 +88,7 @@ module PaperTrail
       #
       # @api private
       def reify_attribute(k, v, model, version)
-        enums = model.class.respond_to?(:defined_enums) ? model.class.defined_enums : {}
-        is_enum_without_type_caster = ::ActiveRecord::VERSION::MAJOR < 5 && enums.key?(k)
-        if model.has_attribute?(k) && !is_enum_without_type_caster
+        if model.has_attribute?(k)
           model[k.to_sym] = v
         elsif model.respond_to?("#{k}=")
           model.send("#{k}=", v)
@@ -120,6 +118,7 @@ module PaperTrail
       # this method returns the constant `Animal`. You can see this particular
       # example in action in `spec/models/animal_spec.rb`.
       #
+      # TODO: Duplication: similar `constantize` in VersionConcern#version_limit
       def version_reification_class(version, attrs)
         inheritance_column_name = version.item_type.constantize.inheritance_column
         inher_col_value = attrs[inheritance_column_name]

data/lib/paper_trail/serializers/yaml.rb

@@ -12,7 +12,12 @@ module PaperTrail
         ::YAML.load string
       end
 
+      # @param object (Hash | HashWithIndifferentAccess) - Coming from
+      # `recordable_object` `object` will be a plain `Hash`. However, due to
+      # recent [memory optimizations](https://git.io/fjeYv), when coming from
+      # `recordable_object_changes`, it will be a `HashWithIndifferentAccess`.
       def dump(object)
+        object = object.to_hash if object.is_a?(HashWithIndifferentAccess)
         ::YAML.dump object
       end
 

data/lib/paper_trail/version_concern.rb

@@ -25,6 +25,10 @@ module PaperTrail
 
     # :nodoc:
     module ClassMethods
+      def item_subtype_column_present?
+        column_names.include?("item_subtype")
+      end
+
       def with_item_keys(item_type, item_id)
         where item_type: item_type, item_id: item_id
       end
@@ -141,6 +145,7 @@ module PaperTrail
       #   Default: false.
       # @return `ActiveRecord::Relation`
       # @api public
+      # rubocop:disable Style/OptionalBooleanParameter
       def preceding(obj, timestamp_arg = false)
         if timestamp_arg != true && primary_key_is_int?
           preceding_by_id(obj)
@@ -148,6 +153,7 @@ module PaperTrail
           preceding_by_timestamp(obj)
         end
       end
+      # rubocop:enable Style/OptionalBooleanParameter
 
       # Returns versions after `obj`.
       #
@@ -156,6 +162,7 @@ module PaperTrail
       #   Default: false.
       # @return `ActiveRecord::Relation`
       # @api public
+      # rubocop:disable Style/OptionalBooleanParameter
       def subsequent(obj, timestamp_arg = false)
         if timestamp_arg != true && primary_key_is_int?
           subsequent_by_id(obj)
@@ -163,6 +170,7 @@ module PaperTrail
           subsequent_by_timestamp(obj)
         end
       end
+      # rubocop:enable Style/OptionalBooleanParameter
 
       private
 
@@ -201,18 +209,8 @@ module PaperTrail
 
     # Restore the item from this version.
     #
-    # Optionally this can also restore all :has_one and :has_many (including
-    # has_many :through) associations as they were "at the time", if they are
-    # also being versioned by PaperTrail.
-    #
     # Options:
     #
-    # - :has_one
-    #   - `true` - Also reify has_one associations.
-    #   - `false - Default.
-    # - :has_many
-    #   - `true` - Also reify has_many and has_many :through associations.
-    #   - `false` - Default.
     # - :mark_for_destruction
     #   - `true` - Mark the has_one/has_many associations that did not exist in
     #     the reified version for destruction, instead of removing them.
@@ -254,13 +252,6 @@ module PaperTrail
     end
     alias version_author terminator
 
-    def sibling_versions(reload = false)
-      if reload || !defined?(@sibling_versions) || @sibling_versions.nil?
-        @sibling_versions = self.class.with_item_keys(item_type, item_id)
-      end
-      @sibling_versions
-    end
-
     def next
       @next ||= sibling_versions.subsequent(self).first
     end
@@ -270,8 +261,9 @@ module PaperTrail
     end
 
     # Returns an integer representing the chronological position of the
-    # version among its siblings (see `sibling_versions`). The "create" event,
-    # for example, has an index of 0.
+    # version among its siblings. The "create" event, for example, has an index
+    # of 0.
+    #
     # @api public
     def index
       @index ||= RecordHistory.new(sibling_versions, self.class).index(self)
@@ -329,7 +321,7 @@ module PaperTrail
     # Enforces the `version_limit`, if set. Default: no limit.
     # @api private
     def enforce_version_limit!
-      limit = PaperTrail.config.version_limit
+      limit = version_limit
       return unless limit.is_a? Numeric
       previous_versions = sibling_versions.not_creates.
         order(self.class.timestamp_sort_order("asc"))
@@ -337,5 +329,26 @@ module PaperTrail
       excess_versions = previous_versions - previous_versions.last(limit)
       excess_versions.map(&:destroy)
     end
+
+    # @api private
+    def sibling_versions
+      @sibling_versions ||= self.class.with_item_keys(item_type, item_id)
+    end
+
+    # See docs section 2.e. Limiting the Number of Versions Created.
+    # The version limit can be global or per-model.
+    #
+    # @api private
+    #
+    # TODO: Duplication: similar `constantize` in Reifier#version_reification_class
+    def version_limit
+      if self.class.item_subtype_column_present?
+        klass = (item_subtype || item_type).constantize
+        if klass&.paper_trail_options&.key?(:limit)
+          return klass.paper_trail_options[:limit]
+        end
+      end
+      PaperTrail.config.version_limit
+    end
   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 = 10
-    MINOR = 1
+    MAJOR = 11
+    MINOR = 0
     TINY = 0
 
     # Set PRE to nil unless it's a pre-release (beta, rc, etc.)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paper_trail
 version: !ruby/object:Gem::Version
-  version: 10.1.0
+  version: 11.0.0
 platform: ruby
 authors:
 - Andy Stewart
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-04 00:00:00.000000000 Z
+date: 2020-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -18,20 +18,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: request_store
   requirement: !ruby/object:Gem::Requirement
@@ -66,28 +60,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.0'
 - !ruby/object:Gem::Dependency
   name: ffaker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '2.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '2.11'
 - !ruby/object:Gem::Dependency
   name: generator_spec
   requirement: !ruby/object:Gem::Requirement
@@ -103,117 +97,137 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.9.4
 - !ruby/object:Gem::Dependency
-  name: mysql2
+  name: memory_profiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.2
+        version: 0.9.14
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.2
+        version: 0.9.14
 - !ruby/object:Gem::Dependency
-  name: paper_trail-association_tracking
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: pg
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: 0.89.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: 0.89.1
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: 1.7.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: 1.7.1
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.58.2
+        version: 1.42.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.58.2
+        version: 1.42.0
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.28.0
+        version: '0.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.28.0
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.18'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.18'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
 description: |
   Track changes to your models, for auditing or versioning. See how a model looked
   at any stage in its lifecycle, revert it to any version, or restore it after it
@@ -227,7 +241,6 @@ files:
 - lib/generators/paper_trail/install/install_generator.rb
 - lib/generators/paper_trail/install/templates/add_object_changes_to_versions.rb.erb
 - lib/generators/paper_trail/install/templates/create_versions.rb.erb
-- lib/generators/paper_trail/install_generator.rb
 - lib/generators/paper_trail/migration_generator.rb
 - lib/generators/paper_trail/update_item_subtype/USAGE
 - lib/generators/paper_trail/update_item_subtype/templates/update_versions_for_item_subtype.rb.erb
@@ -239,6 +252,7 @@ files:
 - lib/paper_trail/attribute_serializers/object_attribute.rb
 - lib/paper_trail/attribute_serializers/object_changes_attribute.rb
 - lib/paper_trail/cleaner.rb
+- lib/paper_trail/compatibility.rb
 - lib/paper_trail/config.rb
 - lib/paper_trail/events/base.rb
 - lib/paper_trail/events/create.rb
@@ -277,15 +291,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Track changes to your models.

data/lib/generators/paper_trail/install_generator.rb

@@ -1,99 +0,0 @@
-# frozen_string_literal: true
-
-require "rails/generators"
-require "rails/generators/active_record"
-
-module PaperTrail
-  # Installs PaperTrail in a rails app.
-  class InstallGenerator < ::Rails::Generators::Base
-    include ::Rails::Generators::Migration
-
-    # Class names of MySQL adapters.
-    # - `MysqlAdapter` - Used by gems: `mysql`, `activerecord-jdbcmysql-adapter`.
-    # - `Mysql2Adapter` - Used by `mysql2` gem.
-    MYSQL_ADAPTERS = [
-      "ActiveRecord::ConnectionAdapters::MysqlAdapter",
-      "ActiveRecord::ConnectionAdapters::Mysql2Adapter"
-    ].freeze
-
-    source_root File.expand_path("templates", __dir__)
-    class_option(
-      :with_changes,
-      type: :boolean,
-      default: false,
-      desc: "Store changeset (diff) with each version"
-    )
-
-    desc "Generates (but does not run) a migration to add a versions table."
-
-    def create_migration_file
-      add_paper_trail_migration("create_versions")
-      add_paper_trail_migration("add_object_changes_to_versions") if options.with_changes?
-    end
-
-    def self.next_migration_number(dirname)
-      ::ActiveRecord::Generators::Base.next_migration_number(dirname)
-    end
-
-    protected
-
-    def add_paper_trail_migration(template)
-      migration_dir = File.expand_path("db/migrate")
-      if self.class.migration_exists?(migration_dir, template)
-        ::Kernel.warn "Migration already exists: #{template}"
-      else
-        migration_template(
-          "#{template}.rb.erb",
-          "db/migrate/#{template}.rb",
-          item_type_options: item_type_options,
-          migration_version: migration_version,
-          versions_table_options: versions_table_options
-        )
-      end
-    end
-
-    private
-
-    # 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
-      opt = { null: false }
-      opt[:limit] = 191 if mysql?
-      ", #{opt}"
-    end
-
-    def migration_version
-      major = ActiveRecord::VERSION::MAJOR
-      if major >= 5
-        "[#{major}.#{ActiveRecord::VERSION::MINOR}]"
-      end
-    end
-
-    def mysql?
-      MYSQL_ADAPTERS.include?(ActiveRecord::Base.connection.class.name)
-    end
-
-    # Even modern versions of MySQL still use `latin1` as the default character
-    # encoding. Many users are not aware of this, and run into trouble when they
-    # try to use PaperTrail in apps that otherwise tend to use UTF-8. Postgres, by
-    # comparison, uses UTF-8 except in the unusual case where the OS is configured
-    # with a custom locale.
-    #
-    # - https://dev.mysql.com/doc/refman/5.7/en/charset-applications.html
-    # - http://www.postgresql.org/docs/9.4/static/multibyte.html
-    #
-    # Furthermore, MySQL's original implementation of UTF-8 was flawed, and had
-    # to be fixed later by introducing a new charset, `utf8mb4`.
-    #
-    # - https://mathiasbynens.be/notes/mysql-utf8mb4
-    # - https://dev.mysql.com/doc/refman/5.5/en/charset-unicode-utf8mb4.html
-    #
-    def versions_table_options
-      if mysql?
-        ', { options: "ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci" }'
-      else
-        ""
-      end
-    end
-  end
-end