hecks 1.4.0 → 1.5.1

data/lib/hecks/runtime/instance.rb

@@ -31,20 +31,34 @@ module Hecks
       # holding it when they mint a brand-new record). See
       # `materialize_identity!` for why a composite identity needs it.
       #
-      # `hydrate:` — ON BY DEFAULT, and every existing caller keeps getting
+      # `hydrate:` — on by default, and every existing caller keeps getting
       # exactly what it always got: `state` re-walked through
       # `hydrate_with_defaults` (declared defaults filled, every attribute
       # re-coerced through `Value.for_attribute`, an entity list's every
       # element rebuilt and re-validated). `false` is for exactly one
       # caller (`Adapters::Memory#build_instance`, judge-bootstrapping
       # only — see its own header) that already knows `state` needs none
-      # of that: it is a shallow dup of an ALREADY-hydrated, ALREADY-
+      # of that: it is a shallow dup of an already-hydrated, already-
       # validated live `Instance`'s own state, not a raw value pulled off
       # a wire. Skipping the re-walk is what turns a `list_of` entity's Nth
       # save from O(N) (re-hydrating every element saved so far, for every
       # save) into O(1) — the quadratic cost `Adapters::Memory`'s own
       # header traces start to finish. `CodecBoundary.check_state!` still
       # runs either way ; only the re-hydration is skipped.
+      #
+      # @param aggregate [Bluebook::Aggregate, Bluebook::Entity] the construct this
+      #   record's state is declared by
+      # @param id [String, nil] this record's identity; nil for a record whose identity
+      #   is not yet resolvable (e.g. an entity element hydrated before its own view exists)
+      # @param state [Hash{Symbol => Object}, nil] the record's stored (or partial)
+      #   attribute values; nil for a brand-new record, hydrated entirely from declared
+      #   defaults
+      # @param args [Hash{Symbol => Object}, nil] the original command payload, offered
+      #   only by a fresh creation; materializes a composite identity's own head
+      #   attributes
+      # @param hydrate [Boolean] whether `state` is re-walked through
+      #   `hydrate_with_defaults`; false only for a caller that already knows `state` is
+      #   already hydrated and validated
       def initialize(aggregate:, id:, state: nil, args: nil, hydrate: true)
         @aggregate = aggregate
         @id        = id
@@ -68,6 +82,12 @@ module Hecks
       # written — arrives filled instead of nil. Only declared defaults
       # fill in; an attribute with no default stays absent, exactly as
       # stored.
+      #
+      # @param aggregate [Bluebook::Aggregate, Bluebook::Entity] the construct whose
+      #   declared attributes and defaults `state` is hydrated against
+      # @param state [Hash{Symbol => Object}] the raw stored (or partial) attribute values
+      # @return [Hash{Symbol => Object}] `state` coerced through every declared attribute,
+      #   with any missing declared-default attribute filled in
       def self.hydrate_with_defaults(aggregate, state)
         hydrated = Value.hydrate(aggregate, state)
         defaults(aggregate).each do |name, value|
@@ -76,6 +96,13 @@ module Hecks
         hydrated
       end
 
+      # Builds a fresh record's starting state: every declared attribute's
+      # default value, an empty frozen Array for a `list_of` attribute, and
+      # the lifecycle field's declared starting value when `aggregate` has one.
+      #
+      # @param aggregate [Bluebook::Aggregate, Bluebook::Entity] the construct whose
+      #   declared attributes and lifecycle are read
+      # @return [Hash{Symbol => Object}] the default state, keyed by attribute name
       def self.defaults(aggregate)
         state = aggregate.attributes.to_h do |attr|
           # Frozen, like a list that has had something appended to it.
@@ -88,6 +115,16 @@ module Hecks
         state
       end
 
+      # Resolves one attribute's default value: its own declared `default:`
+      # if it has one, otherwise a value object built entirely from its own
+      # members' defaults, when every member declares one.
+      #
+      # @param aggregate [Bluebook::Aggregate, Bluebook::Entity] the construct
+      #   `attribute` belongs to
+      # @param attribute [Bluebook::Attribute] the attribute to resolve a default for
+      # @return [Runtime::Value, Object, nil] the coerced default value; nil when
+      #   `attribute` declares no default and either names no value object or names
+      #   one with a member that itself declares no default
       def self.default_for(aggregate, attribute)
         return Value.for_attribute(aggregate, attribute, attribute.default) unless attribute.default.nil?
         # An entity's members hydrate through the same path but an entity
