journaled 6.3.0 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2df51c8d047c8d1da1965d65b85f944e0d6ed83d107f0d592044aad756e710a1
-  data.tar.gz: af858b83df468b03c32aec69cd5d0f2388a5c2f63fab459376c3735e06ee4e8a
+  metadata.gz: 7da8b60f6a6330d804f54a41a3e0ed2fcd4884e811542599088a9b9d7a9cef29
+  data.tar.gz: 489fa98f872666cb5c01a0edc0e4bed2fbc1ed481516cc3abfd363e4f9059f12
 SHA512:
-  metadata.gz: f9230302d408bb4d9ebd01947fb2f42e3ba06901f9860efa1b67d46a89bdc9292a2e3689ba3eebbb7d6a69a09556857f4f6e2029c92d03b3c06c76d0d9119611
-  data.tar.gz: 48494bebcb5bf352b19dfd74b52ac06ae99e156f4d209fba93e63386fcac01d893488192b8de95d4baeee148ce36918dfeb020e252624fd84114ca2a113c1844
+  metadata.gz: 2402f321700808215b5b4ecd9c316e575be1edecd043a9ee81b620178548f57ac54e8cf2646de707166162afe7c353f3fde4341222451bcfb7c30b35791b8291
+  data.tar.gz: 9c00a20d76b5ac214083d74460a99988513cb33f03d42ad75bf5a7690fc935a6cb04b9413a5d773a96b5f18948e02c988d77b256b5abade72c338b20f4f915cb

data/README.md

@@ -359,6 +359,17 @@ record is created or destroyed, an event will be sent to Kinesis with the follow
   * `actor` - a string (usually a rails global_id) representing who
     performed the action.
 
+Pass `tagged: true` to also include a `tags` field sourced from the current
+[tagged event](#tagged-events) context (e.g. `Journaled.tag!`/`Journaled.tagged`):
+
+```ruby
+journal_changes_to :email, :first_name, :last_name, as: :identity_change, tagged: true
+```
+
+This is useful for capturing metadata (like a session or visitor ID) that isn't
+itself a column on the model. It defaults to `false` to preserve the existing
+event shape for models that don't opt in.
+
 Callback-bypassing database methods like `update_all`, `delete_all`,
 `update_columns` and `delete` are intercepted and will require an
 additional `force: true` argument if they would interfere with change
@@ -847,6 +858,19 @@ gem version.
 
 As such, **we always recommend upgrading only one major version at a time.**
 
+### Upgrading from 6.x
+
+`journal_changes_to` now accepts a `tagged:` option (default `false`). This is
+opt-in at the Ruby level, so no application code needs to change to upgrade.
+
+However, the `journaled/change` JSON schema (`journaled_schemas/journaled/change.json`)
+now permits an optional `tags` property on every `Journaled::Change` event,
+regardless of whether any particular model opts in. If you (or a downstream
+consumer of this stream) validate `Journaled::Change` payloads against a copy
+of this schema, or against your own stricter schema, that schema needs to
+tolerate a `tags` field being present, since any model in the producing app
+could begin sending it independently of your consumer.
+
 ### Upgrading from 4.3.0
 
 Versions of Journaled prior to 5.0 would enqueue events one at a time, but 5.0

data/app/models/concerns/journaled/changes.rb

@@ -56,14 +56,18 @@ module Journaled::Changes
   end
 
   class_methods do
-    def journal_changes_to(*attribute_names, as:, enqueue_with: {})
+    def journal_changes_to(*attribute_names, as:, enqueue_with: {}, tagged: false)
       if attribute_names.empty? || attribute_names.any? { |n| !n.is_a?(Symbol) }
         raise "one or more symbol attribute_name arguments is required"
       end
 
       raise "as: must be a symbol" unless as.is_a?(Symbol)
 
-      _journaled_change_definitions << Journaled::ChangeDefinition.new(attribute_names: attribute_names, logical_operation: as)
+      _journaled_change_definitions << Journaled::ChangeDefinition.new(
+        attribute_names: attribute_names,
+        logical_operation: as,
+        tagged: tagged,
+      )
       journaled_attribute_names.concat(attribute_names)
       journaled_enqueue_opts.merge!(enqueue_with)
     end

data/app/models/journaled/change.rb

@@ -26,7 +26,8 @@ class Journaled::Change
                  changes:,
                  journaled_stream_name:,
                  journaled_enqueue_opts:,
-                 actor:)
+                 actor:,
+                 tagged: false)
     @table_name = table_name
     @record_id = record_id
     @database_operation = database_operation
@@ -35,5 +36,18 @@ class Journaled::Change
     @journaled_stream_name = journaled_stream_name
     @journaled_enqueue_opts = journaled_enqueue_opts
     @actor = actor
+    @tagged = tagged
+  end
+
+  def tagged?
+    @tagged
+  end
+
+  def tags
+    Journaled::Current.tags
+  end
+
+  def journaled_attributes
+    tagged? ? super.merge(tags:) : super
   end
 end

data/app/models/journaled/change_definition.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
 class Journaled::ChangeDefinition
-  attr_reader :attribute_names, :logical_operation
+  attr_reader :attribute_names, :logical_operation, :tagged
 
-  def initialize(attribute_names:, logical_operation:)
+  def initialize(attribute_names:, logical_operation:, tagged: false)
     @attribute_names = attribute_names.map(&:to_s)
     @logical_operation = logical_operation
+    @tagged = tagged
     @validated = false
   end
 

data/app/models/journaled/change_writer.rb

@@ -3,7 +3,7 @@
 class Journaled::ChangeWriter
   attr_reader :model, :change_definition
 
-  delegate :attribute_names, :logical_operation, to: :change_definition
+  delegate :attribute_names, :logical_operation, :tagged, to: :change_definition
 
   def initialize(model:, change_definition:)
     @model = model
@@ -33,6 +33,7 @@ class Journaled::ChangeWriter
       journaled_stream_name: journaled_stream_name,
       journaled_enqueue_opts: model.journaled_enqueue_opts,
       actor: actor_uri,
+      tagged: tagged,
     )
   end
 

data/journaled_schemas/journaled/change.json

@@ -41,6 +41,10 @@
     },
     "actor": {
       "type": ["string", null]
+    },
+    "tags": {
+      "type": "object",
+      "additionalProperties": true
     }
   }
 }

data/lib/journaled/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Journaled
-  VERSION = "6.3.0"
+  VERSION = "7.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: journaled
 version: !ruby/object:Gem::Version
-  version: 6.3.0
+  version: 7.0.0
 platform: ruby
 authors:
 - Jake Lipson