Merge pull request #239 from VisLab/revised-validator

Duration should be allowed in files without timeline
hed-standard · Jan 8, 2025 · ff30baa · ff30baa
2 parents 2d74edf + e1aa32a
commit ff30baa
Show file tree

Hide file tree

Showing 5 changed files with 68 additions and 12 deletions.
diff --git a/bids/validator/tsvValidator.js b/bids/validator/tsvValidator.js
@@ -246,7 +246,7 @@ export class BidsHedTsvValidator extends BidsValidator {
   _checkNoTime(elements) {
     const timeIssues = []
     for (const element of elements) {
-      if (element.parsedHedString.tags.some((tag) => this.special.temporalTags.has(tag.schemaTag.name))) {
+      if (element.parsedHedString.tags.some((tag) => this.special.timelineTags.has(tag.schemaTag.name))) {
         timeIssues.push(
           BidsHedIssue.fromHedIssue(
             generateIssue('temporalTagInNonTemporalContext', { string: element.hedString, tsvLine: element.tsvLine }),

diff --git a/data/json/reservedTags.json b/data/json/reservedTags.json
@@ -13,7 +13,7 @@
     "ERROR_CODE": "DEF_INVALID",
     "noSpliceInGroup": false,
     "forbiddenSubgroupTags": [],
-    "isTemporalTag": false,
+    "requiresTimeline": false,
     "requiresDef": false,
     "otherAllowedNonDefTags": null
   },
@@ -31,7 +31,7 @@
     "ERROR_CODE": "DEF_EXPAND_INVALID",
     "noSpliceInGroup": true,
     "forbiddenSubgroupTags": ["Def", "Def-expand"],
-    "isTemporalTag": false,
+    "requiresTimeline": false,
     "requiresDef": false,
     "otherAllowedNonDefTags": []
   },
@@ -49,7 +49,7 @@
     "ERROR_CODE": "DEFINITION_INVALID",
     "noSpliceInGroup": true,
     "forbiddenSubgroupTags": ["Def", "Def-expand"],
-    "isTemporalTag": false,
+    "requiresTimeline": false,
     "requiresDef": false,
     "otherAllowedNonDefTags": []
   },
@@ -67,7 +67,7 @@
     "ERROR_CODE": "TEMPORAL_TAG_ERROR",
     "noSpliceInGroup": false,
     "forbiddenSubgroupTags": [],
-    "isTemporalTag": true,
+    "requiresTimeline": true,
     "requiresDef": false,
     "otherAllowedNonDefTags": ["Duration", "Onset", "Offset", "Inset"]
   },
@@ -85,7 +85,7 @@
     "ERROR_CODE": "TEMPORAL_TAG_ERROR",
     "noSpliceInGroup": false,
     "forbiddenSubgroupTags": [],
-    "isTemporalTag": true,
+    "requiresTimeline": false,
     "requiresDef": false,
     "otherAllowedNonDefTags": ["Delay"]
   },
@@ -103,7 +103,7 @@
     "ERROR_CODE": "TAG_GROUP_ERROR",
     "noSpliceInGroup": true,
     "forbiddenSubgroupTags": [],
-    "isTemporalTag": false,
+    "requiresTimeline": false,
     "requiresDef": false,
     "otherAllowedNonDefTags": []
   },
@@ -121,7 +121,7 @@
     "ERROR_CODE": "TEMPORAL_TAG_ERROR",
     "noSpliceInGroup": false,
     "forbiddenSubgroupTags": [],
-    "isTemporalTag": true,
+    "requiresTimeline": true,
     "requiresDef": true,
     "otherAllowedNonDefTags": ["Delay"]
   },
@@ -139,7 +139,7 @@
     "ERROR_CODE": "TEMPORAL_TAG_ERROR",
     "noSpliceInGroup": false,
     "forbiddenSubgroupTags": [],
-    "isTemporalTag": true,
+    "requiresTimeline": true,
     "requiresDef": true,
     "otherAllowedNonDefTags": ["Delay"]
   },
@@ -157,7 +157,7 @@
     "ERROR_CODE": "TEMPORAL_TAG_ERROR",
     "noSpliceInGroup": false,
     "forbiddenSubgroupTags": [],