@@ -100,10 +137,24 @@ module Hecks
         Value.build(value_object, {}, aggregate)
       end
 
+      # Reads one state field by name.
+      #
+      # @param name [String, Symbol] the declared attribute name to read
+      # @return [Object, nil] the field's current value; nil if `name` is not a key
+      #   of `state`
       def [](name) = @state[name.to_sym]
 
+      # Reports whether `state` holds a value for `name`.
+      #
+      # @param name [String, Symbol] the declared attribute name to check
+      # @return [Boolean] true if `state` has a key for `name`
       def key?(name) = @state.key?(name.to_sym)
 
+      # Writes one state field by name.
+      #
+      # @param name [String, Symbol] the declared attribute name to write
+      # @param value [Object] the value to store
+      # @return [Object] `value`, unchanged
       def []=(name, value)
         @state[name.to_sym] = value
       end
@@ -118,6 +169,8 @@ module Hecks
         @state.key?(name) || super
       end
 
+      # Renders this record's wire/storage shape, state plus its identity.
+      #
       # `id: @id` last, not first — see Facade::Handle#to_h's own comment
       # for the full story (the same fix, landed there first): an
       # aggregate free to declare its own attribute literally named `id`
@@ -125,8 +178,13 @@ module Hecks
       # attribute's own wrapped value object sitting in `@state[:id]` —
       # merging `@state` on top of `{ id: @id }` let it silently clobber
       # the correct bare identity. `@id` merged last always wins.
+      #
+      # @return [Hash{Symbol => Object}] `state`, with `id` merged in last
       def to_h = @state.merge(id: @id)
 
+      # Copies this record, deep enough that a mutation on the copy cannot
+      # reach the original's own state.
+      #
       # A copy a mutation may touch. Every adapter but Memory hands `find`
       # a freshly-decoded Instance already; Memory's holds the record it
       # eventually saves — the same state Hash, aliased. Before `ensures`
@@ -139,6 +197,8 @@ module Hecks
       # record through this, never through the adapter's own return value
       # directly, so a refused ensures leaves the stored record untouched
       # regardless of which adapter is holding it.
+      #
+      # @return [Runtime::Instance] a copy of this record, with its own state Hash
       def dup
         copy = super
         copy.state = @state.dup
@@ -157,11 +217,11 @@ module Hecks
       # `identified_by` to fall back to `:id` for — `@aggregate.identified_by`
       # is nil the moment there is more than one head (`Behaviour::Identified
       # #derive_identity`), so the single-head branch below never runs for
-      # it at all. A creating command that declares those heads as ordinary
-      # attributes but doesn't also `sets` them (redundant with the identity
-      # the command's own args already named) used to persist every head as
-      # nil — the id correctly named the record, but the record's own
-      # attributes forgot what named it.
+      # it at all. Without this, a creating command that declares those heads
+      # as ordinary attributes but doesn't also `sets` them (redundant with
+      # the identity the command's own args already named) would persist
+      # every head as nil — the id correctly naming the record, but the
+      # record's own attributes forgetting what named it.
       #
       # Filled from `args`, never from splitting `@id` back apart — the
       # same reason the single-head branch below won't guess a multi-path

data/lib/hecks/runtime/interpreting.rb

@@ -8,11 +8,19 @@ module Hecks
     # in CommandInterpreter and EntityInterpreter, where they could only
     # ever drift.
     module Interpreting
+      # Ruby's module-inclusion hook. Gives `interpreter` its own `trace`
+      # accessor, since a class including this module needs its own copy
+      # rather than one shared across every interpreter.
+      #
       # Each including interpreter gets its own `trace` — set by a spec to
       # observe dispatch order (Vocabulary::AggregateDispatchOrder and
       # Vocabulary::EntityDispatchOrder in language/bluebook/vocabulary.bluebook);
       # nil in production, always — one array push and a nil check per step
       # is the entire cost of leaving this in.
+      #
+      # @param interpreter [Class] the class (`CommandInterpreter`, `EntityInterpreter`)
+      #   including this module
+      # @return [void]
       def self.included(interpreter)
         interpreter.singleton_class.attr_accessor :trace
       end
