Merge pull request #16 from matejsemancik/feature/update-banner

Application Update banner

Author: matejsemancik

CLAUDE.md

@@ -9,9 +9,63 @@
 - **Naming**: Classes = PascalCase, Functions/Variables = camelCase
 - **Architecture**: MVVM pattern with UI, State (Model), and Data layers
 - **State Management**: Kotlin Flows (StateFlow for UI state)
+- **Visibility Modifiers**:
+  - Use the most restrictive visibility modifier possible
+  - Prefer `internal` over `public` for implementation classes
+  - Use `private` for all properties and functions that don't need wider visibility
+  - Use `public` only for APIs that need to be accessed outside the module
 - **DI**: Koin for dependency injection
+  - Use constructor injection whenever possible instead of property injection
+  - Constructor parameters make dependencies explicit and improve testability
 - **Imports**: Grouped by purpose, explicit imports preferred over wildcards
 - **Error Handling**: Repository pattern for data operations, proper error propagation through Flows
+- **Expressive Kotlin Features**:
+  - Use `runCatching` instead of try-catch blocks
+  - Use `.use` extension for closeables
+  - Prefer `kotlin.io` extensions over Java IO streams
+  - Use scope functions (`let`, `apply`, `run`, `with`, `also`) appropriately
+  - Leverage extension functions for better readability
+  - Use property delegates (`by lazy`, `by Delegates`) where appropriate
+  - Use Elvis operator (`?:`) for fallback values
+
+## Architecture Guidelines
+- Network models (from APIs) should not be propagated to the presentation layer
+- Always map network models to domain models in the repository layer
+- Service layer handles API communication, Repository layer handles domain translation
+- One-shot data fetching should use suspend functions, not Flows
+- Only use Flows when there's data to continuously observe
+- Classes should receive their dependencies through constructor parameters:
+  ```kotlin
+  // Preferred: Constructor injection
+  class MyRepository(
+      private val apiManager: ApiManager,
+      private val database: AppDatabase
+  )
+  
+  // Avoid: Property injection
+  class MyRepository : KoinComponent {
+      private val apiManager: ApiManager by inject()
+      private val database: AppDatabase by inject()
+  }
+  ```
+- Limit KoinComponent usage to top-level components (ViewModels, Application class)
+- Apply appropriate visibility modifiers to control access:
+  ```kotlin
+  // Preferred: Implementation classes are internal
+  internal class MyRepositoryImpl(
+      private val apiManager: ApiManager
+  ) : MyRepository {
+      // Private implementation details
+      private fun processData(data: Data): ProcessedData {
+          // ...
+      }
+  }
+  
+  // Public interfaces define the contract
+  interface MyRepository {
+      suspend fun getData(): Data
+  }
+  ```
 
 ## Project Structure
 - `feature/` - App features organized by domain (tracker, search, settings)

desktopApp/build.gradle.kts

@@ -1,9 +1,16 @@
 import org.jetbrains.compose.desktop.application.dsl.TargetFormat
+import org.jetbrains.kotlin.compose.compiler.gradle.ComposeFeatureFlag
 
 plugins {
     alias(libs.plugins.kotlinMultiplatform)
     alias(libs.plugins.composeMultiplatform)
     alias(libs.plugins.composeCompiler)
+    alias(libs.plugins.composeHotReload)
+}
+
+// https://github.com/JetBrains/compose-hot-reload?tab=readme-ov-file#enable-optimizenonskippinggroups
+composeCompiler {
+    featureFlags.add(ComposeFeatureFlag.OptimizeNonSkippingGroups)
 }
 
 kotlin {

desktopApp/src/desktopMain/kotlin/dev/matsem/bpm/main.kt

@@ -25,8 +25,9 @@ import androidx.compose.ui.window.application
 import androidx.compose.ui.window.rememberWindowState
 import bpm_tracker.desktopapp.generated.resources.Res
 import bpm_tracker.desktopapp.generated.resources.launcher_icon
-import dev.matsem.bpm.feature.app.ui.AppUi
+import dev.matsem.bpm.feature.app.ui.AppWindowUi
 import dev.matsem.bpm.injection.AppInjection
+import org.jetbrains.compose.reload.DevelopmentEntryPoint
 import org.jetbrains.compose.resources.painterResource
 import org.koin.compose.KoinContext
 import java.awt.Desktop
@@ -93,6 +94,8 @@ fun ApplicationScope.MainApplication() {
             }
         }
     ) {
-        AppUi()
+        DevelopmentEntryPoint {
+            AppWindowUi()
+        }
     }
 }

gradle/libs.versions.toml

@@ -1,21 +1,23 @@
 [versions]
 androidx-lifecycle = "2.8.4"
 compose-multiplatform = "1.7.3"
+compose-hotReload = "1.0.0-dev-65"
 junit = "4.13.2"
-kotlin = "2.1.10"
+kotlin = "2.1.20-RC"
+ksp = "2.1.20-RC-1.0.31"
 kotlinx-coroutines = "1.10.1"
 kotlinx-collections = "0.3.8"
 kotlinx-datetime = "0.6.1"
 kotlinx-serialization = "2.1.0"
-ksp = "2.1.10-1.0.29"
-ktorfit = "2.2.0"
+ktorfit = "2.4.0"
 koin = "4.1.0-Beta5"
 ktor = "3.0.1"
 coil = "3.0.4"
 dataStore = "1.1.2"
 androidx-room = "2.7.0-alpha13"
 androidx-sqlite = "2.5.0-alpha13"
 appDirs = "1.3.0"
+markdownRenderer = "0.31.0"
 
 [libraries]
 kotlin-test = { module = "org.jetbrains.kotlin:kotlin-test", version.ref = "kotlin" }
