Merge pull request #82 from infinum/develop

Add history feature

.github/workflows/code-analysis.yml

@@ -9,6 +9,24 @@ on:
       - '*'
 
 jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Save Gradle Caches
+        uses: actions/cache@v2
+        with:
+          path: ~/.gradle/caches/
+          key: gradle-caches-${{ runner.os }}-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
+          restore-keys: |
+            gradle-caches-${{ runner.os }}-
+      - name: Lint
+        run: ./gradlew lintAll
+      - name: Stop Gradle
+        run: ./gradlew --stop
+
   detekt:
     name: Detekt
     runs-on: ubuntu-latest

CHANGELOG.md

@@ -1,6 +1,13 @@
 Changelog
 =========
 
+## Version 5.2.7
+
+_2021-02-24_
+
+* Implement history in editor.
+* Fix word tokenization in editor.
+
 ## Version 5.2.6
 
 _2021-02-18_

README.md

@@ -43,13 +43,13 @@ Then add the following dependencies in your app `build.gradle` or `build.gradle.
 
 **Groovy**
 ```groovy
-debugImplementation "com.infinum.dbinspector:dbinspector:5.2.6"
-releaseImplementation "com.infinum.dbinspector:dbinspector-no-op:5.2.6"
+debugImplementation "com.infinum.dbinspector:dbinspector:5.2.7"
+releaseImplementation "com.infinum.dbinspector:dbinspector-no-op:5.2.7"
 ```
 **KotlinDSL**
 ```kotlin
