Entities Impl improvements

Gerrit Garbereder · Gerrit Garbereder · commit 7a54644cbf0f · 2023-09-03T08:09:54.000+03:00
Better testability
Fixed missing total_duration storage
Extracted parameters for DB drivers
Use interface for DB drivers
Rename Task to PersistentTask to avoid name clashes
diff --git a/Task-Tracker-CLI/src/main/kotlin/Main.kt b/Task-Tracker-CLI/src/main/kotlin/Main.kt
@@ -1,7 +1,8 @@
+import com.garbereder.tasktracker.usecases.sqlite.DriverFactory
 import com.garbereder.tasktracker.usecases.tasks.DBTaskCollectionReaderFactory
 
 fun main() {
     CLI(
-        DBTaskCollectionReaderFactory()
+        DBTaskCollectionReaderFactory(DriverFactory("jdbc:sqlite:tasktracker.sqlite"))
     ).run()
 }
diff --git a/Task-Tracker-Usecases-SQLite-Impl/src/commonMain/kotlin/com/garbereder/tasktracker/usecases/sqlite/DriverFactory.kt b/Task-Tracker-Usecases-SQLite-Impl/src/commonMain/kotlin/com/garbereder/tasktracker/usecases/sqlite/DriverFactory.kt
@@ -1,7 +1,8 @@
 package com.garbereder.tasktracker.usecases.sqlite
 
 import app.cash.sqldelight.db.SqlDriver
+import com.garbereder.tasktracker.usecases.tasks.DBDriverFactory
 
