iron_trail 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 205a181e1b361753b39576a57dbee4503b62573314c52d91044acbdcd60c26b0
-  data.tar.gz: 41f13486979881ee2e23b5247f949c23bddca34f27d3aa5bbaf348f32e9a1673
+  metadata.gz: 4c4a5962c8262c61d0909615b33cf39567699f0feea5b54337818431bc8b6d7d
+  data.tar.gz: 75942627d8daef67d5fd92a0eb75a8a738bab22a317963f95a487e184d587f35
 SHA512:
-  metadata.gz: df308cd9a427c4069178c7304c9b823070db8474d9556a45c9d4a1eb5d0c3edfef70a3d250cc564648c96ce44e57576fdb78e2b3fe30a9ce4682f6824b56497f
-  data.tar.gz: 448ffb8f0440aa63a927b0e41925fd63a48ed1b2b50b68c7f2b205569c3e2de250cbc9f44ca5297bf06c3b8d9d53517796d16afe966fff589779f31c959c4189
+  metadata.gz: 90d7d85c0a098bceb555e40a6c513ae3cd3c5d7694cb71d579a719fbf80c7df6ed6a92dc9196648a80d6551d610d84da221d9dc4276089a67ab0c7578d616f75
+  data.tar.gz: 38e04491986b4d4c0929541c613ad522396c570f132beb289ed75385b7f4de3a168eea450623cb34495f8b4a12e8b668a21f19091da6460d23f0de7b59911730

data/lib/iron_trail/change_model_concern.rb

@@ -4,13 +4,49 @@ module IronTrail
   module ChangeModelConcern
     extend ::ActiveSupport::Concern
 
+    def insert_operation? = (operation == 'i')
+    def update_operation? = (operation == 'u')
+    def delete_operation? = (operation == 'd')
+
     def reify
       Reifier.reify(self)
     end
 
-    def insert_operation? = (operation == 'i')
-    def update_operation? = (operation == 'u')
-    def delete_operation? = (operation == 'd')
+    # We don't store the class name of the object, but we do store the rec_table.
+    # This method infers the class name from the rec_table and also the "type"
+    # attribute in the stored object in case it's a rails STI class.
+    #
+    # It returns the class instance. Raises an error in case the class couldn't
+    # be inferred.
+    def rec_class
+      source_attributes = (delete_operation? ? rec_old : rec_new)
+      Reifier.model_from_table_name(rec_table, source_attributes.fetch('type', nil))
+    end
+
+    # This mimics the method with the same name available in the papertrail gem.
+    # It is an extended rec_delta, where attributes values are properly deserialized
+    # as rails' ActiveRecord would do.
+    #
+    # For instance, timestamps are serialized as strings in JSON, so rec_delta
+    # would return strings for timestamps. Using this method, it'd return a proper
+    # timestamp deserialized from the string.
+    #
+    # This method doesn't do caching and always computes the full thing. It's
+    # up to the user to perform caching if wanted.
+    def compute_changeset
+      return nil unless update_operation?
+
+      klass = rec_class
+
+      HashWithIndifferentAccess.new.tap do |changes|
+        rec_delta.each do |col_name, in_delta|
+          type_class = klass.type_for_attribute(col_name)
+          out_delta = in_delta.map { |val| type_class.deserialize(val) }
+
+          changes[col_name] = out_delta
+        end
+      end
+    end
 
     module ClassMethods
       def where_object_changes_to(args = {})
@@ -21,6 +57,22 @@ module IronTrail
         _where_object_changes(0, args)
       end
 
+      # Allows filtering out updates that changed just a certain set of columns.
+      # This could be useful, for instance, to filter out updates made with
+      # ActiveRecord's #touch method, which changes only the updated_at column.
+      # In that case, calling `.with_delta_other_than(:updated_at)` would exclude
+      # such changes from the result.
+      #
+      # This works by inspecting whether there are any keys in the rec_delta column
+      # other than the columns specified in the `columns` parameter.
+      def with_delta_other_than(*columns)
+        quoted_columns = columns.map { |col_name| connection.quote(col_name) }
+        exclude_array = "ARRAY[#{quoted_columns.join(', ')}]::text[]"
+
+        sql = "rec_delta IS NULL OR (rec_delta - #{exclude_array}) <> '{}'::jsonb"
+        where(::Arel::Nodes::SqlLiteral.new(sql))
+      end
+
       private
 
       def _where_object_changes(ary_index, args)

data/lib/iron_trail/current.rb

@@ -10,6 +10,8 @@ module IronTrail
     end
 
     def self.merge_metadata(keys, merge_hash)
+      raise TypeError.new("value must be a Hash") unless merge_hash.is_a?(Hash)
+
       self.metadata ||= {}
       base = self.metadata
       keys.each do |key|

data/lib/iron_trail/reifier.rb

@@ -10,9 +10,8 @@ module IronTrail
 
       source_attributes.each do |name, value|
         if record.has_attribute?(name)
-          record[name.to_sym] = value
-        elsif record.respond_to?("#{name}=")
-          record.send("#{name}=", value)
+          attr_type = record.type_for_attribute(name)
+          record[name] = attr_type.deserialize(value)
         else
           ghost = record.instance_variable_get(:@irontrail_reified_ghost_attributes)
           unless ghost

data/lib/iron_trail/testing/rspec.rb

@@ -9,6 +9,20 @@ require 'iron_trail'
 
 module IronTrail
   module Testing
+    module InstanceMethods
+      def irontrail_set_actor(actor)
+        if actor.nil?
+          IronTrail::Current.metadata.delete(:_actor_type)
+          IronTrail::Current.metadata.delete(:_actor_id)
+        else
+          IronTrail::Current.merge_metadata([], {
+            _actor_type: actor.class.name,
+            _actor_id: actor.id
+          })
+        end
+      end
+    end
+
     class << self
       attr_accessor :enabled
 
@@ -56,11 +70,18 @@ module IronTrail
 end
 
 RSpec.configure do |config|
+  config.include ::IronTrail::Testing::InstanceMethods
+
   config.around(:each, iron_trail: true) do |example|
     IronTrail::Testing.with_iron_trail(want_enabled: true) { example.run }
   end
+
   config.around(:each, iron_trail: false) do |example|
     raise "Using iron_trail: false does not do what you might think it does. To disable iron_trail, " \
       "use IronTrail::Testing.with_iron_trail(want_enabled: false) { ... } instead."
   end
+
+  config.before(:each) do
+    IronTrail::Current.reset
+  end
 end

data/lib/iron_trail/version.rb

@@ -1,5 +1,5 @@
 # frozen_literal_string: true
 
 module IronTrail
-  VERSION = '0.1.4'
+  VERSION = '0.1.6'
 end

data/lib/iron_trail.rb

@@ -30,7 +30,9 @@ module IronTrail
 
   module SchemaDumper
     def trailer(stream)
-      stream.print "\n  IronTrail.post_schema_load(self, missing_tracking: @irontrail_missing_track)\n"
+      if IronTrail.enabled?
+        stream.print "\n  IronTrail.post_schema_load(self, missing_tracking: @irontrail_missing_track)\n"
+      end
 
       super(stream)
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: iron_trail
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - André Diego Piske
 bindir: bin
 cert_chain: []
-date: 2025-02-24 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -160,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Creates a trail strong as iron
 test_files: []