activerecord-sort 8.0.0 → 10.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50d689663cb6717dab8e034f88d8645cf24a31489e322ca79d9cd52634281dc4
-  data.tar.gz: 544297bd2fc5b8322f8a719d3a4f52e235681a1c756dc191ac74fd69a4c556a7
+  metadata.gz: 55d032ac200c1f9c9bc9a06f988d54744427dcb2afbb2d0f82e89b7f7e6f32de
+  data.tar.gz: 5e10e73498fb36d17d579f9610a79d54ff254b3e36eb5940f9971e5538f15300
 SHA512:
-  metadata.gz: b0caa63a30b528ed30f2fa2ff5c29fe779fd633e9d30ec4404ede2c8b08f9a24a1832b3bd4bd10c39914bebe07cfd8fe23b10ce93496b254d6bb81d2450a3c9e
-  data.tar.gz: afc2f2911285ed3e681a39013013ad1b9ffbce9161a4ac5bb2da6fda40ddd03421942f3b42eaf0c0a3865878fe667759d4c77df0b8962b431937267be40a9d70
+  metadata.gz: 91149455ebd6e9bf3f44b78a4e249c11335ca900923898dc4b90a10113b00276ab44dbe6412f58829f41aa40a04b3d664238e261633c8d3efcfee9087480d78f
+  data.tar.gz: 6e8028be2e9a156bd5a36ff0fc566121b2313aaa4aa48a51b48e41d344f7f59f10837f7c4cdee2fc8a98c763e8962b6fe9a406d560c77f482b26dc4c03651248

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Changelog
 
-## [8.0.0] - 2026-08-27
+## 10.0.0.rc1 (July 15, 2026)
+
+Starting with this release the gem is versioned independently of Rails,
+following [semantic versioning](https://semver.org). Earlier releases
+(6.x) tracked the minimum supported Rails version; the jump to 10 makes
+the break explicit so the version can't be misread as a Rails version.
 
 ### Breaking changes
 
@@ -33,19 +38,13 @@
   `Address.sort(property: :name)`) now defaults to ascending, matching
   every other sort form (previously descending).
 - An unknown sort direction on a relation sort (e.g. `:dsc`) now raises
-  `ActiveRecord::Sort::InvalidSort` (previously sorted ascending
+  `ActiveRecord::StatementInvalid` (previously sorted ascending
   silently), matching column sorts.
+- ActiveRecord 7.1 or newer is required (previously 6.1).
 
 ### Added
 
 - Sorting by `has_and_belongs_to_many` relations.
-- Unrecognized sort columns, associations, and directions raise
-  `ActiveRecord::Sort::InvalidSort`, a subclass of
-  `ActiveRecord::StatementInvalid` — so existing
-  `rescue ActiveRecord::StatementInvalid` handlers still catch bad sort
-  parameters, while callers can rescue the narrower class. Relation sort
-  columns are now validated up front (against the associated model's
-  columns) instead of only failing once the query reaches the database.
 - Sorts of different types compose: they can be combined in one call
   (`Property.sort(:name, tags: :name, addresses: :id)`) or chained
   (`.sort(...).sort(...)`), sharing a single `GROUP BY`.
@@ -67,33 +66,3 @@
   there).
 - Combining a `has_and_belongs_to_many` sort with another relation sort
   raised `PG::GroupingError`.
-
-## [7.0.0] - 2026-08-27
-
-The gem's version is now independent of the Rails version it targets.
-
-### Breaking Changes
-
-- Removed the public `random_sort` method. Use `sort(:random)` instead.
-
-### Changed
-
-- Require `activerecord >= 8.0.0, < 9.0`; support for Rails 7.1 and 7.2 has
-  been dropped.
-- Require `arel-extensions >= 9.0.0`.
-- `#sort` called with no arguments now falls back to Ruby's `Enumerable#sort`
-  (loads the records and sorts them by `<=>`) instead of returning the
-  relation. Pass arguments to use the ordering DSL; `sort(nil)` and `sort([])`
-  still return the relation for chaining.
-
-### Internal
-
-- The `sort`, `sort_for_column`, and `sort_for_relation` methods are now
-  defined in an `ActiveRecord::Sort` module prepended onto
-  `ActiveRecord::QueryMethods`, rather than reopening `QueryMethods` directly.
-  Relations still respond to them, but they no longer appear in
-  `ActiveRecord::QueryMethods.public_instance_methods(false)` — which keeps
-  Rails' internal delegation invariants intact.
-
-[8.0.0]: https://github.com/malomalo/activerecord-sort/releases/tag/v8.0.0
-[7.0.0]: https://github.com/malomalo/activerecord-sort/releases/tag/v7.0.0

