Merge pull request #5 from thepeerstack/feature/code-quality

Setup Ktlint

Author: kamsy

.github/workflows/android.yml

@@ -23,12 +23,8 @@ jobs:
       - name: Grant execute permission for gradlew
         run: chmod +x gradlew
 
-#     This will be enabled after the code-quality PR is merged
-#      - name: Run Ktlint
-#        uses: lucasnlm/ktlint-action@master
-#
-#      - name: Check code quality
-#        run: ./gradlew thepeer-android:ktlint
+      - name: Check code quality with Ktlint
+        run: ./gradlew thepeer-android:ktlint --stacktrace
 
       - name: Build thepeer-android library
         run: ./gradlew thepeer-android:build

.github/workflows/publish.yml

@@ -22,7 +22,7 @@ jobs:
       - id: get_version
         uses: battila7/get-version-action@v2
       - name: Get version from tag
-        run: echo ${{ teps.get_version.outputs.version-without-v }}
+        run: echo ${{ steps.get_version.outputs.version-without-v }}
 
 
         # Builds the release artifacts of the library

build.gradle

@@ -22,13 +22,9 @@ task clean(type: Delete) {
 }
 
 ext {
-    // Compose
-    composeVersion = '1.1.1'
-    constraintLayoutComposeVersion = '1.0.0-rc01'
-    activityComposeVersion = '1.4.0'
-    accompanistPagerVersion = '0.20.0'
-    composeNavigationVersion = '2.3.0'
-    composeViewModelVersion = '2.4.0'
+
+    //ktlint
+    ktlintVersion = '0.46.1'
 
     // Coroutine
     coroutineVersion = '1.5.2'
@@ -42,11 +38,6 @@ ext {
     moshiAdaptersVersion = '1.12.0'
     moshiKotlinVersion = '1.12.0'
 
-    // Retrofit
-    retrofitVersion = '2.9.0'
-    retrofitMoshiConverterVersion = '2.9.0'
-    loggingInterceptorVersion = '4.9.2'
-
     // Mockk
     mockkVersion = '1.12.0'
 

scripts/publish-module.gradle

@@ -52,6 +52,16 @@ afterEvaluate {
                         }
                     }
                     developers {
+                        developer {
+                            id = 'zsmb13'
+                            name = 'Kamsi Oleka'
+                            email = 'kamsy@thepeer.co'
+                        }
+                        developer {
+                            id = 'zsmb14'
+                            name = 'Nsikak Thompson'
+                            email = 'nsikakthompson73@gmail.com'
+                        }
                         // Add all other devs here...
                     }
 

thepeer-android/build.gradle

@@ -80,4 +80,5 @@ ext {
     PUBLISH_ARTIFACT_ID = 'thepeer-android'
 }
 
-apply from: "${rootProject.projectDir}/scripts/publish-module.gradle"
+apply from: "${rootProject.projectDir}/scripts/publish-module.gradle"
+apply from: "$rootDir/thepeer-android/config/ktlint.gradle"

thepeer-android/config/ktlint.gradle

@@ -0,0 +1,34 @@
+configurations {
+    ktlint
+}
+
+dependencies {
+    ktlint("com.pinterest:ktlint:$ktlintVersion") {
+        attributes {
+            attribute(Bundling.BUNDLING_ATTRIBUTE, getObjects().named(Bundling, Bundling.EXTERNAL))
+        }
+    }
+}
+
+tasks.register("ktlint", JavaExec) {
+    group = "verification"
+    description = "Check Kotlin code style."
+    classpath = configurations.ktlint
+    main = "com.pinterest.ktlint.Main"
+    args "**/*.kt" , "!**/build/**/*.kt"
+}
+
+tasks.register("ktlintFormat", JavaExec) {
+    group = "formatting"
+    description = "Fix Kotlin code style deviations."
+    classpath = configurations.ktlint
+    main = "com.pinterest.ktlint.Main"
+    args "-F", "**/*.kt" , "!**/build/**/*.kt"
+}
+
+tasks.register("ktlintAndroidStudio", JavaExec) {
+    description = "Setup Android Studio to use the same code style as ktlint."
+    classpath = configurations.ktlint
+    main = "com.pinterest.ktlint.Main"
+    args "--android", "applyToIDEAProject", "-y"
+}

thepeer-android/src/androidTest/java/co/thepeer/sdk/ExampleInstrumentedTest.kt

@@ -1,13 +1,11 @@
 package co.thepeer.sdk
 
-import androidx.test.platform.app.InstrumentationRegistry
 import androidx.test.ext.junit.runners.AndroidJUnit4
-
+import androidx.test.platform.app.InstrumentationRegistry
+import junit.framework.Assert.assertEquals
 import org.junit.Test
 import org.junit.runner.RunWith
 
-import org.junit.Assert.*
-
 /**
  * Instrumented test, which will execute on an Android device.
  *
@@ -21,4 +19,4 @@ class ExampleInstrumentedTest {
         val appContext = InstrumentationRegistry.getInstrumentation().targetContext
         assertEquals("co.thepeer.sdk.test", appContext.packageName)
     }
-}
+}

thepeer-android/src/main/java/co/thepeer/sdk/Thepeer.kt

@@ -29,7 +29,7 @@ class Thepeer internal constructor(
     private var amount: BigDecimal,
     private var currency: String,
     private var userReference: String,
-    private var meta: Map<String, String> = emptyMap(),
+    private var meta: Map<String, String> = emptyMap()
 ) {
 
     /**
@@ -76,7 +76,6 @@ class Thepeer internal constructor(
             return this
         }
 
-
         fun setCurrency(currency: String): Builder {
             this.currency = currency
             return this
@@ -102,11 +101,9 @@ class Thepeer internal constructor(
                 userReference,
                 meta
             )
-
         }
     }
 
-
     /**
      * This function will be called to launch ThePeer Send Money Widget
      */
@@ -164,7 +161,6 @@ class Thepeer internal constructor(
         resultRegistry.launch(params)
     }
 
-
     private fun getSdkType(type: Enum<ThepeerSDKType>): String {
         return when (type) {
             ThepeerSDKType.SEND -> {
@@ -178,6 +174,5 @@ class Thepeer internal constructor(
             }
             else -> ""
         }
-
     }
-}
+}

