activerecord-filter 8.0.0 → 9.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09732db42dbc93213eb9cb72360f1fe556cb8ee1be65ef4ab9a5ea66460e463e'
-  data.tar.gz: a363687983fb83cdb7db3a65c02e279ec56b57566c2199a844dc6bc973c50382
+  metadata.gz: a42ca6ff3bdbd4318c13518684d31f6bdf3b7a98aa02e877e2d8147c83d2efef
+  data.tar.gz: 5b595328b4129bced6fa43a87c6f93398d6cb35942bb0aa693874b49a062de91
 SHA512:
-  metadata.gz: b98da863c302b2aba54a339f3a78de317a9dbf11235f318f6ffb750bdb80265e5fde571d1a7d7eef72066bb37ad7e9a70bcbf7095b598b9d6b66911e9fd1db03
-  data.tar.gz: d2969b02282399759622892ad30ef2fc181358bd2c9c2c2051f772c7d08395f951f446588a0cd7a060573580b582970ac614252d9be68a1c937c781cfada928f
+  metadata.gz: 3e1500189bf99dae963016fff43cb78cda9aa42fe771907fd7842562d67ea704b4609822e85a3f559f96776c3f084a54e790cfdd4bc1026731da44989b7a5109
+  data.tar.gz: 6f9aeae084bf0b7efde2b69dc20a1ac15b8312bbedd800820f5b84fa7e733147357a09fdcf8272e2c1a263077f2fff93a40c5aebd60b9ef3ce2adbd90537385a

data/README.md

@@ -1,9 +1,13 @@
 # ActiveRecord::Filter
 
-`ActiveRecord::Filter` provides and easy way to accept user input and filter a query by the input.
+`ActiveRecord::Filter` provides an easy way to accept user input and filter a query by that input.
 
-Installtion
------------
+## Requirements
+
+- Ruby >= 3.3
+- ActiveRecord >= 8.0
+
+## Installation
 
 - Add `gem 'activerecord-filter', require: 'active_record/filter'`
 - Run `bundle install`
