hoardable 0.19.0 → 0.19.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12ee4c5fbbd0b35bda5c9b7427015a1d60ca9cc919ac992caca386d4c3664163
-  data.tar.gz: 0020d7f28b85fb70efc3a1b80695f1e9c69f60c954b6aeccb71cedadccb97e0c
+  metadata.gz: 27747103c387757c5faf3cf3771651d221d67b8367d5b6f6623a34c43b3afe9d
+  data.tar.gz: 4abd9206358508019a69273c33fe9d772ad28b9ea4f76f85f499315b17bd99c2
 SHA512:
-  metadata.gz: 2fe01feb0e5260d8072f4a45640517a5041a83c566db15b45cc32d141fa8883cf84a1bec16b8ec043a6b914b28e0e824d1e2820454756501941831613efe95a7
-  data.tar.gz: ceef85ede42a50189fb41de31fe0d4ab6882c2139d825569cd674fdf9611f89fd96721156cad5dee347359f67ecba68d8e9a794c2c6513710a39c2e599975668
+  metadata.gz: a771a19b506f170a17fd672219a4899dcbfebc55e9ab2422a2d22198d0efd6c13667e5fbb2c69e1da724222bb9f9923fc4263f7b3ae14b3e260c62cc22eb42fd
+  data.tar.gz: c8eab3064758767b33f46943f0e09544e096545ad3f436c3b43e237d5be6e11589bc7840241561ddd04f860a1371656285badcd3a890cc003244829d6abf4010

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 0.19.3
+
+- Support providing `event_uuid` in `with`.
+
+## 0.19.2
+
+- Consult `inheritance_column` when constructing default scope
+
+## 0.19.1
+
+- Thread-safety support added for `with_hoardable_config`.
+
 ## 0.19.0
 
 - Ensure that stateful Hoardable class methods `with`, `travel_to` and `at` are thread-safe.

data/Gemfile

@@ -2,7 +2,12 @@
 
 source "https://rubygems.org"
 
+gem "bigdecimal"
 gem "debug"
+gem "drb"
+gem "logger"
+gem "mutex_m"
+gem "ostruct"
 if (rails_version = ENV["RAILS_VERSION"])
   gem "rails", "~> #{rails_version}"
 else

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,9 +28,8 @@ module Hoardable
     end
 
     def find_or_initialize_hoardable_event_uuid
-      Thread.current[:hoardable_event_uuid] ||= (
-        ActiveRecord::Base.connection.query("SELECT gen_random_uuid();")[0][0]
-      )
+      Thread.current[:hoardable_event_uuid] ||= Thread.current[:contextual_event_uuid] ||
+        SecureRandom.uuid
     end
 
     def initialize_version_attributes(operation)
@@ -94,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)
@@ -114,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

@@ -6,7 +6,7 @@ module Hoardable
 
   # Symbols for use with setting contextual data, when creating versions. See
   # {file:README.md#tracking-contextual-data README} for more.
-  DATA_KEYS = %i[meta whodunit event_uuid].freeze
+  DATA_KEYS = %i[meta whodunit].freeze
 
   # Symbols for use with setting {Hoardable} configuration. See {file:README.md#configuration
   # README} for more.
@@ -44,21 +44,15 @@ module Hoardable
 
   class << self
     CONFIG_KEYS.each do |key|
-      define_method(key) do
-        local_config = Thread.current[:hoardable_config] || @config
-        local_config[key]
-      end
+      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) do
-        local_context = Thread.current[:hoardable_context] || @context
-        local_context[key]
-      end
+      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
@@ -67,12 +61,36 @@ module Hoardable
     # @param hash [Hash] config and contextual data to set within a block
     def with(hash)
       thread = Thread.current
-      thread[:hoardable_config] = @config.merge(hash.slice(*CONFIG_KEYS))
-      thread[:hoardable_context] = @context.merge(hash.slice(*DATA_KEYS))
+      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] = nil
-      thread[:hoardable_context] = nil
+      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
 
     # Allows performing a query for record states at a certain time. Returned {SourceModel}
@@ -118,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/model.rb

@@ -9,9 +9,6 @@ module Hoardable
     extend ActiveSupport::Concern
 
     class_methods do
-      # @!visibility private
-      attr_reader :_hoardable_config
-
       # If called with a hash, this will set the model-level +Hoardable+ configuration variables. If
       # called without an argument it will return the computed +Hoardable+ configuration considering
       # both model-level and global values.
@@ -23,10 +20,7 @@ module Hoardable
         if hash
           @_hoardable_config = hash.slice(*CONFIG_KEYS)
         else
-          @_hoardable_config ||= {}
-          CONFIG_KEYS.to_h do |key|
-            [key, @_hoardable_config.key?(key) ? @_hoardable_config[key] : Hoardable.send(key)]
-          end
+          CONFIG_KEYS.to_h { |key| [key, _hoardable_config.fetch(key) { Hoardable.send(key) }] }
         end
       end
 
@@ -36,11 +30,20 @@ module Hoardable
       # @param hash [Hash] The +Hoardable+ configuration for the model. Keys must be present in
       #   {CONFIG_KEYS}
       def with_hoardable_config(hash)
-        current_config = @_hoardable_config
-        @_hoardable_config = hash.slice(*CONFIG_KEYS)
+        thread = Thread.current
+        current_thread_config = thread[hoardable_current_config_key]
+        thread[hoardable_current_config_key] = _hoardable_config.merge(hash.slice(*CONFIG_KEYS))
         yield
       ensure
-        @_hoardable_config = current_config
+        thread[hoardable_current_config_key] = current_thread_config
+      end
+
+      private def _hoardable_config
+        (@_hoardable_config ||= {}).merge(Thread.current[hoardable_current_config_key] ||= {})
+      end
+
+      private def hoardable_current_config_key
+        "hoardable_#{name}_config".to_sym
       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/scopes.rb

@@ -20,9 +20,9 @@ module Hoardable
               exclude_versions
             end
           )
-        next scope unless klass == version_class && "type".in?(column_names)
+        next scope unless klass == version_class && superclass.inheritance_column.in?(column_names)
 
-        scope.where(type: superclass.sti_name)
+        scope.where(superclass.inheritance_column => superclass.sti_name)
       end
 
       # @!scope class

data/lib/hoardable/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: hoardable
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.19.3
 platform: ruby
 authors:
 - justin talbott
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-30 00:00:00.000000000 Z
+date: 2025-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -162,7 +161,6 @@ metadata:
   homepage_uri: https://github.com/waymondo/hoardable
   source_code_uri: https://github.com/waymondo/hoardable
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -177,8 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: An ActiveRecord extension for versioning and soft-deletion of records in
   Postgres