Remove fromReader/writeVCard from Contact data class (#425)

* Remove Contact.writeVCard

* Remove deprecated Contact.fromReader

* Minor test changes

Author: rfc2822

lib/src/androidTest/kotlin/at/bitfire/synctools/storage/contacts/AndroidContactTest.kt

@@ -15,14 +15,18 @@ import androidx.test.filters.MediumTest
 import androidx.test.platform.app.InstrumentationRegistry
 import androidx.test.rule.GrantPermissionRule
 import at.bitfire.synctools.mapping.contacts.Contact
+import at.bitfire.synctools.mapping.contacts.ContactReader
+import at.bitfire.synctools.mapping.contacts.ContactWriter
 import at.bitfire.synctools.mapping.contacts.LabeledProperty
 import at.bitfire.synctools.storage.LocalStorageException
+import at.bitfire.synctools.vcard.VCardParser
 import at.bitfire.synctools.vcard.property.XAbDate
 import ezvcard.VCardVersion
 import ezvcard.property.Address
 import ezvcard.property.Birthday
 import ezvcard.property.Email
 import ezvcard.util.PartialDate
+import kotlinx.coroutines.runBlocking
 import kotlinx.coroutines.test.runTest
 import org.junit.Assert.assertArrayEquals
 import org.junit.Assert.assertEquals
@@ -115,7 +119,7 @@ class AndroidContactTest {
                 "TEL;CELL=;PREF=:+12345\r\n" +
                 "EMAIL;PREF=invalid:test@example.com\r\n" +
                 "END:VCARD\r\n"
-        val contacts = Contact.fromReader(StringReader(vCard), null)
+        val contacts = parseVCards(vCard)
 
         val dbContact = AndroidContact(addressBook, contacts.first(), null, null)
         dbContact.add()
@@ -139,7 +143,7 @@ class AndroidContactTest {
             "FN:John Doe\n\n" +
             "BDAY:20010415T000000+0200\n\n" +
             "END:VCARD\n\n"
-        val contacts = Contact.fromReader(StringReader(vCard), null)
+        val contacts = parseVCards(vCard)
 
         assertEquals(1, contacts.size)
         contacts.first().birthDay.let { birthday ->
@@ -210,8 +214,16 @@ class AndroidContactTest {
          * So, ADR value components may contain DQUOTE (0x22) and don't have to be encoded as defined in RFC 6868 */
 
         val writer = StringWriter()
-        contact.writeVCard(VCardVersion.V4_0, writer, testProductId)
+        ContactWriter(contact, VCardVersion.V4_0, testProductId).writeVCard(writer)
         assertTrue(writer.toString().contains("ADR;LABEL=My ^'Label^'\\nLine 2:;;Street \"Address\";;;;"))
     }
 
+
+    private fun parseVCards(vCardStr: String): List<Contact> =
+        VCardParser().parse(StringReader(vCardStr)).map { vCard ->
+            runBlocking {
+                ContactReader(vCard).toContact()
+            }
+        }
+
 }

lib/src/main/kotlin/at/bitfire/synctools/mapping/contacts/Contact.kt

@@ -6,11 +6,9 @@
 
 package at.bitfire.synctools.mapping.contacts
 
-import at.bitfire.synctools.vcard.VCardParser
 import at.bitfire.synctools.vcard.property.XAbDate
 import com.google.common.base.Ascii
 import com.google.common.base.MoreObjects
-import ezvcard.VCardVersion
 import ezvcard.property.Address
 import ezvcard.property.Anniversary
 import ezvcard.property.Birthday
@@ -21,9 +19,6 @@ import ezvcard.property.Organization
 import ezvcard.property.Related
 import ezvcard.property.Telephone
 import ezvcard.property.Url
-import java.io.IOException
-import java.io.Reader
-import java.io.Writer
 import java.util.LinkedList
 
 /**
@@ -89,30 +84,6 @@ data class Contact(
 
         const val TO_STRING_MAX_VALUE_SIZE = 2000
 
-        /**
-         * Parses a Reader that contains a vCard.
-         *
-         * @param reader     reader for the input stream containing the vCard (pay attention to the charset)
-         * @param downloader will be used to download external resources like contact photos (may be null)
-         *
-         * @return list of filled Contact data objects (may have size 0) – doesn't return null
-         *
-         * @throws IOException on I/O errors when reading the stream
-         * @throws ezvcard.io.CannotParseException when the vCard can't be parsed
-         */
-        suspend fun fromReader(reader: Reader, downloader: Downloader?): List<Contact> =
-            VCardParser().parse(reader).map { vCard ->
-                // convert every vCard to a Contact data object
-                ContactReader.fromVCard(vCard, downloader)
-            }
-
-    }
-
-
-    @Throws(IOException::class)
-    fun writeVCard(vCardVersion: VCardVersion, writer: Writer, productId: String) {
-        val generator = ContactWriter(this, vCardVersion, productId)
-        generator.writeVCard(writer)
     }
 
 

lib/src/main/kotlin/at/bitfire/synctools/mapping/contacts/ContactReader.kt

@@ -154,7 +154,7 @@ class ContactReader internal constructor(val vCard: VCard, val downloader: Conta
     /**
      * Converts the vCard to a [Contact].
      */
-    private suspend fun toContact(): Contact {
+    suspend fun toContact(): Contact {
         val c = Contact()
 
         // process standard properties; after processing, only unknown properties will remain

lib/src/test/kotlin/at/bitfire/synctools/mapping/contacts/ContactTest.kt

@@ -6,6 +6,7 @@
 
 package at.bitfire.synctools.mapping.contacts
 
+import at.bitfire.synctools.vcard.VCardParser
 import ezvcard.VCardVersion
 import ezvcard.parameter.AddressType
 import ezvcard.parameter.EmailType
@@ -24,27 +25,32 @@ import org.junit.Assert.assertNull
 import org.junit.Assert.assertTrue
 import org.junit.Test
 import java.io.InputStreamReader
+import java.io.Reader
 import java.io.StringReader
 import java.io.StringWriter
-import java.nio.charset.Charset
 import java.time.LocalDate
 import java.time.OffsetDateTime
 import java.time.ZoneOffset
 import java.util.LinkedList
 
 class ContactTest {
 
-    private suspend fun parseContact(fname: String, charset: Charset = Charsets.UTF_8): Contact =
+    private suspend fun parseVCard(reader: Reader): Contact {
+        val vCard = VCardParser().parse(reader).first()
+        return ContactReader.fromVCard(vCard)
+    }
+
+    private suspend fun parseContact(fname: String): Contact =
         javaClass.classLoader!!.getResourceAsStream(fname).use { stream ->
-            Contact.fromReader(InputStreamReader(stream, charset), null).first()
+            parseVCard(InputStreamReader(stream, Charsets.UTF_8))
         }
 
     private suspend fun regenerate(c: Contact, vCardVersion: VCardVersion): Contact {
         val writer = StringWriter()
-        c.writeVCard(vCardVersion, writer, testProductId)
+        ContactWriter(c, vCardVersion, testProductId).writeVCard(writer)
         val vCard = writer.toString()
 
-        return Contact.fromReader(StringReader(vCard), null).first()
+        return parseVCard(StringReader(vCard))
     }