]> dreyeck.freedombox.rocks Git - topic-maps.git/blob - README.md
feat(ctm): read associations and roles with merge-safe topic references
[topic-maps.git] / README.md
1 # Common Lisp Topic Maps — Slice 3
2
3 A working ANSI Common Lisp reader for CTM identity/default-name syntax and
4 unary/binary Associations, with same-map merging of Topics, Names, Associations
5 and Roles in a bounded TMDM model. HyperDoc remains a possible future client
6 and is neither the codebase nor a dependency. There is no CXTM canonicalizer,
7 Template implementation or cross-document merge engine.
8
9 Systems: `topic-maps` (the retained foundation), `topic-maps/tests`,
10 `topic-maps/tmdm`, `topic-maps/ctm`, `topic-maps/ctm/tests` and
11 `topic-maps/ctm/merging-tests` and `topic-maps/ctm/association-tests`.
12 The core reader/model uses ANSI Common Lisp; the foundation/tooling uses
13 ASDF/UIOP and Python's standard library. No Quicklisp packages are required.
14
15 Start with [Reading the First CTM Associations](docs/reading-first-ctm-associations.md)
16 for actual Association/Role items, late Topic merges and current subset boundaries.
17 [Reading Topic Identity and Merging](docs/reading-topic-merging.md)
18 for the current API, reference replacement, identifier tails and exact subset
19 boundaries. See [Reading the First Five CTM Documents](docs/reading-first-five-ctm-documents.md)
20 for original sources, actual objects, normative clauses, baseline evidence and
21 copy-pasteable DESCRIBE forms. [API and boundaries](docs/slice-1-api-and-boundaries.md)
22 document the accepted Slice 1 baseline; the Slice 2 document supersedes its
23 statements about absent identity tails, merging and immutable Name references.
24 The Slice 3 document supersedes historical statements about absent Associations/Roles.
25
26 The pinned suite targets the **CTM draft dated 2010-03-31**. Passing it alone
27 does not establish full ISO/IEC 13250-6:2010 conformity.
28
29 ## Load and inspect
30
31 In a new Common Lisp process, with this checkout selected:
32
33 ```lisp
34 (require :asdf)
35 (asdf:initialize-source-registry
36 '(:source-registry :ignore-inherited-configuration))
37 (asdf:load-asd #p"/Users/rgb/workspace/topic-maps/topic-maps.asd")
38 (asdf:load-system "topic-maps/ctm")
39 (asdf:load-system "topic-maps")
40 (defparameter *corpus* (topic-maps.test-foundation:discover-corpus))
41 (topic-maps.test-foundation:summarize-corpus *corpus*)
42 (topic-maps.test-foundation:select-cases *corpus* :category :invalid)
43 (topic-maps.test-foundation:select-cases *corpus* :id "ctm/in/simple.ctm")
44 (asdf:test-system "topic-maps/tests")
45 (asdf:test-system "topic-maps/ctm/tests")
46 (asdf:test-system "topic-maps/ctm/merging-tests")
47 (asdf:test-system "topic-maps/ctm/association-tests")
48 (topic-maps.test-foundation:write-validation-report
49 *corpus* #p"/tmp/topic-maps-inventory.json")
50 ```
51
52 Change only the checkout pathname when using another machine. The case's
53 Document IRI remains independent of that pathname. Records are inspectable
54 Common Lisp structures, with actual source/baseline pathnames and explicit
55 contracts, results, statuses, diagnostics and reviewed clauses.
56
57 ## Offline verification
58
59 ```sh
60 # SBCL must already be installed. No network is used by this command.
61 TOPIC_MAPS_REPORT=/tmp/topic-maps-validation.json ./scripts/test.sh
62 ```
63
64 Set `SBCL=/absolute/path/to/sbcl` if needed. The launcher starts a new process,
65 ignores system/user initialization, clears inherited ASDF source configuration
66 and writes FASLs outside the repository. It runs byte-integrity fixtures,
67 Common Lisp infrastructure checks and an independent JSON-schema/content check
68 when a report pathname is supplied. `nix develop path:.` supplies a minimal,
69 pinned SBCL/Python/Git environment; initial environment provisioning may need
70 network access, while test execution after provisioning does not.
71
72 The complete upstream corpus is already vendored, unchanged. If absent in a
73 source distribution, acquire it once:
74
75 ```sh
76 python3 scripts/corpus.py acquire
77 python3 scripts/corpus.py verify
78 ```
79
80 Acquisition uses the exact commit and archive digest in
81 [corpus-lock.json](references/corpus-lock.json), refuses to merge over existing
82 contents and verifies every file. Verification is offline. Valid CTM inputs
83 are selected only under `ctm/in`, invalid ones only under `ctm/invalid`, and
84 CXTM baselines only under `ctm/baseline`. Auxiliary files are reported separately.
85
86 ## Current validation and historical foundation
87
88 The complete pinned corpus remains unchanged: 231 valid CTM inputs, 42 invalid
89 inputs, 231 CXTM baselines and 22 CTM auxiliary files. Twenty-four selected semantic
90 cases pass; their imported canonical contracts remain NOT-RUN. Only
91 `ctm/invalid/prefix-undefined.ctm` is PASS under its CTM rejection contract;
92 272 imported contracts remain NOT-RUN. Unsupported constructs and I/O errors
93 cannot count as that required rejection.
94
95 The full launcher runs the retained 54 foundation checks, two Python integrity
96 fixtures, 123 retained identity checks, 646 merge checks, 657 Association checks,
97 imported-report validation and selected baseline
98 property evidence. A report path also produces `<path>.semantics.json` with
99 separate model observations, plus `<path>.merging.json` and `<path>.associations.json`.
100 The merge checks include 128 graph/order variants with an independent reachability
101 oracle. Reports are deterministic across the tested SBCL versions and checkout
102 relocation. See [Slice 3 validation](docs/slice-3-validation.md),
103 [imported contracts](reports/slice-1/validation.json) and
104 [semantic observations](reports/slice-1/semantics.json).
105
106 [Slice 0 inventory](docs/inventory.md), [architecture](docs/architecture.md),
107 [coverage](docs/coverage.md) and [validation](docs/validation.md) remain historical
108 foundation records. Their original report/logs are preserved. Their statements
109 about absent reader/model systems describe Slice 0, not the current branch.
110 Slice 1 is built from `9c83db34eb1ba8091b004433f088056717dbaa7e` on
111 `codex/ctm-slice-1`. Slice 2 starts from the accepted Slice 1a commit
112 `fb60afd548d679d83fd8ec76bc5ff384c1e23e5f` on `codex/ctm-slice-2`.
113 Slice 3 starts from accepted `66664dbff6275d60dab1bc6a232fa70f7b916b8c` on
114 `codex/ctm-slice-3`. Await review before continuing to the next slice.