Add += operator as shortcut

rfc2822 · rfc2822 · commit 328c3e864d73 · 2025-06-17T19:38:48.000+02:00
diff --git a/lib/src/androidTest/kotlin/at/bitfire/synctools/storage/BatchOperationTest.kt b/lib/src/androidTest/kotlin/at/bitfire/synctools/storage/BatchOperationTest.kt
@@ -23,11 +23,11 @@ class BatchOperationTest {
         val maxSize = 100
         every { provider.applyBatch(match { it.size > maxSize }) } throws TransactionTooLargeException()
 
-        val op = BatchOperation(provider, null)
+        val batch = BatchOperation(provider, null)
         repeat(4*maxSize) {
-            op.enqueue(BatchOperation.CpoBuilder.newInsert("test://".toUri()))
+            batch += BatchOperation.CpoBuilder.newInsert("test://".toUri())
         }
-        op.commit()
+        batch.commit()
 
         // one too large batch (with 400 operations) +
         // then two still too large batches with 200 operations each +
@@ -41,9 +41,9 @@ class BatchOperationTest {
 
         every { provider.applyBatch(any()) } throws TransactionTooLargeException()
 
-        val op = BatchOperation(provider, null)
-        op.enqueue(BatchOperation.CpoBuilder.newInsert("test://".toUri()))
-        op.commit()
+        val batch = BatchOperation(provider, null)
+        batch += BatchOperation.CpoBuilder.newInsert("test://".toUri())
+        batch.commit()
     }
 
 }
diff --git a/lib/src/androidTest/kotlin/at/bitfire/synctools/storage/CalendarBatchOperationTest.kt b/lib/src/androidTest/kotlin/at/bitfire/synctools/storage/CalendarBatchOperationTest.kt
@@ -52,15 +52,14 @@ class CalendarBatchOperationTest {
 
     @Test
     fun testCalendarProvider_OperationsPerYieldPoint_501() {
-        val builder = CalendarBatchOperation(provider)
+        val batch = CalendarBatchOperation(provider)
 
         // 501 operations should succeed with CalendarBatchOperation
         repeat(501) { idx ->
-            builder.enqueue(
-                BatchOperation.CpoBuilder.newInsert(Events.CONTENT_URI.asSyncAdapter(testAccount))
-                    .withValue(Events.TITLE, "Event $idx"))
+            batch += BatchOperation.CpoBuilder.newInsert(Events.CONTENT_URI.asSyncAdapter(testAccount))
+                .withValue(Events.TITLE, "Event $idx")
         }
-        builder.commit()
+        batch.commit()
     }
 
 }
diff --git a/lib/src/androidTest/kotlin/at/bitfire/synctools/storage/ContactsBatchOperationTest.kt b/lib/src/androidTest/kotlin/at/bitfire/synctools/storage/ContactsBatchOperationTest.kt
@@ -50,32 +50,28 @@ class ContactsBatchOperationTest {
 
     @Test(expected = LocalStorageException::class)
     fun testContactsProvider_OperationsPerYieldPoint_500_WithoutMax() {
-        val builder = BatchOperation(provider, maxOperationsPerYieldPoint = null)
+        val batch = BatchOperation(provider, maxOperationsPerYieldPoint = null)
 
         // 500 operations should fail with BatchOperation(maxOperationsPerYieldPoint = null) (max. 499)
         repeat(500) { idx ->
-            builder.enqueue(
-                BatchOperation.CpoBuilder.newInsert(ContactsContract.RawContacts.CONTENT_URI)
-                    .withValue(ContactsContract.RawContacts.ACCOUNT_TYPE, testAccount.type)
-                    .withValue(ContactsContract.RawContacts.ACCOUNT_NAME, testAccount.name)
-            )
+            batch += BatchOperation.CpoBuilder.newInsert(ContactsContract.RawContacts.CONTENT_URI)
+                .withValue(ContactsContract.RawContacts.ACCOUNT_TYPE, testAccount.type)
+                .withValue(ContactsContract.RawContacts.ACCOUNT_NAME, testAccount.name)
         }
-        builder.commit()
+        batch.commit()
     }
 
     @Test
     fun testContactsProvider_OperationsPerYieldPoint_501() {
-        val builder = ContactsBatchOperation(provider)
+        val batch = ContactsBatchOperation(provider)
 
         // 501 operations should succeed with ContactsBatchOperation
         repeat(501) { idx ->
-            builder.enqueue(
-                BatchOperation.CpoBuilder.newInsert(ContactsContract.RawContacts.CONTENT_URI)
-                    .withValue(ContactsContract.RawContacts.ACCOUNT_TYPE, testAccount.type)
-                    .withValue(ContactsContract.RawContacts.ACCOUNT_NAME, testAccount.name)
-            )
+            batch += BatchOperation.CpoBuilder.newInsert(ContactsContract.RawContacts.CONTENT_URI)
+                .withValue(ContactsContract.RawContacts.ACCOUNT_TYPE, testAccount.type)
+                .withValue(ContactsContract.RawContacts.ACCOUNT_NAME, testAccount.name)
         }
-        builder.commit()
+        batch.commit()
     }
 
 }
