Merge branch 'preview' of https://github.com/buildingSMART/ifc-gherkin-rules into preview

Author: civilx64

.github/workflows/dispatch.yml

@@ -3,7 +3,7 @@ name: Dispatch
 on:
   push:
     branches:
-      - development
+      - preview
     paths-ignore:
       - '.github/**'
   workflow_dispatch:

features/rules/GRF/GRF003_CRS-presence-with-spatial-entities.feature

@@ -4,19 +4,19 @@
 @version1
 Feature: GRF003 - CRS presence with spatial entities
 The rule verifies that proper georeferencing using a coordinate reference system is established when facilities such as buildings or bridges are present in a model.
-Models containing IfcFacility must contain a IfcProjectedCRS or IfcGeographicCRS.
+Models containing facilities such as buildings, bridges, railways, and roads should contain an IfcProjectedCRS or IfcGeographicCRS.
 
 
     Scenario: CRS required when IfcBuilding is present
 
     Given a model with Schema 'IFC4'
     Given an .IfcBuilding.
 
-    Then There must be at least 1 instance(s) of .IfcProjectedCRS.
+    Then There should be at least 1 instance(s) of .IfcProjectedCRS.
 
     Scenario: CRS required when IfcFacility is present
 
     Given a model with Schema 'IFC4.3'
     Given an .IfcFacility.
 
-    Then There must be at least 1 instance(s) of .IfcCoordinateReferenceSystem.
+    Then There should be at least 1 instance(s) of .IfcCoordinateReferenceSystem.

features/steps/registered_type_definitions.json

@@ -17,5 +17,6 @@
     "display_entity": [" ", "and display entity instance"],
     "property_set_or_element_quantity": ["IfcPropertySet", "IfcElementQuantity"],
     "property_or_physical_quantity": ["IfcProperty", "IfcPhysicalQuantity"],
-    "continuity_type": ["position", "tangency", "cant gradient", "vertical gradient"]
+    "continuity_type": ["position", "tangency", "cant gradient", "vertical gradient"],
+    "must_or_should": ["must", "should"]
 }

features/steps/thens/existence.py

@@ -47,10 +47,10 @@ def get_entities_in_model(context, constraint, entity, include_or_exclude_subtyp
 
 
 @gherkin_ifc.step(
-    "There must be {constraint} {num:d} instance(s) of .{entity}. ^{subtype_handling:include_or_exclude_subtypes}^"
+    "There {spec_word:must_or_should} be {constraint} {num:d} instance(s) of .{entity}. ^{subtype_handling:include_or_exclude_subtypes}^"
 )
 @global_rule
-def step_impl(context, inst, constraint, num, entity, subtype_handling="including subtypes"):
+def step_impl(context, inst, spec_word, constraint, num, entity, subtype_handling="including subtypes"):
     op = misc.stmt_to_op(constraint)
     instances_in_model = get_entities_in_model(context, constraint, entity, subtype_handling)
     if not op(len(instances_in_model), num):
@@ -59,9 +59,9 @@ def step_impl(context, inst, constraint, num, entity, subtype_handling="includin
         )
 
 
-@gherkin_ifc.step("There must be {constraint} {num:d} instance(s) of .{entity}.")
+@gherkin_ifc.step("There {spec_word:must_or_should} be {constraint} {num:d} instance(s) of .{entity}.")
 @global_rule
-def step_impl(context, inst, constraint, num, entity, include_or_exclude_subtypes="including subtypes"):
+def step_impl(context, inst, spec_word, constraint, num, entity, include_or_exclude_subtypes="including subtypes"):
     """
     The Given step_impl in combination with 'at least 1' is the equivalent of 'Given an IfcEntity', but without setting new applicable instances. 
     For example: