(multi-os-engine/multi-os-engine#156) Add global moe.proguard.baseCfgFile and appendCfgFile settings. Rename excludedFiles config to excludeFiles.

Update readme.

Author: Noisyfox

README.md

@@ -160,16 +160,38 @@ buildscript {
 
 ### ProGuard
 
-ProGuard has three supported levels of trimming: `app` (default), `platform`, `all`
-
-This level can be set in the buildscript:
+ProGuard can be configured globally here, or per-config in [ProGuard Task](#proguard-task).
 
 ```groovy
 moe {
-    proguardLevel 'platform'
+    proguard {
+        // apply level
+        level = 'platform'
+      
+        // path to the base configuration file, or `null` to use SDK default config
+        baseCfgFile = null
+      
+        // null or path to to appended configuration file
+        appendCfgFile = null
+      
+        // whether code minification is enabled. Ignored when `baseCfgFile` is specified. Default to `true`
+        minifyEnabled = true
+      
+        // whether code obfuscation is enabled. Ignored when `baseCfgFile` is specified. Default to `false`
+        obfuscationEnabled = false
+
+        // exclude files from `-injars` config that will be processed by proguard
+        excludeFiles = [
+                'META-INF/*.SF',
+                'META-INF/*.DSA',
+                'META-INF/*.RSA'
+        ]
+        excludeFile 'org/bouncycastle/jce/provider/*Spi_8.class'
+    }
 }
 ```
 
+ProGuard has three supported levels of trimming: `app` (default), `platform`, `all`:
 - `app` will only process the classes of your application and it's non-MOE dependencies. This is the fastest mode and
 is recommended for development.
 - `platform` will do the same as `app` but will also include the `moe-ios.jar` MOE dependency. This mode is a bit
@@ -322,6 +344,7 @@ information about what got stripped can be found in the `proguard.log` file whic
 - `obfuscationEnabled`: whether code obfuscation is enabled. Ignored when `baseCfgFile` is specified.
 - `mappingFile`: path to the name mapping output file. Generated only if `obfuscationEnabled` is `true`.
 - `inJars`: collection of paths to files being passed to ProGuard via `-injars`.
+- `excludeFiles`: exclude files from `inJars` that will be processed by proguard.
 - `libraryJars`: collection of paths to files being passed to ProGuard via `-libraryjars`.
 - `outJar`: path to ProGuard's output jar.
 - `composedCfgFile`: path to the composed configuration file.

src/main/java/org/moe/gradle/options/ProGuardOptions.java

@@ -4,7 +4,9 @@
 import org.moe.gradle.anns.IgnoreUnused;
 import org.moe.gradle.anns.NotNull;
 import org.moe.gradle.anns.Nullable;
+import org.moe.gradle.utils.Require;
 
+import java.util.Arrays;
 import java.util.Collection;
 import java.util.LinkedHashSet;
 import java.util.Set;
@@ -22,7 +24,8 @@ public class ProGuardOptions {
     private int level = LEVEL_APP;
     private boolean minifyEnabled = true;
     private boolean obfuscationEnabled = false;
-    private Set<String> excludedFiles;
+    @Nullable
+    private Set<String> excludeFiles;
 
     @NotNull
     @IgnoreUnused
@@ -86,12 +89,46 @@ public void setObfuscationEnabled(boolean obfuscationEnabled) {
     }
 
     @Nullable
-    public Collection<String> getExcludedFiles() {
-        return excludedFiles;
+    public Collection<String> getExcludeFiles() {
+        return excludeFiles;
+    }
+
+    @IgnoreUnused
+    public void setExcludeFiles(@Nullable Collection<String> excludedFiles) {
+        this.excludeFiles = excludedFiles == null ? null : new LinkedHashSet<>(excludedFiles);
+    }
+
+    public ProGuardOptions excludeFile(String... names) {
+        if (excludeFiles == null) {
+            excludeFiles = new LinkedHashSet<>();
+        }
+        excludeFiles.addAll(Arrays.asList(Require.nonNull(names)));
+        return this;
+    }
+
+    @Nullable
+    private Object baseCfgFile;
+
+    @Nullable
+    public Object getBaseCfgFile() {
+        return baseCfgFile;
+    }
+
+    @IgnoreUnused
+    public void setBaseCfgFile(@Nullable Object baseCfgFile) {
+        this.baseCfgFile = baseCfgFile;
+    }
+
+    @Nullable
+    private Object appendCfgFile;
+
+    @Nullable
+    public Object getAppendCfgFile() {
+        return appendCfgFile;
     }
 
     @IgnoreUnused
-    public void setExcludedFiles(@Nullable Collection<String> excludedFiles) {
-        this.excludedFiles = excludedFiles == null ? null : new LinkedHashSet<>(excludedFiles);
+    public void setAppendCfgFile(@Nullable Object appendCfgFile) {
+        this.appendCfgFile = appendCfgFile;
     }
 }

src/main/java/org/moe/gradle/tasks/ProGuard.java

@@ -73,7 +73,7 @@ public class ProGuard extends AbstractBaseTask {
     private static final String CONVENTION_BASE_CFG_FILE = "baseCfgFile";
     private static final String CONVENTION_APPEND_CFG_FILE = "appendCfgFile";
     private static final String CONVENTION_IN_JARS = "inJars";
-    private static final String CONVENTION_EXCLUDED_FILES = "excludedFiles";
+    private static final String CONVENTION_EXCLUDE_FILES = "excludeFiles";
     private static final String CONVENTION_LIBRARY_JARS = "libraryJars";
     private static final String CONVENTION_OUT_JAR = "outJar";
     private static final String CONVENTION_COMPOSED_CFG_FILE = "composedCfgFile";
@@ -142,17 +142,17 @@ public void setInJars(@Nullable Collection<Object> inJars) {
     }
 
     @Nullable
-    private Set<String> excludedFiles;
+    private Set<String> excludeFiles;
 
     @Input
     @NotNull
-    public Collection<String> getExcludedFiles() {
-        return getOrConvention(excludedFiles, CONVENTION_EXCLUDED_FILES);
+    public Collection<String> getExcludeFiles() {
+        return getOrConvention(excludeFiles, CONVENTION_EXCLUDE_FILES);
     }
 
     @IgnoreUnused
-    public void setExcludedFiles(@Nullable Collection<String> excludedFiles) {
-        this.excludedFiles = excludedFiles == null ? null : new LinkedHashSet<>(excludedFiles);
+    public void setExcludeFiles(@Nullable Collection<String> excludeFiles) {
+        this.excludeFiles = excludeFiles == null ? null : new LinkedHashSet<>(excludeFiles);
     }
 
     @Nullable
@@ -269,8 +269,8 @@ private String composeInputFileFilter() {
         sb.append("(!**.framework/**,!**.bundle/**,!module-info.class");
 
         // Add user specified
-        for (String excludedFile : getExcludedFiles()) {
-            sb.append(",!").append(excludedFile);
+        for (String excludeFile : getExcludeFiles()) {
+            sb.append(",!").append(excludeFile);
         }
 
         sb.append(")");
@@ -458,6 +458,10 @@ protected final void setupMoeTask(final @NotNull SourceSet sourceSet, final @Not
 
         addConvention(CONVENTION_PROGUARD_JAR, sdk::getProGuardJar);
         addConvention(CONVENTION_BASE_CFG_FILE, () -> {
+            if (ext.proguard.getBaseCfgFile() != null) {
+                return ext.proguard.getBaseCfgFile();
+            }
+
             final File cfg = project.file("proguard.cfg");
             if (cfg.exists() && cfg.isFile()) {
                 return cfg;
@@ -473,6 +477,10 @@ protected final void setupMoeTask(final @NotNull SourceSet sourceSet, final @Not
             }
         });
         addConvention(CONVENTION_APPEND_CFG_FILE, () -> {
+            if (ext.proguard.getAppendCfgFile() != null) {
+                return ext.proguard.getAppendCfgFile();
+            }
+
             final File cfg = project.file("proguard.append.cfg");
             if (cfg.exists() && cfg.isFile()) {
                 return cfg;
@@ -521,8 +529,8 @@ protected final void setupMoeTask(final @NotNull SourceSet sourceSet, final @Not
 
             return jars;
         });
-        addConvention(CONVENTION_EXCLUDED_FILES, () -> {
-            Collection<String> exc = ext.proguard.getExcludedFiles();
+        addConvention(CONVENTION_EXCLUDE_FILES, () -> {
+            Collection<String> exc = ext.proguard.getExcludeFiles();
             if (exc == null) {
                 exc = Collections.emptySet();
             }
@@ -557,7 +565,7 @@ protected final void setupMoeTask(final @NotNull SourceSet sourceSet, final @Not
         addConvention(CONVENTION_COMPOSED_CFG_FILE, () -> resolvePathInBuildDir(out, "configuration.pro"));
         addConvention(CONVENTION_MAPPING_FILE, () -> isCustomisedBaseConfig() || !isObfuscationEnabled() ? null : resolvePathInBuildDir(out, "mapping.txt"));
         addConvention(CONVENTION_LOG_FILE, () -> resolvePathInBuildDir(out, "ProGuard.log"));
-        addConvention(CONVENTION_MINIFY_ENABLED, () -> getMoeExtension().proguard.isMinifyEnabled());
-        addConvention(CONVENTION_OBFUSCATION_ENABLED, () -> getMoeExtension().proguard.isObfuscationEnabled());
+        addConvention(CONVENTION_MINIFY_ENABLED, ext.proguard::isMinifyEnabled);
+        addConvention(CONVENTION_OBFUSCATION_ENABLED, ext.proguard::isObfuscationEnabled);
     }
 }