Support setting tags on specification items (#9)

* [#7] Support setting tags on specification items

* Upgrade to most recent Asciidoc Java library

Upgraded to asciidoctorj 3.0.0.

Author: sophokles73

doc/changes/changelog.md

@@ -2,3 +2,4 @@
 
 * [0.1.0](changes_0.1.0.md)
 * [0.2.0](changes_0.2.0.md)
+* [0.3.0](changes_0.3.0.md)

doc/changes/changes_0.3.0.md

@@ -1,25 +1,11 @@
 # OpenFastTrace AsciiDoc Plugin 0.3.0, released YYYY-MM-DD
 
-Code name: {Codename}
+Code name: Add support for Tags
 
 ## Summary
 
-Here you can add more details about the general changes and improvements of this version.
-
-## Breaking Changes
-
-If there were significant or breaking changes made in this version, describe them here.
+Starting with this release, OpenFastTrace Tags can be set on specification items by means of the `oft-tags` attribute.
 
 ## Features
 
-* If there were any major features added in this version, list them here. Each feature should contain a brief explanation and, if applicable, any issue or PR numbers related to the feature.
-
-## Bug Fixes
-
-* If there were any bugs fixed in this version, detail them here. Like the features, they should contain a concise explanation and relevant issue numbers.
-
-## Known Issues
-
-* If there are any known issues in this version that were not fixed, list them here. Provide as much detail as possible to help users understand the impact and any potential workarounds.
-
-Please replace 'YYYY-MM-DD' with the actual release date, and '{Codename}' with the actual codename for this version, if any.
+* [Issue #7](https://github.com/itsallcode/openfasttrace-asciidoc-plugin/issues/7): Add support for specifying OpenFastTrace Tags on specitems

doc/changes/changes_0.4.0.md

@@ -0,0 +1,25 @@
+# OpenFastTrace AsciiDoc Plugin 0.4.0, released YYYY-MM-DD
+
+Code name: {Codename}
+
+## Summary
+
+Here you can add more details about the general changes and improvements of this version.
+
+## Breaking Changes
+
+If there were significant or breaking changes made in this version, describe them here.
+
+## Features
+
+* If there were any major features added in this version, list them here. Each feature should contain a brief explanation and, if applicable, any issue or PR numbers related to the feature.
+
+## Bug Fixes
+
+* If there were any bugs fixed in this version, detail them here. Like the features, they should contain a concise explanation and relevant issue numbers.
+
+## Known Issues
+
+* If there are any known issues in this version that were not fixed, list them here. Provide as much detail as possible to help users understand the impact and any potential workarounds.
+
+Please replace 'YYYY-MM-DD' with the actual release date, and '{Codename}' with the actual codename for this version, if any.

doc/spec/design.adoc

@@ -234,6 +234,19 @@ The list of artifact types that are needed to fully cover another specification
 This is the description of the first design item.
 ----
 
+[.specitem, oft-sid="dsn~adoc-tags-list~1", oft-covers="req~asciidoc-standard-syntax~1", oft-needs="impl, utest"]
+==== AsciiDoc "Tags" List
+
+The list of tags that apply to a specification item can be set by means of assigning the `oft-tags` _named attribute_ to it. The value of the attribute is a comma separated list of tags.
+
+.Example
+[example]
+----
+[.specitem, oft-sid="dsn~first-design-item~1", oft-needs="impl, utest", oft-tags="Priority1"]
+== First Design Item
+
+This is the description of the first design item.
+----
 
 [.specitem, oft-sid="dsn~adoc-artifact-forwarding-notation~1", oft-covers="req~artifact-type-forwarding-in-asciidoc~1", oft-needs="impl, utest"]
 ==== AsciiDoc Artifact Forwarding Notation

pom.xml

@@ -4,7 +4,7 @@
 
     <groupId>org.itsallcode</groupId>
     <artifactId>openfasttrace-asciidoc-plugin</artifactId>
-    <version>0.2.0</version>
+    <version>0.3.0-SNAPSHOT</version>
     <packaging>jar</packaging>
 
     <name>OpenFastTrace AsciiDoc Importer</name>
@@ -16,9 +16,9 @@
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <java.version>17</java.version>
         <oft.version>4.1.0</oft.version>
-        <junit.version>5.11.0-RC1</junit.version>
+        <junit.version>5.11.4</junit.version>
         <jacoco.version>0.8.12</jacoco.version>
-        <asciidoctor.version>2.5.13</asciidoctor.version>
+        <asciidoctor.version>3.0.0</asciidoctor.version>
         <sonar.organization>itsallcode</sonar.organization>
         <sonar.host.url>https://sonarcloud.io</sonar.host.url>
         <project.build.outputTimestamp>${git.commit.time}</project.build.outputTimestamp>
@@ -353,7 +353,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-surefire-plugin</artifactId>
-                <version>3.3.1</version>
+                <version>3.5.2</version>
                 <configuration>
                     <systemPropertyVariables>
                         <java.util.logging.config.file>src/test/resources/logging.properties</java.util.logging.config.file>

src/main/java/org/itsallcode/openfasttrace/importer/asciidoc/AsciiDocImporter.java

@@ -21,6 +21,7 @@ class AsciiDocImporter implements Importer
     private static final String ATTRIBUTE_OFT_NEEDS = "oft-needs";
     private static final String ATTRIBUTE_OFT_SID = "oft-sid";
     private static final String ATTRIBUTE_OFT_SKIPPED = "oft-skipped";
+    private static final String ATTRIBUTE_OFT_TAGS = "oft-tags";
     private static final String ATTRIBUTE_OFT_TITLE = "oft-title";
 
     private static final String CONTENT_MODEL_SIMPLE = "simple";
@@ -127,6 +128,13 @@ private void processSpecificationItemCovers(final StructuralNode block)
                 .forEach(this.listener::addCoveredId);
     }
 
+    // [impl->dsn~adoc-tags-list~1]
+    private void processSpecificationItemTags(final StructuralNode block)
+    {
+        getAttributeValueAsList(block, ATTRIBUTE_OFT_TAGS)
+                .forEach(this.listener::addTag);
+    }
+
     // [impl->dsn~adoc-specification-item-description~1]
     private void processSpecificationItemDescription(final StructuralNode block)
     {
@@ -170,6 +178,7 @@ private void processSpecificationItemBlock(final String sid, final StructuralNod
         processSpecificationItemDepends(block);
         processSpecificationItemNeeds(block);
         processSpecificationItemCovers(block);
+        processSpecificationItemTags(block);
         processSpecificationItemDescription(block);
         processSpecificationItemRationale(block);
         processSpecificationItemComment(block);

src/test/java/org/itsallcode/openfasttrace/importer/asciidoc/AsciiDocImporterTest.java

@@ -66,7 +66,7 @@ void testImporterIgnoresSpecItemWithoutId(final String content)
             """
                     # Spec
 
-                    [.specitem, oft-sid="dsn~detail-design~1", oft-depends="dsn~grand-design~1, arch~general-constraints~1", oft-needs="impl, utest", oft-covers="req~first-requirement~1, req~second-requirement~1"]
+                    [.specitem, oft-sid="dsn~detail-design~1", oft-depends="dsn~grand-design~1, arch~general-constraints~1", oft-needs="impl, utest", oft-covers="req~first-requirement~1, req~second-requirement~1", oft-tags="Priority1, OtherComponent"]
                     ## A Requirement
 
                     The description
@@ -80,7 +80,7 @@ void testImporterIgnoresSpecItemWithoutId(final String content)
             """
                     # Spec
 
-                    [.specitem, oft-sid="dsn~detail-design~1", oft-depends="dsn~grand-design~1, arch~general-constraints~1", oft-needs="impl, utest", oft-covers="req~first-requirement~1, req~second-requirement~1"]
+                    [.specitem, oft-sid="dsn~detail-design~1", oft-depends="dsn~grand-design~1, arch~general-constraints~1", oft-needs="impl, utest", oft-covers="req~first-requirement~1, req~second-requirement~1", oft-tags="Priority1, OtherComponent"]
                     ## A Requirement
 
                     [.rationale]
@@ -96,7 +96,7 @@ void testImporterIgnoresSpecItemWithoutId(final String content)
                     # Spec
 
                     .A Requirement
-                    [.specitem, oft-sid="dsn~detail-design~1", oft-depends="dsn~grand-design~1, arch~general-constraints~1", oft-needs="impl, utest", oft-covers="req~first-requirement~1, req~second-requirement~1"]
+                    [.specitem, oft-sid="dsn~detail-design~1", oft-depends="dsn~grand-design~1, arch~general-constraints~1", oft-needs="impl, utest", oft-covers="req~first-requirement~1, req~second-requirement~1", oft-tags="Priority1, OtherComponent"]
                     ====
 
                     The description
@@ -112,7 +112,7 @@ void testImporterIgnoresSpecItemWithoutId(final String content)
                     # Spec
 
                     .A Requirement
-                    [.specitem, oft-sid="dsn~detail-design~1", oft-depends="dsn~grand-design~1, arch~general-constraints~1", oft-needs="impl, utest", oft-covers="req~first-requirement~1, req~second-requirement~1"]
+                    [.specitem, oft-sid="dsn~detail-design~1", oft-depends="dsn~grand-design~1, arch~general-constraints~1", oft-needs="impl, utest", oft-covers="req~first-requirement~1, req~second-requirement~1", oft-tags="Priority1, OtherComponent"]
                     ====
 
                     [.rationale]
@@ -140,6 +140,8 @@ void testImporterReadsFullSpecItem(final String content)
         Mockito.verify(listener).addNeededArtifactType("utest");
         Mockito.verify(listener).addCoveredId(new SpecificationItemId.Builder("req~first-requirement~1").build());
         Mockito.verify(listener).addCoveredId(new SpecificationItemId.Builder("req~second-requirement~1").build());
+        Mockito.verify(listener).addTag("Priority1");
+        Mockito.verify(listener).addTag("OtherComponent");
         Mockito.verify(listener).appendDescription("The description");
         Mockito.verify(listener).appendRationale("The rationale");
         Mockito.verify(listener).appendComment("A comment");