issues

refac mostly

Author: release-train-bot

docs/Dataflow/DataStore/usage.md

@@ -3,10 +3,10 @@
 ## Overview
 
 The API can be accessed through:
-- `shared.data.source.keyvalue.KeyValueSource` - base class at the core module level.
-- `shared.data.source.keyvalue.DataStoreSource` - implementation of the base class.
+- `shared.data.source.settings.SettingsSource` - base class at the core module level.
+- `shared.data.source.settings.DataStoreSource` - implementation of the base class.
 
-**KeyValueSource** provides the following methods:
+**SettingsSource** provides the following methods:
 
 - `read(key: String): T?` - Reads data of type [T] associated with the given [key].
 - `save(key: String, value: T)` - Saves the provided [value] of type [T] with the given [key].
@@ -23,12 +23,12 @@ To start using, just inject it to your DI managed class.
 
 ```kotlin
 class TemplateViewModel @Inject constructor(
-    private val keyValueSource: KeyValueSource
+    private val settingsSource: SettingsSource
 ) : BaseViewModel() {
 
     override fun doBind() = async("Init settings") {
         ...
-        val passcode: String? = keyValueSource.read("name")
+        val passcode: String? = settingsSource.read("name")
         ...
     }
 }

docs/Dataflow/Multiplatform Settings/overview.md

@@ -1,7 +1,7 @@
 # About
 
 During the application lifecycle, it may be necessary to persist data across app reopenings (for example, chosen language, theme, font size, and other preferences).
- Key-value storage provides an efficient way to store and retrieve such data using a simple yet powerful API that can manage data of any complexity.
+ Settings provide an efficient way to store and retrieve such data using a simple yet powerful API that can manage data of any complexity.
 
 # Links
 

docs/Dataflow/Multiplatform Settings/usage.md

@@ -3,10 +3,10 @@
 ## Overview
 
 The API can be accessed through:
-- `shared.data.source.keyvalue.KeyValueSource` - base class at the core module level.
-- `shared.data.source.keyvalue.SettingsKeyValueSource` - implementation of the base class.
+- `shared.data.source.settings.SettingsSource` - base class at the core module level.
+- `shared.data.source.settings.SettingsSettingsSource` - implementation of the base class.
 
-**KeyValueSource** provides the following methods:
+**SettingsSource** provides the following methods:
 
 - `read(key: String): T?` - Reads data of type [T] associated with the given [key].
 - `save(key: String, value: T)` - Saves the provided [value] of type [T] with the given [key].
@@ -17,18 +17,18 @@ The API can be accessed through:
 
 ## Example
 
-Class instance is pre-configured via dependency injection (DI) as a singleton in `app.di.common.KeyValueSourceModule`.
+Class instance is pre-configured via dependency injection (DI) as a singleton in `app.di.common.SettingsSourceModule`.
 
 To start using, just inject it to your DI managed class.
 
 ```kotlin
 class TemplateViewModel @Inject constructor(
-    private val keyValueSource: KeyValueSource
+    private val settingsSource: SettingsSource
 ) : BaseViewModel() {
 
     override fun doBind() = async("Init settings") {
         ...
-        val passcode: String? = keyValueSource.read("name")
+        val passcode: String? = settingsSource.read("name")
         ...
     }
 }

docs/Platform/iOS/usage.md

@@ -3,3 +3,7 @@
 ## Run
 
 https://www.jetbrains.com/help/kotlin-multiplatform-dev/compose-multiplatform-create-first-app.html#run-your-application-on-ios
+
+```
+Once everything is configured, ensure that the root file `./gradlew` is executable.
+```

docs/Userflow/Local Passcode Flow/usage.md

@@ -18,7 +18,7 @@ val passcodeModule = module {
             persistentKey = "passcode_config",
             resumeTimeout = 10.seconds.inWholeMilliseconds,
             encryptionSource = get(),
-            keyValueSource = get(),
+            settingsSource = get(),
         )
     }
 }

docs/Userflow/Save Theme API/usage.md

@@ -11,7 +11,7 @@ The feature utilizes `app.feature.theme.provide.presentation.ThemeProvider` to c
 - Persist its state whenever it changes.
 - Restore the last state when the app is reopened.
 
-The logic is handled by `app.feature.theme.provide.presentation.ThemePersistenceViewModel`.
+The logic is handled by `app.feature.theme.provide.presentation.ThemeStatefulViewModel`.
 
 Thus, whenever you update the current active application theme, it is automatically saved across app restarts.
 