@@ -32,9 +40,9 @@ module Hecks
       # read off its own generated Vocabulary::*DispatchOrder table —
       # vocabulary.bluebook, via lib/hecks/vocabulary.rb) by `send`ing
       # each declared step name against the including interpreter's own
-      # `step_<name>` handler, in declared order. What used to be `call`'s own
-      # literal sequence of method calls is now data driving that sequence —
-      # tracing a real dispatch and comparing it to the declaration is
+      # `step_<name>` handler, in declared order. Data drives that sequence,
+      # rather than `call` spelling it out as a literal sequence of method
+      # calls — tracing a real dispatch and comparing it to the declaration is
       # tautological once `call` mechanically follows the declaration; a
       # conditional step (assign_creation_attributes, advance_lifecycle) still
       # has to guard itself at the top of its own handler and skip tracing
@@ -116,8 +124,8 @@ module Hecks
       # refuse_absent_arguments are separate DISPATCH_ORDER steps now (the
       # declared vocabulary lists all three as flat, sequential members, not
       # one nesting the other two), and EntityInterpreter never had them here
-      # at all (an entity inherits its aggregate's own gate). One copy,
-      # shared, rather than the two identical ones that used to drift.
+      # at all (an entity inherits its aggregate's own gate). One shared
+      # copy, rather than two identical ones that can only ever drift apart.
       def normalize_args(aggregate, command, args)
         coerce_declared_arguments(aggregate, command, args)
       end

data/lib/hecks/runtime/invocation.rb

@@ -9,7 +9,8 @@ module Hecks
     # (`target`, a `Routing::Envelope` or nil), and every fact the caller did
     # or did not offer. Built once per dispatch by `Invocation.from_call`, the
     # only place the runtime interprets the shape of a call (`to:` vs `with:`
-    # vs loose keyword arguments, a port operation's reference attribute
+    # vs the flat facts hash `dispatch_flat` carries, a port operation's
+    # reference attribute
     # lifted into `to:`). `Runtime::Routing.envelope`/`.payload` delegate here
     # and no longer hold that logic themselves.
     #
@@ -21,12 +22,12 @@ module Hecks
     #   - `Invocation::Present` — the key was offered with a value
     #
     # Keys are kept exactly as offered: `with:` keys are symbolized (as they
-    # always were), loose keyword arguments keep whatever key the caller
-    # used. Undeclared keys a caller offered are kept too — refusing them is
+    # always were), a flat facts hash keeps whatever key the wire used. Undeclared keys a caller
+    # offered are kept too — refusing them is
     # still `refuse_unknown_arguments`' job, a dispatch step, not this one.
     #
-    # PR I1 changes no behavior: every interpreter still reads `ctx.args`,
-    # which is `#to_args` — the same Hash `Routing.payload` used to return.
+    # I1 changes no behavior: every interpreter still reads `ctx.args`,
+    # which is `#to_args` — the same Hash `Routing.payload` returns.
     # Roadmap I2 moves the Ruby `decode_arguments` step onto `facts` itself.
     Invocation = Data.define(:verb, :target, :facts)
 
@@ -41,6 +42,7 @@ module Hecks
       # The class of the two frozen marker singletons below — never
       # instantiated anywhere else.
       class Marker
+        # @param name [String] the marker's own label, used by #inspect/#to_s
         def initialize(name)
           @name = name
           freeze
@@ -54,22 +56,51 @@ module Hecks
       Absent = Marker.new("Absent")
       Null   = Marker.new("Null")
 
+      # @param verb [String] the fully qualified verb this invocation dispatches
+      # @param target [Routing::Envelope, nil] the resolved receiver, or nil when
+      #   the facts carry the identity themselves
+      # @param facts [Hash{String, Symbol => Object}] every candidate fact, keyed by
+      #   offered (or declared) name; frozen, deep-duped, before being stored
       def initialize(verb:, target:, facts:)
         super(verb: verb, target: target, facts: facts.dup.freeze)
       end
 
+      # Reads the fact recorded under `name`.
+      #
       # The fact recorded under `name` — `Absent` for a name never offered
       # and never declared either.
+      #
+      # @param name [String, Symbol] the fact name to look up
+      # @return [Invocation::Present, Invocation::Null, Invocation::Absent] the
+      #   recorded marker for `name`
       def fact(name) = facts.fetch(name, Absent)
 
