├── .buildscript └── checkstyle-hard.xml ├── .editorconfig ├── .gitignore ├── .travis.yml ├── LICENSE ├── README.md ├── build.gradle ├── consumer-proguard-rules.pro ├── gradle ├── compile.gradle ├── publishing.gradle ├── quality.gradle ├── scan.gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── proguard-rules.pro ├── settings.gradle └── src └── main ├── AndroidManifest.xml ├── java └── burrows │ └── apps │ └── example │ └── template │ ├── adapter │ └── BaseAdapter.java │ └── util │ └── PlayServicesUtils.java └── res ├── mipmap-hdpi └── ic_launcher.png ├── mipmap-mdpi └── ic_launcher.png ├── mipmap-xhdpi └── ic_launcher.png ├── mipmap-xxhdpi └── ic_launcher.png └── values ├── strings.xml └── styles.xml /.buildscript/checkstyle-hard.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 6 | 7 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | 121 | 122 | 123 | 124 | 125 | 126 | 127 | 128 | 129 | 130 | 131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | 143 | 144 | 145 | 146 | 147 | 148 | 149 | 150 | 151 | 152 | 153 | 154 | 155 | 156 | 157 | 158 | 159 | 160 | 161 | 162 | 163 | 164 | 165 | 166 | 167 | 168 | 169 | 170 | 171 | 172 | 173 | 174 | 175 | 176 | 177 | 178 | 179 | 180 | 181 | 182 | 183 | 184 | 185 | 186 | 187 | 188 | 189 | 190 | 191 | 192 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | # Change these settings to your own preference 4 | [*.{java,gradle}] 5 | indent_style = space 6 | indent_size = 4 7 | 8 | # We recommend you to keep these unchanged 9 | end_of_line = lf 10 | charset = utf-8 11 | trim_trailing_whitespace = true 12 | insert_final_newline = true 13 | 14 | [*.md] 15 | trim_trailing_whitespace = false 16 | 17 | [*.yml] 18 | indent_style = space 19 | indent_size = 2 20 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Created by https://www.gitignore.io 2 | 3 | ### Android ### 4 | # Built application files 5 | *.apk 6 | *.ap_ 7 | 8 | # Files for the Dalvik VM 9 | *.dex 10 | 11 | # Java class files 12 | *.class 13 | 14 | # Generated files 15 | bin/ 16 | gen/ 17 | 18 | # Gradle files 19 | .gradle/ 20 | build/ 21 | /*/build/ 22 | 23 | # Local configuration file (sdk path, etc) 24 | local.properties 25 | 26 | # Proguard folder generated by Eclipse 27 | proguard/ 28 | 29 | # Log Files 30 | *.log 31 | 32 | ### Android Patch ### 33 | gen-external-apklibs 34 | 35 | 36 | ### Intellij ### 37 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm 38 | 39 | *.iml 40 | 41 | ## Directory-based project format: 42 | .idea/ 43 | # if you remove the above rule, at least ignore the following: 44 | 45 | # User-specific stuff: 46 | # .idea/workspace.xml 47 | # .idea/tasks.xml 48 | # .idea/dictionaries 49 | 50 | # Sensitive or high-churn files: 51 | # .idea/dataSources.ids 52 | # .idea/dataSources.xml 53 | # .idea/sqlDataSources.xml 54 | # .idea/dynamic.xml 55 | # .idea/uiDesigner.xml 56 | 57 | # Gradle: 58 | # .idea/gradle.xml 59 | # .idea/libraries 60 | 61 | # Mongo Explorer plugin: 62 | # .idea/mongoSettings.xml 63 | 64 | ## File-based project format: 65 | *.ipr 66 | *.iws 67 | 68 | ## Plugin-specific files: 69 | 70 | # IntelliJ 71 | out/ 72 | 73 | # mpeltonen/sbt-idea plugin 74 | .idea_modules/ 75 | 76 | # JIRA plugin 77 | atlassian-ide-plugin.xml 78 | 79 | # Crashlytics plugin (for Android Studio and IntelliJ) 80 | com_crashlytics_export_strings.xml 81 | crashlytics.properties 82 | crashlytics-build.properties 83 | 84 | 85 | ### Java ### 86 | *.class 87 | 88 | # Mobile Tools for Java (J2ME) 89 | .mtj.tmp/ 90 | 91 | # Package Files # 92 | *.jar 93 | *.war 94 | *.ear 95 | 96 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml 97 | hs_err_pid* 98 | 99 | 100 | ### Gradle ### 101 | .gradle 102 | build/ 103 | 104 | # Ignore Gradle GUI config 105 | gradle-app.setting 106 | 107 | # Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored) 108 | !gradle-wrapper.jar 109 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: android 2 | 3 | jdk: oraclejdk8 4 | 5 | install: 6 | - yes | sdkmanager "tools" &>/dev/null 7 | - yes | sdkmanager "platform-tools" &>/dev/null 8 | - yes | sdkmanager "platforms;android-28" &>/dev/null 9 | - yes | sdkmanager --update &>/dev/null 10 | - yes | sdkmanager --licenses &>/dev/null 11 | 12 | script: ./gradlew clean assembleDebug --scan -s 13 | 14 | branches: 15 | except: 16 | - gh-pages 17 | 18 | sudo: false 19 | 20 | cache: 21 | directories: 22 | - $HOME/.m2 23 | - $HOME/.gradle 24 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 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. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Android Gradle Java Library Template 2 | 3 | [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0) 4 | [![TravisCI OSX Build](https://img.shields.io/travis/jaredsburrows/android-gradle-java-library-template/master.svg)](https://travis-ci.org/jaredsburrows/android-gradle-java-library-template) 5 | [![Coveralls Code Coverage](https://img.shields.io/coveralls/jaredsburrows/android-gradle-java-library-template/master.svg?label=Code%20Coverage)](https://coveralls.io/github/jaredsburrows/android-gradle-java-library-template?branch=master) 6 | [![Twitter Follow](https://img.shields.io/twitter/follow/jaredsburrows.svg?style=social)](https://twitter.com/jaredsburrows) 7 | 8 | Gradle + Android Studio + Robolectric + Espresso + Mockito + EasyMock/PowerMock + JaCoCo 9 | 10 | ## Technologies used: 11 | #### Build Tools: 12 | |Name|Description| 13 | |---|---| 14 | | [Gradle](http://gradle.org/docs/current/release-notes) | Gradle build system | 15 | | [Android Gradle Build Tools](http://tools.android.com/tech-docs/new-build-system) | Official Gradle Plugin | 16 | | [Android SDK](http://developer.android.com/tools/revisions/platforms.html#5.1) | Official SDK | 17 | | [Android SDK Build Tools](http://developer.android.com/tools/revisions/build-tools.html) | Official Build Tools | 18 | | [Android Studio](http://tools.android.com/recent) or | Official IDE | 19 | | [Intellij](https://www.jetbrains.com/idea/download/) | Intellij IDE | 20 | 21 | #### Testing Frameworks: 22 | |Name|Description| 23 | |---|---| 24 | | [JUnit](https://github.com/junit-team/junit) | Java Unit Testing Framework | 25 | | [AssertJ](http://joel-costigliola.github.io/assertj/) | Matchers for Unit Tests | 26 | | [Mockito](https://github.com/mockito/mockito) | Mocking Framework | 27 | 28 | #### Reporting Plugins: 29 | |Name|Description| 30 | |---|---| 31 | | [JaCoCo](http://www.eclemma.org/jacoco/) | JaCoCo Test Coverage | 32 | | [Coveralls](https://coveralls.io/) | Hosts test reports published from TravisCI | 33 | 34 | #### Continuous Integration: 35 | |Name|Description| 36 | |---|---| 37 | | [TravisCI](http://docs.travis-ci.com/user/languages/android/) | Build Server(Builds, Tests, Publishes reports to Coveralls) | 38 | 39 | # Getting Started: 40 | ## `Android Studio` or `Intellij` Support(Simple): 41 | - **Import/Open this project with Android Studio/Intellij(click on `build.gradle`)** 42 | 43 | - **Unit Tests:** 44 | - Change the Build Variant Test Artifact to `Unit Tests` 45 | - Right click a unit test located in `src/main/test` and click test 46 | 47 | ## Comand Line(Advanced): 48 | ##### Clone with `Git`: 49 | - `git clone https://github.com/jaredsburrows/android-gradle-java-library-template.git` 50 | - `cd android-gradle-java-library-template` 51 | 52 | ##### Publish via the Gradle "maven" plugin: 53 | - **Install Maven `debug flavor` dependencies locally:** 54 | - `gradlew assembleDebug installArchives` 55 | - **Upload Maven `debug flavor` dependencies to a specified repository:** 56 | - `gradlew assembleDebug uploadArchives` 57 | 58 | ##### Publish via the Gradle "maven-publish" plugin: 59 | - **Install Maven `debug flavor` dependencies locally:** 60 | - `gradlew assembleDebug publishDebugPublicationToMavenLocalRepository` 61 | - **Upload Maven `debug flavor` dependencies to a specified repository:** 62 | - `gradlew assembleDebug publish` 63 | 64 | ##### Publish via the Jfrog Bintray plugin: 65 | - **Upload Maven `debug flavor` dependencies to Jfrog Bintray:** 66 | - `gradlew assembleDebug bintrayUpload` 67 | 68 | ##### Running Unit Tests with `Gradle`: 69 | - **Run all unit tests in all `flavors`:** 70 | - `gradlew test` 71 | - **Run a single unit test in all `flavors`:** 72 | - `gradlew test --tests="*MainActivityTest*"` 73 | - **Run all unit `debug flavor` tests:** 74 | - `gradlew testDebug` 75 | - **Run a single unit test in the `debug flavor`:** 76 | - `gradlew testDebug --tests="*MainActivityTest*"` 77 | - **Run a single unit test in the `debug flavor` with `Jacoco` test reports:** 78 | - `gradlew testDebug --tests="*MainActivityTest*" jacocoDebugReport` 79 | -------------------------------------------------------------------------------- /build.gradle: -------------------------------------------------------------------------------- 1 | buildscript { 2 | repositories { 3 | google() 4 | gradlePluginPortal() 5 | } 6 | 7 | dependencies { 8 | classpath "com.gradle:build-scan-plugin:2.1" 9 | classpath "com.android.tools.build:gradle:3.3.0" 10 | classpath "com.getkeepsafe.dexcount:dexcount-gradle-plugin:0.8.5" 11 | classpath "com.github.ben-manes:gradle-versions-plugin:0.20.0" 12 | classpath "com.jfrog.bintray.gradle:gradle-bintray-plugin:1.8.4" 13 | } 14 | } 15 | 16 | repositories { 17 | google() 18 | gradlePluginPortal() 19 | } 20 | 21 | apply from: "gradle/scan.gradle" 22 | apply plugin: "com.android.library" 23 | apply plugin: "com.getkeepsafe.dexcount" 24 | apply plugin: "com.github.ben-manes.versions" 25 | apply from: "gradle/compile.gradle" 26 | //apply from: "gradle/quality.gradle" 27 | //apply from: "gradle/publishing.gradle" 28 | 29 | android { 30 | compileSdkVersion 28 31 | 32 | defaultConfig { 33 | versionCode 1 34 | versionName "1.0" 35 | minSdkVersion 16 36 | targetSdkVersion 28 37 | consumerProguardFile "consumer-proguard-rules.pro" 38 | } 39 | 40 | buildTypes { 41 | release { 42 | minifyEnabled false 43 | proguardFile getDefaultProguardFile("proguard-android-optimize.txt") 44 | proguardFile "proguard-rules.pro" 45 | } 46 | } 47 | 48 | compileOptions { 49 | sourceCompatibility JavaVersion.VERSION_1_8 50 | targetCompatibility JavaVersion.VERSION_1_8 51 | } 52 | 53 | dexOptions { 54 | preDexLibraries !Boolean.valueOf(System.getenv("TRAVIS")) 55 | } 56 | 57 | lintOptions { 58 | textOutput "stdout" 59 | checkAllWarnings true 60 | warningsAsErrors true 61 | disable "UnusedResources" // Unused will be removed on release 62 | disable "IconExpectedSize" // Using the material icons provided from Google 63 | disable "GoogleAppIndexingApiWarning" // We might want to index our app later 64 | disable "InvalidPackage" // Butterknife, Okio and Realm 65 | disable "ResourceType" // Annotation binding 66 | disable "GradleDependency" 67 | disable "NewerVersionAvailable" 68 | } 69 | } 70 | 71 | dependencies { 72 | // Android Support Library for AppCompat 73 | compile "com.android.support:appcompat-v7:28.0.0" 74 | 75 | // Android Support Library for the CardView 76 | compile "com.android.support:cardview-v7:28.0.0" 77 | 78 | // Android Support Library for the RecyclerView 79 | compile "com.android.support:recyclerview-v7:28.0.0" 80 | 81 | // Google Play Services 82 | compile "com.google.android.gms:play-services-ads:10.2.0" 83 | compile "com.google.android.gms:play-services-basement:10.2.0" 84 | compile "com.google.android.gms:play-services-base:10.2.0" 85 | 86 | // Junit 87 | testCompile "junit:junit:4.12" 88 | 89 | // Mockito 90 | testCompile "org.mockito:mockito-core:2.23.4" 91 | 92 | // AssertJ 93 | testCompile "com.android.support:support-annotations:25.2.0" 94 | testCompile "org.assertj:assertj-core:1.7.1" 95 | } 96 | -------------------------------------------------------------------------------- /consumer-proguard-rules.pro: -------------------------------------------------------------------------------- 1 | # consumer 2 | -------------------------------------------------------------------------------- /gradle/compile.gradle: -------------------------------------------------------------------------------- 1 | tasks.withType(JavaCompile) { 2 | sourceCompatibility = JavaVersion.VERSION_1_8 3 | targetCompatibility = JavaVersion.VERSION_1_8 4 | 5 | configure(options) { 6 | compilerArgs << '-Xlint:all' 7 | compilerArgs << '-Xlint:-options' 8 | compilerArgs << '-Werror' 9 | encoding = 'utf-8' 10 | fork = true 11 | } 12 | } 13 | 14 | tasks.withType(Test) { 15 | // Turn on logging for all tests, filter to show failures/skips only 16 | testLogging { 17 | exceptionFormat 'full' 18 | showCauses true 19 | showExceptions true 20 | showStackTraces true 21 | events 'failed', 'skipped' 22 | } 23 | 24 | failFast = true 25 | maxParallelForks = Runtime.runtime.availableProcessors().intdiv(2) ?: 1 26 | } 27 | 28 | tasks.withType(Javadoc) { 29 | title = "${project.name} ${project.version}" 30 | configure(options) { 31 | header = project.name 32 | encoding 'UTF-8' 33 | docEncoding 'UTF-8' 34 | charSet 'UTF-8' 35 | linkSource true 36 | author = true 37 | links('http://docs.oracle.com/javase/8/docs/api/', 38 | 'http://docs.oracle.com/javaee/7/api/') 39 | exclude "**/*Test.java" 40 | if (JavaVersion.current().java8Compatible) addStringOption('Xdoclint:none', '-quiet') 41 | } 42 | } 43 | -------------------------------------------------------------------------------- /gradle/publishing.gradle: -------------------------------------------------------------------------------- 1 | apply plugin: "maven" 2 | apply plugin: "maven-publish" 3 | apply plugin: "signing" 4 | apply plugin: "com.jfrog.bintray" 5 | 6 | // Create a custom POM file for our artifacts 7 | // See: https://maven.apache.org/pom.html 8 | def pomConfig = { 9 | //noinspection UnnecessaryQualifiedReference 10 | resolveStrategy = Closure.DELEGATE_FIRST 11 | name project.name 12 | description project.description 13 | url "https://github.com/jaredsburrows/android-gradle-java-library-template" 14 | 15 | issueManagement { 16 | system "github" 17 | url "https://github.com/jaredsburrows/android-gradle-java-library-template/issues" 18 | } 19 | 20 | scm { 21 | url "https://github.com/jaredsburrows/android-gradle-java-library-template" 22 | connection "scm:https://github.com/jaredsburrows/android-gradle-java-library-template" 23 | developerConnection "scm:git@github.com:jaredsburrows/android-gradle-java-library-template.git" 24 | } 25 | 26 | licenses { 27 | license { 28 | name "The Apache Software License, Version 2.0" 29 | url "http://www.apache.org/licenses/LICENSE-2.0.txt" 30 | distribution "repo" 31 | } 32 | } 33 | 34 | developers { 35 | developer { 36 | id "jaredsburrows" 37 | name "Jared Burrows" 38 | email "jaredsburrows@gmail.com" 39 | } 40 | } 41 | } 42 | 43 | // This DSL is from the "maven-publish" plugin 44 | // See: https://docs.gradle.org/current/userguide/publishing_maven.html 45 | publishing { 46 | // Publish to local repository 47 | repositories { 48 | mavenLocal() // ~/.m2 49 | } 50 | 51 | publications { 52 | // Create tasks based on the application build variant (productFlavor + buildType = variant) 53 | android.libraryVariants.all { variant -> 54 | 55 | def variantName = variant.name.capitalize() 56 | 57 | /** 58 | * Generate Jar of Java sources. 59 | */ 60 | def jarSourceTask = task("jar${variantName}Sources", type: Jar) { 61 | description = "Generates Java Sources for ${variantName}." 62 | group = "artifact" 63 | classifier = "sources" 64 | from variant.javaCompile.source 65 | } 66 | jarSourceTask.dependsOn variant.javaCompile 67 | artifacts.add("archives", jarSourceTask) 68 | 69 | /** 70 | * Generate Javadocs. 71 | */ 72 | def javadocTask = task("generate${variantName}Javadocs", type: Javadoc) { 73 | description = "Generates Javadoc for ${variantName}." 74 | source = variant.javaCompile.source 75 | classpath += files(variant.javaCompile.classpath.files) 76 | classpath += files(android.getBootClasspath().join(File.pathSeparator)) 77 | classpath += files("${android.sdkDirectory}/platforms/${android.compileSdkVersion}/android.jar") 78 | exclude "**/R.java" 79 | } 80 | javadocTask.dependsOn variant.javaCompile 81 | 82 | /** 83 | * Generate Jar of Javadocs. 84 | */ 85 | def jarJavadocTask = task("jar${variantName}Javadocs", type: Jar) { 86 | description = "Generate Javadoc Jar for ${variantName}." 87 | group = "artifact" 88 | classifier = "javadoc" 89 | from javadocTask.destinationDir 90 | } 91 | jarJavadocTask.dependsOn javadocTask 92 | artifacts.add("archives", jarJavadocTask) 93 | 94 | // Create custom publication based on the "variant" 95 | // "Debug" and "Release" variants 96 | "${variantName}"(MavenPublication) { 97 | artifact "${project.buildDir}/outputs/aar/${project.name}-${variant.name}.aar" 98 | artifact jarSourceTask 99 | artifact jarJavadocTask 100 | 101 | // Add dependencies to POM - normal Java projects use "from components.java" 102 | pom { 103 | withXml { 104 | def root = asNode() 105 | 106 | // List dependencies 107 | def dependenciesNode = root.appendNode("dependencies") 108 | configurations.compile.allDependencies.each { 109 | def dependencyNode = dependenciesNode.appendNode("dependency") 110 | dependencyNode.appendNode("groupId", it.group) 111 | dependencyNode.appendNode("artifactId", it.name) 112 | dependencyNode.appendNode("version", it.version) 113 | } 114 | 115 | // Add parent POM information 116 | root.children().last() + pomConfig 117 | } 118 | } 119 | } 120 | } 121 | } 122 | } 123 | //publish.dependsOn assembleRelease, sourcesJar, javadocJar, testsJar, reportsZip 124 | //publish.dependsOn "generatePomFileForMavenPublication" 125 | 126 | // See: https://docs.gradle.org/current/dsl/org.gradle.plugins.signing.Sign.html 127 | signing { 128 | required { project.version.contains("SNAPSHOT") && gradle.taskGraph.hasTask("uploadArchives") } 129 | sign configurations.archives 130 | } 131 | 132 | // This DSL is from the "maven" plugin 133 | // See: https://docs.gradle.org/current/userguide/maven_plugin.html 134 | // The artifacts are automatically added via "artifacts.add("archives", jarJavadocTask)" 135 | uploadArchives { 136 | repositories { 137 | mavenDeployer { 138 | 139 | beforeDeployment { MavenDeployment deployment -> signing.signPom(deployment) } 140 | 141 | repository(url: "repo") {} 142 | snapshotRepository(url: "repo-snapshot") {} 143 | 144 | pom { 145 | groupId = project.group // project.group = "burrows.apps" 146 | artifactId = "template" // project.name = android-gradle-java-library-template 147 | version = project.version // project.version = "1.0" 148 | } 149 | } 150 | } 151 | } 152 | 153 | /** 154 | * Publish 'archives' artifacts into the local Maven repository. 155 | * To use the local maven repository, located here: "~/.m2", setup your repository: 156 | */ 157 | // See: https://docs.gradle.org/current/dsl/org.gradle.api.tasks.Upload.html 158 | task installArchives(type: Upload) { 159 | 160 | group = "Upload" 161 | description = "Installs the ':archives' artifacts into the local Maven repository." 162 | 163 | configuration = configurations.archives 164 | 165 | repositories { 166 | mavenInstaller { 167 | pom { 168 | groupId = project.group // project.group = "burrows.apps" 169 | artifactId = "template" // project.name = android-gradle-java-library-template 170 | version = project.version // project.version = "1.0" 171 | } 172 | } 173 | } 174 | } 175 | 176 | // Setup our build to publish to Jfrog Bintray - "jcenter()" 177 | bintray { 178 | // Add these variables to your local "gradle.properties" or in your "~/.gradle/gradle.properties" 179 | user = project.hasProperty("bintrayUsername") ? project.property("bintrayUsername") : "" 180 | key = project.hasProperty("bintrayApiKey") ? project.property("bintrayApiKey") : "" 181 | publications = ["Release"] // "Debug" and "Release" variants generated by the 182 | publish = true 183 | pkg { 184 | repo = "maven" 185 | name = project.name 186 | desc = project.description 187 | websiteUrl = "https://github.com/jaredsburrows/android-gradle-java-library-template" 188 | issueTrackerUrl = "https://github.com/jaredsburrows/android-gradle-java-library-template/issues" 189 | vcsUrl = "https://github.com/jaredsburrows/android-gradle-java-library-template.git" 190 | licenses = ["Apache-2.0"] 191 | labels = ["burrows", "apps", "android", "template", "library"] 192 | version { 193 | name = project.version 194 | desc = project.description 195 | mavenCentralSync { 196 | sync = false 197 | // Add these variables to your local "gradle.properties" or in your "~/.gradle/gradle.properties" 198 | user = project.hasProperty("sonatypeUsername") ? project.property("sonatypeUsername") : "" 199 | password = project.hasProperty("sonatypeUsername") ? project.property("sonatypePassword") : "" 200 | close = "1" 201 | } 202 | } 203 | } 204 | } 205 | //bintrayUpload.dependsOn assembleRelease, sourcesJar, javadocJar, testsJar, reportsZip 206 | //bintrayUpload.dependsOn "generatePomFileForMavenPublication" 207 | -------------------------------------------------------------------------------- /gradle/quality.gradle: -------------------------------------------------------------------------------- 1 | apply plugin: "pmd" 2 | apply plugin: "jacoco" 3 | apply plugin: "findbugs" 4 | apply plugin: "checkstyle" 5 | 6 | // Creates tasks based on the application build variant (productFlavor + buildType = variant) 7 | android.libraryVariants.all { variant -> 8 | def variantName = variant.name.capitalize() 9 | def autoGenerated = ['**/R.class', 10 | '**/R$*.class', 11 | '**/Manifest*.*', 12 | 'android/**/*.*', 13 | '**/BuildConfig.*', 14 | '**/*$ViewBinder*.*', 15 | '**/*$ViewInjector*.*', 16 | '**/Lambda$*.class', 17 | '**/Lambda.class', 18 | '**/*Lambda.class', 19 | '**/*Lambda*.class'] 20 | 21 | // Generates Lint reports based off the source code. 22 | variant.assemble.dependsOn "lint$variantName" 23 | 24 | /** 25 | * Generates Lint reports based off the source code. 26 | */ 27 | task("pmd$variantName", type: Pmd, dependsOn: "assemble$variantName") { 28 | group "Reporting" 29 | description "Generate ${variantName} Pmd reports." 30 | 31 | ignoreFailures = true 32 | reports { 33 | xml.enabled = true 34 | html.enabled = true 35 | } 36 | 37 | source = files(variant.javaCompiler.source) 38 | classpath = files(configurations.compile.files) 39 | } 40 | 41 | /** 42 | * Generates Jacoco coverage reports based off the unit tests. 43 | */ 44 | task("jacoco${variantName}Report", type: JacocoReport, dependsOn: "test${variantName}UnitTest") { 45 | group "Reporting" 46 | description "Generate ${variantName} Jacoco coverage reports." 47 | 48 | reports { 49 | xml.enabled = true 50 | html.enabled = true 51 | } 52 | 53 | // variant.javaCompile.source does not work 54 | // traverses from starting point 55 | sourceDirectories = files(android.sourceSets.main.java.srcDirs) 56 | executionData = files("${buildDir}/jacoco/test${variantName}UnitTest.exec") 57 | classDirectories = fileTree(dir: variant.javaCompiler.destinationDir, excludes: autoGenerated) 58 | } 59 | 60 | /** 61 | * Generates FindBugs reports based off the source code. 62 | */ 63 | task("findbugs$variantName", type: FindBugs, dependsOn: "assemble$variantName") { 64 | group "Reporting" 65 | description "Generate ${variantName} Findbugs reports." 66 | 67 | ignoreFailures = true 68 | reports { 69 | xml.enabled = false 70 | html.enabled = true 71 | } 72 | 73 | effort = "max" 74 | reportLevel = "low" 75 | source = files(variant.javaCompiler.source) 76 | classpath = files(configurations.compile.files) 77 | classes = fileTree(dir: variant.javaCompile.destinationDir, excludes: autoGenerated) 78 | } 79 | 80 | /** 81 | * Generates Checkstyle reports based off the source code. 82 | */ 83 | task("checkstyle$variantName", type: Checkstyle, dependsOn: "assemble$variantName") { 84 | group "Reporting" 85 | description "Generate ${variantName} Checkstyle reports." 86 | 87 | ignoreFailures = true 88 | reports.html.enabled = true 89 | 90 | configFile = rootProject.file("./.buildscript/checkstyle-hard.xml") 91 | source = files(android.sourceSets.main.java.srcDirs) 92 | classpath = files(configurations.compile.files) 93 | } 94 | } 95 | -------------------------------------------------------------------------------- /gradle/scan.gradle: -------------------------------------------------------------------------------- 1 | apply plugin: "com.gradle.build-scan" 2 | 3 | buildScan { 4 | termsOfServiceUrl = "https://gradle.com/terms-of-service" 5 | termsOfServiceAgree = "yes" 6 | } 7 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jaredsburrows/android-gradle-java-library-template/f10cb058e315110ea54df964ac9865e17d21cc1e/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-5.1.1-all.zip 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Attempt to set APP_HOME 10 | # Resolve links: $0 may be a link 11 | PRG="$0" 12 | # Need this for relative symlinks. 13 | while [ -h "$PRG" ] ; do 14 | ls=`ls -ld "$PRG"` 15 | link=`expr "$ls" : '.*-> \(.*\)$'` 16 | if expr "$link" : '/.*' > /dev/null; then 17 | PRG="$link" 18 | else 19 | PRG=`dirname "$PRG"`"/$link" 20 | fi 21 | done 22 | SAVED="`pwd`" 23 | cd "`dirname \"$PRG\"`/" >/dev/null 24 | APP_HOME="`pwd -P`" 25 | cd "$SAVED" >/dev/null 26 | 27 | APP_NAME="Gradle" 28 | APP_BASE_NAME=`basename "$0"` 29 | 30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 31 | DEFAULT_JVM_OPTS='"-Xmx64m"' 32 | 33 | # Use the maximum available, or set MAX_FD != -1 to use that value. 34 | MAX_FD="maximum" 35 | 36 | warn () { 37 | echo "$*" 38 | } 39 | 40 | die () { 41 | echo 42 | echo "$*" 43 | echo 44 | exit 1 45 | } 46 | 47 | # OS specific support (must be 'true' or 'false'). 48 | cygwin=false 49 | msys=false 50 | darwin=false 51 | nonstop=false 52 | case "`uname`" in 53 | CYGWIN* ) 54 | cygwin=true 55 | ;; 56 | Darwin* ) 57 | darwin=true 58 | ;; 59 | MINGW* ) 60 | msys=true 61 | ;; 62 | NONSTOP* ) 63 | nonstop=true 64 | ;; 65 | esac 66 | 67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 68 | 69 | # Determine the Java command to use to start the JVM. 70 | if [ -n "$JAVA_HOME" ] ; then 71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 72 | # IBM's JDK on AIX uses strange locations for the executables 73 | JAVACMD="$JAVA_HOME/jre/sh/java" 74 | else 75 | JAVACMD="$JAVA_HOME/bin/java" 76 | fi 77 | if [ ! -x "$JAVACMD" ] ; then 78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 79 | 80 | Please set the JAVA_HOME variable in your environment to match the 81 | location of your Java installation." 82 | fi 83 | else 84 | JAVACMD="java" 85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 86 | 87 | Please set the JAVA_HOME variable in your environment to match the 88 | location of your Java installation." 89 | fi 90 | 91 | # Increase the maximum file descriptors if we can. 92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then 93 | MAX_FD_LIMIT=`ulimit -H -n` 94 | if [ $? -eq 0 ] ; then 95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 96 | MAX_FD="$MAX_FD_LIMIT" 97 | fi 98 | ulimit -n $MAX_FD 99 | if [ $? -ne 0 ] ; then 100 | warn "Could not set maximum file descriptor limit: $MAX_FD" 101 | fi 102 | else 103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 104 | fi 105 | fi 106 | 107 | # For Darwin, add options to specify how the application appears in the dock 108 | if $darwin; then 109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 110 | fi 111 | 112 | # For Cygwin, switch paths to Windows format before running java 113 | if $cygwin ; then 114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 116 | JAVACMD=`cygpath --unix "$JAVACMD"` 117 | 118 | # We build the pattern for arguments to be converted via cygpath 119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 120 | SEP="" 121 | for dir in $ROOTDIRSRAW ; do 122 | ROOTDIRS="$ROOTDIRS$SEP$dir" 123 | SEP="|" 124 | done 125 | OURCYGPATTERN="(^($ROOTDIRS))" 126 | # Add a user-defined pattern to the cygpath arguments 127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 129 | fi 130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 131 | i=0 132 | for arg in "$@" ; do 133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 135 | 136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 138 | else 139 | eval `echo args$i`="\"$arg\"" 140 | fi 141 | i=$((i+1)) 142 | done 143 | case $i in 144 | (0) set -- ;; 145 | (1) set -- "$args0" ;; 146 | (2) set -- "$args0" "$args1" ;; 147 | (3) set -- "$args0" "$args1" "$args2" ;; 148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 154 | esac 155 | fi 156 | 157 | # Escape application args 158 | save () { 159 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done 160 | echo " " 161 | } 162 | APP_ARGS=$(save "$@") 163 | 164 | # Collect all arguments for the java command, following the shell quoting and substitution rules 165 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" 166 | 167 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong 168 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then 169 | cd "$(dirname "$0")" 170 | fi 171 | 172 | exec "$JAVACMD" "$@" 173 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @if "%DEBUG%" == "" @echo off 2 | @rem ########################################################################## 3 | @rem 4 | @rem Gradle startup script for Windows 5 | @rem 6 | @rem ########################################################################## 7 | 8 | @rem Set local scope for the variables with windows NT shell 9 | if "%OS%"=="Windows_NT" setlocal 10 | 11 | set DIRNAME=%~dp0 12 | if "%DIRNAME%" == "" set DIRNAME=. 13 | set APP_BASE_NAME=%~n0 14 | set APP_HOME=%DIRNAME% 15 | 16 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 17 | set DEFAULT_JVM_OPTS="-Xmx64m" 18 | 19 | @rem Find java.exe 20 | if defined JAVA_HOME goto findJavaFromJavaHome 21 | 22 | set JAVA_EXE=java.exe 23 | %JAVA_EXE% -version >NUL 2>&1 24 | if "%ERRORLEVEL%" == "0" goto init 25 | 26 | echo. 27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 28 | echo. 29 | echo Please set the JAVA_HOME variable in your environment to match the 30 | echo location of your Java installation. 31 | 32 | goto fail 33 | 34 | :findJavaFromJavaHome 35 | set JAVA_HOME=%JAVA_HOME:"=% 36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 37 | 38 | if exist "%JAVA_EXE%" goto init 39 | 40 | echo. 41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 42 | echo. 43 | echo Please set the JAVA_HOME variable in your environment to match the 44 | echo location of your Java installation. 45 | 46 | goto fail 47 | 48 | :init 49 | @rem Get command-line arguments, handling Windows variants 50 | 51 | if not "%OS%" == "Windows_NT" goto win9xME_args 52 | 53 | :win9xME_args 54 | @rem Slurp the command line arguments. 55 | set CMD_LINE_ARGS= 56 | set _SKIP=2 57 | 58 | :win9xME_args_slurp 59 | if "x%~1" == "x" goto execute 60 | 61 | set CMD_LINE_ARGS=%* 62 | 63 | :execute 64 | @rem Setup the command line 65 | 66 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 67 | 68 | @rem Execute Gradle 69 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 70 | 71 | :end 72 | @rem End local scope for the variables with windows NT shell 73 | if "%ERRORLEVEL%"=="0" goto mainEnd 74 | 75 | :fail 76 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 77 | rem the _cmd.exe /c_ return code! 78 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 79 | exit /b 1 80 | 81 | :mainEnd 82 | if "%OS%"=="Windows_NT" endlocal 83 | 84 | :omega 85 | -------------------------------------------------------------------------------- /proguard-rules.pro: -------------------------------------------------------------------------------- 1 | # library 2 | -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | rootProject.name = "android-gradle-java-library-template" 2 | -------------------------------------------------------------------------------- /src/main/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | 2 | 7 | 8 | 9 | 10 | 11 | 17 | 18 | 27 | 28 | -------------------------------------------------------------------------------- /src/main/java/burrows/apps/example/template/adapter/BaseAdapter.java: -------------------------------------------------------------------------------- 1 | package burrows.apps.example.template.adapter; 2 | 3 | import android.support.v7.widget.RecyclerView; 4 | import android.util.SparseBooleanArray; 5 | 6 | import java.util.ArrayList; 7 | import java.util.Collections; 8 | import java.util.Comparator; 9 | import java.util.List; 10 | 11 | /** 12 | * @author Jared Burrows 13 | */ 14 | @SuppressWarnings("checkstyle:visibilitymodifier") 15 | public abstract class BaseAdapter extends RecyclerView.Adapter { 16 | 17 | /** Data in the Adapter. */ 18 | protected List data = new ArrayList<>(); 19 | /** Selected items in the Adapter. */ 20 | protected SparseBooleanArray selectedItems = new SparseBooleanArray(); 21 | 22 | /** 23 | * Returns the number of elements in the data. 24 | * 25 | * @return the number of elements in the data. 26 | */ 27 | @Override 28 | public int getItemCount() { 29 | return this.data.size(); 30 | } 31 | 32 | /** 33 | * Returns the instance of the data. 34 | * 35 | * @return instance of the data. 36 | */ 37 | public List getList() { 38 | return this.data; 39 | } 40 | 41 | /** 42 | * Returns the element at the specified location in the data. 43 | * 44 | * @param location the index of the element to return. 45 | * 46 | * @return the element at the specified location. 47 | * 48 | * @exception IndexOutOfBoundsException if {@code location < 0 || location >= size()} 49 | */ 50 | public T getItem(final int location) { 51 | return this.data.get(location); 52 | } 53 | 54 | /** 55 | * Searches the data for the specified object and returns the index of the 56 | * first occurrence. 57 | * 58 | * @param object the object to search for. 59 | * 60 | * @return the index of the first occurrence of the object or -1 if the 61 | * object was not found. 62 | */ 63 | public int getLocation(final T object) { 64 | return this.data.indexOf(object); 65 | } 66 | 67 | /** 68 | * Clear the entire adapter using {@link android.support.v7.widget.RecyclerView.Adapter#notifyItemRangeRemoved}. 69 | */ 70 | public void clear() { 71 | int size = this.data.size(); 72 | if (size > 0) { 73 | for (int i = 0; i < size; i++) { 74 | this.data.remove(0); 75 | } 76 | 77 | this.notifyItemRangeRemoved(0, size); 78 | } 79 | } 80 | 81 | /** 82 | * Adds the specified object at the end of the data. 83 | * 84 | * @param object the object to add. 85 | * 86 | * @return always true. 87 | * 88 | * @exception UnsupportedOperationException if adding to the data is not supported. 89 | * @exception ClassCastException if the class of the object is inappropriate for this 90 | * data. 91 | * @exception IllegalArgumentException if the object cannot be added to the data. 92 | */ 93 | public boolean add(final T object) { 94 | final boolean added = this.data.add(object); 95 | this.notifyItemInserted(this.data.size() + 1); 96 | return added; 97 | } 98 | 99 | /** 100 | * Adds the objects in the specified collection to the end of the data. The 101 | * objects are added in the order in which they are returned from the 102 | * collection's iterator. 103 | * 104 | * @param collection the collection of objects. 105 | * 106 | * @return {@code true} if the data is modified, {@code false} otherwise 107 | * (i.e. if the passed collection was empty). 108 | * 109 | * @exception UnsupportedOperationException if adding to the data is not supported. 110 | * @exception ClassCastException if the class of an object is inappropriate for this 111 | * data. 112 | * @exception IllegalArgumentException if an object cannot be added to the data. 113 | */ 114 | public boolean addAll(final List collection) { 115 | final boolean added = this.data.addAll(collection); 116 | this.notifyItemRangeInserted(0, data.size() + 1); 117 | return added; 118 | } 119 | 120 | /** 121 | * Inserts the specified object into the data at the specified location. 122 | * The object is inserted before the current element at the specified 123 | * location. If the location is equal to the size of the data, the object 124 | * is added at the end. If the location is smaller than the size of the 125 | * data, then all elements beyond the specified location are moved by one 126 | * location towards the end of the data. 127 | * 128 | * @param location the index at which to insert. 129 | * @param object the object to add. 130 | * 131 | * @exception UnsupportedOperationException if adding to the data is not supported. 132 | * @exception ClassCastException if the class of the object is inappropriate for this 133 | * data. 134 | * @exception IllegalArgumentException if the object cannot be added to the data. 135 | * @exception IndexOutOfBoundsException if {@code location < 0 || location > size()} 136 | */ 137 | public void add(final int location, final T object) { 138 | this.data.add(location, object); 139 | this.notifyItemInserted(location); 140 | } 141 | 142 | /** 143 | * Replaces the element at the specified location in the data with the 144 | * specified object. This operation does not change the size of the data. 145 | * 146 | * @param location the index at which to put the specified object. 147 | * @param object the object to insert. 148 | * 149 | * @return the previous element at the index. 150 | * 151 | * @exception UnsupportedOperationException if replacing elements in the data is not supported. 152 | * @exception ClassCastException if the class of an object is inappropriate for this 153 | * data. 154 | * @exception IllegalArgumentException if an object cannot be added to the data. 155 | * @exception IndexOutOfBoundsException if {@code location < 0 || location >= size()} 156 | */ 157 | public T set(final int location, final T object) { 158 | final T insertedObject = this.data.set(location, object); 159 | this.notifyDataSetChanged(); 160 | return insertedObject; 161 | } 162 | 163 | /** 164 | * Removes the first occurrence of the specified object from the data. 165 | * 166 | * @param object the object to remove. 167 | * 168 | * @return true if the data was modified by this operation, false 169 | * otherwise. 170 | * 171 | * @exception UnsupportedOperationException if removing from the data is not supported. 172 | */ 173 | public boolean remove(final int location, final T object) { 174 | final boolean removed = this.data.remove(object); 175 | this.notifyItemRangeRemoved(location, this.data.size()); 176 | return removed; 177 | } 178 | 179 | /** 180 | * Removes the first occurrence of the specified object from the data. 181 | * 182 | * @param object the object to remove. 183 | * 184 | * @return true if the data was modified by this operation, false 185 | * otherwise. 186 | * 187 | * @exception UnsupportedOperationException if removing from the data is not supported. 188 | */ 189 | public boolean remove(final T object) { 190 | final int location = this.getLocation(object); 191 | final boolean removed = this.data.remove(object); 192 | this.notifyItemRemoved(location); 193 | return removed; 194 | } 195 | 196 | /** 197 | * Removes the object at the specified location from the data. 198 | * 199 | * @param location the index of the object to remove. 200 | * 201 | * @return the removed object. 202 | * 203 | * @exception UnsupportedOperationException if removing from the data is not supported. 204 | * @exception IndexOutOfBoundsException if {@code location < 0 || location >= size()} 205 | */ 206 | public T remove(final int location) { 207 | final T removedObject = this.data.remove(location); 208 | this.notifyItemRemoved(location); 209 | this.notifyItemRangeChanged(location, this.data.size()); 210 | return removedObject; 211 | } 212 | 213 | /** 214 | * Sorts the given list using the given comparator. The algorithm is 215 | * stable which means equal elements don't get reordered. 216 | * 217 | * @exception ClassCastException if any element does not implement {@code Comparable}, 218 | * or if {@code compareTo} throws for any pair of elements. 219 | */ 220 | public void sort(final Comparator comparator) { 221 | Collections.sort(this.data, comparator); 222 | this.notifyItemRangeChanged(0, this.getItemCount()); 223 | } 224 | 225 | /** 226 | * Return the number of selected items. 227 | * 228 | * @return Number of selected items. 229 | */ 230 | public int getItemSelectedCount() { 231 | return this.selectedItems.size(); 232 | } 233 | 234 | /** 235 | * Return all selected IDs. 236 | * 237 | * @return Selected IDs. 238 | */ 239 | public SparseBooleanArray getSelectedItems() { 240 | return this.selectedItems; 241 | } 242 | 243 | /** 244 | * Return all selected items. 245 | * 246 | * @return Selected IDs. 247 | */ 248 | public List getSelectedList() { 249 | final List list = new ArrayList<>(); 250 | final SparseBooleanArray sparseBooleanArray = this.getSelectedItems(); 251 | for (int i = 0; i < sparseBooleanArray.size(); i++) { 252 | final T model = this.getList().get(sparseBooleanArray.keyAt(i)); 253 | list.add(model); 254 | } 255 | return list; 256 | } 257 | 258 | /** 259 | * Remove all current selections. 260 | */ 261 | public void removeSelections() { 262 | this.selectedItems.clear(); 263 | this.notifyDataSetChanged(); 264 | } 265 | 266 | /** 267 | * Toggle selection of item. 268 | * 269 | * @param location location of view. 270 | */ 271 | public void toggleSelection(final int location) { 272 | this.selectItem(location, !this.selectedItems.get(location)); 273 | } 274 | 275 | /** 276 | * Change the current view state to selected. 277 | * 278 | * @param location location of view. 279 | * @param value True if view is selected. 280 | */ 281 | public void selectItem(final int location, final boolean value) { 282 | if (value) { 283 | this.selectedItems.put(location, true); 284 | } else { 285 | this.selectedItems.delete(location); 286 | } 287 | 288 | this.notifyItemChanged(location); 289 | } 290 | } 291 | -------------------------------------------------------------------------------- /src/main/java/burrows/apps/example/template/util/PlayServicesUtils.java: -------------------------------------------------------------------------------- 1 | package burrows.apps.example.template.util; 2 | 3 | import android.app.Activity; 4 | import android.app.Dialog; 5 | import android.content.DialogInterface; 6 | import com.google.android.gms.common.ConnectionResult; 7 | import com.google.android.gms.common.GoogleApiAvailability; 8 | 9 | /** 10 | * Google Play Services utility class. 11 | * https://developers.google.com/android/reference/com/google/android/gms/analytics/GoogleAnalytics. I have stopped 12 | * checking for Google Play Services because it pops up a dialog forcing a user to upgrade. 13 | * 14 | * @author Jared Burrows 15 | */ 16 | public final class PlayServicesUtils { 17 | 18 | private PlayServicesUtils() { 19 | // Utility class 20 | } 21 | 22 | /** 23 | * Check if device has the correct Google Play Services version. 24 | * 25 | * @param activity Current activity. 26 | * @param availability New instance of GoogleApiAvailability. 27 | * @return True if there was a successful connection ot Google Play Services. 28 | */ 29 | public static boolean hasGooglePlayServices(final Activity activity, final GoogleApiAvailability availability) { 30 | final int result = availability.isGooglePlayServicesAvailable(activity); 31 | 32 | if (result == ConnectionResult.SUCCESS) { 33 | return true; 34 | } else { 35 | final Dialog dialog = availability.getErrorDialog(activity, result, 0); 36 | // Let user use the application 37 | dialog.setOnCancelListener(new DialogInterface.OnCancelListener() { 38 | @Override 39 | public void onCancel(final DialogInterface dialog) { 40 | dialog.cancel(); 41 | } 42 | }); 43 | dialog.show(); 44 | } 45 | return false; 46 | } 47 | } 48 | -------------------------------------------------------------------------------- /src/main/res/mipmap-hdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jaredsburrows/android-gradle-java-library-template/f10cb058e315110ea54df964ac9865e17d21cc1e/src/main/res/mipmap-hdpi/ic_launcher.png -------------------------------------------------------------------------------- /src/main/res/mipmap-mdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jaredsburrows/android-gradle-java-library-template/f10cb058e315110ea54df964ac9865e17d21cc1e/src/main/res/mipmap-mdpi/ic_launcher.png -------------------------------------------------------------------------------- /src/main/res/mipmap-xhdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jaredsburrows/android-gradle-java-library-template/f10cb058e315110ea54df964ac9865e17d21cc1e/src/main/res/mipmap-xhdpi/ic_launcher.png -------------------------------------------------------------------------------- /src/main/res/mipmap-xxhdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jaredsburrows/android-gradle-java-library-template/f10cb058e315110ea54df964ac9865e17d21cc1e/src/main/res/mipmap-xxhdpi/ic_launcher.png -------------------------------------------------------------------------------- /src/main/res/values/strings.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | AndroidGradleTemplate 5 | 6 | 7 | -------------------------------------------------------------------------------- /src/main/res/values/styles.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 8 | 9 | 10 | --------------------------------------------------------------------------------