-    "isTemporalTag": true,
+    "requiresTimeline": true,
     "requiresDef": true,
     "otherAllowedNonDefTags": ["Delay"]
   }

diff --git a/parser/reservedChecker.js b/parser/reservedChecker.js
@@ -31,7 +31,7 @@ export class ReservedChecker {
     this.requiresDefTags = ReservedChecker._getSpecialTagsByProperty('requiresDef')
     this.groupTags = ReservedChecker._getSpecialTagsByProperty('tagGroup')
     this.exclusiveTags = ReservedChecker._getSpecialTagsByProperty('exclusive')
-    this.temporalTags = ReservedChecker._getSpecialTagsByProperty('isTemporalTag')
+    this.timelineTags = ReservedChecker._getSpecialTagsByProperty('requiresTimeline')
     this.noSpliceInGroup = ReservedChecker._getSpecialTagsByProperty('noSpliceInGroup')
     this.hasForbiddenSubgroupTags = new Set(
       [...ReservedChecker.reservedMap.values()]

diff --git a/tests/bidsTests.spec.js b/tests/bidsTests.spec.js
@@ -14,7 +14,7 @@ import { DefinitionManager } from '../parser/definitionManager'
 //const skipMap = new Map([['definition-tests', ['invalid-missing-definition-for-def', 'invalid-nested-definition']]])
 const skipMap = new Map()
 const runAll = true
-const runMap = new Map([['duplicate-tag-tests', ['invalid-duplicate-multiple-onset']]])
+const runMap = new Map([['delay-tests', ['delay-non-timeline-file']]])
 
 describe('BIDS validation', () => {
   const schemaMap = new Map([['8.3.0', undefined]])

diff --git a/tests/testData/bidsTests.data.js b/tests/testData/bidsTests.data.js
@@ -1714,6 +1714,62 @@ export const bidsTestData = [
           ),
         ],
       },
+      {
+        testname: 'delay-non-timeline-file',
+        explanation: 'A delay tag in not allowed in a file without a timeline',
+        schemaVersion: '8.3.0',
+        definitions: ['(Definition/Acc/#, (Acceleration/# m-per-s^2, Red))', '(Definition/MyColor, (Label/Pie))'],
+        sidecar: {
+          event_code: {
+            HED: {
+              face: '(Delay/5.0 s, (Red))',
+            },
+          },
+        },
+        eventsString: 'event_code\tHED\nn/a\t(Delay/5.0 s, (Blue))\n',
+        sidecarErrors: [],
+        tsvErrors: [
+          BidsHedIssue.fromHedIssue(
+            generateIssue('temporalTagInNonTemporalContext', {
+              string: '(Delay/5.0 s, (Blue))',
+            }),
+            {
+              path: 'delay-non-timeline-file.tsv',
+              relativePath: 'delay-non-timeline-file.tsv',
+            },
+            { tsvLine: '2' },
+          ),
+        ],
+        comboErrors: [
+          BidsHedIssue.fromHedIssue(
+            generateIssue('temporalTagInNonTemporalContext', {
+              string: '(Delay/5.0 s, (Blue))',
+            }),
+            {
+              path: 'delay-non-timeline-file.tsv',
+              relativePath: 'delay-non-timeline-file.tsv',
+            },
+            { tsvLine: '2' },
+          ),
+        ],
+      },
+      {
+        testname: 'duration-non-timeline-file',
+        explanation: 'A duration tag is allowed a file without a timeline',
+        schemaVersion: '8.3.0',
+        definitions: ['(Definition/Acc/#, (Acceleration/# m-per-s^2, Red))', '(Definition/MyColor, (Label/Pie))'],
+        sidecar: {
+          event_code: {
+            HED: {
+              face: '(Duration/5.0 s, (Red))',
+            },
+          },
+        },
+        eventsString: 'event_code\tHED\nn/a\t(Duration/5.0 s, (Blue))\n',
+        sidecarErrors: [],
+        tsvErrors: [],
+        comboErrors: [],
+      },
     ],
   },
   {