+      # Reports whether `name` was offered with a real, non-nil value.
+      #
+      # @param name [String, Symbol] the fact name to check
+      # @return [Boolean] true if `name` was offered with a non-nil value
       def present?(name) = fact(name).is_a?(Present)
+
+      # Reports whether `name` was offered with an explicit nil.
+      #
+      # @param name [String, Symbol] the fact name to check
+      # @return [Boolean] true if `name` was offered with an explicit nil
       def null?(name)    = fact(name).equal?(Null)
+
+      # Reports whether `name` was never offered.
+      #
+      # @param name [String, Symbol] the fact name to check
+      # @return [Boolean] true if `name` was never offered (and, if declared, left out)
       def absent?(name)  = fact(name).equal?(Absent)
 
       # A Present fact's value; nil for an explicit Null. Raises KeyError for
       # an Absent fact — "never offered" has no value, and answering nil
       # would re-conflate it with an explicit null, the very ambiguity this
       # type exists to remove. Ask `absent?`/`present?` first.
+      #
+      # @param name [String, Symbol] the fact name to read
+      # @return [Object, nil] the offered value; nil for an explicit Null fact
+      # @raise [KeyError] if `name` names an Absent fact (never offered)
       def value(name)
         case (found = fact(name))
         when Present then found.value
@@ -78,9 +109,12 @@ module Hecks
         end
       end
 
-      # The legacy args hash, byte for byte what `Routing.payload` returned
+      # The flat args hash, byte for byte what `Routing.payload` returned
       # before this type existed: offered keys in offered order, Absent keys
       # omitted, Null keys mapped to nil. A fresh Hash every call.
+      #
+      # @return [Hash{String, Symbol => Object}] the offered facts by name; a fact
+      #   offered as nil is kept as nil
       def to_args
         facts.each_with_object({}) do |(name, found), args|
           next if found.equal?(Absent)
@@ -90,7 +124,7 @@ module Hecks
       end
 
       class << self
-        # **The one reading of a call's shape**. `receiver:` picks which of the
+        # The one reading of a call's shape. `receiver:` picks which of the
         # three dispatch shapes this is, because each has always checked its
         # parts in its own order and a malformed call's refusal depends on
         # that order:
@@ -107,24 +141,57 @@ module Hecks
         # the point in that order where the caller always resolved it.
         # `aggregate:` is the owning aggregate construct, read for `:port`
         # only.
-        def from_call(verb, to:, with:, legacy:, receiver: :aggregate, entity_depth: 0, aggregate: nil, &declaring)
+        #
+        # @param verb [String] the fully qualified verb being dispatched
+        # @param to [String, Hash, nil] a bare aggregate identity, or a Hash with
+        #   `aggregate:` and `entity:`/`entities:`; nil for no explicit receiver
+        # @param with [Hash, nil] the command's facts, keyed by attribute name; nil
+        #   when the caller offers `flat` instead
+        # @param flat [Hash] the command's facts as a flat args hash, used when `with`
+        #   is nil; for `:port`, may also carry the receiver identity under a
+        #   reference attribute's own name
+        # @param receiver [Symbol] which of the three dispatch shapes this is:
+        #   `:aggregate`, `:entity` or `:port`
+        # @param entity_depth [Integer] the number of entity-hop identities `to:`
+        #   must carry, for `:entity` only
+        # @param aggregate [Bluebook::Aggregate, nil] the owning aggregate construct,
+        #   read for `:port` only
+        # @yieldreturn [Class] the declaring command or port-operation class (anything
+        #   with `hecks_name` and `attributes`)
+        # @return [Runtime::Invocation] the built invocation
+        # @raise [Runtime::TypeMismatch] if `to:` is malformed, its entity count is
+        #   wrong, or (`:port` only) the operation resolves no receiving aggregate
+        # @raise [Runtime::UnknownArgument] if `with:` names an attribute the command
+        #   does not declare
+        # @raise [Runtime::AbsentArgument] if `with:` omits a required attribute
+        # @raise [ArgumentError] if `receiver` is none of `:aggregate`, `:entity` or `:port`
+        def from_call(verb, to:, with:, flat:, receiver: :aggregate, entity_depth: 0, aggregate: nil, &declaring)
           case receiver
           when :aggregate
             command = declaring.call
