Don't include mutators in PRODID anymore (#143)

* Don't include mutators in PRODID anymore; allow PRODID parameters for later

* Update ProdIdGenerator documentation

- Clarify `generateProdId` parameter and return value descriptions
- Improve method description to reflect optional package names usage

Author: rfc2822

lib/src/main/kotlin/at/bitfire/synctools/icalendar/AssociatedComponents.kt

@@ -8,6 +8,7 @@ package at.bitfire.synctools.icalendar
 
 import net.fortuna.ical4j.model.component.CalendarComponent
 import net.fortuna.ical4j.model.component.VEvent
+import net.fortuna.ical4j.model.property.ProdId
 
 /**
  * Represents a set of components (like VEVENT) stored in a calendar object resource as defined
@@ -33,7 +34,7 @@ import net.fortuna.ical4j.model.component.VEvent
 data class AssociatedComponents<T: CalendarComponent>(
     val main: T?,
     val exceptions: List<T>,
-    val prodId: String? = null
+    val prodId: ProdId? = null
 ) {
 
     init {

lib/src/main/kotlin/at/bitfire/synctools/icalendar/ICalendarGenerator.kt

@@ -17,7 +17,6 @@ import net.fortuna.ical4j.model.component.CalendarComponent
 import net.fortuna.ical4j.model.component.VEvent
 import net.fortuna.ical4j.model.property.DateProperty
 import net.fortuna.ical4j.model.property.DtStart
-import net.fortuna.ical4j.model.property.ProdId
 import net.fortuna.ical4j.model.property.Version
 import java.io.Writer
 import javax.annotation.WillNotClose
@@ -40,7 +39,7 @@ class ICalendarGenerator {
 
         // add PRODID
         if (event.prodId != null)
-            ical.properties += ProdId(event.prodId)
+            ical.properties += event.prodId
 
         // keep record of used timezones and earliest DTSTART to generate minified VTIMEZONEs
         var earliestStart: Date? = null

lib/src/main/kotlin/at/bitfire/synctools/mapping/calendar/AndroidEventHandler.kt

@@ -39,6 +39,7 @@ import net.fortuna.ical4j.model.TimeZoneRegistryFactory
 import net.fortuna.ical4j.model.component.VEvent
 import net.fortuna.ical4j.model.parameter.Value
 import net.fortuna.ical4j.model.property.ExDate
+import net.fortuna.ical4j.model.property.ProdId
 import net.fortuna.ical4j.model.property.RDate
 import net.fortuna.ical4j.model.property.RRule
 import net.fortuna.ical4j.model.property.RecurrenceId
@@ -172,7 +173,7 @@ class AndroidEventHandler(
         }
     }
 
-    private fun generateProdId(main: Entity): String {
+    private fun generateProdId(main: Entity): ProdId {
         val mutators: String? = main.entityValues.getAsString(Events.MUTATORS)
         val packages: List<String> = mutators?.split(MUTATORS_SEPARATOR)?.toList() ?: emptyList()
         return prodIdGenerator.generateProdId(packages)

lib/src/main/kotlin/at/bitfire/synctools/mapping/calendar/ProdIdGenerator.kt

@@ -6,31 +6,40 @@
 
 package at.bitfire.synctools.mapping.calendar
 
+import net.fortuna.ical4j.model.ParameterList
+import net.fortuna.ical4j.model.property.ProdId
+
 fun interface ProdIdGenerator {
 
     /**
-     * Generates a `PRODID` string using additional package names.
+     * Generates a `PRODID` string, possibly using additional package names.
      *
-     * @param packages  package names that have modified/generated the iCalendar (like `com.example.app.calendar`; may be empty)
+     * @param packages  package names that have modified the entry in the local storage (like `com.example.app.calendar`; may be empty)
      *
-     * @return the full `PRODID` string, with the package names and probably additional information added
-     * (like `MyApp/1.0 (com.example.app.calendar)`)
+     * @return the generated `PRODID` property, possibly including additional information (like `PRODID:MyApp/1.0`)
      */
-    fun generateProdId(packages: List<String>): String
+    fun generateProdId(packages: List<String>): ProdId
 
 }
 
 class DefaultProdIdGenerator(
-    private val baseId: String
+    private val prodId: String
 ): ProdIdGenerator {
 
-    override fun generateProdId(packages: List<String>): String {
-        val builder = StringBuilder(baseId)
-        if (packages.isNotEmpty())
-            builder .append(" (")
-                .append(packages.joinToString(", "))
-                .append(")")
-        return builder.toString()
+    override fun generateProdId(packages: List<String>): ProdId {
+        val params = ParameterList()
+
+        // check compatibility first
+        /*if (packages.isNotEmpty()) {
+            val packagesStr = packages.joinToString(",")
+            params.add(XParameter(PARAMETER_MUTATORS, packagesStr))
+        }*/
+
+        return ProdId(params, prodId)
     }
 
+    /*companion object {
+        const val PARAMETER_MUTATORS = "x-mutators"
+    }*/
+
 }

lib/src/test/kotlin/at/bitfire/synctools/icalendar/ICalendarGeneratorTest.kt

@@ -13,6 +13,7 @@ import net.fortuna.ical4j.model.component.VEvent
 import net.fortuna.ical4j.model.property.DtEnd
 import net.fortuna.ical4j.model.property.DtStamp
 import net.fortuna.ical4j.model.property.DtStart
+import net.fortuna.ical4j.model.property.ProdId
 import net.fortuna.ical4j.model.property.RRule
 import net.fortuna.ical4j.model.property.RecurrenceId
 import net.fortuna.ical4j.model.property.Uid
@@ -29,7 +30,7 @@ class ICalendarGeneratorTest {
     private val tzLondon = tzRegistry.getTimeZone("Europe/London")!!
     private val tzUTC = tzRegistry.getTimeZone(TimeZones.UTC_ID)!!
 
-    private val userAgent = "TestUA/1.0"
+    private val userAgent = ProdId("TestUA/1.0")
     private val writer = ICalendarGenerator()
 
     @Test

lib/src/test/kotlin/at/bitfire/synctools/mapping/calendar/AndroidEventHandlerTest.kt

@@ -17,6 +17,7 @@ import net.fortuna.ical4j.model.Property
 import net.fortuna.ical4j.model.TimeZoneRegistryFactory
 import net.fortuna.ical4j.model.property.DtStart
 import net.fortuna.ical4j.model.property.ExDate
+import net.fortuna.ical4j.model.property.ProdId
 import net.fortuna.ical4j.model.property.RRule
 import net.fortuna.ical4j.model.property.RecurrenceId
 import org.junit.Assert.assertEquals
@@ -192,7 +193,7 @@ class AndroidEventHandlerTest {
                 exceptions = emptyList()
             )
         ).associatedEvents
-        assertEquals(javaClass.simpleName, result.prodId)
+        assertEquals(ProdId(javaClass.simpleName), result.prodId)
     }
 
     @Test
@@ -206,7 +207,7 @@ class AndroidEventHandlerTest {
                 exceptions = emptyList()
             )
         ).associatedEvents
-        assertEquals("${javaClass.simpleName} (pkg1, pkg2)", result.prodId)
+        assertEquals(ProdId(javaClass.simpleName), result.prodId)
     }