Merge branch 'release/1.10.0'

# Conflicts:
#	README.md

Author: G00fY2

.github/CONTRIBUTING.md

@@ -15,6 +15,8 @@ Make sure to get working code on a personal branch with tests and sanity checks
 ```shell
 ./gradlew detektBundledDebug detektUnbundledDebug
 ./gradlew test
+./gradlew :sample:lintBundledDebug
+./gradlew :sample:lintUnbundledDebug
 ./gradlew :sample:assembleBundledDebug
 ./gradlew :sample:assembleUnbundledDebug
 ```

.github/workflows/build.yml

@@ -37,6 +37,19 @@ jobs:
       - name: Run bundled and unbundled unit tests
         run: ./gradlew test
 
+  android_lint:
+    name: Android lint
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-java@v4
+        with:
+          distribution: 'zulu'
+          java-version: '17'
+      - name: Run Android lint
+        run: ./gradlew :sample:lintBundledDebug :sample:lintUnbundledDebug
+
   build_bundled:
     name: Build bundled debug
     runs-on: ubuntu-latest

README.md

@@ -18,10 +18,10 @@ There are two different flavors available on `mavenCentral()`:
 
 ```kotlin
 // bundled:  
-implementation("io.github.g00fy2.quickie:quickie-bundled:1.9.0")
+implementation("io.github.g00fy2.quickie:quickie-bundled:1.10.0")
 
 // unbundled:
-implementation("io.github.g00fy2.quickie:quickie-unbundled:1.9.0")
+implementation("io.github.g00fy2.quickie:quickie-unbundled:1.10.0")
 ```
 
 ## Quick Start
@@ -116,6 +116,7 @@ override fun onCreate(savedInstanceState: Bundle?) {
           setShowCloseButton(true) // show or hide (default) close button
           setHorizontalFrameRatio(2.2f) // set the horizontal overlay ratio (default is 1 / square frame)
           setUseFrontCamera(true) // use the front camera
+          setKeepScreenOn(true) // keep the device's screen turned on
         }
       )
     }

gradle/libs.versions.toml

@@ -1,28 +1,28 @@
 [versions]
-quickie = "1.9.0"
+quickie = "1.10.0"
 
 androidconfig-minSdk = "21"
 androidconfig-compileSdk = "34"
 androidconfig-targetSdk = "33"
 androidconfig-buildTools = "34.0.0"
 
-androidGradle = "8.2.0"
-kotlin = "1.9.21"
+androidGradle = "8.4.0"
+kotlin = "1.9.23"
 
 appcompat = "1.6.1"
-core = "1.12.0"
+core = "1.13.1"
 
-cameraX = "1.3.0"
+cameraX = "1.3.3"
 
 barcodeScanning = "17.2.0"
 barcodeScanningGms = "18.3.0"
 
-materialDesign = "1.10.0"
+materialDesign = "1.12.0"
 
-detekt = "1.23.4"
-dokka = "1.9.10"
+detekt = "1.23.6"
+dokka = "1.9.20"
 
-junit = "5.10.1"
+junit = "5.10.2"
 
 [libraries]
 androidx-appcompat = { module = "androidx.appcompat:appcompat", version.ref = "appcompat" }

gradle/wrapper/gradle-wrapper.jar

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

gradle/wrapper/gradle-wrapper.properties

@@ -43,11 +43,11 @@ set JAVA_EXE=java.exe
 %JAVA_EXE% -version >NUL 2>&1
 if %ERRORLEVEL% equ 0 goto execute
 
-echo.
-echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
-echo.
-echo Please set the JAVA_HOME variable in your environment to match the
-echo location of your Java installation.
+echo. 1>&2
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
 
 goto fail
 
@@ -57,11 +57,11 @@ set JAVA_EXE=%JAVA_HOME%/bin/java.exe
 
 if exist "%JAVA_EXE%" goto execute
 
-echo.
-echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
-echo.
-echo Please set the JAVA_HOME variable in your environment to match the
-echo location of your Java installation.
+echo. 1>&2
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
 
 goto fail
 

gradlew.bat

@@ -1,5 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
-<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+<manifest xmlns:tools="http://schemas.android.com/tools"
+    xmlns:android="http://schemas.android.com/apk/res/android">
 
   <uses-feature
       android:name="android.hardware.camera"
@@ -12,7 +13,8 @@
     <activity
         android:name=".QRScannerActivity"
         android:screenOrientation="behind"
-        android:theme="@style/QuickieScannerActivity"/>
+        android:theme="@style/QuickieScannerActivity"
+        tools:ignore="DiscouragedApi"/>
 
   </application>
 

quickie/src/main/AndroidManifest.xml

@@ -14,12 +14,12 @@ public sealed class QRResult {
   /**
    * Activity got cancelled by the user.
    */
-  public object QRUserCanceled : QRResult()
+  public data object QRUserCanceled : QRResult()
 
   /**
    * Camera permission was not granted.
    */
-  public object QRMissingPermission : QRResult()
+  public data object QRMissingPermission : QRResult()
 
   /**
    * Error while setting up CameraX or while MLKit analysis.

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

@@ -10,6 +10,7 @@ import android.util.Size
 import android.view.HapticFeedbackConstants
 import android.view.KeyEvent
 import android.view.View
+import android.view.WindowManager
 import androidx.activity.result.contract.ActivityResultContracts
 import androidx.appcompat.app.AppCompatActivity
 import androidx.appcompat.view.ContextThemeWrapper
@@ -195,6 +196,8 @@ internal class QRScannerActivity : AppCompatActivity() {
       showTorchToggle = it.showTorchToggle
       useFrontCamera = it.useFrontCamera
       showCloseButton = it.showCloseButton
+
+      if (it.keepScreenOn) window.addFlags(WindowManager.LayoutParams.FLAG_KEEP_SCREEN_ON)
     }
   }