Update tests and refactoring

Author: Yauhenikapl

core/esmf-aspect-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/utils/DescriptionsUtils.java

@@ -17,6 +17,7 @@
 import java.util.List;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
+import java.util.stream.Collectors;
 
 /**
  * Utility class for extracting and rendering structured content blocks (such as NOTE, EXAMPLE, SOURCE)
@@ -88,13 +89,13 @@ public static String toHtml( final String description ) {
     * <p>Each block is expected to begin with a {@code > TYPE:} line and may span multiple lines,
     * each of which begins with {@code >}.
     *
-    * @param descriptions A set of multi-line Markdown description strings.
+    * @param description A line Markdown description string.
     * @param type The type of block to extract ("NOTE", "EXAMPLE", or "SOURCE").
     * @return A list of extracted block contents for the specified type.
     */
-   private static List<String> extractBlock( final String descriptions, final String type ) {
+   private static List<String> extractBlock( final String description, final String type ) {
       List<String> result = new ArrayList<>();
-      extractFromDescription( descriptions, type, result );
+      extractFromDescription( stripIndent( description ), type, result );
       return result;
    }
 
@@ -141,5 +142,17 @@ private static void flushBlock( boolean[] insideBlock, StringBuilder blockConten
          insideBlock[0] = false;
       }
    }
+
+   static String stripIndent( final String string ) {
+      final int indent = string.lines()
+            .filter( line -> !line.isEmpty() )
+            .map( line -> line.indexOf( line.trim() ) )
+            .filter( offset -> offset > 0 )
+            .min( Integer::compareTo )
+            .orElse( 0 );
+      return string.lines()
+            .map( line -> indent <= line.length() ? line.substring( indent ) : line )
+            .collect( Collectors.joining( "\n" ) );
+   }
 }
 

core/esmf-aspect-meta-model-java/src/test/java/org/eclipse/esmf/aspectmodel/utils/DescriptionsUtilsTest.java

@@ -132,4 +132,12 @@ void testHtmlOutputDoesNotContainMarkdownSyntax() {
       String html = DescriptionsUtils.toHtml( testDescription );
       assertThat( html ).doesNotContain( "[Visit Example](https://example.com)" );
    }
+
+   @Test
+   void testStripIndentSingleLine() {
+      String input = "    only one line";
+      String expected = "only one line";
+      String result = DescriptionsUtils.stripIndent( input );
+      assertEquals( expected, result );
+   }
 }

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

@@ -20,10 +20,12 @@
 import java.io.IOException;
 import java.io.PrintStream;
 
+import org.eclipse.esmf.aspectmodel.utils.DescriptionsUtils;
 import org.eclipse.esmf.metamodel.Aspect;
 import org.eclipse.esmf.test.TestAspect;
 import org.eclipse.esmf.test.TestResources;
 
+import org.assertj.core.api.AssertionsForClassTypes;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.EnumSource;
@@ -179,6 +181,24 @@ void testAspectWithConstraintWithSeeAttribute() throws IOException {
             "<li>http://example.com/me2</li>" );
    }
 
+   @Test
+   void testMarkdownRenderingWithLink() throws IOException {
+      final String htmlResult = generateHtmlDocumentation( TestAspect.ASPECT_WITH_MARKDOWN_DESCRIPTION );
+      AssertionsForClassTypes.assertThat( htmlResult ).contains( "<a href=\"https://example.com\">Visit Example</a>" );
+   }
+
+   @Test
+   void testAspectWithMarkdownDescription() throws IOException {
+      final String htmlResult = generateHtmlDocumentation( TestAspect.ASPECT_WITH_MARKDOWN_DESCRIPTION );
+      AssertionsForClassTypes.assertThat( htmlResult ).doesNotContain( "[link](https://www.example.com/spec)" );
+   }
+
+   @Test
+   void testHtmlOutputDoesNotContainMarkdownSyntax() throws IOException {
+      final String htmlResult = generateHtmlDocumentation( TestAspect.ASPECT_WITH_MARKDOWN_DESCRIPTION );
+      AssertionsForClassTypes.assertThat( htmlResult ).doesNotContain( "[Visit Example](https://example.com)" );
+   }
+
    private String generateHtmlDocumentation( final TestAspect testAspect ) throws IOException {
       final Aspect aspect = TestResources.load( testAspect ).aspect();
       final AspectModelDocumentationGenerator aspectModelDocumentationGenerator = new AspectModelDocumentationGenerator( aspect );

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

@@ -14,38 +14,38 @@
 @prefix samm-c: <urn:samm:org.eclipse.esmf.samm:characteristic:2.2.0#> .
 
 :AspectWithMarkdownDescription a samm:Aspect ;
-  samm:properties ( :myProperty ) ;
-  samm:operations ( ) .
+   samm:properties ( :myProperty ) ;
+   samm:operations ( ) .
 
 :myProperty a samm:Property ;
-  samm:description """
-This is a sample concept demonstrating **Markdown** support in samm:description.
+   samm:description """
+      This is a sample concept demonstrating **Markdown** support in samm:description.
 
-> NOTE: This is a note block.
-> It supports multiple lines.
-> Here's a second line of the note.
+      > NOTE: This is a note block.
+      > It supports multiple lines.
+      > Here's a second line of the note.
 
-> EXAMPLE 1: This is the first example block.
-> It can span several lines, and supports *italic* and **bold** text.
+      > EXAMPLE 1: This is the first example block.
+      > It can span several lines, and supports *italic* and **bold** text.
 
-> EXAMPLE 2: This is the second example.
-> Also multiline, for testing multiple example entries.
+      > EXAMPLE 2: This is the second example.
+      > Also multiline, for testing multiple example entries.
 
-> SOURCE: ISO 12345:2023, section 4.2.1
-> with an inline [link](https://www.example.com/spec).
+      > SOURCE: ISO 12345:2023, section 4.2.1
+      > with an inline [link](https://www.example.com/spec).
 
-Unordered list:
-* Item A
-* Item B
-* Item C
+      Unordered list:
+        * Item A
+        * Item B
+        * Item C
 
-Ordered list:
-1. First
-2. Second
-3. Third
+      Ordered list:
+        1. First
+        2. Second
+        3. Third
 
-You can also include inline links like [Visit Example](https://example.com).
+      You can also include inline links like [Visit Example](https://example.com).
 
-Another paragraph after a blank line to simulate text flow and paragraph breaks.
-     """@en ;
+      Another paragraph after a blank line to simulate text flow and paragraph breaks.
+   """@en ;
   samm:characteristic samm-c:Text .