]> dreyeck.freedombox.rocks Git - topic-maps.git/blob - reports/core-relationship-readers/README.md
docs: design draft for a read-only SHOP3 adapter over TMDM objects
[topic-maps.git] / reports / core-relationship-readers / README.md
1 # Core relationship readers and default name types — execution report
2
3 Base revision: `88994c1b9e1edbf13e665e984a5c9c3b2cdf7575` (branch `dreyeck.ch`).
4 Runtime: SBCL 2.4.10, Python 3.13, Linux. All runs used the unchanged offline
5 launcher `scripts/test.sh` in a fresh process, with `TOPIC_MAPS_REPORT` set.
6
7 ## What was changed
8
9 - `src/tmdm/core-relationships.lisp`: six read-only functions that recognize
10 the type-instance (TMDM 7.2) and supertype-subtype (TMDM 7.3) Associations.
11 They are added API over stored items, not a repair of a conformance defect.
12 - `tests/core-relationships.lisp`, `tests/default-name-types.lisp`, their two
13 ASDF systems, two launcher lines and `scripts/check-core-relationships.py`.
14 - Documentation: `docs/tmdm-coverage-matrix.md` (new),
15 `docs/reading-type-relationships.md`, `docs/reading-typed-topic-names.md` and
16 one pointer in `README.md`.
17
18 No existing source file under `src/` was changed except the export list in
19 `src/tmdm/package.lisp`. Identity, merging, scope, canonicalization, the Core
20 Subject set and the CTM, XTM and CXTM code are untouched. Sort names (TMDM 7.4)
21 are deferred.
22
23 ## Runs
24
25 | Run | State of the tree | Exit code | Log |
26 |---|---|---|---|
27 | before | unchanged `88994c1b` | 0 | [before/run.log](before/run.log) |
28 | default name types alone | tests added, no production change | 0 | 21 checks |
29 | core relationships alone | readers and tests added | 0 | 50 checks |
30 | after | all changes | 0 | [after/run.log](after/run.log) |
31
32 ## Results
33
34 **Passed.**
35
36 - The baseline run on the unchanged tree.
37 - `DEFAULT-NAME-TYPE-PASS`: 21 checks. They passed against the unchanged
38 production code, so the two default name type Subject Identifiers needed no
39 code change.
40 - `CORE-RELATIONSHIP-PASS`: 50 checks over TMDM 7.2 and 7.3, including the
41 eleven original `isa`/`ako` inputs.
42 - `CORE-RELATIONSHIPS-SERIALIZED-DATA-PASS`: the Python evaluation of the
43 eleven unchanged CXTM baselines agrees with the counts the readers report.
44 This evaluates serialized data; it is not a proof of conformance.
45 - Regression: the 25 report files the launcher wrote before the changes are
46 byte-identical after them, the CXTM report included
47 ([before/report-sha256.txt](before/report-sha256.txt),
48 [after/report-sha256.txt](after/report-sha256.txt)). The after run has the
49 316 PASS lines of the before run plus the three new ones.
50
51 **Failed.** Nothing new. The launcher reports the same known baseline
52 discrepancies before and after (the DateTime and Include cases documented in
53 `docs/slice-22c-normative-decisions.md`); they are retained FAIL contracts of
54 the corpus, not regressions.
55
56 **Not run.**
57
58 - The XTM suites (`topic-maps/xtm/tests`, `topic-maps/ctm/xtm-tests`): they
59 require SBCL 2.5.4 and the patched CXML sources, which were not available.
60 The XTM reader path for name types and `instanceOf` is therefore not
61 exercised by this report.
62 - Inference over supertype-subtype relationships and sort names: not
63 implemented, hence not tested.
64
65 ## Open points
66
67 - The editions published by ISO were not consulted; clause numbers refer to the
68 public texts listed in `docs/tmdm-coverage-matrix.md`.
69 - Both default name type identifiers are supported as different identifiers.
70 The explicit merge of the two type Topics is recorded as current behaviour
71 only.
72 - The next smallest integration task is on the client side: use
73 `type-instance-relationship` instead of a local derivation of Topic types.