From 46ff9d25a6f4b49ac683bf49175a2f44f83a372d Mon Sep 17 00:00:00 2001
From: Mark Paluch <mpaluch@vmware.com>
Date: Thu, 11 May 2023 15:59:42 +0200
Subject: [PATCH] Allow reversing `Sort`.

We now allow reversing the sort order of Sort instances to flip ASC and DESC sort orders.

Closes #2805
---
 .../org/springframework/data/domain/Sort.java | 47 +++++++++++++++++--
 .../data/domain/SortUnitTests.java            | 15 ++++++
 2 files changed, 59 insertions(+), 3 deletions(-)

diff --git a/src/main/java/org/springframework/data/domain/Sort.java b/src/main/java/org/springframework/data/domain/Sort.java
index 5c2af3ba7..2520d5630 100644
--- a/src/main/java/org/springframework/data/domain/Sort.java
+++ b/src/main/java/org/springframework/data/domain/Sort.java
@@ -194,7 +194,7 @@ public class Sort implements Streamable<org.springframework.data.domain.Sort.Ord
 
 		Assert.notNull(sort, "Sort must not be null");
 
-		ArrayList<Order> these = new ArrayList<Order>(this.toList());
+		List<Order> these = new ArrayList<Order>(this.toList());
 
 		for (Order order : sort) {
 			these.add(order);
@@ -203,6 +203,31 @@ public class Sort implements Streamable<org.springframework.data.domain.Sort.Ord
 		return Sort.by(these);
 	}
 
+	/**
+	 * Returns a new {@link Sort} with reversed sort {@link Order}s turning effectively asccending into descending sort
+	 * order and vice versa.
+	 *
+	 * @return a new {@link Sort} object with reversed sort orders applied.
+	 * @since 3.1
+	 */
+	public Sort reverse() {
+
+		List<Order> reversed = doReverse();
+
+		return Sort.by(reversed);
+	}
+
+	protected List<Order> doReverse() {
+
+		List<Order> reversed = new ArrayList<>(orders.size());
+
+		for (Order order : this) {
+			reversed.add(order.reverse());
+		}
+
+		return reversed;
+	}
+
 	/**
 	 * Returns the order registered for the given property.
 	 *
@@ -260,7 +285,13 @@ public class Sort implements Streamable<org.springframework.data.domain.Sort.Ord
 	 */
 	private Sort withDirection(Direction direction) {
 
-		return Sort.by(stream().map(it -> it.with(direction)).collect(Collectors.toList()));
+		List<Order> result = new ArrayList<>(orders.size());
+
+		for (Order order : this) {
+			result.add(order.with(direction));
+		}
+
+		return Sort.by(result);
 	}
 
 	/**
@@ -332,7 +363,7 @@ public class Sort implements Streamable<org.springframework.data.domain.Sort.Ord
 	 * @author Thomas Darimont
 	 * @since 1.8
 	 */
-	public static enum NullHandling {
+	public enum NullHandling {
 
 		/**
 		 * Lets the data store decide what to do with nulls.
@@ -503,6 +534,16 @@ public class Sort implements Streamable<org.springframework.data.domain.Sort.Ord
 			return new Order(direction, this.property, this.ignoreCase, this.nullHandling);
 		}
 
+		/**
+		 * Returns a new {@link Order} with the reversed {@link #getDirection()}.
+		 *
+		 * @return
+		 * @since 3.1
+		 */
+		public Order reverse() {
+			return with(this.direction == Direction.ASC ? Direction.DESC : Direction.ASC);
+		}
+
 		/**
 		 * Returns a new {@link Order}
 		 *
diff --git a/src/test/java/org/springframework/data/domain/SortUnitTests.java b/src/test/java/org/springframework/data/domain/SortUnitTests.java
index c0b39cd7b..2f5c9d61e 100755
--- a/src/test/java/org/springframework/data/domain/SortUnitTests.java
+++ b/src/test/java/org/springframework/data/domain/SortUnitTests.java
@@ -201,6 +201,21 @@ class SortUnitTests {
 				.containsExactly(Order.by("center"), Order.by("radius"));
 	}
 
+	@Test // GH-2805
+	void reversesSortCorrectly() {
+		assertThat(Sort.by(Order.asc("center"), Order.desc("radius")).reverse()) //
+				.containsExactly(Order.desc("center"), Order.asc("radius"));
+	}
+
+	@Test // GH-2805
+	void reversesTypedSortCorrectly() {
+
+		Sort reverse = Sort.sort(Circle.class).by(Circle::getCenter).reverse();
+		assertThat(reverse) //
+				.containsExactly(Order.desc("center"));
+
+	}
+
 	@Getter
 	static class Sample {
 		Nested nested;