donut.system — club.donutpower/system 0.0.103

alias-component clj/s

(alias-component component-id)

creates a compnoent that just provides an instance defined elsewhere in the system

apply-signal-computation-graph clj/s

(apply-signal-computation-graph system)

apply-signal-stage clj/s

(apply-signal-stage system computation-stage-node)

ComponentGroup clj/s

Components are grouped. This theoretically helps if publishing a component library. It also helps when creating multiple instances of the same collection of components because components are allowed to have local refs. See TODO for more details.

ComponentGroupName clj/s

ComponentGroups clj/s

ComponentId clj/s

ComponentLike clj/s

Component-like data shows up in ::defs, ::resolved, and ::instances. None of these are the component per se, but they are the way the component manifests in that context.

ComponentName clj/s

ComponentSelection clj/s

config clj/s multimethod

A way to name different configs, e.g. :test, :dev, :prod, etc. Used by the rest of the donut ecosystem.

config-collect-group-path clj/s

specter path that retains a component's group name

const clj/s

(const m)

Helper for constant map components

default-signals clj/s

which graph to follow to apply signal

DonutSystem clj/s

fmt clj/s

gen-graphs clj/s

(gen-graphs {:keys [:donut.system/selected-component-ids] :as system})

Generates order graphs. If ::selected-component-ids is specified, graphs are filtered to the union of all subgraphs reachable by the selected component ids.

gen-signal-computation-graph clj/s

(gen-signal-computation-graph system signal order)

Graph clj/s

Graphs are used to specify component dependency order and signal application order.

group-ref clj/s

(group-ref x)

group-ref-exception clj/s

(group-ref-exception system
                     referencing-component-id
                     referenced-component-group-name)

group-ref? clj/s

(group-ref? x)

GroupRef clj/s

handler-stage-fn clj/s

(handler-stage-fn system computation-stage-node)

init-signal-computation-graph clj/s

(init-signal-computation-graph system signal)

init-system clj/s

(init-system maybe-system signal-name component-keys)

merge-def clj/s

(merge-def d1 d2)

merges defs, coercing constants to maps

OrderGraphs clj/s

Topsorted and reverse-topsorted graphs are generated once when a system is initialized and assoc'c into the system. These graphs are used when applying signals.

prune-signal-computation-graph clj/s

(prune-signal-computation-graph system computation-stage-node)

Ref clj/s

ref clj/s

(ref k)

ref-exception clj/s

(ref-exception system referencing-component-id referenced-component-id)

ref? clj/s

(ref? x)

remove-nodes clj/s

(remove-nodes g nodes)

remove-signal-computation-stage-node clj/s

(remove-signal-computation-stage-node system computation-stage-node)

resolved clj/s

(resolved {:keys [:donut.system/component-id :donut.system/resolved]})

resume clj/s

(resume system)

signal clj/s

(signal system signal-name & [component-keys])

signal-stage-fn clj/s

(signal-stage-fn system computation-stage-node)

computation node will be e.g. [:env :http-port :start]

signal-stage? clj/s

(signal-stage? stage)

SignalConfig clj/s

The set of signals your system can respond to is configurable. To apply a signal, the system needs to know in what order components should be traversed.

start clj/s

(start config-name)

(start config-name custom-config)

(start config-name custom-config component-ids)

stop clj/s

(stop system)

strk clj/s

(strk & xs)

Like str but with keywords

subsystem-component clj/s

(subsystem-component subsystem & [imports])

Decorates a subsystem so that it can respond to signals when embedded in a parent component.

suspend clj/s

(suspend system)

system-config clj/s

(system-config sconf)

(system-config sconf custom-config)

system-merge clj/s

(system-merge & systems)

system? clj/s

validate-with-malli clj/s

(validate-with-malli _
                     instance-val
                     {:keys [->validation :donut.system/resolved-component]})

helper function for validating component instances with malli if a schema is present.