Compare commits

...

8 Commits

Author SHA1 Message Date
Eric Salemi
912d149394 Bump to version 7.0.1 2020-11-04 13:59:00 +01:00
James Hamilton
6a56cc2259 Merge pull request #93 from Guardsquare/mrjameshamilton-patch-1
Add release note for Kotlin 1.4 metadata fix
2020-11-04 13:55:19 +01:00
James Hamilton
cecb95f8d0 Add release note for Kotlin 1.4 metadata fix 2020-11-04 12:17:36 +01:00
Eric Lafortune
cbbecd815a Merge remote-tracking branch 'github/master' 2020-10-23 02:19:58 +02:00
Jago Gyselinck
46b7300da5 Backport DGD-2494 2020-10-23 00:45:26 +02:00
James Hamilton
679425e5d8 Add Gradle Kotlin DSL example 2020-09-26 21:48:32 +02:00
Sander Bogaert
8532cfa2d6 Highlight README code snippets. 2020-09-16 09:59:26 +02:00
Sander Bogaert
c70af673c7 Add 'getting help' section to README with community link. 2020-09-16 09:56:07 +02:00
30 changed files with 471 additions and 45 deletions

View File

@@ -68,51 +68,61 @@ The resulting applications and libraries are smaller, faster, and a bit better
hardened against reverse engineering. ProGuard is very popular for Android
development, but it also works for Java code in general.
## ❓ Getting Help
If you have **usage or general questions** please ask them in the <a href="https://community.guardsquare.com/?utm_source=github&utm_medium=site-link&utm_campaign=github-community">**Guardsquare Community**.</a>
Please use <a href="https://github.com/guardsquare/proguard/issues">**the issue tracker**</a> to report actual **bugs 🐛, crashes**, etc.
<br />
<br />
## 🚀 Quick Start
ProGuard is integrated in Google's Android SDK. If you have an Android Gradle
project you can enable ProGuard instead of the default R8 compiler:
1. Disable R8 in your `gradle.properties`:
```
android.enableR8=false
android.enableR8.libraries=false
```
```gradle
android.enableR8=false
android.enableR8.libraries=false
```
2. Override the default version of ProGuard with the most recent one in your
main `build.gradle`:
```
buildscript {
...
configurations.all {
resolutionStrategy {
dependencySubstitution {
substitute module('net.sf.proguard:proguard-gradle') with module('com.guardsquare:proguard-gradle:7.0.0')
}
```gradle
buildscript {
//...
configurations.all {
resolutionStrategy {
dependencySubstitution {
substitute module('net.sf.proguard:proguard-gradle') with module('com.guardsquare:proguard-gradle:7.0.1')
}
}
}
```
}
```
3. Enable minification as usual in your `build.gradle`:
```
android {
...
buildTypes {
release {
minifyEnabled true
shrinkResources true
proguardFile getDefaultProguardFile('proguard-android-optimize.txt')
proguardFile 'proguard-project.txt'
}
```gradle
android {
//...
buildTypes {
release {
minifyEnabled true
shrinkResources true
proguardFile getDefaultProguardFile('proguard-android-optimize.txt')
proguardFile 'proguard-project.txt'
}
}
```
}
```
4. Add any necessary configuration to your `proguard-project.txt`.
You can then build your application as usual:
```
```shell
gradle assembleRelease
```

View File

@@ -28,7 +28,7 @@ sourceSets.main {
}
dependencies {
compile 'com.guardsquare:proguard-core:7.0.0'
compile "com.guardsquare:proguard-core:${proguardCoreVersion}"
compile "com.google.code.gson:gson:${gsonVersion}"
}

View File

@@ -92,9 +92,8 @@ implements MemberVisitor
// Isn't there another original name for this new name, or should
// this original name get priority?
String otherName = (String)nameMap.get(newName);
if (otherName == null ||
MemberObfuscator.hasFixedNewMemberName(member) ||
name.compareTo(otherName) < 0)
if (otherName == null ||
MemberObfuscator.hasFixedNewMemberName(member))
{
// Remember not to use the new name again in this name space.
nameMap.put(newName, name);

View File

@@ -7,7 +7,7 @@ plugins {
allprojects {
group = 'com.guardsquare'
version = '7.0.0'
version = proguardVersion
}
wrapper {

View File

@@ -10,7 +10,7 @@ line to your **`build.gradle`** file:
jcenter()
}
dependencies {
classpath 'com.guardsquare:proguard-gradle:7.0.0'
classpath 'com.guardsquare:proguard-gradle:7.0.1'
}
}

View File

@@ -14,7 +14,7 @@ project you can enable ProGuard instead of the default R8 compiler:
configurations.all {
resolutionStrategy {
dependencySubstitution {
substitute module('net.sf.proguard:proguard-gradle') with module('com.guardsquare:proguard-gradle:7.0.0')
substitute module('net.sf.proguard:proguard-gradle') with module('com.guardsquare:proguard-gradle:7.0.1')
}
}
}
@@ -58,7 +58,7 @@ project as follows:
}
dependencies {
classpath 'com.android.tools.build:gradle:3.3.0'
classpath 'com.guardsquare:proguard-gradle:7.0.0'
classpath 'com.guardsquare:proguard-gradle:7.0.1'
}
}

View File

@@ -2,6 +2,8 @@
| Version| Issue | Module | Explanation
|--------|----------|----------|----------------------------------
| 7.0.1 | DGD-2382 | CORE | Fixed processing of Kotlin 1.4 metadata annotations.
| 7.0.1 | DGD-2494 | CORE | Fix naming conflict resolution potentially resulting in the renaming of library members.
| 7.0.1 | | RETRACE | Extend expressions supported by Retrace.
| 7.0.0 | | CORE | Added support for [Kotlin metadata](manual/kotlin.md), with new option `-keepkotlinmetadata`.
| 7.0.0 | PGD-32 | CORE | Allowing Java 14 class files.

View File

@@ -9,7 +9,7 @@ buildscript {
}
dependencies {
//classpath ':proguard:' // For the local copy of the ProGuard plugin.
classpath 'com.guardsquare:proguard-gradle:7.0.0' // For the copy from Jcenter.
classpath 'com.guardsquare:proguard-gradle:7.0.1' // For the copy from Jcenter.
classpath 'com.android.tools.build:gradle:3.3.0'
}
}

View File

@@ -11,7 +11,7 @@ buildscript {
// Override the default version of ProGuard
// with the most recent one.
dependencySubstitution {
substitute module('net.sf.proguard:proguard-gradle') with module('com.guardsquare:proguard-gradle:7.0.0')
substitute module('net.sf.proguard:proguard-gradle') with module('com.guardsquare:proguard-gradle:7.0.1')
}
}
}

View File

@@ -20,7 +20,7 @@ buildscript {
google()
}
dependencies {
classpath 'com.guardsquare:proguard-gradle:7.0.0'
classpath 'com.guardsquare:proguard-gradle:7.0.1'
}
}

View File

@@ -13,7 +13,7 @@ buildscript {
google()
}
dependencies {
classpath 'com.guardsquare:proguard-gradle:7.0.0'
classpath 'com.guardsquare:proguard-gradle:7.0.1'
}
}

View File

@@ -13,7 +13,7 @@ buildscript {
google()
}
dependencies {
classpath 'com.guardsquare:proguard-gradle:7.0.0'
classpath 'com.guardsquare:proguard-gradle:7.0.1'
}
}

View File

@@ -14,7 +14,7 @@ buildscript {
google()
}
dependencies {
classpath 'com.guardsquare:proguard-gradle:7.0.0'
classpath 'com.guardsquare:proguard-gradle:7.0.1'
}
}

View File

@@ -13,7 +13,7 @@ buildscript {
google()
}
dependencies {
classpath 'com.guardsquare:proguard-gradle:7.0.0'
classpath 'com.guardsquare:proguard-gradle:7.0.1'
}
}

View File

@@ -14,7 +14,7 @@ buildscript {
google()
}
dependencies {
classpath 'com.guardsquare:proguard-gradle:7.0.0'
classpath 'com.guardsquare:proguard-gradle:7.0.1'
}
}

View File

@@ -14,7 +14,7 @@ buildscript {
google()
}
dependencies {
classpath 'com.guardsquare:proguard-gradle:7.0.0'
classpath 'com.guardsquare:proguard-gradle:7.0.1'
}
}

View File

@@ -14,7 +14,7 @@ buildscript {
google()
}
dependencies {
classpath 'com.guardsquare:proguard-gradle:7.0.0'
classpath 'com.guardsquare:proguard-gradle:7.0.1'
}
}

View File

@@ -14,7 +14,7 @@ buildscript {
google()
}
dependencies {
classpath 'com.guardsquare:proguard-gradle:7.0.0'
classpath 'com.guardsquare:proguard-gradle:7.0.1'
}
}

View File

@@ -13,7 +13,7 @@ buildscript {
google()
}
dependencies {
classpath 'com.guardsquare:proguard-gradle:7.0.0'
classpath 'com.guardsquare:proguard-gradle:7.0.1'
}
}

View File

@@ -0,0 +1,6 @@
#
# https://help.github.com/articles/dealing-with-line-endings/
#
# These are explicitly windows files and should use crlf
*.bat text eol=crlf

5
examples/gradlekotlindsl/.gitignore vendored Normal file
View File

@@ -0,0 +1,5 @@
# Ignore Gradle project-specific cache directory
.gradle
# Ignore Gradle build output directory
build

View File

@@ -0,0 +1,76 @@
buildscript {
repositories {
jcenter()
google()
}
dependencies {
// TODO: required due to https://github.com/Guardsquare/proguard/issues/30
classpath("com.android.tools.build:gradle:3.0.0")
classpath("com.guardsquare:proguard-gradle:7.0.1")
}
}
plugins {
java
application
}
repositories {
jcenter()
}
dependencies {
testImplementation("junit:junit:4.12")
}
application {
mainClassName = "gradlekotlindsl.App"
}
tasks.withType<Jar> {
manifest {
attributes["Main-Class"] = application.mainClassName
}
}
tasks.register<proguard.gradle.ProGuardTask>("proguard") {
dependsOn("jar")
// Alternatively put your config in a separate file
// configuration("config.pro")
verbose()
injars("build/libs/gradlekotlindsl.jar")
outjars("build/libs/gradlekotlindsl-obfuscated.jar")
val javaHome = System.getProperty("java.home")
// Automatically handle the Java version of this build.
if (System.getProperty("java.version").startsWith("1.")) {
// Before Java 9, the runtime classes were packaged in a single jar file.
libraryjars("$javaHome/lib/rt.jar")
} else {
// As of Java 9, the runtime classes are packaged in modular jmod files.
libraryjars(
// filters must be specified first, as a map
mapOf("jarfilter" to "!**.jar",
"filter" to "!module-info.class"),
"$javaHome/jmods/java.base.jmod"
)
}
allowaccessmodification()
repackageclasses("")
printmapping("build/mapping.txt")
keep("""class gradlekotlindsl.App {
public static void main(java.lang.String[]);
}
""")
}

View File

Binary file not shown.

View File

@@ -0,0 +1,5 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-6.1.1-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists

183
examples/gradlekotlindsl/gradlew vendored Executable file
View File

@@ -0,0 +1,183 @@
#!/usr/bin/env sh
#
# Copyright 2015 the original author or authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
##############################################################################
##
## Gradle start up script for UN*X
##
##############################################################################
# Attempt to set APP_HOME
# Resolve links: $0 may be a link
PRG="$0"
# Need this for relative symlinks.
while [ -h "$PRG" ] ; do
ls=`ls -ld "$PRG"`
link=`expr "$ls" : '.*-> \(.*\)$'`
if expr "$link" : '/.*' > /dev/null; then
PRG="$link"
else
PRG=`dirname "$PRG"`"/$link"
fi
done
SAVED="`pwd`"
cd "`dirname \"$PRG\"`/" >/dev/null
APP_HOME="`pwd -P`"
cd "$SAVED" >/dev/null
APP_NAME="Gradle"
APP_BASE_NAME=`basename "$0"`
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD="maximum"
warn () {
echo "$*"
}
die () {
echo
echo "$*"
echo
exit 1
}
# OS specific support (must be 'true' or 'false').
cygwin=false
msys=false
darwin=false
nonstop=false
case "`uname`" in
CYGWIN* )
cygwin=true
;;
Darwin* )
darwin=true
;;
MINGW* )
msys=true
;;
NONSTOP* )
nonstop=true
;;
esac
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
# Determine the Java command to use to start the JVM.
if [ -n "$JAVA_HOME" ] ; then
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
# IBM's JDK on AIX uses strange locations for the executables
JAVACMD="$JAVA_HOME/jre/sh/java"
else
JAVACMD="$JAVA_HOME/bin/java"
fi
if [ ! -x "$JAVACMD" ] ; then
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
else
JAVACMD="java"
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
# Increase the maximum file descriptors if we can.
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
MAX_FD_LIMIT=`ulimit -H -n`
if [ $? -eq 0 ] ; then
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
MAX_FD="$MAX_FD_LIMIT"
fi
ulimit -n $MAX_FD
if [ $? -ne 0 ] ; then
warn "Could not set maximum file descriptor limit: $MAX_FD"
fi
else
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
fi
fi
# For Darwin, add options to specify how the application appears in the dock
if $darwin; then
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
fi
# For Cygwin or MSYS, switch paths to Windows format before running java
if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
JAVACMD=`cygpath --unix "$JAVACMD"`
# We build the pattern for arguments to be converted via cygpath
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
SEP=""
for dir in $ROOTDIRSRAW ; do
ROOTDIRS="$ROOTDIRS$SEP$dir"
SEP="|"
done
OURCYGPATTERN="(^($ROOTDIRS))"
# Add a user-defined pattern to the cygpath arguments
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
fi
# Now convert the arguments - kludge to limit ourselves to /bin/sh
i=0
for arg in "$@" ; do
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
else
eval `echo args$i`="\"$arg\""
fi
i=`expr $i + 1`
done
case $i in
0) set -- ;;
1) set -- "$args0" ;;
2) set -- "$args0" "$args1" ;;
3) set -- "$args0" "$args1" "$args2" ;;
4) set -- "$args0" "$args1" "$args2" "$args3" ;;
5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
esac
fi
# Escape application args
save () {
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
echo " "
}
APP_ARGS=`save "$@"`
# Collect all arguments for the java command, following the shell quoting and substitution rules
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
exec "$JAVACMD" "$@"