-expect class DriverFactory {
-    fun createDriver(): SqlDriver
+expect class DriverFactory : DBDriverFactory {
+    override fun createDriver(): SqlDriver
 }
diff --git a/Task-Tracker-Usecases-SQLite-Impl/src/commonMain/kotlin/com/garbereder/tasktracker/usecases/tasks/DBDriverFactory.kt b/Task-Tracker-Usecases-SQLite-Impl/src/commonMain/kotlin/com/garbereder/tasktracker/usecases/tasks/DBDriverFactory.kt
@@ -0,0 +1,7 @@
+package com.garbereder.tasktracker.usecases.tasks
+
+import app.cash.sqldelight.db.SqlDriver
+
+interface DBDriverFactory {
+    fun createDriver(): SqlDriver
+}
diff --git a/Task-Tracker-Usecases-SQLite-Impl/src/commonMain/kotlin/com/garbereder/tasktracker/usecases/tasks/DBTask.kt b/Task-Tracker-Usecases-SQLite-Impl/src/commonMain/kotlin/com/garbereder/tasktracker/usecases/tasks/DBTask.kt
diff --git a/Task-Tracker-Usecases-SQLite-Impl/src/commonMain/kotlin/com/garbereder/tasktracker/usecases/tasks/DBTaskCollection.kt b/Task-Tracker-Usecases-SQLite-Impl/src/commonMain/kotlin/com/garbereder/tasktracker/usecases/tasks/DBTaskCollection.kt
@@ -4,28 +4,26 @@ import com.garbereder.tasktracker.entities.Task
 import com.garbereder.tasktracker.entities.TaskCollection
 import com.garbereder.tasktracker.usecases.sqlite.Database
 
-class DBAwareTaskCollection(private val database: Database) :
+class DBTaskCollection(private val database: Database) :
     TaskCollection {
 
-    override fun add(task: Task) {
+    override fun add(task: Task) =
         database.transaction {
-            database.tasksQueries.insert(task.name)
+            database.tasksQueries.insert(task.name, task.totalDuration)
         }
-    }
 
-    override fun iterator(): Iterator<Task> = database.tasksQueries.selectAll().executeAsList().map { t -> Task(t.name, t.total_duration) }.iterator()
+    override fun iterator(): Iterator<Task> =
+        database.tasksQueries.selectAll().executeAsList().map { t -> Task(t.name, t.total_duration) }.iterator()
 
-    override fun remove(task: Task) {
+    override fun remove(task: Task) =
         database.transaction {
             database.tasksQueries.deleteByName(task.name)
         }
-    }
 
-    override fun replace(task: Task) {
+    override fun replace(task: Task) =
         database.transaction {
             database.tasksQueries.setTotalDuration(task.totalDuration, task.name)
         }
-    }
 
     override fun size(): Int = database.tasksQueries.selectAll().executeAsList().count()
 }
diff --git a/Task-Tracker-Usecases-SQLite-Impl/src/commonMain/kotlin/com/garbereder/tasktracker/usecases/tasks/DBTaskCollectionReader.kt b/Task-Tracker-Usecases-SQLite-Impl/src/commonMain/kotlin/com/garbereder/tasktracker/usecases/tasks/DBTaskCollectionReader.kt
@@ -2,11 +2,7 @@ package com.garbereder.tasktracker.usecases.tasks
 
 import com.garbereder.tasktracker.entities.TaskCollection
 import com.garbereder.tasktracker.usecases.sqlite.Database
-import com.garbereder.tasktracker.usecases.sqlite.DriverFactory
 
-class DBTaskCollectionReader internal constructor(private val driverFactory: DriverFactory) : TaskCollectionReader {
-    override fun read(): TaskCollection {
-        val database = Database(driverFactory.createDriver())
-        return DBAwareTaskCollection(database)
-    }
+class DBTaskCollectionReader internal constructor(private val driverFactory: DBDriverFactory) : TaskCollectionReader {
+    override fun read(): TaskCollection = DBTaskCollection(Database(driverFactory.createDriver()))
 }
diff --git a/Task-Tracker-Usecases-SQLite-Impl/src/commonMain/sqldelight/com/garbereder/tasktracker/usecases/sqlite/sqldelight/tasktracker/data/Tasks.sq b/Task-Tracker-Usecases-SQLite-Impl/src/commonMain/sqldelight/com/garbereder/tasktracker/usecases/sqlite/sqldelight/tasktracker/data/Tasks.sq
@@ -1,22 +1,23 @@
-CREATE TABLE IF NOT EXISTS Task (
+CREATE TABLE IF NOT EXISTS PersistentTask (
   id INTEGER PRIMARY KEY AUTOINCREMENT,
   name TEXT NOT NULL,
   total_duration INTEGER NOT NULL DEFAULT 0
 );
 
 selectAll:
 SELECT *
-FROM Task;
+FROM PersistentTask
+ORDER BY name;
 
 insert:
-INSERT INTO Task(name)
-VALUES (?);
+INSERT INTO PersistentTask(name, total_duration)
+VALUES (?, ?);
 
 deleteByName:
-DELETE FROM Task
+DELETE FROM PersistentTask
 WHERE name = ?;
 
 setTotalDuration:
-UPDATE Task
+UPDATE PersistentTask
 SET total_duration = ?
 WHERE name = ?;
diff --git a/Task-Tracker-Usecases-SQLite-Impl/src/jvmMain/kotlin/com/garbereder/tasktracker/usecases/sqlite/DriverFactory.kt b/Task-Tracker-Usecases-SQLite-Impl/src/jvmMain/kotlin/com/garbereder/tasktracker/usecases/sqlite/DriverFactory.kt
@@ -2,13 +2,12 @@ package com.garbereder.tasktracker.usecases.sqlite
 
 import app.cash.sqldelight.db.SqlDriver
 import app.cash.sqldelight.driver.jdbc.sqlite.JdbcSqliteDriver
+import com.garbereder.tasktracker.usecases.tasks.DBDriverFactory
 
-actual class DriverFactory {
-    actual fun createDriver(): SqlDriver {
-        val driver: SqlDriver = JdbcSqliteDriver("jdbc:sqlite:tasktracker.sqlite")
+actual class DriverFactory(private val url: String) : DBDriverFactory {
+    actual override fun createDriver(): SqlDriver =
+        JdbcSqliteDriver(url)
             .apply {
                 Database.Schema.create(this)
             }
-        return driver
-    }
 }
diff --git a/Task-Tracker-Usecases-SQLite-Impl/src/jvmMain/kotlin/com/garbereder/tasktracker/usecases/tasks/DBTaskCollectionReaderFactory.kt b/Task-Tracker-Usecases-SQLite-Impl/src/jvmMain/kotlin/com/garbereder/tasktracker/usecases/tasks/DBTaskCollectionReaderFactory.kt
@@ -1,7 +1,6 @@
 package com.garbereder.tasktracker.usecases.tasks
 
-import com.garbereder.tasktracker.usecases.sqlite.DriverFactory
-
-actual class DBTaskCollectionReaderFactory : TaskCollectionReaderFactory {
-    actual override fun create(): TaskCollectionReader = DBTaskCollectionReader(DriverFactory())
+actual class DBTaskCollectionReaderFactory(private val factory: DBDriverFactory) : TaskCollectionReaderFactory {
+    actual override fun create(): TaskCollectionReader = DBTaskCollectionReader(factory)
+    // DriverFactory("jdbc:sqlite:tasktracker.sqlite")
 }
diff --git a/Task-Tracker-Usecases-SQLite-Impl/src/jvmTest/kotlin/com/garbereder/tasktracker/usecases/sqlite/InMemoryDriverFactory.kt b/Task-Tracker-Usecases-SQLite-Impl/src/jvmTest/kotlin/com/garbereder/tasktracker/usecases/sqlite/InMemoryDriverFactory.kt
@@ -0,0 +1,13 @@
+package com.garbereder.tasktracker.usecases.sqlite
+
+import app.cash.sqldelight.db.SqlDriver
+import app.cash.sqldelight.driver.jdbc.sqlite.JdbcSqliteDriver
+import com.garbereder.tasktracker.usecases.tasks.DBDriverFactory
+
+class InMemoryDriverFactory : DBDriverFactory {
+    override fun createDriver(): SqlDriver =
+        JdbcSqliteDriver(JdbcSqliteDriver.IN_MEMORY)
+            .apply {
+                Database.Schema.create(this)
+            }
+}
diff --git a/Task-Tracker-Usecases-SQLite-Impl/src/jvmTest/kotlin/com/garbereder/tasktracker/usecases/tasks/DBTaskCollectionReaderFactoryTests.kt b/Task-Tracker-Usecases-SQLite-Impl/src/jvmTest/kotlin/com/garbereder/tasktracker/usecases/tasks/DBTaskCollectionReaderFactoryTests.kt
@@ -0,0 +1,14 @@
+package com.garbereder.tasktracker.usecases.tasks
+
+import com.garbereder.tasktracker.usecases.sqlite.InMemoryDriverFactory
+import org.junit.jupiter.api.Test
+import kotlin.test.assertNotNull
+
+class DBTaskCollectionReaderFactoryTests {
+
+    @Test
+    fun testRead() {
+        val fac = DBTaskCollectionReaderFactory(InMemoryDriverFactory())
+        assertNotNull(fac.create())
+    }
+}
diff --git a/Task-Tracker-Usecases-SQLite-Impl/src/jvmTest/kotlin/com/garbereder/tasktracker/usecases/tasks/DBTaskCollectionReaderTests.kt b/Task-Tracker-Usecases-SQLite-Impl/src/jvmTest/kotlin/com/garbereder/tasktracker/usecases/tasks/DBTaskCollectionReaderTests.kt
@@ -0,0 +1,14 @@
+package com.garbereder.tasktracker.usecases.tasks
+
+import com.garbereder.tasktracker.usecases.sqlite.InMemoryDriverFactory
+import org.junit.jupiter.api.Test
+import kotlin.test.assertNotNull
+
+class DBTaskCollectionReaderTests {
+
+    @Test
+    fun testRead() {
+        val reader = DBTaskCollectionReader(InMemoryDriverFactory())
+        assertNotNull(reader.read())
+    }
+}
diff --git a/Task-Tracker-Usecases-SQLite-Impl/src/jvmTest/kotlin/com/garbereder/tasktracker/usecases/tasks/DBTaskCollectionTests.kt b/Task-Tracker-Usecases-SQLite-Impl/src/jvmTest/kotlin/com/garbereder/tasktracker/usecases/tasks/DBTaskCollectionTests.kt
@@ -0,0 +1,125 @@
+package com.garbereder.tasktracker.usecases.tasks
+
+import com.garbereder.tasktracker.entities.Task
+import com.garbereder.tasktracker.usecases.sqlite.Database
+import com.garbereder.tasktracker.usecases.sqlite.InMemoryDriverFactory
+import com.garbereder.tasktracker.usecases.sqlite.sqldelight.tasktracker.data.PersistentTask
+import org.junit.jupiter.api.Test
+import kotlin.test.assertEquals
+import kotlin.test.assertFalse
+import kotlin.test.assertNotEquals
+import kotlin.test.assertTrue
+
+class DBTaskCollectionTests {
+
+    @Test
+    fun testEmptySize() {
+        val collection = DBTaskCollection(Database(InMemoryDriverFactory().createDriver()))
+        assertEquals(0, collection.size())
+    }
+
+    @Test
+    fun testAdd() {
+        val database = Database(InMemoryDriverFactory().createDriver())
+        val collection = DBTaskCollection(database)
+        collection.add(Task("Task", 5))
+
+        // Collection handling
+        assertEquals(1, collection.size())
+        val task1 = collection.iterator().next()
+        assertEquals("Task", task1.name)
+        assertEquals(5, task1.totalDuration)
+
+        // DB persistence
+        val tasks = database.tasksQueries.selectAll().executeAsList()
+        assertEquals(1, tasks.size)
+        assertEquals(PersistentTask(1, "Task", 5), tasks[0])
+    }
+
+    @Test
+    fun testAddMoreItems() {
+        val database = Database(InMemoryDriverFactory().createDriver())
+        val collection = DBTaskCollection(database)
+        collection.add(Task("Task2", 20))
+        collection.add(Task("Task", 5))
+
+        // Collection handling
+        assertEquals(2, collection.size())
+        val it = collection.iterator()
+        val task1 = it.next()
+        assertEquals("Task", task1.name)
+        assertEquals(5, task1.totalDuration)
+        val task2 = it.next()
+        assertEquals("Task2", task2.name)
+        assertEquals(20, task2.totalDuration)
+
+        // DB persistence
+        val tasks = database.tasksQueries.selectAll().executeAsList()
+        assertEquals(2, tasks.size)
+        assertEquals(PersistentTask(2, "Task", 5), tasks[0])
+        assertEquals(PersistentTask(1, "Task2", 20), tasks[1])
+    }
+
+    @Test
+    fun testIteratorIsRefreshedOnCall() {
+        val database = Database(InMemoryDriverFactory().createDriver())
+        val collection = DBTaskCollection(database)
+        collection.add(Task("Task", 5))
+        collection.add(Task("Task2", 20))
+
+        val it = collection.iterator()
+        val it2 = collection.iterator()
+        assertNotEquals(it, it2)
+
+        assertTrue(it.hasNext())
+        it.next()
+        it.next()
+        assertFalse(it.hasNext())
+        assertTrue(it2.hasNext())
+        it2.next()
+        it2.next()
+        assertFalse(it2.hasNext())
+    }
+
+    @Test
+    fun testRemove() {
+        val database = Database(InMemoryDriverFactory().createDriver())
+        val collection = DBTaskCollection(database)
+        collection.add(Task("Task", 5))
+        collection.add(Task("Task2", 20))
+        collection.add(Task("Task3", 13))
+
+        // Collection handling
+        assertEquals(3, collection.size())
+        collection.remove(Task("Task2", 20))
+        assertEquals(2, collection.size())
+        val it = collection.iterator()
+        assertEquals("Task", it.next().name)
+        assertEquals("Task3", it.next().name)
+
+        // DB persistence
+        val tasks = database.tasksQueries.selectAll().executeAsList()
+        assertEquals(2, tasks.size)
+        assertEquals(PersistentTask(1, "Task", 5), tasks[0])
+        assertEquals(PersistentTask(3, "Task3", 13), tasks[1])
+    }
+
+    @Test
+    fun testReplace() {
+        val database = Database(InMemoryDriverFactory().createDriver())
+        val collection = DBTaskCollection(database)
+        collection.add(Task("Task", 5))
+        collection.replace(Task("Task", 20))
+
+        // Collection handling
+        assertEquals(1, collection.size())
+        val task1 = collection.iterator().next()
+        assertEquals("Task", task1.name)
+        assertEquals(20, task1.totalDuration)
+
+        // DB persistence
+        val tasks = database.tasksQueries.selectAll().executeAsList()
+        assertEquals(1, tasks.size)
+        assertEquals(PersistentTask(1, "Task", 20), tasks[0])
+    }
+}
diff --git a/Task-Tracker-Usecases-SQLite-Impl/src/jvmTest/kotlin/com/garbereder/tasktracker/usecases/tasks/DriverFactoryTests.kt b/Task-Tracker-Usecases-SQLite-Impl/src/jvmTest/kotlin/com/garbereder/tasktracker/usecases/tasks/DriverFactoryTests.kt
@@ -0,0 +1,14 @@
+package com.garbereder.tasktracker.usecases.tasks
+
+import com.garbereder.tasktracker.usecases.sqlite.DriverFactory
+import org.junit.jupiter.api.Test
+import kotlin.test.assertNotNull
+
+class DriverFactoryTests {
+
+    @Test
+    fun testCreateDriver() {
+        val fac = DriverFactory("jdbc:sqlite:tasktracker.sqlite")
+        assertNotNull(fac.createDriver())
+    }
+}
diff --git a/Task-Tracker-Usecases-SQLite-Impl/src/nativeMain/kotlin/com/garbereder/tasktracker/usecases/sqlite/DriverFactory.kt b/Task-Tracker-Usecases-SQLite-Impl/src/nativeMain/kotlin/com/garbereder/tasktracker/usecases/sqlite/DriverFactory.kt
@@ -1,8 +1,12 @@
 package com.garbereder.tasktracker.usecases.sqlite
 
+import app.cash.sqldelight.db.QueryResult
 import app.cash.sqldelight.db.SqlDriver
+import app.cash.sqldelight.db.SqlSchema
 import app.cash.sqldelight.driver.native.NativeSqliteDriver
+import com.garbereder.tasktracker.usecases.tasks.DBDriverFactory
 
-actual class DriverFactory {
-    actual fun createDriver(): SqlDriver = NativeSqliteDriver(Database.Schema, "test.db")
+actual class DriverFactory(private val schema: SqlSchema<QueryResult.Value<Unit>>, private val name: String) : DBDriverFactory {
+    actual override fun createDriver(): SqlDriver = NativeSqliteDriver(schema, name)
+    // Database.Schema, "test.db"
 }
diff --git a/Task-Tracker-Usecases-SQLite-Impl/src/nativeMain/kotlin/com/garbereder/tasktracker/usecases/tasks/DBTaskCollectionReaderFactory.kt b/Task-Tracker-Usecases-SQLite-Impl/src/nativeMain/kotlin/com/garbereder/tasktracker/usecases/tasks/DBTaskCollectionReaderFactory.kt
@@ -1,7 +1,5 @@
 package com.garbereder.tasktracker.usecases.tasks
 
-import com.garbereder.tasktracker.usecases.sqlite.DriverFactory
-
-actual class DBTaskCollectionReaderFactory : TaskCollectionReaderFactory {
-    actual override fun create(): TaskCollectionReader = DBTaskCollectionReader(DriverFactory())
+actual class DBTaskCollectionReaderFactory(private val factory: DBDriverFactory) : TaskCollectionReaderFactory {
+    actual override fun create(): TaskCollectionReader = DBTaskCollectionReader(factory)
 }

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,8 @@`
	`1`	`+import com.garbereder.tasktracker.usecases.sqlite.DriverFactory`
`1`	`2`	`import com.garbereder.tasktracker.usecases.tasks.DBTaskCollectionReaderFactory`
`2`	`3`
`3`	`4`	`fun main() {`
`4`	`5`	`CLI(`
`5`		`- DBTaskCollectionReaderFactory()`
	`6`	`+ DBTaskCollectionReaderFactory(DriverFactory("jdbc:sqlite:tasktracker.sqlite"))`
`6`	`7`	`).run()`
`7`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,8 @@`
`1`	`1`	`package com.garbereder.tasktracker.usecases.sqlite`
`2`	`2`
`3`	`3`	`import app.cash.sqldelight.db.SqlDriver`
	`4`	`+import com.garbereder.tasktracker.usecases.tasks.DBDriverFactory`
`4`	`5`
`5`		`-expect class DriverFactory {`
`6`		`- fun createDriver(): SqlDriver`
	`6`	`+expect class DriverFactory : DBDriverFactory {`
	`7`	`+ override fun createDriver(): SqlDriver`
`7`	`8`	`}`