Merge pull request #53 from VahidGarousi/43-add-detekt-task

Adding Detekt for #43
VahidGarousi · Jan 27, 2023 · 794c55e · 794c55e
2 parents 9252053 + d5f0696
commit 794c55e
Show file tree

Hide file tree

Showing 22 changed files with 811 additions and 52 deletions.
diff --git a/.github/workflows/android_build.yml b/.github/workflows/android_build.yml
@@ -21,4 +21,7 @@ jobs:
         run: chmod +x ./gradlew
 
       - name: Build Project
-        run: ./gradlew assemble
+        run: ./gradlew assemble
+
+      - name: Static Analysis
+        run: ./gradlew ktlintCheck detekt
diff --git a/...rc/main/java/dev/garousi/stockwatcher/feature/watchlist/data/EmptySubscriptionListener.kt b/...rc/main/java/dev/garousi/stockwatcher/feature/watchlist/data/EmptySubscriptionListener.kt
@@ -1,3 +1,4 @@
+@file:Suppress("TooManyFunctions")
 package dev.garousi.stockwatcher.feature.watchlist.data
 
 import com.lightstreamer.client.ItemUpdate

diff --git a/app/src/main/java/dev/garousi/stockwatcher/feature/watchlist/data/LightStreamerConnection.kt b/app/src/main/java/dev/garousi/stockwatcher/feature/watchlist/data/LightStreamerConnection.kt
@@ -1,3 +1,5 @@
+@file:Suppress("LongParameterList", "TooManyFunctions")
+
 package dev.garousi.stockwatcher.feature.watchlist.data
 
 import android.util.Log

diff --git a/app/src/main/java/dev/garousi/stockwatcher/feature/watchlist/data/StatefulData.kt b/app/src/main/java/dev/garousi/stockwatcher/feature/watchlist/data/StatefulData.kt
@@ -4,6 +4,7 @@ import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.catch
 import kotlinx.coroutines.flow.onEach
 import kotlinx.coroutines.flow.transform
+
 sealed class StatefulData<out T : Any> {
     data class Success<T : Any>(val result: T) : StatefulData<T>()
     data class Error(val msg: String) : StatefulData<Nothing>()
@@ -35,14 +36,23 @@ fun <T : Any> Flow<T>.wrapWithStatefulData(): Flow<StatefulData<T>> = transform
     return@transform emit(StatefulData.Success(value))
 }
 
-inline fun <T : Any, R : Any> Flow<StatefulData<T>>.mapState(crossinline transform: suspend (value: T) -> R): Flow<StatefulData<R>> = transform { value ->
-    return@transform emit(value.suspendMap(transform))
-}
+inline fun <T : Any, R : Any> Flow<StatefulData<T>>.mapState(
+    crossinline transform: suspend (value: T) -> R
+): Flow<StatefulData<R>> =
+    transform { value ->
+        return@transform emit(value.suspendMap(transform))
+    }
 
-inline fun <T : Any> Flow<StatefulData<T>>.onSuccessState(crossinline action: suspend (value: T) -> Unit): Flow<StatefulData<T>> = onEach {
-    if (it is StatefulData.Success) action(it.result)
-}
+inline fun <T : Any> Flow<StatefulData<T>>.onSuccessState(
+    crossinline action: suspend (value: T) -> Unit
+): Flow<StatefulData<T>> =
+    onEach {
+        if (it is StatefulData.Success) action(it.result)
+    }
 
-inline fun <T : Any> Flow<StatefulData<T>>.onErrorState(crossinline action: suspend (error: String) -> Unit): Flow<StatefulData<T>> = onEach {
-    if (it is StatefulData.Error) action(it.msg)
-}
+inline fun <T : Any> Flow<StatefulData<T>>.onErrorState(
+    crossinline action: suspend (error: String) -> Unit
+): Flow<StatefulData<T>> =
+    onEach {
+        if (it is StatefulData.Error) action(it.msg)
+    }
diff --git a/app/src/main/java/dev/garousi/stockwatcher/feature/watchlist/data/SubscriptionMode.kt b/app/src/main/java/dev/garousi/stockwatcher/feature/watchlist/data/SubscriptionMode.kt
@@ -1,6 +1,7 @@
+@file:Suppress("UnusedPrivateMember")
 package dev.garousi.stockwatcher.feature.watchlist.data
 