data/README.md

@@ -1,19 +1,11 @@
 # ActiveRecord::Sort
 
-`ActiveRecord::Sort` provides an easy, safe way to accept user input and order a
-query by it. Only recognized columns and associations produce SQL — anything
-else raises `ActiveRecord::StatementInvalid`, so it's safe to pass request
-parameters straight through.
-
-Requirements
-------------
-
-- Rails / ActiveRecord >= 8.0
+`ActiveRecord::Sort` provides and easy way to accept user input and order a query by the input.
 
 Installation
 ------------
 
-Add `activerecord-sort` to your Gemfile and run `bundle`:
+Add `sunstone` to your Gemfile and run `bundle`:
 
 ```ruby
 gem 'activerecord-sort', require: 'active_record/sort'
@@ -23,10 +15,8 @@ Or install the gem and require it:
 
 ```sh
 gem install activerecord-sort
-```
-
-```ruby
-require 'active_record/sort'
+irb
+# => require('active_record/sort')
 ```
 
 Examples
@@ -43,10 +33,10 @@ Property.sort(:id, :name).to_sql
 Property.sort(id: :desc).to_sql
 # => "...ORDER BY properties.id DESC"
 
-Property.sort(id: {asc: :nulls_first}).to_sql
+Property.sort(id: {asc: :nulls_first})
 # => "...ORDER BY properties.id ASC NULLS FIRST"
 
-Property.sort(id: {asc: :nulls_last}).to_sql
+Property.sort(id: {asc: :nulls_last})
 # => "...ORDER BY properties.id ASC NULLS LAST"
 ```
 
@@ -54,10 +44,7 @@ It can also sort on relations. A relation sort groups by the sorted table's
 primary key — so each record appears once and records with no associated
 rows are still included — and orders by an aggregate of the requested
 column: `MIN` ascending or `MAX` descending, keying each record by the
-member you'd expect to see first in that direction. A record with no
-associated rows has a `NULL` sort key; where `NULL`s land is
-database-dependent, so pass `nulls_first`/`nulls_last` to place those
-records explicitly:
+member you'd expect to see first in that direction:
 
 ```ruby
 Property.sort(addresses: :id).to_sql
@@ -84,29 +71,3 @@ A relation sort is order-only — it never adds or removes records — so
 aggregates on a sorted relation (`count`, `sum`, `average`, `minimum`,
 `maximum`) are computed over the records themselves, not the sort's
 grouped and joined rows.
-
-Order randomly:
-
-```ruby
-Property.sort(:random).to_sql
-# => "...ORDER BY RANDOM()"
-```
-
-Unrecognized columns raise, so unfiltered params can't inject SQL:
-
-```ruby
-Property.sort(:name_or_something_unexpected)
-# => raises ActiveRecord::Sort::InvalidSort
-```
-
-`ActiveRecord::Sort::InvalidSort` subclasses `ActiveRecord::StatementInvalid`,
-so existing `rescue ActiveRecord::StatementInvalid` handlers keep catching bad
-sort parameters, while callers that want to can rescue the narrower class.
-
-Called with no arguments, `#sort` behaves like Ruby's `Enumerable#sort` —
-it loads the records and sorts them by `<=>` — rather than building a query:
-
-```ruby
-Property.all.sort            # => Array of Property, sorted by <=>
-Property.sort(nil)           # => relation (unchanged), for chaining
-```

data/ext/active_record/base.rb

@@ -2,20 +2,8 @@ require 'active_record'
 require 'active_record/relation'
 
 module ActiveRecord
-  # Prepended onto ActiveRecord::QueryMethods (see lib/active_record/sort.rb).
-  # Living in a separate module keeps these methods out of
-  # QueryMethods.public_instance_methods(false) — which Rails' own
-  # delegation tests assert against — while relations still respond to them.
-  module Sort
-
-    # Raised when a sort references an unrecognized column or association,
-    # or an unknown direction. Subclasses StatementInvalid so existing
-    # `rescue ActiveRecord::StatementInvalid` handlers — the safety
-    # contract that makes it OK to pass request params straight through —
-    # keep working, while callers can rescue this narrower class to tell a
-    # bad sort parameter apart from a genuine database error.
-    class InvalidSort < ActiveRecord::StatementInvalid
-    end
+  module QueryMethods
+  # class << self
 
     # ordering:
     # :id
@@ -25,14 +13,7 @@ module ActiveRecord
     # :listings => :id
     # :listings => {:id => {:asc => :nulls_first}}
     # :random
