Change SHACL "rules" to "shapes"

All metadata properties and references are changed.
Legacy "shaclRules" and "rules.shacl" are still supported
as input, but only "shaclShapes" will be generated in the output.

Author: avillar

ogc/bblocks/models.py

@@ -92,11 +92,18 @@ def __init__(self, identifier: str, metadata_file: Path,
         self.output_openapi = self.annotated_path / 'openapi.yaml'
         self.output_openapi_30 = self.output_openapi.with_stem(f"{self.output_openapi.stem}-oas30")
 
-        shacl_rules = self.metadata.setdefault('shaclRules', [])
-        default_shacl_rules = fp / 'rules.shacl'
-        if default_shacl_rules.is_file():
-            shacl_rules.append('rules.shacl')
-        self.shacl_rules = set(r if is_url(r) else fp / r for r in shacl_rules)
+        shacl_shapes = self.metadata.setdefault('shaclShapes', [])
+        if not shacl_shapes and self.metadata.get('shaclRules'):
+            shacl_shapes.extend(self.metadata.pop('shaclRules'))
+        default_shacl_shapes = fp / 'shapes.shacl'
+        if default_shacl_shapes.is_file():
+            shacl_shapes.append('shapes.shacl')
+        else:
+            legacy_shacl_shapes = fp / 'rules.shacl'
+            if legacy_shacl_shapes.is_file():
+                shacl_shapes.append('rules.shacl')
+
+        self.shacl_shapes = set(r if is_url(r) else fp / r for r in shacl_shapes)
 
         self.ontology = self._find_path_or_url('ontology',
                                                ('ontology.ttl', 'ontology.owl'))
@@ -466,7 +473,9 @@ def __init__(self,
             if identifier in self.bblocks:
                 continue
             dep_graph.add_node(identifier)
-            dep_graph.add_edges_from([(d, identifier) for d in imported_bblock.get('dependsOn', ())])
+            dep_graph.add_edges_from([(d, identifier)
+                                      for d in imported_bblock.get('dependsOn', ())
+                                      if d != identifier])
             for schema_url in imported_bblock.get('schema', {}).values():
                 self.imported_bblock_files[schema_url] = identifier
             source_schema = imported_bblock.get('sourceSchema')
@@ -492,7 +501,9 @@ def __init__(self,
             if found_deps:
                 bblock.metadata['dependsOn'] = list(found_deps)
             dep_graph.add_node(bblock.identifier)
-            dep_graph.add_edges_from([(d, bblock.identifier) for d in bblock.metadata.get('dependsOn', ())])
+            dep_graph.add_edges_from([(d, bblock.identifier)
+                                      for d in bblock.metadata.get('dependsOn', ())
+                                      if d != bblock.identifier])
 
             for a, b in dep_graph.edges:
                 if a not in self.bblocks and a not in self.imported_bblocks:
@@ -595,14 +606,14 @@ def find_dependencies(self, identifier: str, seen: tuple[str] = None) -> list[di
 
         return dependencies
 
-    def get_inherited_shacl_rules(self, identifier: str) -> dict[str, set[str | Path]]:
+    def get_inherited_shacl_shapes(self, identifier: str) -> dict[str, set[str | Path]]:
         rules: dict[str, set[str | Path]] = {}
         for dep in self.find_dependencies(identifier):
             if isinstance(dep, BuildingBlock):
-                if dep.shacl_rules:
-                    rules[dep.identifier] = dep.shacl_rules
+                if dep.shacl_shapes:
+                    rules[dep.identifier] = dep.shacl_shapes
             else:
-                dep_rules = dep.get('shaclRules')
+                dep_rules = dep.get('shaclShapes', dep.get('shaclRules'))
                 if dep_rules:
                     if isinstance(dep_rules, list):
                         rules.setdefault(dep.get('itemIdentifier'), set()).update(dep_rules)

ogc/bblocks/postprocess.py

@@ -192,11 +192,11 @@ def do_postprocess(bblock: BuildingBlock, light: bool = False) -> bool:
                         snippet['url'] = f"{base_url}{path}"
 
         if base_url:
-            if bblock.shaclRules:
-                if isinstance(bblock.shaclRules, list):
-                    bblock.metadata['shaclRules'] = {bblock.identifier: bblock.shacl_rules}
-                bblock.metadata['shaclRules'] = {k: [urljoin(base_url, str(s)) for s in v]
-                                                 for k, v in bblock.shaclRules.items()}
+            if bblock.shaclShapes:
+                if isinstance(bblock.shaclShapes, list):
+                    bblock.metadata['shaclShapes'] = {bblock.identifier: bblock.shaclShapes}
+                bblock.metadata['shaclShapes'] = {k: [urljoin(base_url, str(s)) for s in v]
+                                                 for k, v in bblock.shaclShapes.items()}
             if bblock.transforms:
                 bblock.metadata['transforms'] = []
                 for transform in bblock.transforms:

ogc/bblocks/register-context.yaml

@@ -92,7 +92,7 @@ context:
       '@id': prof:isProfileOf
       '@type': '@id'
     tags: dcat:keyword
-    shaclRules:
+    shaclShapes:
       '@id': bblocks:hasShaclRule
       '@type': '@id'
       '@container': '@index'

ogc/bblocks/schemas/bblock.schema.yaml

@@ -186,11 +186,16 @@ properties:
   group:
     description: An identifier to group Building Blocks together
     type: string
-  shaclRules:
+  shaclShapes:
     description: List of SHACL files to use for RDF validation. Can be URLs or file paths.
     type: array
     items:
       type: string
+  shaclRules:
+    description: Legacy alias for `shaclShapes`.
+    type: array
+    items:
+      type: string
   shaclClosures:
     description: |
       List of RDF files or URLs that will be used as SHACL closures for RDF validation. They will be merged with

ogc/bblocks/validation/rdf.py

@@ -107,10 +107,10 @@ def __init__(self, bblock: BuildingBlock, register: BuildingBlockRegister):
         self.closure_graph = Graph()
         self.shacl_graphs: dict[str, Graph] = {}
         self.shacl_errors: list[str] = []
-        inherited_shacl_rules = register.get_inherited_shacl_rules(bblock.identifier)
-        for shacl_bblock in list(inherited_shacl_rules.keys()):
+        inherited_shacl_shapes = register.get_inherited_shacl_shapes(bblock.identifier)
+        for shacl_bblock in list(inherited_shacl_shapes.keys()):
             bblock_shacl_files = set()
-            for shacl_file in inherited_shacl_rules[shacl_bblock]:
+            for shacl_file in inherited_shacl_shapes[shacl_bblock]:
                 if isinstance(shacl_file, Path) or (isinstance(shacl_file, str) and not is_url(shacl_file)):
                     # assume file
                     shacl_file = str(os.path.relpath(bblock.files_path / shacl_file))
@@ -121,7 +121,7 @@ def __init__(self, bblock: BuildingBlock, register: BuildingBlockRegister):
                     self.shacl_errors.append(f"Error retrieving {e.url}: {e}")
                 except Exception as e:
                     self.shacl_errors.append(f"Error processing {shacl_file}: {str(e)}")
-            inherited_shacl_rules[shacl_bblock] = bblock_shacl_files
+            inherited_shacl_shapes[shacl_bblock] = bblock_shacl_files
 
         for shacl_closure in bblock.shaclClosures or ():
             try:
@@ -131,7 +131,7 @@ def __init__(self, bblock: BuildingBlock, register: BuildingBlockRegister):
             except Exception as e:
                 self.shacl_errors.append(f"Error processing {shacl_closure}: {str(e)}")
 
-        bblock.metadata['shaclRules'] = inherited_shacl_rules
+        bblock.metadata['shaclShapes'] = inherited_shacl_shapes
 
         self.uplifter = Uplifter(self.bblock)