]> dreyeck.freedombox.rocks Git - topic-maps.git/blob - README.md
Implement Topic-set Scope across TMDM, CTM and CXTM
[topic-maps.git] / README.md
1 # Common Lisp Topic Maps — Slice 13
2
3 A working ANSI Common Lisp reader for CTM identity/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 or Variants. Slice 6 adds document-local
10 prefixes, QName resolution and explicit datatype locators on quoted Occurrence
11 values. Unknown datatypes retain their lexical values; Date timezone CXTM rules
12 remain explicitly unsupported. Slice 7 adds integer literals, lexical validation
13 and pure xsd:integer canonical output; qualified strings retain their stored
14 lexical values. Slice 8 adds decimal literals, exact character-based xsd:decimal
15 canonicalization and lexical validation, with the same separation of stored
16 strings, TMDM equality and canonical serialization. Slice 9 adds timezone-free
17 xsd:date literals, Gregorian calendar validation and pure CXTM Date output.
18 Negative-year leap validation follows the documented XSD 1.0 E.1 interpretation.
19 Slice 10 adds xsd:dateTime with absent/zero zones, exact fractional precision and
20 midnight rollover. A noncandidate leap-second baseline disagrees with XSD D.1
21 following-minute interpretation and remains FAIL. Slice 11 adds exact nonzero-offset UTC canonicalization; the original timezone2
22 contract now executes and reports its known inconsistent baseline as FAIL.
23 Nonzero-offset BCE day rollover and leap-second contexts remain explicitly
24 unsupported; existing zero/absent-zone behavior is retained.
25 Slice 12A adds explicitly typed Topic Names. Slice 13 adds Scope Topic sets to
26 Names, Occurrences and Associations, including reference replacement, duplicate
27 merging and canonical output. Embedded Topics and Variants remain unsupported.
28
29 Systems: `topic-maps` (the retained foundation), `topic-maps/tests`,
30 `topic-maps/tmdm`, `topic-maps/ctm`, `topic-maps/ctm/tests` and
31 `topic-maps/ctm/merging-tests` and `topic-maps/ctm/association-tests`, plus `topic-maps/cxtm` and
32 `topic-maps/cxtm/tests`, `topic-maps/ctm/occurrence-tests` and `topic-maps/ctm/prefix-tests` and `topic-maps/ctm/integer-tests`, plus `topic-maps/ctm/decimal-tests` and `topic-maps/ctm/date-tests` and `topic-maps/ctm/datetime-tests` and `topic-maps/ctm/timezone-tests`, `topic-maps/ctm/typed-name-tests` and `topic-maps/ctm/scope-tests`.
33 The core reader/model uses ANSI Common Lisp; the foundation/tooling uses
34 ASDF/UIOP and Python's standard library. No Quicklisp packages are required.
35
36 Start with [Reading Scope](docs/reading-scope.md) for Scope APIs, actual Topic
37 references, merge handles and the three original comparisons.
38 [Reading Typed Topic Names](docs/reading-typed-topic-names.md) covers Slice 12A.
39 [Reading DateTime Timezone Canonicalization](docs/reading-datetime-timezones.md)
40 for UTC conversion, calendar limits, actual stored strings and executable inspection.
41 [Reading DateTime Occurrences](docs/reading-datetime-occurrences.md)
42 for lexical/value/canonical distinctions and the two normative discrepancies.
43 [Reading Date Occurrences](docs/reading-date-occurrences.md)
44 for the ten original Date cases, calendar rules, stored values and inspection.
45 [Reading Decimal Occurrences](docs/reading-decimal-occurrences.md)
46 for the seven Decimal cases, string representation, equality and inspection.
47 [Reading Integer Occurrences](docs/reading-integer-occurrences.md)
48 for integer representation, lexical equality, canonicalization and inspection.
49 [Reading Prefixes and Explicit Datatypes](docs/reading-prefixes-and-datatypes.md)
50 for the seven original cases, current API, object properties and diagnostics.
51 [Reading the First Four CTM Occurrences](docs/reading-first-occurrences.md)
52 for actual parent/type references, literal values, datatypes and executable inspection.
53 [Reading Canonical Topic Maps](docs/reading-canonical-topic-maps.md)
54 for the CXTM API, normative clauses, base-locator policy and actual byte comparisons.
55 [Reading the First CTM Associations](docs/reading-first-ctm-associations.md)
56 for actual Association/Role items, late Topic merges and current subset boundaries.
57 [Reading Topic Identity and Merging](docs/reading-topic-merging.md)
58 for the current API, reference replacement, identifier tails and exact subset
59 boundaries. See [Reading the First Five CTM Documents](docs/reading-first-five-ctm-documents.md)
60 for original sources, actual objects, normative clauses, baseline evidence and
61 copy-pasteable DESCRIBE forms. [API and boundaries](docs/slice-1-api-and-boundaries.md)
62 document the accepted Slice 1 baseline; the Slice 2 document supersedes its
63 statements about absent identity tails, merging and immutable Name references.
64 The Slice 3 document supersedes historical statements about absent Associations/Roles.
65
66 The pinned suite targets the **CTM draft dated 2010-03-31**. Passing it alone
67 does not establish full ISO/IEC 13250-6:2010 conformity.
68
69 ## Load and inspect
70
71 In a new Common Lisp process, with this checkout selected:
72
73 ```lisp
74 (require :asdf)
75 (asdf:initialize-source-registry
76 '(:source-registry :ignore-inherited-configuration))
77 (asdf:load-asd #p"/Users/rgb/workspace/topic-maps/topic-maps.asd")
78 (asdf:load-system "topic-maps/ctm")
79 (asdf:load-system "topic-maps")
80 (defparameter *corpus* (topic-maps.test-foundation:discover-corpus))
81 (topic-maps.test-foundation:summarize-corpus *corpus*)
82 (topic-maps.test-foundation:select-cases *corpus* :category :invalid)
83 (topic-maps.test-foundation:select-cases *corpus* :id "ctm/in/simple.ctm")
84 (asdf:test-system "topic-maps/tests")
85 (asdf:test-system "topic-maps/ctm/tests")
86 (asdf:test-system "topic-maps/ctm/merging-tests")
87 (asdf:test-system "topic-maps/ctm/association-tests")
88 (asdf:test-system "topic-maps/ctm/decimal-tests") ; includes retained Integer/Prefix/Occurrence/CXTM suites
89 (topic-maps.test-foundation:write-validation-report
90 *corpus* #p"/tmp/topic-maps-inventory.json")
91 ```
92
93 Change only the checkout pathname when using another machine. The case's
94 Document IRI remains independent of that pathname. Records are inspectable
95 Common Lisp structures, with actual source/baseline pathnames and explicit
96 contracts, results, statuses, diagnostics and reviewed clauses.
97
98 ## Offline verification
99
100 ```sh
101 # SBCL must already be installed. No network is used by this command.
102 TOPIC_MAPS_REPORT=/tmp/topic-maps-validation.json ./scripts/test.sh
103 ```
104
105 Set `SBCL=/absolute/path/to/sbcl` if needed. The launcher starts a new process,
106 ignores system/user initialization, clears inherited ASDF source configuration
107 and writes FASLs outside the repository. It runs byte-integrity fixtures,
108 Common Lisp infrastructure checks and an independent JSON-schema/content check
109 when a report pathname is supplied. `nix develop path:.` supplies a minimal,
110 pinned SBCL/Python/Git environment; initial environment provisioning may need
111 network access, while test execution after provisioning does not.
112
113 The complete upstream corpus is already vendored, unchanged. If absent in a
114 source distribution, acquire it once:
115
116 ```sh
117 python3 scripts/corpus.py acquire
118 python3 scripts/corpus.py verify
119 ```
120
121 Acquisition uses the exact commit and archive digest in
122 [corpus-lock.json](references/corpus-lock.json), refuses to merge over existing
123 contents and verifies every file. Verification is offline. Valid CTM inputs
124 are selected only under `ctm/in`, invalid ones only under `ctm/invalid`, and
125 CXTM baselines only under `ctm/baseline`. Auxiliary files are reported separately.
126
127 ## Current validation and historical foundation
128
129 The complete pinned corpus remains unchanged: 231 valid CTM inputs, 42 invalid
130 inputs, 231 CXTM baselines and 22 CTM auxiliary files. Fifty-nine selected positive
131 cases pass actual CXTM byte comparisons. Eight specific rejection contracts pass.
132 Two executed DateTime contracts remain FAIL because of documented normative
133 baseline discrepancies; 204 contracts remain NOT-RUN. A green regression run
134 preserves those two FAILs and never changes an upstream baseline. Unsupported
135 constructs and I/O errors cannot count as the required CTM rejection.
136
137 The full launcher runs the retained 54 foundation checks, two Python integrity
138 fixtures, 123 retained identity checks, 646 merge checks, 657 Association checks,
139 imported-report validation and selected baseline
140 property evidence, 445 retained CXTM checks, 1,101 Occurrence checks, 150 prefix/datatype checks, 665 integer checks, 715 Decimal checks, 1,806 Date checks, 217 DateTime checks, 1,944 timezone checks, 106 typed-name checks and 293 Scope checks, plus
141 16,294 independent Unicode NFC oracle
142 comparisons. The oracle needs Python UCD 15.0 or 15.1 (tables use UCD 15.1.0).
143 A report path also produces `<path>.semantics.json` with
144 separate model observations, plus `<path>.merging.json`, `<path>.associations.json`
145 and `<path>.cxtm.json` (complete actual/expected XML and byte counts),
146 plus `<path>.occurrences.json` with separate actual Occurrence objects/properties
147 and `<path>.prefixes.json` with all seven selected observations, plus `<path>.integers.json` for integer objects
148 and independently checked arithmetic probes, plus `<path>.decimals.json` with
149 seven Decimal object observations and 157 independent Decimal arithmetic probes,
150 plus `<path>.dates.json` with five original Date results, five original rejections,
151 396 independent date/calendar probes and 15 century decisions. `<path>.datetimes.json` records five actual DateTime
152 models, 45 independent lexical/canonical probes and two executed baseline
153 discrepancies. `<path>.timezones.json` adds exact UTC, fraction and model-purity
154 probes, including every one of the 1681 permitted signed offset minutes.
155 The merge checks include 128 graph/order variants with an independent reachability
156 oracle. Reports are deterministic across the tested SBCL versions and checkout
157 relocation. `<path>.typed-names.json` records Name value/Parent/Type relations;
158 `<path>.scopes.json` records Scope object relations and an ordering witness.
159 See [Slice 13 validation](docs/slice-13-validation.md) for current evidence.
160 [Slice 12A validation](docs/slice-12a-validation.md) records explicit Name types.
161 [Slice 11 validation](docs/slice-11-validation.md) preserves the prior timezone evidence.
162 [Slice 10 validation](docs/slice-10-validation.md) preserves the earlier DateTime baseline.
163 [Slice 9 validation](docs/slice-9-validation.md) records the accepted Date subset.
164 [Slice 8 validation](docs/slice-8-validation.md) records the accepted Decimal subset.
165 [Slice 7 validation](docs/slice-7-validation.md) records the accepted Integer subset.
166 [Slice 6 validation](docs/slice-6-validation.md) records the preceding accepted subset.
167 [Slice 5 validation](docs/slice-5-validation.md) records the preceding accepted subset.
168 [Slice 4 validation](docs/slice-4-validation.md) records the accepted baseline.
169 [Slice 3 validation](docs/slice-3-validation.md),
170 [imported contracts](reports/slice-1/validation.json) and
171 [semantic observations](reports/slice-1/semantics.json).
172
173 [Slice 0 inventory](docs/inventory.md), [architecture](docs/architecture.md),
174 [coverage](docs/coverage.md) and [validation](docs/validation.md) remain historical
175 foundation records. Their original report/logs are preserved. Their statements
176 about absent reader/model systems describe Slice 0, not the current branch.
177 Slice 1 is built from `9c83db34eb1ba8091b004433f088056717dbaa7e` on
178 `codex/ctm-slice-1`. Slice 2 starts from the accepted Slice 1a commit
179 `fb60afd548d679d83fd8ec76bc5ff384c1e23e5f` on `codex/ctm-slice-2`.
180 Slice 13 starts from `788899aea1a20b9cd8237c6106e6613e180d7362` on
181 `codex/ctm-slice-13`.
182 Slice 11 starts from `8741d155d948c7317945eee423a977940cad995e` on
183 `codex/ctm-slice-11`.
184 Slice 10 starts from `2ad41cd1a945a4ce97824464de40646bb899259e` on
185 `codex/ctm-slice-10`.
186 Slice 9 starts from `195d5f5444d776096b765d04c815c23c3db5f84c` on
187 `codex/ctm-slice-9`.
188 Slice 8 starts from `17dd58775e25ab495e3c83deb4b5a36f5e5a124b` on
189 `codex/ctm-slice-8`.
190 Slice 7 starts from `3924d1eac5a070fe5a6a26683e23ac338793f544` on
191 `codex/ctm-slice-7`.
192 Slice 6 starts from `437ad53ea7539d36db3fa871d0931650b7a6a03e` on
193 `codex/ctm-slice-6`.
194 Slice 5 starts from `8036a2b1ce009218f33d300edcc5f715ec1d1124` on
195 `codex/ctm-slice-5`.
196 Slice 4 starts from `35648c4dcc71e8dc6448b64abcacb438e53d64a2` on
197 `codex/ctm-slice-4`.
198 Slice 3 starts from accepted `66664dbff6275d60dab1bc6a232fa70f7b916b8c` on
199 `codex/ctm-slice-3`. Await review before continuing to the next slice.