-            facts   = facts_for(command, with: with, legacy: legacy)
+            facts   = facts_for(command, with: with, flat: flat)
             new(verb: verb, target: route(to), facts: facts)
           when :entity
             target  = route(to, entity_depth: entity_depth)
             command = declaring.call
-            new(verb: verb, target: target, facts: facts_for(command, with: with, legacy: legacy))
+            new(verb: verb, target: target, facts: facts_for(command, with: with, flat: flat))
           when :port
-            port_call(verb, aggregate, declaring.call, to: to, with: with, legacy: legacy)
+            port_call(verb, aggregate, declaring.call, to: to, with: with, flat: flat)
           else
             raise ArgumentError, "unknown receiver #{receiver.inspect}"
           end
         end
 
         # `to:` as a `Routing::Envelope`, or nil when no `to:` was given.
+        #
+        # @param to [String, Hash, nil] a bare aggregate identity, or a Hash with
+        #   `aggregate:` and `entity:`/`entities:`; nil for no receiver
+        # @param entity_depth [Integer] the number of entity-hop identities `to`
+        #   must carry
+        # @return [Routing::Envelope, nil] the resolved envelope, or nil when `to`
+        #   is nil
+        # @raise [Runtime::TypeMismatch] if `to` is malformed, or its entity count
+        #   does not match `entity_depth`
         def route(to, entity_depth: 0)
           return nil if to.nil?
 
@@ -146,8 +213,23 @@ module Hecks
         # The offered facts for `declaring`, as Absent/Null/Present — offered
         # keys first, in offered order, then every declared attribute that was
         # not offered, as Absent.
-        def facts_for(declaring, with:, legacy:)
-          offered = offered_facts(declaring, with: with, legacy: legacy)
+        #
+        # @param declaring [Class] the command or port-operation class (anything
+        #   with `hecks_name` and `attributes`) whose declared attributes are read
+        # @param with [Hash, nil] the command's facts, keyed by attribute name; nil
+        #   when the caller offers `flat` instead
+        # @param flat [Hash] the command's facts as a flat args hash, used when `with`
+        #   is nil
+        # @return [Hash{String, Symbol => Invocation::Absent, Invocation::Null,
+        #   Invocation::Present}] each candidate fact keyed by its offered (or
+        #   declared) name
+        # @raise [Runtime::TypeMismatch] if both `with` and a non-empty `flat` are
+        #   given, or if `with` is not a Hash
+        # @raise [Runtime::UnknownArgument] if `with:` names an attribute `declaring`
+        #   does not declare
+        # @raise [Runtime::AbsentArgument] if `with:` omits a required attribute
+        def facts_for(declaring, with:, flat:)
+          offered = offered_facts(declaring, with: with, flat: flat)
           facts = offered.each_with_object({}) do |(name, value), found|
             found[name] = value.nil? ? Null : Present.new(value: value)
           end
@@ -160,10 +242,10 @@ module Hecks
 
         private
 
-        # **The port operation shape** — formerly `Dispatcher#port_invocation`.
+        # **The port operation shape** — moved from `Dispatcher#port_invocation`.
         #
         # A Reference-typed attribute naming the owning aggregate is routing,
-        # not a fact: lifted out of the loose kwargs into `to:` when no `to:`
+        # not a fact: lifted out of the flat facts into `to:` when no `to:`
         # was given. A `to:`-declared operation carries no Reference
         # attribute at all (PortOperationBuilder#initialize's own comment),
         # so its receiver is read — not removed — from the plain attribute
@@ -173,30 +255,30 @@ module Hecks
         # with attribute"; a real AbsentArgument confirmed this before `[]`
         # replaced `delete`). Composite identity is not attempted — `.first`
         # only, no domain in the corpus needs more for a port operation.
-        def port_call(verb, aggregate, operation, to:, with:, legacy:)
-          legacy = legacy.dup
+        def port_call(verb, aggregate, operation, to:, with:, flat:)
+          flat = flat.dup
           identity = operation.identity_attribute(aggregate.hecks_name)
-          if to.nil? && identity && legacy.key?(identity.name)
-            to = legacy.delete(identity.name)
+          if to.nil? && identity && flat.key?(identity.name)
+            to = flat.delete(identity.name)
           elsif to.nil? && operation.to == aggregate.hecks_name
             identity_name = Array(aggregate.identified_by).first
