using comma separations when merging non-json meta-data

Author: jchapuis

src/main/scala/com/nexthink/utils/parsing/combinator/completion/CompletionSupport.scala

@@ -177,6 +177,7 @@ trait CompletionSupport extends Parsers with CompletionTypes {
       Parser(this, in => updateCompletionsTag(this.completions(in), None, None, Some(tagDescription), None))
 
     /** An operator to specify the completion tag meta-data of a parser (empty by default).
+      * Note that meta-data is merged with comma separations when combining two equivalent entries.
       * @param tagMeta the completion tag meta-data (to be used e.g. to specify the visual style for a completion tag in the menu)
       * @return wrapper `Parser` instance specifying the completion tag meta-data
       */
@@ -192,17 +193,18 @@ trait CompletionSupport extends Parsers with CompletionTypes {
       */
     def %%(tagMeta: JValue): Parser[T] = %%(compact(render(tagMeta)))
 
-    /** An operator to specify the meta-data for completions of a parser (empty by default)
+    /** An operator to specify the meta-data for completions of a parser (empty by default).
+      * Note that meta-data is merged with comma separations when combining two equivalent entries.
       * @param meta the completion meta-data (to be used e.g. to specify the visual style for a completion entry in the menu)
       * @return wrapper `Parser` instance specifying the completion meta-data
       */
     def %-%(meta: String): Parser[T] =
       Parser(this, in => updateCompletions(this.completions(in), Some(meta)))
 
     /** An operator to specify the meta-data for completions of a parser in JSON format (empty by default)
-      * Note that if the meta-data is encoded in JSON, it is automatically merged when combining two equivalent tags
+      * Note that if the meta-data is encoded in JSON, it is automatically merged when combining two equivalent entries
       * (i.e. bearing the same label, but with a different payload). This allows for more flexibility when defining the grammar:
-      * various parsers can return the same completion entries with an additive effect on the meta-data.
+      *  various parsers can return the same completion entries with an additive effect on the meta-data.
       * @param meta the JValue for completion meta-data (to be used e.g. to specify the visual style for a completion entry in the menu)
       * @return wrapper `Parser` instance specifying the completion meta-data
       */

src/main/scala/com/nexthink/utils/parsing/combinator/completion/CompletionTypes.scala

@@ -162,11 +162,12 @@ trait CompletionTypes {
     override def toString: String = pretty(render(serializeJson))
     def toJson: String            = compact(render(serializeJson))
 
+
     private def mergeMetaData(left: Option[String], right: Option[String]) = (left, right) match {
       case (Some(l), Some(r)) =>
         (parseOpt(l), parseOpt(r)) match {
           case (Some(lJson), Some(rJson)) => Some(compact(render(lJson merge rJson)))
-          case _                          => Some(l + r)
+          case _                          => Some(Seq(l, r).mkString(", "))
         }
       case (Some(l), None) => Some(l)
       case (None, Some(r)) => Some(r)

src/test/scala/com/nexthink/utils/parsing/combinator/completion/CompletionTypesTest.scala

@@ -17,13 +17,17 @@ class CompletionTypesTest extends CompletionTypes {
 
   val setA = CompletionSet(
     CompletionTag("A", 10, Some("description"), Some(compact(render("type" -> "a-type")))),
-    Set(Completion("a", 2), Completion("b", 1, Some(compact(render(("objects" -> Seq("devices")) ~ ("themes" -> Seq("some")))))))
+    Set(Completion("a", 2, Some("meta1")), Completion("b", 1, Some(compact(render(("objects" -> Seq("devices")) ~ ("themes" -> Seq("some")))))))
   )
   val setB = CompletionSet(CompletionTag("B", 5), Set(Completion("c", 4), Completion("d", 3)))
   val setC = CompletionSet("C", Completion("e", 10))
   val setAPrime = CompletionSet(
     CompletionTag("A", 10, None, Some(compact(render("style" -> "highlight")))),
-    Set(Completion("a", 4), Completion("b", 1, Some(compact(render(("objects" -> Seq("users", "packages")) ~ ("themes" -> Seq("other")))))), Completion("aa"))
+    Set(
+      Completion("a", 4, Some("meta2")),
+      Completion("b", 1, Some(compact(render(("objects" -> Seq("users", "packages")) ~ ("themes" -> Seq("other")))))),
+      Completion("aa")
+    )
   )
 
   @Test
@@ -58,7 +62,7 @@ class CompletionTypesTest extends CompletionTypes {
         CompletionSet(
           CompletionTag("A", 10, Some("description"), Some(compact(render(("type" -> "a-type") ~ ("style" -> "highlight"))))),
           Set(
-            Completion("a", 4),
+            Completion("a", 4, Some("meta1, meta2")),
             Completion("b", 1, Some(compact(render(("objects" -> Seq("devices", "users", "packages")) ~ ("themes" -> Seq("some", "other")))))),
             Completion("aa")
           )