Skip to content

Commit 518289f

Browse files
author
Shintaro Katafuchi
committed
Initial commit.
0 parents  commit 518289f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+2603
-0
lines changed

‎.gitignore

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.gradle
2+
/local.properties
3+
4+
/build
5+
/captures
6+
7+
/.idea/
8+
*.iml
9+
10+
.DS_Store

‎.travis.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
language: android
2+
3+
android:
4+
components:
5+
- tools
6+
- platform-tools
7+
- build-tools-22.0.1
8+
- android-22
9+
- extra-google-google_play_services
10+
- extra-android-m2repository
11+
- extra-android-support
12+
- extra-google-m2repository
13+
14+
jdk:
15+
- oraclejdk7
16+
- oraclejdk8
17+
18+
branches:
19+
except:
20+
- gh-pages
21+
22+
script: ./gradlew assemble
23+
24+
cache:
25+
directories:
26+
- $HOME/.m2

‎LICENCE

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "{}"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright {yyyy} {name of copyright owner}
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
# PermissionsDispatcher
2+
3+
> **PermissionsDispatcher is based on the latest [official information](https://developer.android.com/preview/overview.html). Currently preview2 is the newest but it may change drastically in the near future. 1.0 will be out after M final release.**
4+
5+
PermissionsDispatcher provides simple annotation-based API to handle runtime permissions in Android M.
6+
7+
You can be released from the burden writing a bunch of check statements whether a permission have been granted or not.
8+
9+
## Motivation
10+
11+
[Runtime permissions](https://developer.android.com/preview/features/runtime-permissions.html) is so great for users but it's also the hell for developers.
12+
13+
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.
14+
15+
## Usage
16+
17+
Here's an minimum example that you register `MainActivity` which requires `Manifest.permission.CAMERA`.
18+
19+
### 1. Attach annotations
20+
21+
There are only 3 annotations.
22+
23+
- `@RuntimePermissions`: [Must] Register an Activity or Fragment to handle permissions.
24+
- `@NeedsPermission`: [Must] Register a method which the permission is needed.
25+
- `@ShowsRationale`: [Option] Register a method which explains why this permission is needed. Actually an annotated method is called when `shouldShowRequestPermissionRationale` returns true.
26+
27+
> NOTE: Annotated methods must be package private or above.
28+
29+
```java
30+
@RuntimePermissions
31+
public class MainActivity extends Activity {
32+
33+
@NeedsPermission(Manifest.permission.CAMERA)
34+
void showCamera() {
35+
getSupportFragmentManager().beginTransaction()
36+
.replace(R.id.sample_content_fragment, CameraPreviewFragment.newInstance())
37+
.addToBackStack("contacts")
38+
.commitAllowingStateLoss();
39+
}
40+
41+
// this is option
42+
@ShowsRationale(Manifest.permission.CAMERA)
43+
void showRationaleForCamera() {
44+
Toast.makeText(this, R.string.permission_camera_rationale, Toast.LENGTH_SHORT).show();
45+
}
46+
}
47+
```
48+
49+
### 2. Delegate to generated class
50+
51+
Now you can use the class generated by annotation processor.
52+
53+
In this case the name is `MainActivityPermissionsDispatcher`.
54+
55+
It has `~WithCheck` and `onRequestPermissionsResult` methods.
56+
57+
Only you have to do is delegating the work to it.
58+
59+
```java
60+
@Override
61+
protected void onCreate(Bundle savedInstanceState) {
62+
super.onCreate(savedInstanceState);
63+
setContentView(R.layout.activity_main);
64+
Button cameraButton = (Button) findViewById(R.id.button_camera);
65+
cameraButton.setOnClickListener(this);
66+
Button contactsButton = (Button) findViewById(R.id.button_contacts);
67+
contactsButton.setOnClickListener(this);
68+
}
69+
70+
@Override
71+
public void onClick(View v) {
72+
switch (v.getId()) {
73+
case R.id.button_camera:
74+
// NOTE: delegate the permission handling to generated method
75+
MainActivityPermissionsDispatcher.showCameraWithCheck(this);
76+
break;
77+
case R.id.button_contacts:
78+
// NOTE: delegate the permission handling to generated method
79+
MainActivityPermissionsDispatcher.showContactsWithCheck(this);
80+
break;
81+
}
82+
}
83+
84+
@Override
85+
public void onRequestPermissionsResult(int requestCode, String[] permissions, int[] grantResults) {
86+
// NOTE: delegate the permission handling to generated method
87+
MainActivityPermissionsDispatcher.
88+
onRequestPermissionsResult(this, requestCode, permissions, grantResults);
89+
}
90+
```
91+
92+
If you want to know more detail, please check the sample module and generated class.
93+
94+
## Download
95+
96+
Add to your project `build.gradle` file:
97+
98+
```groovy
99+
buildscript {
100+
dependencies {
101+
classpath 'com.neenbedankt.gradle.plugins:android-apt:1.4'
102+
}
103+
}
104+
105+
apply plugin: 'android-apt'
106+
107+
dependencies {
108+
compile 'com.github.hotchemi:permissionsdispatcher:0.5.0'
109+
apt 'com.github.hotchemi:permissionsdispatcher-processor:0.5.0'
110+
}
111+
```
112+
113+
## ProGuard
114+
115+
```
116+
-dontwarn permissions.dispatcher.processor.**
117+
-keep class permissions.dispatcher.** { *; }
118+
-keep class **PermissionsDispatcher { *; }
119+
-keepclasseswithmembernames class * {
120+
@permissions.dispatcher.* <methods>;
121+
}
122+
```
123+
124+
## License
125+
126+
```
127+
Copyright 2015 Shintaro Katafuchi
128+
129+
Licensed under the Apache License, Version 2.0 (the "License");
130+
you may not use this file except in compliance with the License.
131+
You may obtain a copy of the License at
132+
133+
http://www.apache.org/licenses/LICENSE-2.0
134+
135+
Unless required by applicable law or agreed to in writing, software
136+
distributed under the License is distributed on an "AS IS" BASIS,
137+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
138+
See the License for the specific language governing permissions and
139+
limitations under the License.
140+
```

0 commit comments

Comments
 (0)