-            to = legacy[identity_name] if identity_name && legacy.key?(identity_name)
+            to = flat[identity_name] if identity_name && flat.key?(identity_name)
           end
 
           target = route(to)
           raise TypeMismatch, "#{operation.hecks_name} requires its receiving aggregate in to:" unless target
 
-          new(verb: verb, target: target, facts: facts_for(operation, with: with, legacy: legacy))
+          new(verb: verb, target: target, facts: facts_for(operation, with: with, flat: flat))
         end
 
         # BUG#7 — a non-Hash `to:` must be a String, matching Rust's
         # `RoutingEnvelope::from_json` (kernel/routing.rs), which refuses
         # anything neither a JSON string nor object before the domain payload
         # is examined. Surfaced on `examples/roster`'s `Mark`, whose own
-        # attribute is literally named `to`: a flat-kwargs dispatch steals
-        # that key into this parameter, and an out-of-range Integer used to be
-        # accepted as the aggregate identity, leaving Mark's `to` fact absent
-        # (AbsentArgument in Ruby, TypeMismatch in Rust). See
+        # attribute is literally named `to`: a flat-facts dispatch steals
+        # that key into this parameter, and without this check an out-of-range
+        # Integer would be accepted as the aggregate identity, leaving Mark's
+        # `to` fact absent (AbsentArgument in Ruby, TypeMismatch in Rust). See
         # spec/runtime/routing_envelope_shape_spec.rb.
         def scalar_envelope(to)
           return [to, []] if to.is_a?(String)
@@ -214,11 +296,11 @@ module Hecks
 
         # BUG#18 — an entity route naming no entity (`entities: []`, or
         # neither key) refuses here, unconditionally, before entity_depth is
-        # consulted: for an aggregate-level command (depth 0) `[].size == 0`
-        # used to satisfy the depth check and let the degenerate Hash reach
-        # the command's own validation. Rust's `RoutingEnvelope::from_json`
-        # always refused it at this point. A bare aggregate identity String
-        # remains the ordinary aggregate-command shape.
+        # consulted: for an aggregate-level command (depth 0), without this,
+        # `[].size == 0` would satisfy the depth check and let the degenerate
+        # Hash reach the command's own validation. Rust's `RoutingEnvelope::
+        # from_json` always refused it at this point. A bare aggregate identity
+        # String remains the ordinary aggregate-command shape.
         def entity_identities(hash)
           raise TypeMismatch, "to: takes entity: or entities:, not both" if hash.key?(:entities) && hash.key?(:entity)
 
@@ -230,16 +312,16 @@ module Hecks
 
         # `with:` is deliberately strict: a caller choosing the explicit
         # envelope cannot smuggle receiver identity back into the payload,
-        # and may not mix it with loose keyword arguments. Without `with:`
-        # (nil or false) the loose keyword arguments are the facts, unread —
+        # and may not mix it with a flat facts hash. Without `with:`
+        # (nil or false) the flat facts are the facts, unread —
         # whether `to:` was given never enters this decision (BUG#17).
-        def offered_facts(declaring, with:, legacy:)
-          if with && !legacy.empty?
+        def offered_facts(declaring, with:, flat:)
+          if with && !flat.empty?
             raise TypeMismatch,
-                  "dispatch takes command facts in with:, not both with: and loose keyword arguments"
+                  "dispatch takes command facts in with:, not both with: and a flat facts hash"
           end
 
-          return legacy unless with
+          return flat unless with
           raise TypeMismatch, "with: must be a hash of command facts" unless with.is_a?(Hash)
 
           offered = with.transform_keys(&:to_sym)

data/lib/hecks/runtime/loader.rb

@@ -37,6 +37,20 @@ module Hecks
       # its own env var name and passes the resulting string straight
       # through, e.g. `Hecks.boot(path, environment:
       # ENV.fetch("MYAPP_ENV", "development"))`.
+      #
+      # @param path [String] a domain directory to boot, resolved through
+      #   `Ports::Loading#bluebook_directory`
+      # @param shared [String, nil] an explicit shared ports/adapters root override; nil
+      #   resolves it by walking up from the domain directory
+      # @param install_facade [Boolean] whether to install the `Widget::Item.Add(...)`
+      #   facade sugar
+      # @param environment [String, nil] the environment overlay to load after the
+      #   domain's own files (e.g. `"production"`); nil loads none
+      # @return [Runtime::Dispatcher, Runtime::RemoteDispatcher] the booted dispatcher
+      # @raise [Errno::ENOENT] if `path` names neither a domain directory nor one holding
+      #   a `bluebook/` subdirectory
+      # @raise [Runtime::WiringError] if a boot gate finds a wiring problem (an undeclared
+      #   bind, a compute/rekey rule with no persistence plugin loaded, …)
       def self.boot(path, shared: nil, install_facade: true, environment: nil)
         loading   = Ports::Loading.bootstrap
         directory = loading.bluebook_directory(path)