100
examples/gradlekotlindsl/gradlew.bat vendored Normal file
View File

@@ -0,0 +1,100 @@
@rem
@rem Copyright 2015 the original author or authors.
@rem
@rem Licensed under the Apache License, Version 2.0 (the "License");
@rem you may not use this file except in compliance with the License.
@rem You may obtain a copy of the License at
@rem
@rem https://www.apache.org/licenses/LICENSE-2.0
@rem
@rem Unless required by applicable law or agreed to in writing, software
@rem distributed under the License is distributed on an "AS IS" BASIS,
@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@rem See the License for the specific language governing permissions and
@rem limitations under the License.
@rem
@if "%DEBUG%" == "" @echo off
@rem ##########################################################################
@rem
@rem Gradle startup script for Windows
@rem
@rem ##########################################################################
@rem Set local scope for the variables with windows NT shell
if "%OS%"=="Windows_NT" setlocal
set DIRNAME=%~dp0
if "%DIRNAME%" == "" set DIRNAME=.
set APP_BASE_NAME=%~n0
set APP_HOME=%DIRNAME%
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
@rem Find java.exe
if defined JAVA_HOME goto findJavaFromJavaHome
set JAVA_EXE=java.exe
%JAVA_EXE% -version >NUL 2>&1
if "%ERRORLEVEL%" == "0" goto init
echo.
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
echo.
echo Please set the JAVA_HOME variable in your environment to match the
echo location of your Java installation.
goto fail
:findJavaFromJavaHome
set JAVA_HOME=%JAVA_HOME:"=%
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
if exist "%JAVA_EXE%" goto init
echo.
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
echo.
echo Please set the JAVA_HOME variable in your environment to match the
echo location of your Java installation.
goto fail
:init
@rem Get command-line arguments, handling Windows variants
if not "%OS%" == "Windows_NT" goto win9xME_args
:win9xME_args
@rem Slurp the command line arguments.
set CMD_LINE_ARGS=
set _SKIP=2
:win9xME_args_slurp
if "x%~1" == "x" goto execute
set CMD_LINE_ARGS=%*
:execute
@rem Setup the command line
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
@rem Execute Gradle
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
:end
@rem End local scope for the variables with windows NT shell
if "%ERRORLEVEL%"=="0" goto mainEnd
:fail
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
rem the _cmd.exe /c_ return code!
if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
exit /b 1
:mainEnd
if "%OS%"=="Windows_NT" endlocal
:omega

