Get storage permissions & remove old packages (#77)

* Remove filesystem & mediastore modules (already deprecated) * Add getReadFilesPermissions & getReadAndWriteFilesPermissions methods Refactor storage permission checking logic to be more flexible for future usages * Remove filesystem & mediastore modules (already deprecated) * Add getReadFilesPermissions & getReadAndWriteFilesPermissions methods Refactor storage permission checking logic to be more flexible for future usages * Change permissions check to bitwise operations * Deprecate canReadFiles & canReadAndWriteFiles in favor of hasAccess Deprecate getReadFilesPermissions & getReadAndWriteFilesPermissions in favor of getPermissions Simplify StoragePermissions.getPermissions unit tests * Add better support for Java usage * Add Bill of Material (#78) * Fix module versioning in documentation (#76) * Add Bill of Material * Fix build Exclude BOM from adding metalava as it doesn't have api/current.api Co-authored-by: Yacine Rezgui <rezgui.y@gmail.com> * Update API metadata * Fix documentation code tab snippets * Avoid wasting useless workflow runs * Use new StoragePermissions.hasAccess method * Update guide with new StoragePermissions.hasAccess method * Upgrade version number Co-authored-by: Andreas <andreas.everos@gmail.com>
google · Jan 19, 2022 · bd4188e · bd4188e
1 parent 05a8ee7
commit bd4188e
Show file tree

Hide file tree

Showing 56 changed files with 437 additions and 3,321 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -2,8 +2,11 @@ name: Build
 
 on:
     push:
+        branches:
+            - main
+        paths-ignore:
+            - '**.md'
     pull_request:
-        branches: [ main ]
 
 jobs:
     build:

diff --git a/bom/build.gradle.kts b/bom/build.gradle.kts
@@ -0,0 +1,18 @@
+plugins {
+    kotlin("jvm")
+    id("com.vanniktech.maven.publish")
+}
+
+dependencies {
+    constraints {
+        api(project(":permissions"))
+        api(project(":photopicker"))
+        api(project(":storage"))
+        api("com.squareup.okio:okio:3.0.0")
+    }
+}
+
+java {
+    sourceCompatibility = JavaVersion.VERSION_1_8
+    targetCompatibility = JavaVersion.VERSION_1_8
+}
diff --git a/bom/gradle.properties b/bom/gradle.properties
@@ -0,0 +1,3 @@
+POM_ARTIFACT_ID=modernstorage-bom
+POM_NAME=ModernStorage Bill of Material
+POM_PACKAGING=jar
diff --git a/build.gradle b/build.gradle
@@ -70,7 +70,7 @@ subprojects {
         }
     }
 
-    if (project.hasProperty('POM_ARTIFACT_ID')) {
+    if (project.hasProperty('POM_ARTIFACT_ID') && project.properties['POM_ARTIFACT_ID'] != "modernstorage-bom") {
         apply plugin: 'me.tylerbwong.gradle.metalava'
 
         metalava {

diff --git a/docs/README.md b/docs/README.md
@@ -19,6 +19,21 @@ implementation("com.google.modernstorage:modernstorage-permissions:{{ lib_versio
 implementation("com.google.modernstorage:modernstorage-storage:{{ lib_version }}")
 ```
 
+Alternatively use the Bill of Material to just have to define the version once, and then define which modules you need.
+
+```kotlin
+implementation("com.google.modernstorage:modernstorage-bom:{{ lib_version }}")
+
+implementation("com.google.modernstorage:modernstorage-permissions")
+
+implementation("com.google.modernstorage:modernstorage-storage")
+
+// The Bill of Material includes Okio and Photo Picker as well
+implementation("com.google.modernstorage:modernstorage-photopicker")
+
+implementation("com.squareup.okio:okio")
+```
+
 ## Quick start
 
 * Have a look at the [permissions][permissions_guide] and [storage interactions][storage_interactions_guide] guides

diff --git a/docs/permissions.md b/docs/permissions.md
@@ -53,13 +53,15 @@ To help you navigate common use cases, check out the below table:
 // Check if the app can read image & document files created by itself
 val storagePermissions = StoragePermissions(context)
 
-storagePermissions.canReadFiles(
+storagePermissions.hasAccess(
+    action = Action.READ,
     types = listOf(FileType.Image, FileType.Document),
     createdBy = StoragePermissions.CreatedBy.Self
 )
 
 // Check if the app can read video & audio files created by all apps
-storagePermissions.canReadFiles(
+storagePermissions.hasAccess(
+    action = Action.READ,
     types = listOf(FileType.Video, FileType.Audio),
     createdBy = StoragePermissions.CreatedBy.AllApps
 )
@@ -71,13 +73,15 @@ storagePermissions.canReadFiles(
 // Check if the app can read & write image & document files created by itself
 val storagePermissions = StoragePermissions(context)
 
-storagePermissions.canReadAndWriteFiles(
+storagePermissions.hasAccess(
+    action = Action.READ_AND_WRITE,
     types = listOf(FileType.Image, FileType.Video),
     createdBy = StoragePermissions.CreatedBy.Self
 )
 
 // Check if the app can read & write video & audio files created by all apps
-storagePermissions.canReadAndWriteFiles(
+storagePermissions.hasAccess(
+    action = Action.READ_AND_WRITE,
     types = listOf(FileType.Audio, FileType.Document),
     createdBy = StoragePermissions.CreatedBy.AllApps
 )

diff --git a/docs/photopicker.md b/docs/photopicker.md
@@ -67,7 +67,6 @@ implementation("com.google.modernstorage:{{ artifact }}:{{ lib_version }}")
 === "Views"
 
     ```kotlin
-    class
     // Register a callback for the Activity Result
     val photoPicker = registerForActivityResult(PhotoPicker()) { uris ->
         // uris contain the list of selected images & video

diff --git a/filesystem/api/current.api b/filesystem/api/current.api
diff --git a/filesystem/build.gradle b/filesystem/build.gradle
diff --git a/filesystem/consumer-rules.pro b/filesystem/consumer-rules.pro
diff --git a/filesystem/gradle.properties b/filesystem/gradle.properties
diff --git a/filesystem/proguard-rules.pro b/filesystem/proguard-rules.pro