Sequence diagrams from operations and parts: call/return, async, self-calls, opt/alt/par/break fragments, timeouts

Aperta
  • Qualcosa non va?
#365 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
rust, yaml
Ambito
backend-api-design, data-visualization

Direzione di ricerca

Start by reading crates/syscribe-model/src/vis/derive/sequence.rs and the existing golden SVG/IR tests for derived sequence diagrams. Trace how ActionDef and UseCaseDef subjects map actions to messages and fragments, then compare that with the proposal for PartDef, operations, and the additional UML constructs. Done means the listed constructs have golden coverage, part subjects no longer produce W418, and existing diagrams remain byte-for-byte unchanged where no new construct is used.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Part of #363 (items 2 and 3). Builds on A for operation-based messages.

Current state

crates/syscribe-model/src/vis/derive/sequence.rs: subject is an ActionDef/Action or a UseCaseDef/UseCase with actors:. One Message per SendAction/AcceptAction, one alt fragment per IfAction, one loop per LoopAction. The module states its scope: "no return, create or destroy messages". A PartDef/Part as subject is W418 and the diagram is empty.

Proposal

  1. Subjects. A PartDef/Part subject derives a sequence from the actions it performs: (and from the operations it provides, once A lands), instead of W418.
  2. Messages. Call versus return (a sync operation draws a call and a dashed return carrying the return value and declared errors), async (open arrowhead), self-calls, create and destroy where a model field declares them, and message labels op(arg: T): R from the operation signature.
  3. Fragments. opt (an if without else), alt with a visible else divider per branch, par (from Fork/Join), break, and loop with its guard. Nesting as today.
  4. Timeouts. A timeout on a call or accept (after:) drawn as a timing constraint on the message or as a labelled alt branch.
  5. Keep determinism and fixed layout: lifelines at fixed pitch, messages by row, as today.

Acceptance (tests first)

  • Golden SVG/IR tests for each construct: call and return, async, self-call, opt, alt/else, par, break, nested fragments.
  • A PartDef subject with performs: no longer raises W418 and shows its messages.
  • Existing derived sequence diagrams are unchanged byte for byte unless they use a new construct.

Part of #272 (executable MBSE / software design).

Generated by Claude Code

Lingua principale
Rust
Stelle
8
Fork
1
Merge medio
3h 35m
PR unite (30g)
69

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di sjames/syscribe

Tutte le issue di sjames/syscribe

Issue simili

Altre issue su Rust

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.