processor/src/main/kotlin/kotli/template/multiplatform/compose/MultiplatformComposeTemplateProcessor.kt

@@ -18,8 +18,8 @@ import kotli.template.multiplatform.compose.dataflow.config.ConfigProvider
 import kotli.template.multiplatform.compose.dataflow.database.DatabaseProvider
 import kotli.template.multiplatform.compose.dataflow.encryption.EncryptionProvider
 import kotli.template.multiplatform.compose.dataflow.http.HttpProvider
-import kotli.template.multiplatform.compose.dataflow.keyvalue.KeyValueProvider
-import kotli.template.multiplatform.compose.dataflow.keyvalue.settings.SettingsKeyValueProcessor
+import kotli.template.multiplatform.compose.dataflow.settings.SettingsProvider
+import kotli.template.multiplatform.compose.dataflow.settings.basic.BasicSettingsProcessor
 import kotli.template.multiplatform.compose.dataflow.paging.PagingProvider
 import kotli.template.multiplatform.compose.essentials.buildtool.BuildToolProvider
 import kotli.template.multiplatform.compose.essentials.design.DesignSystemProvider
@@ -57,7 +57,7 @@ object MultiplatformComposeTemplateProcessor : BaseTemplateProcessor() {
             features = listOf(
                 Feature(IOSPlatformProcessor.ID),
                 Feature(AndroidPlatformProcessor.ID),
-                Feature(SettingsKeyValueProcessor.ID),
+                Feature(BasicSettingsProcessor.ID),
                 Feature(DataLoaderProcessor.ID),
                 Feature(SaveThemeProcessor.ID),
                 Feature(ChangeThemeProcessor.ID),
@@ -84,7 +84,7 @@ object MultiplatformComposeTemplateProcessor : BaseTemplateProcessor() {
 
         // dataflow
         CommonDataFlowProvider,
-        KeyValueProvider,
+        SettingsProvider,
         EncryptionProvider,
         CacheProvider,
         ConfigProvider,

processor/src/main/kotlin/kotli/template/multiplatform/compose/Rules.kt

@@ -80,8 +80,7 @@ object Rules {
 
     // design
     const val SharedDesignSrcDir = "${SharedDesignDir}/src"
-    const val SharedDesignComponentDir =
-        "${SharedDesignSrcDir}/commonMain/kotlin/shared/design/component"
+    const val SharedDesignComponentDir = "${SharedDesignSrcDir}/commonMain/kotlin/shared/design/component"
     const val AppIconsKt = "${SharedDesignSrcDir}/commonMain/kotlin/shared/design/icon/AppIcons.kt"
     const val AppPlaceholder = "${SharedDesignComponentDir}/AppPlaceholder.kt"
     const val AppMarkdown = "${SharedDesignComponentDir}/AppMarkdown.kt"
@@ -111,9 +110,9 @@ object Rules {
     // dataflow -> http
     const val HttpSource = "*/*HttpSource*.kt"
 
-    // dataflow -> keyvalue
-    const val KeyValueSource = "*/*KeyValueSource*.kt"
-    const val SettingsKeyValueSource = "*/*SettingsKeyValueSource*.kt"
+    // dataflow -> settings
+    const val SettingsSource = "*/*SettingsSource*.kt"
+    const val BasicSettingsSource = "*/*BasicSettingsSource*.kt"
     const val DataStoreSource = "*/*DataStoreSource.kt"
 
     // dataflow -> encryption

processor/src/main/kotlin/kotli/template/multiplatform/compose/dataflow/keyvalue/KeyValueProvider.kt

@@ -0,0 +1,18 @@
+package kotli.template.multiplatform.compose.dataflow.settings
+
+import kotli.engine.FeatureProcessor
+import kotli.template.multiplatform.compose.dataflow.BaseDataFlowProvider
+import kotli.template.multiplatform.compose.dataflow.settings.common.CommonSettingsProcessor
+import kotli.template.multiplatform.compose.dataflow.settings.datastore.DataStoreProcessor
+import kotli.template.multiplatform.compose.dataflow.settings.basic.BasicSettingsProcessor
+
+object SettingsProvider : BaseDataFlowProvider() {
+
+    override fun getId(): String = "dataflow.settings"
+    override fun isMultiple(): Boolean = false
+    override fun createProcessors(): List<FeatureProcessor> = listOf(
+        CommonSettingsProcessor,
+        BasicSettingsProcessor,
+        DataStoreProcessor
+    )
+}