-    def sort(*ordering, &block)
-      # With no arguments, fall back to Ruby's Enumerable#sort so code (and
-      # Rails' own test suite) that calls `relation.sort` expecting Ruby
-      # semantics keeps working. The ordering DSL only applies when given
-      # arguments; `sort(nil)`/`sort([])` still return the relation for
-      # chaining.
-      return super(&block) if ordering.empty?
-
+    def sort(*ordering)
       resource = all
       ordering.compact!
       ordering.flatten!
@@ -42,19 +23,23 @@ module ActiveRecord
         order = Array(order)
         order.each do |column_or_relation, options|
           if column_or_relation.to_sym == :random
-            resource = resource.order(Arel::Nodes::RandomOrdering.new)
+            resource = resource.random_sort
           elsif self.column_names.include?(column_or_relation.to_s)
             resource = resource.sort_for_column(self.arel_table[column_or_relation.to_s], options)
           elsif reflect_on_association(column_or_relation.to_sym)
             resource = resource.sort_for_relation(column_or_relation.to_sym, options)
           else
-            raise InvalidSort.new("Unknown column #{column_or_relation}")
+            raise ActiveRecord::StatementInvalid.new("Unkown column #{column_or_relation}")
           end
         end
       end
 
       resource
     end
+    
+    def random_sort
+      self.order(Arel::Nodes::RandomOrdering.new)
+    end
 
     # Normalizes per-column sort options into [direction, nulls]. A blank
     # direction — a bare column, or "" as query params often produce —
@@ -78,7 +63,7 @@ module ActiveRecord
       elsif direction == :asc
         self.order(Arel::Nodes::Ascending.new(column, nulls))
       else
-        raise InvalidSort.new("Unknown ordering #{direction}")
+        raise ActiveRecord::StatementInvalid.new("Unkown ordering #{direction}")
       end
     end
 
@@ -91,63 +76,68 @@ module ActiveRecord
     def sort_for_relation(relation, options)
       resource = self
       relation = reflect_on_association(relation)
-      options = [options] if !options.is_a?(Array)
-
-      # LEFT JOIN the association, group by this table's primary key — so
-      # rows don't fan / duplicate and records with an empty collection
-      # still appear — and order by an aggregate of the requested column:
-      #
-      #   SELECT properties.*
-      #   FROM properties
-      #   LEFT JOIN properties_tags ON properties_tags.property_id = properties.id
-      #   LEFT JOIN tags ON tags.id = properties_tags.tag_id
-      #   GROUP BY properties.id
-      #   ORDER BY MIN(tags.name) ASC
-      #
-      # Ascending keys each record by its smallest member (MIN), descending
-      # by its largest (MAX) — the member you'd expect to see first in that
-      # direction. Toggling asc/desc therefore re-keys multi-value records
-      # rather than strictly reversing the list.
-      options.each do |order|
-        Array(order).each do |column_name, column_options|
-          if !relation.klass.column_names.include?(column_name.to_s)
-            raise InvalidSort.new("Unknown column #{column_name}")
-          end
 
-          # A collection (has_many / has_and_belongs_to_many) wraps the
-          # attribute in an Arel::Attributes::Relation so the aggregate
-          # references the joined table correctly; a singular association
-          # (belongs_to / has_one) uses the plain attribute.
-          column = if relation.collection?
-            Arel::Attributes::Relation.new(relation.klass.arel_table[column_name], relation.name)
-          else
-            relation.klass.arel_table[column_name]
+      if relation.macro == :has_many || relation.macro == :has_and_belongs_to_many
+        options = [options] if !options.is_a?(Array)
+
+        options.each do |order|
+          Array(order).each do |column_name, options|
+            # LEFT JOIN the collection, group by this table's primary key —
+            # so rows don't fan / duplicate and records with an empty
+            # collection still appear — and order by an aggregate of the
+            # requested column:
+            #
+            #   SELECT properties.*
+            #   FROM properties
+            #   LEFT JOIN properties_tags ON properties_tags.property_id = properties.id
+            #   LEFT JOIN tags ON tags.id = properties_tags.tag_id
+            #   GROUP BY properties.id
+            #   ORDER BY MIN(tags.name) ASC
+            #
+            # Ascending keys each record by its smallest member (MIN),
+            # descending by its largest (MAX) — the member you'd expect to
+            # see first in that direction. Toggling asc/desc therefore
+            # re-keys multi-value records rather than strictly reversing
+            # the list.
+            column = Arel::Attributes::Relation.new(relation.klass.arel_table[column_name], relation.name)
+            direction, nulls = sort_direction_and_nulls(options)
+
+            order = if direction == :desc
+              Arel::Nodes::Descending.new(column.maximum, nulls)
+            elsif direction == :asc
+              Arel::Nodes::Ascending.new(column.minimum, nulls)
+            else
+              raise ActiveRecord::StatementInvalid.new("Unkown ordering #{direction}")
+            end
+
+            resource = resource.left_outer_joins(relation.name)
+            resource = resource.order(order)
           end
