ransack 4.1.1 → 4.4.0

data/spec/ransack/search_spec.rb

@@ -178,7 +178,6 @@ module Ransack
         #     AND "articles"."title" = 'Test' AND "articles"."published" = 't' AND ('default_scope' = 'default_scope')
         # ) ORDER BY "people"."id" DESC
 
-        pending("spec should pass, but I do not know how/where to fix lib code")
         s = Search.new(Person, published_articles_title_not_eq: 'Test')
         expect(s.result.to_sql).to include 'default_scope'
         expect(s.result.to_sql).to include 'published'
@@ -270,6 +269,7 @@ module Ransack
           end
 
           specify { expect { subject }.to raise_error ArgumentError }
+          specify { expect { subject }.to raise_error InvalidSearchError }
         end
 
         context 'when ignore_unknown_conditions configuration option is true' do
@@ -300,6 +300,7 @@ module Ransack
 
         context 'when ignore_unknown_conditions search parameter is false' do
           specify { expect { with_ignore_unknown_conditions_false }.to raise_error ArgumentError }
+          specify { expect { with_ignore_unknown_conditions_false }.to raise_error InvalidSearchError }
         end
 
         context 'when ignore_unknown_conditions search parameter is true' do
@@ -335,18 +336,90 @@ module Ransack
         end
       end
 
+      context "ransackable_scope with array arguments" do
+        around(:each) do |example|
+          Person.define_singleton_method(:domestic) do |countries|
+            self.where(name: countries)
+          end
+
+          Person.define_singleton_method(:flexible_scope) do |*args|
+            self.where(id: args)
+          end
+
+          Person.define_singleton_method(:two_param_scope) do |param1, param2|
+            self.where(name: param1, id: param2)
+          end
+
+          begin
+            example.run
+          ensure
+            Person.singleton_class.undef_method :domestic
+            Person.singleton_class.undef_method :flexible_scope
+            Person.singleton_class.undef_method :two_param_scope
+          end
+        end
+
+        it "handles scopes that take arrays as single arguments (arity 1)" do
+          allow(Person).to receive(:ransackable_scopes)
+            .and_return(Person.ransackable_scopes + [:domestic])
+
+          # This should not raise ArgumentError
+          expect {
+            s = Search.new(Person, domestic: ['US', 'JP'])
+            s.result # This triggers the actual scope call
+          }.not_to raise_error
+
+          s = Search.new(Person, domestic: ['US', 'JP'])
+          expect(s.instance_variable_get(:@scope_args)["domestic"]).to eq("US")
+        end
+
+        it "handles scopes with flexible arity (negative arity)" do
+          allow(Person).to receive(:ransackable_scopes)
+            .and_return(Person.ransackable_scopes + [:flexible_scope])
+
+          expect {
+            s = Search.new(Person, flexible_scope: ['US', 'JP'])
+            s.result
+          }.not_to raise_error
+        end
+
+        it "handles scopes with arity > 1" do
+          allow(Person).to receive(:ransackable_scopes)
+            .and_return(Person.ransackable_scopes + [:two_param_scope])
+
+          expect {
+            s = Search.new(Person, two_param_scope: ['param1', 'param2'])
+            s.result
+          }.not_to raise_error
+        end
+
+        it "still supports the workaround with nested arrays" do
+          allow(Person).to receive(:ransackable_scopes)
+            .and_return(Person.ransackable_scopes + [:domestic])
+
+          # The workaround from the issue should still work
+          expect {
+            s = Search.new(Person, domestic: [['US', 'JP']])
+            s.result
+          }.not_to raise_error
+        end
+      end
     end
 
     describe '#result' do
       let(:people_name_field) {
         "#{quote_table_name("people")}.#{quote_column_name("name")}"
       }
+      let(:people_temperament_field) {
+        "#{quote_table_name("people")}.#{quote_column_name("temperament")}"
+      }
       let(:children_people_name_field) {
         "#{quote_table_name("children_people")}.#{quote_column_name("name")}"
       }
       let(:notable_type_field) {
         "#{quote_table_name("notes")}.#{quote_column_name("notable_type")}"
       }
+
       it 'evaluates conditions contextually' do
         s = Search.new(Person, children_name_eq: 'Ernie')
         expect(s.result).to be_an ActiveRecord::Relation
@@ -354,6 +427,36 @@ module Ransack
           children_people_name_field} = 'Ernie'/
       end
 