@@ -48,10 +50,12 @@ coil-network-ktor = { module = "io.coil-kt.coil3:coil-network-ktor3", version.re
 coil-svg = { module = "io.coil-kt.coil3:coil-svg", version.ref = "coil" }
 
 appDirs = { module = "net.harawata:appdirs", version.ref = "appDirs" }
+markdownRenderer = { module = "com.mikepenz:multiplatform-markdown-renderer-m3", version.ref = "markdownRenderer" }
 
 [plugins]
 composeMultiplatform = { id = "org.jetbrains.compose", version.ref = "compose-multiplatform" }
 composeCompiler = { id = "org.jetbrains.kotlin.plugin.compose", version.ref = "kotlin" }
+composeHotReload = { id = "org.jetbrains.compose.hot-reload", version.ref = "compose-hotReload"}
 kotlinMultiplatform = { id = "org.jetbrains.kotlin.multiplatform", version.ref = "kotlin" }
 ksp = { id = "com.google.devtools.ksp", version.ref = "ksp" }
 ktorfit = { id = "de.jensklingenberg.ktorfit", version.ref = "ktorfit" }

settings.gradle.kts

@@ -12,6 +12,9 @@ pluginManagement {
         }
         mavenCentral()
         gradlePluginPortal()
+
+        // https://github.com/JetBrains/compose-hot-reload?tab=readme-ov-file#add-repository
+        maven("https://packages.jetbrains.team/maven/p/firework/dev")
     }
 }
 
@@ -25,8 +28,15 @@ dependencyResolutionManagement {
             }
         }
         mavenCentral()
+
+        // https://github.com/JetBrains/compose-hot-reload?tab=readme-ov-file#add-repository
+        maven("https://packages.jetbrains.team/maven/p/firework/dev")
     }
 }
 
+plugins {
+    id("org.gradle.toolchains.foojay-resolver-convention") version "0.8.0"
+}
+
 include(":desktopApp")
 include(":shared")

shared/build.gradle.kts

@@ -13,6 +13,7 @@ kotlin {
 
     sourceSets {
         val desktopMain by getting
+        val commonTest by getting
 
         commonMain.dependencies {
             // compose
@@ -22,6 +23,7 @@ kotlin {
             implementation(compose.components.resources)
             implementation(compose.components.uiToolingPreview)
             implementation(libs.androidx.lifecycle.runtime.compose)
+            implementation(libs.markdownRenderer)
 
             // kx
             implementation(libs.kotlinx.collections)
@@ -52,6 +54,10 @@ kotlin {
             implementation(libs.androidx.sqlite.bundled)
         }
 
+        commonTest.dependencies {
+            implementation(libs.kotlin.test)
+        }
+
         desktopMain.dependencies {
             implementation(libs.ktor.engine.okhttp)
             implementation(libs.appDirs)

shared/src/commonMain/composeResources/values/strings.xml

@@ -12,6 +12,7 @@
     <string name="new_timer">New timer</string>
     <string name="pick_issue">Pick an issue</string>
     <string name="timer">Timer</string>
+    <string name="new_version_banner_md">✨ New version available! [Download on GitHub](%1$s)</string>
 
     <!-- Commit/Timer -->
     <string name="duration_label">⏳ Duration</string>
@@ -23,7 +24,7 @@
     <!-- Settings -->
     <string name="credentials_title">🔐 Credentials</string>
     <string name="credentials_description">Sign In by providing necessary credentials.</string>
-    <string name="credentials_instructions">Jira API token is used to sync your profile and search issues. Tempo API token is used to synchronize worklogs with Tempo.\nInstructions on how to generate TBD.</string>
+    <string name="credentials_instructions_md">Jira API token is used to sync your profile and search issues. Tempo API token is used to synchronize worklogs with Tempo. [Instructions here](https://github.com/matejsemancik/tempo-timer?tab=readme-ov-file#getting-started).</string>
     <string name="jira_url">Jira URL</string>
     <string name="jira_email">Atlassian account e-mail</string>
     <string name="jira_email_placeholder">you@corporate.org</string>

shared/src/commonMain/kotlin/dev/matsem/bpm/data/mapping/ReleaseMapping.kt

@@ -0,0 +1,10 @@
+package dev.matsem.bpm.data.mapping
+
+import dev.matsem.bpm.data.repo.model.AppVersion
+import dev.matsem.bpm.data.service.github.model.Release as ApiRelease
+
+fun ApiRelease.toAppVersion(): AppVersion = AppVersion(
+    version = tagName.removePrefix("v"),
+    name = name,
+    releaseUrl = htmlUrl
+)

shared/src/commonMain/kotlin/dev/matsem/bpm/data/repo/GitHubRepo.kt

@@ -0,0 +1,18 @@
+package dev.matsem.bpm.data.repo
+
+import dev.matsem.bpm.data.mapping.toAppVersion
+import dev.matsem.bpm.data.repo.model.AppVersion
+import dev.matsem.bpm.data.service.github.GitHubApiManager
+
+interface GitHubRepo {
+    suspend fun getLatestAppVersion(): AppVersion
+}
+
+class GitHubRepoImpl(
+    private val gitHubApiManager: GitHubApiManager
+) : GitHubRepo {
+    
+    override suspend fun getLatestAppVersion(): AppVersion {
+        return gitHubApiManager.getLatestRelease().toAppVersion()
+    }
+}

shared/src/commonMain/kotlin/dev/matsem/bpm/data/repo/model/AppVersion.kt

@@ -0,0 +1,7 @@
+package dev.matsem.bpm.data.repo.model
+
+data class AppVersion(
+    val version: String,
+    val name: String?,
+    val releaseUrl: String,
+)