Support sort and reverse methods in pg_array_ops extension on PostgreSQL 18+

Author: jeremyevans

CHANGELOG

@@ -1,5 +1,7 @@
 === master
 
+* Support sort and reverse methods in pg_array_ops extension on PostgreSQL 18+ (jeremyevans)
+
 * Support :in_arrays option for Postgres::JSON{,B}#strip_nulls in pg_json_ops extension on PostgreSQL 18+ (jeremyevans)
 
 * Support VIRTUAL generated columns on PostgreSQL 18+ using :virtual option (jeremyevans)

lib/sequel/extensions/pg_array_ops.rb

@@ -56,6 +56,13 @@
 #   ia.join(':', ' ')  # array_to_string(int_array_column, ':', ' ')
 #   ia.unnest          # unnest(int_array_column)
 #   ia.unnest(:b)      # unnest(int_array_column, b)
+#
+# On PostgreSQL 18+, the following are supported:
+#
+#   ia.sort                # array_sort(int_array_column)
+#   ia.sort(desc: true)    # array_sort(int_array_column, true)
+#   ia.sort(nulls: :first) # array_sort(int_array_column, false, true)
+#   ia.reverse             # array_reverse(int_array_column)
 # 
 # See the PostgreSQL array function and operator documentation for more
 # details on what these functions and operators do.
@@ -217,6 +224,40 @@ def replace(element, replacement)
         ArrayOp.new(function(:array_replace, element, replacement))
       end
 
+      # Call the array_reverse method:
+      #
+      #   array_op.reverse # array_reverse(array)
+      def reverse
+        function(:array_reverse)
+      end
+      
+      # Call the array_sort method. Options:
+      #
+      # :desc :: Sort in descending order instead of ascending order.
+      # :nulls :: If sorting in ascending order and value is :first, include NULL
+      #           values before non-NULL values. If sorting in descending order and
+      #           value is :last, include non-NULL values before NULL values.
+      #
+      #   array_op.sort                           # array_sort(array)
+      #   array_op.sort(desc: true)               # array_sort(array, true)
+      #   array_op.sort(nulls: :first)            # array_sort(array, false, true)
+      #   array_op.sort(desc: true, nulls: :last) # array_sort(array, true, false)
+      def sort(opts=OPTS)
+        desc = opts[:desc]
+        nulls = opts[:nulls]
+        if desc
+          if nulls == :last
+            function(:array_sort, true, false)
+          else
+            function(:array_sort, true)
+          end
+        elsif nulls == :first
+          function(:array_sort, false, true)
+        else
+          function(:array_sort)
+        end
+      end
+      
       # Call the array_to_string method:
       #
       #   array_op.join           # array_to_string(array, '')

spec/adapters/postgres_spec.rb

@@ -3789,6 +3789,18 @@ def ==(other)
 
       @ds.from{Sequel.pg_array([1,2,3]).op.unnest([4,5,6], [7,8]).as(:t1, [:a, :b, :c])}.select_order_map([:a, :b, :c]).must_equal [[1, 4, 7], [2, 5, 8], [3, 6, nil]]
     end
+    if @db.server_version >= 180000
+      @ds.get(Sequel.pg_array(:i5).sort).must_equal [1, 5, nil]
+      @ds.get(Sequel.pg_array(:i5).sort(:desc => false)).must_equal [1, 5, nil]
+      @ds.get(Sequel.pg_array(:i5).sort(:desc => true)).must_equal [nil, 5, 1]
+      @ds.get(Sequel.pg_array(:i5).sort(:nulls => :first)).must_equal [nil, 1, 5]
+      @ds.get(Sequel.pg_array(:i5).sort(:nulls => :last)).must_equal [1, 5, nil]
+      @ds.get(Sequel.pg_array(:i5).sort(:desc => false, :nulls => :first)).must_equal [nil, 1, 5]
+      @ds.get(Sequel.pg_array(:i5).sort(:desc => false, :nulls => :last)).must_equal [1, 5, nil]
+      @ds.get(Sequel.pg_array(:i5).sort(:desc => true, :nulls => :first)).must_equal [nil, 5, 1]
+      @ds.get(Sequel.pg_array(:i5).sort(:desc => true, :nulls => :last)).must_equal [5, 1, nil]
+      @ds.get(Sequel.pg_array(:i5).reverse).must_equal [5, nil, 1]
+    end
 
     @ds.get(Sequel.pg_array(:i).push(4)).must_equal [1, 2, 3, 4]
     @ds.get(Sequel.pg_array(:i).unshift(4)).must_equal [4, 1, 2, 3]

spec/extensions/pg_array_ops_spec.rb

@@ -60,6 +60,30 @@
     @db.literal(@a.replace(1, 2)[3]).must_equal "(array_replace(a, 1, 2))[3]"
   end
 
+  it "#reverse should call the array_reverse function" do
+    @db.literal(@a.reverse).must_equal "array_reverse(a)"
+  end
+
+  it "#sort should call the array_sort function" do
+    @db.literal(@a.sort).must_equal "array_sort(a)"
+  end
+
+  it "#sort should respect the :desc option" do
+    @db.literal(@a.sort(desc: true)).must_equal "array_sort(a, true)"
+  end
+
+  it "#sort should respect the nulls: :first option" do
+    @db.literal(@a.sort(nulls: :first)).must_equal "array_sort(a, false, true)"
+  end
+
+  it "#sort should respect the desc: true, nulls: :last options" do
+    @db.literal(@a.sort(desc: true, nulls: :last)).must_equal "array_sort(a, true, false)"
+  end
+
+  it "#sort should call the array_sort function" do
+    @db.literal(@a.sort).must_equal "array_sort(a)"
+  end
+
   it "#unshift should use the || operator in prepend mode" do
     @db.literal(@a.unshift(:b)).must_equal "(b || a)"
   end