arel-extensions 8.0.2 → 9.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f10fd80539653570d9ea7333fa9f9aef21e29ccdb9f9a976fa178e106c1f3c66
-  data.tar.gz: 02efc9b543b5325e61899a590982207378482592f13a91ccb121d94a621a1966
+  metadata.gz: 2cac2b9e201296fa2c9e058f38cd0acf4835b134f2f98bb74f245af78b58f02c
+  data.tar.gz: 8b4be319b4037c1dfb2c54d6d9314a6add237ac60ec1fe2e6e1f0d396d67d1bb
 SHA512:
-  metadata.gz: 4da172777f5c26a8eafcc82faef85510967381601e67c6d8259229be3097aaa483ad8f57bddb3d42733b95a805ace1f40f84aa2a89777a4fe33f9b2647669e85
-  data.tar.gz: 40873247a7c72bd997f424df0ebf1e421f158046967929ef4d11ae932e1d10422b26fe78feb56a86086b2eb261d20e118dbbe848f10a862d04fae8701bb4340f
+  metadata.gz: 36818826669a7004657c3362908fc8c11bb683fabbf93183dde33cb4a933ce3e5bd41da637cfd2c48906fab72d8ed22992802aa44daa69d7919cc3ccc62faffe
+  data.tar.gz: 17ae44d0099f00b6193f3e94aaa50830556e191d728bc3580b4164fae8f4b6b9f808cea2d3925ffe73cd5a30ea5501be6d393b428e23b01d6b4ee63dfd9d5d32

data/CHANGELOG.md

@@ -0,0 +1,41 @@
+## [9.0.0] - Unreleased
+
+### Changed
+- Switched to independent Semantic Versioning. Prior releases tracked the Rails
+  major/minor line; the version number no longer maps to a Rails version.
+- Require Ruby >= 3.3.
+- Require ActiveRecord >= 8.0, < 9.0 (dropped support for Rails older than 8.0).
+
+### Added
+- `gem.description` and gemspec `metadata` (source, changelog, MFA-required).
+
+### Packaging
+- Slimmed the published gem to `lib`, `ext`, `LICENSE`, and `README.md`; removed
+  the deprecated `test_files` declaration.
+
+### Documentation
+- Documented the features arel-extensions adds (DISTINCT ON, NULLS ordering,
+  array/JSON predicates, full-text search, GIS, binary values) in the README.
+- Documented that the GIS predicates (`#intersects`, `#within`) require the
+  optional `rgeo` gem unless passed an Arel node.
+
+## Earlier releases
+
+Prior versions tracked the matching Rails release. See the Git tags for details:
+
+- [8.1.0] - 2025-12-22
+- [8.0.0] - 2025-01-27
+- [7.0.1] - 2023-05-31
+- [7.0.0] - 2022-12-07
+- [6.1.0] - 2021-01-14
+- [6.0.0.7] - 2019-11-04
+- [6.0.0.2] - 2019-08-12
+
+[9.0.0]: https://github.com/malomalo/arel-extensions/compare/v8.1.0...master
+[8.1.0]: https://github.com/malomalo/arel-extensions/releases/tag/v8.1.0
+[8.0.0]: https://github.com/malomalo/arel-extensions/releases/tag/v8.0.0
+[7.0.1]: https://github.com/malomalo/arel-extensions/releases/tag/v7.0.1
+[7.0.0]: https://github.com/malomalo/arel-extensions/releases/tag/v7.0.0
+[6.1.0]: https://github.com/malomalo/arel-extensions/releases/tag/v6.1.0
+[6.0.0.7]: https://github.com/malomalo/arel-extensions/releases/tag/v6.0.0.7
+[6.0.0.2]: https://github.com/malomalo/arel-extensions/releases/tag/v6.0.0.2

data/README.md

@@ -18,5 +18,86 @@ Or install it yourself as:
 
 ## Usage
 
