Skip to content

Remove possibility to subclass DmfsTask #155

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sunkup merged 2 commits into from
Dec 8, 2025
Merged

Remove possibility to subclass DmfsTask #155

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e0485d7
Remove possibility to subclass DmfsTask
sunkup Dec 2, 2025
91de363
Adapt tests
sunkup Dec 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions lib/src/androidTest/kotlin/at/bitfire/ical4android/DmfsTaskListTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ import android.content.ContentUris
import android.content.ContentValues
import android.database.DatabaseUtils
import android.provider.CalendarContract
import at.bitfire.ical4android.impl.TestTask
import at.bitfire.ical4android.impl.TestTaskList
import net.fortuna.ical4j.model.property.RelatedTo
import org.dmfs.tasks.contract.TaskContract
Expand Down Expand Up @@ -77,9 +76,9 @@ class DmfsTaskListTest(providerName: TaskProvider.ProviderName):
child.relatedTo.add(RelatedTo(parent.uid))

// insert child before parent
val childContentUri = TestTask(taskList, child).add()
val childContentUri = DmfsTask(taskList, child, "452a5672-e2b0-434e-92b4-bc70a7a51ef2", null, 0).add()
val childId = ContentUris.parseId(childContentUri)
val parentContentUri = TestTask(taskList, parent).add()
val parentContentUri = DmfsTask(taskList, parent, "452a5672-e2b0-434e-92b4-bc70a7a51ef2", null, 0).add()
val parentId = ContentUris.parseId(parentContentUri)

