├── .gitignore ├── .travis.yml ├── LICENSE.md ├── README.md ├── build.gradle ├── buildSrc ├── gradle.properties ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── java-censor-plugin ├── build.gradle └── src │ ├── main │ ├── kotlin │ │ └── com │ │ │ └── sebchlan │ │ │ └── javacensor │ │ │ └── JavaCensorPlugin.kt │ └── resources │ │ └── META-INF │ │ └── gradle-plugins │ │ └── com.sebchlan.javacensor.properties │ └── test │ └── kotlin │ └── com │ └── sebchlan │ └── javacensor │ ├── AssertFunctions.kt │ ├── FunctionalTests.kt │ ├── TestClasses.kt │ └── TestHelper.kt ├── java-censor-sample ├── build.gradle └── src │ └── main │ └── java │ └── com │ └── sebchlan │ └── sample │ ├── PrivateTestClass.java │ ├── Sample.java │ ├── TestClass.java │ └── TestInterface.java ├── settings.gradle └── travis.sh /.gitignore: -------------------------------------------------------------------------------- 1 | .gradle 2 | build/ 3 | output/ 4 | 5 | # Ignore Gradle GUI config 6 | gradle-app.setting 7 | 8 | # Idea 9 | .idea 10 | *iml 11 | 12 | local.properties 13 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: java 2 | jdk: 3 | - oraclejdk9 4 | branches: 5 | only: 6 | - master 7 | env: 8 | global: 9 | - secure: KaQFjEJ4+T908NWsbn6YagoaHerFKUtnz6I3oqSHKx3te6b3/Yw+7m82yJDrfvPpdX/HyKMJbHo2ciYFwKVKYeTrPx5fGdPZhFJFy5Mbv3XqL9eC7TAtnSn+gpm4Jd957nAE2Q7GSIQGtwrDsGnut+Nl06H+zMkOgvyoz6kGJKfeY4V4zNjmxL2690BH4kRgam6Y8DnAvFModLun/6enPUuy7ypSsc2McUYjbVtvHRXAHv64uRX6zb7FxWobSLK0q8Hr16lqJr3XI70XYIC0qN2zJmNuVmmRvPAkca2C1VS4FntNJzs8Ju+5araIwzM2CRzlIbIaOlAJjjbfHVIcIRYg3/KQUIOpzbIA8tF2sU6TUFgLmSjPGx9B9p/FFBAs5wDNM22hXYRqAxSQxTMF+zNSytJZQQ0utSqdoPOl9MyGXMKVsWgjff7bNocf9Mc41bHo9HL4XpiaSsJdcMRmhlHrS9Av+yrrOpcY+QJfnoyDP8YBtPINvCRJ5ZF54DHsDjbp4tQBXKhy2fOxis454BgXKVyFfDY37brn/a2tEbcSdYBydqINEDIKdaZ3dnr83UUhKeP36kvwPR09LkajolsOnukuA1M/p7MmTAlBB9Nqpr9DHB40dQWSoEUZ/ba86fuhSLiQdkjNCwgKIkUXrAVc72buzs9zcFZIdbPNKzk= 10 | - secure: gd0oZHKK50MJUEpHkxP9JwA7OJkml2vH3hnkhiQHN9P4pcTFskGdnIrymBT10gelfJL3qwvurbce0DP1l9erJQJ8Cf3Ggbc0UwgJqEYQrcoSHpWOryj/LSdqaCUgwW7osFWPD5K9Wm2bPcpQtbxJcv1hgSS0HZ6kR4ayeYsDmRKFZRTpDdzRtzXuYLtlCH0P4l6KPP3zjsSVuLQc+hGKQ5YIV6ABgpDjpFdLyk/JgrJo4RVx+s+AsOYtVmDMXo7ecFK3fe7C5W80zFv3ZNuWmm60BHTgGKBRuJ7+h8Tn5ivuKu/JGGauvnaPxje1c7HAL3TTNRh0CyBHv935o2+zmf4WkXxr6EaCThSy/JHLDJkh5qJxP6Hsds+dUj+o4K+85Wk/XKtpC4wklGpym4YdXkSGvwvSh9OXY16qXlNMVMJ0fRhOJylB+6YhaEYKmkM+rFHKCtLgiW/bkSOzuPlQ9AL8gLdxcdmkEFCBBX5uHeI8XspGHjmn9F85qQpVGHCDSCLrR255C8C4XajKXl7PRRcA9GEJsFs6MsWTM/dZ2pNi2eAQ4qz/HHjnQiiyD5y5DfzoYuUWbWRbS2z+4gqOaHQOhVXOxfLmrTQVJxF2GLeIHJJVJisxwbPQrxyUDHAt7UGrnAzSiBYrWJ0JZV2bmf80nc22QaJiL9JAjGJo08U= 11 | install: true 12 | script: ./travis.sh 13 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 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 | 2 |

3 | 4 |
5 | Build Status 6 | Java Censor Version 7 | 8 | License 9 |

