Add proguard rules to modules (#14)

* Add proguard rules to modules

* Update changelog

* Update README

Author: Adrián García

CHANGELOG.md

@@ -5,11 +5,22 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
-- No new features, yet!
+### Added
+- Add proguard rules for most modules that need them.
+### Changed
+- No changed features!
+### Deprecated
+- No deprecated features!
+### Removed
+- No removed features!
+### Fixed
+- No fixed issues!
+### Security
+- No security issues fixed!
 
 ## [1.3.2] - 2020-05-27
 ### Added
-- Added `allTerminal`, `onAllTerminal` and `firstExceptionOrNull` functions to lists of `Resource`s
+- Add `allTerminal`, `onAllTerminal` and `firstExceptionOrNull` functions to lists of `Resource`s
 
 ## [1.3.1] - 2020-04-22
 ### Added

README.md

@@ -247,6 +247,10 @@ dispatcher.addInterceptor(LoggerInterceptor(stores)) { tag, msg ->
 }
 ```
 
+### \[Android] Proguard/R8
+Each of the libraries contain a sensible proguard file that your project can consume in order to run you app on Proguard or R8.
+No additional steps have to be done in order to use them apart from enabling minify in your project.
+
 ## License
 ```
    Copyright 2019 BQ

mini-android/build.gradle

@@ -12,7 +12,9 @@ android {
         versionCode android_version_code
         versionName android_version_name
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+        consumerProguardFiles "mini-android.pro"
     }
+
     buildTypes {
         release {
             minifyEnabled false

mini-android/mini-android.pro

@@ -0,0 +1,7 @@
+# ViewModel's empty constructor is considered to be unused by proguard, so keep it
+-keepclassmembers,allowobfuscation class * extends androidx.lifecycle.ViewModel {
+    <init>();
+}
+-keepclassmembers,allowobfuscation class * extends androidx.lifecycle.AndroidViewModel {
+    <init>(android.app.Application);
+}

mini-common/src/main/resources/META-INF/proguard/mini-common.pro

@@ -0,0 +1,4 @@
+-keepnames class * extends mini.Store { *; }
+-keepnames class * extends mini.BaseAction { *; }
+-keep class mini.BaseAction { *; }
+-keep class mini.Task { *; }

mini-kodein-android/build.gradle

@@ -12,7 +12,9 @@ android {
         versionCode android_version_code
         versionName android_version_name
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+        consumerProguardFiles "mini-kodein-android.pro"
     }
+
     buildTypes {
         release {
             minifyEnabled false

mini-kodein-android/mini-kodein-android.pro

@@ -0,0 +1,2 @@
+# Needed for injection
+-keep class * extends androidx.lifecycle.ViewModel { *; }

mini-kodein-android/consumer-rules.pro renamed to mini-kodein/src/main/resources/META-INF/proguard/mini-kodein.pro

@@ -14,7 +14,7 @@ android {
         versionName android_version_name
 
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
-        consumerProguardFiles 'consumer-rules.pro'
+        consumerProguardFiles "mini-rx2-android.pro"
     }
 
     buildTypes {