View File

@@ -0,0 +1,10 @@
/*
* This file was generated by the Gradle 'init' task.
*
* The settings file is used to specify which projects to include in your build.
*
* Detailed information about configuring a multi-project build in Gradle can be found
* in the user manual at https://docs.gradle.org/6.1.1/userguide/multi_project_builds.html
*/
rootProject.name = "gradlekotlindsl"

View File

@@ -0,0 +1,14 @@
/*
* This Java source file was generated by the Gradle 'init' task.
*/
package gradlekotlindsl;
public class App {
public String getGreeting() {
return "Hello world.";
}
public static void main(String[] args) {
System.out.println(new App().getGreeting());
}
}

View File

@@ -0,0 +1,14 @@
/*
* This Java source file was generated by the Gradle 'init' task.
*/
package gradlekotlindsl;
import org.junit.Test;
import static org.junit.Assert.*;
public class AppTest {
@Test public void testAppHasAGreeting() {
App classUnderTest = new App();
assertNotNull("app should have a greeting", classUnderTest.getGreeting());
}
}

View File

@@ -1,3 +1,5 @@
proguardVersion = 7.0.1
proguardCoreVersion = 7.0.1
gsonVersion = 2.8.5
kotlinVersion = 1.3.31
kotlinxMetadataVersion = 0.1.0