lists in result messages

.changeset/eighty-snakes-hide.md

@@ -0,0 +1,5 @@
+---
+"rdf-validate-shacl": patch
+---
+
+Improved result messages with lists

src/validation-engine.js

@@ -320,7 +320,16 @@ function localName(uri) {
   return uri.substring(index + 1)
 }
 
-function nodeLabel(node) {
+function * take(n, iterable) {
+  let i = 0
+  for (const item of iterable) {
+    if (i++ === n) break
+    yield item
+  }
+}
+
+function nodeLabel(constraint, param) {
+  const node = constraint.getParameterValue(param)
   if (!node) {
     return 'NULL'
   }
@@ -331,6 +340,13 @@ function nodeLabel(node) {
   }
 
   if (node.termType === 'BlankNode') {
+    const pointer = constraint.shapeNodePointer.out(param)
+    const list = pointer.list()
+    if (list) {
+      const items = Array.from(take(3, list))
+      return items.join(', ') + (items.length === 3 ? ' ...' : '')
+    }
+
     return 'Blank node ' + node.value
   }
 
@@ -340,7 +356,7 @@ function nodeLabel(node) {
 function withSubstitutions(messageTerm, constraint, factory) {
   const message = constraint.component.parameters.reduce((message, param) => {
     const paramName = localName(param.value)
-    const paramValue = nodeLabel(constraint.getParameterValue(param))
+    const paramValue = nodeLabel(constraint, param)
     return message
       .replace(`{$${paramName}}`, paramValue)
       .replace(`{?${paramName}}`, paramValue)

src/validators-registry.js

@@ -54,7 +54,7 @@ export default {
   [ns.sh.InConstraintComponent.value]: {
     validator: {
       func: validators.validateIn,
-      message: 'Value is not in {$in}',
+      message: 'Value is not one of the allowed values: {$in}',
     },
   },
   [ns.sh.LanguageInConstraintComponent.value]: {

test/data/validation-message/message-with-list.ttl

@@ -0,0 +1,11 @@
+@prefix sh: <http://www.w3.org/ns/shacl#> .
+@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
+
+<Alice> a <Person> ; <category> "f" .
+
+<ShapeWithList> a sh:NodeShape ;
+  sh:targetClass <Person> ;
+  sh:property [
+    sh:path <category> ;
+    sh:in ("a" "b" "c" "d" "e") ;
+  ] .

test/validation_message_test.js

@@ -89,4 +89,17 @@ describe('validation messages', () => {
       { value: 'Mon message de validation', language: 'fr' },
     ]))
   })
+
+  it('Lists first items in message', async () => {
+    const dataPath = path.join(rootPath, 'message-with-list.ttl')
+    const data = await loadDataset(dataPath)
+    const shapes = data
+
+    const validator = new SHACLValidator(shapes)
+    const report = validator.validate(data)
+
+    assert.strictEqual(report.results.length, 1)
+    assert.strictEqual(report.results[0].message.length, 1)
+    assert.strictEqual(report.results[0].message[0].value, 'Value is not one of the allowed values: a, b, c ...')
+  })
 })