Merge branch 'release/1.1.0' into main

Author: G00fY2

.github/workflows/android.yml

@@ -20,6 +20,15 @@ jobs:
       - name: Run detekt with ktlint
         run: ./gradlew detektBundledDebug detektUnbundledDebug
 
+  unit_tests:
+    name: Run unit tests
+    runs-on: ubuntu-20.04
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Run bundled and unbundled unit tests
+        run: ./gradlew test
+
   build_bundled:
     name: Build bundled debug
     runs-on: ubuntu-20.04

README.md

@@ -13,19 +13,19 @@ There are two different flavors available on `mavenCentral()`:
 
 | Bundled                             | Unbundled                                         |
 | ----------------------------------- | ------------------------------------------------- |
-| ML Kit model is bundled inside app (independent of Google Services) | ML Kit model will be automatically downloaded via Play Services (after app install) |
+| ML Kit model is bundled inside app (independent of Google Services) | ML Kit model will be automatically downloaded via Play Services (once after app install) |
 | additional 1.1 MB per ABI (you should use App Bundle or ABI splitting) | smaller app size |
 | V2 model is used (possibly faster, more accurate) | currently V1 model will be downloaded
 ```kotlin
 // bundled:  
-implementation("io.github.g00fy2.quickie:quickie-bundled:1.0.0")
+implementation("io.github.g00fy2.quickie:quickie-bundled:1.1.0")
 
 // unbundled:
-implementation("io.github.g00fy2.quickie:quickie-unbundled:1.0.0")
+implementation("io.github.g00fy2.quickie:quickie-unbundled:1.1.0")
 ```
 
 ## Quick Start
