hecks 0.2.0 → 0.3.0

data/lib/hecks/language/hecksagon/port_operation.bluebook

@@ -0,0 +1,102 @@
+Hecks.bluebook "Hecksagon" do
+  aggregate "PortOperation" do
+    description "One operation a port exposes — the same shape a command's payload has (attributes in, an event out) with none of a command's given/ensures/sets : a port operation is the translation boundary itself, not a second place business rules live. Those stay on whichever command a policy triggers in reaction to the event it emits."
+
+    identified_by OperationName, as: :name
+
+    attribute :attributes, list_of(PortOperationField)
+    attribute :emits,      list_of(EmittedEvent)
+
+    # THE TWO ENDINGS OF AN `asks`, held by the language about itself.
+    #
+    # `emits` above is what an inbound `tells` says once the fact is in.
+    # These two are the outbound half: what the adapter came back with, and
+    # what it said instead. Singular where `emits` is a list, because an ask
+    # has exactly one of each — a call that could answer two different ways
+    # is two calls.
+    #
+    # Empty on every `tells`, which is why neither carries an invariant
+    # demanding a value; `PortOperationBuilder` refuses the wrong word for
+    # the direction long before a record gets here.
+    attribute :answers,    AnsweringEvent
+    attribute :refuses,    RefusingEvent
+
+    value_object "OperationName" do
+      attribute :value, String
+      invariant("an operation is named") { !value.to_s.empty? }
+    end
+
+    value_object "PortOperationField" do
+      attribute :name, String
+      attribute :type, String
+    end
+
+    value_object "EmittedEvent" do
+      attribute :value, String
+      invariant("an emitted event is named") { !value.to_s.empty? }
+    end
+
+    value_object "AnsweringEvent" do
+      attribute :value, String
+    end
+
+    value_object "RefusingEvent" do
+      attribute :value, String
+    end
+
+    # HOW PORTOPERATION IS SPELLED. These rows live with the concept
+    # they describe; SyntaxBoot discovers every aggregate-local seed table.
+    # Contexts represented here: PortOperation.
+    value_object "KeywordSeed" do
+      attribute :word,          String
+      attribute :context,       String, admits: "Syntax::Context"
+      attribute :body,          String, admits: "Syntax::Body"
+      attribute :inner,         String
+      attribute :opens,         String
+      attribute :fills,         String
+      attribute :status,        String, default: "admitted", admits: "Syntax::Status"
+      attribute :was,           String
+      attribute :resolves_via,  String, default: "", admits: "Syntax::ResolutionScope"
+      attribute :disambiguator, String, default: "", admits: "Syntax::Disambiguator"
+
+      member word: "reference_to",    context: "PortOperation", body: "none",     inner: "",              opens: "",              fills: "attributes", calls: "reference_to_impl"
+      member word: "attribute",       context: "PortOperation", body: "none",     inner: "",              opens: "",              fills: "attributes", calls: "attribute_impl"
+      member word: "emits",           context: "PortOperation", body: "none",     inner: "",              opens: "",              fills: "emits"
+      member word: "answers",         context: "PortOperation", body: "none",     inner: "",              opens: "",              fills: "answers"
+      member word: "refuses",         context: "PortOperation", body: "none",     inner: "",              opens: "",              fills: "refuses"
+
+    end
+
+    value_object "ArgumentSeed" do
+      attribute :keyword,          String
+      attribute :context,          String, admits: "Syntax::Context"
+      attribute :at,               String
+      attribute :named,            String
+      attribute :kind,             String, admits: "Syntax::ArgumentKind"
+      attribute :required,         String
+      attribute :fills,            String
+      attribute :selects,          String
+      attribute :pair_key_fills,   String
+      attribute :pair_value_fills, String
+      attribute :pairs_shape,      String, admits: "Syntax::PairsShape"
+      attribute :status,           String, default: "admitted", admits: "Syntax::Status"
+      attribute :variadic,         String
+      attribute :coerce,           String
+      attribute :blank_message,    String
+
+      member keyword: "reference_to",    context: "PortOperation", at: "1", named: "", kind: "constant", required: "true", fills: "type"
+      member keyword: "reference_to",    context: "PortOperation", at: "",  named: "as", kind: "symbol", required: "false", fills: "name"
+      member keyword: "attribute",       context: "PortOperation", at: "1", named: "",        kind: "symbol",   required: "true",  fills: "name"
+      member keyword: "attribute",       context: "PortOperation", at: "2", named: "",        kind: "constant", required: "true",  fills: "type"
+      member keyword: "attribute",       context: "PortOperation", at: "",  named: "default",  kind: "literal",  required: "false", fills: "default"
+      member keyword: "attribute",       context: "PortOperation", at: "",  named: "optional", kind: "flag",     required: "false", fills: "optional"
+      member keyword: "attribute",       context: "PortOperation", at: "",  named: "pattern",  kind: "text",     required: "false", fills: "pattern"
+      member keyword: "attribute",       context: "PortOperation", at: "",  named: "admits",   kind: "text",     required: "false", fills: "admits"
+      member keyword: "attribute",       context: "PortOperation", at: "",  named: "one_of",   kind: "list",     required: "false", fills: "one_of"
+      member keyword: "emits",           context: "PortOperation", at: "1", named: "", kind: "text", required: "true", fills: "emits"
+      member keyword: "answers",         context: "PortOperation", at: "1", named: "", kind: "text", required: "true", fills: "answers"
+      member keyword: "refuses",         context: "PortOperation", at: "1", named: "", kind: "text", required: "true", fills: "refuses"
+
+    end
+  end
+end

