summaryrefslogtreecommitdiffhomepage
path: root/gleam/README.md
diff options
context:
space:
mode:
authorRalph Amissah <ralph.amissah@gmail.com>2026-09-24 16:33:53 -0400
committerRalph Amissah <ralph.amissah@gmail.com>2026-09-24 16:33:53 -0400
commitbbe505c8d48e822c012c9820dfe93b83dc61bcab (patch)
tree3385f5420959ff20af295c3125a080297555a72b /gleam/README.md
parentdealing with six properties including .is_of_type (diff)
--validate, and a second reader, in Gleam
--validate: the specification, executed. A validator written from ssp-format-specification.md and from nothing else, so that a file can be held against the document rather than against an implementation. Each finding names the specification section it comes from, so a disagreement can be taken back to the text. It checks the version banner and its major part, the file shape and the order of the preamble blocks and the nine sections, the two spaces of a preamble pair, the object declaration and its sixteen kinds and eight heading levels, that a property is one of the 42 and in the emitted order, that text lines carry their prefix, the ten keys of doc_has, and that no line is of a shape the specification does not define. Every .ssp of the markup document samples validates clean. Five classes of deliberate breakage are caught: an unknown major version, a property that is not one of the 42, a property out of order, a kind that is not one of the sixteen, and a block that is neither preamble nor section. Writing it found two rules the specification implied and did not state (repeated properties are consecutive; no property follows the text), and both were written into it. One repository, a reader per language. The readers are not separate tools that share a name. They are the same specification implemented more than once, and the interesting thing about them is that they agree, so they are published as one thing with that claim at the top of it. The D reader moves to dlang/; the Gleam reader arrives at gleam/. The language directory is named for the language and not for the tool: gleam refuses a hyphenated package name, so ssp-reader cannot be a gleam package and must be ssp_reader. A .gitignore for the repository, denying everything and whitelisting what belongs, covering both languages. Both build under nix, sandboxed and without network. There is no gleam builder in nixpkgs and gleam build fetches from Hex, so the Gleam build uses nix-gleam's builder, kept in gleam/nix-gleam/ (MIT), which fetches each Hex package by the checksum manifest.toml already carries, with no hash to maintain; the result is an escript wrapped with erlang. The D reader depends on nothing beyond phobos, so --skip-registry=all is the whole of what it takes: ldc by default, dmd available as ssp-reader-dmd (given gcc14, GCC 15 having introduced nullptr in headers dmd's ImportC does not yet parse). (assisted by Claude-Code)
Diffstat (limited to 'gleam/README.md')
-rw-r--r--gleam/README.md82
1 files changed, 82 insertions, 0 deletions
diff --git a/gleam/README.md b/gleam/README.md
new file mode 100644
index 0000000..32d4cf7
--- /dev/null
+++ b/gleam/README.md
@@ -0,0 +1,82 @@
+# ssp-reader, in Gleam
+
+Reads a `.ssp`, the object-centric document abstraction written as text,
+and says what it found and what it did not understand.
+
+**Written from the specification alone**, as an experiment in whether that
+specification suffices:
+
+- `ssp-format-specification.md`, from the **doc-abstraction-format**
+ specification
+- `ocda-model.md`, from the same
+
+No reference was made to spine's emitter or to the D reader while writing
+it. The constants it carries (the sixteen kinds, the nine sections, the
+four preamble blocks, the 42 properties in their emitted order) were taken
+from the specification's own tables.
+
+## Building and running
+
+```sh
+nix build # the reader, as a single-file escript
+./result/bin/ssp_reader <file.ssp>
+```
+
+`nix build` works **sandboxed and without network**. There is no Gleam
+builder in nixpkgs and `gleam build` fetches from Hex, so the build uses
+nix-gleam's builder, kept in `nix-gleam/` (MIT, see its README), which
+fetches each Hex package on its own by the checksum `manifest.toml` already
+carries. There is no hash in `flake.nix` to keep up to date. The result
+needs only what it carries: run it with an empty environment and it works.
+
+For development:
+
+```sh
+nix develop # gleam, erlang, rebar3
+gleam run -- <file.ssp>
+gleam run -- --outline <file.ssp>
+gleam run -- --report-unknown <file.ssp>
+gleam run -- --any-version <file.ssp>
+```
+
+## What it does
+
+- Reads the version banner and **checks the major part**, refusing a major
+ it does not know (specification section 2.1). `--any-version` overrides.
+- Parses the four preamble blocks, the nine sections, and the object
+ records: declaration line, properties, text.
+- `--outline` prints the headings indented by level.
+- `--report-unknown` lists every property it did not use, with counts.
+
+## Agreement with the D reader
+
+Both implementations were run over the 36 document reference collection
+and **agree on the section counts of all 36**.
+
+## Tests
+
+```sh
+gleam test
+```
+
+Ten, against small literals rather than files, since the parser is a pure
+function from text to a document. Each names the specification section it
+holds the parser to: the version banner, the `% Source:` line, `@source`
+being preamble and not a section, the object declaration, text line order,
+ancestors as numbers, that a `comment` object does not render, that an
+unused property is counted rather than dropped, and that a line of no known
+shape is counted.
+
+## What it does not do
+
+- The `.ocda.db`, which would want an Erlang sqlite binding.
+- HTML, JSONL or plain-text output.
+- Packaging as an escript, so it needs `gleam run`.
+
+## Layout
+
+```
+src/ssp_reader.gleam the program: arguments, version gate, output
+src/ssp/types.gleam the document, the object, the version rule
+src/ssp/parse.gleam the parser, a fold over the lines
+```