Update README: new primitives, fetch/pick, BBS::Color

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
2026-04-30 10:41:39 +02:00
parent bd8aa51684
commit 15cd593b33

View File

@@ -49,22 +49,45 @@ The entire dialogue is defined as a declarative `BBS::Flow.define` block.
### Primitives ### Primitives
#### Output
| Primitive | Description | | Primitive | Description |
|---|---| |---|---|
| `screen :name, **vars` | Render an ERB screen from `screens/`; vars override/extend the context | | `screen :name, **vars` | Render an ERB screen from `screens/`; vars override/extend the context |
| `banner "text", style:` | Print a box-drawing ASCII banner | | `banner "text", style:` | Print a box-drawing ASCII banner |
| `big_banner "text", style:, font:` | Print a large FIGlet ASCII-art banner (default font: `slant`) | | `big_banner "text", style:, font:` | Print a large FIGlet ASCII-art banner (default font: `slant`) |
| `say "text", style:` | Print a single styled line | | `say "text", style:` | Print a single styled line |
| `text "content", style:` | Print a line; accepts a block `{ \|ctx\| string }` for dynamic content |
| `section "title", color:` | Print a decorated section header with box-drawing |
| `line color:` | Print a horizontal rule |
| `rows(empty: "…") { \|ctx\| array }` | Print a list of lines; shows `empty` when the array is empty |
| `table { \|ctx\| hash }` | Print a two-column key/value table |
| `body(width:, indent:) { \|ctx\| string }` | Word-wrap and print a block of text (strips basic Markdown) |
| `output { \|ctx\| string }` | Write a raw string returned by the block verbatim |
#### Input & control
| Primitive | Description |
|---|---|
| `ask :field, prompt:, transform:, validate:` | Read input and store it in the session context | | `ask :field, prompt:, transform:, validate:` | Read input and store it in the session context |
| `set :field, value` | Set a context variable directly from code | | `set :field, value` | Set a context variable directly from code |
| `persist :field, …, store:` | Write named context fields to a `BBS::Store` | | `persist :field, …, store:` | Write named context fields to a `BBS::Store` |
| `pause "message", seconds:` | Display a message and sleep | | `pause "message", seconds:` | Display a message and sleep |
| `wait_enter prompt:` | Print a prompt and block until the user presses Enter |
| `gate denied: "…" { \|ctx\| bool }` | Halt the flow unless the block returns true | | `gate denied: "…" { \|ctx\| bool }` | Halt the flow unless the block returns true |
| `confirm "message", denied: "…"` | Yes/no gate — halts on no | | `confirm "message", denied: "…"` | Yes/no gate — halts on no |
| `confirm "message", denied: "…" { }` | Yes/no branch — runs the block on yes, skips on no | | `confirm "message", denied: "…" { }` | Yes/no branch — runs the block on yes, skips on no |
| `call { \|ctx\| }` | Run an arbitrary block; return `:halt` to end the session |
| `menu "prompt", loop: bool { }` | Numbered option menu; loops back after each selection when `loop: true` | | `menu "prompt", loop: bool { }` | Numbered option menu; loops back after each selection when `loop: true` |
| `exit_menu` | Break out of the enclosing `menu` loop and continue the parent flow | | `exit_menu` | Break out of the enclosing `menu` loop and continue the parent flow |
#### Data fetching
| Primitive | Description |
|---|---|
| `fetch :key, loading: "…" { \|ctx\| value }` | Show a loading message, call the block, store the result in `ctx[:key]`, erase the loading line |
| `pick from:, prompt:, empty:, item:, hint: { sub-flow }` | Show a numbered list from `ctx[from]`; on selection stores the item in `ctx[:picked]` and runs the sub-flow |
### `ask` options ### `ask` options
| Option | Description | | Option | Description |
@@ -77,6 +100,28 @@ The entire dialogue is defined as a declarative `BBS::Flow.define` block.
`:success`, `:info`, `:error`, `:warning`, `:muted` — each maps to an ANSI colour. `:success`, `:info`, `:error`, `:warning`, `:muted` — each maps to an ANSI colour.
### `fetch` + `pick` example
```ruby
option 'Blog Posts' do
section 'Blog Posts', color: :blue
fetch :pages, loading: 'Loading...' do |ctx|
WIKI.list('blog')
end
pick from: :pages,
empty: 'No results.',
prompt: 'Enter number to read (blank to go back)',
item: ->(p, i) { "#{i}. #{p.title}" },
hint: ->(p, i) { p.description.to_s[0...65] } do
fetch :body, loading: 'Loading page...' do |ctx|
WIKI.content(ctx[:picked].id)
end
body { |ctx| ctx[:body] }
wait_enter
end
end
```
### Menu example ### Menu example
```ruby ```ruby
@@ -123,6 +168,22 @@ persist :email, store: signups
Rows are keyed by `session_id`: the first `persist` for a session creates the row; subsequent ones update it in place. Rows are keyed by `session_id`: the first `persist` for a session creates the row; subsequent ones update it in place.
## Colors
`BBS::Color` is a `module_function` module you can `include` to get the `c` helper anywhere — top-level, inside lambdas, and inside `instance_eval` blocks.
```ruby
include BBS::Color
c(:green, "[▶ Play]") # => "\e[1;32m[▶ Play]\e[0m"
c(:gray, "some text")
c(:yellow, msg.timestamp)
```
Available color symbols: `:reset`, `:gray`, `:yellow`, `:white`, `:blue`, `:cyan`, `:green`, `:magenta`, `:red`.
Raises `KeyError` on unknown symbols.
## Architecture ## Architecture
| File | Responsibility | | File | Responsibility |
@@ -132,6 +193,7 @@ Rows are keyed by `session_id`: the first `persist` for a session creates the ro
| `bbs/telnet.rb` | Telnet protocol (IAC handling, echo control, readline) | | `bbs/telnet.rb` | Telnet protocol (IAC handling, echo control, readline) |
| `bbs/flow.rb` | Flow DSL builder | | `bbs/flow.rb` | Flow DSL builder |
| `bbs/flow_runner.rb` | Executes a Flow step by step against a session context | | `bbs/flow_runner.rb` | Executes a Flow step by step against a session context |
| `bbs/color.rb` | `BBS::Color` module with ANSI color map and `c()` helper |
| `bbs/config.rb` | Configuration object | | `bbs/config.rb` | Configuration object |
| `bbs/banner.rb` | Box-drawing and FIGlet banner renderer | | `bbs/banner.rb` | Box-drawing and FIGlet banner renderer |
| `bbs/renderer.rb` | ERB screen loader with ANSI colour helpers | | `bbs/renderer.rb` | ERB screen loader with ANSI colour helpers |