hoardable 0.19.2 → 0.19.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: affe4a55357ac085a712046c50d2742c7f1887947dee2a7e4d221cf5c7fd7086
-  data.tar.gz: 7b2112637801d32e5f18a93d3aa54077e631d25fd9ef6a85639770910d87024b
+  metadata.gz: 27747103c387757c5faf3cf3771651d221d67b8367d5b6f6623a34c43b3afe9d
+  data.tar.gz: 4abd9206358508019a69273c33fe9d772ad28b9ea4f76f85f499315b17bd99c2
 SHA512:
-  metadata.gz: dfdf425df919edd8abce1942108881469c3c29b4e3e0ac9641ab56c221a6c0496f73ae7b6c657aa3edf33ae31b265e15d245e1e4d6e41fedbcbc7983af0657f9
-  data.tar.gz: 04b2495a301dd95bdd8d7f4af56ea6cf6dac682d7da59e59dee6d40ed031451410344a34f9580551047985009fc17e5ce1ac0e6d83c0a6f531ec071e932788d7
+  metadata.gz: a771a19b506f170a17fd672219a4899dcbfebc55e9ab2422a2d22198d0efd6c13667e5fbb2c69e1da724222bb9f9923fc4263f7b3ae14b3e260c62cc22eb42fd
+  data.tar.gz: c8eab3064758767b33f46943f0e09544e096545ad3f436c3b43e237d5be6e11589bc7840241561ddd04f860a1371656285badcd3a890cc003244829d6abf4010

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.19.3
+
+- Support providing `event_uuid` in `with`.
+
 ## 0.19.2
 
 - Consult `inheritance_column` when constructing default scope

data/lib/hoardable/database_client.rb

@@ -19,7 +19,7 @@ module Hoardable
           returning: source_primary_key.to_sym
         )
       version_id = version[0][source_primary_key]
-      source_record.instance_variable_set("@hoardable_version", version_class.find(version_id))
+      source_record.instance_variable_set(:@hoardable_version, version_class.find(version_id))
       source_record.run_callbacks(:versioned, &block)
     end
 
@@ -28,7 +28,8 @@ module Hoardable
     end
 
     def find_or_initialize_hoardable_event_uuid
-      Thread.current[:hoardable_event_uuid] ||= SecureRandom.uuid
+      Thread.current[:hoardable_event_uuid] ||= Thread.current[:contextual_event_uuid] ||
+        SecureRandom.uuid
     end
 
     def initialize_version_attributes(operation)
@@ -92,7 +93,7 @@ module Hoardable
 
     def initialize_temporal_range
       upper_bound = Thread.current[:hoardable_travel_to] || Time.now.utc
-      lower_bound = (previous_temporal_tsrange_end || hoardable_source_epoch)
+      lower_bound = previous_temporal_tsrange_end || hoardable_source_epoch
 
       if upper_bound < lower_bound
         raise InvalidTemporalUpperBoundError.new(upper_bound, lower_bound)
@@ -112,7 +113,7 @@ module Hoardable
     end
 
     def unset_hoardable_version_and_event_uuid
-      source_record.instance_variable_set("@hoardable_version", nil)
+      source_record.instance_variable_set(:@hoardable_version, nil)
       return if source_record.class.connection.transaction_open?
 
       Thread.current[:hoardable_event_uuid] = nil

data/lib/hoardable/engine.rb

@@ -46,13 +46,13 @@ module Hoardable
     CONFIG_KEYS.each do |key|
       define_method(key) { hoardable_config[key] }
 
-      define_method("#{key}=") { |value| @config[key] = value }
+      define_method(:"#{key}=") { |value| @config[key] = value }
     end
 
     DATA_KEYS.each do |key|
       define_method(key) { hoardable_context[key] }
 
-      define_method("#{key}=") { |value| @context[key] = value }
+      define_method(:"#{key}=") { |value| @context[key] = value }
     end
 
     # This is a general use method for setting {file:README.md#tracking-contextual-data Contextual
@@ -63,18 +63,32 @@ module Hoardable
       thread = Thread.current
       current_thread_config = thread[:hoardable_config]
       current_thread_context = thread[:hoardable_context]
