Merge pull request #9 from hotchemi/multiple_permissions

Add multiple permissions.

Author: Shintaro Katafuchi

.travis.yml

@@ -12,7 +12,6 @@ android:
     - extra-google-m2repository
 
 jdk:
-  - oraclejdk7
   - oraclejdk8
 
 branches:

CHANGELOG.md

@@ -1,5 +1,7 @@
 # ChangeLog
 
+- 1.1.0 2015/08/24
+    - Add `@NeedsPermissions` and `@ShowRationales`.
 - 1.0.1 2015/08/20
     - Stop calling rationale methods in the OnRequestPermissionsResult.
 - 1.0.0 2015/08/19

README.md

@@ -4,9 +4,9 @@
 [ ![Download](https://api.bintray.com/packages/hotchemi/maven/permissionsdispatcher/images/download.svg) ](https://bintray.com/hotchemi/maven/permissionsdispatcher/_latestVersion)
 [![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-PermissionsDispatcher-green.svg?style=flat)](https://android-arsenal.com/details/1/2316)
 
-PermissionsDispatcher provides simple annotation-based API to handle runtime permissions in Android M.
+PermissionsDispatcher provides simple annotation-based API to handle runtime permissions in Marshmallow.
 
-[Runtime permissions](https://developer.android.com/preview/features/runtime-permissions.html) is so great for users but also the hell for developers. Actually I don't want to write such a complicated [code](https://github.com/googlesamples/android-RuntimePermissions/blob/master/Application/src/main/java/com/example/android/system/runtimepermissions/MainActivity.java) anymore.
+[Runtime permissions](https://developer.android.com/preview/features/runtime-permissions.html) is so great for users but also the hell for developers.
 
 You can be released from the burden that writing a bunch of check statements whether a permission have been granted or not. 
 
@@ -16,11 +16,13 @@ Here's a minimum example that you register `MainActivity` which requires `Manife
 
 ### 1. Attach annotations
 
-There are only 3 annotations.
+There are only few annotations.
 
 - `@RuntimePermissions`: [Must] Register an Activity or Fragment to handle permissions.
 - `@NeedsPermission`: [Must] Register a method which the permission is needed.
+    - You can use `@NeedsPermissions` for multiple requests.
 - `@ShowsRationale`: [Option] Register a method which explains why the permission is needed. Actually an annotated method is called when `shouldShowRequestPermissionRationale` returns true or when uer deny a permission.
+    - You can use `@ShowsRationales` for multiple requests.
 
 > NOTE: Annotated methods must be package private or above.
 
@@ -103,8 +105,8 @@ buildscript {
 apply plugin: 'android-apt'
 
 dependencies {
-  compile 'com.github.hotchemi:permissionsdispatcher:1.0.1'
-  apt 'com.github.hotchemi:permissionsdispatcher-processor:1.0.1'
+  compile 'com.github.hotchemi:permissionsdispatcher:1.1.0'
+  apt 'com.github.hotchemi:permissionsdispatcher-processor:1.1.0'
 }
 ```
 

gradle.properties

@@ -2,7 +2,7 @@ USER = hotchemi
 GROUP_ID = com.github.hotchemi
 ARTIFACT_ID_CORE = permissionsdispatcher
 ARTIFACT_ID_PROCESSOR = permissionsdispatcher-processor
-VERSION = 1.0.1
+VERSION = 1.1.0
 DESCRIPTION = Annotation-based library for generating runtime permissions dispatcher.
 WEBSITE = https://github.com/hotchemi/PermissionsDispatcher
 LICENCES = ['Apache-2.0']

permissionsdispatcher-processor/build.gradle

@@ -1,8 +1,10 @@
+import org.gradle.internal.jvm.Jvm
+
 apply plugin: "java"
 apply plugin: 'com.novoda.bintray-release'
 
-targetCompatibility = JavaVersion.VERSION_1_7
-sourceCompatibility = JavaVersion.VERSION_1_7
+targetCompatibility = JavaVersion.VERSION_1_8
+sourceCompatibility = JavaVersion.VERSION_1_8
 
 sourceSets {
     main {
@@ -20,7 +22,7 @@ dependencies {
     testCompile 'org.mockito:mockito-core:1.10.19'
     testCompile 'com.google.testing.compile:compile-testing:0.6'
     testCompile 'com.google.android:android:4.1.1.4'
-    testCompile files(org.gradle.internal.jvm.Jvm.current().getToolsJar())
+    testCompile files(Jvm.current().getToolsJar())
     // FIXME: there are support v4 and core module jar but it is dirty hack
     testCompile fileTree(dir: './src/test/libs', includes: ['*.jar'])
 }

permissionsdispatcher-processor/src/main/java/permissions/dispatcher/processor/ClassType.java

@@ -1,6 +1,6 @@
 package permissions.dispatcher.processor;
 
-public enum ClassType {
+enum ClassType {
     ACTIVITY("target"),
     FRAGMENT("target.getActivity()");
 
@@ -10,10 +10,6 @@ public enum ClassType {
         this.activity = activity;
     }
 
-    public String getActivity() {
-        return activity;
-    }
-
     static ClassType getClassType(String className) {
         if (className.endsWith("Activity")) {
             return ACTIVITY;
@@ -22,4 +18,8 @@ static ClassType getClassType(String className) {
         }
         return null;
     }
-}
+
+    public String getActivity() {
+        return activity;
+    }
+}

permissionsdispatcher-processor/src/main/java/permissions/dispatcher/processor/ConstantsProvider.java

@@ -5,7 +5,7 @@
 interface ConstantsProvider {
 
     ClassName ACTIVITY_COMPAT = ClassName.get("android.support.v4.app", "ActivityCompat");
-    ClassName PERMISSION_UTIL = ClassName.get("permissions.dispatcher", "PermissionUtils");
+    ClassName PERMISSION_UTILS = ClassName.get("permissions.dispatcher", "PermissionUtils");
     String CLASS_SUFFIX = "PermissionsDispatcher";
     String METHOD_SUFFIX = "WithCheck";
     String FIELD_PREFIX = "REQUEST_";

permissionsdispatcher-processor/src/main/java/permissions/dispatcher/processor/JavaFileBuilder.java

@@ -1,57 +1,58 @@
 package permissions.dispatcher.processor;
 
-import com.squareup.javapoet.ClassName;
-import com.squareup.javapoet.FieldSpec;
-import com.squareup.javapoet.JavaFile;
-import com.squareup.javapoet.MethodSpec;
-import com.squareup.javapoet.TypeSpec;
-
-import java.util.ArrayList;
-import java.util.List;
+import com.squareup.javapoet.*;
+import permissions.dispatcher.NeedsPermission;
+import permissions.dispatcher.NeedsPermissions;
 
 import javax.lang.model.element.ExecutableElement;
 import javax.lang.model.element.Modifier;
+import java.util.ArrayList;
+import java.util.List;
 
-import permissions.dispatcher.NeedsPermission;
-
-import static permissions.dispatcher.processor.ConstantsProvider.ACTIVITY_COMPAT;
-import static permissions.dispatcher.processor.ConstantsProvider.METHOD_SUFFIX;
-import static permissions.dispatcher.processor.ConstantsProvider.PERMISSION_UTIL;
+import static permissions.dispatcher.processor.ConstantsProvider.*;
 import static permissions.dispatcher.processor.Utils.getFieldName;
 
 final class JavaFileBuilder {
 
-    private JavaFileBuilder() {
-    }
-
     private static MethodSpec createConstructor() {
         return MethodSpec.constructorBuilder().addModifiers(Modifier.PRIVATE).build();
     }
 
-    private static List<MethodSpec> createMethodsWithCheck(RuntimePermissionsAnnotatedElement clazz) {
+    private static List<MethodSpec> createNeedsPermissionMethods(RuntimePermissionsAnnotatedElement clazz) {
         List<MethodSpec> methodSpecs = new ArrayList<>();
         List<ExecutableElement> elements = clazz.getNeedsPermissionMethods();
         for (ExecutableElement element : elements) {
             String value = element.getAnnotation(NeedsPermission.class).value();
-            ExecutableElement showsRationale = clazz.getShowsRationaleMethodFromValue(value);
-            methodSpecs.add(createMethodWithCheck(clazz.getClassType(), clazz.getClassName(), element, showsRationale));
+            ExecutableElement showsRationale = clazz.getShowsRationaleFromValue(value);
+            String activity = clazz.getClassType().getActivity();
+            methodSpecs.add(createNeedsPermissionMethod(activity, clazz.getClassName(), element, showsRationale));
         }
         return methodSpecs;
     }
 
-    private static MethodSpec createMethodWithCheck(ClassType classType, ClassName target, ExecutableElement needsPermission, ExecutableElement showsRationale) {
+    private static List<MethodSpec> createNeedsPermissionsMethods(RuntimePermissionsAnnotatedElement clazz) {
+        List<MethodSpec> methodSpecs = new ArrayList<>();
+        List<ExecutableElement> elements = clazz.getNeedsPermissionsMethods();
+        for (ExecutableElement element : elements) {
+            String[] value = element.getAnnotation(NeedsPermissions.class).value();
+            ExecutableElement showsRationale = clazz.getShowsRationaleFromValue(value);
+            String activity = clazz.getClassType().getActivity();
+            methodSpecs.add(createNeedsPermissionsMethod(activity, clazz.getClassName(), element, showsRationale));
+        }
+        return methodSpecs;
+    }
+
+    private static MethodSpec createNeedsPermissionMethod(String activity, ClassName target, ExecutableElement needsPermission, ExecutableElement showsRationale) {
         String methodName = needsPermission.getSimpleName().toString();
         String value = needsPermission.getAnnotation(NeedsPermission.class).value();
-        String activity = classType.getActivity();
         MethodSpec.Builder
                 methodBuilder = MethodSpec.methodBuilder(methodName + METHOD_SUFFIX)
                 .addModifiers(Modifier.PUBLIC, Modifier.STATIC)
                 .returns(void.class)
                 .addParameter(target, "target")
-                .beginControlFlow("if ($T.hasSelfPermissions($N, $S))", PERMISSION_UTIL, activity, value)
+                .beginControlFlow("if ($T.hasSelfPermissions($N, $S))", PERMISSION_UTILS, activity, value)
                 .addStatement("target.$N()", methodName)
                 .nextControlFlow("else");
-
         if (showsRationale != null) {
             methodBuilder.beginControlFlow("if ($T.shouldShowRequestPermissionRationale($N, $S))",
                     ACTIVITY_COMPAT, activity, value)
@@ -64,6 +65,30 @@ ACTIVITY_COMPAT, activity, value, getFieldName(methodName))
                 .build();
     }
 
+    private static MethodSpec createNeedsPermissionsMethod(String activity, ClassName target, ExecutableElement needsPermission, ExecutableElement showsRationale) {
+        String methodName = needsPermission.getSimpleName().toString();
+        String[] value = needsPermission.getAnnotation(NeedsPermissions.class).value();
+        String array = "new String[]" + Utils.toString(value);
+        MethodSpec.Builder
+                methodBuilder = MethodSpec.methodBuilder(methodName + METHOD_SUFFIX)
+                .addModifiers(Modifier.PUBLIC, Modifier.STATIC)
+                .returns(void.class)
+                .addParameter(target, "target")
+                .beginControlFlow("if ($T.hasSelfPermissions($N, $L))", PERMISSION_UTILS, activity, array)
+                .addStatement("target.$N()", methodName)
+                .nextControlFlow("else");
+        if (showsRationale != null) {
+            methodBuilder.beginControlFlow("if ($T.shouldShowRequestPermissionRationale($N, $L))",
+                    PERMISSION_UTILS, activity, array)
+                    .addStatement("target.$N()", showsRationale.getSimpleName())
+                    .endControlFlow();
+        }
+        return methodBuilder.addStatement("$T.requestPermissions($N, $L, $N)",
+                ACTIVITY_COMPAT, activity, array, getFieldName(methodName))
+                .endControlFlow()
+                .build();
+    }
+
     private static MethodSpec createOnRequestPermissionsResult(ClassName target, List<ExecutableElement> methods) {
         MethodSpec.Builder methodBuilder = MethodSpec.methodBuilder("onRequestPermissionsResult")
                 .addModifiers(Modifier.PUBLIC, Modifier.STATIC)
@@ -73,12 +98,11 @@ private static MethodSpec createOnRequestPermissionsResult(ClassName target, Lis
                 .addParameter(int[].class, "grantResults")
                 .returns(void.class)
                 .beginControlFlow("switch (requestCode)");
-
         for (ExecutableElement method : methods) {
             String methodName = method.getSimpleName().toString();
             methodBuilder
                     .addCode("case $N:\n", getFieldName(methodName))
-                    .beginControlFlow("if ($T.verifyPermissions(grantResults))", PERMISSION_UTIL)
+                    .beginControlFlow("if ($T.verifyPermissions(grantResults))", PERMISSION_UTILS)
                     .addStatement("target.$N()", methodName)
                     .endControlFlow()
                     .addStatement("break");
@@ -106,15 +130,24 @@ private static FieldSpec createField(String name, int index) {
                 .build();
     }
 
-    public static JavaFile createJavaFile(RuntimePermissionsAnnotatedElement element) {
-        List<ExecutableElement> needsPermissionMethods = element.getNeedsPermissionMethods();
-        TypeSpec clazz = TypeSpec.classBuilder(element.getDispatchClassName())
+    static JavaFile createJavaFile(RuntimePermissionsAnnotatedElement element) {
+        List<ExecutableElement> permissionsMethods = new ArrayList<ExecutableElement>() {
+            {
+                addAll(element.getNeedsPermissionMethods());
+            }
+
+            {
+                addAll(element.getNeedsPermissionsMethods());
+            }
+        };
+        TypeSpec clazz = TypeSpec.classBuilder(element.getDispatcherClassName())
                 .addModifiers(Modifier.PUBLIC, Modifier.FINAL)
-                .addFields(createFields(needsPermissionMethods))
+                .addFields(createFields(permissionsMethods))
                 .addMethod(createConstructor())
-                .addMethods(createMethodsWithCheck(element))
-                .addMethod(createOnRequestPermissionsResult(element.getClassName(), needsPermissionMethods))
-                        .build();
+                .addMethods(createNeedsPermissionMethods(element))
+                .addMethods(createNeedsPermissionsMethods(element))
+                .addMethod(createOnRequestPermissionsResult(element.getClassName(), permissionsMethods))
+                .build();
         String packageName = element.getPackageName();
         return JavaFile.builder(packageName, clazz).build();
     }

permissionsdispatcher-processor/src/main/java/permissions/dispatcher/processor/PermissionsProcessor.java

@@ -61,4 +61,4 @@ public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment
         return true;
     }
 
-}
+}