+      context 'when evaluating enums' do
+        before do
+          Person.take.update_attribute(:temperament, 'choleric')
+        end
+
+        it 'evaluates enum key correctly' do
+          s = Search.new(Person, temperament_eq: 'choleric')
+
+          expect(s.result.to_sql).not_to match /#{
+          people_temperament_field} = 0/
+
+          expect(s.result.to_sql).to match /#{
+          people_temperament_field} = #{Person.temperaments[:choleric]}/
+
+          expect(s.result).not_to be_empty
+        end
+
+        it 'evaluates enum value correctly' do
+          s = Search.new(Person, temperament_eq: Person.temperaments[:choleric])
+
+          expect(s.result.to_sql).not_to match /#{
+          people_temperament_field} = 0/
+
+          expect(s.result.to_sql).to match /#{
+          people_temperament_field} = #{Person.temperaments[:choleric]}/
+
+          expect(s.result).not_to be_empty
+        end
+      end
+
       it 'use appropriate table alias' do
         s = Search.new(Person, {
           name_eq: "person_name_query",
@@ -477,6 +580,11 @@ module Ransack
         @s = Search.new(Person)
       end
 
+      it 'doesn\'t creates sorts' do
+        @s.sorts = ''
+        expect(@s.sorts.size).to eq(0)
+      end
+
       it 'creates sorts based on a single attribute/direction' do
         @s.sorts = 'id desc'
         expect(@s.sorts.size).to eq(1)
@@ -614,6 +722,18 @@ module Ransack
         expect(@s.result.first.id).to eq 1
       end
 
+      it 'raises ArgumentError when an invalid argument is sent' do
+        expect do
+          @s.sorts = 1234
+        end.to raise_error(ArgumentError,  "Invalid argument (Integer) supplied to sorts=")
+      end
+
+      it 'raises InvalidSearchError when an invalid argument is sent' do
+        expect do
+          @s.sorts = 1234
+        end.to raise_error(Ransack::InvalidSearchError,  "Invalid argument (Integer) supplied to sorts=")
+      end
+
       it "PG's sort option", if: ::ActiveRecord::Base.connection.adapter_name == "PostgreSQL" do
         default = Ransack.options.clone
 

data/spec/ransack/translate_spec.rb

@@ -2,7 +2,6 @@ require 'spec_helper'
 
 module Ransack
   describe Translate do
-
     describe '.attribute' do
       it 'translate namespaced attribute like AR does' do
         ar_translation = ::Namespace::Article.human_attribute_name(:title)

data/spec/spec_helper.rb

@@ -1,13 +1,12 @@
-require 'machinist/active_record'
-require 'polyamorous/polyamorous'
+require 'ransack'
 require 'sham'
 require 'faker'
-require 'ransack'
 require 'action_controller'
 require 'ransack/helpers'
 require 'pry'
 require 'simplecov'
 require 'byebug'
+require 'machinist/active_record'
 
 SimpleCov.start
 I18n.enforce_available_locales = false

data/spec/support/schema.rb

@@ -1,4 +1,5 @@
 require 'active_record'
+require 'activerecord-postgis-adapter'
 
 case ENV['DB'].try(:downcase)
 when 'mysql', 'mysql2'
@@ -20,6 +21,17 @@ when 'pg', 'postgres', 'postgresql'
     host: ENV.fetch("DATABASE_HOST") { "localhost" },
     min_messages: 'warning'
   )
+when 'postgis'
+  # To test with PostGIS: `DB=postgis bundle exec rake spec`
+  ActiveRecord::Base.establish_connection(
+    adapter: 'postgis',
+    postgis_extension: 'postgis',
+    database: 'ransack',
+    username: ENV.fetch("DATABASE_USERNAME") { "postgres" },
+    password: ENV.fetch("DATABASE_PASSWORD") { "" },
+    host: ENV.fetch("DATABASE_HOST") { "localhost" },
+    min_messages: 'warning'
+  )
 else
   # Otherwise, assume SQLite3: `bundle exec rake spec`
   ActiveRecord::Base.establish_connection(
@@ -69,6 +81,8 @@ class Person < ApplicationRecord
   scope :sort_by_reverse_name_asc, lambda { order(Arel.sql("REVERSE(name) ASC")) }
   scope :sort_by_reverse_name_desc, lambda { order("REVERSE(name) DESC") }
 
+  enum :temperament, { sanguine: 1, choleric: 2, melancholic: 3, phlegmatic: 4 }
+
   alias_attribute :full_name, :name
 
   ransack_alias :term, :name_or_email
@@ -126,6 +140,17 @@ class Person < ApplicationRecord
     Arel.sql(query)
   end
 
+  ransacker :article_tags, formatter: proc { |id|
+    if Tag.exists?(id)
+      joins(articles: :tags)
+        .where(tags: { id: id })
+        .distinct
+        .select(:id).arel
+    end
+  } do |parent|
+    parent.table[:id]
+  end
+
   def self.ransackable_attributes(auth_object = nil)
     if auth_object == :admin
       authorizable_ransackable_attributes - ['only_sort']
@@ -151,6 +176,7 @@ class Article < ApplicationRecord
   has_many :comments
   has_and_belongs_to_many :tags
   has_many :notes, as: :notable
+  has_many :recent_notes, as: :notable
 
   alias_attribute :content, :body
 
@@ -220,18 +246,28 @@ end
 class Comment < ApplicationRecord
   belongs_to :article
   belongs_to :person
+  has_and_belongs_to_many :tags
 
   default_scope { where(disabled: false) }
 end
 
 class Tag < ApplicationRecord
   has_and_belongs_to_many :articles
+  has_and_belongs_to_many :comments
 end
 
 class Note < ApplicationRecord
   belongs_to :notable, polymorphic: true
 end
 
+class RecentNote < ApplicationRecord
+  DEFAULT_NOTABLE_ID = 1
+  self.table_name = "notes"
+  default_scope { where(notable_id: DEFAULT_NOTABLE_ID) }
+
+  belongs_to :notable, polymorphic: true
+end
+
 class Account < ApplicationRecord
   belongs_to :agent_account, class_name: "Account"
   belongs_to :trade_account, class_name: "Account"
@@ -266,6 +302,7 @@ module Schema
         t.string   :new_start
         t.string   :stop_end
         t.integer  :salary
+        t.integer  :temperament
         t.date     :life_start
         t.boolean  :awesome, default: false
         t.boolean  :terms_and_conditions, default: false
@@ -298,6 +335,11 @@ module Schema
         t.integer  :tag_id
       end
 
+      create_table :comments_tags, force: true, id: false do |t|
+        t.integer  :comment_id
+        t.integer  :tag_id
+      end
+
       create_table :notes, force: true do |t|
         t.integer  :notable_id
         t.string   :notable_type

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ransack
 version: !ruby/object:Gem::Version
-  version: 4.1.1
+  version: 4.4.0
 platform: ruby
 authors:
 - Ernie Miller
@@ -9,10 +9,9 @@ authors:
 - Jon Atack
 - Sean Carroll
 - David Rodríguez
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-29 00:00:00.000000000 Z
+date: 2025-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -20,28 +19,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.5
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.5
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.5
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.5
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -56,91 +55,22 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Ransack is the successor to the MetaSearch gem. It improves and expands
-  upon MetaSearch's functionality, but does not have a 100%-compatible API.
+description: Powerful object-based searching and filtering for Active Record with
+  advanced features like complex boolean queries, association searching, custom predicates
+  and i18n support.
 email:
 - ernie@erniemiller.org
 - radarlistener@gmail.com
 - jonnyatack@gmail.com
-- sfcarroll@gmail.com
+- magma.craters2h@icloud.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/FUNDING.yml"
-- ".github/SECURITY.md"
-- ".github/workflows/codeql.yml"
-- ".github/workflows/cronjob.yml"
-- ".github/workflows/deploy.yml"
-- ".github/workflows/rubocop.yml"
-- ".github/workflows/test-deploy.yml"
-- ".github/workflows/test.yml"
-- ".gitignore"
-- ".nojekyll"
-- ".rubocop.yml"
-- CHANGELOG.md
-- CONTRIBUTING.md
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
-- bug_report_templates/test-ransack-scope-and-column-same-name.rb
-- bug_report_templates/test-ransacker-arel-present-predicate.rb
-- docs/.gitignore
-- docs/.nojekyll
-- docs/babel.config.js
-- docs/blog/2022-03-27-ransack-3.0.0.md
-- docs/docs/getting-started/_category_.json
-- docs/docs/getting-started/advanced-mode.md
-- docs/docs/getting-started/configuration.md
-- docs/docs/getting-started/search-matches.md
-- docs/docs/getting-started/simple-mode.md
-- docs/docs/getting-started/sorting.md
-- docs/docs/getting-started/using-predicates.md
-- docs/docs/going-further/_category_.json
-- docs/docs/going-further/acts-as-taggable-on.md
-- docs/docs/going-further/associations.md
-- docs/docs/going-further/custom-predicates.md
-- docs/docs/going-further/documentation.md
-- docs/docs/going-further/exporting-to-csv.md
-- docs/docs/going-further/external-guides.md
-- docs/docs/going-further/form-customisation.md
-- docs/docs/going-further/i18n.md
-- docs/docs/going-further/img/create_release.png
-- docs/docs/going-further/merging-searches.md
-- docs/docs/going-further/other-notes.md
-- docs/docs/going-further/polymorphic-search.md
-- docs/docs/going-further/ransackers.md
-- docs/docs/going-further/release_process.md
-- docs/docs/going-further/saving-queries.md
-- docs/docs/going-further/searching-postgres.md
-- docs/docs/going-further/wiki-contributors.md
-- docs/docs/intro.md
-- docs/docusaurus.config.js
-- docs/package.json
-- docs/sidebars.js
-- docs/src/components/HomepageFeatures/index.js
-- docs/src/components/HomepageFeatures/styles.module.css
-- docs/src/css/custom.css
-- docs/src/pages/index.module.css
-- docs/src/pages/markdown-page.md
-- docs/static/.nojekyll
-- docs/static/img/docusaurus.png
-- docs/static/img/favicon.ico
-- docs/static/img/logo.svg
-- docs/static/img/tutorial/docsVersionDropdown.png
-- docs/static/img/tutorial/localeDropdown.png
-- docs/static/img/undraw_docusaurus_mountain.svg
-- docs/static/img/undraw_docusaurus_react.svg
-- docs/static/img/undraw_docusaurus_tree.svg
-- docs/static/logo/ransack-h.png
-- docs/static/logo/ransack-h.svg
-- docs/static/logo/ransack-v.png
-- docs/static/logo/ransack-v.svg
-- docs/static/logo/ransack.png
-- docs/static/logo/ransack.svg
-- docs/yarn.lock
 - lib/polyamorous/activerecord/join_association.rb
+- lib/polyamorous/activerecord/join_association_7_2.rb
 - lib/polyamorous/activerecord/join_dependency.rb
 - lib/polyamorous/activerecord/reflection.rb
 - lib/polyamorous/join.rb
@@ -157,6 +87,7 @@ files:
 - lib/ransack/helpers.rb
 - lib/ransack/helpers/form_builder.rb
 - lib/ransack/helpers/form_helper.rb
+- lib/ransack/invalid_search_error.rb
 - lib/ransack/locale/ar.yml
 - lib/ransack/locale/az.yml
 - lib/ransack/locale/bg.yml
@@ -174,6 +105,7 @@ files:
 - lib/ransack/locale/id.yml
 - lib/ransack/locale/it.yml
 - lib/ransack/locale/ja.yml
+- lib/ransack/locale/ko.yml
 - lib/ransack/locale/nl.yml
 - lib/ransack/locale/pt-BR.yml
 - lib/ransack/locale/ro.yml
@@ -181,6 +113,7 @@ files:
 - lib/ransack/locale/sk.yml
 - lib/ransack/locale/sv.yml
 - lib/ransack/locale/tr.yml
+- lib/ransack/locale/uk.yml
 - lib/ransack/locale/zh-CN.yml
 - lib/ransack/locale/zh-TW.yml
 - lib/ransack/naming.rb
@@ -197,7 +130,6 @@ files:
 - lib/ransack/translate.rb
 - lib/ransack/version.rb
 - lib/ransack/visitor.rb
-- ransack.gemspec
 - spec/blueprints/articles.rb
 - spec/blueprints/comments.rb
 - spec/blueprints/notes.rb
@@ -227,8 +159,8 @@ files:
 homepage: https://github.com/activerecord-hackery/ransack
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  changelog_uri: https://github.com/activerecord-hackery/ransack/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -243,8 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Object-based searching for Active Record.
 test_files:

data/.github/FUNDING.yml

@@ -1,3 +0,0 @@
----
-
-tidelift: rubygems/ransack

data/.github/SECURITY.md

@@ -1,12 +0,0 @@
-# Security Policy
-
-## Supported Versions
-
-At the moment, only the latest major.minor release stream is supported with
-security updates.
-
-## Reporting a Vulnerability
-
-Please use the Tidelift security contact to [report a security
-vulnerability](https://tidelift.com/security).  Tidelift will coordinate the fix
-and disclosure.

data/.github/workflows/codeql.yml

@@ -1,72 +0,0 @@
-# For most projects, this workflow file will not need changing; you simply need
-# to commit it to your repository.
-#
-# You may wish to alter this file to override the set of languages analyzed,
-# or to provide custom queries or build logic.
-#
-# ******** NOTE ********
-# We have attempted to detect the languages in your repository. Please check
-# the `language` matrix defined below to confirm you have the correct set of
-# supported CodeQL languages.
-#
-name: "CodeQL"
-
-on:
-  push:
-    branches: [ main ]
-  pull_request:
-    # The branches below must be a subset of the branches above
-    branches: [ main ]
-  schedule:
-    - cron: '43 11 * * 3'
-
-jobs:
-  analyze:
-    name: Analyze
-    runs-on: ubuntu-latest
-    permissions:
-      actions: read
-      contents: read
-      security-events: write
-
-    strategy:
-      fail-fast: false
-      matrix:
-        language: [ 'ruby' ]
-        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
-        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
-
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@v3
-
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-        
-        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
-        # queries: security-extended,security-and-quality
-
-        
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
-
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
-
-    #   If the Autobuild fails above, remove it and uncomment the following three lines. 
-    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
-
-    # - run: |
-    #   echo "Run, Build Application using script"
-    #   ./location_of_script_within_repo/buildscript.sh
-
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2