scoped_search 4.3.1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2413a0e2075ccff25188af0a579df4b8cfde593f38ab801b99bd7379b2344c8b
-  data.tar.gz: edc1ec5d32cc2b410fdf9938e49aca0cfba46807850491c3ee6bba28642dfc5b
+  metadata.gz: b246204885d3b4432baebaa00e7dea9407e8938dc078fa0bc726e587f4a12122
+  data.tar.gz: 81f9dd75acb77c0d9eb6165528493bdb1e93fbd8ccf71c91bacbe6e2585d3ef7
 SHA512:
-  metadata.gz: 4a31a5e76daac85ca7b36cff7fdf38a377258401f38da13fb789afb1d6ca55e01331ce88c78136e7bc4efc64704e59460de267b50bfd8dc47e479c881e2b84b7
-  data.tar.gz: 87d273283f63fbc83afb0ab29f163a5625f0fc074c551c5220f004eb902c43a407973bf5470395c90442666ff14e1a69b1b0e7b8aba653c997d180da969429ee
+  metadata.gz: 714a96861d37c99dac22c3e6d33dccbf18d2287191944abc112048942d2dbef04957ce932ba0f645b3e53e00f702ba70b379512485b0ce96a09d414010d4bf54
+  data.tar.gz: 62d2fdfbd14f777db4c0f0f090d061ddcdd775108d948a6c3d796927b7b840b9622197d4e416c46dbbc7ce9d1ad8fdcf35eae5817183e7b48ee481808e7071dc

data/.github/workflows/ruby.yml

@@ -7,7 +7,8 @@
 
 name: Ruby
 
-on: [pull_request]
+on:  # yamllint disable-line rule:truthy
+  - pull_request
 
 env:
   TESTOPTS: --verbose
@@ -19,31 +20,18 @@ jobs:
       fail-fast: false
       matrix:
         ruby_version:
-          - 2.7.1
-          - 3.0.0
+          - '2.7'
+          - '3.0'
+          - '3.3'
           - ruby-head
           - jruby-head
-        gemfile:
-          - Gemfile.activerecord52
-          - Gemfile.activerecord52_with_activesupport52
-          - Gemfile.activerecord60
-          - Gemfile.activerecord60_with_activesupport60
-          - Gemfile.activerecord61
-          - Gemfile.activerecord61_with_activesupport61
-
-        exclude:
-          - ruby_version: 2.7.1
-            gemfile: Gemfile.activerecord52
-          - ruby_version: 2.7.1
-            gemfile: Gemfile.activerecord52_with_activesupport52
-          - ruby_version: 3.0.0
-            gemfile: Gemfile.activerecord52
-          - ruby_version: 3.0.0
-            gemfile: Gemfile.activerecord52_with_activesupport52
-          - ruby_version: ruby-head
-            gemfile: Gemfile.activerecord52
-          - ruby_version: ruby-head
-            gemfile: Gemfile.activerecord52_with_activesupport52
+        appraisal:
+          - rails-6.0
+          - rails-6.0-activesupport
+          - rails-6.1
+          - rails-6.1-activesupport
+          - rails-7.0
+          - rails-7.0-activesupport
     services:
       postgres:
         image: postgres:12.1
@@ -59,18 +47,18 @@ jobs:
           MYSQL_DATABASE: scoped_search_test
 
     env:
