Merge pull request #82 from PatilShreyas/2.0.0-dev

Release v2.0.0

Author: PatilShreyas

README.md

@@ -53,18 +53,22 @@ val permissionFlow = PermissionFlow.getInstance()
 
 // Observe state of single permission
 suspend fun observePermission() {
-    permissionFlow.getPermissionState(android.Manifest.permission.READ_CONTACTS).collect { state ->
+    permissionFlow.getPermissionState(Manifest.permission.READ_CONTACTS).collect { state ->
         if (state.isGranted) {
-            // Do something
+            // Permission granted, access contacts.
+        } else if (state.isRationaleRequired == true) {
+            // Permission denied, but can be requested again
+        } else {
+            // Permission denied, and can't be requested again
         }
     }
 }
 
 // Observe state of multiple permissions
 suspend fun observeMultiplePermissions() {
     permissionFlow.getMultiplePermissionState(
-        android.Manifest.permission.READ_CONTACTS,
-        android.Manifest.permission.READ_SMS
+        Manifest.permission.READ_CONTACTS,
+        Manifest.permission.READ_SMS
     ).collect { state ->
         // All permission states
         val allPermissions = state.permissions
@@ -77,6 +81,9 @@ suspend fun observeMultiplePermissions() {
 
         // List of denied permissions
         val deniedPermissions = state.deniedPermissions
+        
+        // List of permissions requiring rationale
+        val permissionsRequiringRationale = state.permissionsRequiringRationale
     }
 }
 ```
@@ -90,9 +97,11 @@ State of a permission and state of multiple permissions can also be observed in
 fun ExampleSinglePermission() {
     val state by rememberPermissionState(Manifest.permission.CAMERA)
     if (state.isGranted) {
-        // Render something
+        // Permission granted
+    } else if (state.isRationaleRequired == true) {
+        // Permission denied, but can be requested again
     } else {
-        // Render something else
+        // Permission denied, and can't be requested again
     }
 }
 
@@ -113,6 +122,9 @@ fun ExampleMultiplePermission() {
 
     val deniedPermissions = state.deniedPermissions
     // Do something with `deniedPermissions`
+    
+    val permissionsRequiringRationale = state.permissionsRequiringRationale
+    // Do something with `permissionsRequiringRationale`
 }
 ```
 

build.gradle

@@ -14,6 +14,7 @@ buildscript {
         robolectricVersion = "4.11.1"
         mockkVersion = '1.13.10'
         turbineVersion = '1.1.0'
+        androidxCoreTestingVersion = '1.5.0'
         spotlessVersion = '6.25.0'
         koverVersion = "0.5.1"
         startupVersion = "1.1.1"

permission-flow-compose/src/main/java/dev/shreyaspatil/permissionflow/compose/PermissionFlow.kt

@@ -37,6 +37,9 @@ import dev.shreyaspatil.permissionFlow.contract.RequestPermissionsContract
  *      if (state.isGranted) {
  *          // Render something
  *      } else {
+ *          if (state.isRationaleRequired) {
+ *              // Show rationale
+ *          }
  *          // Render something else
  *      }
  *  }

permission-flow/build.gradle

@@ -57,6 +57,7 @@ dependencies {
 
     // Testing
     testImplementation "junit:junit:$jUnitVersion"
+    testImplementation "androidx.test:core:$androidxCoreTestingVersion"
     testImplementation("org.robolectric:robolectric:$robolectricVersion")
     testImplementation "org.jetbrains.kotlinx:kotlinx-coroutines-test:$coroutinesVersion"
     testImplementation "app.cash.turbine:turbine:$turbineVersion"

permission-flow/src/main/java/dev/shreyaspatil/permissionFlow/PermissionFlow.kt

@@ -19,10 +19,10 @@ import android.content.Context
 import dev.shreyaspatil.permissionFlow.PermissionFlow.Companion.getInstance
 import dev.shreyaspatil.permissionFlow.PermissionFlow.Companion.init
 import dev.shreyaspatil.permissionFlow.impl.PermissionFlowImpl
-import java.util.concurrent.Executors
 import kotlinx.coroutines.CoroutineDispatcher
-import kotlinx.coroutines.asCoroutineDispatcher
+import kotlinx.coroutines.DelicateCoroutinesApi
 import kotlinx.coroutines.flow.StateFlow
+import kotlinx.coroutines.newFixedThreadPoolContext
 
 /**
  * A utility class which provides a functionality for observing state of a permission (whether it's
@@ -58,6 +58,10 @@ import kotlinx.coroutines.flow.StateFlow
  *              .collect { state ->
  *                  if (state.isGranted) {
  *                      // Do something
+ *                  } else {
+ *                      if (state.isRationaleRequired) {
+ *                          // Do something
+ *                      }
  *                  }
  *              }
  *      }
@@ -93,6 +97,10 @@ interface PermissionFlow {
      *      .collect { state ->
      *          if (state.isGranted) {
      *              // Do something
+     *          } else {
+     *              if (state.isRationaleRequired) {
+     *                  // Do something
+     *              }
      *          }
      *      }
      * ```
@@ -160,9 +168,11 @@ interface PermissionFlow {
     /**
      * Starts listening the changes of state of permissions.
      *
-     * Ideally it automatically starts listening lazily when [getMultiplePermissionState] method is
-     * used for the first time. But this can be used to start to listen again after stopping
-     * listening with [stopListening].
+     * Ideally it automatically starts listening eagerly when application is started and created via
+     * [dev.shreyaspatil.permissionFlow.initializer.PermissionFlowInitializer]. If initializer is
+     * disabled, then starts listening lazily when [getPermissionState] [getPermissionEvent] or
+     * [getMultiplePermissionState] method is used for the first time. But this can be used to start
+     * to listen again after stopping listening with [stopListening].
      */
     fun startListening()
 
@@ -178,7 +188,8 @@ interface PermissionFlow {
      * getting instance.
      */
     companion object {
-        private val DEFAULT_DISPATCHER = Executors.newFixedThreadPool(2).asCoroutineDispatcher()
+        @OptIn(DelicateCoroutinesApi::class)
+        private val DEFAULT_DISPATCHER = newFixedThreadPoolContext(2, "PermissionFlow")
 
         /**
          * Initializes this [PermissionFlow] instance with specified arguments.
@@ -189,10 +200,7 @@ interface PermissionFlow {
          */
         @JvmStatic
         @JvmOverloads
-        fun init(
-            context: Context,
-            dispatcher: CoroutineDispatcher = DEFAULT_DISPATCHER,
-        ) {
+        fun init(context: Context, dispatcher: CoroutineDispatcher = DEFAULT_DISPATCHER) {
             PermissionFlowImpl.init(context, dispatcher)
         }
 

permission-flow/src/main/java/dev/shreyaspatil/permissionFlow/State.kt

@@ -20,8 +20,13 @@ package dev.shreyaspatil.permissionFlow
  *
  * @property permission Name of a permission
  * @property isGranted State of a permission whether it's granted or not
+ * @property isRationaleRequired Whether to show rationale for a permission or not.
  */
-data class PermissionState(val permission: String, val isGranted: Boolean)
+data class PermissionState(
+    val permission: String,
+    val isGranted: Boolean,
+    val isRationaleRequired: Boolean?,
+)
 
 /**
  * State model for multiple permissions
@@ -37,4 +42,9 @@ data class MultiplePermissionState(val permissions: List<PermissionState>) {
 
     /** List of permissions which are denied / not granted by user */
     val deniedPermissions by lazy { permissions.filter { !it.isGranted }.map { it.permission } }
+
+    /** List of permissions which are required to show rationale */
+    val permissionsRequiringRationale by lazy {
+        permissions.filter { it.isRationaleRequired == true }.map { it.permission }
+    }
 }

permission-flow/src/main/java/dev/shreyaspatil/permissionFlow/contract/RequestPermissionsContract.kt

@@ -35,19 +35,14 @@ class RequestPermissionsContract(
     private val contract: RequestMultiplePermissions = RequestMultiplePermissions(),
     private val permissionFlow: PermissionFlow = PermissionFlow.getInstance(),
 ) : ActivityResultContract<Array<String>, Map<String, Boolean>>() {
-    override fun createIntent(
-        context: Context,
-        input: Array<String>,
-    ): Intent {
-        return contract.createIntent(context, input ?: emptyArray())
+
+    override fun createIntent(context: Context, input: Array<String>): Intent {
+        return contract.createIntent(context, input)
     }
 
-    override fun parseResult(
-        resultCode: Int,
-        intent: Intent?,
-    ): Map<String, Boolean> {
+    override fun parseResult(resultCode: Int, intent: Intent?): Map<String, Boolean> {
         return contract.parseResult(resultCode, intent).also {
-            val permissions = it.keys.filterNotNull().toTypedArray()
+            val permissions = it.keys.toList().toTypedArray()
             permissionFlow.notifyPermissionsChanged(*permissions)
         }
     }

permission-flow/src/main/java/dev/shreyaspatil/permissionFlow/impl/PermissionFlowImpl.kt

@@ -21,6 +21,7 @@ import androidx.annotation.VisibleForTesting
 import dev.shreyaspatil.permissionFlow.MultiplePermissionState
 import dev.shreyaspatil.permissionFlow.PermissionFlow
 import dev.shreyaspatil.permissionFlow.PermissionState
+import dev.shreyaspatil.permissionFlow.internal.ApplicationStateMonitor
 import dev.shreyaspatil.permissionFlow.watchmen.PermissionWatchmen
 import kotlinx.coroutines.CoroutineDispatcher
 import kotlinx.coroutines.flow.StateFlow
@@ -33,13 +34,13 @@ constructor(
 ) : PermissionFlow {
 
     override fun getPermissionState(permission: String): StateFlow<PermissionState> {
-        return watchmen.watch(permission)
+        return watchmen.watchState(permission)
     }
 
     override fun getMultiplePermissionState(
         vararg permissions: String
     ): StateFlow<MultiplePermissionState> {
-        return watchmen.watchMultiple(permissions.toList().toTypedArray())
+        return watchmen.watchMultipleState(permissions.toList().toTypedArray())
     }
 
     override fun notifyPermissionsChanged(vararg permissions: String) {
@@ -62,9 +63,10 @@ constructor(
         @Synchronized
         fun init(context: Context, dispatcher: CoroutineDispatcher) {
             if (instance == null) {
+                val monitor = ApplicationStateMonitor(context.applicationContext as Application)
                 val watchmen =
                     PermissionWatchmen(
-                        application = context.applicationContext as Application,
+                        appStateMonitor = monitor,
                         dispatcher = dispatcher,
                     )
                 instance = PermissionFlowImpl(watchmen)

permission-flow/src/main/java/dev/shreyaspatil/permissionFlow/initializer/PermissionFlowInitializer.kt

@@ -23,6 +23,7 @@ import dev.shreyaspatil.permissionFlow.PermissionFlow
 class PermissionFlowInitializer : Initializer<Unit> {
     override fun create(context: Context) {
         PermissionFlow.init(context)
+        PermissionFlow.getInstance().startListening()
     }
 
     override fun dependencies(): List<Class<out Initializer<*>>> {