-debugImplementation("com.infinum.dbinspector:dbinspector:5.2.6")
-releaseImplementation("com.infinum.dbinspector:dbinspector-no-op:5.2.6")
+debugImplementation("com.infinum.dbinspector:dbinspector:5.2.7")
+releaseImplementation("com.infinum.dbinspector:dbinspector-no-op:5.2.7")
 ```
 
 ### Usage

build.gradle

@@ -57,7 +57,6 @@ subprojects {
     apply from: "$rootDir/dokka.gradle"
 }
 
-apply from: "shared.gradle"
 apply from: "deploy.gradle"
 apply from: "jacoco.gradle"
 
@@ -69,35 +68,44 @@ task clean(type: Delete) {
     delete rootProject.buildDir
 }
 
+task lintAll(dependsOn: [
+        ':dbinspector:lintRelease',
+        ':dbinspector-no-op:lintRelease'
+]) {
+    group = "Verification"
+    description = "Run Lint on all modules"
+}
+
 task detektAll(dependsOn: [
         ':dbinspector:detekt',
         ':dbinspector-no-op:detekt'
 ]) {
     group = "Verification"
-    description = "Run detekt on all modules"
+    description = "Run Detekt on all modules"
 }
 
 task ktlintAll(dependsOn: [
         ':dbinspector:ktlintCheck',
         ':dbinspector-no-op:ktlintCheck'
 ]) {
     group = "Verification"
-    description = "Run ktlintCheck on all modules"
+    description = "Run Ktlint on all modules"
 }
 
 task cpdAll(dependsOn: [
         ':dbinspector:cpdCheck',
         ':dbinspector-no-op:cpdCheck'
 ]) {
     group = "Verification"
-    description = "Run cpdCheck on all modules"
+    description = "Run CPD on all modules"
 }
 
-task runStaticChecks(dependsOn: ordered(
+task runStaticChecks(dependsOn: [
+        ':lintAll',
         ':detektAll',
         ':ktlintAll',
         ':cpdAll'
-)) {
+]) {
     group = "Verification"
     description = "Run static checks on all modules"
 }

config.gradle

@@ -7,7 +7,7 @@ ext {
     ]
     releaseConfig = [
             "group"      : "com.infinum.dbinspector",
-            "version"    : "5.2.6",
-            "versionCode": 5 * 100 * 100 + 2 * 100 + 6
+            "version"    : "5.2.7",
+            "versionCode": 5 * 100 * 100 + 2 * 100 + 7
     ]
 }

dbinspector/build.gradle

@@ -71,6 +71,7 @@ dependencies {
     implementation packages.koin.scope
     implementation packages.koin.viewmodel
     implementation packages.timber.core
+    implementation packages.fuzzy.core
 }
 
 apply from: "publish.gradle"

dbinspector/src/main/kotlin/com/infinum/dbinspector/data/Data.kt

@@ -1,11 +1,18 @@
 package com.infinum.dbinspector.data
 
+import android.content.Context
 import androidx.datastore.core.Serializer
+import androidx.datastore.createDataStore
+import com.infinum.dbinspector.data.Data.Constants.Name.PROTO_FILENAME_HISTORY
+import com.infinum.dbinspector.data.Data.Constants.Name.PROTO_FILENAME_SETTINGS
+import com.infinum.dbinspector.data.models.local.proto.output.HistoryEntity
 import com.infinum.dbinspector.data.models.local.proto.output.SettingsEntity
 import com.infinum.dbinspector.data.source.local.cursor.PragmaSource
 import com.infinum.dbinspector.data.source.local.cursor.RawQuerySource
 import com.infinum.dbinspector.data.source.local.cursor.SchemaSource
-import com.infinum.dbinspector.data.source.local.proto.DataStoreFactory
+import com.infinum.dbinspector.data.source.local.proto.history.HistoryDataStore
+import com.infinum.dbinspector.data.source.local.proto.history.HistorySerializer
+import com.infinum.dbinspector.data.source.local.proto.settings.SettingsDataStore
 import com.infinum.dbinspector.data.source.local.proto.settings.SettingsSerializer
 import com.infinum.dbinspector.data.source.memory.connection.AndroidConnectionSource
 import com.infinum.dbinspector.data.source.memory.pagination.CursorPaginator
@@ -27,12 +34,18 @@ internal object Data {
         object Settings {
             const val LINES_LIMIT_MAXIMUM = 100
         }
+
+        object Name {
+            const val PROTO_FILENAME_SETTINGS = "settings-entity.pb"
+            const val PROTO_FILENAME_HISTORY = "history-entity.pb"
+        }
     }
 
     object Qualifiers {
 
         object Name {
             val DATASTORE_SETTINGS = StringQualifier("data.qualifiers.name.datastore.settings")
+            val DATASTORE_HISTORY = StringQualifier("data.qualifiers.name.datastore.history")
         }
 
         object Schema {
@@ -92,15 +105,28 @@ internal object Data {
     }
 
     private fun local() = module {
-        single(qualifier = Qualifiers.Name.DATASTORE_SETTINGS) { "settings-entity.pb" }
-
-        single<Serializer<SettingsEntity>> { SettingsSerializer() }
-
-        single<Sources.Local.Store> {
-            DataStoreFactory(
-                get(),
-                get(qualifier = Qualifiers.Name.DATASTORE_SETTINGS),
-                get()
+        single(qualifier = Qualifiers.Name.DATASTORE_SETTINGS) { PROTO_FILENAME_SETTINGS }
+        single(qualifier = Qualifiers.Name.DATASTORE_HISTORY) { PROTO_FILENAME_HISTORY }
+
+        single<Serializer<SettingsEntity>>(qualifier = Qualifiers.Name.DATASTORE_SETTINGS) { SettingsSerializer() }
+        single<Serializer<HistoryEntity>>(qualifier = Qualifiers.Name.DATASTORE_HISTORY) { HistorySerializer() }
+
+        single<Sources.Local.Settings> {
+            val context: Context = get()
+            SettingsDataStore(
+                context.createDataStore(
+                    fileName = get(qualifier = Qualifiers.Name.DATASTORE_SETTINGS),
+                    serializer = get(qualifier = Qualifiers.Name.DATASTORE_SETTINGS)
+                )
+            )
+        }
+        single<Sources.Local.History> {
+            val context: Context = get()
+            HistoryDataStore(
+                context.createDataStore(
+                    fileName = get(qualifier = Qualifiers.Name.DATASTORE_HISTORY),
+                    serializer = get(qualifier = Qualifiers.Name.DATASTORE_HISTORY)
+                )
             )
         }
 

dbinspector/src/main/kotlin/com/infinum/dbinspector/data/Sources.kt

@@ -1,10 +1,11 @@
 package com.infinum.dbinspector.data
 
 import android.database.sqlite.SQLiteDatabase
-import androidx.datastore.core.DataStore
 import com.infinum.dbinspector.data.models.local.cursor.input.Query
 import com.infinum.dbinspector.data.models.local.cursor.output.QueryResult
+import com.infinum.dbinspector.data.models.local.proto.output.HistoryEntity
 import com.infinum.dbinspector.data.models.local.proto.output.SettingsEntity
+import com.infinum.dbinspector.data.shared.base.BaseStore
 import com.infinum.dbinspector.domain.database.models.Operation
 import java.io.File
 
@@ -32,12 +33,9 @@ internal interface Sources {
 
     interface Local {
 
-        interface Store {
+        interface Settings : BaseStore<SettingsEntity>
 
-            suspend fun settings(): DataStore<SettingsEntity>
-
-            suspend fun current(): SettingsEntity
-        }
+        interface History : BaseStore<HistoryEntity>
 
         interface Schema {
 

dbinspector/src/main/kotlin/com/infinum/dbinspector/data/models/local/proto/input/HistoryTask.kt

@@ -0,0 +1,8 @@
+package com.infinum.dbinspector.data.models.local.proto.input
+
+import com.infinum.dbinspector.data.models.local.proto.output.HistoryEntity
+
+internal data class HistoryTask(
+    val databasePath: String? = null,
+    val execution: HistoryEntity.ExecutionEntity? = null,
+)

dbinspector/src/main/kotlin/com/infinum/dbinspector/data/shared/base/BaseStore.kt

@@ -0,0 +1,13 @@
+package com.infinum.dbinspector.data.shared.base
+
+import androidx.datastore.core.DataStore
+import kotlinx.coroutines.flow.Flow
+
+internal interface BaseStore<OutputModel> {
+
+    suspend fun store(): DataStore<OutputModel> = throw NotImplementedError()
+
+    suspend fun current(): OutputModel = throw NotImplementedError()
+
+    fun flow(): Flow<OutputModel> = throw NotImplementedError()
+}

dbinspector/src/main/kotlin/com/infinum/dbinspector/data/source/local/cursor/PragmaSource.kt

@@ -18,7 +18,7 @@ internal class PragmaSource(
     private val tableInfoPaginator: Paginator,
     private val foreignKeysPaginator: Paginator,
     private val indexesPaginator: Paginator,
-    private val store: Sources.Local.Store
+    private val store: Sources.Local.Settings
 ) : CursorSource(), Sources.Local.Pragma {
 
     override suspend fun getUserVersion(query: Query): QueryResult =

dbinspector/src/main/kotlin/com/infinum/dbinspector/data/source/local/cursor/RawQuerySource.kt

@@ -16,7 +16,7 @@ import kotlinx.coroutines.suspendCancellableCoroutine
 
 internal class RawQuerySource(
     private val rawQueryPaginator: Paginator,
-    private val store: Sources.Local.Store
+    private val store: Sources.Local.Settings
 ) : CursorSource(), Sources.Local.RawQuery {
 
     override suspend fun rawQueryHeaders(query: Query): QueryResult =

dbinspector/src/main/kotlin/com/infinum/dbinspector/data/source/local/cursor/SchemaSource.kt

@@ -18,7 +18,7 @@ internal class SchemaSource(
     private val triggersPaginator: Paginator,
     private val triggerByNamePaginator: Paginator,
     private val dropTriggerPaginator: Paginator,
-    private val store: Sources.Local.Store
+    private val store: Sources.Local.Settings
 ) : CursorSource(), Sources.Local.Schema {
 
     // region Tables

dbinspector/src/main/kotlin/com/infinum/dbinspector/data/source/local/proto/history/HistoryDataStore.kt

@@ -0,0 +1,20 @@
+package com.infinum.dbinspector.data.source.local.proto.history
+
+import androidx.datastore.core.DataStore
+import com.infinum.dbinspector.data.Sources
+import com.infinum.dbinspector.data.models.local.proto.output.HistoryEntity
+import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.firstOrNull
+
+internal class HistoryDataStore(
+    private val store: DataStore<HistoryEntity>
+) : Sources.Local.History {
+
+    override suspend fun store(): DataStore<HistoryEntity> = store
+
+    override suspend fun current(): HistoryEntity =
+        store.data.firstOrNull() ?: HistoryEntity.getDefaultInstance()
+
+    override fun flow(): Flow<HistoryEntity> =
+        store.data
+}

dbinspector/src/main/kotlin/com/infinum/dbinspector/data/source/local/proto/history/HistorySerializer.kt

@@ -0,0 +1,25 @@
+package com.infinum.dbinspector.data.source.local.proto.history
+
+import androidx.datastore.core.CorruptionException
+import androidx.datastore.core.Serializer
+import com.google.protobuf.InvalidProtocolBufferException
+import com.infinum.dbinspector.data.models.local.proto.output.HistoryEntity
+import java.io.InputStream
+import java.io.OutputStream
+
+internal class HistorySerializer : Serializer<HistoryEntity> {
+
+    override val defaultValue: HistoryEntity =
+        HistoryEntity.getDefaultInstance()
+
+    override fun readFrom(input: InputStream): HistoryEntity {
+        try {
+            return HistoryEntity.parseFrom(input)
+        } catch (exception: InvalidProtocolBufferException) {
+            throw CorruptionException("Cannot read proto.", exception)
+        }
+    }
+
+    override fun writeTo(t: HistoryEntity, output: OutputStream) =
+        t.writeTo(output)
+}

dbinspector/src/main/kotlin/com/infinum/dbinspector/data/source/local/proto/settings/SettingsDataStore.kt

@@ -0,0 +1,20 @@
+package com.infinum.dbinspector.data.source.local.proto.settings
+
+import androidx.datastore.core.DataStore
+import com.infinum.dbinspector.data.Sources
+import com.infinum.dbinspector.data.models.local.proto.output.SettingsEntity
+import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.firstOrNull
+
+internal class SettingsDataStore(
+    private val store: DataStore<SettingsEntity>
+) : Sources.Local.Settings {
+
+    override suspend fun store(): DataStore<SettingsEntity> = store
+
+    override suspend fun current(): SettingsEntity =
+        store.data.firstOrNull() ?: SettingsEntity.getDefaultInstance()
+
+    override fun flow(): Flow<SettingsEntity> =
+        store.data
+}

dbinspector/src/main/kotlin/com/infinum/dbinspector/domain/Control.kt

@@ -13,4 +13,6 @@ internal interface Control {
     interface Pragma : BaseControl<Mappers.Pragma, Converters.Pragma>
 
     interface Settings : BaseControl<Mappers.Settings, Converters.Settings>
+
+    interface History : BaseControl<Mappers.History, Converters.History>
 }