diff --git a/lib/src/androidTest/kotlin/at/bitfire/synctools/storage/JtxBatchOperationTest.kt b/lib/src/androidTest/kotlin/at/bitfire/synctools/storage/JtxBatchOperationTest.kt
@@ -47,7 +47,7 @@ class JtxBatchOperationTest {
 
     @Test
     fun testJtxBoard_OperationsPerYieldPoint_501() {
-        val builder = JtxBatchOperation(provider)
+        val batch = JtxBatchOperation(provider)
         val uri = JtxCollection.create(testAccount, provider, ContentValues().apply {
             put(JtxContract.JtxCollection.ACCOUNT_NAME, testAccount.name)
             put(JtxContract.JtxCollection.ACCOUNT_TYPE, testAccount.type)
@@ -58,13 +58,11 @@ class JtxBatchOperationTest {
         try {
             // 501 operations should succeed with JtxBatchOperation
             repeat(501) { idx ->
-                builder.enqueue(
-                    BatchOperation.CpoBuilder.newInsert(JtxContract.JtxICalObject.CONTENT_URI.asSyncAdapter(testAccount))
-                        .withValue(JtxContract.JtxICalObject.ICALOBJECT_COLLECTIONID, collectionId)
-                        .withValue(JtxContract.JtxICalObject.SUMMARY, "Entry $idx")
-                )
+                batch += BatchOperation.CpoBuilder.newInsert(JtxContract.JtxICalObject.CONTENT_URI.asSyncAdapter(testAccount))
+                    .withValue(JtxContract.JtxICalObject.ICALOBJECT_COLLECTIONID, collectionId)
+                    .withValue(JtxContract.JtxICalObject.SUMMARY, "Entry $idx")
             }
-            builder.commit()
+            batch.commit()
         } finally {
             val collection = JtxCollection<JtxICalObject>(testAccount, provider, mockk(), collectionId)
             collection.delete()
diff --git a/lib/src/androidTest/kotlin/at/bitfire/synctools/storage/TasksBatchOperationTest.kt b/lib/src/androidTest/kotlin/at/bitfire/synctools/storage/TasksBatchOperationTest.kt
@@ -21,37 +21,33 @@ class TasksBatchOperationTest(
 
     @Test(expected = LocalStorageException::class)
     fun testTasksProvider_OperationsPerYieldPoint_500_WithoutMax() {
-        val builder = BatchOperation(provider.client, maxOperationsPerYieldPoint = null)
+        val batch = BatchOperation(provider.client, maxOperationsPerYieldPoint = null)
         val taskList = TestTaskList.Companion.create(testAccount, provider)
         try {
             // 500 operations should fail with BatchOperation(maxOperationsPerYieldPoint = null) (max. 499)
             repeat(500) { idx ->
-                builder.enqueue(
-                    BatchOperation.CpoBuilder.newInsert(provider.tasksUri())
-                        .withValue(TaskContract.Tasks.LIST_ID, taskList.id)
-                        .withValue(TaskContract.Tasks.TITLE, "Task $idx")
-                )
+                batch += BatchOperation.CpoBuilder.newInsert(provider.tasksUri())
+                    .withValue(TaskContract.Tasks.LIST_ID, taskList.id)
+                    .withValue(TaskContract.Tasks.TITLE, "Task $idx")
             }
-            builder.commit()
+            batch.commit()
         } finally {
             taskList.delete()
         }
     }
 
     @Test
     fun testTasksProvider_OperationsPerYieldPoint_501() {
-        val builder = TasksBatchOperation(provider.client)
+        val batch = TasksBatchOperation(provider.client)
         val taskList = TestTaskList.Companion.create(testAccount, provider)
         try {
             // 501 operations should succeed with ContactsBatchOperation
             repeat(501) { idx ->
-                builder.enqueue(
-                    BatchOperation.CpoBuilder.newInsert(provider.tasksUri())
-                        .withValue(TaskContract.Tasks.LIST_ID, taskList.id)
-                        .withValue(TaskContract.Tasks.TITLE, "Task $idx")
-                )
+                batch += BatchOperation.CpoBuilder.newInsert(provider.tasksUri())
+                    .withValue(TaskContract.Tasks.LIST_ID, taskList.id)
+                    .withValue(TaskContract.Tasks.TITLE, "Task $idx")
             }
-            builder.commit()
+            batch.commit()
         } finally {
             taskList.delete()
         }
diff --git a/lib/src/main/kotlin/at/bitfire/synctools/storage/BatchOperation.kt b/lib/src/main/kotlin/at/bitfire/synctools/storage/BatchOperation.kt
@@ -43,14 +43,30 @@ open class BatchOperation internal constructor(
 
     fun nextBackrefIdx() = queue.size
 
+    /**
+     * Enqueues an operation to the current batch.
+     *
+     * @param operation     operation to add
+     * @return this batch (for chaining)
+     */
     fun enqueue(operation: CpoBuilder): BatchOperation {
         queue.add(operation)
         return this
     }
 
-    fun enqueueAll(operations: Iterable<CpoBuilder>) {
+    /**
+     * Shortcut for [enqueue].
+     */
+    operator fun plusAssign(operation: CpoBuilder) {
+        enqueue(operation)
+    }
+
+    /**
+     * Shortcut for [enqueue] of multiple operations.
+     */
+    operator fun plusAssign(operations: Iterable<CpoBuilder>) {
         for (operation in operations)
-            enqueue(operation)
+            this += operation
     }
 
     /**
diff --git a/lib/src/main/kotlin/at/bitfire/vcard4android/contactrow/ContactProcessor.kt b/lib/src/main/kotlin/at/bitfire/vcard4android/contactrow/ContactProcessor.kt
@@ -10,9 +10,9 @@ import android.content.ContentProviderClient
 import android.content.ContentValues
 import android.net.Uri
 import android.provider.ContactsContract.RawContacts
+import at.bitfire.synctools.storage.BatchOperation
 import at.bitfire.vcard4android.AndroidContact
 import at.bitfire.vcard4android.Contact
-import at.bitfire.synctools.storage.BatchOperation
 import java.util.logging.Level
 import java.util.logging.Logger
 
@@ -97,7 +97,7 @@ class ContactProcessor(
     fun insertDataRows(dataRowUri: Uri, rawContactId: Long?, contact: Contact, batch: BatchOperation, readOnly: Boolean) {
         for (factory in dataRowBuilderFactories) {
             val builder = factory.newInstance(dataRowUri, rawContactId, contact, readOnly)
-            batch.enqueueAll(builder.build())
+            batch += builder.build()
         }
     }
 

Original file line number	Diff line number	Diff line change
`@@ -52,15 +52,14 @@ class CalendarBatchOperationTest {`
`52`	`52`
`53`	`53`	`@Test`
`54`	`54`	`fun testCalendarProvider_OperationsPerYieldPoint_501() {`
`55`		`- val builder = CalendarBatchOperation(provider)`
	`55`	`+ val batch = CalendarBatchOperation(provider)`
`56`	`56`
`57`	`57`	`// 501 operations should succeed with CalendarBatchOperation`
`58`	`58`	`repeat(501) { idx ->`
`59`		`- builder.enqueue(`
`60`		`- BatchOperation.CpoBuilder.newInsert(Events.CONTENT_URI.asSyncAdapter(testAccount))`
`61`		`- .withValue(Events.TITLE, "Event $idx"))`
	`59`	`+ batch += BatchOperation.CpoBuilder.newInsert(Events.CONTENT_URI.asSyncAdapter(testAccount))`
	`60`	`+ .withValue(Events.TITLE, "Event $idx")`
`62`	`61`	`}`
`63`		`- builder.commit()`
	`62`	`+ batch.commit()`
`64`	`63`	`}`
`65`	`64`
`66`	`65`	`}`