Add detekt

.github/workflows/build.yml

@@ -0,0 +1,29 @@
+name: Build Project
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Java 17
+        uses: actions/setup-java@v4
+        with:
+          java-version: '17'
+          distribution: 'adopt'
+
+      - name: Decode google-services.json
+        env:
+          GOOGLE_SERVICES_JSON: ${{ secrets.GOOGLE_SERVICES_JSON }}
+        run: echo "$GOOGLE_SERVICES_JSON" | base64 --decode > app/google-services.json
+
+      - name: Grant execute permission for gradlew
+        run: chmod +x ./gradlew
+
+      - name: Build gradle project
+        run: ./gradlew build

.github/workflows/code_analysis.yml

@@ -0,0 +1,29 @@
+name: Code Analysis
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+jobs:
+  detekt:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Java 17
+        uses: actions/setup-java@v4
+        with:
+          java-version: '17'
+          distribution: 'adopt'
+
+      - name: Decode google-services.json
+        env:
+          GOOGLE_SERVICES_JSON: ${{ secrets.GOOGLE_SERVICES_JSON }}
+        run: echo "$GOOGLE_SERVICES_JSON" | base64 --decode > app/google-services.json
+
+      - name: Grant execute permission for gradlew
+        run: chmod +x ./gradlew
+
+      - name: Run Detekt
+        run: ./gradlew detekt

.github/workflows/unit_tests.yml

@@ -0,0 +1,29 @@
+name: Unit Tests
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Java 17
+        uses: actions/setup-java@v4
+        with:
+          java-version: '17'
+          distribution: 'adopt'
+
+      - name: Decode google-services.json
+        env:
+          GOOGLE_SERVICES_JSON: ${{ secrets.GOOGLE_SERVICES_JSON }}
+        run: echo "$GOOGLE_SERVICES_JSON" | base64 --decode > app/google-services.json
+
+      - name: Grant execute permission for gradlew
+        run: chmod +x ./gradlew
+
+      - name: Run Unit Tests
+        run: ./gradlew test

app/src/main/java/com/grappim/hateitorrateit/core/LaunchedEffectResult.kt

@@ -8,4 +8,4 @@ import java.time.Instant
 data class LaunchedEffectResult<T>(
     val data: T,
     val timestamp: Long = Instant.now().toEpochMilli()
-)
+)

app/src/main/java/com/grappim/hateitorrateit/core/NativeText.kt

@@ -13,6 +13,7 @@ sealed class NativeText {
     data class Multi(val text: List<NativeText>) : NativeText()
 }
 
+@Suppress("SpreadOperator")
 fun NativeText.asString(context: Context): String {
     return when (this) {
         is NativeText.Arguments -> context.getString(id, *args.toTypedArray())
@@ -32,4 +33,4 @@ fun NativeText.asString(context: Context): String {
         is NativeText.Simple -> text
         is NativeText.Empty -> ""
     }
-}
+}

app/src/main/java/com/grappim/hateitorrateit/core/SharingStartedViews.kt

@@ -2,7 +2,7 @@ package com.grappim.hateitorrateit.core
 
 import kotlinx.coroutines.flow.SharingStarted
 
-private const val StopTimeoutMillis: Long = 5000
+private const val STOP_TIMEOUT_MILLIS: Long = 5000
 
 /**
  * A [SharingStarted] meant to be used with a [StateFlow] to expose data to a view.
@@ -13,4 +13,4 @@ private const val StopTimeoutMillis: Long = 5000
  * back, the latest value is replayed and the upstream flows are executed again. This is done to
  * save resources when the app is in the background but let users switch between apps quickly.
  */
-val WhileViewSubscribed: SharingStarted = SharingStarted.WhileSubscribed(StopTimeoutMillis)
+val WhileViewSubscribed: SharingStarted = SharingStarted.WhileSubscribed(STOP_TIMEOUT_MILLIS)

app/src/main/java/com/grappim/hateitorrateit/core/SnackbarStateView.kt

@@ -30,4 +30,4 @@ class SnackbarStateViewModelImpl : SnackbarStateViewModel {
             )
         )
     }
-}
+}

app/src/main/java/com/grappim/hateitorrateit/core/navigation/HomeNavDestination.kt

@@ -19,5 +19,4 @@ sealed interface HomeNavDestination {
         override val title: String = "Settings"
         override val imageVector: ImageVector = PlatoIconType.Settings.imageVector
     }
-
-}
+}

app/src/main/java/com/grappim/hateitorrateit/core/navigation/RootNavDestinations.kt

@@ -27,4 +27,4 @@ sealed interface RootNavDestinations {
         override val route: String = "${PREFIX}?productId={$KEY_PRODUCT_ID}&index={$KEY_INDEX}"
         fun getRouteWithUri(productId: String, index: Int) = "${PREFIX}?productId=$productId&index=$index"
     }
-}
+}

app/src/main/java/com/grappim/hateitorrateit/core/startup/LoggerInitializer.kt

@@ -35,11 +35,12 @@ private class DevelopmentTree : Timber.DebugTree() {
 
 private class ProductionTree : Timber.Tree() {
 
+    @Suppress("EmptyFunctionBlock")
     override fun log(
         priority: Int,
         tag: String?,
         message: String,
         t: Throwable?
     ) {
     }
-}
+}