data/lib/hecks/language/oidc.json

@@ -0,0 +1,313 @@
+{
+  "audience": "Bluebook",
+  "scopes": [
+    {
+      "scope": "bluebook:aggregate.attribute",
+      "verb": "Bluebook::Aggregate.Attribute",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:aggregate.declare",
+      "verb": "Bluebook::Aggregate.Declare",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:aggregate.holds",
+      "verb": "Bluebook::Aggregate.Holds",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:aggregate.identify",
+      "verb": "Bluebook::Aggregate.Identify",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:aggregate.invariant",
+      "verb": "Bluebook::Aggregate.Invariant",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:aggregate.lifecycle",
+      "verb": "Bluebook::Aggregate.Lifecycle",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:aggregate.precondition",
+      "verb": "Bluebook::Aggregate.Precondition",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:aggregate.projects",
+      "verb": "Bluebook::Aggregate.Projects",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:aggregate.reference",
+      "verb": "Bluebook::Aggregate.Reference",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:aggregate.seal",
+      "verb": "Bluebook::Aggregate.Seal",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:aggregate.transition",
+      "verb": "Bluebook::Aggregate.Transition",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:aggregate.value",
+      "verb": "Bluebook::Aggregate.Value",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:bluebook.attach",
+      "verb": "Bluebook::Bluebook.Attach",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:bluebook.declare",
+      "verb": "Bluebook::Bluebook.Declare",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:bluebook.normalise",
+      "verb": "Bluebook::Bluebook.Normalise",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:command.acts_on",
+      "verb": "Bluebook::Command.ActsOn",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:command.announce",
+      "verb": "Bluebook::Command.Announce",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:command.argument",
+      "verb": "Bluebook::Command.Argument",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:command.change",
+      "verb": "Bluebook::Command.Change",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:command.declare",
+      "verb": "Bluebook::Command.Declare",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:command.ensure",
+      "verb": "Bluebook::Command.Ensure",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:command.reference",
+      "verb": "Bluebook::Command.Reference",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:command.rule",
+      "verb": "Bluebook::Command.Rule",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:entity.attribute",
+      "verb": "Bluebook::Entity.Attribute",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:entity.declare",
+      "verb": "Bluebook::Entity.Declare",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:entity.identify",
+      "verb": "Bluebook::Entity.Identify",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:entity.invariant",
+      "verb": "Bluebook::Entity.Invariant",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:entity.lifecycle",
+      "verb": "Bluebook::Entity.Lifecycle",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:entity.precondition",
+      "verb": "Bluebook::Entity.Precondition",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:entity.seal",
+      "verb": "Bluebook::Entity.Seal",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:entity.transition",
+      "verb": "Bluebook::Entity.Transition",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:policy.bind",
+      "verb": "Bluebook::Policy.Bind",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:policy.declare",
+      "verb": "Bluebook::Policy.Declare",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:process_manager.declare",
+      "verb": "Bluebook::ProcessManager.Declare",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:process_manager.handler",
+      "verb": "Bluebook::ProcessManager.Handler",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:process_manager.handler.dispatch",
+      "verb": "Bluebook::ProcessManager.Handler.Dispatch",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:process_manager.handler.dispatch.bind",
+      "verb": "Bluebook::ProcessManager.Handler.Dispatch.Bind",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:process_manager.state",
+      "verb": "Bluebook::ProcessManager.State",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:query.argument",
+      "verb": "Bluebook::Query.Argument",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:query.declare",
+      "verb": "Bluebook::Query.Declare",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:query.filter",
+      "verb": "Bluebook::Query.Filter",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:query.option",
+      "verb": "Bluebook::Query.Option",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:read_model.count",
+      "verb": "Bluebook::ReadModel.Count",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:read_model.declare",
+      "verb": "Bluebook::ReadModel.Declare",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:read_model.gather",
+      "verb": "Bluebook::ReadModel.Gather",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:read_model.group_by",
+      "verb": "Bluebook::ReadModel.GroupBy",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:read_model.median",
+      "verb": "Bluebook::ReadModel.Median",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:read_model.option",
+      "verb": "Bluebook::ReadModel.Option",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:syntax.argument",
+      "verb": "Bluebook::Syntax.Argument",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:syntax.argument.deprecate",
+      "verb": "Bluebook::Syntax.Argument.Deprecate",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:syntax.argument.retire",
+      "verb": "Bluebook::Syntax.Argument.Retire",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:syntax.declare",
+      "verb": "Bluebook::Syntax.Declare",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:syntax.keyword",
+      "verb": "Bluebook::Syntax.Keyword",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:syntax.keyword.deprecate",
+      "verb": "Bluebook::Syntax.Keyword.Deprecate",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:syntax.keyword.retire",
+      "verb": "Bluebook::Syntax.Keyword.Retire",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:value_object.assert",
+      "verb": "Bluebook::ValueObject.Assert",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:value_object.close",
+      "verb": "Bluebook::ValueObject.Close",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:value_object.declare",
+      "verb": "Bluebook::ValueObject.Declare",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:value_object.field",
+      "verb": "Bluebook::ValueObject.Field",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:value_object.member",
+      "verb": "Bluebook::ValueObject.Member",
+      "role": "Language"
+    },
+    {
+      "scope": "bluebook:value_object.member.pair",
+      "verb": "Bluebook::ValueObject.Member.Pair",
+      "role": "Language"
+    }
+  ],
+  "roles": [
+    "Language"
+  ]
+}