+
+      if hash.include?(:event_uuid)
+        contextual_event_uuid = hash[:event_uuid]
+        unless valid_event_uuid?(contextual_event_uuid)
+          raise InvalidEventUUID, contextual_event_uuid
+        end
+        thread[:contextual_event_uuid] = contextual_event_uuid
+      end
+
       thread[:hoardable_config] = hoardable_config.merge(hash.slice(*CONFIG_KEYS))
       thread[:hoardable_context] = hoardable_context.merge(hash.slice(*DATA_KEYS))
       yield
     ensure
       thread[:hoardable_config] = current_thread_config
       thread[:hoardable_context] = current_thread_context
+      thread[:contextual_event_uuid] = nil
     end
 
     private def hoardable_config
       @config.merge(Thread.current[:hoardable_config] ||= {})
     end
 
+    private def valid_event_uuid?(value)
+      /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.match?(value.to_s.downcase)
+    end
+
     private def hoardable_context
       @context.merge(Thread.current[:hoardable_context] ||= {})
     end
@@ -122,7 +136,7 @@ module Hoardable
     initializer "hoardable.schema_statements" do
       ActiveSupport.on_load(:active_record_postgresqladapter) do
         # We need to control the table dumping order of tables, so revert these to just +super+
-        Fx::SchemaDumper.module_eval("def tables(streams); super; end")
+        Fx::SchemaDumper.module_eval("def tables(streams); super; end", __FILE__, __LINE__)
 
         ActiveRecord::ConnectionAdapters::PostgreSQL::SchemaDumper.prepend(SchemaDumper)
         ActiveRecord::ConnectionAdapters::PostgreSQL::SchemaStatements.prepend(SchemaStatements)

data/lib/hoardable/error.rb

@@ -9,9 +9,9 @@ module Hoardable
   class CreatedAtColumnMissingError < Error
     def initialize(source_table_name)
       super(<<~LOG)
-          '#{source_table_name}' does not have a 'created_at' column, so the start of the first
-          version’s temporal period cannot be known. Add a 'created_at' column to '#{source_table_name}'.
-        LOG
+        '#{source_table_name}' does not have a 'created_at' column, so the start of the first
+        version’s temporal period cannot be known. Add a 'created_at' column to '#{source_table_name}'.
+      LOG
     end
   end
 
@@ -19,9 +19,9 @@ module Hoardable
   class UpdatedAtColumnMissingError < Error
     def initialize(source_table_name)
       super(<<~LOG)
-          '#{source_table_name}' does not have an 'updated_at' column, so Hoardable cannot look up
-          associated record versions with it. Add an 'updated_at' column to '#{source_table_name}'.
-        LOG
+        '#{source_table_name}' does not have an 'updated_at' column, so Hoardable cannot look up
+        associated record versions with it. Add an 'updated_at' column to '#{source_table_name}'.
+      LOG
     end
   end
 
@@ -29,9 +29,18 @@ module Hoardable
   class InvalidTemporalUpperBoundError < Error
     def initialize(upper, lower)
       super(<<~LOG)
-          'The supplied value to `Hoardable.travel_to` (#{upper}) is before the calculated lower bound (#{lower}).
-          You must provide a datetime > the lower bound.
-        LOG
+        'The supplied value to `Hoardable.travel_to` (#{upper}) is before the calculated lower bound (#{lower}).
+        You must provide a datetime > the lower bound.
+      LOG
+    end
+  end
+
+  # An error to be raised when an invalid (non-UUID) value is provided as an event_uuid
+  class InvalidEventUUID < Error
+    def initialize(value)
+      super(<<~LOG)
+        'The supplied 'event_uuid' value must be a valid UUID'
+      LOG
     end
   end
 end

data/lib/hoardable/schema_dumper.rb

@@ -10,6 +10,7 @@ module Hoardable
       super
       dump_inherited_tables(stream)
       empty_line(stream)
+      functions(stream)
       triggers(stream)
     end
 

data/lib/hoardable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Hoardable
-  VERSION = "0.19.2"
+  VERSION = "0.19.3"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: hoardable
 version: !ruby/object:Gem::Version
-  version: 0.19.2
+  version: 0.19.3
 platform: ruby
 authors:
 - justin talbott
 bindir: exe
 cert_chain: []
-date: 2025-04-08 00:00:00.000000000 Z
+date: 2025-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord