Merge pull request quarkusio#53569 from FroMage/panache-next-sort

Panache next sort

Author: gsmet

extensions/panache/hibernate-orm-panache/deployment/src/test/java/io/quarkus/hibernate/orm/panache/deployment/test/JpaOperationsSortTest.java

@@ -75,4 +75,64 @@ public void testSortByDisabledEscaping() {
         Sort sort1 = Sort.by("foo.`bar`").disableEscaping();
         assertEquals(" ORDER BY foo.`bar`", PanacheJpaUtil.toOrderBy(sort1));
     }
+
+    @Test
+    public void testCaseInsensitiveSorting() {
+        Sort sort = Sort.ascendingIgnoreCase("name");
+        assertEquals(" ORDER BY LOWER(`name`)", PanacheJpaUtil.toOrderBy(sort));
+    }
+
+    @Test
+    public void testCaseInsensitiveSortingDescending() {
+        Sort sort = Sort.descendingIgnoreCase("name");
+        assertEquals(" ORDER BY LOWER(`name`) DESC", PanacheJpaUtil.toOrderBy(sort));
+    }
+
+    @Test
+    public void testCaseInsensitiveSortingWithNullPrecedence() {
+        Sort sort = Sort.ascendingIgnoreCase("name").nullsFirst();
+        assertEquals(" ORDER BY LOWER(`name`) NULLS FIRST", PanacheJpaUtil.toOrderBy(sort));
+    }
+
+    @Test
+    public void testMixedCaseSensitiveAndInsensitive() {
+        Sort sort = Sort.by("category").andIgnoreCase("name", Sort.Direction.Descending);
+        assertEquals(" ORDER BY `category` , LOWER(`name`) DESC", PanacheJpaUtil.toOrderBy(sort));
+    }
+
+    @Test
+    public void testCaseInsensitiveEmbeddedColumn() {
+        Sort sort = Sort.ascendingIgnoreCase("author.name");
+        assertEquals(" ORDER BY LOWER(`author`.`name`)", PanacheJpaUtil.toOrderBy(sort));
+    }
+
+    @Test
+    public void testCaseInsensitiveDisabledEscaping() {
+        Sort sort = Sort.ascendingIgnoreCase("name").disableEscaping();
+        assertEquals(" ORDER BY LOWER(name)", PanacheJpaUtil.toOrderBy(sort));
+    }
+
+    @Test
+    public void testIgnoreCaseFluentAPI() {
+        Sort sort = Sort.by("name", "author").ignoreCase();
+        assertEquals(" ORDER BY LOWER(`name`) , LOWER(`author`)", PanacheJpaUtil.toOrderBy(sort));
+    }
+
+    @Test
+    public void testCaseInsensitiveMultipleColumns() {
+        Sort sort = Sort.ascendingIgnoreCase("name", "author");
+        assertEquals(" ORDER BY LOWER(`name`) , LOWER(`author`)", PanacheJpaUtil.toOrderBy(sort));
+    }
+
+    @Test
+    public void testNullsFirstConvenience() {
+        Sort sort = Sort.by("foo").nullsFirst();
+        assertEquals(" ORDER BY `foo` NULLS FIRST", PanacheJpaUtil.toOrderBy(sort));
+    }
+
+    @Test
+    public void testNullsLastConvenience() {
+        Sort sort = Sort.by("foo").nullsLast();
+        assertEquals(" ORDER BY `foo` NULLS LAST", PanacheJpaUtil.toOrderBy(sort));
+    }
 }

extensions/panache/hibernate-panache-next/runtime/pom.xml

@@ -33,11 +33,10 @@
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-panache-common</artifactId>
         </dependency>
-        <!-- For the metamodel generation -->
+        <!-- For the metamodel generation and now also for public API (Order/Sort) -->
         <dependency>
             <groupId>jakarta.data</groupId>
             <artifactId>jakarta.data-api</artifactId>
-            <optional>true</optional>
         </dependency>
         <dependency>
             <groupId>jakarta.json.bind</groupId>

extensions/panache/hibernate-panache-next/runtime/src/main/java/io/quarkus/hibernate/panache/PanacheRepositoryQueries.java

@@ -2,10 +2,9 @@
 
 import java.util.Map;
 
+import jakarta.data.Order;
 import jakarta.persistence.LockModeType;
 
