Add base-output-filename to examples

ogc/bblocks/examples-schema.yaml

@@ -21,6 +21,10 @@ items:
     base-uri:
       description: Base URI that will be used for semantic uplift (JSON -> JSON-LD -> Turtle).
       type: string
+    base-output-filename:
+      description: |
+        Base filename that will be used for writing this example to its own file. Extension, if any, will be discarded.
+      type: string
     snippets:
       description: |
         Collection of snippets to illustrate this example. Preferably, only one snippet per language

ogc/bblocks/util.py

@@ -16,6 +16,7 @@
 
 import jsonschema
 import networkx as nx
+import pathvalidate
 import requests
 from ogc.na.annotate_schema import SchemaAnnotator, ContextBuilder
 from ogc.na.util import load_yaml, dump_yaml, is_url
@@ -835,3 +836,7 @@ def walk(subschema: dict | list, schema_id: str | Path, is_properties: bool = Fa
             {'$ref': f"{schema_url}#/x-defs/{root_ref_id}"}
         ]
     }
+
+
+def sanitize_filename(fn: str):
+    return pathvalidate.sanitize_filename(fn)

ogc/bblocks/validate.py

@@ -28,7 +28,7 @@
 from rdflib.term import Node, URIRef, BNode
 from yaml import MarkedYAMLError
 
-from ogc.bblocks.util import BuildingBlock, BuildingBlockRegister
+from ogc.bblocks.util import BuildingBlock, BuildingBlockRegister, sanitize_filename
 import traceback
 import pyshacl
 import jsonref
@@ -697,12 +697,16 @@ def validate_test_resources(bblock: BuildingBlock,
     output_dir.mkdir(parents=True, exist_ok=True)
 
     all_results: list[ValidationReportItem] = []
+
+    output_base_filenames = set()
+
     # Test resources
     if bblock.tests_dir.is_dir():
         for fn in sorted(bblock.tests_dir.resolve().iterdir()):
             if fn.suffix not in ('.json', '.jsonld', '.ttl'):
                 continue
             output_fn = output_dir / fn.name
+            output_base_filenames.add(fn.stem)
 
             test_result = _validate_resource(
                 bblock, fn, output_fn,
@@ -755,7 +759,12 @@ def validate_test_resources(bblock: BuildingBlock,
                 if code and lang in ('json', 'jsonld', 'ttl', 'json-ld', 'turtle'):
                     fn = bblock.files_path / (f"example_{example_id + 1}_{snippet_id + 1}"
                                               f".{FORMAT_ALIASES.get(snippet['language'], snippet['language'])}")
-                    output_fn = output_dir / fn.name
+
+                    output_fn = output_dir / sanitize_filename(example.get('base-output-filename', fn.name))
+                    i = 0
+                    while output_fn.stem in output_base_filenames:
+                        i += 1
+                        output_fn = output_fn.with_stem(f"{output_fn.stem}-{i}")
 
                     with open(output_fn, 'w') as f:
                         f.write(code)

requirements.txt

@@ -10,3 +10,4 @@ rdflib~=6.3.2
 jsonref~=1.1.0
 networkx~=3.1
 jq~=1.6
+pathvalidate==3.2.0