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