thepeer-android/src/main/java/co/thepeer/sdk/model/ThePeerTransaction.kt

@@ -4,14 +4,12 @@ import android.os.Parcelable
 import kotlinx.parcelize.Parcelize
 import java.math.BigDecimal
 
-
 @Parcelize
 data class ThepeerEvent(
     val event: String,
     val data: ThepeerTransaction
 ) : Parcelable
 
-
 @Parcelize
 data class ThepeerTransaction(
     val id: String,
@@ -29,7 +27,6 @@ data class ThepeerTransaction(
 
 ) : Parcelable
 
-
 @Parcelize
 data class ThepeerUser(
     val name: String,
@@ -39,7 +36,6 @@ data class ThepeerUser(
     val reference: String?
 ) : Parcelable
 
-
 @Parcelize
 data class ThepeerBusiness(
     val name: String,
@@ -54,11 +50,10 @@ data class ThepeerCheckout(
     val status: String,
     val linked_account: LinkedAccount
 
-
 ) : Parcelable
 
 @Parcelize
 data class LinkedAccount(
     val user: ThepeerUser,
     val business: ThepeerBusiness
-) : Parcelable
+) : Parcelable

thepeer-android/src/main/java/co/thepeer/sdk/model/ThepeerParam.kt

@@ -15,8 +15,7 @@ data class ThepeerParam(
     val currency: String,
     val userReference: String,
     val emailAddress: String? = null,
-    val meta: Map<String, String>,
-): Parcelable
+    val meta: Map<String, String>
+) : Parcelable
 
-
-enum class ThepeerSDKType{SEND, CHECKOUT, DIRECT_CHARGE, NONE}
+enum class ThepeerSDKType { SEND, CHECKOUT, DIRECT_CHARGE, NONE }