phronomy 0.14.0 → 0.15.0

data/lib/phronomy/workflow_context.rb

@@ -1,25 +1,16 @@
 # frozen_string_literal: true
 
 module Phronomy
-  # Module for defining workflow context (the data that travels through a workflow).
-  # Include in a class and use the field DSL to declare context fields.
+  # Module for defining Workflow context data.
   #
-  # In StateChart terminology this is the "extended state" or "context" —
-  # data associated with the current execution that does not affect transitions
-  # directly, as opposed to the current phase (which is the machine's state).
+  # In StateChart terminology this is the extended state/context, as opposed to
+  # the current FSM phase.
   #
-  # Field update policies:
-  #   :replace (default) -- overwrites with the new value
-  #   :append            -- appends to an Array
-  #   :merge             -- shallow-merges into a Hash (top-level keys are merged; nested objects are replaced)
-  #
-  # @example
-  #   class ScanContext
-  #     include Phronomy::WorkflowContext
-  #     field :messages, type: :append, default: -> { [] }
-  #     field :query,    type: :replace
-  #     field :metadata, type: :merge,   default: -> { {} }
-  #   end
+  # An application context may define +handle_fsm_event(event)+. FSMSession calls
+  # it on the EventLoop thread before evaluating a declared transition. The
+  # method may mutate the context and return +false+ to continue transition
+  # evaluation, return a replacement WorkflowContext, or return +:consume+ to
+  # discard a stale/unrelated event without firing a transition.
   module WorkflowContext
     def self.included(base)
       base.extend(ClassMethods)
@@ -27,12 +18,6 @@ module Phronomy
     end
 
     module ClassMethods
-      # Defines a context field.
-      # @param name [Symbol]
-      # @param type [Symbol] :replace / :append / :merge
-      # @param default [Object, Proc, nil]
-      # @raise [ArgumentError] if +default+ is a plain Array or Hash (use a Proc instead)
-      # @api public
       def field(name, type: :replace, default: nil)
         if default.is_a?(Array) || default.is_a?(Hash)
           raise ArgumentError,
@@ -42,12 +27,8 @@ module Phronomy
         end
 
         @fields[name] = {type: type, default: default}
-
-        # Define getter.
         attr_reader name
 
-        # Define write-guarded setter.  Mutation from outside the EventLoop
-        # dispatch thread raises WorkflowContextOwnershipError in EventLoop mode.
         define_method(:"#{name}=") do |value|
           _assert_write_permitted!
           instance_variable_set(:"@#{name}", value)
@@ -59,86 +40,71 @@ module Phronomy
       end
     end
 
-    # Internal workflow metadata accessors (not user-defined fields).
-    # These are preserved through merge but excluded from to_h.
     attr_reader :thread_id
 
-    # Returns the current execution phase of the workflow.
-    # Encoding:
-    #   :__end__           — workflow completed (or not yet started)
-    #   :awaiting_<name>   — halted at a wait_state(:awaiting_<name>) declaration
-    #   :<state>           — resuming at <state> (workflow paused before its execution)
-    # @return [Symbol]
-    # @api public
-    # mutant:disable - @phase is always non-nil (set to :__end__ in initialize, only changed by set_graph_metadata which never sets nil), so the || :__end__ fallback branch is never reached — all mutations of the right-hand side are genuine equivalents
     def phase
       @phase || :__end__
     end
 
-    # Returns true if the workflow is paused mid-execution (not yet completed).
-    # @return [Boolean]
-    # @api public
-    # mutant:disable - phase != :__end__ vs !phase.eql?(:__end__) vs !phase.equal?(:__end__) are genuine equivalents for Symbol (Symbols are interned so == / eql? / equal? all behave identically)
     def halted?
       phase != :__end__
     end
 
-    # Sets internal workflow metadata. Returns self.
-    # @param thread_id [String, nil]
-    # @param phase [Symbol, nil]
-    # @api public
-    # mutant:disable - mutations replacing return value `self` with nil or removing the last line are genuine equivalents: callers chain on the return value only in merge which immediately discards it
     def set_graph_metadata(thread_id: nil, phase: nil)
       @thread_id = thread_id unless thread_id.nil?
       @phase = phase unless phase.nil?
       self
     end
 
-    # mutant:disable - multiple genuine equivalent mutations: is_a?(Proc) vs instance_of?(Proc) (Proc has no subclasses in practice), config[]/fetch() for always-present :default key, @thread_id=nil removal (unset ivar is already nil), @phase=:__end__ → nil or removal (phase method returns :__end__ via @phase||:__end__ fallback), raise message #{.inspect} vs #{} (spec checks exception class not message text)
     def initialize(**attrs)
       unknown = attrs.keys - self.class.fields.keys
-      raise ArgumentError, "Unknown WorkflowContext field(s): #{unknown.inspect}" unless unknown.empty?
+      unless unknown.empty?
+        raise ArgumentError,
+          "Unknown WorkflowContext field(s): #{unknown.inspect}"
+      end
 
       self.class.fields.each do |name, config|
-        default = config[:default].is_a?(Proc) ? config[:default].call : config[:default]
-        # Bypass the write guard in initialize — ownership enforcement begins
-        # after construction is complete.
-        instance_variable_set(:"@#{name}", attrs.fetch(name, default))
+        default =
+          if config[:default].is_a?(Proc)
+            config[:default].call
+          else
+            config[:default]
+          end
+        instance_variable_set(
+          :"@#{name}",
+          attrs.fetch(name, default)
+        )
       end
       @thread_id = nil
       @phase = :__end__
     end
 