@@ -52,6 +66,7 @@ module Hecks
         run_boot_gates!(registry, directory)
         dispatcher = dispatcher_for(registry)
         redrive_outbox!(dispatcher)
+        seed_privacy_markings!(dispatcher, registry)
         install_facade ? bind_runtime(dispatcher) : dispatcher
       end
 
@@ -63,12 +78,43 @@ module Hecks
       # provably never started; `claimed` rows are surfaced, never
       # auto-redriven — see `Runtime::Outbox`. A remote dispatcher has
       # no local stores to scan.
+      #
+      # @param dispatcher [Runtime::Dispatcher, Runtime::RemoteDispatcher] the
+      #   just-booted dispatcher; a no-op unless it exposes an `outbox`
+      # @return [void]
       def self.redrive_outbox!(dispatcher)
         return unless dispatcher.respond_to?(:outbox)
 
         dispatcher.outbox.redrive!
       end
 
+      # Turns every `.hecksagon`-declared `AggregateDoor#mark_sensitive` fact into a real
+      # `Privacy::Marking.Mark` — after the dispatcher exists (dispatch needs a bound
+      # repository), idempotent across reboots (a marking already present is never
+      # re-dispatched, the same "provably never started" restraint `redrive_outbox!`
+      # holds itself to above). A no-op when nothing declared one, or when the domain
+      # never attached Privacy at all.
+      #
+      # @param dispatcher [Runtime::Dispatcher, Runtime::RemoteDispatcher] the just-booted
+      #   dispatcher `Privacy::Marking.Mark` dispatches through
+      # @param registry [Runtime::Registry] the just-booted registry `pending_privacy_markings`
+      #   was recorded on
+      # @return [void]
+      def self.seed_privacy_markings!(dispatcher, registry)
+        return if registry.pending_privacy_markings.empty?
+        return unless registry.bluebook("Privacy")
+
+        already_marked_by_domain = registry.pending_privacy_markings.map { |marking| marking[:domain] }.uniq.to_h do |domain|
+          [domain, dispatcher.query("Privacy::Marking.ForDomain", domain: domain).map { |row| row[:attribute_path][:value] }]
+        end
+
+        registry.pending_privacy_markings.each do |marking|
+          next if already_marked_by_domain[marking[:domain]].include?(marking[:attribute_path])
+
+          dispatcher.dispatch_flat("Privacy::Marking.Mark", marking)
+        end
+      end
+
       # The explicit-file form — `paths` names the exact bluebook/hecksagon/
       # world files to boot, in place, wherever they actually live. `boot`
       # above only ever takes a directory and globs it; that is the right
@@ -91,6 +137,18 @@ module Hecks
       # first real path in `paths` — genuinely on disk, not a copy — so
       # every downstream path (`EraCheck`, `persisted_by`, `shared_root`)
       # resolves exactly as an ordinary directory boot's would.
+      #
+      # @param paths [Array<String>, String] the exact bluebook/hecksagon/world file paths
+      #   to boot, in the order they should load
+      # @param shared [String, nil] an explicit shared ports/adapters root override; nil
+      #   resolves it by walking up from `File.dirname` of the first path
+      # @param install_facade [Boolean] whether to install the `Widget::Item.Add(...)`
+      #   facade sugar
+      # @param environment [String, nil] the environment overlay to load after the
+      #   named files (e.g. `"production"`); nil loads none
+      # @return [Runtime::Dispatcher, Runtime::RemoteDispatcher] the booted dispatcher
+      # @raise [Runtime::WiringError] if a boot gate finds a wiring problem (an undeclared
+      #   bind, a compute/rekey rule with no persistence plugin loaded, …)
       def self.boot_files(paths, shared: nil, install_facade: true, environment: nil)
         loading   = Ports::Loading.bootstrap
         files     = Array(paths).map { |path| File.expand_path(path) }