-Just `require 'arel-extensions'` and use Arel/ActiveRecord as you normally would!
-arel-extensions extends ActiveRecord's query methods in both Arel and ActiveRecord.
+Just `require 'arel-extensions'` and use `Arel` / `ActiveRecord` as you normally
+would.
+
+It adds the methods and nodes below to `Arel::Attributes::Attribute` and to
+`ActiveRecord` relations. Most operators generate PostgreSQL-specific SQL.
+
+Attribute-level helpers are used through an Arel attribute, e.g.
+`Model.arel_table[:column]`, typically inside `where` or `order`.
+
+## What it adds
+
+### `DISTINCT ON` (ActiveRecord)
+
+Added to relations (and as a class method via `Model.distinct_on`):
+
+```ruby
+User.distinct_on(:email)          # SELECT DISTINCT ON (users.email) ...
+User.distinct_on(:a, :b)          # DISTINCT ON (users.a, users.b)
+```
+
+`uniq_on` is an alias of `distinct_on`.
+
+### Ordering with NULLS FIRST / LAST
+
+```ruby
+col = User.arel_table[:name]
+User.order(col.asc(:nulls_last))    # ... ORDER BY users.name ASC NULLS LAST
+User.order(col.desc(:nulls_first))  # ... ORDER BY users.name DESC NULLS FIRST
+```
+
+A `RANDOM()` ordering node is also provided.
+
+### Array predicates
+
+```ruby
+tags = Post.arel_table[:tags]
+tags.contained_by(other)   # tags <@ other
+tags.excludes(other)       # NOT (tags @> other)
+```
+
+### JSON / JSONB predicates
+
+```ruby
+data = User.arel_table[:data]
+
+data.key('name')            # data #>'{name}'   (aliases: data['name'], data.index('name'))
+data.dig('address', 'zip')  # data #>'{address,zip}'
+data.has_key('name')        # data ? 'name'
+data.has_keys('a', 'b')     # data ?& array['a','b']
+data.has_any_key('a', 'b')  # data ?| array['a','b']
+data.cast_as('int')         # (data)::int
+```
+
+### Full-text search
+
+```ruby
+body = Article.arel_table[:body]
+body.ts_query('quick & fox')          # to_tsvector(body) @@ to_tsquery('quick & fox')
+body.ts_query('quick & fox', 'english')
+```
+
+Nodes for `to_tsvector`, `to_tsquery`, `@@` (`TSMatch`), `ts_rank`, and
+`ts_rank_cd` are available for building ranking expressions.
+
+### GIS predicates (optional)
+
+```ruby
+area = Place.arel_table[:area]
+area.intersects(value)   # ST_Intersects(area, value)
+area.within(value)       # ST_Within(area, value)
+```
+
+`value` may be an Arel node, an RGeo geometry, a WKT/WKB string, or a GeoJSON
+hash. Anything other than an Arel node requires the
+[`rgeo`](https://github.com/rgeo/rgeo) gem, so add it to your Gemfile if you use
+these:
+
+    gem 'rgeo'
+
+### Binary values
+
+`BinaryValue` and `HexEncodedBinaryValue` nodes for embedding binary data
+(escaped `bytea` and `\x`-encoded hex, respectively).

data/ext/arel/nodes/ascending.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arel
   module Nodes
     class Ascending < Ordering

data/ext/arel/nodes/descending.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arel
   module Nodes
     class Descending < Ordering

data/ext/arel/order_predications.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Ordering with :nulls_last, :nulls_first options
 module Arel
   module OrderPredications

data/lib/active_record/query_methods.rb

@@ -1,47 +1,49 @@
+# frozen_string_literal: true
+
 require 'active_record'
 require 'active_record/relation'
 require 'active_record/querying'
 require 'active_record/relation/query_methods'
 
-module ActiveRecord::QueryMethods
-  def distinct_on_values
-    @values["distinct_on_values"] || []
-  end
-
-  def distinct_on_values=(value)
-    @values["distinct_on_values"] = value
-  end
+module ActiveRecord
+  # Prepended onto ActiveRecord::QueryMethods rather than reopening it, so
+  # these methods don't appear in QueryMethods.public_instance_methods(false)
+  # -- which Rails' QueryingMethodsDelegationTest asserts against -- while
+  # relations still respond to them.
+  module DistinctOn
+    def distinct_on_values
+      @values["distinct_on_values"] || []
+    end
 
-  def distinct_on(*fields)
-    spawn.distinct_on!(*fields)
-  end
-  alias uniq_on distinct_on
+    def distinct_on_values=(value)
+      @values["distinct_on_values"] = value
+    end
 
-  def distinct_on!(*fields)
-    fields.flatten!
-    self.distinct_on_values = fields.map { |x| x.is_a?(Arel::Attributes::Attribute) ? x : klass.arel_table[x] }
-    self
-  end
-  alias uniq_on! distinct_on!
+    def distinct_on(*fields)
+      spawn.distinct_on!(*fields)
+    end
+    alias uniq_on distinct_on
 
-  private
-  
-  if ActiveRecord.version >= "7.2"
-    def build_arel_with_distinct_on(connection, aliases = nil)
-      arel = build_arel_without_distinct_on(connection, aliases)
-      arel.distinct_on(self.distinct_on_values) if !self.distinct_on_values.empty?
-      arel
+    def distinct_on!(*fields)
+      fields.flatten!
+      self.distinct_on_values = fields.map { |x| x.is_a?(Arel::Attributes::Attribute) ? x : klass.arel_table[x] }
+      self
     end
-  else
-    def build_arel_with_distinct_on(aliases = nil)
-      arel = build_arel_without_distinct_on(aliases)
+    alias uniq_on! distinct_on!
+
+    private
+
+    # Version-agnostic: forward whatever build_arel receives (its signature
+    # varies across Rails versions) to the original via super, then apply
+    # the accumulated distinct_on values.
+    def build_arel(*args)
+      arel = super
       arel.distinct_on(self.distinct_on_values) if !self.distinct_on_values.empty?
       arel
     end
   end
-  alias_method :build_arel_without_distinct_on, :build_arel
-  alias_method :build_arel, :build_arel_with_distinct_on
 end
 
+ActiveRecord::QueryMethods.prepend(ActiveRecord::DistinctOn)
 ActiveRecord::Querying.delegate :distinct_on, to: :all
-ActiveRecord::Querying.delegate :distinct_on!, to: :all
+ActiveRecord::Querying.delegate :uniq_on, to: :all

data/lib/arel/array_predications.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arel
   module ArrayPredications
 

data/lib/arel/attributes/cast.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arel
   module Attributes
     class Cast < Attribute

data/lib/arel/attributes/key.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arel
   module Attributes
     class Key < Attribute

data/lib/arel/extensions/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Arel
   module Extensions
-    VERSION = '8.0.2'
+    VERSION = '9.0.0'
   end
 end

data/lib/arel/extensions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "arel"
 require File.expand_path('../nodes/binary_value', __FILE__)
 require File.expand_path('../nodes/hex_encoded_binary_value', __FILE__)

data/lib/arel/gis_predications.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arel
   module GISPredications
 

data/lib/arel/json_predications.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arel
   module JSONPredications
     

data/lib/arel/nodes/binary_value.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arel
   module Nodes
     class BinaryValue < Arel::Nodes::Unary

data/lib/arel/nodes/contained_by.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arel
   module Nodes
     class ContainedBy < InfixOperation

data/lib/arel/nodes/excludes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arel
   module Nodes
     class Excludes < Binary

data/lib/arel/nodes/geometry.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arel
   module Nodes
     class Geometry < Arel::Nodes::Unary

data/lib/arel/nodes/has_any_key.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arel
   module Nodes
     class HasAnyKey < Binary

data/lib/arel/nodes/has_key.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arel
   module Nodes
     class HasKey < Binary

data/lib/arel/nodes/has_keys.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arel
   module Nodes
     class HasKeys < Binary

data/lib/arel/nodes/hex_encoded_binary_value.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arel
   module Nodes
     class HexEncodedBinaryValue < Arel::Nodes::Unary

data/lib/arel/nodes/intersects.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arel
   module Nodes
     class Intersects < Binary

data/lib/arel/nodes/random.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arel
   module Nodes
     class RandomOrdering < Arel::Nodes::Node

data/lib/arel/nodes/relation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arel
   module Attributes
     class Relation < Attribute

data/lib/arel/nodes/ts_match.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arel
   module Nodes
     class TSMatch < Binary

data/lib/arel/nodes/ts_query.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arel
   module Nodes
     class TSQuery < Arel::Nodes::Node

data/lib/arel/nodes/ts_rank.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arel
   module Nodes
     class TSRank < Arel::Nodes::Node

data/lib/arel/nodes/ts_rank_cd.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arel
   module Nodes
     class TSRankCD < Arel::Nodes::Node

data/lib/arel/nodes/ts_vector.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arel
   module Nodes
     class TSVector < Arel::Nodes::Node

data/lib/arel/nodes/within.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arel
   module Nodes
     class Within < Binary

data/lib/arel/ts_predications.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arel
   module TSPredications
     

data/lib/arel/visitors/postgresql_extensions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arel
   module Visitors
     class PostgreSQL

data/lib/arel/visitors/sunstone_extensions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arel
   module Visitors
     class Sunstone

data/lib/arel/visitors/to_sql_extensions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arel
   module Visitors
     class ToSql

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: arel-extensions
 version: !ruby/object:Gem::Version
-  version: 8.0.2
+  version: 9.0.0
 platform: ruby
 authors:
 - Jon Bracy
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-27 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,7 +15,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.0
+        version: 8.0.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '9.0'
@@ -26,24 +25,10 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.0
+        version: 8.0.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '9.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: debug
   requirement: !ruby/object:Gem::Requirement
@@ -170,20 +155,18 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '8.0'
-description:
+description: Extends Arel and ActiveRecord with SQL operators and functions that aren't
+  available out of the box, including array and JSON predicates, PostgreSQL full-text
+  search (tsvector/tsquery), GIS/geometry predicates, and additional ordering helpers.
 email:
 - jonbracy@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/ci.yml"
-- ".gitignore"
-- Gemfile
+- CHANGELOG.md
 - LICENSE
 - README.md
-- Rakefile
-- arel-extensions.gemspec
 - ext/arel/nodes/ascending.rb
 - ext/arel/nodes/descending.rb
 - ext/arel/order_predications.rb
@@ -216,18 +199,13 @@ files:
 - lib/arel/visitors/postgresql_extensions.rb
 - lib/arel/visitors/sunstone_extensions.rb
 - lib/arel/visitors/to_sql_extensions.rb
-- test/binary_value_test.rb
-- test/database.rb
-- test/gis_test.rb
-- test/order_test.rb
-- test/sunstone_test.rb
-- test/test_helper.rb
-- test/ts_test.rb
 homepage: https://github.com/malomalo/arel-extensions
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  source_code_uri: https://github.com/malomalo/arel-extensions
+  changelog_uri: https://github.com/malomalo/arel-extensions/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -235,22 +213,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.21
-signing_key:
+rubygems_version: 4.0.11
 specification_version: 4
 summary: Adds support for missing SQL operators and functions to Arel
-test_files:
-- test/binary_value_test.rb
-- test/database.rb
-- test/gis_test.rb
-- test/order_test.rb
-- test/sunstone_test.rb
-- test/test_helper.rb
-- test/ts_test.rb
+test_files: []