10 | 11 | Java Censor is a Gradle plugin that enables developers to publish sources of closed source projects to a Maven repository. It does this by removing implemented code only leaving the signatures of public interfaces, classes, methods and fields behind. 12 | 13 | 14 | 15 | ## Purpose 16 | 17 | Java Censor is built for closed source java libraries, in particular, closed source Android libraries. When working on closed source libraries, it is usually not possible to ship a source artefact when deploying a release. 18 | That brings one big downside* for the integrators of your library. Even if you ship a Javadoc artefact, IDEs like Android Studio or IntelliJ don't use that artefact for showing documentation. Instead, they rely solely on the source artefact for showing inline documentation. 19 | 20 | That is where Java Censor can help. Java Censor makes it possible to release a source artefact of a closed source library without exposing secret code but still allows IDEs to show inline documentation. It does that when running before the release, by removing any implemented code, only keeping public signatures (interfaces, classes, methods, constructors, fields) and Javadoc. 21 | 22 | ## Usage 23 | 24 | For using Java Censor in a Gradle project, it needs to be added to the project first. That is done by adding it as a classpath dependency to the `buildscript` block and applying the plugin to a module. 25 | Applying the plugin to a module introduces a new task type called `CensorCopyTask`. The `CensorCopyTask` behaves like the built-in `Copy` task and has two mandatory configuration options. 26 | 27 |
28 |
from = [set of input directories/files]
29 |
Takes a set of files as input.
30 | 31 |
into = [output directory]
32 |
The output directory. (File)
33 |
34 | 35 | Example: 36 | 37 | ```gradle 38 | // Add classpath dependency 39 | buildscript { 40 | dependencies { 41 | classpath group: 'com.sebchlan.javacensor', name: 'java-censor', version: '1.2.1' 42 | } 43 | } 44 | 45 | // Apply the plugin 46 | apply plugin: 'com.sebchlan.javacensor' 47 | 48 | // Add a new task 49 | tasks.register("censorSource", com.sebchlan.javacensor.CensorCopyTask) { task -> 50 | inputs.files(sourceSets.main.java.srcDirs) 51 | destinationDir = file("$buildDir/censored_source") 52 | } 53 | ``` 54 | 55 | ### Android 56 | 57 | Java Censor is also applicable to Android projects. The installation steps are very similar to the ones above. 58 | This is how a configuration can look like: 59 | 60 | ```gradle 61 | 62 | buildscript { 63 | repositories { 64 | jcenter() 65 | } 66 | 67 | dependencies { 68 | classpath group: 'com.sebchlan.javacensor', name: 'java-censor', version: '1.2.1' 69 | } 70 | } 71 | 72 | apply plugin: 'com.sebchlan.javacensor' 73 | 74 | afterEvaluate { project -> 75 | 76 | uploadArchives { 77 | repositories { 78 | mavenDeployer { 79 | // .... 80 | } 81 | } 82 | 83 | task censorSource(type: com.sebchlan.javacensor.CensorCopyTask) { 84 | inputs.files(android.sourceSets.main.java.srcDirs) 85 | destinationDir = file("$buildDir/generated-src") 86 | } 87 | 88 | task androidSourcesJar(type: Jar) { 89 | classifier = 'sources' 90 | from "$buildDir/generated-src/" 91 | dependsOn censorSource 92 | } 93 | 94 | artifacts { 95 | archives androidSourcesJar 96 | } 97 | 98 | } 99 | } 100 | ``` 101 | 102 | ## Contribution 103 | 104 | Feel free to submit a PR or file an issue. Please make sure, when filing a bug, to provide sufficient reproduction steps or even a failing test. 105 | -------------------------------------------------------------------------------- /build.gradle: -------------------------------------------------------------------------------- 1 | allprojects { 2 | repositories { 3 | jcenter() 4 | 5 | maven { 6 | url 'https://oss.sonatype.org/content/repositories/snapshots' 7 | } 8 | } 9 | } 10 | -------------------------------------------------------------------------------- /buildSrc: -------------------------------------------------------------------------------- 1 | java-censor-plugin/ -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/schlan/java-censor/a8f8b1e769341deab654c66822aed3329c5eacff/gradle.properties -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/schlan/java-censor/a8f8b1e769341deab654c66822aed3329c5eacff/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | zipStoreBase=GRADLE_USER_HOME 4 | zipStorePath=wrapper/dists 5 | distributionUrl=https\://services.gradle.org/distributions/gradle-6.7-bin.zip 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="" 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= 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 | -------------------------------------------------------------------------------- /java-censor-plugin/build.gradle: -------------------------------------------------------------------------------- 1 | 2 | buildscript { 3 | 4 | repositories { 5 | jcenter() 6 | maven { url "https://plugins.gradle.org/m2/" } 7 | } 8 | 9 | dependencies { 10 | classpath group: "org.jetbrains.kotlin", name: "kotlin-gradle-plugin", version: "1.3.20" 11 | classpath group: "com.gradle.publish", name: "plugin-publish-plugin", version: "0.9.10" 12 | } 13 | } 14 | 15 | repositories { 16 | jcenter() 17 | } 18 | 19 | apply plugin: 'kotlin' 20 | 21 | dependencies { 22 | implementation gradleApi() 23 | implementation group: 'org.jetbrains.kotlin', name: 'kotlin-stdlib', version: '1.3.20' 24 | implementation group: 'com.github.javaparser', name: 'javaparser-core', version: '3.10.1' 25 | 26 | testImplementation gradleTestKit() 27 | testImplementation group: 'junit', name: 'junit', version: '4.12' 28 | testImplementation group: 'org.jetbrains.kotlin', name: 'kotlin-stdlib', version: '1.3.11' 29 | testImplementation group: 'com.google.truth', name: 'truth', version: '0.42' 30 | } 31 | 32 | //// Setup for testing 33 | 34 | // Write the plugin's classpath to a file to share with the tests 35 | task createClasspathManifest { 36 | def outputDir = file("$buildDir/$name") 37 | 38 | inputs.files sourceSets.main.runtimeClasspath 39 | outputs.dir outputDir 40 | 41 | doLast { 42 | outputDir.mkdirs() 43 | file("$outputDir/plugin-classpath.txt").text = sourceSets.main.runtimeClasspath.join("\n") 44 | } 45 | } 46 | 47 | // Add the classpath file to the test runtime classpath 48 | dependencies { 49 | testRuntime files(createClasspathManifest) 50 | } 51 | 52 | 53 | //// Deployment 54 | apply plugin: 'maven' 55 | apply plugin: 'signing' 56 | 57 | ext { 58 | SDK_GROUP_ID = 'com.sebchlan.javacensor' 59 | SDK_URL = 'https://github.com/schlan/java-censor' 60 | PROJECT_NAME = 'Java Censor' 61 | PROJECT_DESCRIPTION = 'Censor Java Source Files' 62 | SDK_VERSION_NAME = '1.3.0-SNAPSHOT' 63 | SDK_ARTIFACT_ID = 'java-censor' 64 | SDK_PACKAGING = 'jar' 65 | JAVA_DOC_TITLE = 'Java Censor' 66 | POM_DEVELOPER_ID = 'sebchlan' 67 | POM_DEVELOPER_NAME = 'Sebastian Chlan' 68 | 69 | repoUsername = System.getenv("sebSonatypeUsername") ?: rootProject.properties["sebSonatypeUsername"] 70 | repoPassword = System.getenv("sebSonatypePassword") ?: rootProject.properties["sebSonatypePassword"] 71 | } 72 | 73 | ext."signing.keyId" = rootProject.properties["sebKeyId"] 74 | ext."signing.secretKeyRingFile" = rootProject.properties["sebKeyRingFile"] 75 | ext."signing.password" = rootProject.properties["sebKeyPassword"] 76 | 77 | afterEvaluate { project -> 78 | uploadArchives { 79 | repositories { 80 | mavenDeployer { 81 | beforeDeployment { MavenDeployment deployment -> signing.signPom(deployment) } 82 | 83 | snapshotRepository(url: "https://oss.sonatype.org/content/repositories/snapshots") { 84 | authentication(userName: repoUsername, password: repoPassword) 85 | } 86 | 87 | repository(url: "https://oss.sonatype.org/service/local/staging/deploy/maven2") { 88 | authentication(userName: repoUsername, password: repoPassword) 89 | } 90 | 91 | pom.project { 92 | name PROJECT_NAME 93 | description PROJECT_DESCRIPTION 94 | groupId SDK_GROUP_ID 95 | artifactId SDK_ARTIFACT_ID 96 | packaging SDK_PACKAGING 97 | version SDK_VERSION_NAME 98 | url SDK_URL 99 | 100 | scm { 101 | url SDK_URL 102 | connection 'scm:git:https://github.com/schlan/java-censore.git' 103 | developerConnection 'scm:git:git@github.com:schlan/java-censor.git' 104 | } 105 | 106 | licenses { 107 | license { 108 | name 'The Apache License, Version 2.0' 109 | url 'http://www.apache.org/licenses/LICENSE-2.0.txt' 110 | } 111 | } 112 | 113 | developers { 114 | developer { 115 | id POM_DEVELOPER_ID 116 | name POM_DEVELOPER_NAME 117 | } 118 | } 119 | } 120 | } 121 | } 122 | } 123 | 124 | signing { 125 | required { SDK_VERSION_NAME.contains("SNAPSHOT") == false } 126 | sign configurations.archives 127 | } 128 | 129 | if (JavaVersion.current().isJava8Compatible()) { 130 | allprojects { 131 | tasks.withType(Javadoc) { 132 | options.addStringOption('Xdoclint:none', '-quiet') 133 | } 134 | } 135 | } 136 | 137 | task sourcesJar(type: Jar, dependsOn:classes) { 138 | classifier = 'sources' 139 | from sourceSets.main.allSource 140 | } 141 | 142 | tasks.withType(Javadoc) { 143 | source = sourceSets.main.allJava 144 | options.addStringOption('Xdoclint:none', '-quiet') 145 | title = JAVA_DOC_TITLE 146 | options.links("http://docs.oracle.com/javase/8/docs/api/") 147 | } 148 | 149 | task javadocJar(type: Jar, dependsOn:javadoc) { 150 | classifier = 'javadoc' 151 | from javadoc.destinationDir 152 | } 153 | 154 | artifacts { 155 | archives sourcesJar 156 | archives javadocJar 157 | } 158 | } 159 | 160 | 161 | ///// Deploy to Gradle plugin 162 | 163 | apply plugin: "com.gradle.plugin-publish" 164 | 165 | pluginBundle { 166 | website = 'https://github.com/schlan/java-censor' 167 | vcsUrl = 'https://github.com/schlan/java-censor' 168 | description = 'Java Censor is a Gradle plugin that enables developers to publish sources of closed source projects to a Maven repository. It does this by removing implemented code only leaving the signatures of public interfaces, classes, methods and fields behind. ' 169 | tags = ['java', 'android', 'library', 'source', 'censor', 'redcat', 'source-artefact', 'deploy', 'deployment'] 170 | 171 | plugins { 172 | javaCensor { 173 | id = SDK_GROUP_ID 174 | displayName = 'Java Censor Plugin' 175 | version = SDK_VERSION_NAME 176 | } 177 | } 178 | 179 | mavenCoordinates { 180 | groupId = SDK_GROUP_ID 181 | artifactId = SDK_ARTIFACT_ID 182 | version = SDK_VERSION_NAME 183 | } 184 | } -------------------------------------------------------------------------------- /java-censor-plugin/src/main/kotlin/com/sebchlan/javacensor/JavaCensorPlugin.kt: -------------------------------------------------------------------------------- 1 | package com.sebchlan.javacensor 2 | 3 | import com.github.javaparser.JavaParser 4 | import com.github.javaparser.ast.Node 5 | import com.github.javaparser.ast.NodeList 6 | import com.github.javaparser.ast.body.ClassOrInterfaceDeclaration 7 | import com.github.javaparser.ast.body.FieldDeclaration 8 | import com.github.javaparser.ast.body.MethodDeclaration 9 | import com.github.javaparser.ast.comments.LineComment 10 | import com.github.javaparser.ast.expr.ObjectCreationExpr 11 | import com.github.javaparser.ast.expr.StringLiteralExpr 12 | import com.github.javaparser.ast.stmt.BlockStmt 13 | import com.github.javaparser.ast.stmt.ThrowStmt 14 | import com.github.javaparser.ast.visitor.ModifierVisitor 15 | import com.github.javaparser.ast.visitor.Visitable 16 | import org.gradle.api.DefaultTask 17 | import org.gradle.api.Plugin 18 | import org.gradle.api.Project 19 | import org.gradle.api.tasks.OutputDirectory 20 | import org.gradle.api.tasks.TaskAction 21 | import java.io.File 22 | 23 | 24 | class JavaCensorPlugin : Plugin { 25 | override fun apply(project: Project) { 26 | project.tasks.register("censorCopyTask", CensorCopyTask::class.java) { task -> 27 | task.description = "Copy source files and censor them" 28 | } 29 | } 30 | } 31 | 32 | open class CensorCopyTask : DefaultTask() { 33 | 34 | @OutputDirectory 35 | var destinationDir: File? = null 36 | 37 | @TaskAction 38 | fun censor() { 39 | val output = destinationDir ?: throw IllegalArgumentException("Please provide an output directory.") 40 | if (!output.isDirectory) throw IllegalArgumentException("Output is not a directory") 41 | 42 | project.copy { spec -> 43 | spec.from(inputs.files) 44 | spec.into(output) 45 | } 46 | 47 | output.walk() 48 | .filter { it.isFile } 49 | .forEach { censorSourceFile(it) } 50 | } 51 | 52 | private fun censorSourceFile(file: File) { 53 | val cu = JavaParser.parse(file) 54 | CensorVisitor().visit(cu, null) 55 | CommentVisitor().visit(cu, null) 56 | file.writeText(cu.toString(), Charsets.UTF_8) 57 | } 58 | } 59 | 60 | class CensorVisitor : ModifierVisitor() { 61 | 62 | override fun visit(n: ClassOrInterfaceDeclaration, arg: Void?): Visitable? { 63 | return if (n.isPublic) { 64 | 65 | // Replace constructors 66 | n.constructors.forEach { 67 | if (it.isPublic) { 68 | it.body = getBlockWithException() 69 | } else { 70 | it.remove() 71 | } 72 | } 73 | 74 | // Continue visiting children 75 | super.visit(n, arg) 76 | 77 | } else { 78 | 79 | // Class is not public remove methods, fields and constructors 80 | n.methods.forEach { it.remove() } 81 | n.fields.forEach { it.remove() } 82 | n.constructors.forEach { it.remove() } 83 | 84 | // Continue visiting children, e.g. inner classes 85 | super.visit(n, arg) 86 | } 87 | } 88 | 89 | override fun visit(n: FieldDeclaration, arg: Void?): Visitable? { 90 | return if (n.isParentAnInterface() || n.isPublic) { 91 | // Keep field if it is public or part of an interface 92 | super.visit(n, arg) 93 | 94 | } else { 95 | null 96 | } 97 | } 98 | 99 | override fun visit(n: MethodDeclaration, arg: Void?): Visitable? { 100 | return when { 101 | 102 | // Keep method if it's part of an interface 103 | n.isParentAnInterface() -> { 104 | super.visit(n, arg) 105 | } 106 | 107 | // Keep method signature, replace body 108 | n.isPublic -> { 109 | n.setBody(getBlockWithException()) 110 | super.visit(n, arg) 111 | } 112 | 113 | // Remove non public methods 114 | else -> { 115 | null 116 | } 117 | } 118 | } 119 | 120 | private fun Node.isParentAnInterface(): Boolean { 121 | return parentNode.map { 122 | if (it is ClassOrInterfaceDeclaration) { 123 | it.isInterface 124 | } else { 125 | false 126 | } 127 | }.orElseGet { false } 128 | } 129 | 130 | private fun getBlockWithException(): BlockStmt { 131 | 132 | val type = JavaParser.parseClassOrInterfaceType("java.lang.RuntimeException") 133 | val ex = ObjectCreationExpr(null, type, NodeList(StringLiteralExpr(comment))) 134 | 135 | val throwStmt = ThrowStmt(ex) 136 | throwStmt.setLineComment(javaCensorComment) 137 | 138 | val block = BlockStmt() 139 | block.addStatement(throwStmt) 140 | 141 | return block 142 | } 143 | 144 | } 145 | 146 | class CommentVisitor : ModifierVisitor() { 147 | 148 | override fun visit(n: ClassOrInterfaceDeclaration, arg: Void?): Visitable? { 149 | if (n.members.isEmpty()) { 150 | 151 | n.addOrphanComment(LineComment("")) 152 | n.addOrphanComment(LineComment(comment)) 153 | n.addOrphanComment(LineComment("")) 154 | n.addOrphanComment(LineComment(javaCensorComment)) 155 | n.addOrphanComment(LineComment("")) 156 | } 157 | return super.visit(n, arg) 158 | } 159 | 160 | } 161 | 162 | private const val javaCensorComment = "This code was redacted by Java Censor - Learn more about it at https://github.com/schlan/java-censor" 163 | const val comment = "Source removed" 164 | -------------------------------------------------------------------------------- /java-censor-plugin/src/main/resources/META-INF/gradle-plugins/com.sebchlan.javacensor.properties: -------------------------------------------------------------------------------- 1 | implementation-class=com.sebchlan.javacensor.JavaCensorPlugin 2 | -------------------------------------------------------------------------------- /java-censor-plugin/src/test/kotlin/com/sebchlan/javacensor/AssertFunctions.kt: -------------------------------------------------------------------------------- 1 | package com.sebchlan.javacensor 2 | 3 | import com.github.javaparser.JavaParser 4 | import com.github.javaparser.ast.CompilationUnit 5 | import com.github.javaparser.ast.body.ClassOrInterfaceDeclaration 6 | import com.google.common.truth.Truth.assertThat 7 | import com.google.common.truth.Truth.assertWithMessage 8 | import org.junit.Assert.fail 9 | import java.io.File 10 | 11 | fun assertClassHasNoMethodsFieldsConstructors(sourceFile: File) { 12 | val cu = readSourceFile(sourceFile) 13 | val clazz = getFirstClass(cu) 14 | 15 | assertWithMessage("Ensure class has no methods") 16 | .that(clazz.methods).isEmpty() 17 | 18 | assertWithMessage("Ensure class has no fields") 19 | .that(clazz.fields).isEmpty() 20 | 21 | assertWithMessage("Ensure class has no constructors") 22 | .that(clazz.constructors).isEmpty() 23 | } 24 | 25 | fun assertClassHasComment(sourceFile: File) { 26 | val cu = readSourceFile(sourceFile) 27 | val clazz = getFirstClass(cu) 28 | 29 | val hasComment = clazz.orphanComments.map { it.content.trim() == comment }.contains(true) 30 | assertWithMessage("Ensure class has java censor comment") 31 | .that(hasComment).isTrue() 32 | } 33 | 34 | fun assertClassHasNoNonPublicElements(sourceFile: File) { 35 | val cu = readSourceFile(sourceFile) 36 | val clazz = getFirstClass(cu) 37 | 38 | assertWithMessage("Ensure class has no private/local/protected methods") 39 | .that(clazz.methods.filter { !it.isPublic }).isEmpty() 40 | 41 | assertWithMessage("Ensure class has no private/local/protected fields") 42 | .that(clazz.fields.filter { !it.isPublic }).isEmpty() 43 | 44 | assertWithMessage("Ensure class has no private/local/protected constructors") 45 | .that(clazz.constructors.filter { !it.isPublic }).isEmpty() 46 | 47 | } 48 | 49 | fun assertClassHasPublicField(sourceFile: File, fieldName: String) { 50 | val cu = readSourceFile(sourceFile) 51 | val clazz = getFirstClass(cu) 52 | 53 | val hasField = clazz.fields.filter { it.isPublic && it.toString().contains(fieldName) } 54 | 55 | assertWithMessage("Ensure class has a public field with name $fieldName") 56 | .that(hasField).hasSize(1) 57 | } 58 | 59 | fun assertClassHasPublicMethod(sourceFile: File, fieldName: String) { 60 | val cu = readSourceFile(sourceFile) 61 | val clazz = getFirstClass(cu) 62 | 63 | val method = clazz.methods.filter { it.isPublic && it.nameAsString == fieldName } 64 | 65 | assertWithMessage("Ensure class has a public method with name '$fieldName'") 66 | .that(method).hasSize(1) 67 | 68 | val body = method.first().body.get() 69 | 70 | assertWithMessage("Ensure class has a public method with name '$fieldName' that has one throw statement") 71 | .that(body.statements.size == 1 && body.statements[0].isThrowStmt).isTrue() 72 | } 73 | 74 | fun assertInterfaceHasField(sourceFile: File, fieldName: String) { 75 | val cu = readSourceFile(sourceFile) 76 | val clazz = getFirstClass(cu) 77 | 78 | val hasField = clazz.fields.filter { it.toString().contains(fieldName) } 79 | 80 | assertWithMessage("Ensure class has a field with name $fieldName") 81 | .that(hasField).hasSize(1) 82 | } 83 | 84 | fun assertInterfaceHasMethod(sourceFile: File, methodName: String) { 85 | val cu = readSourceFile(sourceFile) 86 | val clazz = getFirstClass(cu) 87 | 88 | val method = clazz.methods.filter { it.nameAsString == methodName } 89 | 90 | assertWithMessage("Ensure class has a method with name '$methodName'") 91 | .that(method).hasSize(1) 92 | } 93 | 94 | 95 | private fun getFirstClass(cu: CompilationUnit): ClassOrInterfaceDeclaration { 96 | val clazz = cu.types.filterIsInstance() 97 | assertThat(clazz.size).isEqualTo(1) 98 | return clazz.first() 99 | } 100 | 101 | private fun readSourceFile(sourceFile: File): CompilationUnit { 102 | 103 | val cu = try { 104 | JavaParser.parse(sourceFile) 105 | } catch (e: Exception) { 106 | fail("Unable to parse file. Error ${e.message}") 107 | null 108 | } 109 | 110 | if (cu == null) { 111 | fail("Something is wrong. JavaParser returned null") 112 | } 113 | 114 | return cu!! 115 | } -------------------------------------------------------------------------------- /java-censor-plugin/src/test/kotlin/com/sebchlan/javacensor/FunctionalTests.kt: -------------------------------------------------------------------------------- 1 | package com.sebchlan.javacensor 2 | 3 | import org.junit.Before 4 | import org.junit.Rule 5 | import org.junit.Test 6 | import org.junit.rules.TemporaryFolder 7 | import java.io.File 8 | 9 | class FunctionalTests { 10 | 11 | @Rule @JvmField 12 | val testProjectDir = TemporaryFolder() 13 | 14 | private lateinit var buildFile: File 15 | private lateinit var buildSrcDir: File 16 | 17 | @Before 18 | fun setup() { 19 | buildFile = testBuildFile(testProjectDir) 20 | buildSrcDir = testSourceDir(testProjectDir) 21 | } 22 | 23 | @Test 24 | fun `local class, everything gets removed, has a comment`() { 25 | val (input, output) = testFile(testProjectDir, "TestClass.java") 26 | input.writeText(testClassWithPrivateField) 27 | 28 | runGradle(testProjectDir, "censorSource") 29 | 30 | assertClassHasNoMethodsFieldsConstructors(output) 31 | assertClassHasComment(output) 32 | } 33 | 34 | @Test 35 | fun `class with private field, field gets removed`() { 36 | val (input, output) = testFile(testProjectDir, "TestClass.java") 37 | input.writeText(localTestClass) 38 | 39 | runGradle(testProjectDir, "censorSource") 40 | 41 | assertClassHasNoMethodsFieldsConstructors(output) 42 | assertClassHasComment(output) 43 | } 44 | 45 | @Test 46 | fun `class with private field, field stays untouched`() { 47 | val (input, output) = testFile(testProjectDir, "TestClass.java") 48 | input.writeText(testClassWithPublicField) 49 | 50 | runGradle(testProjectDir, "censorSource") 51 | 52 | assertClassHasNoNonPublicElements(output) 53 | assertClassHasPublicField(output, "String testField") 54 | } 55 | 56 | @Test 57 | fun `class with private method, private gets removed`() { 58 | val (input, output) = testFile(testProjectDir, "TestClass.java") 59 | input.writeText(testClassWithPrivateMethod) 60 | 61 | runGradle(testProjectDir,"censorSource") 62 | 63 | assertClassHasNoMethodsFieldsConstructors(output) 64 | assertClassHasComment(output) 65 | } 66 | 67 | @Test 68 | fun `class with public method, method throws`() { 69 | val (input, output) = testFile(testProjectDir, "TestClass.java") 70 | input.writeText(testClassWithPublicMethod) 71 | 72 | runGradle(testProjectDir, "censorSource") 73 | 74 | assertClassHasNoNonPublicElements(output) 75 | assertClassHasPublicMethod(output, "test") 76 | } 77 | 78 | @Test 79 | fun `local interface with public method, method removed`() { 80 | val (input, output) = testFile(testProjectDir, "TestClass.java") 81 | input.writeText(localTestInterface) 82 | 83 | runGradle(testProjectDir, "censorSource") 84 | 85 | assertClassHasNoNonPublicElements(output) 86 | assertClassHasComment(output) 87 | } 88 | 89 | @Test 90 | fun `public interface with public method, method throws`() { 91 | val (input, output) = testFile(testProjectDir, "TestClass.java") 92 | input.writeText(testInterface) 93 | 94 | runGradle(testProjectDir, "censorSource") 95 | 96 | assertInterfaceHasField(output,"String constant") 97 | assertInterfaceHasMethod(output,"test") 98 | } 99 | 100 | } -------------------------------------------------------------------------------- /java-censor-plugin/src/test/kotlin/com/sebchlan/javacensor/TestClasses.kt: -------------------------------------------------------------------------------- 1 | package com.sebchlan.javacensor 2 | 3 | const val testClassWithPrivateField = """ 4 | public class TestClass { 5 | 6 | private String testField = "test"; 7 | 8 | } 9 | """ 10 | 11 | const val testClassWithPublicField = """ 12 | public class TestClass { 13 | 14 | public String testField = "test"; 15 | 16 | } 17 | """ 18 | 19 | 20 | const val testClassWithPrivateMethod = """ 21 | public class TestClass { 22 | 23 | /** 24 | * Test public, return String 25 | */ 26 | private String test(Object object) { 27 | System.out.println("asdf"); 28 | return "asdf"; 29 | } 30 | 31 | } 32 | """ 33 | 34 | const val testClassWithPublicMethod = """ 35 | public class TestClass { 36 | 37 | /** 38 | * Test public, return String 39 | */ 40 | public String test(Object object) { 41 | System.out.println("asdf"); 42 | return "asdf"; 43 | } 44 | 45 | } 46 | """ 47 | 48 | 49 | const val localTestClass = """ 50 | class TestClass { 51 | 52 | int field2; 53 | public double field3; 54 | 55 | public TestClass() { 56 | System.out.println("lolo"); 57 | } 58 | 59 | /** 60 | * Test public 61 | */ 62 | public void test1() { 63 | System.out.println("asdf"); 64 | } 65 | 66 | } 67 | """ 68 | 69 | const val localTestInterface = """ 70 | interface TestInterface { 71 | 72 | String constant = "constant"; 73 | 74 | /** 75 | * More public interfaces 76 | */ 77 | void test(); 78 | 79 | } 80 | """ 81 | 82 | const val testInterface = """ 83 | public interface TestInterface { 84 | 85 | String constant = "constant"; 86 | 87 | /** 88 | * More public interfaces 89 | */ 90 | void test(); 91 | 92 | } 93 | """ -------------------------------------------------------------------------------- /java-censor-plugin/src/test/kotlin/com/sebchlan/javacensor/TestHelper.kt: -------------------------------------------------------------------------------- 1 | package com.sebchlan.javacensor 2 | 3 | import org.gradle.testkit.runner.GradleRunner 4 | import org.junit.rules.TemporaryFolder 5 | import java.io.File 6 | import java.net.URLDecoder 7 | 8 | 9 | fun testFile(testProject: TemporaryFolder, name: String): Pair { 10 | val file = testProject.newFile("src/$name") 11 | val resultFile = File(testProject.root, "censored_source/$name") 12 | return Pair(file, resultFile) 13 | } 14 | 15 | fun runGradle(folder: TemporaryFolder, argument: String) = GradleRunner.create().apply { 16 | withPluginClasspath(pluginPath()) 17 | withProjectDir(folder.root) 18 | withArguments(argument) 19 | }.build()!! 20 | 21 | 22 | fun testSourceDir(folder: TemporaryFolder): File = folder.newFolder("src") 23 | 24 | fun testBuildFile(folder: TemporaryFolder): File { 25 | 26 | val buildFile = """ 27 | buildscript { 28 | dependencies { 29 | classpath files(${pluginPath().joinToString(separator = ",") { "'${it.absolutePath }'" }}) 30 | } 31 | } 32 | 33 | apply plugin: 'com.sebchlan.javacensor' 34 | 35 | task censorSource(type: com.sebchlan.javacensor.CensorCopyTask) { 36 | inputs.files(files("${folder.root}/src").toSet()) 37 | destinationDir = file("${folder.root}/censored_source") 38 | } 39 | """ 40 | val file = folder.newFile("build.gradle") 41 | file.writeText(buildFile) 42 | return file 43 | } 44 | 45 | private fun pluginPath(): List { 46 | return File(URLDecoder.decode(ClassLoader.getSystemResource("plugin-classpath.txt").file, "UTF-8")) 47 | .readLines() 48 | .map { File(it) } 49 | } 50 | -------------------------------------------------------------------------------- /java-censor-sample/build.gradle: -------------------------------------------------------------------------------- 1 | apply plugin: 'java-library' 2 | apply plugin: 'com.sebchlan.javacensor' 3 | 4 | sourceCompatibility = "1.7" 5 | targetCompatibility = "1.7" 6 | 7 | tasks.register("censorSource", com.sebchlan.javacensor.CensorCopyTask) { task -> 8 | inputs.files(sourceSets.main.java.srcDirs) 9 | destinationDir = file("$buildDir/censored_source") 10 | } -------------------------------------------------------------------------------- /java-censor-sample/src/main/java/com/sebchlan/sample/PrivateTestClass.java: -------------------------------------------------------------------------------- 1 | package com.sebchlan.sample; 2 | 3 | class PrivateTestClass { 4 | 5 | } 6 | -------------------------------------------------------------------------------- /java-censor-sample/src/main/java/com/sebchlan/sample/Sample.java: -------------------------------------------------------------------------------- 1 | package com.sebchlan.sample; 2 | 3 | public class Sample { 4 | } 5 | -------------------------------------------------------------------------------- /java-censor-sample/src/main/java/com/sebchlan/sample/TestClass.java: -------------------------------------------------------------------------------- 1 | package com.sebchlan.sample; 2 | 3 | /** 4 | * Class docs 5 | */ 6 | public class TestClass { 7 | 8 | String field1; 9 | int field2; 10 | public double field3; 11 | long field4; 12 | 13 | public TestClass() { 14 | System.out.println("lolo"); 15 | } 16 | 17 | /** 18 | * Test public 19 | */ 20 | public void test1() { 21 | System.out.println("asdf"); 22 | } 23 | 24 | /** 25 | * Test local 26 | */ 27 | void test2() { 28 | System.out.println("asdf"); 29 | } 30 | 31 | /** 32 | * Test private 33 | */ 34 | private void test3() { 35 | System.out.println("asdf"); 36 | } 37 | 38 | /** 39 | * Test protected 40 | */ 41 | protected void test6() { 42 | System.out.println("asdf"); 43 | } 44 | 45 | /** 46 | * Test public, return String 47 | */ 48 | public String test4(Object object) { 49 | System.out.println("asdf"); 50 | return "asdf"; 51 | } 52 | 53 | /** 54 | * Test public, return int 55 | */ 56 | public int test5(Object object) { 57 | System.out.println("asdf"); 58 | return 1; 59 | } 60 | 61 | class Foobar { 62 | 63 | } 64 | 65 | public class Foobar2 { 66 | 67 | } 68 | 69 | } 70 | -------------------------------------------------------------------------------- /java-censor-sample/src/main/java/com/sebchlan/sample/TestInterface.java: -------------------------------------------------------------------------------- 1 | package com.sebchlan.sample; 2 | 3 | public interface TestInterface { 4 | 5 | String constant = "zxczxvczxcv"; 6 | 7 | /** 8 | * More public interfaces 9 | */ 10 | void bla(); 11 | 12 | class Lol { 13 | 14 | public String a; 15 | 16 | public void test() { 17 | System.out.println("asdf"); 18 | } 19 | 20 | } 21 | 22 | } 23 | -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | include ':java-censor-plugin', ':java-censor-sample' 2 | 3 | 4 | -------------------------------------------------------------------------------- /travis.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | boxOut(){ 4 | local s="$*" 5 | tput setaf 3 6 | echo -e " =${s//?/=}=\n| $(tput setaf 4)$s$(tput setaf 3) |\n =${s//?/=}=\n" 7 | tput sgr 0 8 | } 9 | 10 | isPullRequest() { 11 | [[ "$TRAVIS_PULL_REQUEST" == "false" ]] && return 1 || return 0 12 | } 13 | 14 | exitOnFailedBuild() { 15 | if [ $? -ne 0 ]; then 16 | boxOut "BUILD FAILED: $1" 17 | exit 1 18 | fi 19 | } 20 | 21 | deployArtifacts() { 22 | boxOut "Deploying artefact" 23 | ./gradlew :java-censor-plugin:uploadArchives 24 | exitOnFailedBuild "Deploying artefact." 25 | } 26 | 27 | runTests() { 28 | boxOut "Run tests" 29 | ./gradlew test 30 | exitOnFailedBuild "Error running tests." 31 | } 32 | 33 | if isPullRequest ; then 34 | boxOut "This is a PR." 35 | runTests 36 | else 37 | boxOut "This is a branch build." 38 | runTests 39 | deployArtifacts 40 | fi 41 | exit 0 --------------------------------------------------------------------------------