@@ -109,9 +167,11 @@ module Hecks
         install_facade ? bind_runtime(dispatcher) : dispatcher
       end
 
-      # ADR 0031 — replaces two previously-hardcoded, unconditional calls
-      # with a per-boot `BootGates` instance holding exactly the gates this
-      # registry's own bound adapters have a capability for. Ordering is
+      # Runs every registered boot gate against `registry`, in order.
+      #
+      # ADR 0031 — a per-boot `BootGates` instance holds exactly the gates this
+      # registry's own bound adapters have a capability for, rather than two
+      # hardcoded, unconditional calls. Ordering is
       # preserved: era-checking (when a persistence plugin contributes one)
       # still runs before `verify!`, saga rehydration still runs after
       # (conservative — see `SagaPersistence#rehydrate_sagas!`'s own
@@ -124,6 +184,13 @@ module Hecks
       # `:post_verify` gates generically; `:saga_rehydration` is the one
       # gate core still registers directly, because ADR 0031 already
       # proved it's not era-specific.
+      #
+      # @param registry [Runtime::Registry] the registry mid-boot, with its bluebooks,
+      #   hecksagons, ports, adapters and worlds already loaded
+      # @param directory [String] the domain directory the gates report against in a refusal
+      # @return [Runtime::BootGates] the gates instance built and run for this boot
+      # @raise [Runtime::WiringError] if `registry.verify!` or any contributed gate finds
+      #   a wiring problem
       def self.run_boot_gates!(registry, directory)
         gates = BootGates.new
         Ports::Persistence.each_plugin { |plugin| plugin.contribute_boot_gates(registry, gates) }
@@ -149,6 +216,12 @@ module Hecks
       # the real, adapter-aware version of this check and refuses by name
       # ("...is bound to Memory") long before this ever would; this only
       # fires when nothing did, because nothing was loaded to.
+      #
+      # @param registry [Runtime::Registry] the registry mid-boot, whose declared
+      #   `translations` are checked
+      # @return [void]
+      # @raise [Runtime::WiringError] if any translation declares a `computes`/`rekeys`
+      #   rule while no persistence plugin is loaded to interpret it
       def self.check_compute_rules_backstop!(registry)
         return if Ports::Persistence.plugins_loaded?
 
@@ -183,6 +256,12 @@ module Hecks
       # this landed. A domain opts in explicitly, the same way
       # `persisted_by("PostgresEra")` is never inferred from anything
       # else either.
+      #
+      # @param registry [Runtime::Registry] the just-booted registry, whose just-booted
+      #   domain's `.world` is checked for `dispatched_by("Lambda")`
+      # @return [Runtime::Dispatcher, Runtime::RemoteDispatcher] a `RemoteDispatcher`
+      #   bound to `registry` if the domain declares `dispatched_by("Lambda")`, a plain
+      #   `Dispatcher` otherwise
       def self.dispatcher_for(registry)
         domain = registry.bluebooks.keys.first
         settings = registry.world(domain)&.for_verb("dispatched_by") || {}
@@ -191,11 +270,18 @@ module Hecks
         RemoteDispatcher.new(registry, region: settings.fetch(:region, "us-east-1"), function: settings[:function])
       end
 
-      # The door is installed here, not stamped. This used to write the
-      # dispatcher onto every aggregate's class (`ruby_class.runtime =`) — the
-      # class-level global that made two boots in one process share one
-      # name. The facade's modules close over this dispatcher instead, so the
-      # binding lives in the surface a boot installs, not on anything shared.
+      # Installs the facade sugar (`Widget::Item.Add(...)`), closed over
+      # `dispatcher`, and hands `dispatcher` back.
+      #
+      # The door is installed here, not stamped: the facade's modules close
+      # over this dispatcher, so the binding lives in the surface a boot
+      # installs rather than in a class-level global (`ruby_class.runtime =`
+      # on every aggregate's class) that would make two boots in one process
+      # share one name.
+      #
+      # @param dispatcher [Runtime::Dispatcher, Runtime::RemoteDispatcher] the
+      #   just-booted dispatcher the facade should call into
+      # @return [Runtime::Dispatcher, Runtime::RemoteDispatcher] `dispatcher`, unchanged
       def self.bind_runtime(dispatcher)
         Facade::Surface.install(dispatcher)
         dispatcher