data/lib/hecks/language/port.bluebook

@@ -0,0 +1,92 @@
+Hecks.bluebook "Port" do
+  vision "The .port language, declared in itself. A port names one resource door a domain's own aggregates call by verb — persisted_by, posted_by, whatever a chapter spells — bound to a real driven adapter at the world level. A sibling artifact to the bluebook, not part of one: the same port name is reused across every domain that needs the same kind of door."
+  core
+
+  aggregate "Port" do
+    description "One .port — a resource door a domain's own aggregates call by verb, and whether calling it answers with a value (reply) or fires an effect with nothing to hand back (effect)."
+
+    identified_by PortName, as: :name
+
+    attribute :verb,   PortVerb
+    attribute :signal, PortSignal
+
+    value_object "PortName" do
+      attribute :value, String
+      invariant("a port names itself") { !value.to_s.empty? }
+    end
+
+    value_object "PortVerb" do
+      attribute :value, String
+      invariant("a port's verb says something") { !value.to_s.empty? }
+    end
+
+    value_object "PortSignal" do
+      attribute :value, String, one_of: ["reply", "effect"]
+    end
+
+    command "Declare" do
+      role "Deployment"
+      goal "Open a resource door a domain's own aggregates may call by verb"
+
+      attribute :name,   PortName
+      # OPTIONAL — real, pre-existing PortBuilder behavior (spec/dsl_spec
+      # .rb's own "signal says whether the domain gets a value back..."
+      # builds a port with only `signal`, never calling `verb` at all;
+      # `def verb(value)` has no default, unlike `signal`'s `:reply`).
+      # Same asymmetry world.bluebook's own Declare command already has
+      # for `realm`/`latest`.
+      attribute :verb,   PortVerb, optional: true
+      attribute :signal, PortSignal
+
+      sets :name
+      sets :verb
+      sets :signal
+
+      emits "PortDeclared"
+    end
+
+    # HOW PORT IS SPELLED. These rows live with the concept
+    # they describe; SyntaxBoot discovers every aggregate-local seed table.
+    # Contexts represented here: File, Port.
+    value_object "KeywordSeed" do
+      attribute :word,          String
+      attribute :context,       String, admits: "Syntax::Context"
+      attribute :body,          String, admits: "Syntax::Body"
+      attribute :inner,         String
+      attribute :opens,         String
+      attribute :fills,         String
+      attribute :status,        String, default: "admitted", admits: "Syntax::Status"
+      attribute :was,           String
+      attribute :resolves_via,  String, default: "", admits: "Syntax::ResolutionScope"
+      attribute :disambiguator, String, default: "", admits: "Syntax::Disambiguator"
+
+      member word: "port",            context: "File",     body: "keywords", inner: "Port",           opens: "Port",           fills: ""
+      member word: "verb",            context: "Port",      body: "none", inner: "", opens: "", fills: "verb"
+      member word: "signal",          context: "Port",      body: "none", inner: "", opens: "", fills: "signal"
+
+    end
+
+    value_object "ArgumentSeed" do
+      attribute :keyword,          String
+      attribute :context,          String, admits: "Syntax::Context"
+      attribute :at,               String
+      attribute :named,            String
+      attribute :kind,             String, admits: "Syntax::ArgumentKind"
+      attribute :required,         String
+      attribute :fills,            String
+      attribute :selects,          String
+      attribute :pair_key_fills,   String
+      attribute :pair_value_fills, String
+      attribute :pairs_shape,      String, admits: "Syntax::PairsShape"
+      attribute :status,           String, default: "admitted", admits: "Syntax::Status"
+      attribute :variadic,         String
+      attribute :coerce,           String
+      attribute :blank_message,    String
+
+      member keyword: "port",            context: "File", at: "1", named: "", kind: "text", required: "true", fills: "name"
+      member keyword: "verb",            context: "Port", at: "1", named: "", kind: "text",   required: "true", fills: "verb"
+      member keyword: "signal",          context: "Port", at: "1", named: "", kind: "symbol", required: "true", fills: "signal"
+
+    end
+  end
+end

