Skip to content

README.md

Latest commit

 

History

History
80 lines (56 loc) · 2.46 KB

README.md

File metadata and controls

80 lines (56 loc) · 2.46 KB
Raw

Model-First Library

Write the behavior once. Compile it. Run the specifications.

Screenplay · Stage · Commands · Events · Model specifications

Back to all samples

The idea

library.play describes one small catalog workflow as a software model:

AddBook command
    │
    ├── validates title and author
    │
    ▼
BookAddedToCatalog event

The same file contains one accepted example and one rejected example. Screenplay compiles the model; Stage runs those examples as model-level specifications.

flowchart LR
    model[library.play] --> compiler[Screenplay compiler]
    compiler --> stage[Stage specification runner]
    stage --> result[2 model specifications]
Loading

What is in the model

  • BookId, BookTitle, and AuthorName concepts;
  • an AddBook state-change slice;
  • required title and author rules;
  • the BookAddedToCatalog fact;
  • one successful scenario;
  • one expected validation rejection.

Open library.play before running anything—the complete behavior fits on one screen.

Run it

This sample uses already-built local Screenplay and Stage checkouts. With the standard Cratis sibling-repository layout, run these commands from this directory:

export SCREENPLAY_REPO=${SCREENPLAY_REPO:-../../../Screenplay}
export STAGE_REPO=${STAGE_REPO:-../../../Stage}

# Compile the model and treat warnings as errors.
dotnet run --no-build --no-restore \
  --project "$SCREENPLAY_REPO/Source/DotNET/Tool/Tool.csproj" -- \
  "$PWD/library.play" --warnaserror

# Run the specifications embedded in the model.
RESULTS_PATH="${TMPDIR:-/tmp}/cratis-library-stage-results.json"
dotnet run --no-build --no-restore \
  --project "$STAGE_REPO/Source/SpecRunner/SpecRunner.csproj" -- \
  --model "$PWD" --output "$RESULTS_PATH"

cat "$RESULTS_PATH"

The current model compiles without diagnostics and produces two passing specification results.

Make it yours

  • Add an ISBN concept and require it on AddBook.
  • Add a second rejection for an empty author name.
  • Introduce a read model after exploring the focused state-change slice.
  • Change an expected event value and watch the specification catch it.

Note

This is the first bounded model-first step. It verifies compilation and model specifications; it does not yet demonstrate a live Chronicle command, query results, Scene UI, complete source generation, or a Studio round trip.