Add gitbook hook on CI(#565)

Author: hotchemi

.travis.yml

@@ -4,6 +4,8 @@ env:
   global:
     - secure: "KY2ZIqFr6RCbZvFpCGo1CXtnmvbGq+uEw/haDOeva7V86A5K+2IzzoCdBTyIcGWo4MfAlfwvtr2z/5JTLQQ9XE2h0N1oVTqJCBPTmorXDFv7CNHxortje9Ra0jrQZY69pXCJePlI9XQ4QOS2pHMujucYt7RFTV/TmU3yI+xBd6PVVTt54mRCSrIAbl5YWGK9lHUWygBn+rLspmAxamSOccqjJlmotzqFp60gedgbrcGOPhLRcuESDn8w45fP0I1owXEhvnIOlMlTavoDc+qeMLckR9xyCYFqxt0jTPaQViR0+JPm7P9Qwho4r9dBcoK+ojqg56fyqQ89sckZ22jXqjmWrKViQdCEB5Oul/n2R2fgH+OfZ1eUffaNTKRAz8a7JgwmPC+X7BiQKxY+GGeZ7tlMxlSyGQGr5EDsAypr9R7r+6WuHtlM7wfSdWNWgMY+CnViJH0f1pl5nftqBzE2PJArU4w1r5tPdkVnGzUHgDrksTGU9WRQ4q/HP+8xZkQjsY1hRuXJlXm+SvMPNyJRn1yxyu2zeetdOmnEUHVN1TgGol3k/sHCUtqF6N4cskpCTFTdXNSZPd3uZs0JLhQR4ygJ6Es+yfPM6pae8jKmUNsUJpl9ctOpwvyZYIsc3rqtLjBWN47v6S/wtOmdJhh1uxz79K7vcPh1Z3pcfGgoVUs="
     - secure: "ucfbFyzFVzzmGivT3MrH7CbW1Wjs2B2gFIc/iqsJ/jF+1vh0ki2wwmE8pFFGo/4iKF59yCnj0NtxnInX3YVRtLOKD1bqS0yAPOskLlx3XhH5gg4owJ6vo9vuKoizcRabT/ss8SjlFkv7PDHmFWVyUtZmgjkwZbuQbTnMBQv1qzDo+AfS8cuDQAXvWzfMF1R9wEpc1/hmRCYMTpUS3c0qms2wxPatLLnXHGT3qVfHsAFm46mBiwA2K7G8UwRHLQCqC0RE9/4PDvmrTSt4xdq9PsY6CGqBHJmDW8ylWW6JONzFw4g3l/9GH0uBu4iryZmZORjTCRsIWbqzFcLCF+AN+mLxIsmRnRqabxOv4QRgIRq0S5ODfOkLbrAMTRH7P4JitwSnMUrG6Rfmb5XRTg6Di0L3Wd2n4wP9n7R/2037Z7C9/nwfv5UewCn75H5DynLGA00szLLe4ws4oY0OEJQQoCkjXkNoXvPuCv6XaVTg61JgSJGMJsjxNGGrAjXJvpXgGPdqMqert/quc5kdyabU0O7H9EfLBPQ0jFMrDXZkfjGRvyshp4bhIthIw1oerQy2DDtkPsQkhRajPg2AyHo5ttGnsr7fyZ1eAol8SgvP180zqsHJj8rPwET7WN+QgPA/xBuj9CFUpoRF3QFVoxMFouimgUhwKV1nZ8uCJ4vaSSA="
+    - secure: "BEOoJWIoQSp9j6XOxAIN3o7oe/RH6OePD+gGeX4PmQcqVnqYzUxVSUMknQSKzTpHlrXHPGOh2sJRCcNynSEhRryC/qEu73Z/lwgye+xnaz7YTnqo+lfVnzWDPvMTi4IuLJuL6R31ZeM9XOqvOA4k6RoxcbRp6WI4mPtrReipsq6bJwBRJlC6bnxIvrkmiRLm/E/clx1bfVVOpAMk6SELc/lBtXq20BO96J/WkUHGKmva5Pp7K8lQ+vXhCasHrmKxXrzYAvjZTnQGEZmTE5z3+2H8jQ9OBZdI13JOE+Lm+COIa+/GcEUNUsc0hReqJSJmC+7EzTWxDhxpUpjS+Pjy67Btly7cAo3U7HFTR/b00en+acAFeznsNc1tJDBWk+PQwxGyETxOfkZNcWn9RNHqZat/zIhIqbdwuu0M+IcvrZ3yRQV0UmIcnAHxU+e3+IXo9KXe3oz2Mi1VaxzH8pLftEHzDc3VXObnvFaKNSLdhIS2UdlFVX0iPfU2e7U6yKOI5z5MDzRVhgCHdMqyfAcoTOrwRePVoDk5UFxy9C2TAIIJ9xlfW4YydIbIJRahjtRe5+Jp2lH9qiBgjt6/IgiXpI4C6H+8rsfz4N7pssmymM7+0hQuSevWaJnhCt9kPdiwHzHJ3lUm/ud1WGZvQQUFH/pTQJXOYqxmDRivQlzWSWQ="
+    - secure: "znN56WtufsW5EYRWCbc5sJOkuVnZw8J2nhGTGCtLwXOrQhYZvVHlxhNmwkWctBF/kJHNtxGWnq3bcsD3wOm7a/BSdZDCS+JoL0MN75QY93a2xoEoBSO4Wr0oW2s2HFc/+Ik9O8EeeH4YImYUYoQ+LVuFJ6twr+8vQDjrt7S2cndiBdX9cXnMbz5hh98rSy5NFawafp0p+lby8eKV8HjdwDkyHyZGtg2BU1s01ef45iOAXmZtvuRffASIoRTvF8qTanqv90ZUzm50Pl3UcLEx7A5tR+/hExeK1pY5RiRGjrZEWawVIyBjOuQtvjFaLlfmVnIt44fwF7luuVWI6slxyDp/RsXAazOmaaB5vVt8KlhwTUxgQ2NGFXjVaC//C9AiMnnU4ZrBF/D33VkcyHBvtTATtlLbIQliG3x119UGWAjTzJwSAIc/YgEowKK/MR/qHfRSxz+HTR73KV8DA1/yaRAhLPUY9iJ4Kmn0uVKc4WxSJpq+bPyXf4FGmc1AOt4VkSYpwsBxB8kZiqq2er1z+u2lYf2LZFhZ1rtZxvccrQurDE30LSyg2oZAI75/x7o97CLciTu342CM4c1FayRUV4CxIHwOEPenb7DfYvEyiexPDG3/DACcMGVUsYa4oFw3dftufJK9fWkI308uG19L4wqcVvMqAXqpn1NbQU0Akxk="
 
 android:
   components:
@@ -24,14 +26,11 @@ before_install:
   - mkdir "$ANDROID_HOME/licenses" || true
   - cp ./android-sdk-licenses/* "$ANDROID_HOME/licenses/"
 
-branches:
-  except:
-    - gh-pages
-
 script: ./gradlew clean check --stacktrace
 
 after_success:
-  - "./scripts/deploy_snapshot.sh"
+  - ./scripts/deploy_snapshot.sh
+  - ./scripts/push-to-github-io.sh
 
 deploy:
   skip_cleanup: true
@@ -40,3 +39,10 @@ deploy:
   on:
     tags: true
     repo: permissions-dispatcher/PermissionsDispatcher
+
+cache:
+  directories:
+    - $HOME/.m2
+    - $HOME/.gradle/caches/
+    - $HOME/.gradle/wrapper/
+    - $HOME/.android/build-cache

.travis/deploy_key.enc

@@ -1,118 +1,18 @@
 # PermissionsDispatcher [![Build Status](https://travis-ci.org/permissions-dispatcher/PermissionsDispatcher.svg?branch=master)](https://travis-ci.org/permissions-dispatcher/PermissionsDispatcher)
 
-- [**Fully Kotlin support**](https://github.com/hotchemi/PermissionsDispatcher/blob/master/doc/kotlin_support.md)
+- [**Kotlin support**](https://github.com/hotchemi/PermissionsDispatcher/blob/master/doc/kotlin_support.md)
 - [**Special Permissions support**](https://github.com/hotchemi/PermissionsDispatcher/blob/master/doc/special_permissions.md)
 - **100% reflection-free**
 
 PermissionsDispatcher provides a simple annotation-based API to handle runtime permissions.
 
 This library lifts the burden that comes with writing a bunch of check statements whether a permission has been granted or not from you, in order to keep your code clean and safe.
 
-## Usage
-
-- If you're using Kotlin check [**Kotlin ver**](https://github.com/hotchemi/PermissionsDispatcher/blob/master/doc/kotlin_support.md) first of all.
-
-Here's a minimum example, in which you register a `MainActivity` which requires `Manifest.permission.CAMERA`.
-
-### 0. Prepare AndroidManifest
-
-Add the following line to `AndroidManifest.xml`:
- 
-`<uses-permission android:name="android.permission.CAMERA" />`
-
-### 1. Attach annotations
-
-PermissionsDispatcher introduces only a few annotations, keeping its general API concise:
-
-> NOTE: Annotated methods must not be `private`.
-
-|Annotation|Required|Description|
-|---|---|---|
-|`@RuntimePermissions`|**✓**|Register an `Activity` or `Fragment`(we support both) to handle permissions|
-|`@NeedsPermission`|**✓**|Annotate a method which performs the action that requires one or more permissions|
-|`@OnShowRationale`||Annotate a method which explains why the permission/s is/are needed. It passes in a `PermissionRequest` object which can be used to continue or abort the current permission request upon user input|
-|`@OnPermissionDenied`||Annotate a method which is invoked if the user doesn't grant the permissions|
-|`@OnNeverAskAgain`||Annotate a method which is invoked if the user chose to have the device "never ask again" about a permission|
-
-```java
-@RuntimePermissions
-public class MainActivity extends AppCompatActivity {
-
-    @NeedsPermission(Manifest.permission.CAMERA)
-    void showCamera() {
-        getSupportFragmentManager().beginTransaction()
-                .replace(R.id.sample_content_fragment, CameraPreviewFragment.newInstance())
-                .addToBackStack("camera")
-                .commitAllowingStateLoss();
-    }
-
-    @OnShowRationale(Manifest.permission.CAMERA)
-    void showRationaleForCamera(final PermissionRequest request) {
-        new AlertDialog.Builder(this)
-            .setMessage(R.string.permission_camera_rationale)
-            .setPositiveButton(R.string.button_allow, (dialog, button) -> request.proceed())
-            .setNegativeButton(R.string.button_deny, (dialog, button) -> request.cancel())
-            .show();
-    }
-
-    @OnPermissionDenied(Manifest.permission.CAMERA)
-    void showDeniedForCamera() {
-        Toast.makeText(this, R.string.permission_camera_denied, Toast.LENGTH_SHORT).show();
-    }
-
-    @OnNeverAskAgain(Manifest.permission.CAMERA)
-    void showNeverAskForCamera() {
-        Toast.makeText(this, R.string.permission_camera_neverask, Toast.LENGTH_SHORT).show();
-    }
-}
-```
-
-### 2. Delegate to generated class
-
-Upon compilation, PermissionsDispatcher generates a class for `MainActivityPermissionsDispatcher`([Activity Name] + PermissionsDispatcher), which you can use to safely access these permission-protected methods.
-
-The only step you have to do is delegating the work to this helper class:
-
-```java
-@Override
-protected void onCreate(Bundle savedInstanceState) {
-    super.onCreate(savedInstanceState);
-    setContentView(R.layout.activity_main);
-    findViewById(R.id.button_camera).setOnClickListener(v -> {
-      // NOTE: delegate the permission handling to generated method
-      MainActivityPermissionsDispatcher.showCameraWithPermissionCheck(this);
-    });
-}
-
-@Override
-public void onRequestPermissionsResult(int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults) {
-    super.onRequestPermissionsResult(requestCode, permissions, grantResults);
-    // NOTE: delegate the permission handling to generated method
-    MainActivityPermissionsDispatcher.onRequestPermissionsResult(this, requestCode, grantResults);
-}
-```
-
-Check out the [sample](https://github.com/hotchemi/PermissionsDispatcher/tree/master/sample) for more details.
-
-## Other features
-
-- [Getting Special Permissions](https://github.com/hotchemi/PermissionsDispatcher/blob/master/doc/special_permissions.md)
-- [maxSdkVersion](https://github.com/hotchemi/PermissionsDispatcher/blob/master/doc/maxsdkversion.md)
-- [IntelliJ plugin](https://github.com/shiraji/permissions-dispatcher-plugin)
-- AndroidAnnotations plugin
-  - If you use [AndroidAnnotations](http://androidannotations.org/), you need to add [AndroidAnnotationsPermissionsDispatcherPlugin](https://github.com/AleksanderMielczarek/AndroidAnnotationsPermissionsDispatcherPlugin).
-
-### Known issues
-
-If you're in trouble check known issues [list](https://github.com/hotchemi/PermissionsDispatcher/blob/master/doc/known_issues.md) before filing an issue.
-
-### Users
-
-Thankfully we've got hundreds of [users](https://github.com/hotchemi/PermissionsDispatcher/blob/master/doc/users.md) around the world!
+For more information please see [the website](https://permissions-dispatcher.github.io/).
 
 ## Download
 
-NOTE: 4.x only supports [Jetpack](https://developer.android.com/jetpack/). If you use appcompat 3.x which is almost stable is the way to go.
+NOTE: 4.x only supports [Jetpack](https://developer.android.com/jetpack/). If you still use appcompat 3.x is the way to go.
 
 To add PermissionsDispatcher to your project, include the following in your **app module** `build.gradle` file:
 
@@ -125,6 +25,17 @@ dependencies {
 }
 ```
 
+With Kotlin:
+
+```groovy
+apply plugin: 'kotlin-kapt'
+
+dependencies {
+  implementation "com.github.hotchemi:permissionsdispatcher:${latest.version}"
+  kapt "com.github.hotchemi:permissionsdispatcher-processor:${latest.version}"
+}
+```
+
 Snapshots of the development version are available in [JFrog's snapshots repository](https://oss.jfrog.org/oss-snapshot-local/). 
 Add the repo below to download `SNAPSHOT` releases.
 
@@ -135,13 +46,7 @@ repositories {
 }
 ```
 
-### Misc
-
-- If you include [Jitpack.io](https://jitpack.io/) dependencies in your project, it is important to review the order of the repositories available to your app module
-  - Because of the library's artifact ID, Jitpack might be tempted to resolve the dependency on its own, which could lead to an error during Gradle's configuration time
-- If you're going to bump up the major version number we recommend to refer to [migration guide](https://github.com/hotchemi/PermissionsDispatcher/blob/master/doc/migration_guide.md) 
-
-## Licence
+## License
 
 ```
 Copyright 2016 Shintaro Katafuchi, Marcel Schnelle, Yoshinori Isogai

README.md

@@ -0,0 +1,24 @@
+# Summary
+
+- [Introduction](README.md)
+
+## Getting Started
+
+- [Java](doc/java_usage.md)
+- [Kotlin](doc/kotlin_usage.md)
+
+## Features
+
+- [Special Permissions](doc/special_permissions.md)
+- [maxSdkVersion](doc/maxsdkversion.md)
+
+## Plugins
+
+- [IntelliJ plugin](https://github.com/shiraji/permissions-dispatcher-plugin)
+- [AndroidAnnotations plugin](https://github.com/permissions-dispatcher/AndroidAnnotationsPermissionsDispatcherPlugin)
+
+## Others
+
+- [Changelog](CHANGELOG.md)
+- [Users](doc/users.md)
+- [Migration Guide](doc/migration_guide.md)

SUMMARY.md

@@ -0,0 +1,83 @@
+## Usage with Java
+
+Here's a minimum example, in which you register a `MainActivity` which requires `Manifest.permission.CAMERA`.
+
+### 0. Prepare AndroidManifest
+
+Add the following line to `AndroidManifest.xml`:
+ 
+`<uses-permission android:name="android.permission.CAMERA" />`
+
+### 1. Attach annotations
+
+PermissionsDispatcher introduces only a few annotations, keeping its general API concise:
+
+> NOTE: Annotated methods must not be `private`.
+
+|Annotation|Required|Description|
+|---|---|---|
+|`@RuntimePermissions`|**✓**|Register an `Activity` or `Fragment`(we support both) to handle permissions|
+|`@NeedsPermission`|**✓**|Annotate a method which performs the action that requires one or more permissions|
+|`@OnShowRationale`||Annotate a method which explains why the permission/s is/are needed. It passes in a `PermissionRequest` object which can be used to continue or abort the current permission request upon user input|
+|`@OnPermissionDenied`||Annotate a method which is invoked if the user doesn't grant the permissions|
+|`@OnNeverAskAgain`||Annotate a method which is invoked if the user chose to have the device "never ask again" about a permission|
+
+```java
+@RuntimePermissions
+public class MainActivity extends AppCompatActivity {
+
+    @NeedsPermission(Manifest.permission.CAMERA)
+    void showCamera() {
+        getSupportFragmentManager().beginTransaction()
+                .replace(R.id.sample_content_fragment, CameraPreviewFragment.newInstance())
+                .addToBackStack("camera")
+                .commitAllowingStateLoss();
+    }
+
+    @OnShowRationale(Manifest.permission.CAMERA)
+    void showRationaleForCamera(final PermissionRequest request) {
+        new AlertDialog.Builder(this)
+            .setMessage(R.string.permission_camera_rationale)
+            .setPositiveButton(R.string.button_allow, (dialog, button) -> request.proceed())
+            .setNegativeButton(R.string.button_deny, (dialog, button) -> request.cancel())
+            .show();
+    }
+
+    @OnPermissionDenied(Manifest.permission.CAMERA)
+    void showDeniedForCamera() {
+        Toast.makeText(this, R.string.permission_camera_denied, Toast.LENGTH_SHORT).show();
+    }
+
+    @OnNeverAskAgain(Manifest.permission.CAMERA)
+    void showNeverAskForCamera() {
+        Toast.makeText(this, R.string.permission_camera_neverask, Toast.LENGTH_SHORT).show();
+    }
+}
+```
+
+### 2. Delegate to generated class
+
+Upon compilation, PermissionsDispatcher generates a class for `MainActivityPermissionsDispatcher`([Activity Name] + PermissionsDispatcher), which you can use to safely access these permission-protected methods.
+
+The only step you have to do is delegating the work to this helper class:
+
+```java
+@Override
+protected void onCreate(Bundle savedInstanceState) {
+    super.onCreate(savedInstanceState);
+    setContentView(R.layout.activity_main);
+    findViewById(R.id.button_camera).setOnClickListener(v -> {
+      // NOTE: delegate the permission handling to generated method
+      MainActivityPermissionsDispatcher.showCameraWithPermissionCheck(this);
+    });
+}
+
+@Override
+public void onRequestPermissionsResult(int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults) {
+    super.onRequestPermissionsResult(requestCode, permissions, grantResults);
+    // NOTE: delegate the permission handling to generated method
+    MainActivityPermissionsDispatcher.onRequestPermissionsResult(this, requestCode, grantResults);
+}
+```
+
+Check out the [sample](https://github.com/hotchemi/PermissionsDispatcher/tree/master/sample) for more details.

doc/java_usage.md

@@ -1,28 +1,13 @@
-## Fully Kotlin support
+## Usage with Kotlin
 
-From 3.0.0 we started support `.kt` file generation.
-
-Let's think about the same example as described in `README.md`.
+Here's a minimum example, in which you register a `MainActivity` which requires `Manifest.permission.CAMERA`.
 
 ### 0. Preparation
 
 Add the following line to `AndroidManifest.xml`:
 
 `<uses-permission android:name="android.permission.CAMERA" />`
 
-Include the following in your **app module** `build.gradle` file:
-
-`${latest.version}` is [![Download](https://api.bintray.com/packages/hotchemi/maven/permissionsdispatcher/images/download.svg)](https://bintray.com/hotchemi/maven/permissionsdispatcher/_latestVersion)
-
-```groovy
-apply plugin: 'kotlin-kapt'
-
-dependencies {
-  implementation "com.github.hotchemi:permissionsdispatcher:${latest.version}"
-  kapt "com.github.hotchemi:permissionsdispatcher-processor:${latest.version}"
-}
-```
-
 ### 1. Attach annotations
 
 > NOTE: Annotated methods must not be `private`.

doc/known_issues.md

@@ -1,4 +1,4 @@
-## Getting Special Permissions
+## Special Permissions
 
 PermissionsDispatcher takes care of special permissions `Manifest.permission.SYSTEM_ALERT_WINDOW` and `Manifest.permission.WRITE_SETTINGS`.
 

doc/kotlin_support.md doc/kotlin_usage.mddoc/kotlin_support.md renamed to doc/kotlin_usage.md

@@ -0,0 +1,46 @@
+#!/bin/bash
+
+declare repoName="permissions-dispatcher.github.io"
+declare repoUrl="[email protected]:permissions-dispatcher/${repoName}.git"
+declare distDir="_book"
+declare branch="master"
+declare commitMessage="Update content from TravisCI."
+
+commit_and_push_changes() {
+  git config --global user.email "$GH_USER_EMAIL" \
+    && git config --global user.name "$GH_USER_NAME" \
+    && git add -A \
+    && git commit --message "$2" \
+    && git push --quiet --force "${repoUrl}" "$1"
+}
+
+if [ "$TRAVIS_BRANCH" != "master" ] || [ "$TRAVIS_PULL_REQUEST" != "false" ]; then
+  echo "Skip updating gitbook: branch is not master or the build was triggered by pull request."
+  exit 0;
+fi
+
+echo "Decrypt deploy key"
+openssl aes-256-cbc -K $encrypted_786b61619ad8_key -iv $encrypted_786b61619ad8_iv -in .travis/deploy_key.enc -out deploy_key -d
+chmod 600 deploy_key
+eval `ssh-agent -s`
+ssh-add deploy_key
+
+echo "Clone repo"
+rm -rf ${repoName}
+git clone ${repoUrl} ${repoName}
+
+echo "Install Node and dependencies"
+. $HOME/.nvm/nvm.sh
+nvm install stable
+nvm use stable
+npm install -g gitbook-cli
+
+echo "Build HTML"
+gitbook build
+
+echo "Copy files"
+cp -Rf "${distDir}/doc"* "${distDir}/gitbook"* "${distDir}/*.html" "${distDir}/search_index.json" "${repoName}"
+
+echo "Commit and push"
+cd "${repoName}"
+commit_and_push_changes "${branch}" "${commitMessage}"