document collections and lists (spring-attic#2196)

* document collections and lists in Firestore; fixes spring-attic#2189

Author: dmitry-s

docs/src/main/asciidoc/firestore.adoc

@@ -102,7 +102,6 @@ import org.springframework.data.annotation.Id;
 import org.springframework.cloud.gcp.data.firestore.Document;
 
 include::{project-root}/spring-cloud-gcp-data-firestore/src/test/java/org/springframework/cloud/gcp/data/firestore/User.java[tag=class_definition]
-
 ----
 
 `@Document(collectionName = "usersCollection")` annotation configures the collection name for the documents of this type.
@@ -112,6 +111,18 @@ This annotation is optional, by default the collection name is derived from the
 
 NOTE: Internally we use Firestore client library object mapping. See https://developers.google.com/android/reference/com/google/firebase/firestore/package-summary[the documentation] for supported annotations.
 
+==== Embedded entities and lists
+Spring Data Cloud Firestore supports embedded properties of custom types and lists. 
+Given a custom POJO definition, you can have properties of this type or lists of this type in your entities.
+They are stored as embedded documents (or arrays, correspondingly) in the Cloud Firestore.
+
+Example: 
+
+[source,java,indent=0]
+----
+include::{project-root}/spring-cloud-gcp-data-firestore/src/test/java/org/springframework/cloud/gcp/data/firestore/User.java[tag=embedded_class_collections]
+----
+
 === Reactive Repositories
 
 https://docs.spring.io/spring-data/commons/docs/current/api/org/springframework/data/repository/reactive/ReactiveCrudRepository.html[Spring Data Repositories] is an abstraction that can reduce boilerplate code.

spring-cloud-gcp-data-firestore/src/test/java/org/springframework/cloud/gcp/data/firestore/User.java

@@ -25,18 +25,26 @@
  * Sample entity for integration tests.
  *
  * @author Daniel Zou
+ * @author Dmitry Solomakha
  */
 //tag::class_definition[]
+//tag::embedded_class_collections[]
 @Document(collectionName = "usersCollection")
 public class User {
 	@DocumentId
 	private String name;
 
 	private Integer age;
-	//end::class_definition[]
 
+	//end::class_definition[]
 	private List<String> pets;
 
+	private List<Address> addresses;
+
+	private Address homeAddress;
+
+	//end::embedded_class_collections[]
+
 	public User(String name, Integer age) {
 		this.name = name;
 		this.age = age;
@@ -48,6 +56,15 @@ public User(String name, Integer age, List<String> pets) {
 		this.pets = pets;
 	}
 
+	public User(String name, Integer age, List<String> pets, List<Address> addresses, Address homeAddress) {
+		this.name = name;
+		this.age = age;
+		this.pets = pets;
+		this.addresses = addresses;
+		this.homeAddress = homeAddress;
+	}
+
+	//tag::class_definition[]
 	public User() {
 	}
 
@@ -66,7 +83,9 @@ public Integer getAge() {
 	public void setAge(Integer age) {
 		this.age = age;
 	}
+	//end::class_definition[]
 
+	//tag::embedded_class_collections[]
 	public List<String> getPets() {
 		return this.pets;
 	}
@@ -75,11 +94,30 @@ public void setPets(List<String> pets) {
 		this.pets = pets;
 	}
 
+	public List<Address> getAddresses() {
+		return this.addresses;
+	}
+
+	public void setAddresses(List<Address> addresses) {
+		this.addresses = addresses;
+	}
+
+	public Address getHomeAddress() {
+		return this.homeAddress;
+	}
+
+	public void setHomeAddress(Address homeAddress) {
+		this.homeAddress = homeAddress;
+	}
+	//end::embedded_class_collections[]
 	@Override
 	public String toString() {
 		return "User{" +
-				"name='" + this.name + '\'' +
-				", age=" + this.age +
+				"name='" + name + '\'' +
+				", age=" + age +
+				", pets=" + pets +
+				", addresses=" + addresses +
+				", homeAddress=" + homeAddress +
 				'}';
 	}
 
@@ -93,13 +131,59 @@ public boolean equals(Object o) {
 		}
 		User user = (User) o;
 		return Objects.equals(getName(), user.getName()) &&
-				Objects.equals(getAge(), user.getAge());
+				Objects.equals(getAge(), user.getAge()) &&
+				Objects.equals(getPets(), user.getPets()) &&
+				Objects.equals(getAddresses(), user.getAddresses()) &&
+				Objects.equals(getHomeAddress(), user.getHomeAddress());
 	}
 
 	@Override
 	public int hashCode() {
-		return Objects.hash(getName(), getAge());
+		return Objects.hash(getName(), getAge(), getPets(), getAddresses(), getHomeAddress());
+	}
+
+	//tag::embedded_class_collections[]
+
+	public static class Address {
+		String streetAddress;
+		String country;
+
+		public Address() {
+		}
+		//end::embedded_class_collections[]
+		public Address(String streetAddress, String country) {
+			this.streetAddress = streetAddress;
+			this.country = country;
+		}
+
+		public String getStreetAddress() {
+			return this.streetAddress;
+		}
+
+		public String getCountry() {
+			return this.country;
+		}
+
+		@Override
+		public boolean equals(Object o) {
+			if (this == o) {
+				return true;
+			}
+			if (o == null || getClass() != o.getClass()) {
+				return false;
+			}
+			Address address = (Address) o;
+			return Objects.equals(getStreetAddress(), address.getStreetAddress()) &&
+					Objects.equals(getCountry(), address.getCountry());
+		}
+
+		@Override
+		public int hashCode() {
+			return Objects.hash(getStreetAddress(), getCountry());
+		}
+		//tag::embedded_class_collections[]
 	}
 	//tag::class_definition[]
 }
+//end::embedded_class_collections[]
 //end::class_definition[]

spring-cloud-gcp-data-firestore/src/test/java/org/springframework/cloud/gcp/data/firestore/it/FirestoreRepositoryIntegrationTests.java

@@ -94,7 +94,10 @@ public void countTest() {
 	@Test
 	//tag::repository_built_in[]
 	public void writeReadDeleteTest() {
-		User alice = new User("Alice", 29);
+		List<User.Address> addresses = Arrays.asList(new User.Address("123 Alice st", "US"),
+				new User.Address("1 Alice ave", "US"));
+		User.Address homeAddress = new User.Address("10 Alice blvd", "UK");
+		User alice = new User("Alice", 29, null, addresses, homeAddress);
 		User bob = new User("Bob", 60);
 
 		this.userRepository.save(alice).block();
@@ -103,6 +106,10 @@ public void writeReadDeleteTest() {
 		assertThat(this.userRepository.count().block()).isEqualTo(2);
 		assertThat(this.userRepository.findAll().map(User::getName).collectList().block())
 				.containsExactlyInAnyOrder("Alice", "Bob");
+
+		User aliceLoaded = this.userRepository.findById("Alice").block();
+		assertThat(aliceLoaded.getAddresses()).isEqualTo(addresses);
+		assertThat(aliceLoaded.getHomeAddress()).isEqualTo(homeAddress);
 	}
 	//end::repository_built_in[]