podlite 0.0.83 → 0.0.84

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (168) hide show
  1. package/CHANGELOG.podlite +90 -0
  2. package/esm/assemble/async.d.ts +31 -0
  3. package/esm/assemble/async.js +113 -0
  4. package/esm/assemble/async.js.map +1 -0
  5. package/esm/assemble/files.d.ts +2 -0
  6. package/esm/assemble/files.js +77 -0
  7. package/esm/assemble/files.js.map +1 -0
  8. package/esm/assemble/index.d.ts +59 -0
  9. package/esm/assemble/index.js +1003 -0
  10. package/esm/assemble/index.js.map +1 -0
  11. package/esm/cli.js +151 -26
  12. package/esm/cli.js.map +1 -1
  13. package/esm/file-format.d.ts +3 -0
  14. package/esm/file-format.js +53 -0
  15. package/esm/file-format.js.map +1 -0
  16. package/esm/index.d.ts +4 -0
  17. package/esm/index.js +3 -0
  18. package/esm/index.js.map +1 -1
  19. package/esm/lint/grammar/scan.d.ts +1 -1
  20. package/esm/lint/grammar/scan.js +2 -1
  21. package/esm/lint/grammar/scan.js.map +1 -1
  22. package/esm/lint/index.d.ts +1 -1
  23. package/esm/lint/index.js +3 -3
  24. package/esm/lint/index.js.map +1 -1
  25. package/esm/lint/loader.js +5 -4
  26. package/esm/lint/loader.js.map +1 -1
  27. package/esm/lint/mute.js +2 -1
  28. package/esm/lint/mute.js.map +1 -1
  29. package/esm/lint/rules/include-resolves.d.ts +6 -0
  30. package/esm/lint/rules/include-resolves.js +89 -0
  31. package/esm/lint/rules/include-resolves.js.map +1 -0
  32. package/esm/lint/rules/index.js +2 -0
  33. package/esm/lint/rules/index.js.map +1 -1
  34. package/esm/lint/rules/table-shape.js +7 -1
  35. package/esm/lint/rules/table-shape.js.map +1 -1
  36. package/esm/lint/types.d.ts +6 -1
  37. package/esm/lint/types.js.map +1 -1
  38. package/esm/query-blocks.d.ts +6 -0
  39. package/esm/query-blocks.js +127 -0
  40. package/esm/query-blocks.js.map +1 -0
  41. package/esm/query.d.ts +2 -0
  42. package/esm/query.js +233 -26
  43. package/esm/query.js.map +1 -1
  44. package/esm/reader.d.ts +15 -0
  45. package/esm/reader.js +119 -0
  46. package/esm/reader.js.map +1 -0
  47. package/esm/refresh-tocs.d.ts +2 -0
  48. package/esm/refresh-tocs.js +52 -0
  49. package/esm/refresh-tocs.js.map +1 -0
  50. package/esm/resolve-includes.d.ts +27 -1
  51. package/esm/resolve-includes.js +80 -40
  52. package/esm/resolve-includes.js.map +1 -1
  53. package/esm/test/collect.d.ts +16 -0
  54. package/esm/test/collect.js +368 -0
  55. package/esm/test/collect.js.map +1 -0
  56. package/esm/test/documents.d.ts +47 -0
  57. package/esm/test/documents.js +211 -0
  58. package/esm/test/documents.js.map +1 -0
  59. package/esm/test/evaluate.d.ts +41 -0
  60. package/esm/test/evaluate.js +104 -0
  61. package/esm/test/evaluate.js.map +1 -0
  62. package/esm/test/formatters/json.d.ts +2 -0
  63. package/esm/test/formatters/json.js +11 -0
  64. package/esm/test/formatters/json.js.map +1 -0
  65. package/esm/test/formatters/text.d.ts +2 -0
  66. package/esm/test/formatters/text.js +104 -0
  67. package/esm/test/formatters/text.js.map +1 -0
  68. package/esm/test/index.d.ts +11 -0
  69. package/esm/test/index.js +19 -0
  70. package/esm/test/index.js.map +1 -0
  71. package/esm/test/resources.d.ts +5 -0
  72. package/esm/test/resources.js +45 -0
  73. package/esm/test/resources.js.map +1 -0
  74. package/esm/test/run.d.ts +52 -0
  75. package/esm/test/run.js +91 -0
  76. package/esm/test/run.js.map +1 -0
  77. package/esm/test/sources.d.ts +48 -0
  78. package/esm/test/sources.js +162 -0
  79. package/esm/test/sources.js.map +1 -0
  80. package/esm/test/types.d.ts +104 -0
  81. package/esm/test/types.js +3 -0
  82. package/esm/test/types.js.map +1 -0
  83. package/esm/version.d.ts +1 -1
  84. package/esm/version.js +1 -1
  85. package/lib/assemble/async.d.ts +31 -0
  86. package/lib/assemble/async.js +118 -0
  87. package/lib/assemble/async.js.map +1 -0
  88. package/lib/assemble/files.d.ts +2 -0
  89. package/lib/assemble/files.js +81 -0
  90. package/lib/assemble/files.js.map +1 -0
  91. package/lib/assemble/index.d.ts +59 -0
  92. package/lib/assemble/index.js +1013 -0
  93. package/lib/assemble/index.js.map +1 -0
  94. package/lib/cli.js +149 -24
  95. package/lib/cli.js.map +1 -1
  96. package/lib/file-format.d.ts +3 -0
  97. package/lib/file-format.js +58 -0
  98. package/lib/file-format.js.map +1 -0
  99. package/lib/index.d.ts +4 -0
  100. package/lib/index.js +22 -1
  101. package/lib/index.js.map +1 -1
  102. package/lib/lint/grammar/scan.d.ts +1 -1
  103. package/lib/lint/grammar/scan.js +2 -1
  104. package/lib/lint/grammar/scan.js.map +1 -1
  105. package/lib/lint/index.d.ts +1 -1
  106. package/lib/lint/index.js +3 -3
  107. package/lib/lint/index.js.map +1 -1
  108. package/lib/lint/loader.js +5 -4
  109. package/lib/lint/loader.js.map +1 -1
  110. package/lib/lint/mute.js +2 -1
  111. package/lib/lint/mute.js.map +1 -1
  112. package/lib/lint/rules/include-resolves.d.ts +6 -0
  113. package/lib/lint/rules/include-resolves.js +92 -0
  114. package/lib/lint/rules/include-resolves.js.map +1 -0
  115. package/lib/lint/rules/index.js +2 -0
  116. package/lib/lint/rules/index.js.map +1 -1
  117. package/lib/lint/rules/table-shape.js +7 -1
  118. package/lib/lint/rules/table-shape.js.map +1 -1
  119. package/lib/lint/types.d.ts +6 -1
  120. package/lib/lint/types.js.map +1 -1
  121. package/lib/query-blocks.d.ts +6 -0
  122. package/lib/query-blocks.js +136 -0
  123. package/lib/query-blocks.js.map +1 -0
  124. package/lib/query.d.ts +2 -0
  125. package/lib/query.js +232 -25
  126. package/lib/query.js.map +1 -1
  127. package/lib/reader.d.ts +15 -0
  128. package/lib/reader.js +124 -0
  129. package/lib/reader.js.map +1 -0
  130. package/lib/refresh-tocs.d.ts +2 -0
  131. package/lib/refresh-tocs.js +56 -0
  132. package/lib/refresh-tocs.js.map +1 -0
  133. package/lib/resolve-includes.d.ts +27 -1
  134. package/lib/resolve-includes.js +84 -40
  135. package/lib/resolve-includes.js.map +1 -1
  136. package/lib/test/collect.d.ts +16 -0
  137. package/lib/test/collect.js +374 -0
  138. package/lib/test/collect.js.map +1 -0
  139. package/lib/test/documents.d.ts +47 -0
  140. package/lib/test/documents.js +250 -0
  141. package/lib/test/documents.js.map +1 -0
  142. package/lib/test/evaluate.d.ts +41 -0
  143. package/lib/test/evaluate.js +142 -0
  144. package/lib/test/evaluate.js.map +1 -0
  145. package/lib/test/formatters/json.d.ts +2 -0
  146. package/lib/test/formatters/json.js +15 -0
  147. package/lib/test/formatters/json.js.map +1 -0
  148. package/lib/test/formatters/text.d.ts +2 -0
  149. package/lib/test/formatters/text.js +141 -0
  150. package/lib/test/formatters/text.js.map +1 -0
  151. package/lib/test/index.d.ts +11 -0
  152. package/lib/test/index.js +31 -0
  153. package/lib/test/index.js.map +1 -0
  154. package/lib/test/resources.d.ts +5 -0
  155. package/lib/test/resources.js +83 -0
  156. package/lib/test/resources.js.map +1 -0
  157. package/lib/test/run.d.ts +52 -0
  158. package/lib/test/run.js +95 -0
  159. package/lib/test/run.js.map +1 -0
  160. package/lib/test/sources.d.ts +48 -0
  161. package/lib/test/sources.js +200 -0
  162. package/lib/test/sources.js.map +1 -0
  163. package/lib/test/types.d.ts +104 -0
  164. package/lib/test/types.js +8 -0
  165. package/lib/test/types.js.map +1 -0
  166. package/lib/version.d.ts +1 -1
  167. package/lib/version.js +1 -1
  168. package/package.json +28 -7
