Added ability to auto-wrap notes.

comsysto · Jan 5, 2022 · c2393ca · c2393ca
1 parent 9b81922
commit c2393ca
Show file tree

Hide file tree

Showing 6 changed files with 47 additions and 11 deletions.
diff --git a/annotations/src/main/java/com/comsysto/livingdoc/s0t/annotation/plantuml/PlantUmlNote.java b/annotations/src/main/java/com/comsysto/livingdoc/s0t/annotation/plantuml/PlantUmlNote.java
@@ -27,5 +27,27 @@
      */
     Position position() default Position.TOP;
 
+    /**
+     * Max line length of the note.
+     *
+     * @return the maximum number of characters in a line.
+     */
+    int maxLineLength() default 30;
+
+    /**
+     * A flag indicating if long words shall be wrapped if they exceed
+     * maxLineLength.
+     *
+     * @return true if long words should be wrapped.
+     */
+    boolean wrapLongwords() default true;
+
+    /**
+     * A regular expression used to specify characters where line breaks may be
+     * inserted.
+     *
+     * @return a regular expression.
+     */
+    String wrapOn() default "";
 }
 
diff --git a/pom.xml b/pom.xml
@@ -37,6 +37,7 @@
         <snakeyaml.version>1.27</snakeyaml.version>
         <junit-platform.version>1.8.1</junit-platform.version>
         <tools.version>0.16.0</tools.version>
+        <commons-text.version>1.9</commons-text.version>
     </properties>
 
     <dependencies>
@@ -84,6 +85,11 @@
                 <artifactId>commons-configuration2</artifactId>
                 <version>${commons-configuration2.version}</version>
             </dependency>
+            <dependency>
+                <groupId>org.apache.commons</groupId>
+                <artifactId>commons-text</artifactId>
+                <version>${commons-text.version}</version>
+            </dependency>
             <dependency>
                 <groupId>org.yaml</groupId>
                 <artifactId>snakeyaml</artifactId>

diff --git a/processors/src/main/kotlin/com/comsysto/livingdoc/s0t/model/NoteModel.kt b/processors/src/main/kotlin/com/comsysto/livingdoc/s0t/model/NoteModel.kt
@@ -2,6 +2,7 @@ package com.comsysto.livingdoc.s0t.model
 
 import com.comsysto.livingdoc.s0t.annotation.plantuml.PlantUmlNote
 import com.comsysto.livingdoc.s0t.annotation.plantuml.PlantUmlNotes
+import org.apache.commons.text.WordUtils
 import javax.lang.model.element.TypeElement
 
 /**
@@ -11,9 +12,12 @@ data class NoteModel(val text: String, val position: Position) {
 
     companion object {
         fun allOf(typeElement: TypeElement): List<NoteModel> = typeElement.getAnnotation(PlantUmlNotes::class.java)
-            ?.let { notes -> notes.value.map { NoteModel(it.value, Position.valueOf(it.position.name)) } }
+            ?.let { notes -> notes.value.map { toNoteModel(it) } }
             ?: typeElement.getAnnotation(PlantUmlNote::class.java)
-                ?.let { listOf(NoteModel(it.value, Position.valueOf(it.position.name))) }
+                ?.let { listOf(toNoteModel(it)) }
                 .orEmpty()
+
+        private fun toNoteModel(it: PlantUmlNote) =
+            NoteModel(WordUtils.wrap(it.value, it.maxLineLength, "\n", it.wrapLongwords, it.wrapOn), Position.valueOf(it.position.name))
     }
 }
diff --git a/processors/src/test/java/com/comsysto/livingdoc/s0t/example/Airplane.java b/processors/src/test/java/com/comsysto/livingdoc/s0t/example/Airplane.java
@@ -13,7 +13,7 @@
 
 @PlantUmlClass
 @PlantUmlNote(
-    value = "This models an airplane, a //flying// \nvehicle that is **very** fast.",
+    value = "This models an airplane, a //flying// vehicle that is **very** fast.",
     position = BOTTOM)
 public class Airplane extends FlyingVehicle {
 
@@ -22,7 +22,7 @@ public class Airplane extends FlyingVehicle {
 
     @Override
     @PlantUmlExecutable
-    @PlantUmlNote(position = RIGHT, value = "Directly after launch, the\nplane needs to **retract** its wheels.")
+    @PlantUmlNote(position = RIGHT, value = "Directly after launch, the plane needs to **retract** its wheels.")
     public void launch() {
         super.launch();
         retractWheels();

diff --git a/processors/src/test/java/com/comsysto/livingdoc/s0t/example/GroundVehicle.java b/processors/src/test/java/com/comsysto/livingdoc/s0t/example/GroundVehicle.java
@@ -8,7 +8,7 @@
 
 @PlantUmlClass(diagramIds = { "package", "ground-vehicles" })
 @PlantUmlNote(value = "A vehicle that drives on the ground", position = Position.TOP)
-@PlantUmlNote(value = "Multiple notes may be\nattached to a type", position = Position.RIGHT)
+@PlantUmlNote(value = "Multiple notes may be attached to a type", position = Position.RIGHT)
 public abstract class GroundVehicle extends Vehicle {
 
     @PlantUmlField

diff --git a/processors/src/test/resources/expected/example-class.puml b/processors/src/test/resources/expected/example-class.puml
@@ -8,8 +8,9 @@ title Example class diagram
     }
 
 note bottom of Airplane
-This models an airplane, a //flying//
-vehicle that is **very** fast.
+This models an airplane, a
+//flying// vehicle that is
+**very** fast.
 end note
 
     class Car
@@ -23,11 +24,12 @@ end note
     }
 
 note top of GroundVehicle
-A vehicle that drives on the ground
+A vehicle that drives on the
+ground
 end note
 note right of GroundVehicle
-Multiple notes may be
-attached to a type
+Multiple notes may be attached
+to a type
 end note
 
     class Train {
@@ -42,7 +44,9 @@ end note
     }
 
 note top of TransportType
-Indicates whether a vehicle transports passengers or cargo.
+Indicates whether a vehicle
+transports passengers or
+cargo.
 end note
 
     class Vehicle {