paper_trail 10.1.0 → 10.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac357832683a239eb259f30fea0d05701ddd634f
-  data.tar.gz: 1745e41be7c599090c4fd947822a30a6ad18b6ee
+  metadata.gz: 9a180f82e731345bd4b9f46971ee6ca61753f82e
+  data.tar.gz: c32cde31e4da02b078d13c8c2667a6b0c49c4110
 SHA512:
-  metadata.gz: efa1906f7569fd7cb9eab56ad5d70daed5739714cd52197e97e2057cdb311b3016c3b36c3b4992c1cb75cc26ede53e42b481424fedc4fc40f47adc3902c7f772
-  data.tar.gz: b4e4976c7273d397ea6a657debd40b4aa4354bce68b59c7e70bb28cf928e46c210d4085e44314d3aa8b3d8889fb46762375987bf904a989751d732056f54b592
+  metadata.gz: bd84d2586c73b9f08e44fabb1298a6e530ecf25953da0a05a41a925870720e6c05eb74474321816b51dd24cceb1d14b0658f685ac0c68a91de3ff6e7c2e0525b
+  data.tar.gz: fb8e6814903909666d842d43b68b5ef97e5c207a8193d34a5d199f8405fb83565c87ba86925c58148720debde25bdd442f712ef75b9acaf8b3d86a6c71978191

data/lib/paper_trail.rb

@@ -125,6 +125,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

data/lib/paper_trail/events/base.rb

@@ -106,38 +106,9 @@ module PaperTrail
         (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
-      end
-
-      # @api private
-      def notable_changes
-        changes_in_latest_version.delete_if { |k, _v|
-          !notably_changed.include?(k)
-        }
+        changes_in_latest_version.keys
       end
 
       # Rails 5.1 changed the API of `ActiveRecord::Dirty`. See
@@ -220,6 +191,13 @@ 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
@@ -245,6 +223,13 @@ module PaperTrail
         attrs
       end
 
+      # @api private
+      def prepare_object_changes(changes)
+        changes = serialize_object_changes(changes)
+        changes = recordable_object_changes(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,
@@ -293,6 +278,14 @@ 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)
+        changes.to_hash
+      end
     end
   end
 end

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/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/version_number.rb

@@ -8,7 +8,7 @@ module PaperTrail
   # People are encouraged to use `PaperTrail.gem_version` instead.
   module VERSION
     MAJOR = 10
-    MINOR = 1
+    MINOR = 2
     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: 10.2.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: 2019-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -21,7 +21,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -31,7 +31,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: request_store
   requirement: !ruby/object:Gem::Requirement
@@ -120,16 +120,16 @@ dependencies:
   name: paper_trail-association_tracking
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: 2.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -178,14 +178,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.58.2
+        version: 0.62.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.58.2
+        version: 0.62.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -285,7 +285,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14.3
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Track changes to your models.