Merge pull request #351 from bci-oss/bugfix/ESMF-313-characteristic-trait-is-not-displayed

Fix #313 Trait Base Characteristic not included in HTML Documentation

Author: atextor

core/esmf-aspect-model-document-generators/src/main/resources/docu/templates/html/characteristic-documentation-lib.vm

@@ -22,6 +22,13 @@
                     #list( $characteristic.getSee() )
                 </div>
             </div>
+        #elseif($characteristic.getBaseCharacteristic())
+            <div class="table-row-group">
+                <div class="table-cell pb-3 col-span-2">
+                    $i18n.getText( "docu.label.see" )
+                    #list( $characteristic.getBaseCharacteristic().getSee() )
+                </div>
+            </div>
         #end
         #if( $characteristic.getDataType().isPresent() && !$characteristicClass.equals( "Either" )  )
             <div class="table-row-group">

core/esmf-aspect-model-document-generators/src/main/resources/docu/templates/html/property-documentation-lib.vm

@@ -81,7 +81,13 @@
     #if( !$property.getSee().isEmpty() )
         <div class="flex border-b pb-1 py-4">
             <div class="w-80">$i18n.getText( "docu.label.see" )</div>
-            #list( $property.getSee() )
+            <div class="w-full">
+                #foreach($item in $property.getSee())
+                    <ul class="reset-all-styles m-0 list">
+                        <li>$item</li>
+                    </ul>
+                #end
+            </div>
         </div>
     #end
 

core/esmf-aspect-model-document-generators/src/test/java/org/eclipse/esmf/aspectmodel/generator/docu/AspectModelDocumentationGeneratorTest.java

@@ -194,6 +194,18 @@ public void testAspectWithQuantifiableWithoutUnit( final KnownVersion metaModelV
       }
    }
 
+   @ParameterizedTest
+   @MethodSource( "allVersions" )
+   public void testAspectWithConstraintWithSeeAttribute( final KnownVersion metaModelVersion ) throws IOException {
+      final String documentation = generateHtmlDocumentation( TestAspect.ASPECT_WITH_CONSTRAINT_WITH_SEE_ATTRIBUTE, metaModelVersion );
+      assertThat( documentation ).contains(
+              "<h3 id=\"org-eclipse-esmf-test-AspectWithConstraintWithSeeAttribute-org-eclipse-esmf-test-testPropertyTwo-property\">testPropertyTwo</h3>" );
+      assertThat( documentation ).contains(
+              "<div class=\"table-cell pb-3 col-span-2\">Trait</div>" );
+      assertThat( documentation ).contains(
+              "<li>http://example.com/me2</li>" );
+   }
+
    private String generateHtmlDocumentation( final TestAspect model, final KnownVersion testedVersion ) throws IOException {
       final VersionedModel versionedModel = TestResources.getModel( model, testedVersion ).get();
       final Aspect aspect = AspectModelLoader.getSingleAspect( versionedModel ).getOrElseThrow( () -> new RuntimeException() );

core/esmf-test-aspect-models/src/main/resources/valid/samm_1_0_0/org.eclipse.esmf.test/1.0.0/AspectWithConstraintWithSeeAttribute.ttl

@@ -43,13 +43,15 @@
 :TestTraitTwo a samm-c:Trait ;
    samm:name "TestTraitTwo" ;
    samm-c:constraint [
-      a samm-c:LengthConstraint ;
-      samm:name "TestConstraintTwo" ;
+      a samm-c:RegularExpressionConstraint ;
       samm:preferredName "Test Constraint Two"@en ;
       samm:description "Test Constraint Two"@en ;
-      samm:see <http://example.com/> ;
       samm:see <http://example.com/me> ;
-      samm-c:minValue "5"^^xsd:nonNegativeInteger ;
-      samm-c:maxValue "10"^^xsd:nonNegativeInteger ;
+      samm:value "^[A-Z][A-Z][A-Z]$" ;
    ] ;
-   samm-c:baseCharacteristic samm-c:Text .
+   samm-c:baseCharacteristic :TestCharacteristicTwo .
+:TestCharacteristicTwo a samm:Characteristic;
+    samm:preferredName "Test Characteristic Two"@en;
+    samm:description "Test Characteristic Two"@en;
+    samm:dataType xsd:string;
+    samm:see <http://example.com/me2> .

core/esmf-test-aspect-models/src/main/resources/valid/samm_2_0_0/org.eclipse.esmf.test/1.0.0/AspectWithConstraintWithSeeAttribute.ttl

@@ -37,11 +37,15 @@
 
 :TestTraitTwo a samm-c:Trait ;
    samm-c:constraint [
-      a samm-c:LengthConstraint ;
+      a samm-c:RegularExpressionConstraint ;
       samm:preferredName "Test Constraint Two"@en ;
       samm:description "Test Constraint Two"@en ;
-      samm:see <http://example.com/> ;
-      samm-c:minValue "5"^^xsd:nonNegativeInteger ;
-      samm-c:maxValue "10"^^xsd:nonNegativeInteger ;
+      samm:see <http://example.com/me> ;
+      samm:value "^[A-Z][A-Z][A-Z]$" ;
    ] ;
-   samm-c:baseCharacteristic samm-c:Text .
+   samm-c:baseCharacteristic :TestCharacteristicTwo .
+:TestCharacteristicTwo a samm:Characteristic;
+    samm:preferredName "Test Characteristic Two"@en;
+    samm:description "Test Characteristic Two"@en;
+    samm:dataType xsd:string;
+    samm:see <http://example.com/me2> .