Merge pull request #6 from marcelpinto/multiple-permission-request

Multiple permission request

README.md

@@ -1,14 +1,12 @@
-# permissions-ktx [ ![Download](https://api.bintray.com/packages/skimarxall/maven/permissions-ktx/images/download.svg?version=0.6) ](https://bintray.com/skimarxall/maven/permissions-ktx/0.6/link)
+# permissions-ktx [ ![Download](https://api.bintray.com/packages/skimarxall/maven/permissions-ktx/images/download.svg?version=0.7) ](https://bintray.com/skimarxall/maven/permissions-ktx/0.7/link)
 
 Kotlin Lightweight Android permissions library that follows the permission request principles
 and it's Jetpack Compose friendly.
 
 Learn more about best practices at
 [https://developer.android.com/guide/topics/permissions/overview](https://developer.android.com/guide/topics/permissions/overview)
 
-```
-Disclaimer: this is an experimental project, the API is constantly changing, use at your own risk.
-```
+> **Disclaimer:** this is an experimental project, the API is constantly changing, use at your own risk.
 
 # Overview
 
@@ -89,7 +87,7 @@ class MainFragment : Fragment() {
         }
 }
 ```
-This creates a [PermissionRequest](lib/src/main/java/dev/marcelpinto/permissionktx/PermissionLauncher.kt)
+This creates a [PermissionRequest](lib/src/main/java/dev/marcelpinto/permissionktx/PermissionResultLauncher.kt)
 instance that can be used to launch the permission request flow.
 
 ## Launch Permission Request
@@ -102,11 +100,11 @@ This is the desired way to launch since it enforces the permission recommendatio
 
 1. Checking if the permission was already granted --> onAlreadyGranted
 2. Then if further explanation is required --> onRequireRational
-3. Otherwise launching the permission request --> onRequirePermission
+3. Otherwise launching the permission request --> onRequirePermissions
 
 ```kotlin
 locationPermissionRequest.safeLaunch(
-    onRequirePermission = {
+    onRequirePermissions = {
         // Optional:update your UI if needed and return true to launch 
         // the permission request
         true
@@ -138,6 +136,27 @@ by the Jetpack Activity/Fragment library can still be used.
 locationPermissionRequest.launch()
 ```
 
+## Multiple permissions launch
+
+The library support launching multiple permissions at the same time, although this is only encourage
+for specific cases, for example, a videochat (CAMERA and MIC). Otherwise is always better to request
+only the necessary single permission for each use case, instead of requesting all at once.
+
+To launch multiple permissions simply pass an array following the same mechanism explained above:
+
+```kotlin
+locationPermissionsRequest = registerForMultiplePermissionResult(
+  arrayOf(
+      Manifest.permission.ACCESS_COARSE_LOCATION,
+      Manifest.permission.ACCESS_FINE_LOCATION
+  )
+) { resultMap ->
+    // a map of Permission and the result as boolean.
+}
+```
+
+> Check the [MultipleActivity sample](app/src/main/java/dev/marcelpinto/permissionktx/multiple/MultipleActivity.kt).
+
 ## Observe Permission Status
 
 The library adds an observability pattern to the current Android Permissions API

app/build.gradle.kts

@@ -1,11 +1,27 @@
+/*
+ * Copyright 2020 Marcel Pinto Biescas
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *          http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 import org.jetbrains.kotlin.config.KotlinCompilerVersion
 
 plugins {
     id("com.android.application")
     kotlin("android")
 }
 
-val composeVersion = "1.0.0-beta01"
+val composeVersion = "1.0.0-beta02"
 
 android {
     compileSdkVersion(30)
@@ -63,14 +79,13 @@ dependencies {
     implementation(project(":lib"))
 
     implementation("androidx.core:core-ktx:1.3.2")
-    implementation("androidx.appcompat:appcompat:1.2.0")
+    implementation("androidx.appcompat:appcompat:1.3.0-beta01")
     implementation("androidx.constraintlayout:constraintlayout:2.0.4")
 
     implementation("com.google.android.material:material:1.3.0")
     implementation("androidx.compose.ui:ui:$composeVersion")
     implementation("androidx.compose.material:material:$composeVersion")
-    implementation("androidx.compose.ui:ui-tooling:$composeVersion")
-    implementation("androidx.activity:activity-compose:1.3.0-alpha03")
+    implementation("androidx.activity:activity-compose:1.3.0-alpha04")
     implementation("androidx.lifecycle:lifecycle-runtime-ktx:2.3.0")
     implementation("androidx.lifecycle:lifecycle-livedata-ktx:2.3.0")
     implementation("androidx.lifecycle:lifecycle-viewmodel-ktx:2.3.0")

app/src/androidTest/java/dev/marcelpinto/permissionktx/compose/ComposePermissionTest.kt

@@ -1,3 +1,19 @@
+/*
+ * Copyright 2020 Marcel Pinto Biescas
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *          http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package dev.marcelpinto.permissionktx.compose
 
 import android.Manifest
@@ -31,7 +47,7 @@ class ComposePermissionTest {
         rationale = PermissionRational.OPTIONAL
     )
 
-    @ExperimentalCoroutinesApi
+    @OptIn(ExperimentalCoroutinesApi::class)
     @Before
     fun setUp() {
         PermissionProvider.init(

app/src/androidTest/java/dev/marcelpinto/permissionktx/simple/SimpleActivityTest.kt

@@ -1,3 +1,19 @@
+/*
+ * Copyright 2020 Marcel Pinto Biescas
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *          http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package dev.marcelpinto.permissionktx.simple
 
 import android.Manifest
@@ -22,11 +38,11 @@ import org.junit.runner.RunWith
 class SimpleActivityTest {
 
     private var permissionStatus: PermissionStatus = PermissionStatus.Revoked(
-        type = Permission(Manifest.permission.ACCESS_FINE_LOCATION),
+        type = Permission(Manifest.permission.ACCESS_COARSE_LOCATION),
         rationale = PermissionRational.OPTIONAL
     )
 
-    @ExperimentalCoroutinesApi
+    @OptIn(ExperimentalCoroutinesApi::class)
     @Before
     fun setUp() {
         // Provide a custom init that returns the values of the defined permissionStatus

app/src/main/AndroidManifest.xml

@@ -1,4 +1,20 @@
 <?xml version="1.0" encoding="utf-8"?>
+<!--
+  ~ Copyright 2020 Marcel Pinto Biescas
+  ~
+  ~ Licensed under the Apache License, Version 2.0 (the "License");
+  ~ you may not use this file except in compliance with the License.
+  ~ You may obtain a copy of the License at
+  ~
+  ~          http://www.apache.org/licenses/LICENSE-2.0
+  ~
+  ~ Unless required by applicable law or agreed to in writing, software
+  ~ distributed under the License is distributed on an "AS IS" BASIS,
+  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  ~ See the License for the specific language governing permissions and
+  ~ limitations under the License.
+  -->
+
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
     package="dev.marcelpinto.permissionktx">
 
@@ -15,6 +31,7 @@
 
         <activity
             android:name=".MainActivity"
+            android:exported="true"
             android:theme="@style/Theme.PermissionKtx">
             <intent-filter>
                 <action android:name="android.intent.action.MAIN" />
@@ -23,10 +40,21 @@
             </intent-filter>
         </activity>
 
-        <activity android:name=".simple.SimpleActivity" />
-        <activity android:name=".advance.AdvanceActivity" />
-        <activity android:name=".compose.ComposeActivity" />
-        <activity android:name="androidx.activity.ComponentActivity" />
+        <activity
+            android:name=".simple.SimpleActivity"
+            android:exported="false" />
+        <activity
+            android:name=".multiple.MultipleActivity"
+            android:exported="false" />
+        <activity
+            android:name=".advance.AdvanceActivity"
+            android:exported="false" />
+        <activity
+            android:name=".compose.ComposeActivity"
+            android:exported="false" />
+        <activity
+            android:name="androidx.activity.ComponentActivity"
+            android:exported="false" />
 
     </application>
 

app/src/main/java/dev/marcelpinto/permissionktx/MainActivity.kt

@@ -1,3 +1,19 @@
+/*
+ * Copyright 2020 Marcel Pinto Biescas
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *          http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package dev.marcelpinto.permissionktx
 
 import android.content.Intent
@@ -15,6 +31,7 @@ import androidx.compose.ui.Alignment
 import androidx.compose.ui.Modifier
 import dev.marcelpinto.permissionktx.advance.AdvanceActivity
 import dev.marcelpinto.permissionktx.compose.ComposeActivity
+import dev.marcelpinto.permissionktx.multiple.MultipleActivity
 import dev.marcelpinto.permissionktx.simple.SimpleActivity
 
 class MainActivity : AppCompatActivity() {
@@ -34,6 +51,11 @@ class MainActivity : AppCompatActivity() {
                         }) {
                             Text("Simple Sample")
                         }
+                        Button(onClick = {
+                            start(MultipleActivity::class.java)
+                        }) {
+                            Text("Multiple Permissions Sample")
+                        }
                         Button(onClick = {
                             start(AdvanceActivity::class.java)
                         }) {

app/src/main/java/dev/marcelpinto/permissionktx/advance/AdvanceActivity.kt

@@ -1,3 +1,19 @@
+/*
+ * Copyright 2020 Marcel Pinto Biescas
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *          http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package dev.marcelpinto.permissionktx.advance
 
 import android.Manifest

app/src/main/java/dev/marcelpinto/permissionktx/advance/AdvanceViewModel.kt

@@ -1,3 +1,19 @@
+/*
+ * Copyright 2020 Marcel Pinto Biescas
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *          http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package dev.marcelpinto.permissionktx.advance
 
 import android.Manifest

app/src/main/java/dev/marcelpinto/permissionktx/advance/LocationFlow.kt

@@ -1,3 +1,19 @@
+/*
+ * Copyright 2020 Marcel Pinto Biescas
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *          http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package dev.marcelpinto.permissionktx.advance
 
 import kotlinx.coroutines.delay

app/src/main/java/dev/marcelpinto/permissionktx/compose/ComposeActivity.kt

@@ -1,3 +1,19 @@
+/*
+ * Copyright 2020 Marcel Pinto Biescas
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *          http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package dev.marcelpinto.permissionktx.compose
 
 import android.Manifest