paper_trail 14.0.0 → 15.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8442e35802b28551f1ab7275a3e6a14fed55edcba6c1aa9beeff5e65a2a92626
-  data.tar.gz: 3014b42bde912764165fc14a8974b14cc16cdf9643a1f8c9af23083a4479c50d
+  metadata.gz: 3a343a4be31774100a8713280696dcfad46cd119b04de6884de7b6a1b34acd13
+  data.tar.gz: 120dfe293f08004ee33bb09a0db23d3004ea2dadfaff56e8992283564458df28
 SHA512:
-  metadata.gz: 57f5248c0e5d448dd20e88530f06e74fddcf641c1f13f6b9d7e33ef54305168e5f0bb34322c4db7b0b9b5fe9c7c988116a72b17605500061c43ffc67f0519f9d
-  data.tar.gz: 6d84306539336b774e8b9cd5f1f2412fa59752c6ceb3033af6be9652045e19d5e11f95555f47cdde3742bf18e6165addcde3e3d5a5b2c7b8df7ecc908b16d6eb
+  metadata.gz: 8401d4f39db71320590dab474b8782a4f52843394869d12aa3cb5270d25170df8435af7a1c97cdcb3b1acbd8841eacdfd0c905c681b6e1173b2e6c0a69e37af9
+  data.tar.gz: 0ec02b4a9ab72e45741ba79c8c4b09c524a02dc01de35b7763322eea5612112ae0be36e4a6dcf50c297b8bf8f0c5b96d78719d2f7839352b8d57c383d6fd250a

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

@@ -35,7 +35,8 @@ module PaperTrail
         "create_versions",
         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")
@@ -49,6 +50,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/create_versions.rb.erb

@@ -9,7 +9,7 @@ class CreateVersions < ActiveRecord::Migration<%= migration_version %>
   TEXT_BYTES = 1_073_741_823
 
   def change
-    create_table :versions<%= versions_table_options %> do |t|
+    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

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 PaperTrail.active_record_gte_7_0? && 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,12 @@ module PaperTrail
     class ObjectAttribute
       def initialize(model_class)
         @model_class = model_class
+
+        # ActiveRecord since 7.0 has a built-in encryption mechanism
+        @encrypted_attributes =
+          if PaperTrail.active_record_gte_7_0?
+            @model_class.encrypted_attributes&.map(&:to_s)
+          end
       end
 
       def serialize(attributes)
@@ -23,14 +29,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,12 @@ module PaperTrail
     class ObjectChangesAttribute
       def initialize(item_class)
         @item_class = item_class
+
+        # ActiveRecord since 7.0 has a built-in encryption mechanism
+        @encrypted_attributes =
+          if PaperTrail.active_record_gte_7_0?
+            @item_class.encrypted_attributes&.map(&:to_s)
+          end
       end
 
       def serialize(changes)
@@ -23,17 +29,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,7 +17,7 @@ module PaperTrail
   # newer rails versions. Most PT users should avoid incompatible rails
   # versions.
   module Compatibility
-    ACTIVERECORD_GTE = ">= 6.0" # enforced in gemspec
+    ACTIVERECORD_GTE = ">= 6.1" # enforced in gemspec
     ACTIVERECORD_LT = "< 7.1" # not enforced in gemspec
 
     E_INCOMPATIBLE_AR = <<-EOS

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.

data/lib/paper_trail/model_config.rb

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

data/lib/paper_trail/record_trail.rb

@@ -226,7 +226,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
 

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 = 15
     MINOR = 0
     TINY = 0
 

data/lib/paper_trail.rb

@@ -114,6 +114,10 @@ module PaperTrail
     def version
       VERSION::STRING
     end
+
+    def active_record_gte_7_0?
+      @active_record_gte_7_0 ||= ::ActiveRecord.gem_version >= ::Gem::Version.new("7.0.0")
+    end
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paper_trail
 version: !ruby/object:Gem::Version
-  version: 14.0.0
+  version: 15.0.0
 platform: ruby
 authors:
 - Andy Stewart
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-26 00:00:00.000000000 Z
+date: 2023-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: request_store
   requirement: !ruby/object:Gem::Requirement
@@ -116,14 +116,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -360,7 +360,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="