data/lib/hecks/language/translation/translation.bluebook

@@ -0,0 +1,110 @@
+Hecks.bluebook "Translation" do
+  aggregate "Translation" do
+    description "One translations/*.bluebook edge — a domain moving from one pinned era to the next, aggregate by aggregate."
+
+    identified_by :domain, :from, :to
+
+    attribute :domain, TranslationDomainName
+    attribute :from,   TranslationEraName
+    attribute :to,     TranslationEraName
+    attribute :retired, list_of(TranslationName)
+
+    value_object "TranslationDomainName" do
+      attribute :value, String
+      invariant("a translation names its domain") { !value.to_s.empty? }
+    end
+
+    value_object "TranslationEraName" do
+      attribute :value, String
+      invariant("a translation names its own era") { !value.to_s.empty? }
+    end
+
+    value_object "TranslationName" do
+      attribute :value, String
+      invariant("a name says something") { !value.to_s.empty? }
+    end
+
+    # ARBITRARY, UNVALIDATED CAPTURE — `convert`'s own `values:` table and
+    # `backfill`'s own `default:` are open-ended (any literal a real
+    # migration needs), the same shape `AggregateBuilder#provenance`/
+    # `CommandBuilder#provenance` already capture as plain, unvalidated
+    # text (`LiteralText`, aggregate.bluebook) rather than a fixed
+    # attribute shape a closed self-hosted record could enumerate.
+    value_object "TranslationLiteralText" do
+      attribute :value, String
+    end
+
+    command "Declare" do
+      role "Deployment"
+      goal "Open a domain's own move from one pinned era to the next"
+
+      attribute :domain, TranslationDomainName
+      attribute :from,   TranslationEraName
+      attribute :to,     TranslationEraName
+
+      sets :domain
+      sets :from
+      sets :to
+
+      emits "TranslationDeclared"
+    end
+
+    command "Retire" do
+      role "Deployment"
+      goal "Name an aggregate the new era drops outright, not renamed"
+
+      attribute :value, TranslationName
+
+      sets :retired, append: { value: :value }
+
+      emits "TranslationAggregateRetired"
+    end
+
+    # HOW TRANSLATION IS SPELLED. These rows live with the concept
+    # they describe; SyntaxBoot discovers every aggregate-local seed table.
+    # Contexts represented here: File, Translation.
+    value_object "KeywordSeed" do
+      attribute :word,          String
+      attribute :context,       String, admits: "Syntax::Context"
+      attribute :body,          String, admits: "Syntax::Body"
+      attribute :inner,         String
+      attribute :opens,         String
+      attribute :fills,         String
+      attribute :status,        String, default: "admitted", admits: "Syntax::Status"
+      attribute :was,           String
+      attribute :resolves_via,  String, default: "", admits: "Syntax::ResolutionScope"
+      attribute :disambiguator, String, default: "", admits: "Syntax::Disambiguator"
+
+      member word: "data_translation", context: "File",    body: "keywords", inner: "Translation",    opens: "Translation",    fills: ""
+      member word: "aggregate",       context: "Translation", body: "keywords", inner: "TranslationAggregate", opens: "TranslationAggregate", fills: "", calls: "aggregate_impl"
+      member word: "retired",         context: "Translation", body: "none",     inner: "",                     opens: "",                     fills: "retired"
+
+    end
+
+    value_object "ArgumentSeed" do
+      attribute :keyword,          String
+      attribute :context,          String, admits: "Syntax::Context"
+      attribute :at,               String
+      attribute :named,            String
+      attribute :kind,             String, admits: "Syntax::ArgumentKind"
+      attribute :required,         String
+      attribute :fills,            String
+      attribute :selects,          String
+      attribute :pair_key_fills,   String
+      attribute :pair_value_fills, String
+      attribute :pairs_shape,      String, admits: "Syntax::PairsShape"
+      attribute :status,           String, default: "admitted", admits: "Syntax::Status"
+      attribute :variadic,         String
+      attribute :coerce,           String
+      attribute :blank_message,    String
+
+      member keyword: "data_translation", context: "File", at: "1", named: "", kind: "text", required: "true", fills: "name"
+      member keyword: "data_translation", context: "File", at: "",  named: "from", kind: "text", required: "true", fills: "from"
+      member keyword: "data_translation", context: "File", at: "",  named: "to",   kind: "text", required: "true", fills: "to"
+      member keyword: "aggregate",       context: "Translation", at: "1", named: "",     kind: "text", required: "true",  fills: "name"
+      member keyword: "aggregate",       context: "Translation", at: "",  named: "was",  kind: "text", required: "false", fills: "was"
+      member keyword: "retired",         context: "Translation", at: "1", named: "",     kind: "text", required: "true",  fills: "name", blank_message: "a retired needs an aggregate name"
+
+    end
+  end
+end