paging

thombergs · thombergs · commit b3532e2f1e68 · 2019-03-28T06:09:03.000+01:00
diff --git a/spring-boot/conditionals/build.gradle b/spring-boot/conditionals/build.gradle
@@ -18,7 +18,7 @@ dependencies {
 	implementation 'org.apache.commons:commons-lang3:3.8.1'
 	testImplementation('org.junit.jupiter:junit-jupiter:5.4.0')
 	testImplementation('org.springframework.boot:spring-boot-starter-test'){
-		exclude group: 'org.junit', module: 'junit'
+		exclude group: 'junit', module: 'junit'
 	}
 }
 
diff --git a/spring-boot/configuration/build.gradle b/spring-boot/configuration/build.gradle
@@ -22,7 +22,7 @@ dependencies {
 	annotationProcessor 'org.springframework.boot:spring-boot-configuration-processor'
 	testImplementation('org.junit.jupiter:junit-jupiter:5.4.0')
 	testImplementation('org.springframework.boot:spring-boot-starter-test'){
-		exclude group: 'org.junit', module: 'junit'
+		exclude group: 'junit', module: 'junit'
 	}
 }
 
diff --git a/spring-boot/pagination/build.gradle b/spring-boot/pagination/build.gradle
@@ -21,7 +21,7 @@ dependencies {
 	runtimeOnly 'com.h2database:h2'
 	testImplementation('org.junit.jupiter:junit-jupiter:5.4.0')
 	testImplementation('org.springframework.boot:spring-boot-starter-test'){
-		exclude group: 'org.junit', module: 'junit'
+		exclude group: 'junit', module: 'junit'
 	}
 }
 
diff --git a/spring-boot/pagination/gradle/wrapper/gradle-wrapper.jar b/spring-boot/pagination/gradle/wrapper/gradle-wrapper.jar
diff --git a/spring-boot/pagination/gradle/wrapper/gradle-wrapper.properties b/spring-boot/pagination/gradle/wrapper/gradle-wrapper.properties
@@ -0,0 +1,5 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-5.2.1-bin.zip
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists
diff --git a/spring-boot/pagination/src/main/java/io/reflectoring/pagination/CharacterRepository.java b/spring-boot/pagination/src/main/java/io/reflectoring/pagination/CharacterRepository.java
diff --git a/spring-boot/pagination/src/main/java/io/reflectoring/pagination/MovieCharacter.java b/spring-boot/pagination/src/main/java/io/reflectoring/pagination/MovieCharacter.java
@@ -8,7 +8,7 @@
 
 @Entity
 @Data