-To use the QR scanner simply register the `ScanQRCode()` ActivityResultContract together with a callback during `init` or `onCreate()` lifecycle of your Activity/Fragment and use the returned ActivityResultLauncher to launch the QR scanner activity.
+To use the QR scanner simply register the `ScanQRCode()` ActivityResultContract together with a callback during `init` or `onCreate()` lifecycle of your Activity/Fragment and use the returned ActivityResultLauncher to launch the QR scanner Activity.
 ```kotlin
 val scanQrCode = registerForActivityResult(ScanQRCode(), ::handleResult)
 
@@ -47,9 +47,9 @@ The callback you add to the `registerForActivityResult` will receive a subclass
 
 1. `QRSuccess` when ML Kit successfully detected a QR code
    * wraps a `QRContent` object
-1. `QRUserCanceled` when the activity got canceled by the user
+1. `QRUserCanceled` when the Activity got canceled by the user
 1. `QRMissingPermission` when the user didn't accept the camera permission
-1. `QRError` when CameraX or ML kit threw an exception
+1. `QRError` when CameraX or ML Kit threw an exception
    * wraps the `exception`
 
 ### Content
@@ -61,7 +61,49 @@ Currently, supported subtypes are:
 See the ML Kit [Barcode documentation](https://developers.google.com/android/reference/com/google/mlkit/vision/barcode/Barcode#nested-class-summary) for further details.
 
 ### Customization
-The library is designed to behave and look as generic as possible while matching Material Design guidelines. Currently, it's not possible to change the UI, but there are plans to add customizations in future releases.
+Use the `ScanCustomCode()` ActivityResultContract to create a configurable barcode scan. When launching the ActivityResultLauncher pass in a `ScannerConfig` object. You can set the supported `BarcodeFormat` list, `overlayStringRes` and `overlayDrawableRes` resource ID.
+
+<details>
+  <summary>BarcodeFormat options</summary>
+
+```kotlin
+BarcodeFormat.FORMAT_ALL_FORMATS
+BarcodeFormat.FORMAT_CODE_128
+BarcodeFormat.FORMAT_CODE_39
+BarcodeFormat.FORMAT_CODE_93
+BarcodeFormat.FORMAT_CODABAR
+BarcodeFormat.FORMAT_DATA_MATRIX
+BarcodeFormat.FORMAT_EAN_13
+BarcodeFormat.FORMAT_EAN_8
+BarcodeFormat.FORMAT_ITF
+BarcodeFormat.FORMAT_QR_CODE
+BarcodeFormat.FORMAT_UPC_A
+BarcodeFormat.FORMAT_UPC_E
+BarcodeFormat.FORMAT_PDF417
+BarcodeFormat.FORMAT_AZTEC
+```
+</details>
+
+```kotlin
+val scanCustomCode = registerForActivityResult(ScanCustomCode(), ::handleResult)
+
+override fun onCreate(savedInstanceState: Bundle?) {
+    super.onCreate(savedInstanceState)
+    …
+    binding.button.setOnClickListener {
+      scanCustomCode.launch(
+        ScannerConfig.build {
+          setBarcodeFormats(listOf(BarcodeFormat.FORMAT_CODE_128))
+          setOverlayStringRes(R.string.scan_barcode)
+          setOverlayDrawableRes(R.drawable.ic_scan_barcode)
+        }
+      )
+    }
+}
+
+fun handleResult(result: QRResult) {
+    …
+```
 
 ## Screenshots / Sample App
 You can find the sample app APKs inside the [release](https://github.com/G00fY2/quickie/releases) assets.

build.gradle.kts

@@ -28,9 +28,10 @@ subprojects {
   tasks.withType<KotlinCompile>().configureEach {
     kotlinOptions {
       allWarningsAsErrors = true
-      val arguments = mutableListOf("-progressive")
-      if (this@subprojects.name != "sample") arguments += "-Xexplicit-api=strict"
-      freeCompilerArgs = freeCompilerArgs + arguments
+      freeCompilerArgs = freeCompilerArgs + listOfNotNull(
+        "-progressive",
+        if (this@subprojects.name != "sample") "-Xexplicit-api=strict" else null,
+      )
       jvmTarget = "1.8"
     }
   }

buildSrc/src/main/kotlin/Deps.kt

@@ -1,10 +1,7 @@
 object Deps {
 
   object AndroidX {
-    const val activity = "androidx.activity:activity:${Versions.activity}"
-    const val fragment = "androidx.fragment:fragment:${Versions.fragment}"
     const val appcompat = "androidx.appcompat:appcompat:${Versions.appcompat}"
-    const val core = "androidx.core:core:${Versions.core}"
 
     const val camera = "androidx.camera:camera-camera2:${Versions.cameraX}"
     const val cameraLifecycle = "androidx.camera:camera-lifecycle:${Versions.cameraX}"
@@ -20,4 +17,9 @@ object Deps {
     const val barcodeScanningGms =
       "com.google.android.gms:play-services-mlkit-barcode-scanning:${Versions.barcodeScanningGms}"
   }
+
+  object Test {
+    const val junitApi = "org.junit.jupiter:junit-jupiter-api:${Versions.junit}"
+    const val junitEngine = "org.junit.jupiter:junit-jupiter-engine:${Versions.junit}"
+  }
 }

buildSrc/src/main/kotlin/Versions.kt

@@ -5,13 +5,10 @@ object Versions {
   const val androidTargetSdk = 30
   const val androidBuildTools = "30.0.3"
 
-  const val androidGradle = "4.2.0"
+  const val androidGradle = "4.2.1"
   const val kotlin = "1.5.0"
 
-  const val activity = "1.2.3"
-  const val fragment = "1.3.3"
-  const val appcompat = "1.2.0"
-  const val core = "1.3.2"
+  const val appcompat = "1.3.0"
 
   const val cameraX = "1.0.0"
   const val cameraView = "1.0.0-alpha24"
@@ -21,10 +18,12 @@ object Versions {
   const val barcodeScanning = "16.1.1"
   const val barcodeScanningGms = "16.1.4"
 
-  const val detekt = "1.17.0-RC2"
+  const val detekt = "1.17.1"
   const val gradleVersions = "0.38.0"
   const val dokka = "1.4.32"
 
+  const val junit = "5.7.2"
+
   fun maturityLevel(version: String): Int {
     val levels = listOf("alpha", "beta", "m", "rc")
     levels.forEachIndexed { index, s ->

config/detekt/detekt.yml

@@ -17,6 +17,10 @@ formatting:
   ParameterListWrapping:
     indentSize: 2
 
+performance:
+  SpreadOperator:
+    active: false
+
 style:
   MagicNumber:
     active: false

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.0-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.0.2-all.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

quickie/build.gradle.kts

@@ -24,27 +24,26 @@ android {
     getByName("main").java.srcDirs("src/main/kotlin")
     getByName("bundled").java.srcDirs("src/bundled/kotlin")
     getByName("unbundled").java.srcDirs("src/unbundled/kotlin")
+    getByName("test").java.srcDirs("src/test/kotlin")
   }
 }
 
-val bundledImplementation by configurations
-val unbundledImplementation by configurations
 dependencies {
-  implementation(Deps.AndroidX.activity)
-  implementation(Deps.AndroidX.fragment)
   implementation(Deps.AndroidX.appcompat)
-  implementation(Deps.AndroidX.core)
 
   implementation(Deps.AndroidX.camera)
   implementation(Deps.AndroidX.cameraLifecycle)
   implementation(Deps.AndroidX.cameraPreview)
 
-  bundledImplementation(Deps.MLKit.barcodeScanning)
-  unbundledImplementation(Deps.MLKit.barcodeScanningGms)
+  "bundledImplementation"(Deps.MLKit.barcodeScanning)
+  "unbundledImplementation"(Deps.MLKit.barcodeScanningGms)
+
+  testImplementation(Deps.Test.junitApi)
+  testRuntimeOnly(Deps.Test.junitEngine)
 }
 
 group = "io.github.g00fy2.quickie"
-version = "1.0.0"
+version = "1.1.0"
 
 tasks.register<Jar>("androidJavadocJar") {
   archiveClassifier.set("javadoc")
@@ -58,6 +57,12 @@ tasks.register<Jar>("androidSourcesJar") {
 }
 
 afterEvaluate {
+  tasks.withType<Test>().configureEach {
+    useJUnitPlatform()
+    testLogging.events("failed", "passed", "skipped")
+    enabled = name.endsWith("DebugUnitTest")
+  }
+
   publishing {
     publications {
       create<MavenPublication>("bundledRelease") {

quickie/src/main/kotlin/io/github/g00fy2/quickie/QRCodeAnalyzer.kt

@@ -10,12 +10,20 @@ import com.google.mlkit.vision.barcode.BarcodeScanning
 import com.google.mlkit.vision.common.InputImage
 
 @ExperimentalGetImage
-internal class QRCodeAnalyzer(val onSuccess: ((Barcode) -> Unit), val onFailure: ((Exception) -> Unit)) :
-  ImageAnalysis.Analyzer {
+internal class QRCodeAnalyzer(
+  private val barcodeFormats: IntArray,
+  private val onSuccess: ((Barcode) -> Unit),
+  private val onFailure: ((Exception) -> Unit)
+) : ImageAnalysis.Analyzer {
 
   private var pendingTask: Task<List<Barcode>>? = null
   private val barcodeScanner by lazy {
-    BarcodeScanning.getClient(BarcodeScannerOptions.Builder().setBarcodeFormats(Barcode.FORMAT_QR_CODE).build())
+    val optionsBuilder = if (barcodeFormats.size > 1) {
+      BarcodeScannerOptions.Builder().setBarcodeFormats(barcodeFormats.first(), *barcodeFormats.drop(1).toIntArray())
+    } else {
+      BarcodeScannerOptions.Builder().setBarcodeFormats(barcodeFormats.firstOrNull() ?: Barcode.FORMAT_UNKNOWN)
+    }
+    BarcodeScanning.getClient(optionsBuilder.build())
   }
 
   override fun analyze(imageProxy: ImageProxy) {

quickie/src/main/kotlin/io/github/g00fy2/quickie/QROverlayView.kt

@@ -1,6 +1,7 @@
 package io.github.g00fy2.quickie
 
 import android.content.Context
+import android.content.res.Resources.NotFoundException
 import android.graphics.Bitmap
 import android.graphics.Bitmap.Config.ARGB_8888
 import android.graphics.Canvas
@@ -9,13 +10,15 @@ import android.graphics.Paint
 import android.graphics.PorterDuff.Mode.CLEAR
 import android.graphics.PorterDuffXfermode
 import android.graphics.RectF
+import android.graphics.drawable.Drawable
 import android.util.AttributeSet
 import android.util.TypedValue
 import android.view.LayoutInflater
 import android.view.View
 import android.widget.FrameLayout
 import androidx.appcompat.widget.AppCompatTextView
 import androidx.core.content.ContextCompat
+import androidx.core.content.res.ResourcesCompat
 import androidx.core.graphics.ColorUtils
 import io.github.g00fy2.quickie.databinding.QuickieTextviewBinding
 import kotlin.math.min
@@ -29,12 +32,11 @@ internal class QROverlayView @JvmOverloads constructor(
 
   private val strokeColor = ContextCompat.getColor(context, R.color.quickie_stroke)
   private val highlightedStrokeColor = getAccentColor()
-  private val backgroundColor =
-    ColorUtils.setAlphaComponent(ContextCompat.getColor(context, R.color.quickie_black), BACKGROUND_ALPHA.roundToInt())
+  private val backgroundColor = ColorUtils.setAlphaComponent(Color.BLACK, BACKGROUND_ALPHA.roundToInt())
   private val alphaPaint = Paint().apply { alpha = BACKGROUND_ALPHA.roundToInt() }
   private val strokePaint = Paint(Paint.ANTI_ALIAS_FLAG)
   private val transparentPaint = Paint(Paint.ANTI_ALIAS_FLAG).apply {
-    color = ContextCompat.getColor(context, R.color.quickie_transparent)
+    color = Color.TRANSPARENT
     xfermode = PorterDuffXfermode(CLEAR)
   }
   private val radius = TypedValue.applyDimension(TypedValue.COMPLEX_UNIT_DIP, OUT_RADIUS, resources.displayMetrics)
@@ -76,6 +78,25 @@ internal class QROverlayView @JvmOverloads constructor(
     super.onDraw(canvas)
   }
 
+  fun setCustomTextAndIcon(stringRes: Int, drawableRes: Int) {
+    if (stringRes != 0) {
+      try {
+        titleTextView.setText(stringRes)
+      } catch (ignore: NotFoundException) {
+        // string resource not found
+      }
+    }
+    if (drawableRes != 0) {
+      try {
+        ResourcesCompat.getDrawable(resources, drawableRes, null)?.limitDrawableSize(ICON_DP_MAX_HEIGHT)?.let {
+          titleTextView.setCompoundDrawables(null, it, null, null)
+        }
+      } catch (ignore: NotFoundException) {
+        // drawable resource not found
+      }
+    }
+  }
+
   private fun calculateFrameAndTitlePos() {
     val centralX = width / 2
     val centralY = height / 2
@@ -114,10 +135,18 @@ internal class QROverlayView @JvmOverloads constructor(
     layoutParams = params
   }
 
+  private fun Drawable.limitDrawableSize(maxDpHeight: Int): Drawable {
+    val scale = (maxDpHeight * resources.displayMetrics.density) / minimumHeight
+    if (scale < 1) setBounds(0, 0, (minimumWidth * scale).roundToInt(), (minimumHeight * scale).roundToInt())
+    else setBounds(0, 0, minimumWidth, minimumHeight)
+    return this
+  }
+
   companion object {
     private const val BACKGROUND_ALPHA = 0.77 * 255
     private const val STROKE_WIDTH = 4f
     private const val OUT_RADIUS = 16f
     private const val FRAME_MARGIN_RATIO = 1f / 4
+    private const val ICON_DP_MAX_HEIGHT = 56
   }
 }