Merge pull request #20 from gravatar/hamorillo/13-detekt

Adding Detekt for static code analysis
Automattic · Jan 17, 2024 · f4cc942 · f4cc942
2 parents 108eca9 + 96b1c87
commit f4cc942
Show file tree

Hide file tree

Showing 8 changed files with 93 additions and 3 deletions.
diff --git a/.github/workflows/android.yml b/.github/workflows/android.yml
@@ -24,5 +24,7 @@ jobs:
       run: chmod +x gradlew
     - name: Check code style
       run: ./gradlew ktlintcheck
+    - name: Static code analysis
+      run: ./gradlew detekt
     - name: Build with Gradle
       run: ./gradlew build
diff --git a/README.md b/README.md
@@ -25,4 +25,15 @@ You can also try to let Ktlint fix the code style issues. Just use:
 ./gradlew ktlintFormat
 ./gradlew :gravatar:ktlintFormat
 ./gradlew :app:ktlintFormat
+```
+
+## Code static analysis
+
+We use [Detekt](https://github.com/detekt/detekt) to perform static code analysis. You can run
+Detekt via a gradle command:
+
+```
+./gradlew detekt
+./gradlew :gravatar:detekt
+./gradlew :app:detekt
 ```
diff --git a/app/build.gradle.kts b/app/build.gradle.kts
@@ -4,6 +4,9 @@ plugins {
 
     // Ktlint
     id("org.jlleitschuh.gradle.ktlint")
+
+    // Detekt
+    id("io.gitlab.arturbosch.detekt")
 }
 
 android {
@@ -33,6 +36,13 @@ android {
     kotlinOptions {
         jvmTarget = "1.8"
     }
+    detekt {
+        config.setFrom("${project.rootDir}/config/detekt/detekt.yml")
+        source.setFrom("src")
+        autoCorrect = false
+        buildUponDefaultConfig = true
+        parallel = false
+    }
 }
 
 dependencies {

diff --git a/build.gradle.kts b/build.gradle.kts
@@ -5,4 +5,7 @@ plugins {
 
     // Ktlint
     id("org.jlleitschuh.gradle.ktlint") version "12.1.0" apply false
-}
+
+    // Detekt
+    id("io.gitlab.arturbosch.detekt") version "1.23.4" apply false
+}
diff --git a/config/detekt/detekt.yml b/config/detekt/detekt.yml
@@ -0,0 +1,42 @@
+# Default Config: https://github.com/detekt/detekt/blob/main/detekt-core/src/main/resources/default-detekt-config.yml
+# Formatting Config: https://github.com/detekt/detekt/blob/main/detekt-formatting/src/main/resources/config/config.yml
+# Compose Config: https://detekt.dev/docs/introduction/compose/
+
+config:
+  warningsAsErrors: true
+
+complexity:
+  LongParameterList:
+    ignoreDefaultParameters: true
+    ignoreAnnotated: ['Inject', 'Composable']
+  LongMethod:
+    ignoreAnnotated: ['Composable']
+  TooManyFunctions:
+    active: false
+  CyclomaticComplexMethod:
+    ignoreSimpleWhenEntries: true
+
+coroutines:
+  GlobalCoroutineUsage:
+    active: true
+
+naming:
+  FunctionNaming:
+    ignoreAnnotated: ['Composable']
+
+style:
+  DataClassShouldBeImmutable:
+    active: true
+  MagicNumber:
+    ignoreEnums: true
+    ignoreAnnotated: ['Composable']
+    ignorePropertyDeclaration: true
+  SpacingBetweenPackageAndImports:
+    active: true
+  UnusedImports:
+    active: true
+  UnusedPrivateMember:
+    ignoreAnnotated: ['Preview']
+  WildcardImport:
+    active: true
+    excludeImports: []
diff --git a/gravatar/build.gradle.kts b/gravatar/build.gradle.kts
@@ -4,6 +4,9 @@ plugins {
 
     // Ktlint
     id("org.jlleitschuh.gradle.ktlint")
+
+    // Detekt
+    id("io.gitlab.arturbosch.detekt")
 }
 
 android {
@@ -32,6 +35,14 @@ android {
     kotlinOptions {
         jvmTarget = "1.8"
     }
+
+    detekt {
+        config.setFrom("${project.rootDir}/config/detekt/detekt.yml")
+        source.setFrom("src")
+        autoCorrect = false
+        buildUponDefaultConfig = true
+        parallel = true
+    }
 }
 
 dependencies {

diff --git a/gravatar/src/main/java/com/gravatar/GravatarApi.kt b/gravatar/src/main/java/com/gravatar/GravatarApi.kt
@@ -62,8 +62,8 @@ class GravatarApi(okHttpClient: OkHttpClient? = null) {
                             Log.w(LOG_TAG, "Network call unsuccessful trying to upload Gravatar: $response.body")
                             val error: ErrorType =
                                 when (response.code()) {
-                                    408 -> ErrorType.TIMEOUT
-                                    in 500..599 -> ErrorType.SERVER
+                                    HttpResponseCode.HTTP_CLIENT_TIMEOUT -> ErrorType.TIMEOUT
+                                    in HttpResponseCode.SERVER_ERRORS -> ErrorType.SERVER
                                     else -> ErrorType.UNKNOWN
                                 }
                             gravatarUploadListener.onError(error)

diff --git a/gravatar/src/main/java/com/gravatar/HttpResponseCode.kt b/gravatar/src/main/java/com/gravatar/HttpResponseCode.kt
@@ -0,0 +1,11 @@
+package com.gravatar
+
+object HttpResponseCode {
+    // 4xx codes
+    const val HTTP_CLIENT_TIMEOUT = 408
+
+    // 5xx codes
+    private const val HTTP_INTERNAL_ERROR = 500
+    private const val NETWORK_CONNECT_TIMEOUT_ERROR = 599
+    val SERVER_ERRORS = HTTP_INTERNAL_ERROR..NETWORK_CONNECT_TIMEOUT_ERROR
+}