// OpenTasks should provide the correct relation
Expand Down
19 changes: 9 additions & 10 deletions lib/src/androidTest/kotlin/at/bitfire/ical4android/DmfsTaskTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ import android.database.DatabaseUtils
import android.net.Uri
import android.provider.CalendarContract
import androidx.core.content.contentValuesOf
import at.bitfire.ical4android.impl.TestTask
import at.bitfire.ical4android.impl.TestTaskList
import at.bitfire.synctools.storage.LocalStorageException
import net.fortuna.ical4j.model.Date
Expand Down Expand Up @@ -92,7 +91,7 @@ class DmfsTaskTest(
val task = Task().apply {
taskBuilder()
}
val uri = TestTask(taskList!!, task).add()
val uri = DmfsTask(taskList!!, task, "9468a4cf-0d5b-4379-a704-12f1f84100ba", null, 0).add()
provider.client.query(uri, null, null, null, null)!!.use {
it.moveToNext()
val values = ContentValues()
Expand Down Expand Up @@ -688,7 +687,7 @@ class DmfsTaskTest(
task.unknownProperties += XProperty("X-UNKNOWN-PROP", "Unknown Value")

// add to task list
val uri = TestTask(taskList!!, task).add()
val uri = DmfsTask(taskList!!, task, "9468a4cf-0d5b-4379-a704-12f1f84100ba", null, 0).add()
assertNotNull("Couldn't add task", uri)

// read and parse event from calendar provider
Expand Down Expand Up @@ -721,7 +720,7 @@ class DmfsTaskTest(
task.dtStart = DtStart(Date("20150102"))

task.due = Due(Date("20150101"))
TestTask(taskList!!, task).add()
DmfsTask(taskList!!, task, "9468a4cf-0d5b-4379-a704-12f1f84100ba", null, 0).add()
}

@Test
Expand All @@ -734,7 +733,7 @@ class DmfsTaskTest(
for (i in 1..1050)
task.alarms += VAlarm(java.time.Duration.ofMinutes(i.toLong()))

val uri = TestTask(taskList!!, task).add()
val uri = DmfsTask(taskList!!, task, "9468a4cf-0d5b-4379-a704-12f1f84100ba", null, 0).add()
val task2 = taskList!!.findById(ContentUris.parseId(uri))
assertEquals(1050, task2.task?.alarms?.size)
}
Expand All @@ -749,7 +748,7 @@ class DmfsTaskTest(
task.location = "Sample location"
task.dtStart = DtStart("20150501T120000", tzVienna)
assertFalse(task.isAllDay())
val uri = TestTask(taskList!!, task).add()
val uri = DmfsTask(taskList!!, task, "9468a4cf-0d5b-4379-a704-12f1f84100ba", null, 0).add()
assertNotNull(uri)

val testTask = taskList!!.findById(ContentUris.parseId(uri))
Expand Down Expand Up @@ -782,7 +781,7 @@ class DmfsTaskTest(
task.dtStart = DtStart(Date("20150501"))
task.due = Due(Date("20150502"))
assertTrue(task.isAllDay())
val uri = TestTask(taskList!!, task).add()
val uri = DmfsTask(taskList!!, task, "9468a4cf-0d5b-4379-a704-12f1f84100ba", null, 0).add()
assertNotNull(uri)

val testTask = taskList!!.findById(ContentUris.parseId(uri))
Expand All @@ -803,16 +802,16 @@ class DmfsTaskTest(
@Test
fun testGetTimeZone() {
// no date/time
var t = TestTask(taskList!!, Task())
var t = DmfsTask(taskList!!, Task(), "9468a4cf-0d5b-4379-a704-12f1f84100ba", null, 0)
assertEquals(tzDefault, t.getTimeZone())

// dtstart with date (no time)
t = TestTask(taskList!!, Task())
t = DmfsTask(taskList!!, Task(), "410c19d7-df79-4d65-8146-40b7bec5923b", null, 0)
t.task!!.dtStart = DtStart("20150101")
assertEquals(tzDefault, t.getTimeZone())

// dtstart with time
t = TestTask(taskList!!, Task())
t = DmfsTask(taskList!!, Task(), "9dc64544-1816-4f04-b952-e894164467f6", null, 0)
t.task!!.dtStart = (DtStart("20150101", tzVienna))
assertEquals(tzVienna, t.getTimeZone())
}
Expand Down
28 changes: 0 additions & 28 deletions lib/src/androidTest/kotlin/at/bitfire/ical4android/impl/TestTask.kt
View file
Open in desktop

This file was deleted.

22 changes: 13 additions & 9 deletions lib/src/androidTest/kotlin/at/bitfire/ical4android/impl/TestTaskList.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ import at.bitfire.ical4android.TaskProvider
import org.dmfs.tasks.contract.TaskContract

class TestTaskList(
account: Account,
provider: ContentProviderClient,
providerName: TaskProvider.ProviderName,
id: Long
): DmfsTaskList<TestTask>(account, provider, providerName, TestTask.Factory, id) {
account: Account,
provider: ContentProviderClient,
providerName: TaskProvider.ProviderName,
id: Long
) : DmfsTaskList(account, provider, providerName, id) {

companion object {

Expand All @@ -33,17 +33,21 @@ class TestTaskList(
values.put(TaskContract.TaskListColumns.LIST_COLOR, 0xffff0000)
values.put(TaskContract.TaskListColumns.SYNC_ENABLED, 1)
values.put(TaskContract.TaskListColumns.VISIBLE, 1)
val uri = DmfsTaskList.create(account, provider.client, provider.name, values)
val uri = create(account, provider.client, provider.name, values)

return TestTaskList(account, provider.client, provider.name, ContentUris.parseId(uri))
}

}


object Factory: DmfsTaskListFactory<TestTaskList> {
override fun newInstance(account: Account, provider: ContentProviderClient, providerName: TaskProvider.ProviderName, id: Long) =
TestTaskList(account, provider, providerName, id)
object Factory : DmfsTaskListFactory<TestTaskList> {
override fun newInstance(
account: Account,
provider: ContentProviderClient,
providerName: TaskProvider.ProviderName,
id: Long
) = TestTaskList(account, provider, providerName, id)
}

}
42 changes: 23 additions & 19 deletions lib/src/main/kotlin/at/bitfire/ical4android/DmfsTask.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,27 +64,27 @@ import java.util.logging.Logger
* The SEQUENCE field is stored in [Tasks.SYNC_VERSION], so don't use [Tasks.SYNC_VERSION]
* for anything else.
*/
open class DmfsTask(
val taskList: DmfsTaskList<*>
class DmfsTask(
val taskList: DmfsTaskList
) {

protected val logger = Logger.getLogger(javaClass.name)
protected val tzRegistry by lazy { TimeZoneRegistryFactory.getInstance().createRegistry() }
private val logger = Logger.getLogger(javaClass.name)
private val tzRegistry by lazy { TimeZoneRegistryFactory.getInstance().createRegistry() }

var id: Long? = null
var syncId: String? = null
var eTag: String? = null
var flags: Int = 0


constructor(taskList: DmfsTaskList<*>, values: ContentValues): this(taskList) {
constructor(taskList: DmfsTaskList, values: ContentValues): this(taskList) {
id = values.getAsLong(Tasks._ID)
syncId = values.getAsString(Tasks._SYNC_ID)
eTag = values.getAsString(COLUMN_ETAG)
flags = values.getAsInteger(COLUMN_FLAGS) ?: 0
}

constructor(taskList: DmfsTaskList<*>, task: Task, syncId: String?, eTag: String?, flags: Int): this(taskList) {
constructor(taskList: DmfsTaskList, task: Task, syncId: String?, eTag: String?, flags: Int): this(taskList) {
this.task = task
this.syncId = syncId
this.eTag = eTag
Expand Down Expand Up @@ -160,7 +160,7 @@ open class DmfsTask(
throw FileNotFoundException("Couldn't find task #$id")
}

protected fun populateTask(values: ContentValues) {
private fun populateTask(values: ContentValues) {
val task = requireNotNull(task)

task.uid = values.getAsString(Tasks._UID)
Expand Down Expand Up @@ -267,7 +267,7 @@ open class DmfsTask(
values.getAsString(Tasks.RRULE)?.let { task.rRule = RRule(it) }
}

protected fun populateProperty(row: ContentValues) {
private fun populateProperty(row: ContentValues) {
logger.log(Level.FINER, "Found property", row)

val task = requireNotNull(task)
Expand All @@ -287,7 +287,7 @@ open class DmfsTask(
}
}

protected fun populateAlarm(row: ContentValues) {
private fun populateAlarm(row: ContentValues) {
val task = requireNotNull(task)
val props = PropertyList<Property>()

Expand Down Expand Up @@ -315,7 +315,7 @@ open class DmfsTask(
task.alarms += VAlarm(props)
}

protected fun populateRelatedTo(row: ContentValues) {
private fun populateRelatedTo(row: ContentValues) {
val uid = row.getAsString(Relation.RELATED_UID)
if (uid == null) {
logger.warning("Task relation doesn't refer to same task list; can't be synchronized")
Expand Down Expand Up @@ -380,15 +380,19 @@ open class DmfsTask(
return ContentUris.withAppendedId(Tasks.getContentUri(taskList.providerName.authority), existingId)
}

protected fun insertProperties(batch: TasksBatchOperation, idxTask: Int?) {
fun update(values: ContentValues) {
taskList.provider.update(taskSyncURI(), values, null, null)
}

private fun insertProperties(batch: TasksBatchOperation, idxTask: Int?) {
insertAlarms(batch, idxTask)
insertCategories(batch, idxTask)
insertComment(batch, idxTask)
insertRelatedTo(batch, idxTask)
insertUnknownProperties(batch, idxTask)
}

protected fun insertAlarms(batch: TasksBatchOperation, idxTask: Int?) {
private fun insertAlarms(batch: TasksBatchOperation, idxTask: Int?) {
val task = requireNotNull(task)
for (alarm in task.alarms) {
val (alarmRef, minutes) = ICalendar.vAlarmToMin(
Expand Down Expand Up @@ -430,7 +434,7 @@ open class DmfsTask(
}
}

protected fun insertCategories(batch: TasksBatchOperation, idxTask: Int?) {
private fun insertCategories(batch: TasksBatchOperation, idxTask: Int?) {
for (category in requireNotNull(task).categories) {
val builder = CpoBuilder.newInsert(taskList.tasksPropertiesSyncUri())
.withTaskId(Category.TASK_ID, idxTask)
Expand All @@ -441,7 +445,7 @@ open class DmfsTask(
}
}

protected fun insertComment(batch: TasksBatchOperation, idxTask: Int?) {
private fun insertComment(batch: TasksBatchOperation, idxTask: Int?) {
val comment = requireNotNull(task).comment ?: return
val builder = CpoBuilder.newInsert(taskList.tasksPropertiesSyncUri())
.withTaskId(Comment.TASK_ID, idxTask)
Expand All @@ -451,7 +455,7 @@ open class DmfsTask(
batch += builder
}

protected fun insertRelatedTo(batch: TasksBatchOperation, idxTask: Int?) {
private fun insertRelatedTo(batch: TasksBatchOperation, idxTask: Int?) {
for (relatedTo in requireNotNull(task).relatedTo) {
val relType = when ((relatedTo.getParameter(Parameter.RELTYPE) as RelType?)) {
RelType.CHILD ->
Expand All @@ -471,7 +475,7 @@ open class DmfsTask(
}
}

protected fun insertUnknownProperties(batch: TasksBatchOperation, idxTask: Int?) {
private fun insertUnknownProperties(batch: TasksBatchOperation, idxTask: Int?) {
for (property in requireNotNull(task).unknownProperties) {
if (property.value.length > UnknownProperty.MAX_UNKNOWN_PROPERTY_SIZE) {
logger.warning("Ignoring unknown property with ${property.value.length} octets (too long)")
Expand All @@ -491,7 +495,7 @@ open class DmfsTask(
return taskList.provider.delete(taskSyncURI(), null, null)
}

protected fun buildTask(builder: CpoBuilder, update: Boolean) {
private fun buildTask(builder: CpoBuilder, update: Boolean) {
if (!update)
builder .withValue(Tasks.LIST_ID, taskList.id)

Expand Down Expand Up @@ -602,7 +606,7 @@ open class DmfsTask(
}


protected fun CpoBuilder.withTaskId(column: String, idxTask: Int?): CpoBuilder {
private fun CpoBuilder.withTaskId(column: String, idxTask: Int?): CpoBuilder {
if (idxTask != null)
withValueBackReference(column, idxTask)
else
Expand All @@ -611,7 +615,7 @@ open class DmfsTask(
}


protected fun taskSyncURI(loadProperties: Boolean = false): Uri {
private fun taskSyncURI(loadProperties: Boolean = false): Uri {
val id = requireNotNull(id)
return ContentUris.withAppendedId(taskList.tasksSyncUri(loadProperties), id)
}
Expand Down
15 changes: 0 additions & 15 deletions lib/src/main/kotlin/at/bitfire/ical4android/DmfsTaskFactory.kt
View file
Open in desktop

This file was deleted.

Loading