-    # Returns a new context instance with the specified field updates applied.
-    # Updated fields follow the field's declared +:type+ semantics (:replace, :append,
-    # or :merge). Unchanged fields are deep-copied on a best-effort basis — objects
-    # that do not support +#dup+ (e.g. integers, frozen objects) are carried over
-    # by reference. Internal workflow metadata (thread_id, phase) is preserved.
-    # @param updates [Hash] { field_name => new_value }
-    # @return [self.class] new context instance
-    # @raise [ArgumentError] if updates contains keys that are not declared fields
-    # @api public
-    # mutant:disable - multiple genuine equivalent mutations: send/public_send/__send__ are identical (all field accessors are public), fields[]/fetch() and field_config[]/fetch() for always-present keys, updates[]/fetch() when updates.key?(name) is already true, Array() wrapping for append fields that always hold Arrays, (send||{})/send equivalence for merge fields that always hold Hashes, deep_dup_value(send) vs send are equivalent under killfork (coverage selection does not trace the deep_dup_value call site across the fork boundary), raise message inspect vs to_s (spec checks exception class only)
+    # Returns a new context with field update policies applied.
     def merge(updates)
       unknown = updates.keys - self.class.fields.keys
-      raise ArgumentError, "Unknown WorkflowContext field(s): #{unknown.inspect}" unless unknown.empty?
+      unless unknown.empty?
+        raise ArgumentError,
+          "Unknown WorkflowContext field(s): #{unknown.inspect}"
+      end
 
       new_attrs = {}
       self.class.fields.each_key do |name|
         field_config = self.class.fields[name]
-        new_attrs[name] = if updates.key?(name)
-          case field_config[:type]
-          when :append
-            Array(send(name)) + Array(updates[name])
-          when :merge
-            (send(name) || {}).merge(updates[name])
+        new_attrs[name] =
+          if updates.key?(name)
+            case field_config[:type]
+            when :append
+              Array(public_send(name)) + Array(updates[name])
+            when :merge
+              (public_send(name) || {}).merge(updates[name])
+            else
+              updates[name]
+            end
           else
-            updates[name]
+            deep_dup_value(public_send(name))
           end
-        else
-          deep_dup_value(send(name))
-        end
       end
+
       new_context = self.class.new(**new_attrs)
       new_context.set_graph_metadata(
         thread_id: @thread_id,
@@ -147,28 +113,18 @@ module Phronomy
       new_context
     end
 
-    # Converts user-defined fields to a Hash (excludes internal workflow metadata).
-    # @return [Hash]
-    # @api public
-    # mutant:disable - send/public_send/__send__ are genuine equivalents (all field accessors are public methods)
     def to_h
-      self.class.fields.keys.each_with_object({}) do |name, h|
-        h[name] = send(name)
+      self.class.fields.keys.each_with_object({}) do |name, result|
+        result[name] = public_send(name)
       end
     end
 
     private
 
-    # Asserts that the calling thread is allowed to mutate this context.
-    # Raises WorkflowContextOwnershipError when called from outside the EventLoop
-    # dispatch thread, unless we are inside a synchronous execution context
-    # (e.g. Workflow#stream using the run_workflow sync path).
-    # @raise [Phronomy::WorkflowContextOwnershipError]
-    # @api private
-    # mutant:disable - multiple genuine equivalent mutations: defined?(Phronomy::EventLoop)&& removal is genuine because EventLoop is always loaded in the killfork environment; true&& is genuine (truthy guard); EventLoop.current? resolves to Phronomy::EventLoop.current? within the Phronomy module; WorkflowContextOwnershipError resolves to Phronomy::WorkflowContextOwnershipError within the module; raise without message or with nil message is genuine (spec checks exception class, not message text)
+    # Workflow field mutation is permitted only on the Runtime-owned EventLoop
+    # dispatch thread. All Workflow execution APIs now use that same path; there
+    # is no caller-thread synchronous exception.
     def _assert_write_permitted!
-      # Allow mutations when executing synchronously (e.g. Workflow#stream via run_workflow).
-      return if Thread.current[:phronomy_sync_execution]
       return if Phronomy::Runtime.in_event_loop_context?
 
       raise Phronomy::WorkflowContextOwnershipError,
@@ -177,27 +133,23 @@ module Phronomy
         "updates as event payloads."
     end
 
-    # Performs a deep copy of a value for immutable context propagation.
-    # Arrays and Hashes are deep-duplicated recursively.
-    # Immutable values (nil, Symbol, Integer, Float, true/false, frozen String) are returned as-is.
-    # Other objects are dup'd (best-effort shallow copy for custom types).
-    # Objects that cannot be dup'd (e.g. Proc, Method) are returned as-is.
-    # mutant:disable - multiple genuine equivalent mutations: each class in the when clause (NilClass/Symbol/Integer/Float/TrueClass/FalseClass) can be removed or replaced with nil because all those types are frozen so the else-branch val.frozen? guard returns the same result; return val vs val is also equivalent; if val.frozen? vs if self.frozen? is equivalent since self is never frozen in this context
-    def deep_dup_value(val)
-      case val
+    def deep_dup_value(value)
+      case value
       when Array
-        val.map { |v| deep_dup_value(v) }
+        value.map { |item| deep_dup_value(item) }
       when Hash
-        val.each_with_object({}) { |(k, v), h| h[k] = deep_dup_value(v) }
+        value.each_with_object({}) do |(key, item), result|
+          result[key] = deep_dup_value(item)
+        end
       when NilClass, Symbol, Integer, Float, TrueClass, FalseClass
-        val
+        value
       else
-        return val if val.frozen?
+        return value if value.frozen?
 
         begin
-          val.dup
+          value.dup
         rescue TypeError
-          val
+          value
         end
       end
     end