-
-          direction, nulls = sort_direction_and_nulls(column_options)
-
-          order = if direction == :desc
-            Arel::Nodes::Descending.new(column.maximum, nulls)
-          elsif direction == :asc
-            Arel::Nodes::Ascending.new(column.minimum, nulls)
-          else
-            raise InvalidSort.new("Unknown ordering #{direction}")
+        end
+      elsif relation.macro == :belongs_to || relation.macro == :has_one
+        options = [options] if !options.is_a?(Array)
+
+        options.each do |order|
+          order = Array(order)
+          order.each do |column, options|
+            column = relation.klass.arel_table[column]
+            direction, nulls = sort_direction_and_nulls(options)
+
+            if direction == :desc
+              order = Arel::Nodes::Descending.new(column.maximum, nulls)
+            elsif direction == :asc
+              order = Arel::Nodes::Ascending.new(column.minimum, nulls)
+            else
+              raise ActiveRecord::StatementInvalid.new("Unkown ordering #{direction}")
+            end
+
+            resource = resource.left_outer_joins(relation.name)
+            resource = resource.order(order)
           end
-
-          resource = resource.left_outer_joins(relation.name)
-          resource = resource.order(order)
         end
       end
 
-      # Group by the primary key so the aggregate collapses the joined,
-      # fanned-out rows to one per record. Every relation sort adds this,
-      # so only add it once: ActiveRecord < 8.1's group! appends rather
-      # than unioning, which would leave a duplicate [pk, pk] that trips
-      # the count override's group_values check below.
-      # TODO: once Rails <= 8.0 is no longer supported, group! unions on
-      # its own — drop the include? guard and just group(primary_key).
-      primary_key = klass.arel_table[klass.primary_key]
-      resource = resource.group(primary_key) unless resource.group_values.include?(primary_key)
+      resource = resource.group(klass.arel_table[klass.primary_key])
       # Tag the relation for the count override below. Chained relations
       # are built with clone, which copies instance variables, so the tag
       # survives further chaining.

data/lib/active_record/sort/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module Sort
-    VERSION = '8.0.0'
+    VERSION = '10.0.0.rc1'
   end
 end

data/lib/active_record/sort.rb

@@ -3,5 +3,4 @@ require 'arel/extensions'
 
 require File.expand_path(File.join(__FILE__, '../../../ext/active_record/base'))
 
-ActiveRecord::QueryMethods.prepend(ActiveRecord::Sort)
 ActiveRecord::Querying.delegate :sort, to: :all

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-sort
 version: !ruby/object:Gem::Version
-  version: 8.0.0
+  version: 10.0.0.rc1
 platform: ruby
 authors:
 - Jon Bracy
@@ -15,34 +15,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 8.0.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '9.0'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 8.0.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '9.0'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: arel-extensions
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 9.0.0
+        version: 6.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 9.0.0
+        version: 6.1.0
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -57,6 +51,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -133,14 +141,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.0
+        version: 6.1.0.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.0
+        version: 6.1.0.2
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -169,14 +177,14 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 'Adds a #sort query method to ActiveRecord that turns whitelisted user-supplied
-  parameters into ORDER BY clauses -- ordering by columns or associations, ascending/descending,
-  with NULLS handling and random ordering -- without exposing you to SQL injection.'
+description: A safe way to accept user parameters and order against your ActiveRecord
+  Models
 email:
 - jonbracy@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
 - CHANGELOG.md
 - LICENSE
@@ -187,11 +195,10 @@ files:
 homepage: https://github.com/malomalo/activerecord-sort
 licenses:
 - MIT
-metadata:
-  source_code_uri: https://github.com/malomalo/activerecord-sort
-  changelog_uri: https://github.com/malomalo/activerecord-sort/blob/master/CHANGELOG.md
-  rubygems_mfa_required: 'true'
-rdoc_options: []
+metadata: {}
+rdoc_options:
+- "--main"
+- README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -205,7 +212,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.11
+rubygems_version: 4.0.2
 specification_version: 4
 summary: A safe way to accept user parameters and order against your ActiveRecord
   Models