-      BUNDLE_GEMFILE: ${{ github.workspace }}/${{ matrix.gemfile }}
+      BUNDLE_GEMFILE: appraisal.gemfile
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
-    # change this to (see https://github.com/ruby/setup-ruby#versioning):
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby_version }}
-        bundler-cache: true
-    # - name: Install dependencies
-    #   run: bundle install
-    - name: Run tests
-      run: bundle exec rake
+      - uses: actions/checkout@v6
+      - name: Set up Ruby ${{ matrix.ruby_version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+          bundler-cache: true
+      - name: Generate gemfiles
+        run: bundle exec appraisal generate
+      - name: Appraisal for ${{ matrix.ruby_version }} ${{ matrix.appraisal }}
+        run: bundle exec appraisal ${{ matrix.appraisal }} bundle
+      - name: Tests for ${{ matrix.ruby_version }} ${{ matrix.appraisal }}
+        run: bundle exec appraisal ${{ matrix.appraisal }} bundle exec rake

data/.gitignore

@@ -6,7 +6,8 @@ scoped_search-*.gem
 /coverage
 /classes
 /files
+/gemfiles/*.gemfile
 /spec/database.yml
 .bundle/
-Gemfile*.lock
+*.lock
 .idea/

data/Appraisals

@@ -0,0 +1,16 @@
+['6.0', '6.1', '7.0'].each do |version|
+  appraise "rails-#{version}" do
+    gem 'actionview', "~> #{version}.0"
+    gem 'activerecord', "~> #{version}.0"
+    eval_gemfile 'modular/rails-6'
+    eval_gemfile 'modular/rspec'
+  end
+
+  appraise "rails-#{version}-activesupport" do
+    gem 'actionview', "~> #{version}.0"
+    gem 'activerecord', "~> #{version}.0"
+    gem 'activesupport', "~> #{version}.0"
+    eval_gemfile 'modular/rails-6'
+    eval_gemfile 'modular/rspec'
+  end
+end

data/CHANGELOG.rdoc

@@ -6,6 +6,12 @@ Please add an entry to the "Unreleased changes" section in your pull requests.
 
 === Unreleased changes
 
+=== Version 5.0.0
+
+- Drop Rails versions older than 6.0
+- Add support for Ruby 3.3 and Rails 7.0
+- Add virtual field check to to_null_sql method in query builder
+
 === Version 4.3.1
 - Autocomplete now offers only relevant options available through scopes set on associations (#233)
 

data/Gemfile

@@ -4,7 +4,7 @@ gemspec
 gem 'actionview'
 gem 'activerecord'
 
-gem 'nokogiri', '~> 1.6.0' if RUBY_VERSION.start_with?('2.0')
+gem 'appraisal2'
 
 platforms :jruby do
   gem 'activerecord-jdbcsqlite3-adapter'

data/README.rdoc

@@ -22,8 +22,8 @@ Add the following line in your Gemfile, and run <tt>bundle install</tt>:
 
   gem "scoped_search"
 
-Scoped search 4.x supports Rails 4.2 to 5.0, with Ruby 2.0.0 or higher. Use
-previous versions, e.g. 3.x to support older versions of Rails or Ruby.
+Scoped search 5.x supports Rails 6.
+Use previous versions to support older versions of Rails or Ruby.
 
 == Usage
 

data/appraisal.gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'appraisal2'

data/gemfiles/modular/rails-6

@@ -0,0 +1,25 @@
+# Ruby 3 has moved various gems from default gems to bundled gems
+# Prior to activesupport 7.0.9 these were not listed
+# See https://stdgems.org/ for more
+if RUBY_VERSION >= '3.4'
+  gem 'base64'
+  gem 'benchmark'
+  gem 'bigdecimal'
+  gem 'logger'
+  gem 'mutex_m'
+end
+
+group :mysql do
+  gem 'activerecord-jdbcmysql-adapter', platforms: :jruby
+  gem 'mysql2', '> 0.5', platforms: :ruby
+end
+
+group :postgresql do
+  gem 'activerecord-jdbcpostgresql-adapter', platforms: :jruby
+  gem 'pg', '>= 0.18', '< 2.0', platforms: :ruby
+end
+
+group :sqlite do
+  gem 'activerecord-jdbcsqlite3-adapter', platforms: :jruby
+  gem 'sqlite3', '~> 1.4', platforms: :ruby
+end

data/gemfiles/modular/rspec

@@ -0,0 +1 @@
+gem 'rspec', '~> 3.0'

data/lib/scoped_search/query_builder.rb

@@ -307,8 +307,7 @@ module ScopedSearch
 
       join_reflections.zip(table_names.zip(join_reflections.drop(1))).reduce(sql) do |acc, (reflection, (previous_table, next_reflection))|
         fk1, pk1 = if reflection.respond_to?(:join_keys)
-                     klass = reflection.method(:join_keys).arity == 1 ? [reflection.klass] : [] # ActiveRecord <5.2 workaround
-                     reflection.join_keys(*klass).values # We are joining the tables "in reverse", so the PK and FK are swapped
+                     reflection.join_keys.values # We are joining the tables "in reverse", so the PK and FK are swapped
                    else
                      [reflection.join_primary_key, reflection.join_foreign_key] #ActiveRecord 6.1
                    end
@@ -426,8 +425,7 @@ module ScopedSearch
       def reflection_keys(reflection)
         pk = reflection.klass.primary_key
         fk = reflection.options[:foreign_key]
-        # activerecord prior to 3.1 doesn't respond to foreign_key method and hold the key name in the reflection primary key
-        fk ||= reflection.respond_to?(:foreign_key) ? reflection.foreign_key : reflection.primary_key_name
+        fk ||= reflection.foreign_key
         reflection.macro == :belongs_to ? [fk, pk] : [pk, fk]
       end
 
@@ -495,6 +493,11 @@ module ScopedSearch
           field = definition.field_by_name(rhs.value)
           raise ScopedSearch::QueryNotSupported, "Field '#{rhs.value}' not recognized for searching!" unless field
 
+          if field.virtual?
+            sql_operator = operator == :notnull ? 'IS NOT NULL' : 'IS NULL'
+            return field.to_ext_method_sql(rhs.value, sql_operator, nil, &block)
+          end
+
           if field.key_field
             yield(:parameter, rhs.value.to_s.sub(/^.*\./,''))
           end

data/lib/scoped_search/version.rb

@@ -1,3 +1,3 @@
 module ScopedSearch
-  VERSION = "4.3.1"
+  VERSION = "5.0.0"
 end

data/scoped_search.gemspec

@@ -29,8 +29,9 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.required_ruby_version = '>= 2.0.0'
-  gem.add_runtime_dependency('activerecord', '>= 4.2.0')
+  # https://www.fastruby.io/blog/ruby/rails/versions/compatibility-table.html
+  gem.required_ruby_version = '>= 2.5.0'
+  gem.add_runtime_dependency('activerecord', '>= 6.0')
   gem.add_development_dependency('rspec', '~> 3.0')
   gem.add_development_dependency('rake')
 

data/spec/integration/ext_method_spec.rb

@@ -46,4 +46,131 @@ ScopedSearch::RSpec::Database.test_databases.each do |db|
       @class.search_for('beta = 42').should == [@two]
     end
   end
+
+  describe ScopedSearch, "ext_method with has/not has on a #{db} database" do
+
+    before(:all) do
+      ScopedSearch::RSpec::Database.establish_named_connection(db)
+    end
+
+    after(:all) do
+      ScopedSearch::RSpec::Database.close_connection
+    end
+
+    context 'on a direct field' do
+      before(:all) do
+        @class = ScopedSearch::RSpec::Database.create_model(alpha: :integer) do |klass|
+          klass.send(:define_singleton_method, :test_ext_has) do |key, operator, value|
+            if value.nil?
+              case operator
+              when 'IS NOT NULL'
+                { conditions: "#{klass.table_name}.alpha > 1" }
+              when 'IS NULL'
+                { conditions: "#{klass.table_name}.alpha IS NULL OR #{klass.table_name}.alpha <= 1" }
+              end
+            else
+              { conditions: "#{klass.table_name}.alpha = ?", parameter: [value.to_i] }
+            end
+          end
+          klass.scoped_search on: :alpha, ext_method: :test_ext_has
+        end
+
+        @included = @class.create!(alpha: 2)
+        @excluded = @class.create!(alpha: 1)
+        @null_record = @class.create!(alpha: nil)
+      end
+
+      after(:all) do
+        ScopedSearch::RSpec::Database.drop_model(@class)
+      end
+
+      it 'should delegate set? to ext_method' do
+        @class.search_for('set? alpha').should == [@included]
+      end
+
+      it 'should delegate null? to ext_method' do
+        results = @class.search_for('null? alpha')
+        results.should include(@excluded)
+        results.should include(@null_record)
+        results.length.should == 2
+      end
+
+      it 'should still find records via value search' do
+        @class.search_for('alpha = 2').should == [@included]
+      end
+    end
+
+    context 'on a relation field' do
+      before(:all) do
+        @main = ScopedSearch::RSpec::Database.create_model(name: :string) {}
+
+        @related = ScopedSearch::RSpec::Database.create_model(
+          value: :string,
+          promoted: :boolean,
+          main_id: :integer
+        ) do |klass|
+        end
+
+        related_table = @related.table_name
+        main_table = @main.table_name
+        related_class = @related
+        main_class = @main
+
+        @related.belongs_to main_table.to_sym, foreign_key: :main_id
+        @main.has_many related_table.to_sym, foreign_key: :main_id
+
+        @main.send(:define_singleton_method, :test_ext_promoted) do |key, operator, value|
+          if value.nil?
+            subquery = related_class.where(promoted: true).select(:main_id).to_sql
+            case operator
+            when 'IS NOT NULL'
+              { conditions: "#{main_table}.id IN (#{subquery})" }
+            when 'IS NULL'
+              { conditions: "#{main_table}.id NOT IN (#{subquery})" }
+            end
+          else
+            { joins: related_table.to_sym,
+              conditions: "#{related_table}.value #{operator} ? AND #{related_table}.promoted = ?",
+              parameter: [value, true] }
+          end
+        end
+
+        @main.scoped_search(
+          relation: related_table.to_sym,
+          on: :value,
+          rename: :promoted_items,
+          ext_method: :test_ext_promoted
+        )
+
+        @record_a = @main.create!(name: 'a')
+        @related.create!(value: 'item1', promoted: true, main_id: @record_a.id)
+
+        @record_b = @main.create!(name: 'b')
+        @related.create!(value: 'item2', promoted: false, main_id: @record_b.id)
+
+        @record_c = @main.create!(name: 'c')
+      end
+
+      after(:all) do
+        ScopedSearch::RSpec::Database.drop_model(@related)
+        ScopedSearch::RSpec::Database.drop_model(@main)
+      end
+
+      it 'should delegate set? to ext_method, not raw relation' do
+        @main.search_for('set? promoted_items').should == [@record_a]
+      end
+
+      it 'should delegate null? to ext_method, not raw relation' do
+        results = @main.search_for('null? promoted_items')
+        results.should include(@record_b)
+        results.should include(@record_c)
+        results.length.should == 2
+      end
+
+      it 'should still use ext_method for value search' do
+        @main.search_for('promoted_items = item1').should == [@record_a]
+        @main.search_for('promoted_items = item2').should == []
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,3 @@
-require 'rubygems'
-require 'bundler/setup'
-
 require 'rspec'
 require 'scoped_search'
 

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: scoped_search
 version: !ruby/object:Gem::Version
-  version: 4.3.1
+  version: 5.0.0
 platform: ruby
 authors:
 - Amos Benari
 - Willem van Bergen
 - Wes Hays
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-09-30 00:00:00.000000000 Z
+date: 2026-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -150,24 +150,19 @@ files:
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".travis.yml"
+- Appraisals
 - CHANGELOG.rdoc
 - CONTRIBUTING.rdoc
 - Gemfile
-- Gemfile.activerecord42
-- Gemfile.activerecord50
-- Gemfile.activerecord51
-- Gemfile.activerecord52
-- Gemfile.activerecord52_with_activesupport52
-- Gemfile.activerecord60
-- Gemfile.activerecord60_with_activesupport60
-- Gemfile.activerecord61
-- Gemfile.activerecord61_with_activesupport61
 - LICENSE
 - README.rdoc
 - Rakefile
 - app/assets/images/spinner.gif
 - app/assets/javascripts/scoped_search.js
 - app/assets/stylesheets/scoped_search.scss
+- appraisal.gemfile
+- gemfiles/modular/rails-6
+- gemfiles/modular/rspec
 - lib/scoped_search.rb
 - lib/scoped_search/auto_complete_builder.rb
 - lib/scoped_search/compass.rb
@@ -214,7 +209,7 @@ homepage: https://github.com/wvanbergen/scoped_search/wiki
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--title"
 - scoped_search
@@ -228,15 +223,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: Easily search you ActiveRecord models with a simple query language using
   a named scope

data/Gemfile.activerecord42

@@ -1,19 +0,0 @@
-source 'https://rubygems.org'
-gemspec
-
-gem 'actionview', '~> 4.2.0'
-gem 'activerecord', '~> 4.2.0'
-
-gem 'nokogiri', '~> 1.6.0' if RUBY_VERSION.start_with?('2.0')
-
-platforms :jruby do
-  gem 'activerecord-jdbcsqlite3-adapter'
-  gem 'activerecord-jdbcmysql-adapter'
-  gem 'activerecord-jdbcpostgresql-adapter'
-end
-
-platforms :ruby do
-  gem 'sqlite3', '~> 1.3.6'
-  gem 'mysql2', '>= 0.3.13', '< 0.5'
-  gem 'pg', '~> 0.15'
-end

data/Gemfile.activerecord50

@@ -1,17 +0,0 @@
-source 'https://rubygems.org'
-gemspec
-
-gem 'actionview', '~> 5.0.0'
-gem 'activerecord', '~> 5.0.0'
-
-platforms :jruby do
-  gem 'activerecord-jdbcsqlite3-adapter'
-  gem 'activerecord-jdbcmysql-adapter'
-  gem 'activerecord-jdbcpostgresql-adapter'
-end
-
-platforms :ruby do
-  gem 'sqlite3', '~> 1.3.6'
-  gem 'mysql2', '>= 0.3.18', '< 0.5'
-  gem 'pg', '~> 0.18'
-end

data/Gemfile.activerecord51

@@ -1,17 +0,0 @@
-source 'https://rubygems.org'
-gemspec
-
-gem 'actionview', '~> 5.1.0'
-gem 'activerecord', '~> 5.1.0'
-
-platforms :jruby do
-  gem 'activerecord-jdbcsqlite3-adapter'
-  gem 'activerecord-jdbcmysql-adapter'
-  gem 'activerecord-jdbcpostgresql-adapter'
-end
-
-platforms :ruby do
-  gem 'sqlite3', '~> 1.3.6'
-  gem 'mysql2', '>= 0.3.18', '< 0.5'
-  gem 'pg', '~> 0.18'
-end

data/Gemfile.activerecord52

@@ -1,17 +0,0 @@
-source 'https://rubygems.org'
-gemspec
-
-gem 'actionview', '~> 5.2.0'
-gem 'activerecord', '~> 5.2.0'
-
-platforms :jruby do
-  gem 'activerecord-jdbcsqlite3-adapter'
-  gem 'activerecord-jdbcmysql-adapter'
-  gem 'activerecord-jdbcpostgresql-adapter'
-end
-
-platforms :ruby do
-  gem 'sqlite3', '~> 1.3.6'
-  gem 'mysql2', '>= 0.3.18', '< 0.5'
-  gem 'pg', '~> 0.18'
-end

data/Gemfile.activerecord52_with_activesupport52

@@ -1,18 +0,0 @@
-source 'https://rubygems.org'
-gemspec
-
-gem 'actionview', '~> 5.2.0'
-gem 'activerecord', '~> 5.2.0'
-gem 'activesupport', '~> 5.2.0'
-
-platforms :jruby do
-  gem 'activerecord-jdbcsqlite3-adapter'
-  gem 'activerecord-jdbcmysql-adapter'
-  gem 'activerecord-jdbcpostgresql-adapter'
-end
-
-platforms :ruby do
-  gem 'sqlite3', '~> 1.3.6'
-  gem 'mysql2', '>= 0.3.18', '< 0.5'
-  gem 'pg', '~> 0.18'
-end

data/Gemfile.activerecord60

@@ -1,17 +0,0 @@
-source 'https://rubygems.org'
-gemspec
-
-gem 'actionview', '~> 6.0.0'
-gem 'activerecord', '~> 6.0.0'
-
-platforms :jruby do
-  gem 'activerecord-jdbcsqlite3-adapter'
-  gem 'activerecord-jdbcmysql-adapter'
-  gem 'activerecord-jdbcpostgresql-adapter'
-end
-
-platforms :ruby do
-  gem 'sqlite3', '~> 1.4'
-  gem 'mysql2', '> 0.5'
-  gem 'pg', '>= 0.18', '< 2.0'
-end

data/Gemfile.activerecord60_with_activesupport60

@@ -1,18 +0,0 @@
-source 'https://rubygems.org'
-gemspec
-
-gem 'actionview', '~> 6.0.0'
-gem 'activerecord', '~> 6.0.0'
-gem 'activesupport', '~> 6.0.0'
-
-platforms :jruby do
-  gem 'activerecord-jdbcsqlite3-adapter'
-  gem 'activerecord-jdbcmysql-adapter'
-  gem 'activerecord-jdbcpostgresql-adapter'
-end
-
-platforms :ruby do
-  gem 'sqlite3', '~> 1.4'
-  gem 'mysql2', '> 0.5'
-  gem 'pg', '>= 0.18', '< 2.0'
-end

data/Gemfile.activerecord61

@@ -1,17 +0,0 @@
-source 'https://rubygems.org'
-gemspec
-
-gem 'actionview', '~> 6.1.0'
-gem 'activerecord', '~> 6.1.0'
-
-platforms :jruby do
-  gem 'activerecord-jdbcsqlite3-adapter'
-  gem 'activerecord-jdbcmysql-adapter'
-  gem 'activerecord-jdbcpostgresql-adapter'
-end
-
-platforms :ruby do
-  gem 'sqlite3', '~> 1.4'
-  gem 'mysql2', '> 0.5'
-  gem 'pg', '>= 0.18', '< 2.0'
-end

data/Gemfile.activerecord61_with_activesupport61

@@ -1,18 +0,0 @@
-source 'https://rubygems.org'
-gemspec
-
-gem 'actionview', '~> 6.1.0'
-gem 'activerecord', '~> 6.1.0'
-gem 'activesupport', '~> 6.1.0'
-
-platforms :jruby do
-  gem 'activerecord-jdbcsqlite3-adapter'
-  gem 'activerecord-jdbcmysql-adapter'
-  gem 'activerecord-jdbcpostgresql-adapter'
-end
-
-platforms :ruby do
-  gem 'sqlite3', '~> 1.4'
-  gem 'mysql2', '> 0.5'
-  gem 'pg', '>= 0.18', '< 2.0'
-end