@@ -0,0 +1,52 @@
1
+ import type { Profile } from './documents';
2
+ import type { AssertionResult } from './evaluate';
3
+ import type { CollectionProblem, Place, TestSource } from './types';
4
+ export type TestStatus = 'passed' | 'failed' | 'skipped';
5
+ export type TestReason = {
6
+ kind: 'assertion';
7
+ } | {
8
+ kind: 'no-assertions';
9
+ } | {
10
+ kind: 'malformed-test';
11
+ message: string;
12
+ place: Place;
13
+ } | {
14
+ kind: 'invalid-test';
15
+ message: string;
16
+ place: Place;
17
+ } | {
18
+ kind: 'unknown-child';
19
+ name: string;
20
+ place: Place;
21
+ };
22
+ export type TestResult = {
23
+ id?: string;
24
+ caption?: string;
25
+ place: Place;
26
+ obtainedFrom: string[];
27
+ against?: string;
28
+ status: TestStatus;
29
+ reason?: TestReason;
30
+ asserts: AssertionResult[];
31
+ };
32
+ export type RunReport = {
33
+ format: 'podlite-test-report';
34
+ version: 1;
35
+ profile: string;
36
+ tests: TestResult[];
37
+ problems: CollectionProblem[];
38
+ counts: {
39
+ tests: number;
40
+ passed: number;
41
+ failed: number;
42
+ skipped: number;
43
+ };
44
+ exitCode: 0 | 1 | 2;
45
+ };
46
+ export type RunOptions = {
47
+ tests: TestSource[];
48
+ against?: string[];
49
+ profile?: Profile;
50
+ allowSkipped?: boolean;
51
+ };
52
+ export declare const runTests: (opts: RunOptions) => RunReport;
@@ -0,0 +1,91 @@
1
+ import { collectTests, planRuns } from './collect.js';
2
+ import { coreProfile } from './documents.js';
3
+ import { evaluateAssertion } from './evaluate.js';
4
+ import { inputsFor, prepareSupplied } from './sources.js';
5
+ const statusOf = (test, asserts) => {
6
+ const { shape } = test;
7
+ switch (shape.kind) {
8
+ case 'unknown-child':
9
+ return { status: 'skipped', reason: { kind: 'unknown-child', name: shape.name, place: shape.place } };
10
+ case 'malformed':
11
+ return { status: 'failed', reason: { kind: 'malformed-test', message: shape.message, place: shape.place } };
12
+ case 'invalid':
13
+ return { status: 'failed', reason: { kind: 'invalid-test', message: shape.message, place: shape.place } };
14
+ case 'no-assertions':
15
+ return { status: 'failed', reason: { kind: 'no-assertions' } };
16
+ case 'runnable':
17
+ return asserts.every(a => a.held) ? { status: 'passed' } : { status: 'failed', reason: { kind: 'assertion' } };
18
+ }
19
+ };
20
+ const isImplementationError = (problem) => problem.kind === 'implementation-error';
21
+ const losesTests = (problem) => problem.kind === 'unreadable-source' || (problem.kind === 'include' && problem.severity === 'error');
22
+ const exitCodeOf = (tests, problems, allowSkipped) => {
23
+ const broken = problems.some(isImplementationError) ||
24
+ tests.some(t => t.asserts.some(a => a.reason?.kind === 'implementation-error'));
25
+ if (broken)
26
+ return 2;
27
+ if (tests.length === 0 || problems.some(losesTests))
28
+ return 1;
29
+ if (tests.some(t => t.status === 'failed'))
30
+ return 1;
31
+ if (!allowSkipped && tests.some(t => t.status === 'skipped'))
32
+ return 1;
33
+ return 0;
34
+ };
35
+ /*
36
+ =begin pod :kind<export>
37
+
38
+ =head2 runTests
39
+
40
+ Collects the tests of the files given, runs each once or once per document it has to
41
+ read, and reports. Nothing is printed and the process exit code is not touched: the
42
+ code is in the report.
43
+
44
+ The exit code is 2 when the implementation failed, 1 when a test failed, a test was
45
+ skipped and that is not allowed, no test was found, or an include lost tests, and 0
46
+ otherwise.
47
+
48
+ =end pod
49
+ */
50
+ export const runTests = (opts) => {
51
+ const profile = opts.profile ?? coreProfile;
52
+ const against = opts.against ?? [];
53
+ const collection = collectTests(opts.tests, profile);
54
+ const supplied = against.map(file => prepareSupplied(file, profile));
55
+ const env = {
56
+ profile,
57
+ supplied,
58
+ containing: (index) => collection.sources.find(s => s.index === index),
59
+ };
60
+ const sourceName = (index) => collection.sources.find(s => s.index === index)?.name ?? String(index);
61
+ const results = planRuns(collection.tests, against.length).map((run) => {
62
+ const { test, context } = run;
63
+ const input = inputsFor(test, context, env);
64
+ const asserts = test.shape.kind === 'runnable' ? test.asserts.map(a => evaluateAssertion(a, input(a), profile)) : [];
65
+ return {
66
+ id: test.id,
67
+ caption: test.caption,
68
+ place: test.place,
69
+ obtainedFrom: run.obtained.map(t => sourceName(t.obtainedFrom)),
70
+ against: context.kind === 'supplied' ? against[context.document] : undefined,
71
+ ...statusOf(test, asserts),
72
+ asserts,
73
+ };
74
+ });
75
+ const counts = {
76
+ tests: results.length,
77
+ passed: results.filter(t => t.status === 'passed').length,
78
+ failed: results.filter(t => t.status === 'failed').length,
79
+ skipped: results.filter(t => t.status === 'skipped').length,
80
+ };
81
+ return {
82
+ format: 'podlite-test-report',
83
+ version: 1,
84
+ profile: profile.name,
85
+ tests: results,
86
+ problems: collection.problems,
87
+ counts,
88
+ exitCode: exitCodeOf(results, collection.problems, opts.allowSkipped === true),
89
+ };
90
+ };
91
+ //# sourceMappingURL=run.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"run.js","sourceRoot":"","sources":["../../src/test/run.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAA;AAClD,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAEzC,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAE9C,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,WAAW,CAAA;AAwFtD,MAAM,QAAQ,GAAG,CAAC,IAAmB,EAAE,OAA0B,EAAyC,EAAE;IAC1G,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAA;IACtB,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,eAAe;YAClB,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,eAAe,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,EAAE,CAAA;QACvG,KAAK,WAAW;YACd,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,gBAAgB,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,EAAE,CAAA;QAC7G,KAAK,SAAS;YACZ,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,cAAc,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,EAAE,CAAA;QAC3G,KAAK,eAAe;YAClB,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,eAAe,EAAE,EAAE,CAAA;QAChE,KAAK,UAAU;YACb,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,EAAE,CAAA;IAClH,CAAC;AACH,CAAC,CAAA;AAED,MAAM,qBAAqB,GAAG,CAAC,OAA0B,EAAW,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,sBAAsB,CAAA;AAE9G,MAAM,UAAU,GAAG,CAAC,OAA0B,EAAW,EAAE,CACzD,OAAO,CAAC,IAAI,KAAK,mBAAmB,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,SAAS,IAAI,OAAO,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAA;AAEtG,MAAM,UAAU,GAAG,CAAC,KAAmB,EAAE,QAA6B,EAAE,YAAqB,EAAa,EAAE;IAC1G,MAAM,MAAM,GACV,QAAQ,CAAC,IAAI,CAAC,qBAAqB,CAAC;QACpC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,IAAI,KAAK,sBAAsB,CAAC,CAAC,CAAA;IACjF,IAAI,MAAM;QAAE,OAAO,CAAC,CAAA;IACpB,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC;QAAE,OAAO,CAAC,CAAA;IAC7D,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,QAAQ,CAAC;QAAE,OAAO,CAAC,CAAA;IACpD,IAAI,CAAC,YAAY,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,SAAS,CAAC;QAAE,OAAO,CAAC,CAAA;IACtE,OAAO,CAAC,CAAA;AACV,CAAC,CAAA;AAED;;;;;;;;;;;;;;EAcE;AACF,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,IAAgB,EAAa,EAAE;IACtD,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,WAAW,CAAA;IAC3C,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,EAAE,CAAA;IAClC,MAAM,UAAU,GAAG,YAAY,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;IACpD,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,eAAe,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAA;IACpE,MAAM,GAAG,GAAG;QACV,OAAO;QACP,QAAQ;QACR,UAAU,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,KAAK,CAAC;KAC/E,CAAA;IACD,MAAM,UAAU,GAAG,CAAC,KAAa,EAAU,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,KAAK,CAAC,EAAE,IAAI,IAAI,MAAM,CAAC,KAAK,CAAC,CAAA;IAEpH,MAAM,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,GAAe,EAAc,EAAE;QAC7F,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,GAAG,CAAA;QAC7B,MAAM,KAAK,GAAG,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG,CAAC,CAAA;QAC3C,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,iBAAiB,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;QACpH,OAAO;YACL,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,YAAY,EAAE,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;YAC/D,OAAO,EAAE,OAAO,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS;YAC5E,GAAG,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;YAC1B,OAAO;SACR,CAAA;IACH,CAAC,CAAC,CAAA;IAEF,MAAM,MAAM,GAAG;QACb,KAAK,EAAE,OAAO,CAAC,MAAM;QACrB,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,MAAM;QACzD,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,MAAM;QACzD,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,MAAM;KAC5D,CAAA;IACD,OAAO;QACL,MAAM,EAAE,qBAAqB;QAC7B,OAAO,EAAE,CAAC;QACV,OAAO,EAAE,OAAO,CAAC,IAAI;QACrB,KAAK,EAAE,OAAO;QACd,QAAQ,EAAE,UAAU,CAAC,QAAQ;QAC7B,MAAM;QACN,QAAQ,EAAE,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,QAAQ,EAAE,IAAI,CAAC,YAAY,KAAK,IAAI,CAAC;KAC/E,CAAA;AACH,CAAC,CAAA"}
@@ -0,0 +1,48 @@
1
+ import type { PodliteDocument, PodNode, SelectorDoc } from '@podlite/schema';
2
+ import type { IncludeProblem } from '../resolve-includes';
3
+ import type { PreparedDocument, Profile } from './documents';
4
+ import type { AssertDecl, CollectedTest, FixtureDecl, Result, RunContext } from './types';
5
+ export type InputKind = 'named' | 'supplied' | 'fixture' | 'containing';
6
+ export type AssertionInput = {
7
+ kind: InputKind;
8
+ document: PreparedDocument;
9
+ target: PodNode | PodliteDocument;
10
+ source?: string;
11
+ base?: string;
12
+ fixture?: FixtureDecl;
13
+ supplied?: number;
14
+ readFile?: (document: string) => SelectorDoc[] | undefined;
15
+ };
16
+ export type InputFailure = {
17
+ kind: 'source-unavailable';
18
+ input: InputKind;
19
+ source: string;
20
+ base: string;
21
+ message: string;
22
+ } | {
23
+ kind: 'address-unresolved';
24
+ input: InputKind;
25
+ source: string;
26
+ address: string;
27
+ } | {
28
+ kind: 'source-unsupported';
29
+ input: InputKind;
30
+ source: string;
31
+ message: string;
32
+ } | {
33
+ kind: 'input-error';
34
+ input: InputKind;
35
+ problems: IncludeProblem[];
36
+ } | {
37
+ kind: 'implementation-error';
38
+ input: InputKind;
39
+ message: string;
40
+ };
41
+ export type SuppliedDocument = Result<PreparedDocument, InputFailure>;
42
+ export type InputEnvironment = {
43
+ profile: Profile;
44
+ supplied: SuppliedDocument[];
45
+ containing: (source: number) => PreparedDocument | undefined;
46
+ };
47
+ export declare const prepareSupplied: (file: string, profile: Profile) => SuppliedDocument;
48
+ export declare const inputsFor: (test: CollectedTest, context: RunContext, env: InputEnvironment) => (assert: AssertDecl) => Result<AssertionInput, InputFailure>;
@@ -0,0 +1,162 @@
1
+ import * as path from 'path';
2
+ import { bindTarget, buildBindingIndex } from '@podlite/schema';
3
+ import { formatOfFile } from '../file-format.js';
4
+ import { diskProvider } from '../resolve-includes.js';
5
+ import { canonical, prepareDocument, readDocument } from './documents.js';
6
+ import { RESOURCE_ROOT, resourceProvider } from './resources.js';
7
+ import { err, ok } from './types.js';
8
+ const hasMask = (target) => /[*?]/.test(target);
9
+ // A source written without a scheme is a file.
10
+ const readSourceExpression = (source) => {
11
+ const withScheme = source.match(/^([a-zA-Z][a-zA-Z0-9+.-]*):(.*)$/);
12
+ const scheme = withScheme ? withScheme[1] : 'file';
13
+ const rest = withScheme ? withScheme[2] : source;
14
+ const hash = rest.indexOf('#');
15
+ return hash === -1
16
+ ? { scheme, document: rest }
17
+ : { scheme, document: rest.slice(0, hash), address: rest.slice(hash + 1) || undefined };
18
+ };
19
+ const whole = (document, input) => {
20
+ if (document.errors.length > 0)
21
+ return err({ kind: 'input-error', input, problems: document.errors });
22
+ const [unread] = document.unread;
23
+ if (unread) {
24
+ return err({
25
+ kind: 'source-unsupported',
26
+ input,
27
+ source: unread.source,
28
+ message: unread.message,
29
+ });
30
+ }
31
+ return ok(document);
32
+ };
33
+ // A document with an include that lost content is not the document the author
34
+ // wrote; nothing it lacks may pass for nothing having matched.
35
+ const complete = (prepared, input) => {
36
+ if (prepared.ok === false)
37
+ return err({ kind: 'implementation-error', input, message: prepared.error });
38
+ return whole(prepared.value, input);
39
+ };
40
+ export const prepareSupplied = (file, profile) => {
41
+ const read = readDocument(file);
42
+ if (read.ok === false) {
43
+ return err({
44
+ kind: 'source-unavailable',
45
+ input: 'supplied',
46
+ source: file,
47
+ base: process.cwd(),
48
+ message: read.error,
49
+ });
50
+ }
51
+ return complete(prepareDocument(read.value, { profile }), 'supplied');
52
+ };
53
+ const isNode = (value) => typeof value === 'object' && value !== null && 'type' in value && typeof value.type === 'string';
54
+ const addressed = (document, input, source, address) => {
55
+ if (!address)
56
+ return ok(document.tree);
57
+ const binding = bindTarget(address, buildBindingIndex(document.tree));
58
+ return binding.found && isNode(binding.node)
59
+ ? ok(binding.node)
60
+ : err({ kind: 'address-unresolved', input, source, address });
61
+ };
62
+ // The directory a source named in the test is read from: the file the test is
63
+ // written in, not the document it was included into.
64
+ const baseOf = (test, env) => {
65
+ const holder = env.containing(test.obtainedFrom);
66
+ return holder && test.place.file === holder.name ? holder.baseDir : path.dirname(test.place.file);
67
+ };
68
+ // One test run: fixtures are read the first time an assertion needs them, and
69
+ // what one test declares is seen by no other.
70
+ /*
71
+ =begin pod :kind<export>
72
+
73
+ =head2 inputsFor
74
+
75
+ The document each assertion of one test run is read against: the source it names,
76
+ else the supplied document, else the fixture nearest before it, else the document the
77
+ test is in. A fixture is read the first time it is needed, and the resources of the
78
+ test are seen by that fixture only.
79
+
80
+ =end pod
81
+ */
82
+ export const inputsFor = (test, context, env) => {
83
+ const fixtures = new Map();
84
+ const named = new Map();
85
+ const provider = resourceProvider(test.resources);
86
+ const fixtureDocument = (fixture) => {
87
+ const known = fixtures.get(fixture.index);
88
+ if (known)
89
+ return known;
90
+ const name = `${test.place.file}#fixture-${fixture.index}`;
91
+ const prepared = complete(prepareDocument({ name, text: fixture.body, baseDir: RESOURCE_ROOT }, { profile: env.profile, provider }), 'fixture');
92
+ fixtures.set(fixture.index, prepared);
93
+ return prepared;
94
+ };
95
+ const readNamed = (document, source, base) => {
96
+ const file = path.resolve(base, document);
97
+ const key = canonical(file);
98
+ let prepared = named.get(key);
99
+ if (!prepared) {
100
+ const text = diskProvider.read(file);
101
+ prepared =
102
+ text === null
103
+ ? err({ kind: 'source-unavailable', input: 'named', source, base, message: `cannot read ${document}` })
104
+ : complete(prepareDocument({ name: key, text, baseDir: path.dirname(file), self: file, format: formatOfFile(file) }, { profile: env.profile }), 'named');
105
+ named.set(key, prepared);
106
+ }
107
+ return prepared;
108
+ };
109
+ const readFile = (document) => {
110
+ if (hasMask(document))
111
+ return undefined;
112
+ const prepared = readNamed(document, `file:${document}`, baseOf(test, env));
113
+ return prepared.ok ? [{ file: prepared.value.name, node: prepared.value.tree }] : undefined;
114
+ };
115
+ const namedDocument = (source) => {
116
+ const base = baseOf(test, env);
117
+ const { scheme, document, address } = readSourceExpression(source);
118
+ if (scheme !== 'file') {
119
+ return err({ kind: 'source-unsupported', input: 'named', source, message: `scheme ${scheme}: is not read` });
120
+ }
121
+ if (hasMask(document)) {
122
+ return err({ kind: 'source-unsupported', input: 'named', source, message: 'a mask is not read as a source' });
123
+ }
124
+ const prepared = readNamed(document, source, base);
125
+ if (prepared.ok === false)
126
+ return prepared;
127
+ const target = addressed(prepared.value, 'named', source, address);
128
+ if (target.ok === false)
129
+ return target;
130
+ return ok({ kind: 'named', document: prepared.value, target: target.value, source, base });
131
+ };
132
+ const input = (assert) => {
133
+ if (assert.source !== undefined)
134
+ return namedDocument(assert.source);
135
+ if (context.kind === 'supplied') {
136
+ const supplied = env.supplied[context.document];
137
+ if (!supplied)
138
+ return err({ kind: 'implementation-error', input: 'supplied', message: 'no such document' });
139
+ if (supplied.ok === false)
140
+ return supplied;
141
+ return ok({ kind: 'supplied', document: supplied.value, target: supplied.value.tree, supplied: context.document });
142
+ }
143
+ if (assert.fixture) {
144
+ const fixture = fixtureDocument(assert.fixture);
145
+ if (fixture.ok === false)
146
+ return fixture;
147
+ return ok({ kind: 'fixture', document: fixture.value, target: fixture.value.tree, fixture: assert.fixture });
148
+ }
149
+ const holder = env.containing(context.kind === 'containing' ? context.source : test.obtainedFrom);
150
+ if (!holder)
151
+ return err({ kind: 'implementation-error', input: 'containing', message: 'the source of the test is gone' });
152
+ const checked = whole(holder, 'containing');
153
+ if (checked.ok === false)
154
+ return checked;
155
+ return ok({ kind: 'containing', document: holder, target: holder.tree });
156
+ };
157
+ return (assert) => {
158
+ const found = input(assert);
159
+ return found.ok ? ok({ ...found.value, readFile }) : found;
160
+ };
161
+ };
162
+ //# sourceMappingURL=sources.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"sources.js","sourceRoot":"","sources":["../../src/test/sources.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,MAAM,CAAA;AAC5B,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAA;AAE/D,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAE7C,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AAClD,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAEtE,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAE7D,OAAO,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,SAAS,CAAA;AAmCjC,MAAM,OAAO,GAAG,CAAC,MAAc,EAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;AAEhE,+CAA+C;AAC/C,MAAM,oBAAoB,GAAG,CAAC,MAAc,EAA0D,EAAE;IACtG,MAAM,UAAU,GAAG,MAAM,CAAC,KAAK,CAAC,kCAAkC,CAAC,CAAA;IACnE,MAAM,MAAM,GAAG,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAA;IAClD,MAAM,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAA;IAChD,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;IAC9B,OAAO,IAAI,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE;QAC5B,CAAC,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,SAAS,EAAE,CAAA;AAC3F,CAAC,CAAA;AAED,MAAM,KAAK,GAAG,CAAC,QAA0B,EAAE,KAAgB,EAA0C,EAAE;IACrG,IAAI,QAAQ,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,GAAG,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAA;IACrG,MAAM,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAA;IAChC,IAAI,MAAM,EAAE,CAAC;QACX,OAAO,GAAG,CAAC;YACT,IAAI,EAAE,oBAAoB;YAC1B,KAAK;YACL,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,OAAO,EAAE,MAAM,CAAC,OAAO;SACxB,CAAC,CAAA;IACJ,CAAC;IACD,OAAO,EAAE,CAAC,QAAQ,CAAC,CAAA;AACrB,CAAC,CAAA;AAED,8EAA8E;AAC9E,+DAA+D;AAC/D,MAAM,QAAQ,GAAG,CACf,QAA0C,EAC1C,KAAgB,EACwB,EAAE;IAC1C,IAAI,QAAQ,CAAC,EAAE,KAAK,KAAK;QAAE,OAAO,GAAG,CAAC,EAAE,IAAI,EAAE,sBAAsB,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAA;IACvG,OAAO,KAAK,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;AACrC,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,IAAY,EAAE,OAAgB,EAAoB,EAAE;IAClF,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC,CAAA;IAC/B,IAAI,IAAI,CAAC,EAAE,KAAK,KAAK,EAAE,CAAC;QACtB,OAAO,GAAG,CAAC;YACT,IAAI,EAAE,oBAAoB;YAC1B,KAAK,EAAE,UAAU;YACjB,MAAM,EAAE,IAAI;YACZ,IAAI,EAAE,OAAO,CAAC,GAAG,EAAE;YACnB,OAAO,EAAE,IAAI,CAAC,KAAK;SACpB,CAAC,CAAA;IACJ,CAAC;IACD,OAAO,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,UAAU,CAAC,CAAA;AACvE,CAAC,CAAA;AAED,MAAM,MAAM,GAAG,CAAC,KAAc,EAAoB,EAAE,CAClD,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,MAAM,IAAI,KAAK,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAA;AAElG,MAAM,SAAS,GAAG,CAChB,QAA0B,EAC1B,KAAgB,EAChB,MAAc,EACd,OAA2B,EACsB,EAAE;IACnD,IAAI,CAAC,OAAO;QAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;IACtC,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE,iBAAiB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAA;IACrE,OAAO,OAAO,CAAC,KAAK,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC;QAC1C,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;QAClB,CAAC,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAA;AACjE,CAAC,CAAA;AAED,8EAA8E;AAC9E,qDAAqD;AACrD,MAAM,MAAM,GAAG,CAAC,IAAmB,EAAE,GAAqB,EAAU,EAAE;IACpE,MAAM,MAAM,GAAG,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;IAChD,OAAO,MAAM,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;AACnG,CAAC,CAAA;AAED,8EAA8E;AAC9E,8CAA8C;AAC9C;;;;;;;;;;;EAWE;AACF,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,IAAmB,EAAE,OAAmB,EAAE,GAAqB,EAAE,EAAE;IAC3F,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAkD,CAAA;IAC1E,MAAM,KAAK,GAAG,IAAI,GAAG,EAAkD,CAAA;IACvE,MAAM,QAAQ,GAAG,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;IAEjD,MAAM,eAAe,GAAG,CAAC,OAAoB,EAA0C,EAAE;QACvF,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QACzC,IAAI,KAAK;YAAE,OAAO,KAAK,CAAA;QACvB,MAAM,IAAI,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,YAAY,OAAO,CAAC,KAAK,EAAE,CAAA;QAC1D,MAAM,QAAQ,GAAG,QAAQ,CACvB,eAAe,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,aAAa,EAAE,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,QAAQ,EAAE,CAAC,EACzG,SAAS,CACV,CAAA;QACD,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAA;QACrC,OAAO,QAAQ,CAAA;IACjB,CAAC,CAAA;IAED,MAAM,SAAS,GAAG,CAAC,QAAgB,EAAE,MAAc,EAAE,IAAY,EAA0C,EAAE;QAC3G,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;QACzC,MAAM,GAAG,GAAG,SAAS,CAAC,IAAI,CAAC,CAAA;QAC3B,IAAI,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAC7B,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;YACpC,QAAQ;gBACN,IAAI,KAAK,IAAI;oBACX,CAAC,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,eAAe,QAAQ,EAAE,EAAE,CAAC;oBACvG,CAAC,CAAC,QAAQ,CACN,eAAe,CACb,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,CAAC,IAAI,CAAC,EAAE,EACxF,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,CACzB,EACD,OAAO,CACR,CAAA;YACP,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAA;QAC1B,CAAC;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC,CAAA;IAED,MAAM,QAAQ,GAAG,CAAC,QAAgB,EAA6B,EAAE;QAC/D,IAAI,OAAO,CAAC,QAAQ,CAAC;YAAE,OAAO,SAAS,CAAA;QACvC,MAAM,QAAQ,GAAG,SAAS,CAAC,QAAQ,EAAE,QAAQ,QAAQ,EAAE,EAAE,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAA;QAC3E,OAAO,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAC7F,CAAC,CAAA;IAED,MAAM,aAAa,GAAG,CAAC,MAAc,EAAwC,EAAE;QAC7E,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;QAC9B,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,oBAAoB,CAAC,MAAM,CAAC,CAAA;QAClE,IAAI,MAAM,KAAK,MAAM,EAAE,CAAC;YACtB,OAAO,GAAG,CAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,MAAM,eAAe,EAAE,CAAC,CAAA;QAC9G,CAAC;QACD,IAAI,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;YACtB,OAAO,GAAG,CAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,gCAAgC,EAAE,CAAC,CAAA;QAC/G,CAAC;QACD,MAAM,QAAQ,GAAG,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,CAAA;QAClD,IAAI,QAAQ,CAAC,EAAE,KAAK,KAAK;YAAE,OAAO,QAAQ,CAAA;QAC1C,MAAM,MAAM,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;QAClE,IAAI,MAAM,CAAC,EAAE,KAAK,KAAK;YAAE,OAAO,MAAM,CAAA;QACtC,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAA;IAC5F,CAAC,CAAA;IAED,MAAM,KAAK,GAAG,CAAC,MAAkB,EAAwC,EAAE;QACzE,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS;YAAE,OAAO,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;QACpE,IAAI,OAAO,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YAChC,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;YAC/C,IAAI,CAAC,QAAQ;gBAAE,OAAO,GAAG,CAAC,EAAE,IAAI,EAAE,sBAAsB,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,kBAAkB,EAAE,CAAC,CAAA;YAC3G,IAAI,QAAQ,CAAC,EAAE,KAAK,KAAK;gBAAE,OAAO,QAAQ,CAAA;YAC1C,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAA;QACpH,CAAC;QACD,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACnB,MAAM,OAAO,GAAG,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;YAC/C,IAAI,OAAO,CAAC,EAAE,KAAK,KAAK;gBAAE,OAAO,OAAO,CAAA;YACxC,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC,CAAA;QAC9G,CAAC;QACD,MAAM,MAAM,GAAG,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,KAAK,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;QACjG,IAAI,CAAC,MAAM;YACT,OAAO,GAAG,CAAC,EAAE,IAAI,EAAE,sBAAsB,EAAE,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,gCAAgC,EAAE,CAAC,CAAA;QAC9G,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,EAAE,YAAY,CAAC,CAAA;QAC3C,IAAI,OAAO,CAAC,EAAE,KAAK,KAAK;YAAE,OAAO,OAAO,CAAA;QACxC,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAA;IAC1E,CAAC,CAAA;IAED,OAAO,CAAC,MAAkB,EAAwC,EAAE;QAClE,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,CAAA;QAC3B,OAAO,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,KAAK,CAAC,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAA;IAC5D,CAAC,CAAA;AACH,CAAC,CAAA"}
@@ -0,0 +1,104 @@
1
+ import type { Location } from '@podlite/schema';
2
+ import type { IncludeProblem } from '../resolve-includes';
3
+ export type Result<T, E> = {
4
+ ok: true;
5
+ value: T;
6
+ } | {
7
+ ok: false;
8
+ error: E;
9
+ };
10
+ export declare const ok: <T>(value: T) => {
11
+ ok: true;
12
+ value: T;
13
+ };
14
+ export declare const err: <E>(error: E) => {
15
+ ok: false;
16
+ error: E;
17
+ };
18
+ export type TestSource = {
19
+ kind: 'file';
20
+ path: string;
21
+ } | {
22
+ kind: 'text';
23
+ name: string;
24
+ text: string;
25
+ baseDir: string;
26
+ };
27
+ export type Place = {
28
+ file: string;
29
+ location?: Location;
30
+ };
31
+ export type FixtureDecl = {
32
+ index: number;
33
+ body: string;
34
+ place: Place;
35
+ };
36
+ export type ResourceDecl = {
37
+ name: string;
38
+ body: string;
39
+ place: Place;
40
+ };
41
+ export type AssertDecl = {
42
+ index: number;
43
+ expression: string;
44
+ absent: boolean;
45
+ caption?: string;
46
+ place: Place;
47
+ source?: string;
48
+ fixture?: FixtureDecl;
49
+ };
50
+ export type TestShape = {
51
+ kind: 'runnable';
52
+ } | {
53
+ kind: 'no-assertions';
54
+ } | {
55
+ kind: 'unknown-child';
56
+ name: string;
57
+ place: Place;
58
+ } | {
59
+ kind: 'malformed';
60
+ message: string;
61
+ place: Place;
62
+ } | {
63
+ kind: 'invalid';
64
+ message: string;
65
+ place: Place;
66
+ };
67
+ export type CollectedTest = {
68
+ key: string;
69
+ id?: string;
70
+ caption?: string;
71
+ place: Place;
72
+ obtainedFrom: number;
73
+ shape: TestShape;
74
+ asserts: AssertDecl[];
75
+ resources: ResourceDecl[];
76
+ };
77
+ export type CollectionProblem = {
78
+ kind: 'unreadable-source';
79
+ source: string;
80
+ message: string;
81
+ } | {
82
+ kind: 'include';
83
+ severity: 'error' | 'warning';
84
+ source: string;
85
+ problem: IncludeProblem;
86
+ } | {
87
+ kind: 'implementation-error';
88
+ source: string;
89
+ message: string;
90
+ };
91
+ export type RunContext = {
92
+ kind: 'fixture-or-named';
93
+ } | {
94
+ kind: 'supplied';
95
+ document: number;
96
+ } | {
97
+ kind: 'containing';
98
+ source: number;
99
+ };
100
+ export type PlannedRun = {
101
+ test: CollectedTest;
102
+ obtained: CollectedTest[];
103
+ context: RunContext;
104
+ };
@@ -0,0 +1,3 @@
1
+ export const ok = (value) => ({ ok: true, value });
2
+ export const err = (error) => ({ ok: false, error });
3
+ //# sourceMappingURL=types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/test/types.ts"],"names":[],"mappings":"AAKA,MAAM,CAAC,MAAM,EAAE,GAAG,CAAI,KAAQ,EAA0B,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAA;AAChF,MAAM,CAAC,MAAM,GAAG,GAAG,CAAI,KAAQ,EAA2B,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAA"}
package/esm/version.d.ts CHANGED
@@ -1 +1 @@
1
- export declare const version = "0.0.83";
1
+ export declare const version = "0.0.84";
package/esm/version.js CHANGED
@@ -1,3 +1,3 @@
1
1
  // generated by scripts/inject-version.mjs — do not edit by hand