-import io.quarkus.panache.common.Sort;
-
 public interface PanacheRepositoryQueries<EntityResult, EntityList, Query extends PanacheQuery<?, ?, ?, ?>, Count, Confirmation, Id> {
 
     // Queries
@@ -44,15 +43,15 @@ public interface PanacheRepositoryQueries<EntityResult, EntityList, Query extend
      * Find entities using a query and the given sort options, with optional indexed parameters.
      *
      * @param query a {@link io.quarkus.hibernate.panache query string}
-     * @param sort the sort strategy to use
+     * @param order the sort strategy to use
      * @param params optional sequence of indexed parameters
      * @return a new {@link PanacheQuery} instance for the given query
      * @see #find(String, Object...)
-     * @see #find(String, Sort, Map)
-     * @see #list(String, Sort, Object...)
-     * @see #stream(String, Sort, Object...)
+     * @see #find(String, Order, Map)
+     * @see #list(String, Order, Object...)
+     * @see #stream(String, Order, Object...)
      */
-    Query find(String query, Sort sort, Object... params);
+    Query find(String query, Order<?> order, Object... params);
 
     /**
      * Find entities using a query, with named parameters.
@@ -71,15 +70,15 @@ public interface PanacheRepositoryQueries<EntityResult, EntityList, Query extend
      * Find entities using a query and the given sort options, with named parameters.
      *
      * @param query a {@link io.quarkus.hibernate.panache query string}
-     * @param sort the sort strategy to use
+     * @param order the sort strategy to use
      * @param params {@link Map} of indexed parameters
      * @return a new {@link PanacheQuery} instance for the given query
      * @see #find(String, Map)
-     * @see #find(String, Sort, Object...)
-     * @see #list(String, Sort, Map)
-     * @see #stream(String, Sort, Map)
+     * @see #find(String, Order, Object...)
+     * @see #list(String, Order, Map)
+     * @see #stream(String, Order, Map)
      */
-    Query find(String query, Sort sort, Map<String, Object> params);
+    Query find(String query, Order<?> order, Map<String, Object> params);
 
     /**
      * Find all entities of this type.
@@ -94,13 +93,13 @@ public interface PanacheRepositoryQueries<EntityResult, EntityList, Query extend
     /**
      * Find all entities of this type, in the given order.
      *
-     * @param sort the sort order to use
+     * @param order the sort order to use
      * @return a new {@link PanacheQuery} instance to find all entities of this type.
      * @see #findAll()
-     * @see #listAll(Sort)
-     * @see #streamAll(Sort)
+     * @see #listAll(Order)
+     * @see #streamAll(Order)
      */
-    Query findAll(Sort sort);
+    Query findAll(Order<?> order);
 
     /**
      * Find entities matching a query, with optional indexed parameters.
@@ -118,18 +117,18 @@ public interface PanacheRepositoryQueries<EntityResult, EntityList, Query extend
 
     /**
      * Find entities matching a query and the given sort options, with optional indexed parameters.
-     * This method is a shortcut for <code>find(query, sort, params).list()</code>.
+     * This method is a shortcut for <code>find(query, order, params).list()</code>.
      *
      * @param query a {@link io.quarkus.hibernate.panache query string}
-     * @param sort the sort strategy to use
+     * @param order the sort strategy to use
      * @param params optional sequence of indexed parameters
      * @return a {@link List} containing all results, without paging
      * @see #list(String, Object...)
-     * @see #list(String, Sort, Map)
-     * @see #find(String, Sort, Object...)
-     * @see #stream(String, Sort, Object...)
+     * @see #list(String, Order, Map)
+     * @see #find(String, Order, Object...)
+     * @see #stream(String, Order, Object...)
      */
-    EntityList list(String query, Sort sort, Object... params);
+    EntityList list(String query, Order<?> order, Object... params);
 
     /**
      * Find entities matching a query, with named parameters.
@@ -147,18 +146,18 @@ public interface PanacheRepositoryQueries<EntityResult, EntityList, Query extend
 
     /**
      * Find entities matching a query and the given sort options, with named parameters.
-     * This method is a shortcut for <code>find(query, sort, params).list()</code>.
+     * This method is a shortcut for <code>find(query, order, params).list()</code>.
      *
      * @param query a {@link io.quarkus.hibernate.panache query string}
-     * @param sort the sort strategy to use
+     * @param order the sort strategy to use
      * @param params {@link Map} of indexed parameters
      * @return a {@link List} containing all results, without paging
      * @see #list(String, Map)
-     * @see #list(String, Sort, Object...)
-     * @see #find(String, Sort, Map)
-     * @see #stream(String, Sort, Map)
+     * @see #list(String, Order, Object...)
+     * @see #find(String, Order, Map)
+     * @see #stream(String, Order, Map)
      */
-    EntityList list(String query, Sort sort, Map<String, Object> params);
+    EntityList list(String query, Order<?> order, Map<String, Object> params);
 
     /**
      * Find all entities of this type.
@@ -173,15 +172,15 @@ public interface PanacheRepositoryQueries<EntityResult, EntityList, Query extend
 
     /**
      * Find all entities of this type, in the given order.
-     * This method is a shortcut for <code>findAll(sort).list()</code>.
+     * This method is a shortcut for <code>findAll(order).list()</code>.
      *
-     * @param sort the sort order to use
+     * @param order the sort order to use
      * @return a {@link List} containing all results, without paging
      * @see #listAll()
-     * @see #findAll(Sort)
-     * @see #streamAll(Sort)
+     * @see #findAll(Order)
+     * @see #streamAll(Order)
      */
-    EntityList listAll(Sort sort);
+    EntityList listAll(Order<?> order);
 
     /**
      * Counts the number of this type of entity in the database.

extensions/panache/hibernate-panache-next/runtime/src/main/java/io/quarkus/hibernate/panache/blocking/PanacheRepositoryBlockingQueries.java

@@ -5,10 +5,10 @@
 import java.util.Optional;
 import java.util.stream.Stream;
 
+import jakarta.data.Order;
 import jakarta.persistence.LockModeType;
 
 import io.quarkus.hibernate.panache.PanacheRepositoryQueries;
-import io.quarkus.panache.common.Sort;
 
 public interface PanacheRepositoryBlockingQueries<Entity, Id>
         extends PanacheRepositoryQueries<Entity, List<Entity>, PanacheBlockingQuery<Entity>, Long, Boolean, Id> {
@@ -49,20 +49,20 @@ public interface PanacheRepositoryBlockingQueries<Entity, Id>
 
     /**
      * Find entities matching a query and the given sort options, with optional indexed parameters.
-     * This method is a shortcut for <code>find(query, sort, params).stream()</code>.
+     * This method is a shortcut for <code>find(query, order, params).stream()</code>.
      * It requires a transaction to work.
      * Without a transaction, the underlying cursor can be closed before the end of the stream.
      *
      * @param query a {@link io.quarkus.hibernate.panache query string}
-     * @param sort the sort strategy to use
+     * @param order the sort strategy to use
      * @param params optional sequence of indexed parameters
      * @return a {@link Stream} containing all results, without paging
      * @see #stream(String, Object...)
-     * @see #stream(String, Sort, Map)
-     * @see #find(String, Sort, Object...)
-     * @see #list(String, Sort, Object...)
+     * @see #stream(String, Order, Map)
+     * @see #find(String, Order, Object...)
+     * @see #list(String, Order, Object...)
      */
-    Stream<Entity> stream(String query, Sort sort, Object... params);
+    Stream<Entity> stream(String query, Order<?> order, Object... params);
 
     /**
      * Find entities matching a query, with named parameters.
@@ -82,20 +82,20 @@ public interface PanacheRepositoryBlockingQueries<Entity, Id>
 
     /**
      * Find entities matching a query and the given sort options, with named parameters.
-     * This method is a shortcut for <code>find(query, sort, params).stream()</code>.
+     * This method is a shortcut for <code>find(query, order, params).stream()</code>.
      * It requires a transaction to work.
      * Without a transaction, the underlying cursor can be closed before the end of the stream.
      *
      * @param query a {@link io.quarkus.hibernate.panache query string}
-     * @param sort the sort strategy to use
+     * @param order the sort strategy to use
      * @param params {@link Map} of indexed parameters
      * @return a {@link Stream} containing all results, without paging
      * @see #stream(String, Map)
-     * @see #stream(String, Sort, Object...)
-     * @see #find(String, Sort, Map)
-     * @see #list(String, Sort, Map)
+     * @see #stream(String, Order, Object...)
+     * @see #find(String, Order, Map)
+     * @see #list(String, Order, Map)
      */
-    Stream<Entity> stream(String query, Sort sort, Map<String, Object> params);
+    Stream<Entity> stream(String query, Order<?> order, Map<String, Object> params);
 
     /**
      * Find all entities of this type.
@@ -104,11 +104,11 @@ public interface PanacheRepositoryBlockingQueries<Entity, Id>
      * Without a transaction, the underlying cursor can be closed before the end of the stream.
      *
      * @return a {@link Stream} containing all results, without paging
-     * @see #streamAll(Sort)
+     * @see #streamAll(Order)
      * @see #findAll()
      * @see #listAll()
      */
-    Stream<Entity> streamAll(Sort sort);
+    Stream<Entity> streamAll(Order<?> order);
 
     /**
      * Find all entities of this type, in the given order.
@@ -118,8 +118,8 @@ public interface PanacheRepositoryBlockingQueries<Entity, Id>
      *
      * @return a {@link Stream} containing all results, without paging
      * @see #streamAll()
-     * @see #findAll(Sort)
-     * @see #listAll(Sort)
+     * @see #findAll(Order)
+     * @see #listAll(Order)
      */
     Stream<Entity> streamAll();
 }