Merge pull request #1227 from ably/release/1.8.0

Release/1.8.0

Author: sacOO7

CHANGELOG.md

@@ -1,5 +1,29 @@
 # Change Log
 
+## [1.8.0](https://github.com/ably/ably-java/tree/v1.8.0)
+
+[Full Changelog](https://github.com/ably/ably-java/compare/v1.7.2...v1.8.0)
+
+### What's Changed
+
+- Introduce the new path-based LiveObjects API [#1214](https://github.com/ably/ably-java/pull/1214). LiveObjects data is now accessed through `channel.object`, which returns a `RealtimeObject` exposing `PathObject`s — stable references to locations within the channel object that resolve to values dynamically at runtime, instead of explicit `LiveMap`/`LiveCounter` instances. See the [PathObject documentation](https://ably.com/docs/liveobjects/concepts/path-object) for details. This feature was delivered through the following PRs:
+  - Implement the path-based LiveObjects public API interfaces [#1213](https://github.com/ably/ably-java/pull/1213)
+  - Add the path-based `RealtimeObject` and the `channel.object` accessor [#1216](https://github.com/ably/ably-java/pull/1216)
+  - Add basic implementation for the `PathObject` and `Instance` interfaces [#1217](https://github.com/ably/ably-java/pull/1217)
+  - Rename the `object` package to `liveobjects` (`io.ably.lib.liveobjects`) [#1220](https://github.com/ably/ably-java/pull/1220)
+  - Update the LiveObjects `uts-to-kotlin` skill to generate tests for the new API [#1221](https://github.com/ably/ably-java/pull/1221)
+  - Implement core `LiveObjects` functionality on the new path-based API (Kotlin) [#1223](https://github.com/ably/ably-java/pull/1223)
+  - Implement the remaining path-based API — parent references, event bubbling and related behaviour [#1224](https://github.com/ably/ably-java/pull/1224)
+  - Migrate the LiveObjects example app to the path-based API [#1225](https://github.com/ably/ably-java/pull/1225)
+
+### Breaking changes
+
+This release replaces the previous experimental instance-based LiveObjects API with the new path-based API:
+
+- The `channel.getObjects()` accessor (returning `RealtimeObjects`) has been replaced by the `channel.object` field (returning `RealtimeObject`)
+- The `io.ably.lib.objects` package has been renamed to `io.ably.lib.liveobjects`
+- Instead of obtaining and operating on explicit `LiveMap`/`LiveCounter` instances, data is accessed and mutated through `PathObject` references
+
 ## [1.7.2](https://github.com/ably/ably-java/tree/v1.7.2)
 
 [Full Changelog](https://github.com/ably/ably-java/compare/v1.7.1...v1.7.2)

CONTRIBUTING.md

@@ -235,7 +235,7 @@ You may wish to make changes to Ably Java or Ably Android, and test it immediate
 - Open the directory printed from the output of that command. Inside that folder, get the `ably-android-x.y.z.aar`, and place it your Android project's `libs/` directory. Create this directory if it doesn't exist.
 - Add an `implementation` dependency on the `.aar`:
 ```groovy
-implementation files('libs/ably-android-1.7.2.aar')
+implementation files('libs/ably-android-1.8.0.aar')
 ```
 - Add the `implementation` (not `testImplementation`) dependencies found in `dependencies.gradle` to your project. This is because the `.aar` does not contain dependencies.
 - Build/run your application.

README.md

@@ -51,14 +51,14 @@ The Java SDK is available as a [Maven dependency](https://mvnrepository.com/arti
 <dependency>
     <groupId>io.ably</groupId>
     <artifactId>ably-java</artifactId>
-    <version>1.7.2</version>
+    <version>1.8.0</version>
 </dependency>
 ```
 
 ### Install for Gradle:
 
 ```gradle
-implementation 'io.ably:ably-java:1.7.2'
+implementation 'io.ably:ably-java:1.8.0'
 implementation 'org.slf4j:slf4j-simple:2.0.7'
 ```
 
@@ -113,7 +113,7 @@ Add the following dependency to your `build.gradle` file:
 
 ```groovy
 dependencies {
-    runtimeOnly("io.ably:liveobjects:1.7.2")
+    runtimeOnly("io.ably:liveobjects:1.8.0")
 }
 ```
 

gradle.properties

@@ -1,5 +1,5 @@
 GROUP=io.ably
-VERSION_NAME=1.7.2
+VERSION_NAME=1.8.0
 POM_INCEPTION_YEAR=2015
 POM_URL=https://github.com/ably/ably-java
 POM_SCM_URL=https://github.com/ably/ably-java/

lib/src/test/java/io/ably/lib/test/realtime/RealtimeHttpHeaderTest.java

@@ -88,7 +88,7 @@ public void realtime_websocket_param_test() {
              * Defaults.ABLY_AGENT_PARAM, as ultimately the request param has been derived from those values.
              */
             assertEquals("Verify correct lib version", requestParameters.get("agent"),
-                    Collections.singletonList("ably-java/1.7.2 jre/" + System.getProperty("java.version")));
+                    Collections.singletonList("ably-java/1.8.0 jre/" + System.getProperty("java.version")));
 
             /* Spec RTN2a */
             assertEquals("Verify correct format", requestParameters.get("format"),