refactor AndroidEvent; introduce AndroidEvent2 with Entity as data object

README.md

@@ -19,6 +19,17 @@ We're happy about contributions! In case of bigger changes, please let us know i
 Then make the changes in your own repository and send a pull request.
 
 
+# Packages
+
+- `at.bitfire.synctools`: new package where everything shall be refactored into
+  - `.icalendar`: high-level operations on iCalendar objects
+  - `.mapping`: mappers between low-level (database rows) and high-level (iCalendar/vCard) objects
+  - `.storage`: low-level operations on content-provider storage (`ContentValues` / `Entity` to store data)
+- `at.bitfire.ical4android`: legacy [ical4android](https://github.com/bitfireAT/ical4android)
+- `at.bitfire.vcard4android`: legacy [vcard4android](https://github.com/bitfireAT/vcard4android)
+
+
+
 # How to use
 
 Add the [jitpack.io](https://jitpack.io) repository to your project's level `build.gradle`:

lib/src/androidTest/kotlin/at/bitfire/ical4android/AndroidEventTest.kt

@@ -17,6 +17,7 @@ import at.bitfire.ical4android.impl.TestCalendar
 import at.bitfire.ical4android.util.MiscUtils.closeCompat
 import at.bitfire.synctools.icalendar.Css3Color
 import at.bitfire.synctools.storage.calendar.AndroidCalendar
+import at.bitfire.synctools.storage.calendar.AndroidEvent2
 import at.bitfire.synctools.test.InitCalendarProviderRule
 import net.fortuna.ical4j.model.DateTime
 import net.fortuna.ical4j.model.component.VAlarm
@@ -44,15 +45,17 @@ class AndroidEventTest {
 
     private val testAccount = Account(javaClass.name, ACCOUNT_TYPE_LOCAL)
 
-    private lateinit var calendar: AndroidCalendar
     lateinit var client: ContentProviderClient
+    private lateinit var calendar: AndroidCalendar
+    private lateinit var legacyCalendar: LegacyAndroidCalendar
 
     @Before
     fun prepare() {
         val context = getInstrumentation().targetContext
         client = context.contentResolver.acquireContentProviderClient(AUTHORITY)!!
 
         calendar = TestCalendar.findOrCreate(testAccount, client, withColors = true)
+        legacyCalendar = LegacyAndroidCalendar(calendar)
     }
 
     @After
@@ -68,9 +71,9 @@ class AndroidEventTest {
             calendar, contentValuesOf(
                 Events._ID to 123,
                 Events._SYNC_ID to "some-ical.ics",
-                AndroidEvent.COLUMN_ETAG to "some-etag",
-                AndroidEvent.COLUMN_SCHEDULE_TAG to "some-schedule-tag",
-                AndroidEvent.COLUMN_FLAGS to 45
+                AndroidEvent2.COLUMN_ETAG to "some-etag",
+                AndroidEvent2.COLUMN_SCHEDULE_TAG to "some-schedule-tag",
+                AndroidEvent2.COLUMN_FLAGS to 45
             )
         )
         assertEquals(123L, e.id)
@@ -90,11 +93,11 @@ class AndroidEventTest {
         event.dtStart = DtStart("20150502T120000Z")
         event.dtEnd = DtEnd("20150502T130000Z")
         event.organizer = Organizer(URI("mailto:organizer@example.com"))
-        val uri = AndroidEvent(calendar, event, "update-event").add()
+        val uri = legacyCalendar.add(event)
 
         // update test event in calendar
-        val testEvent = calendar.getEvent(ContentUris.parseId(uri))!!
-        val event2 = testEvent.event!!
+        val testEvent = legacyCalendar.getAndroidEvent(calendar, ContentUris.parseId(uri))!!
+        val event2 = legacyCalendar.getEvent(testEvent.id)!!
         event2.summary = "Updated event"
         // add data rows
         event2.alarms += VAlarm(Duration.parse("-P1DT2H3M4S"))
@@ -105,9 +108,9 @@ class AndroidEventTest {
         assertEquals(ContentUris.parseId(uri), ContentUris.parseId(uri2))
 
         // read again and verify result
-        val updatedEvent = calendar.getEvent(ContentUris.parseId(uri2))!!
+        val updatedEvent = legacyCalendar.getAndroidEvent(calendar, ContentUris.parseId(uri2))!!
         try {
-            val event3 = updatedEvent.event!!
+            val event3 = legacyCalendar.getEvent(updatedEvent.id)!!
             assertEquals(event2.summary, event3.summary)
             assertEquals(1, event3.alarms.size)
             assertEquals(1, event3.attendees.size)
@@ -124,20 +127,20 @@ class AndroidEventTest {
             dtStart = DtStart(DateTime())
             color = Css3Color.silver
         }
-        val uri = AndroidEvent(calendar, event, "reset-color").add()
+        val uri = legacyCalendar.add(event)
         val id = ContentUris.parseId(uri)
 
         // verify that it has color
-        val beforeUpdate = calendar.getEvent(id)!!
-        assertNotNull(beforeUpdate.event?.color)
+        val beforeUpdate = legacyCalendar.getAndroidEvent(calendar, id)!!
+        assertNotNull(legacyCalendar.getEvent(beforeUpdate.id)!!.color)
 
         // update: reset color
         event.color = null
         beforeUpdate.update(event)
 
         // verify that it doesn't have color anymore
-        val afterUpdate = calendar.getEvent(id)!!
-        assertNull(afterUpdate.event!!.color)
+        val afterUpdate = legacyCalendar.getAndroidEvent(calendar, id)!!
+        assertNull(legacyCalendar.getEvent(afterUpdate.id)!!.color)
     }
 
     @Test
@@ -147,11 +150,11 @@ class AndroidEventTest {
         event.summary = "Sample event with STATUS"
         event.dtStart = DtStart("20150502T120000Z")
         event.dtEnd = DtEnd("20150502T130000Z")
-        val uri = AndroidEvent(calendar, event, "update-status-from-null").add()
+        val uri = legacyCalendar.add(event)
 
         // update test event in calendar
-        val testEvent = calendar.getEvent(ContentUris.parseId(uri))!!
-        val event2 = testEvent.event!!
+        val testEvent = legacyCalendar.getAndroidEvent(calendar, ContentUris.parseId(uri))!!
+        val event2 = legacyCalendar.getEvent(testEvent.id)!!
         event2.summary = "Sample event without STATUS"
         event2.status = Status.VEVENT_CONFIRMED
         val uri2 = testEvent.update(event2)
@@ -160,9 +163,9 @@ class AndroidEventTest {
         assertEquals(ContentUris.parseId(uri), ContentUris.parseId(uri2))
 
         // read again and verify result
-        val updatedEvent = calendar.getEvent(ContentUris.parseId(uri2))!!
+        val updatedEvent = legacyCalendar.getAndroidEvent(calendar, ContentUris.parseId(uri2))!!
         try {
-            val event3 = updatedEvent.event!!
+            val event3 = legacyCalendar.getEvent(updatedEvent.id)!!
             assertEquals(Status.VEVENT_CONFIRMED, event3.status)
         } finally {
             updatedEvent.delete()
@@ -177,11 +180,11 @@ class AndroidEventTest {
         event.dtStart = DtStart("20150502T120000Z")
         event.dtEnd = DtEnd("20150502T130000Z")
         event.status = Status.VEVENT_CONFIRMED
-        val uri = AndroidEvent(calendar, event, "update-status-to-null").add()
+        val uri = legacyCalendar.add(event)
 
         // update test event in calendar
-        val testEvent = calendar.getEvent(ContentUris.parseId(uri))!!
-        val event2 = testEvent.event!!
+        val testEvent = legacyCalendar.getAndroidEvent(calendar, ContentUris.parseId(uri))!!
+        val event2 = legacyCalendar.getEvent(testEvent.id)!!
         event2.summary = "Sample event without STATUS"
         event2.status = null
         val uri2 = testEvent.update(event2)
@@ -190,9 +193,9 @@ class AndroidEventTest {
         assertNotEquals(ContentUris.parseId(uri), ContentUris.parseId(uri2))
 
         // read again and verify result
-        val updatedEvent = calendar.getEvent(ContentUris.parseId(uri2))!!
+        val updatedEvent = legacyCalendar.getAndroidEvent(calendar, ContentUris.parseId(uri2))!!
         try {
-            val event3 = updatedEvent.event!!
+            val event3 = legacyCalendar.getEvent(updatedEvent.id)!!
             assertNull(event3.status)
         } finally {
             updatedEvent.delete()
@@ -209,11 +212,11 @@ class AndroidEventTest {
         event.dtEnd = DtEnd("20150502T130000Z")
         for (i in 0 until 20)
             event.attendees += Attendee(URI("mailto:att$i@example.com"))
-        val uri = AndroidEvent(calendar, event, "transaction").add()
+        val uri = legacyCalendar.add(event)
 
-        val testEvent = calendar.getEvent(ContentUris.parseId(uri))!!
+        val testEvent = legacyCalendar.getAndroidEvent(calendar, ContentUris.parseId(uri))!!
         try {
-            assertEquals(20, testEvent.event!!.attendees.size)
+            assertEquals(20, legacyCalendar.getEvent(testEvent.id)!!.attendees.size)
         } finally {
             testEvent.delete()
         }

lib/src/androidTest/kotlin/at/bitfire/ical4android/impl/TestCalendar.kt

@@ -9,7 +9,6 @@ package at.bitfire.ical4android.impl
 import android.accounts.Account
 import android.content.ContentProviderClient
 import android.provider.CalendarContract.Calendars
-import android.provider.CalendarContract.Reminders
 import androidx.core.content.contentValuesOf
 import at.bitfire.synctools.storage.calendar.AndroidCalendar
 import at.bitfire.synctools.storage.calendar.AndroidCalendarProvider
@@ -30,7 +29,7 @@ object TestCalendar {
             ?: provider.createAndGetCalendar(contentValuesOf(
                 Calendars.NAME to UUID.randomUUID().toString(),
                 Calendars.CALENDAR_DISPLAY_NAME to "ical4android Test Calendar",
-                Calendars.ALLOWED_REMINDERS to Reminders.METHOD_DEFAULT)
+                Calendars.CALENDAR_ACCESS_LEVEL to Calendars.CAL_ACCESS_ROOT)
             )
     }
 

lib/src/androidTest/kotlin/at/bitfire/synctools/mapping/calendar/AndroidEventBuilderTest.kt → lib/src/androidTest/kotlin/at/bitfire/synctools/mapping/calendar/LegacyAndroidEventBuilderTest.kt

@@ -16,8 +16,8 @@ import android.provider.CalendarContract.Events
 import android.provider.CalendarContract.ExtendedProperties
 import android.provider.CalendarContract.Reminders
 import androidx.test.platform.app.InstrumentationRegistry.getInstrumentation
-import at.bitfire.ical4android.AndroidEvent
 import at.bitfire.ical4android.Event
+import at.bitfire.ical4android.LegacyAndroidCalendar
 import at.bitfire.ical4android.UnknownProperty
 import at.bitfire.ical4android.impl.TestCalendar
 import at.bitfire.ical4android.util.AndroidTimeUtils
@@ -69,7 +69,7 @@ import java.net.URI
 import java.time.Period
 import java.util.UUID
 
-class AndroidEventBuilderTest {
+class LegacyAndroidEventBuilderTest {
 
     @get:Rule
     val initCalendarProviderRule = InitCalendarProviderRule.initialize()
@@ -134,7 +134,7 @@ class AndroidEventBuilderTest {
             eventBuilder()
         }
         // write event with random file name/sync_id
-        val uri = AndroidEvent(calendar, event, syncId = UUID.randomUUID().toString()).add()
+        val uri = LegacyAndroidCalendar(calendar).add(event, syncId = UUID.randomUUID().toString())
         client.query(uri, null, null, null, null)!!.use { cursor ->
             cursor.moveToNext()
             return cursor.toContentValues()

lib/src/androidTest/kotlin/at/bitfire/synctools/mapping/calendar/AndroidEventProcessorTest.kt → lib/src/androidTest/kotlin/at/bitfire/synctools/mapping/calendar/LegacyAndroidEventProcessorTest.kt

@@ -10,18 +10,17 @@ import android.accounts.Account
 import android.content.ContentProviderClient
 import android.content.ContentUris
 import android.content.ContentValues
-import android.net.Uri
 import android.provider.CalendarContract.ACCOUNT_TYPE_LOCAL
 import android.provider.CalendarContract.AUTHORITY
 import android.provider.CalendarContract.Attendees
-import android.provider.CalendarContract.Calendars
 import android.provider.CalendarContract.Events
 import android.provider.CalendarContract.ExtendedProperties
 import android.provider.CalendarContract.Reminders
 import androidx.core.content.contentValuesOf
 import androidx.test.platform.app.InstrumentationRegistry.getInstrumentation
 import at.bitfire.ical4android.AndroidEvent
 import at.bitfire.ical4android.Event
+import at.bitfire.ical4android.LegacyAndroidCalendar
 import at.bitfire.ical4android.UnknownProperty
 import at.bitfire.ical4android.impl.TestCalendar
 import at.bitfire.ical4android.util.AndroidTimeUtils
@@ -30,6 +29,7 @@ import at.bitfire.ical4android.util.MiscUtils.closeCompat
 import at.bitfire.synctools.icalendar.Css3Color
 import at.bitfire.synctools.storage.calendar.AndroidCalendar
 import at.bitfire.synctools.storage.calendar.AndroidCalendarProvider
+import at.bitfire.synctools.storage.calendar.AndroidEvent2
 import at.bitfire.synctools.test.InitCalendarProviderRule
 import net.fortuna.ical4j.model.Date
 import net.fortuna.ical4j.model.DateTime
@@ -65,7 +65,7 @@ import org.junit.rules.TestRule
 import java.net.URI
 import java.time.Duration
 
-class AndroidEventProcessorTest {
+class LegacyAndroidEventProcessorTest {
 
     @get:Rule
     val initCalendarProviderRule: TestRule = InitCalendarProviderRule.initialize()
@@ -75,8 +75,8 @@ class AndroidEventProcessorTest {
     private val tzVienna = tzRegistry.getTimeZone("Europe/Vienna")!!
     private val tzShanghai = tzRegistry.getTimeZone("Asia/Shanghai")!!
 
-    private lateinit var calendarUri: Uri
     private lateinit var calendar: AndroidCalendar
+    lateinit var legacyCalendar: LegacyAndroidCalendar
     lateinit var client: ContentProviderClient
 
     @Before
@@ -85,8 +85,7 @@ class AndroidEventProcessorTest {
         client = context.contentResolver.acquireContentProviderClient(AUTHORITY)!!
 
         calendar = TestCalendar.findOrCreate(testAccount, client)
-        assertNotNull(calendar)
-        calendarUri = ContentUris.withAppendedId(Calendars.CONTENT_URI, calendar.id)
+        legacyCalendar = LegacyAndroidCalendar(calendar)
     }
 
     @After
@@ -134,7 +133,7 @@ class AndroidEventProcessorTest {
             client.insert(ExtendedProperties.CONTENT_URI.asSyncAdapter(testAccount), extendedValues)
         }
 
-        return destinationCalendar.getEvent(id)!!
+        return legacyCalendar.getAndroidEvent(destinationCalendar, id)!!
     }
 
     private fun populateEvent(
@@ -145,22 +144,23 @@ class AndroidEventProcessorTest {
         extendedProperties: Map<String, String> = emptyMap(),
         valuesBuilder: ContentValues.() -> Unit = {}
     ): Event {
-        return populateAndroidEvent(
+        val androidEvent = populateAndroidEvent(
             automaticDates,
             destinationCalendar,
             asSyncAdapter,
             insertCallback,
             extendedProperties,
             valuesBuilder
-        ).event!!
+        )
+        return LegacyAndroidCalendar(destinationCalendar).getEvent(androidEvent.id)!!
     }
 
     @Test
     fun testPopulateEvent_Uid_iCalUid() {
         populateEvent(
             true,
             extendedProperties = mapOf(
-                AndroidEvent.EXTNAME_ICAL_UID to "event1@example.com"
+                AndroidEvent2.EXTNAME_ICAL_UID to "event1@example.com"
             )
         ).let { result ->
             assertEquals("event1@example.com", result.uid)
@@ -181,7 +181,7 @@ class AndroidEventProcessorTest {
         populateEvent(
             true,
             extendedProperties = mapOf(
-                AndroidEvent.EXTNAME_ICAL_UID to "event1@example.com"
+                AndroidEvent2.EXTNAME_ICAL_UID to "event1@example.com"
             )
         ) {
             put(Events.UID_2445, "event2@example.com")
@@ -194,7 +194,7 @@ class AndroidEventProcessorTest {
     @Test
     fun testPopulateEvent_Sequence_Int() {
         populateEvent(true, asSyncAdapter = true) {
-            put(AndroidEvent.COLUMN_SEQUENCE, 5)
+            put(AndroidEvent2.COLUMN_SEQUENCE, 5)
         }.let { result ->
             assertEquals(5, result.sequence)
         }
@@ -203,7 +203,7 @@ class AndroidEventProcessorTest {
     @Test
     fun testPopulateEvent_Sequence_Null() {
         populateEvent(true, asSyncAdapter = true) {
-            putNull(AndroidEvent.COLUMN_SEQUENCE)
+            putNull(AndroidEvent2.COLUMN_SEQUENCE)
         }.let { result ->
             assertNull(result.sequence)
         }
@@ -408,7 +408,7 @@ class AndroidEventProcessorTest {
     @Test
     fun testPopulateEvent_Url() {
         populateEvent(true,
-            extendedProperties = mapOf(AndroidEvent.EXTNAME_URL to "https://example.com")
+            extendedProperties = mapOf(AndroidEvent2.EXTNAME_URL to "https://example.com")
         ).let { result ->
             assertEquals(URI("https://example.com"), result.url)
         }