-class Character {
+class MovieCharacter {
 
   @Id
   @GeneratedValue
diff --git a/spring-boot/pagination/src/main/java/io/reflectoring/pagination/MovieCharacterRepository.java b/spring-boot/pagination/src/main/java/io/reflectoring/pagination/MovieCharacterRepository.java
@@ -0,0 +1,19 @@
+package io.reflectoring.pagination;
+
+import java.util.List;
+
+import org.springframework.data.domain.Page;
+import org.springframework.data.domain.Pageable;
+import org.springframework.data.domain.Slice;
+import org.springframework.data.domain.Sort;
+import org.springframework.data.repository.CrudRepository;
+
+interface MovieCharacterRepository extends CrudRepository<MovieCharacter, Long> {
+
+	Page<MovieCharacter> findAllPage(Pageable pageable);
+
+	Slice<MovieCharacter> findAllSlice(Pageable pageable);
+
+	List<MovieCharacter> findAllSorted(Sort sort);
+
+}
diff --git a/spring-boot/pagination/src/main/java/io/reflectoring/pagination/PaginatedController.java b/spring-boot/pagination/src/main/java/io/reflectoring/pagination/PaginatedController.java
@@ -1,20 +1,33 @@
 package io.reflectoring.pagination;
 
+import java.util.List;
+
 import lombok.RequiredArgsConstructor;
+import org.springframework.data.domain.Page;
 import org.springframework.data.domain.Pageable;
+import org.springframework.data.domain.Slice;
+import org.springframework.data.domain.Sort;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RestController;
 
-import java.util.List;
-
 @RestController
 @RequiredArgsConstructor
 class PaginatedController {
 
-  private final CharacterRepository characterRepository;
+  private final MovieCharacterRepository characterRepository;
+
+  @GetMapping(path = "/characters/page")
+  Page<MovieCharacter> loadCharactersPage(Pageable pageable) {
+    return characterRepository.findAllPage(pageable);
+  }
+
+  @GetMapping(path = "/characters/sorted")
+  List<MovieCharacter> loadCharactersSorted(Sort sort) {
+    return characterRepository.findAllSorted(sort);
+  }
 
-  @GetMapping(path = "/characters")
-  List<Character> loadCharacters(Pageable pageable) {
-    return characterRepository.findAll(pageable);
+  @GetMapping(path = "/characters/slice")
+  Slice<MovieCharacter> loadCharactersSlice(Pageable pageable) {
+    return characterRepository.findAllSlice(pageable);
   }
 }
diff --git a/spring-boot/pagination/src/main/java/io/reflectoring/pagination/PaginationConfiguration.java b/spring-boot/pagination/src/main/java/io/reflectoring/pagination/PaginationConfiguration.java
@@ -0,0 +1,9 @@
+package io.reflectoring.pagination;
+
+import org.springframework.context.annotation.Configuration;
+import org.springframework.data.web.config.EnableSpringDataWebSupport;
+
+@Configuration
+@EnableSpringDataWebSupport
+class PaginationConfiguration {
+}
diff --git a/spring-boot/pagination/src/main/resources/application.properties b/spring-boot/pagination/src/main/resources/application.properties
@@ -1 +1,7 @@
-
+spring.data.web.pageable.size-parameter=size
+spring.data.web.pageable.page-parameter=page
+spring.data.web.pageable.default-page-size=10
+spring.data.web.pageable.one-indexed-parameters=false
+spring.data.web.pageable.max-page-size=10000
+spring.data.web.pageable.prefix=
+spring.data.web.pageable.qualifier-delimiter=_
diff --git a/spring-boot/pagination/src/main/resources/data.sql b/spring-boot/pagination/src/main/resources/data.sql
@@ -0,0 +1,17 @@
+insert into character (id, name, movie) values (1, 'Groot', 'Guardians of the Galaxy');
+insert into character (id, name, movie) values (2, 'Gamora', 'Guardians of the Galaxy');
+insert into character (id, name, movie) values (3, 'Star-Lord', 'Guardians of the Galaxy');
+insert into character (id, name, movie) values (4, 'Rocket', 'Guardians of the Galaxy');
+insert into character (id, name, movie) values (5, 'Zaphod Beeblebrox', 'Hitchhiker''s Guide to the Galaxy');
+insert into character (id, name, movie) values (6, 'Slartibartfast', 'Hitchhiker''s Guide to the Galaxy');
+insert into character (id, name, movie) values (7, 'Arthur Dent', 'Hitchhiker''s Guide to the Galaxy');
+insert into character (id, name, movie) values (8, 'Ford Prefect', 'Hitchhiker''s Guide to the Galaxy');
+insert into character (id, name, movie) values (9, 'Marvin the Paranoid Android', 'Hitchhiker''s Guide to the Galaxy');
+insert into character (id, name, movie) values (10, 'Darth Vader', 'Star Wars');
+insert into character (id, name, movie) values (11, 'Count Dooku', 'Star Wars');
+insert into character (id, name, movie) values (12, 'The Imperator', 'Star Wars');
+insert into character (id, name, movie) values (13, 'Luke Skywalker', 'Star Wars');
+insert into character (id, name, movie) values (14, 'Han Solo', 'Star Wars');
+insert into character (id, name, movie) values (15, 'Princess Leia', 'Star Wars');
+insert into character (id, name, movie) values (16, 'Anakin Skywalker', 'Star Wars');
+insert into character (id, name, movie) values (17, 'Obi Wan Kenobi', 'Star Wars');
diff --git a/spring-boot/pagination/src/test/java/io/reflectoring/pagination/MovieCharacterRepositoryTest.java b/spring-boot/pagination/src/test/java/io/reflectoring/pagination/MovieCharacterRepositoryTest.java
@@ -0,0 +1,39 @@
+package io.reflectoring.pagination;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest;
+import org.springframework.data.domain.PageRequest;
+import static org.assertj.core.api.Assertions.*;
+
+@DataJpaTest
+class MovieCharacterRepositoryTest {
+
+	@Autowired
+	private MovieCharacterRepository characterRepository;
+
+	@Test
+	void returnsPage() {
+		// database is initialized with script "data.sql"
+		assertThat(
+				characterRepository
+						.findAllPage(PageRequest.of(0, 10))
+						.getContent()
+						.size())
+				.isEqualTo(10);
+
+	}
+
+	@Test
+	void returnsSlice() {
+		// database is initialized with script "data.sql"
+		assertThat(
+				characterRepository
+						.findAllSlice(PageRequest.of(0, 10))
+						.getContent()
+						.size())
+				.isEqualTo(10);
+
+	}
+
+}
diff --git a/spring-boot/pagination/src/test/java/io/reflectoring/pagination/PageableAssert.java b/spring-boot/pagination/src/test/java/io/reflectoring/pagination/PageableAssert.java
@@ -0,0 +1,45 @@
+package io.reflectoring.pagination;
+
+import java.util.Objects;
+
+import org.assertj.core.api.AbstractAssert;
+import org.springframework.data.domain.Pageable;
+import org.springframework.data.domain.Sort;
+
+class PageableAssert extends AbstractAssert<PageableAssert, Pageable> {
+
+	PageableAssert(Pageable pageable) {
+		super(pageable, PageableAssert.class);
+	}
+
+	static PageableAssert assertThat(Pageable actual) {
+		return new PageableAssert(actual);
+	}
+
+	PageableAssert hasPageSize(int expectedPageSize) {
+		if (!Objects.equals(actual.getPageSize(), expectedPageSize)) {
+			failWithMessage("expected page size to be <%s> but was <%s>", expectedPageSize, actual.getPageSize());
+		}
+		return this;
+	}
+
+	PageableAssert hasPageNumber(int expectedPageNumber) {
+		if (!Objects.equals(actual.getPageNumber(), expectedPageNumber)) {
+			failWithMessage("expected page number to be <%s> but was <%s>", expectedPageNumber, actual.getPageNumber());
+		}
+		return this;
+	}
+
+	PageableAssert hasSort(String field, Sort.Direction direction) {
+
+		Sort.Order actualOrder = actual.getSort().getOrderFor(field);
+
+		if (actualOrder == null) {
+			failWithMessage("expected sort for field <%s> to be <%s> but was null", field, direction);
+		} else if (actualOrder.getDirection() != direction) {
+			failWithMessage("expected sort for field <%s> to be <%s> but was <%s>", field, direction, actualOrder.getDirection());
+		}
+
+		return this;
+	}
+}
diff --git a/spring-boot/pagination/src/test/java/io/reflectoring/pagination/PaginatedControllerTest.java b/spring-boot/pagination/src/test/java/io/reflectoring/pagination/PaginatedControllerTest.java
@@ -10,38 +10,82 @@
 import org.springframework.data.domain.Sort;
 import org.springframework.test.web.servlet.MockMvc;
 
-import static org.assertj.core.api.AssertionsForInterfaceTypes.*;
+import static io.reflectoring.pagination.PageableAssert.*;
+import static io.reflectoring.pagination.SortAssert.*;
 import static org.mockito.Mockito.*;
 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;
 import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;
 
-@WebMvcTest(controllers = PaginatedController.class)
+@WebMvcTest(
+		controllers = PaginatedController.class
+		// If we exclude SpringDataWebAutoConfiguration, the Pageable parameter will not be resolved.
+		// If we only exclude it on the Application class itself, the test will still work!!!
+		// excludeAutoConfiguration = SpringDataWebAutoConfiguration.class
+)
 class PaginatedControllerTest {
 
-  @MockBean
-  private CharacterRepository characterRepository;
+	@MockBean
+	private MovieCharacterRepository characterRepository;
 
-  @Autowired
-  private MockMvc mockMvc;
+	@Autowired
+	private MockMvc mockMvc;
 
-  @Test
-  void paginationParametersAreEvaluated() throws Exception {
+	@Test
+	void evaluatesPageableParameter() throws Exception {
 
-    mockMvc.perform(get("/characters")
-            .param("page", "5")
-            .param("size", "10")
-            .param("sort", "id,desc") // <-- no space after comma!!!
-            .param("sort", "name,asc")) // <-- no space after comma!!!
-            .andExpect(status().isOk());
+		mockMvc.perform(get("/characters/page")
+				.param("page", "5")
+				.param("size", "10")
+				.param("sort", "id, desc") // <-- no space after comma!!!
+				.param("sort", "name,asc")) // <-- no space after comma!!!
+				.andExpect(status().isOk());
 
-    ArgumentCaptor<Pageable> pageableCaptor = ArgumentCaptor.forClass(Pageable.class);
-    verify(characterRepository).findAll(pageableCaptor.capture());
-    PageRequest pageable = (PageRequest) pageableCaptor.getValue();
-    assertThat(pageable.getPageNumber()).isEqualTo(5);
-    assertThat(pageable.getPageSize()).isEqualTo(10);
-    assertThat(pageable.getSort().getOrderFor("name").getDirection()).isEqualTo(Sort.Direction.ASC);
-    assertThat(pageable.getSort().getOrderFor("id").getDirection()).isEqualTo(Sort.Direction.DESC);
+		ArgumentCaptor<Pageable> pageableCaptor = ArgumentCaptor.forClass(Pageable.class);
+		verify(characterRepository).findAllPage(pageableCaptor.capture());
+		PageRequest pageable = (PageRequest) pageableCaptor.getValue();
 
-  }
+		assertThat(pageable).hasPageNumber(5);
+		assertThat(pageable).hasPageSize(10);
+		assertThat(pageable).hasSort("name", Sort.Direction.ASC);
+		assertThat(pageable).hasSort("id", Sort.Direction.DESC);
+	}
+
+	@Test
+	void returnsSlice() throws Exception {
+
+		mockMvc.perform(get("/characters/slice")
+				.param("page", "5")
+				.param("size", "10")
+				.param("sort", "id,desc") // <-- no space after comma!!!
+				.param("sort", "name,asc")) // <-- no space after comma!!!
+				.andExpect(status().isOk());
+
+		ArgumentCaptor<Pageable> pageableCaptor = ArgumentCaptor.forClass(Pageable.class);
+		verify(characterRepository).findAllSlice(pageableCaptor.capture());
+		PageRequest pageable = (PageRequest) pageableCaptor.getValue();
+
+		assertThat(pageable).hasPageNumber(5);
+		assertThat(pageable).hasPageSize(10);
+		assertThat(pageable).hasSort("name", Sort.Direction.ASC);
+		assertThat(pageable).hasSort("id", Sort.Direction.DESC);
+
+	}
+
+	@Test
+	void evaluatesSortParameter() throws Exception {
+
+		mockMvc.perform(get("/characters/sorted")
+				.param("sort", "id,desc") // <-- no space after comma!!!
+				.param("sort", "name,asc")) // <-- no space after comma!!!
+				.andExpect(status().isOk());
+
+		ArgumentCaptor<Sort> sortCaptor = ArgumentCaptor.forClass(Sort.class);
+		verify(characterRepository).findAllSorted(sortCaptor.capture());
+		Sort sort = sortCaptor.getValue();
+
+		assertThat(sort).hasSort("name", Sort.Direction.ASC);
+		assertThat(sort).hasSort("id", Sort.Direction.DESC);
+
+	}
 
 }
diff --git a/spring-boot/pagination/src/test/java/io/reflectoring/pagination/PaginationApplicationTests.java b/spring-boot/pagination/src/test/java/io/reflectoring/pagination/PaginationApplicationTests.java
@@ -1,16 +1,13 @@
 package io.reflectoring.pagination;
 
-import org.junit.Test;
-import org.junit.runner.RunWith;
+import org.junit.jupiter.api.Test;
 import org.springframework.boot.test.context.SpringBootTest;
-import org.springframework.test.context.junit4.SpringRunner;
 
-@RunWith(SpringRunner.class)
 @SpringBootTest
-public class PaginationApplicationTests {
+class PaginationApplicationTests {
 
 	@Test
-	public void contextLoads() {
+	void contextLoads() {
 	}
 
 }
diff --git a/spring-boot/pagination/src/test/java/io/reflectoring/pagination/SortAssert.java b/spring-boot/pagination/src/test/java/io/reflectoring/pagination/SortAssert.java
@@ -0,0 +1,28 @@
+package io.reflectoring.pagination;
+
+import org.assertj.core.api.AbstractAssert;
+import org.springframework.data.domain.Sort;
+
+class SortAssert extends AbstractAssert<SortAssert, Sort> {
+
+	SortAssert(Sort sort) {
+		super(sort, SortAssert.class);
+	}
+
+	static SortAssert assertThat(Sort actual) {
+		return new SortAssert(actual);
+	}
+
+	SortAssert hasSort(String field, Sort.Direction direction) {
+
+		Sort.Order actualOrder = actual.getOrderFor(field);
+
+		if (actualOrder == null) {
+			failWithMessage("expected sort for field <%s> to be <%s> but was null", field, direction);
+		} else if (actualOrder.getDirection() != direction) {
+			failWithMessage("expected sort for field <%s> to be <%s> but was <%s>", field, direction, actualOrder.getDirection());
+		}
+
+		return this;
+	}
+}

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ dependencies {`
`18`	`18`	`implementation 'org.apache.commons:commons-lang3:3.8.1'`
`19`	`19`	`testImplementation('org.junit.jupiter:junit-jupiter:5.4.0')`
`20`	`20`	`testImplementation('org.springframework.boot:spring-boot-starter-test'){`
`21`		`- exclude group: 'org.junit', module: 'junit'`
	`21`	`+ exclude group: 'junit', module: 'junit'`
`22`	`22`	`}`
`23`	`23`	`}`
`24`	`24`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ dependencies {`
`22`	`22`	`annotationProcessor 'org.springframework.boot:spring-boot-configuration-processor'`
`23`	`23`	`testImplementation('org.junit.jupiter:junit-jupiter:5.4.0')`
`24`	`24`	`testImplementation('org.springframework.boot:spring-boot-starter-test'){`
`25`		`- exclude group: 'org.junit', module: 'junit'`
	`25`	`+ exclude group: 'junit', module: 'junit'`
`26`	`26`	`}`
`27`	`27`	`}`
`28`	`28`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ dependencies {`
`21`	`21`	`runtimeOnly 'com.h2database:h2'`
`22`	`22`	`testImplementation('org.junit.jupiter:junit-jupiter:5.4.0')`
`23`	`23`	`testImplementation('org.springframework.boot:spring-boot-starter-test'){`
`24`		`- exclude group: 'org.junit', module: 'junit'`
	`24`	`+ exclude group: 'junit', module: 'junit'`
`25`	`25`	`}`
`26`	`26`	`}`
`27`	`27`