app/src/main/java/com/grappim/hateitorrateit/model/ProcuctDetailsImageUi.kt → app/src/main/java/com/grappim/hateitorrateit/model/ProductDetailsImageUi.kt

@@ -2,6 +2,6 @@ package com.grappim.hateitorrateit.model
 
 import com.grappim.hateitorrateit.domain.ProductImageData
 
-data class ProcuctDetailsImageUi(
+data class ProductDetailsImageUi(
     val filesUri: List<ProductImageData> = emptyList(),
-)
+)

app/src/main/java/com/grappim/hateitorrateit/model/UiModelsMapper.kt

@@ -43,9 +43,9 @@ class UiModelsMapper @Inject constructor(
         )
     }
 
-    suspend fun toProductDetailsImageUI(product: Product): ProcuctDetailsImageUi =
+    suspend fun toProductDetailsImageUI(product: Product): ProductDetailsImageUi =
         withContext(ioDispatcher) {
-            ProcuctDetailsImageUi(
+            ProductDetailsImageUi(
                 filesUri = product.filesUri,
             )
         }

app/src/main/java/com/grappim/hateitorrateit/ui/screens/details/DetailsScreen.kt

@@ -68,6 +68,8 @@ const val DETAILS_TOP_APP_BAR_TAG = "details_top_app_bar_tag"
 const val DETAILS_EDIT_CONTENT_TAG = "details_edit_content_tag"
 const val DETAILS_DEMONSTRATION_CONTENT_TAG = "details_demonstration_content_tag"
 
+private const val TOP_APP_BAR_WEIGHT = 1.2f
+
 @Composable
 fun DetailsRoute(
     viewModel: DetailsViewModel = hiltViewModel(),
@@ -138,7 +140,7 @@ private fun DetailsScreenContent(
         TopAppBarContent(
             modifier = Modifier
                 .fillMaxWidth()
-                .weight(1.2f),
+                .weight(TOP_APP_BAR_WEIGHT),
             state = state,
             onImageClicked = onImageClicked,
             goBack = goBack,

app/src/main/java/com/grappim/hateitorrateit/ui/screens/rateorhate/HateOrRateScreen.kt

@@ -219,7 +219,7 @@ private fun RateOrHateScreenContent(
                     .fillMaxWidth()
                     .padding(
                         top = 12.dp,
-                        bottom = 16.dp
+                        bottom = 16.dp,
                     )
                     .padding(horizontal = 16.dp),
                 state = state

app/src/main/java/com/grappim/hateitorrateit/ui/screens/settings/SettingsScreen.kt

@@ -30,6 +30,8 @@ import com.grappim.hateitorrateit.ui.widgets.PlatoTopBar
 const val CROSSFADE_TAG = "crossfade_tag"
 const val CRASHLYTICS_TILE_TAG = "crashlytics_tile_tag"
 
+private const val ANIMATION_DURATION = 500
+
 @Composable
 internal fun SettingsRoute(
     goBack: () -> Unit,
@@ -117,7 +119,7 @@ fun TypeIcon(
     Crossfade(
         targetState = state.type,
         label = "type_crossfade_icon",
-        animationSpec = tween(500),
+        animationSpec = tween(ANIMATION_DURATION),
     ) { type ->
         Icon(
             modifier = Modifier
@@ -137,7 +139,7 @@ fun CrashesIcon(
         modifier = Modifier.testTag(CROSSFADE_TAG),
         targetState = state.isCrashesCollectionEnabled,
         label = "custom_switch_label",
-        animationSpec = tween(500),
+        animationSpec = tween(ANIMATION_DURATION),
     ) { enabled ->
         val imageVector = if (enabled) {
             PlatoIconType.CheckCircleOutline.imageVector

app/src/main/java/com/grappim/hateitorrateit/ui/screens/settings/SettingsViewState.kt

@@ -14,6 +14,7 @@ data class SettingsViewState(
     val onDismissDialog: () -> Unit,
     val onCrashlyticsToggle: () -> Unit
 ) {
+    @Suppress("LongParameterList")
     fun safeCopy(
         isLoading: Boolean = this.isLoading,
         type: HateRateType = this.type,

build.gradle.kts

@@ -6,4 +6,17 @@ plugins {
     alias(libs.plugins.gms.googleServices) apply false
     alias(libs.plugins.hilt.android) apply false
     alias(libs.plugins.ksp) apply false
+    alias(libs.plugins.detekt)
+}
+
+subprojects {
+    apply {
+        plugin("io.gitlab.arturbosch.detekt")
+    }
+
+    detekt {
+        parallel = true
+        config.setFrom(rootProject.files("config/detekt/detekt.yml"))
+        allRules = false
+    }
 }

commons/src/main/java/com/grappim/hateitorrateit/commons/CoroutinesModule.kt

@@ -50,4 +50,4 @@ class CoroutinesModule {
     fun provideApplicationScope(
         @DefaultDispatcher defaultDispatcher: CoroutineDispatcher
     ): CoroutineScope = CoroutineScope(SupervisorJob() + defaultDispatcher)
-}
+}