@@ -124,10 +128,39 @@ Property.filter("metadata.key": { eq: 'value' }).to_sql
 # => "...WHERE "properties"."metadata" #> '{key}' = 'value'..."
 ```
 
-It can also sort on relations:
+It can also filter across associations. Any association (`belongs_to`,
+`has_many`, `has_one`, `has_and_belongs_to_many`, `has_many :through`) can be
+nested, and the join is added for you:
 
 ```ruby
 Photo.filter(property: {name: 'Empire State'}).to_sql
 # => "... LEFT OUTER JOIN properties ON properties.id = photos.property_id ...
 # => "... WHERE properties.name = 'Empire State'"
 ```
+
+Pass `true`/`false` against an association to filter on its presence:
+
+```ruby
+Account.filter(photos: true).to_sql   # accounts that have photos
+Account.filter(photos: false).to_sql  # accounts with no photos
+```
+
+For a polymorphic association, scope it to a type with `as:`:
+
+```ruby
+View.filter(subject: {as: 'Property', name: 'Name'}).to_sql
+```
+
+Combining conditions with AND / OR
+----------------------------------
+
+Pass an array to group conditions. Use the strings `'AND'` / `'OR'` as
+separators, and nest arrays for precedence:
+
+```ruby
+Property.filter([{id: 10}, 'OR', {name: 'name'}]).to_sql
+# => "... WHERE ((properties.id = 10) OR (properties.name = 'name'))"
+
+Property.filter([{id: 10}, 'AND', [{id: 10}, 'OR', {name: 'name'}]]).to_sql
+# => "... WHERE properties.id = 10 AND ((properties.id = 10) OR (properties.name = 'name'))"
+```

data/lib/active_record/filter/alias_tracker_extension.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveRecord::Filter::AliasTrackerExtension
 
   def initialize(*, **)

data/lib/active_record/filter/filter_clause_factory.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 class ActiveRecord::Filter::FilterClauseFactory
 
   def initialize(model, predicate_builder)
-    @model = model
+    @klass = model
     @predicate_builder = predicate_builder
   end
 
@@ -17,6 +19,6 @@ class ActiveRecord::Filter::FilterClauseFactory
 
   protected
 
-  attr_reader :model, :predicate_builder
+  attr_reader :klass, :predicate_builder
 
 end

data/lib/active_record/filter/predicate_builder_extension.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "active_support/concern"
 
 module ActiveRecord::Filter::PredicateBuilderExtension
@@ -26,6 +28,15 @@ module ActiveRecord::Filter::PredicateBuilderExtension
                   relations << j
                 end
               end
+            elsif js.is_a?(Proc)
+              resolved = js.call(value)
+              Array(resolved).compact.each do |j|
+                if j.is_a?(String)
+                  custom << j
+                else
+                  relations << j
+                end
+              end
             elsif js
               if js.is_a?(String)
                 custom << js
@@ -53,17 +64,17 @@ module ActiveRecord::Filter::PredicateBuilderExtension
                 ]
               else
                 {
-                  key => build_filter_joins(reflection.klass, value, [], custom)
+                  reflection.name => build_filter_joins(reflection.klass, value, [], custom)
                 }
               end
             elsif value.is_a?(Array)
               value.each do |v|
                 relations << {
-                  key => build_filter_joins(reflection.klass, v, [], custom)
+                  reflection.name => build_filter_joins(reflection.klass, v, [], custom)
                 }
               end
             elsif value != true && value != false && value != 'true' && value != 'false' && !value.nil?
-              relations << key
+              relations << reflection.name
             end
           elsif !klass.columns_hash.has_key?(key.to_s) && key.to_s.end_with?('_ids') && reflection = klass._reflections[key.to_s.gsub(/_ids$/, 's').to_sym]
             relations << reflection.name
@@ -297,18 +308,18 @@ module ActiveRecord::Filter::PredicateBuilderExtension
       value = value.dup
       klass = value.delete(:as).safe_constantize
 
-      builder = self.class.new(ActiveRecord::TableMetadata.new(
+      builder = new_predicate_builder_extension(
         klass,          
         alias_tracker.aliased_table_for_relation(relation_trail + ["#{klass.table_name}_as_#{relation.name}"], klass.arel_table) { klass.arel_table.name },
         relation
-      ))
+      )
       builder.build_from_filter_hash(value, relation_trail + ["#{klass.table_name}_as_#{relation.name}"], alias_tracker)
     else
-      builder = self.class.new(ActiveRecord::TableMetadata.new(
+      builder = new_predicate_builder_extension(
         relation.klass,
         alias_tracker.aliased_table_for_relation(relation_trail + [relation.name], relation.klass.arel_table) { relation.alias_candidate(table.arel_table.name || relation.klass.arel_table) },
         relation
-      ))
+      )
       builder.build_from_filter_hash(value, relation_trail + [relation.name], alias_tracker)
     end
 
@@ -316,12 +327,21 @@ module ActiveRecord::Filter::PredicateBuilderExtension
 
   def expand_filter_for_join_table(relation, value, relation_trail, alias_tracker)
     relation = relation.active_record._reflections[relation.active_record._reflections[relation.name].send(:delegate_reflection).options[:through]]
-    builder = self.class.new(ActiveRecord::TableMetadata.new(
+    builder = new_predicate_builder_extension(
       relation.klass,
       alias_tracker.aliased_table_for_relation(relation_trail + [relation.name], relation.klass.arel_table) { relation.alias_candidate(table.arel_table.name || relation.klass.arel_table) },
       relation
-    ))
+    )
     builder.build_from_filter_hash(value, relation_trail + [relation.name], alias_tracker)
   end
 
+  if ActiveRecord.version >= "8.1"
+    def new_predicate_builder_extension(a,b,c)
+      self.class.new(ActiveRecord::TableMetadata.new(a, b))
+    end
+  else
+    def new_predicate_builder_extension(a,b,c)
+      self.class.new(ActiveRecord::TableMetadata.new(a, b, c))
+    end
+  end
 end

data/lib/active_record/filter/query_methods_extension.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveRecord::Filter::QueryMethodsExtension
 private
   def build_join_buckets
@@ -8,11 +10,7 @@ private
       left_joins = select_named_joins(left_outer_joins_values, stashed_left_joins) do |left_join|
         if left_join.is_a?(ActiveRecord::QueryMethods::CTEJoin)
           buckets[:join_node] << build_with_join_node(left_join.name, Arel::Nodes::OuterJoin)
-# Add this elsif becasuse PR https://github.com/rails/rails/pull/46843
-# Changed a line https://github.com/rails/rails/blob/ae2983a75ca658d84afa414dea8eaf1cca87aa23/activerecord/lib/active_record/relation/query_methods.rb#L1769
-# that was probably a bug beforehand but allowed nodes to be joined
-# which I think was and still is supported?
-        elsif left_join.is_a?(Arel::Nodes::OuterJoin)
+        elsif left_join.is_a?(Arel::Nodes::Join)
           buckets[:join_node] << left_join
         else
           raise ArgumentError, "only Hash, Symbol and Array are allowed"

data/lib/active_record/filter/relation_extension.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveRecord::Filter::RelationExtension
 
   def initialize(*, **)
@@ -49,7 +51,14 @@ module ActiveRecord::Filter::RelationExtension
     @filter_clause_factory ||= ActiveRecord::Filter::FilterClauseFactory.new(klass, predicate_builder)
   end
 
-  if ActiveRecord.version >= "7.2"
+  if ActiveRecord.version >= "8.1"
+    def build_arel(aliases = nil)
+      arel = super
+      my_alias_tracker = ActiveRecord::Associations::AliasTracker.create(model.connection_pool, table.name, [])
+      build_filters(arel, my_alias_tracker)
+      arel
+    end
+  elsif ActiveRecord.version >= "7.2"
     def build_arel(connection, aliases = nil)
       arel = super
       my_alias_tracker = ActiveRecord::Associations::AliasTracker.create(model.connection_pool, table.name, [])

data/lib/active_record/filter/spawn_methods_extension.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveRecord::Filter::SpawnMethodsExtension
 
   def except(*skips)

data/lib/active_record/filter/unkown_filter_error.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 class ActiveRecord::UnkownFilterError < NoMethodError
 end

data/lib/active_record/filter/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module ActiveRecord
   module Filter
-    VERSION = '8.0.0'
+    VERSION = '9.0.0'
   end
 end

data/lib/active_record/filter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_record'
 require 'arel/extensions'
 require 'active_record/filter/unkown_filter_error'

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-filter
 version: !ruby/object:Gem::Version
-  version: 8.0.0
+  version: 9.0.0
 platform: ruby
 authors:
 - Jon Bracy
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-28 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,28 +15,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.1.0
+        version: 8.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.1.0
+        version: 8.0.0
 - !ruby/object:Gem::Dependency
   name: arel-extensions
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.1.0
+        version: 8.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.1.0
+        version: 8.0.0
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +57,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.0
+        version: 8.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.0
+        version: 8.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +121,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: benchmark
+  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: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +155,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.0
+        version: 8.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.0
+        version: 8.0.0
 - !ruby/object:Gem::Dependency
   name: faker
   requirement: !ruby/object:Gem::Requirement
@@ -214,8 +227,11 @@ files:
 homepage: https://github.com/malomalo/activerecord-filter
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  homepage_uri: https://github.com/malomalo/activerecord-filter
+  source_code_uri: https://github.com/malomalo/activerecord-filter
+  changelog_uri: https://github.com/malomalo/activerecord-filter/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 rdoc_options:
 - "--main"
 - README.md
@@ -225,15 +241,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: A safe way to accept user parameters and query against your ActiveRecord
   Models