-enum class SubscriptionMode(mode: String) {
-    Merge("MERGE"),
-    Command("COMMAND"),
+enum class SubscriptionMode {
+    Merge,
+    Command,
 }
diff --git a/app/src/main/java/dev/garousi/stockwatcher/feature/watchlist/di/LightStreamerModule.kt b/app/src/main/java/dev/garousi/stockwatcher/feature/watchlist/di/LightStreamerModule.kt
@@ -1,3 +1,5 @@
+@file:Suppress("UnnecessaryAbstractClass")
+
 package dev.garousi.stockwatcher.feature.watchlist.di
 
 import dagger.Binds

diff --git a/app/src/main/java/dev/garousi/stockwatcher/feature/watchlist/di/StockRepositoryModule.kt b/app/src/main/java/dev/garousi/stockwatcher/feature/watchlist/di/StockRepositoryModule.kt
@@ -1,3 +1,4 @@
+@file:Suppress("UnnecessaryAbstractClass")
 package dev.garousi.stockwatcher.feature.watchlist.di
 
 import dagger.Binds

diff --git a/app/src/main/java/dev/garousi/stockwatcher/feature/watchlist/presentation/StockItem.kt b/app/src/main/java/dev/garousi/stockwatcher/feature/watchlist/presentation/StockItem.kt
@@ -1,3 +1,5 @@
+@file:Suppress("MagicNumber", "LongMethod", "FunctionNaming", "CyclomaticComplexMethod")
+
 package dev.garousi.stockwatcher.feature.watchlist.presentation
 
 import androidx.compose.foundation.layout.Arrangement
@@ -159,7 +161,10 @@ fun StockItem(
                     textAlign = TextAlign.Center,
                 )
                 Icon(
-                    imageVector = if (stock.change > 0) Icons.Filled.KeyboardArrowUp else Icons.Filled.KeyboardArrowDown,
+                    imageVector = if (stock.change > 0)
+                        Icons.Filled.KeyboardArrowUp
+                    else
+                        Icons.Filled.KeyboardArrowDown,
                     contentDescription = null,
                     tint = if (stock.change > 0) Color(0XFF48BE62) else Color(0XFFBE4848),
                     modifier = Modifier

diff --git a/app/src/main/java/dev/garousi/stockwatcher/feature/watchlist/presentation/StockList.kt b/app/src/main/java/dev/garousi/stockwatcher/feature/watchlist/presentation/StockList.kt
@@ -1,3 +1,4 @@
+@file:Suppress("FunctionNaming")
 package dev.garousi.stockwatcher.feature.watchlist.presentation
 
 import androidx.compose.foundation.Image
@@ -40,7 +41,7 @@ fun StockList(
         ) {
             itemsIndexed(
                 items = stocks,
-                key = { index, item -> item.itemName },
+                key = { _, item -> item.itemName },
             ) { index, stock ->
                 StockItem(
                     stock = stock,

diff --git a/app/src/main/java/dev/garousi/stockwatcher/feature/watchlist/presentation/WatchlistScreen.kt b/app/src/main/java/dev/garousi/stockwatcher/feature/watchlist/presentation/WatchlistScreen.kt
@@ -1,3 +1,5 @@
+@file:Suppress("FunctionNaming", "LongParameterList")
+
 package dev.garousi.stockwatcher.feature.watchlist.presentation
 
 import androidx.compose.animation.AnimatedVisibility
@@ -26,7 +28,6 @@ import androidx.compose.material.primarySurface
 import androidx.compose.runtime.Composable
 import androidx.compose.runtime.collectAsState
 import androidx.compose.runtime.getValue
-import androidx.compose.ui.Alignment
 import androidx.compose.ui.Alignment.Companion.Center
 import androidx.compose.ui.Alignment.Companion.CenterVertically
 import androidx.compose.ui.Modifier
@@ -130,26 +131,3 @@ private fun WatchlistTopAppBar(
         )
     }
 }
-
-@Composable
-private fun LoadingView() {
-    Box(
-        modifier = Modifier.fillMaxSize(),
-    ) {
-        CircularProgressIndicator(
-            modifier = Modifier.align(Alignment.Center),
-        )
-    }
-}
-
-@Composable
-private fun ErrorView() {
-    Box(
-        modifier = Modifier.fillMaxSize(),
-    ) {
-        Text(
-            text = "Error Happened",
-            modifier = Modifier.align(Alignment.Center),
-        )
-    }
-}
diff --git a/app/src/main/java/dev/garousi/stockwatcher/feature/watchlist/presentation/WatchlistState.kt b/app/src/main/java/dev/garousi/stockwatcher/feature/watchlist/presentation/WatchlistState.kt
@@ -1,3 +1,4 @@
+@file:Suppress("MagicNumber", "ForEachOnRange")
 package dev.garousi.stockwatcher.feature.watchlist.presentation
 
 import dev.garousi.stockwatcher.feature.watchlist.domain.models.Stock

diff --git a/...c/main/java/dev/garousi/stockwatcher/feature/watchlist/presentation/WatchlistViewModel.kt b/...c/main/java/dev/garousi/stockwatcher/feature/watchlist/presentation/WatchlistViewModel.kt
@@ -1,3 +1,4 @@
+@file:Suppress("CyclomaticComplexMethod")
 package dev.garousi.stockwatcher.feature.watchlist.presentation
 
 import android.util.Log
@@ -32,9 +33,6 @@ class WatchlistViewModel @Inject constructor(
         stockListLightStreamerService
             .subscribe()
             .flow
-            .catch { cause: Throwable ->
-                Log.i("LOGGER", "" + cause.localizedMessage.orEmpty())
-            }
             .map { stock ->
                 _uiState.update { it.copy(isLoading = false) }
                 stock.itemPos?.let { updatedItemIndex ->
@@ -60,6 +58,9 @@ class WatchlistViewModel @Inject constructor(
                     }
                 }
             }
+            .catch { cause: Throwable ->
+                Log.i("LOGGER", "" + cause.localizedMessage.orEmpty())
+            }
             .stateIn(
                 scope = viewModelScope,
                 initialValue = StockListDto(),

diff --git a/app/src/main/java/dev/garousi/stockwatcher/navigation/JankStatsExtensions.kt b/app/src/main/java/dev/garousi/stockwatcher/navigation/JankStatsExtensions.kt
@@ -1,3 +1,4 @@
+@file:Suppress("FunctionNaming")
 /*
  * Copyright 2022 The Android Open Source Project
  *

diff --git a/app/src/main/java/dev/garousi/stockwatcher/navigation/StockWatcherNavHost.kt b/app/src/main/java/dev/garousi/stockwatcher/navigation/StockWatcherNavHost.kt
@@ -1,3 +1,4 @@
+@file:Suppress("FunctionNaming")
 package dev.garousi.stockwatcher.navigation
 
 import androidx.compose.runtime.Composable
@@ -8,7 +9,6 @@ import androidx.navigation.compose.NavHost
 @Composable
 fun StockWatcherNavHost(
     navController: NavHostController,
-    onBackClick: () -> Unit,
     modifier: Modifier = Modifier,
     startDestination: String = watchlistGraphRoutePattern,
 ) {

diff --git a/app/src/main/java/dev/garousi/stockwatcher/ui/StockWatcherApp.kt b/app/src/main/java/dev/garousi/stockwatcher/ui/StockWatcherApp.kt
@@ -1,3 +1,4 @@
+@file:Suppress("FunctionNaming")
 package dev.garousi.stockwatcher.ui
 
 import androidx.compose.foundation.layout.Column
@@ -32,8 +33,6 @@ fun StockWatcherApp(
                 testTagsAsResourceId = true
             },
         bottomBar = {
-            if (appState.shouldShowBottomBar) {
-            }
         },
     ) { padding ->
         Row(
@@ -49,12 +48,8 @@ fun StockWatcherApp(
         ) {
             Column(Modifier.fillMaxSize()) {
                 // Show the top app bar on top level destinations.
-                val destination = appState.currentTopLevelDestination
-                if (destination != null) {
-                }
                 StockWatcherNavHost(
-                    navController = appState.navController,
-                    onBackClick = appState::onBackClick,
+                    navController = appState.navController
                 )
             }
         }

diff --git a/app/src/main/java/dev/garousi/stockwatcher/ui/StockWatcherAppState.kt b/app/src/main/java/dev/garousi/stockwatcher/ui/StockWatcherAppState.kt
@@ -1,3 +1,4 @@
+@file:Suppress("FunctionNaming")
 package dev.garousi.stockwatcher.ui
 
 import androidx.compose.runtime.Composable

diff --git a/app/src/main/java/dev/garousi/stockwatcher/ui/theme/Color.kt b/app/src/main/java/dev/garousi/stockwatcher/ui/theme/Color.kt
@@ -1,3 +1,4 @@
+@file:Suppress("MagicNumber")
 package dev.garousi.stockwatcher.ui.theme
 
 import androidx.compose.ui.graphics.Color

diff --git a/app/src/main/java/dev/garousi/stockwatcher/ui/theme/Theme.kt b/app/src/main/java/dev/garousi/stockwatcher/ui/theme/Theme.kt
@@ -1,3 +1,4 @@
+@file:Suppress("MagicNumber", "FunctionNaming")
 package dev.garousi.stockwatcher.ui.theme
 
 import androidx.compose.foundation.isSystemInDarkTheme

diff --git a/build.gradle b/build.gradle
@@ -9,10 +9,13 @@ plugins {
     id 'org.jetbrains.kotlin.android' version '1.7.20' apply false
     id 'com.google.dagger.hilt.android' version '2.44.2' apply false
     id "com.github.ben-manes.versions" version "0.44.0"
-    id "com.diffplug.spotless" version "6.12.1"
+//    id "com.diffplug.spotless" version "6.12.1"
+    id "io.gitlab.arturbosch.detekt" version "1.22.0"
+    id "org.jlleitschuh.gradle.ktlint" version "10.2.0"
 }
 
 subprojects {
+    apply from: "../buildscripts/ktlint.gradle"
+    apply from: "../buildscripts/detekt.gradle"
     apply from: "../buildscripts/versionsplugin.gradle"
-    apply from: "../buildscripts/spotless.gradle"
 }
diff --git a/buildscripts/detekt.gradle b/buildscripts/detekt.gradle
@@ -0,0 +1,14 @@
+apply plugin: "io.gitlab.arturbosch.detekt"
+
+detekt {
+    config = files("${rootProject.rootDir}/config/detekt/detekt.yml")
+}
+
+
+tasks.named("detekt").configure {
+    reports {
+        html.enabled = true
+        xml.enabled = true
+        txt.enabled = true
+    }
+}
diff --git a/buildscripts/ktlint.gradle b/buildscripts/ktlint.gradle
@@ -0,0 +1,14 @@
+apply plugin: "org.jlleitschuh.gradle.ktlint"
+
+ktlint {
+    // https://github.com/pinterest/ktlint/releases
+    version = "0.45.2"
+
+    reporters {
+        reporter "plain"
+        reporter "checkstyle"
+        reporter "html"
+    }
+
+    outputColorName = "RED"
+}