rf: Subsume evalAdditionalColumns into evalColumns

Author: effigies

src/schema/applyRules.ts

@@ -7,7 +7,6 @@ import { memoize } from '../utils/memoize.ts'
 import { compile } from '../validators/json.ts'
 import type { DefinedError } from '@ajv'
 import {
-  evalAdditionalColumns,
   evalColumns,
   evalIndexColumns,
   evalInitialColumns,
@@ -107,8 +106,6 @@ const evalMap: Record<
   // @ts-expect-error
   columns: evalColumns,
   // @ts-expect-error
-  additional_columns: evalAdditionalColumns,
-  // @ts-expect-error
   initial_columns: evalInitialColumns,
   // @ts-expect-error
   index_columns: evalIndexColumns,

src/schema/tables.test.ts

@@ -2,7 +2,6 @@
 import { assertEquals } from '@std/assert'
 import { loadSchema } from '../setup/loadSchema.ts'
 import {
-  evalAdditionalColumns,
   evalColumns,
   evalIndexColumns,
   evalInitialColumns,
@@ -246,11 +245,11 @@ Deno.test('tables eval* tests', async (t) => {
       dataset: { issues: new DatasetIssues() },
     }
     const rule = schemaDefs.rules.tabular_data.made_up.MadeUp
-    evalAdditionalColumns(rule, context, schema, 'rules.tabular_data.made_up.MadeUp')
+    evalColumns(rule, context, schema, 'rules.tabular_data.made_up.MadeUp')
     assertEquals(context.dataset.issues.size, 0)
 
     context.columns['extra'] = [1, 2, 3]
-    evalAdditionalColumns(rule, context, schema, 'rules.tabular_data.made_up.MadeUp')
+    evalColumns(rule, context, schema, 'rules.tabular_data.made_up.MadeUp')
     assertEquals(
       context.dataset.issues.get({ code: 'TSV_ADDITIONAL_COLUMNS_NOT_ALLOWED' }).length,
       1,
@@ -270,18 +269,18 @@ Deno.test('tables eval* tests', async (t) => {
     }
     const rule = schemaDefs.rules.tabular_data.made_up.MadeUp
     rule.additional_columns = 'allowed_if_defined'
-    evalAdditionalColumns(rule, context, schema, 'rules.tabular_data.made_up.MadeUp')
+    evalColumns(rule, context, schema, 'rules.tabular_data.made_up.MadeUp')
     assertEquals(context.dataset.issues.size, 0)
 
     context['sidecar'] = {}
-    evalAdditionalColumns(rule, context, schema, 'rules.tabular_data.made_up.MadeUp')
+    evalColumns(rule, context, schema, 'rules.tabular_data.made_up.MadeUp')
     assertEquals(
       context.dataset.issues.get({ code: 'TSV_ADDITIONAL_COLUMNS_MUST_DEFINE' }).length,
       1,
     )
 
     rule.additional_columns = 'allowed'
-    evalAdditionalColumns(rule, context, schema, 'rules.tabular_data.made_up.MadeUp')
+    evalColumns(rule, context, schema, 'rules.tabular_data.made_up.MadeUp')
     assertEquals(
       context.dataset.issues.get({ code: 'TSV_ADDITIONAL_COLUMNS_UNDEFINED' }).length,
       1,

src/schema/tables.ts

@@ -236,6 +236,12 @@ export function evalColumns(
     let signature: ValueSignature
     if (!ruleHeader) { // Additional column
       if (requirement === 'not_allowed' || !sidecarDef) {
+        const code = requirement === 'not_allowed'
+          ? 'TSV_ADDITIONAL_COLUMNS_NOT_ALLOWED'
+          : requirement === 'allowed_if_defined'
+          ? 'TSV_ADDITIONAL_COLUMNS_MUST_DEFINE'
+          : 'TSV_ADDITIONAL_COLUMNS_UNDEFINED'
+        context.dataset.issues.add({ code, ...issue })
         continue
       }
       signature = extractDefinition(sidecarDef)
@@ -349,46 +355,6 @@ export function evalInitialColumns(
   })
 }
 
-export function evalAdditionalColumns(
-  rule: GenericRule,
-  context: BIDSContext,
-  schema: Schema,
-  schemaPath: string,
-): void {
-  if (!['.tsv', '.tsv.gz'].includes(context.extension)) return
-  const headers = Object.keys(context?.columns)
-  if (rule.columns) {
-    if (!rule.additional_columns || rule.additional_columns === 'n/a') {
-      // Old schemas might be missing the field, so be permissive.
-      // New schemas indicate it is not applicable with 'n/a'.
-      return
-    }
-    const ruleHeadersNames = Object.keys(rule.columns).map(
-      (x) => schema.objects.columns[x].name,
-    )
-    let extraCols = headers.filter(
-      (header) => !ruleHeadersNames.includes(header),
-    )
-
-    if (rule.additional_columns?.startsWith('allowed')) {
-      extraCols = extraCols.filter((header) => !(header in context.sidecar))
-    }
-    const code = rule.additional_columns === 'not_allowed'
-      ? 'TSV_ADDITIONAL_COLUMNS_NOT_ALLOWED'
-      : rule.additional_columns === 'allowed_if_defined'
-      ? 'TSV_ADDITIONAL_COLUMNS_MUST_DEFINE'
-      : 'TSV_ADDITIONAL_COLUMNS_UNDEFINED'
-    const issue = {
-      code,
-      location: context.path,
-      rule: schemaPath,
-    }
-    for (const col of extraCols) {
-      context.dataset.issues.add({ ...issue, subCode: col })
-    }
-  }
-}
-
 export function evalIndexColumns(
   rule: GenericRule,
   context: BIDSContext,