Merge pull request #88 from OneBusAway/release-please--branches--main--changes--next

release: 0.1.0-alpha.32

Author: Ahmedhossamdev

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.1.0-alpha.31"
+  ".": "0.1.0-alpha.32"
 }

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.1.0-alpha.32 (2025-07-29)
+
+Full Changelog: [v0.1.0-alpha.31...v0.1.0-alpha.32](https://github.com/OneBusAway/java-sdk/compare/v0.1.0-alpha.31...v0.1.0-alpha.32)
+
+### Features
+
+* **client:** ensure compat with proguard ([06bc3af](https://github.com/OneBusAway/java-sdk/commit/06bc3afc80e34e726f835bbe3eca0ec8dc3c4d43))
+
 ## 0.1.0-alpha.31 (2025-07-25)
 
 Full Changelog: [v0.1.0-alpha.30...v0.1.0-alpha.31](https://github.com/OneBusAway/java-sdk/compare/v0.1.0-alpha.30...v0.1.0-alpha.31)

README.md

@@ -2,8 +2,8 @@
 
 <!-- x-release-please-start-version -->
 
-[![Maven Central](https://img.shields.io/maven-central/v/org.onebusaway/onebusaway-sdk-java)](https://central.sonatype.com/artifact/org.onebusaway/onebusaway-sdk-java/0.1.0-alpha.31)
-[![javadoc](https://javadoc.io/badge2/org.onebusaway/onebusaway-sdk-java/0.1.0-alpha.31/javadoc.svg)](https://javadoc.io/doc/org.onebusaway/onebusaway-sdk-java/0.1.0-alpha.31)
+[![Maven Central](https://img.shields.io/maven-central/v/org.onebusaway/onebusaway-sdk-java)](https://central.sonatype.com/artifact/org.onebusaway/onebusaway-sdk-java/0.1.0-alpha.32)
+[![javadoc](https://javadoc.io/badge2/org.onebusaway/onebusaway-sdk-java/0.1.0-alpha.32/javadoc.svg)](https://javadoc.io/doc/org.onebusaway/onebusaway-sdk-java/0.1.0-alpha.32)
 
 <!-- x-release-please-end -->
 
@@ -15,7 +15,7 @@ It is generated with [Stainless](https://www.stainless.com/).
 
 <!-- x-release-please-start-version -->
 
-The REST API documentation can be found on [developer.onebusaway.org](https://developer.onebusaway.org). Javadocs are available on [javadoc.io](https://javadoc.io/doc/org.onebusaway/onebusaway-sdk-java/0.1.0-alpha.31).
+The REST API documentation can be found on [developer.onebusaway.org](https://developer.onebusaway.org). Javadocs are available on [javadoc.io](https://javadoc.io/doc/org.onebusaway/onebusaway-sdk-java/0.1.0-alpha.32).
 
 <!-- x-release-please-end -->
 
@@ -26,7 +26,7 @@ The REST API documentation can be found on [developer.onebusaway.org](https://de
 ### Gradle
 
 ```kotlin
-implementation("org.onebusaway:onebusaway-sdk-java:0.1.0-alpha.31")
+implementation("org.onebusaway:onebusaway-sdk-java:0.1.0-alpha.32")
 ```
 
 ### Maven
@@ -35,7 +35,7 @@ implementation("org.onebusaway:onebusaway-sdk-java:0.1.0-alpha.31")
 <dependency>
   <groupId>org.onebusaway</groupId>
   <artifactId>onebusaway-sdk-java</artifactId>
-  <version>0.1.0-alpha.31</version>
+  <version>0.1.0-alpha.32</version>
 </dependency>
 ```
 
@@ -241,6 +241,12 @@ Or to `debug` for more verbose logging:
 $ export ONEBUSAWAY_SDK_LOG=debug
 ```
 
+## ProGuard and R8
+
+Although the SDK uses reflection, it is still usable with [ProGuard](https://github.com/Guardsquare/proguard) and [R8](https://developer.android.com/topic/performance/app-optimization/enable-app-optimization) because `onebusaway-sdk-java-core` is published with a [configuration file](onebusaway-sdk-java-core/src/main/resources/META-INF/proguard/onebusaway-sdk-java-core.pro) containing [keep rules](https://www.guardsquare.com/manual/configuration/usage).
+
+ProGuard and R8 should automatically detect and use the published rules, but you can also manually copy the keep rules if necessary.
+
 ## Jackson
 
 The SDK depends on [Jackson](https://github.com/FasterXML/jackson) for JSON serialization/deserialization. It is compatible with version 2.13.4 or higher, but depends on version 2.18.2 by default.

build.gradle.kts

@@ -8,7 +8,7 @@ repositories {
 
 allprojects {
     group = "org.onebusaway"
-    version = "0.1.0-alpha.31" // x-release-please-version
+    version = "0.1.0-alpha.32" // x-release-please-version
 }
 
 subprojects {

onebusaway-sdk-java-core/src/main/resources/META-INF/proguard/onebusaway-sdk-java-core.pro

@@ -0,0 +1,32 @@
+# Jackson uses reflection and depends heavily on runtime attributes.
+-keepattributes
+
+# Jackson uses Kotlin reflection utilities, which themselves use reflection to access things.
+-keep class kotlin.reflect.** { *; }
+-keep class kotlin.Metadata { *; }
+
+# Jackson uses reflection to access enum members (e.g. via `java.lang.Class.getEnumConstants()`).
+-keepclassmembers class com.fasterxml.jackson.** extends java.lang.Enum {
+    <fields>;
+    public static **[] values();
+    public static ** valueOf(java.lang.String);
+}
+
+# Jackson uses reflection to access annotation members.
+-keepclassmembers @interface com.fasterxml.jackson.annotation.** {
+    *;
+}
+
+# Jackson uses reflection to access the default constructors of serializers and deserializers.
+-keepclassmembers class * extends org.onebusaway.core.BaseSerializer {
+    <init>();
+}
+-keepclassmembers class * extends org.onebusaway.core.BaseDeserializer {
+    <init>();
+}
+
+# Jackson uses reflection to serialize and deserialize our classes based on their constructors and annotated members.
+-keepclassmembers class org.onebusaway.** {
+    <init>(...);
+    @com.fasterxml.jackson.annotation.* *;
+}

onebusaway-sdk-java-proguard-test/build.gradle.kts

@@ -0,0 +1,74 @@
+plugins {
+    id("onebusaway-sdk.kotlin")
+    id("com.gradleup.shadow") version "8.3.8"
+}
+
+buildscript {
+    dependencies {
+        classpath("com.guardsquare:proguard-gradle:7.4.2")
+    }
+}
+
+dependencies {
+    testImplementation(project(":onebusaway-sdk-java"))
+    testImplementation(kotlin("test"))
+    testImplementation("org.junit.jupiter:junit-jupiter-api:5.9.3")
+    testImplementation("org.assertj:assertj-core:3.25.3")
+    testImplementation("com.fasterxml.jackson.module:jackson-module-kotlin:2.13.4")
+    testImplementation("org.junit.platform:junit-platform-console:1.10.1")
+}
+
+tasks.shadowJar {
+    from(sourceSets.test.get().output)
+    configurations = listOf(project.configurations.testRuntimeClasspath.get())
+}
+
+val proguardJarPath = "${layout.buildDirectory.get()}/libs/${project.name}-${project.version}-proguard.jar"
+val proguardJar by tasks.registering(proguard.gradle.ProGuardTask::class) {
+    group = "verification"
+    dependsOn(tasks.shadowJar)
+    notCompatibleWithConfigurationCache("ProGuard")
+
+    injars(tasks.shadowJar)
+    outjars(proguardJarPath)
+    printmapping("${layout.buildDirectory.get()}/proguard-mapping.txt")
+
+    verbose()
+    dontwarn()
+
+    val javaHome = System.getProperty("java.home")
+    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"
+        )
+    }
+
+    configuration("./test.pro")
+    configuration("../onebusaway-sdk-java-core/src/main/resources/META-INF/proguard/onebusaway-sdk-java-core.pro")
+}
+
+val testProGuard by tasks.registering(JavaExec::class) {
+    group = "verification"
+    dependsOn(proguardJar)
+    notCompatibleWithConfigurationCache("ProGuard")
+
+    mainClass.set("org.junit.platform.console.ConsoleLauncher")
+    classpath = files(proguardJarPath)
+    args = listOf(
+        "--classpath", proguardJarPath,
+        "--scan-classpath",
+        "--details", "verbose",
+    )
+}
+
+tasks.test {
+    dependsOn(testProGuard)
+    // We defer to the tests run via the ProGuard JAR.
+    enabled = false
+}