2
- export const version = '0.0.83';
2
+ export const version = '0.0.84';
3
3
  //# sourceMappingURL=version.js.map
@@ -0,0 +1,31 @@
1
+ import type { AssembleOptions, IncludeStep, Located, Source, Sources } from './index';
2
+ export type AsyncSources = {
3
+ schemes?: readonly string[];
4
+ locate: (path: string, context: unknown, plain?: boolean, at?: IncludeStep, scheme?: string) => Located | Promise<Located>;
5
+ read: (source: Source) => string | null | Promise<string | null>;
6
+ };
7
+ type Wanted = {
8
+ kind: 'locate';
9
+ path: string;
10
+ context: unknown;
11
+ plain: boolean;
12
+ at?: IncludeStep;
13
+ scheme?: string;
14
+ } | {
15
+ kind: 'read';
16
+ source: Source;
17
+ };
18
+ export type SourceStore = {
19
+ sources: () => Sources;
20
+ wanted: () => Wanted[];
21
+ located: (path: string, context: unknown, plain: boolean, at: IncludeStep | undefined, answer: Located, scheme?: string) => void;
22
+ text: (source: Source, answer: string | null) => void;
23
+ drop: (id?: string) => void;
24
+ };
25
+ export declare const createSourceStore: () => SourceStore;
26
+ export type AssembleAsyncOptions = Omit<AssembleOptions, 'sources'> & {
27
+ sources: AsyncSources;
28
+ store?: SourceStore;
29
+ };
30
+ export declare const assembleAsync: (tree: any, opts: AssembleAsyncOptions) => Promise<any>;
31
+ export {};
@@ -0,0 +1,118 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.assembleAsync = exports.createSourceStore = void 0;
4
+ /*
5
+ =begin pod :kind<module>
6
+
7
+ =head2 async
8
+
9
+ Assembly over sources that answer later: a host that reads files through a
10
+ promise gives its answers to a store, and the assembly runs over the store until
11
+ nothing is left to ask.
12
+
13
+ =end pod
14
+ */
15
+ const index_1 = require("./index");
16
+ const createSourceStore = () => {
17
+ const places = new Map();
18
+ const texts = new Map();
19
+ let asked = [];
20
+ // A path read as written and the same path read as a mask are two questions,
21
+ // and so is the same path at two directives: a host may answer by the place.
22
+ const keyOf = (path, plain, at, scheme = 'file') => `${plain ? 'plain' : 'mask'}\u0000${scheme}\u0000${path}\u0000${at ? `${at.file}@${at.location?.start?.offset ?? ''}` : ''}`;
23
+ const want = (item, same) => {
24
+ if (!asked.some(same))
25
+ asked.push(item);
26
+ };
27
+ return {
28
+ sources: () => ({
29
+ locate: (path, context, plain = false, at, scheme) => {
30
+ const key = keyOf(path, plain, at, scheme);
31
+ const known = places.get(context)?.get(key);
32
+ if (known)
33
+ return known;
34
+ want({ kind: 'locate', path, context, plain, at, scheme }, o => o.kind === 'locate' && o.context === context && keyOf(o.path, o.plain, o.at, o.scheme) === key);
35
+ return undefined;
36
+ },
37
+ read: source => {
38
+ if (texts.has(source.id))
39
+ return texts.get(source.id) ?? null;
40
+ want({ kind: 'read', source }, o => o.kind === 'read' && o.source.id === source.id);
41
+ return undefined;
42
+ },
43
+ }),
44
+ wanted: () => {
45
+ const out = asked;
46
+ asked = [];
47
+ return out;
48
+ },
49
+ located: (path, context, plain, at, answer, scheme) => {
50
+ const known = places.get(context) ?? new Map();
51
+ known.set(keyOf(path, plain, at, scheme), answer);
52
+ places.set(context, known);
53
+ },
54
+ text: (source, answer) => {
55
+ texts.set(source.id, answer);
56
+ },
57
+ drop: id => {
58
+ if (id === undefined) {
59
+ places.clear();
60
+ texts.clear();
61
+ }
62
+ else
63
+ texts.delete(id);
64
+ },
65
+ };
66
+ };
67
+ exports.createSourceStore = createSourceStore;
68
+ // more rounds than any document needs: each one must bring a new answer
69
+ const maxRounds = 1000;
70
+ /*
71
+ =begin pod :kind<export>
72
+
73
+ =head2 assembleAsync
74
+
75
+ Assembles a document whose sources answer through promises. The document is
76
+ assembled over the answers at hand; what was missing is asked of C<sources>, and
77
+ the assembly is run again from the document as given, until nothing is missing.
78
+ Only that last assembly reports problems, fills C<origin> and calls C<onCopy>. A
79
+ source that fails to answer is taken as one that cannot be had.
80
+
81
+ =end pod
82
+ */
83
+ const assembleAsync = async (tree, opts) => {
84
+ const { sources, store = (0, exports.createSourceStore)(), ...rest } = opts;
85
+ const ignore = () => { };
86
+ // the store answers for the host, so it knows the schemes the host knows
87
+ const known = () => ({ ...store.sources(), schemes: sources.schemes });
88
+ for (let round = 0; round < maxRounds; round++) {
89
+ (0, index_1.silently)(() => (0, index_1.assembleIncludes)(tree, {
90
+ ...rest,
91
+ sources: known(),
92
+ origin: new WeakMap(),
93
+ onCopy: undefined,
94
+ onError: ignore,
95
+ onWarning: ignore,
96
+ }));
97
+ const wanted = store.wanted();
98
+ if (wanted.length === 0)
99
+ return (0, index_1.assembleIncludes)(tree, { ...rest, sources: known() });
100
+ await Promise.all(wanted.map(async (item) => {
101
+ if (item.kind === 'locate') {
102
+ const answer = await Promise.resolve()
103
+ .then(() => sources.locate(item.path, item.context, item.plain, item.at, item.scheme))
104
+ .catch(() => ({ masked: false, sources: [] }));
105
+ store.located(item.path, item.context, item.plain, item.at, answer, item.scheme);
106
+ }
107
+ else {
108
+ const answer = await Promise.resolve()
109
+ .then(() => sources.read(item.source))
110
+ .catch(() => null);
111
+ store.text(item.source, answer);
112
+ }
113
+ }));
114
+ }
115
+ throw new Error('include sources keep asking for more');
116
+ };
117
+ exports.assembleAsync = assembleAsync;
118
+ //# sourceMappingURL=async.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"async.js","sourceRoot":"","sources":["../../src/assemble/async.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;EAUE;AACF,mCAAoD;AA8C7C,MAAM,iBAAiB,GAAG,GAAgB,EAAE;IACjD,MAAM,MAAM,GAAG,IAAI,GAAG,EAAiC,CAAA;IACvD,MAAM,KAAK,GAAG,IAAI,GAAG,EAAyB,CAAA;IAC9C,IAAI,KAAK,GAAa,EAAE,CAAA;IACxB,6EAA6E;IAC7E,6EAA6E;IAC7E,MAAM,KAAK,GAAG,CAAC,IAAY,EAAE,KAAc,EAAE,EAAgB,EAAE,MAAM,GAAG,MAAM,EAAU,EAAE,CACxF,GAAG,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,SAAS,MAAM,SAAS,IAAI,SACrD,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC,QAAQ,EAAE,KAAK,EAAE,MAAM,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,EAC1D,EAAE,CAAA;IACJ,MAAM,IAAI,GAAG,CAAC,IAAY,EAAE,IAAgC,EAAQ,EAAE;QACpE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;YAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACzC,CAAC,CAAA;IACD,OAAO;QACL,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC;YACd,MAAM,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,GAAG,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE;gBACnD,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,CAAC,CAAA;gBAC1C,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAA;gBAC3C,IAAI,KAAK;oBAAE,OAAO,KAAK,CAAA;gBACvB,IAAI,CACF,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,EACpD,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,CAAC,OAAO,KAAK,OAAO,IAAI,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,GAAG,CACpG,CAAA;gBACD,OAAO,SAAS,CAAA;YAClB,CAAC;YACD,IAAI,EAAE,MAAM,CAAC,EAAE;gBACb,IAAI,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;oBAAE,OAAO,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,IAAI,CAAA;gBAC7D,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,IAAI,CAAC,CAAC,MAAM,CAAC,EAAE,KAAK,MAAM,CAAC,EAAE,CAAC,CAAA;gBACnF,OAAO,SAAS,CAAA;YAClB,CAAC;SACF,CAAC;QACF,MAAM,EAAE,GAAG,EAAE;YACX,MAAM,GAAG,GAAG,KAAK,CAAA;YACjB,KAAK,GAAG,EAAE,CAAA;YACV,OAAO,GAAG,CAAA;QACZ,CAAC;QACD,OAAO,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE;YACpD,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,IAAI,GAAG,EAAmB,CAAA;YAC/D,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,CAAA;YACjD,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;QAC5B,CAAC;QACD,IAAI,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE;YACvB,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;QAC9B,CAAC;QACD,IAAI,EAAE,EAAE,CAAC,EAAE;YACT,IAAI,EAAE,KAAK,SAAS,EAAE,CAAC;gBACrB,MAAM,CAAC,KAAK,EAAE,CAAA;gBACd,KAAK,CAAC,KAAK,EAAE,CAAA;YACf,CAAC;;gBAAM,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;QACzB,CAAC;KACF,CAAA;AACH,CAAC,CAAA;AAnDY,QAAA,iBAAiB,qBAmD7B;AAQD,wEAAwE;AACxE,MAAM,SAAS,GAAG,IAAI,CAAA;AAEtB;;;;;;;;;;;;EAYE;AACK,MAAM,aAAa,GAAG,KAAK,EAAE,IAAS,EAAE,IAA0B,EAAgB,EAAE;IACzF,MAAM,EAAE,OAAO,EAAE,KAAK,GAAG,IAAA,yBAAiB,GAAE,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAA;IAC9D,MAAM,MAAM,GAAG,GAAS,EAAE,GAAE,CAAC,CAAA;IAC7B,yEAAyE;IACzE,MAAM,KAAK,GAAG,GAAY,EAAE,CAAC,CAAC,EAAE,GAAG,KAAK,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC,CAAA;IAC/E,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,SAAS,EAAE,KAAK,EAAE,EAAE,CAAC;QAC/C,IAAA,gBAAQ,EAAC,GAAG,EAAE,CACZ,IAAA,wBAAgB,EAAC,IAAI,EAAE;YACrB,GAAG,IAAI;YACP,OAAO,EAAE,KAAK,EAAE;YAChB,MAAM,EAAE,IAAI,OAAO,EAAyB;YAC5C,MAAM,EAAE,SAAS;YACjB,OAAO,EAAE,MAAM;YACf,SAAS,EAAE,MAAM;SAClB,CAAC,CACH,CAAA;QACD,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,EAAE,CAAA;QAC7B,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,IAAA,wBAAgB,EAAC,IAAI,EAAE,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,CAAC,CAAA;QACrF,MAAM,OAAO,CAAC,GAAG,CACf,MAAM,CAAC,GAAG,CAAC,KAAK,EAAC,IAAI,EAAC,EAAE;YACtB,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC3B,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,OAAO,EAAE;qBACnC,IAAI,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;qBACrF,KAAK,CAAC,GAAY,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC,CAAA;gBACzD,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;YAClF,CAAC;iBAAM,CAAC;gBACN,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,OAAO,EAAE;qBACnC,IAAI,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;qBACrC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAA;gBACpB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;YACjC,CAAC;QACH,CAAC,CAAC,CACH,CAAA;IACH,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAA;AACzD,CAAC,CAAA;AAnCY,QAAA,aAAa,iBAmCzB"}
@@ -0,0 +1,2 @@
1
+ import type { Sources } from './index';
2
+ export declare const sourcesFromFiles: (files: Record<string, string>) => Sources;