refactor: [WIP] updated domain layer

Author: Lennoard

domain/consumer-rules.pro

@@ -0,0 +1,21 @@
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.
+#
+# For more details, see
+#   http://developer.android.com/guide/developing/tools/proguard.html
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+#   public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile

domain/proguard-rules.pro

@@ -0,0 +1,12 @@
+package com.androidvip.sysctlgui.domain
+
+import androidx.annotation.StringRes
+
+/**
+ * Provides access to string resources.
+ * This interface allows for fetching localized strings, potentially with formatting arguments.
+ */
+interface StringProvider {
+    fun getString(@StringRes resId: Int): String
+    fun getString(@StringRes resId: Int, vararg formatArgs: Any): String
+}

domain/src/main/java/com/androidvip/sysctlgui/domain/StringProvider.kt

@@ -1,34 +1,38 @@
 package com.androidvip.sysctlgui.domain.di
 
-import com.androidvip.sysctlgui.domain.usecase.AddUserParamUseCase
 import com.androidvip.sysctlgui.domain.usecase.AddUserParamsUseCase
-import com.androidvip.sysctlgui.domain.usecase.ApplyParamsUseCase
+import com.androidvip.sysctlgui.domain.usecase.ApplyParamUseCase
 import com.androidvip.sysctlgui.domain.usecase.BackupParamsUseCase
 import com.androidvip.sysctlgui.domain.usecase.ClearUserParamUseCase
 import com.androidvip.sysctlgui.domain.usecase.ExportParamsUseCase
-import com.androidvip.sysctlgui.domain.usecase.GetJsonParamsUseCase
+import com.androidvip.sysctlgui.domain.usecase.GetAppSettingsUseCase
+import com.androidvip.sysctlgui.domain.usecase.GetParamDocumentationUseCase
 import com.androidvip.sysctlgui.domain.usecase.GetParamsFromFilesUseCase
+import com.androidvip.sysctlgui.domain.usecase.GetRuntimeParamUseCase
 import com.androidvip.sysctlgui.domain.usecase.GetRuntimeParamsUseCase
+import com.androidvip.sysctlgui.domain.usecase.GetUserParamByNameUseCase
 import com.androidvip.sysctlgui.domain.usecase.GetUserParamsUseCase
-import com.androidvip.sysctlgui.domain.usecase.ImportParamsUseCase
-import com.androidvip.sysctlgui.domain.usecase.PerformDatabaseMigrationUseCase
+import com.androidvip.sysctlgui.domain.usecase.IsTaskerInstalledUseCase
 import com.androidvip.sysctlgui.domain.usecase.RemoveUserParamUseCase
-import com.androidvip.sysctlgui.domain.usecase.UpdateUserParamUseCase
+import com.androidvip.sysctlgui.domain.usecase.UpsertUserParamUseCase
+import org.koin.android.ext.koin.androidContext
+import org.koin.core.module.dsl.factoryOf
 import org.koin.dsl.module
 
 val domainModule = module {
-    factory { AddUserParamsUseCase(get(), get()) }
-    factory { AddUserParamUseCase(get(), get()) }
-    factory { ApplyParamsUseCase(get(), get()) }
-    factory { ClearUserParamUseCase(get()) }
-    factory { GetJsonParamsUseCase(get()) }
-    factory { GetParamsFromFilesUseCase(get()) }
-    factory { GetUserParamsUseCase(get()) }
-    factory { GetRuntimeParamsUseCase(get(), get()) }
-    factory { PerformDatabaseMigrationUseCase(get()) }
-    factory { RemoveUserParamUseCase(get()) }
-    factory { UpdateUserParamUseCase(get(), get()) }
-    factory { ImportParamsUseCase(get(), get(), get(), get()) }
-    factory { BackupParamsUseCase(get(), get()) }
-    factory { ExportParamsUseCase(get(), get()) }
+    factoryOf(::AddUserParamsUseCase)
+    factoryOf(::ApplyParamUseCase)
+    factoryOf(::ClearUserParamUseCase)
+    factoryOf(::GetParamsFromFilesUseCase)
+    factoryOf(::GetUserParamsUseCase)
+    factoryOf(::GetRuntimeParamsUseCase)
+    factoryOf(::GetRuntimeParamUseCase)
+    factoryOf(::GetUserParamByNameUseCase)
+    factoryOf(::RemoveUserParamUseCase)
+    factoryOf(::UpsertUserParamUseCase)
+    factoryOf(::BackupParamsUseCase)
+    factoryOf(::ExportParamsUseCase)
+    factoryOf(::GetAppSettingsUseCase)
+    factoryOf(::GetParamDocumentationUseCase)
+    factory { IsTaskerInstalledUseCase(androidContext()) }
 }

domain/src/main/java/com/androidvip/sysctlgui/domain/datasource/LocalDataSourceContract.kt

@@ -0,0 +1,27 @@
+package com.androidvip.sysctlgui.domain.enums
+
+/**
+ * Defines the method used to commit kernel parameter changes.
+ */
+enum class CommitMode {
+    /**
+     * Commits the value using the `sysctl -w` command.
+     * This is the default mode.
+     */
+    SYSCTL,
+    /**
+     * Commits the value to the file using `echo` command.
+     * This method is generally safer and more reliable.
+     */
+    ECHO;
+
+    companion object {
+        fun parse(value: String): CommitMode {
+            return when (value) {
+                "sysctl" -> SYSCTL
+                "echo" -> ECHO
+                else -> SYSCTL
+            }
+        }
+    }
+}

domain/src/main/java/com/androidvip/sysctlgui/domain/datasource/RuntimeDataSourceContract.kt

@@ -0,0 +1,27 @@
+package com.androidvip.sysctlgui.domain.enums
+
+/**
+ * Represents the different types of settings component that can be displayed in the UI.
+ * Each type corresponds to a specific UI element used to interact with the setting.
+ */
+enum class SettingItemType {
+    /**
+     * Simple setting header with no behavior
+     */
+    Text,
+
+    /**
+     * Represents a switch setting component that can be toggled on or off.
+     */
+    Switch,
+
+    /**
+     * Represents a list of options that can be selected from.
+     */
+    List,
+
+    /**
+     * Represents a slider component that allows the user to select a value within a range.
+     */
+    Slider
+}

domain/src/main/java/com/androidvip/sysctlgui/domain/di/DomainModule.kt

@@ -1,4 +1,22 @@
 package com.androidvip.sysctlgui.domain.exceptions
 
+// TODO: Use sealed classes instead of exceptions
+/**
+ * Exception thrown when a value commit fails or refuses to be applied (value remains the same)
+ */
 class ApplyValueException(message: String) : Exception(message)
+
+/**
+ * Exception thrown when a value commit fails and the commit mode is "sysctl"
+ */
 class CommitModeException(message: String) : Exception(message)
+
+/**
+ * Exception thrown when a value to be committed is blank and blank values are not allowed
+ */
+class BlankValueNotAllowedException() : IllegalArgumentException()
+
+/**
+ * Exception thrown when a shell command fails
+ */
+class ShellCommandException(message: String, cause: Throwable) : Exception(message, cause)

domain/src/main/java/com/androidvip/sysctlgui/domain/enums/CommitMode.kt

@@ -1,3 +1,6 @@
 package com.androidvip.sysctlgui.domain.exceptions
 
+/**
+ * Exception thrown when no parameter is found for a given kernel file path.
+ */
 class NoParameterFoundException : Exception()