Make annotation processor isolating (#31)

Author: MatthiasRobbers

CHANGELOG.md

@@ -1,6 +1,17 @@
 Change Log
 ==========
 
+Version 1.4.0 *(2021-04-10)*
+----------------------------
+* Improve: Shortbread is now an _isolating_ annotation processor, which improves the performance of incremental annotation processing.
+Before, the processor was of type _aggregating_ and it would generate a single class `ShortbreadGenerated`. Now it generates one
+class for each activity that contains shortcuts, e.g. `MoviesActivity_Shortcuts`. The generated classes are still only used by the
+library itself, the consumer does not interact with them.
+* Improve: Shortcut methods/functions don't have to be `public` anymore. Any visibility higher than `private` is enough.
+* Fix: When using `R2`, resource values sometimes were not properly read when the incremental annotation processing was incremental
+* New: The module `:sample-library` shows how to use Shortbread in a library module
+
+
 Version 1.3.0 *(2021-03-31)*
 ----------------------------
 * New: Shortbread is now initialized automatically using [App Startup](https://developer.android.com/topic/libraries/app-startup)

README.md

@@ -92,8 +92,8 @@ Shortbread is available on `mavenCentral()`.
 apply plugin: 'kotlin-kapt'
 
 dependencies {
-    implementation 'com.github.matthiasrobbers:shortbread:1.3.0'
-    kapt 'com.github.matthiasrobbers:shortbread-compiler:1.3.0'
+    implementation 'com.github.matthiasrobbers:shortbread:1.4.0'
+    kapt 'com.github.matthiasrobbers:shortbread-compiler:1.4.0'
 }
 ```
 </details>
@@ -102,8 +102,8 @@ dependencies {
 
 ```groovy
 dependencies {
-    implementation 'com.github.matthiasrobbers:shortbread:1.3.0'
-    annotationProcessor 'com.github.matthiasrobbers:shortbread-compiler:1.3.0'
+    implementation 'com.github.matthiasrobbers:shortbread:1.4.0'
+    annotationProcessor 'com.github.matthiasrobbers:shortbread-compiler:1.4.0'
 }
 ```
 </details>
@@ -123,7 +123,7 @@ buildscript {
         mavenCentral()
     }
     dependencies {
-        classpath 'com.github.matthiasrobbers:shortbread-gradle-plugin:1.3.0'
+        classpath 'com.github.matthiasrobbers:shortbread-gradle-plugin:1.4.0'
     }
 }
 ```

gradle.properties

@@ -2,7 +2,7 @@ org.gradle.jvmargs=-Xmx1536m
 android.useAndroidX=true
 
 GROUP=com.github.matthiasrobbers
-VERSION_NAME=1.3.0
+VERSION_NAME=1.4.0
 
 POM_URL=https://github.com/matthiasrobbers/shortbread
 POM_SCM_URL=https://github.com/matthiasrobbers/shortbread

sample-library/.gitignore

@@ -0,0 +1 @@
+/build

sample-library/build.gradle

@@ -0,0 +1,32 @@
+buildscript {
+    repositories {
+        mavenCentral()
+        google()
+    }
+
+    dependencies {
+        classpath "com.github.matthiasrobbers:shortbread-gradle-plugin:1.3.0"
+    }
+}
+
+apply plugin: 'com.android.library'
+apply plugin: 'com.github.matthiasrobbers.shortbread'
+
+android {
+    compileSdkVersion project.compileSdkVersion
+    buildToolsVersion project.buildToolsVersion
+
+    defaultConfig {
+        minSdkVersion project.minSdkVersion
+    }
+
+    compileOptions {
+        sourceCompatibility = sourceCompatibilityVersion
+        targetCompatibility = targetCompatibilityVersion
+    }
+}
+
+dependencies {
+    implementation project(':shortbread')
+    annotationProcessor project(':shortbread-compiler')
+}

sample-library/src/main/AndroidManifest.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="com.example.shortbread.songs">
+
+    <application>
+
+        <activity
+            android:name="com.example.songs.SongsActivity"
+            android:label="Songs" />
+    </application>
+</manifest>

sample-library/src/main/java/com/example/songs/SongsActivity.java

@@ -0,0 +1,22 @@
+package com.example.songs;
+
+import android.app.Activity;
+import android.os.Bundle;
+import android.widget.TextView;
+
+import com.example.shortbread.songs.R;
+import com.example.shortbread.songs.R2;
+
+import shortbread.Shortcut;
+
+@Shortcut(id = "songs", icon = R2.drawable.ic_shortcut_songs, shortLabelRes = R2.string.label_songs, rank = 5)
+public class SongsActivity extends Activity {
+
+    @Override
+    protected void onCreate(Bundle savedInstanceState) {
+        super.onCreate(savedInstanceState);
+        setContentView(R.layout.activity_sample);
+
+        ((TextView) findViewById(R.id.text)).setText("Songs");
+    }
+}

…es/drawable-xxhdpi/ic_shortcut_songs.png …es/drawable-xxhdpi/ic_shortcut_songs.pngsample/src/main/res/drawable-xxhdpi/ic_shortcut_songs.png renamed to sample-library/src/main/res/drawable-xxhdpi/ic_shortcut_songs.png sample/src/main/res/drawable-xxhdpi/ic_shortcut_songs.png renamed to sample-library/src/main/res/drawable-xxhdpi/ic_shortcut_songs.png

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="utf-8"?>
+<FrameLayout xmlns:android="http://schemas.android.com/apk/res/android"
+    android:layout_width="match_parent"
+    android:layout_height="match_parent"
+    android:padding="16dp">
+
+    <TextView
+        android:id="@+id/text"
+        android:layout_width="wrap_content"
+        android:layout_height="wrap_content"
+        android:layout_gravity="center"
+        android:text="Shortbread"
+        android:textSize="48sp" />
+</FrameLayout>

sample-library/src/main/res/layout/activity_sample.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="utf-8"?>
+<resources>
+
+    <string name="label_songs">Songs</string>
+</resources>