From acf12423e0a6dc197a64ecfdb8a46be81c895434 Mon Sep 17 00:00:00 2001
From: Oliver Gierke <ogierke@pivotal.io>
Date: Tue, 26 Jul 2016 14:36:00 +0200
Subject: [PATCH] DATACMNS-888 - Added dedicated Sort type to be able to
 express directions for revisions.

Introduced dedicated RevisionSort property that allows to define the sort order independent of the revision property to be used.

Introduced methods to find out whether a Sort is descending or ascending to avoid having to refer to the enum.
---
 .../org/springframework/data/domain/Sort.java | 34 +++++++-
 .../data/history/RevisionSort.java            | 81 +++++++++++++++++++
 .../history/RevisionRepository.java           |  7 +-
 3 files changed, 118 insertions(+), 4 deletions(-)
 create mode 100644 src/main/java/org/springframework/data/history/RevisionSort.java

diff --git a/src/main/java/org/springframework/data/domain/Sort.java b/src/main/java/org/springframework/data/domain/Sort.java
index 70d8eba88..dcb6cbb45 100644
--- a/src/main/java/org/springframework/data/domain/Sort.java
+++ b/src/main/java/org/springframework/data/domain/Sort.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2008-2014 the original author or authors.
+ * Copyright 2008-2016 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -196,6 +196,26 @@ public class Sort implements Iterable<org.springframework.data.domain.Sort.Order
 
 		ASC, DESC;
 
+		/**
+		 * Returns whether the direction is ascending.
+		 * 
+		 * @return
+		 * @since 1.13
+		 */
+		public boolean isAscending() {
+			return this.equals(ASC);
+		}
+
+		/**
+		 * Returns whether the direction is descending.
+		 * 
+		 * @return
+		 * @since 1.13
+		 */
+		public boolean isDescending() {
+			return this.equals(DESC);
+		}
+
 		/**
 		 * Returns the {@link Direction} enum for the given {@link String} value.
 		 * 
@@ -350,7 +370,17 @@ public class Sort implements Iterable<org.springframework.data.domain.Sort.Order
 		 * @return
 		 */
 		public boolean isAscending() {
-			return this.direction.equals(Direction.ASC);
+			return this.direction.isAscending();
+		}
+
+		/**
+		 * Returns whether sorting for this property shall be descending.
+		 * 
+		 * @return
+		 * @since 1.13
+		 */
+		public boolean isDescending() {
+			return this.direction.isDescending();
 		}
 
 		/**
diff --git a/src/main/java/org/springframework/data/history/RevisionSort.java b/src/main/java/org/springframework/data/history/RevisionSort.java
new file mode 100644
index 000000000..84e773d2c
--- /dev/null
+++ b/src/main/java/org/springframework/data/history/RevisionSort.java
@@ -0,0 +1,81 @@
+/*
+ * Copyright 2016 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.history;
+
+import org.springframework.data.domain.Sort;
+
+/**
+ * A dedicated {@link Sort} implementation that allows the definition of the ordering of revisions independently of the
+ * property name the revision number is held in.
+ * 
+ * @author Oliver Gierke
+ * @since 1.13
+ * @soundtrack Benny Greb's Moving Parts - Soulfood (Live)
+ */
+public class RevisionSort extends Sort {
+
+	private static final long serialVersionUID = 618238321589063537L;
+
+	private static final String PROPERTY = "__revisionNumber__";
+	private static final RevisionSort ASC = new RevisionSort(Direction.ASC);
+	private static final RevisionSort DESC = new RevisionSort(Direction.DESC);
+
+	/**
+	 * Creates a new {@link RevisionSort} using the given direction for sorting by revision number.
+	 * 
+	 * @param direction must not be {@literal null}.
+	 */
+	private RevisionSort(Direction direction) {
+		super(direction, PROPERTY);
+	}
+
+	/**
+	 * Creates a {@link RevisionSort} with ascending order for the revision number property, i.e. more recent revisions
+	 * will come last.
+	 * 
+	 * @return
+	 */
+	public static RevisionSort asc() {
+		return ASC;
+	}
+
+	/**
+	 * Creates a {@link RevisionSort} with descending order for the revision number property, i.e. more recent revisions
+	 * will come first.
+	 * 
+	 * @return
+	 */
+	public static RevisionSort desc() {
+		return DESC;
+	}
+
+	/**
+	 * Returns in which direction to sort revisions for the given {@link Sort} instance. Defaults to
+	 * {@link Direction#ASC}.
+	 * 
+	 * @param sort can be {@literal null}.
+	 * @return
+	 */
+	public static Direction getRevisionDirection(Sort sort) {
+
+		if (sort == null) {
+			return Direction.ASC;
+		}
+
+		Order order = sort.getOrderFor(PROPERTY);
+		return order == null ? Direction.ASC : order.getDirection();
+	}
+}
diff --git a/src/main/java/org/springframework/data/repository/history/RevisionRepository.java b/src/main/java/org/springframework/data/repository/history/RevisionRepository.java
index d8f5b1f58..448b4ebed 100755
--- a/src/main/java/org/springframework/data/repository/history/RevisionRepository.java
+++ b/src/main/java/org/springframework/data/repository/history/RevisionRepository.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2015 the original author or authors.
+ * Copyright 2012-2016 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -20,6 +20,7 @@ import java.io.Serializable;
 import org.springframework.data.domain.Page;
 import org.springframework.data.domain.Pageable;
 import org.springframework.data.history.Revision;
+import org.springframework.data.history.RevisionSort;
 import org.springframework.data.history.Revisions;
 import org.springframework.data.repository.NoRepositoryBean;
 
@@ -49,10 +50,12 @@ public interface RevisionRepository<T, ID extends Serializable, N extends Number
 	Revisions<N, T> findRevisions(ID id);
 
 	/**
-	 * Returns a {@link Page} of revisions for the entity with the given id.
+	 * Returns a {@link Page} of revisions for the entity with the given id. Note, that it's not guaranteed that
+	 * implementations have to support sorting by all properties.
 	 * 
 	 * @param id must not be {@literal null}.
 	 * @param pageable
+	 * @see RevisionSort
 	 * @return
 	 */
 	Page<Revision<N, T>> findRevisions(ID id, Pageable pageable);