ransack 4.4.0 → 4.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4fe4a128cacdb920f2efe5fc5063cd21b8fa1a4a527fa07e84123f2ead7a6694
-  data.tar.gz: 82f66ffeaa4d8bed52614374fe71617bb1c2d85ac1745dfca7e4520e07782545
+  metadata.gz: 9174f26f96f894e12f75427d0bc4fee92d3cda026ed899f2356b42973d1fb3bf
+  data.tar.gz: aa87e6f2d75557369ca2cf1e7821aaf833490c2793380535d9e5514823ebd117
 SHA512:
-  metadata.gz: a80ce4b0da981c6e3b2d18de8c742d3598a2a7479b44d04adaa1ce3c60a81fa4377f706c78048c1d72f719d488afd379c303b55811053d8613eb82cf0f0dfcad
-  data.tar.gz: cd3f836f63aa19596a3510961bbe64a1f9abcc858473bf9516623e5fe76908bcbb346d36cf1cd7cb83094f0a3c0f4bcdb942b0e137a9020cd8772e28d01d9f51
+  metadata.gz: cdb319a97b23b03a24ac010136212ac53460f03b208e5dff1efae8ff32833256dff1222abbce533e704320740a5bd1cd1d56e14d35d7264a733d0bc1aa75e918
+  data.tar.gz: 12dd3eae7f2cd9bf78d30ab4ae76e5a3ffc80f33ddb3737856cabf3cfb395adf8b9af83eb5feb4e131c8ffd5294e7bf81870da42f7cdbc734288f086902aab96

data/README.md

@@ -13,7 +13,7 @@ There are advanced searching solutions around, like ElasticSearch or Algolia. **
 
 Ready to move beyond the basics? Use **advanced features** like i18n and extensive configuration options.
 
-Ransack is supported for Rails 8.0, 7.2, 7.1 on Ruby 3.1 and later.
+Ransack is supported for Rails 8.0, 7.2 on Ruby 3.1 and later.
 
 ## Installation
 
@@ -41,7 +41,7 @@ This [gist](https://gist.github.com/raghubetina/d5fc3df67ddbadcac271) has a quic
 
 * Before filing an issue, please read the [Contributing Guide](CONTRIBUTING.md).
 * File an issue if a bug is caused by Ransack, is new (has not already been reported), and _can be reproduced from the information you provide_.
-* Please consider adding a branch with a failing spec describing the problem.
+* Please consider creating a pull request with a failing test that demonstrates the problem.
 * Contributions are welcome. :smiley:
 * Please do not use the issue tracker for personal support requests. Stack Overflow or [GitHub Discussions](https://github.com/activerecord-hackery/ransack/discussions) is a better place for that where a wider community can help you!
 

data/lib/ransack/nodes/condition.rb

@@ -226,7 +226,7 @@ module Ransack
       end
 
       def casted_values_for_attribute(attr)
-        validated_values.map(&:cast_array)
+        validated_values.map { |v| v.cast(predicate.type || attr.type) }
       end
 
       def formatted_values_for_attribute(attr)

data/lib/ransack/nodes/value.rb

@@ -43,14 +43,6 @@ module Ransack
         end
       end
 
-      def cast_array
-        if value.is_a?(Array)
-          cast_to_date(value)
-        else
-          value
-        end
-      end
-
       def cast_to_date(val)
         if val.respond_to?(:to_date)
           val.to_date rescue nil

data/lib/ransack/version.rb

@@ -1,3 +1,3 @@
 module Ransack
-  VERSION = '4.4.0'
+  VERSION = '4.4.1'
 end

data/lib/ransack.rb

@@ -1,10 +1,6 @@
 require 'active_support/dependencies/autoload'
 require 'active_support/deprecation'
-require 'active_support/version'
-
-if ::ActiveSupport.version >= ::Gem::Version.new("7.1")
-  require 'active_support/deprecator'
-end
+require 'active_support/deprecator'
 
 require 'active_support/core_ext'
 require 'ransack/configuration'

data/spec/console.rb

@@ -1,25 +1,13 @@
 Bundler.setup
-require 'machinist/active_record'
-require 'sham'
+require 'factory_bot'
 require 'faker'
 require 'ransack'
 
-Dir[File.expand_path('../../spec/{helpers,support,blueprints}/*.rb', __FILE__)]
+Dir[File.expand_path('../../spec/{helpers,support,factories}/*.rb', __FILE__)]
 .each do |f|
   require f
 end
 
-Sham.define do
-  name     { Faker::Name.name }
-  title    { Faker::Lorem.sentence }
-  body     { Faker::Lorem.paragraph }
-  salary   { |index| 30000 + (index * 1000) }
-  tag_name { Faker::Lorem.words(number: 3).join(' ') }
-  note     { Faker::Lorem.words(number: 7).join(' ') }
-  only_admin  { Faker::Lorem.words(number: 3).join(' ') }
-  only_search { Faker::Lorem.words(number: 3).join(' ') }
-  only_sort   { Faker::Lorem.words(number: 3).join(' ') }
-  notable_id  { |id| id }
-end
+Faker::Config.random = Random.new(0)
 
 Schema.create

data/spec/factories/articles.rb

@@ -0,0 +1,7 @@
+FactoryBot.define do
+  factory :article do
+    association :person
+    title { Faker::Lorem.sentence }
+    body { Faker::Lorem.paragraph }
+  end
+end

data/spec/factories/comments.rb

@@ -0,0 +1,7 @@
+FactoryBot.define do
+  factory :comment do
+    association :article
+    association :person
+    body { Faker::Lorem.paragraph }
+  end
+end

data/spec/factories/notes.rb

@@ -0,0 +1,13 @@
+FactoryBot.define do
+  factory :note do
+    note { Faker::Lorem.words(number: 7).join(' ') }
+    
+    trait :for_person do
+      association :notable, factory: :person
+    end
+    
+    trait :for_article do
+      association :notable, factory: :article
+    end
+  end
+end

data/spec/factories/people.rb

@@ -0,0 +1,10 @@
+FactoryBot.define do
+  factory :person do
+    name { Faker::Name.name }
+    email { "test@example.com" }
+    sequence(:salary) { |n| 30000 + (n * 1000) }
+    only_sort { Faker::Lorem.words(number: 3).join(' ') }
+    only_search { Faker::Lorem.words(number: 3).join(' ') }
+    only_admin { Faker::Lorem.words(number: 3).join(' ') }
+  end
+end

data/spec/factories/tags.rb

@@ -0,0 +1,5 @@
+FactoryBot.define do
+  factory :tag do
+    name { Faker::Lorem.words(number: 3).join(' ') }
+  end
+end

data/spec/ransack/adapters/active_record/base_spec.rb

@@ -729,6 +729,44 @@ module Ransack
             end
           end
 
+          context 'ransacker with different types' do
+            it 'handles string type ransacker correctly' do
+              s = Person.ransack(name_case_insensitive_eq: 'test')
+              expect(s.result.to_sql).to match(/LOWER\(.*\) = 'test'/)
+            end
+
+            it 'handles integer type ransacker correctly' do
+              s = Person.ransack(sql_literal_id_eq: 1)
+              expect(s.result.to_sql).to match(/people\.id = 1/)
+            end
+          end
+
+          context 'ransacker with formatter returning nil' do
+            it 'handles formatter returning nil gracefully' do
+              # This tests the edge case where a formatter might return nil
+              s = Person.ransack(article_tags_eq: 999999) # Non-existent tag ID
+              expect { s.result.to_sql }.not_to raise_error
+            end
+          end
+
+          context 'ransacker with array formatters' do
+            it 'handles array_people_ids formatter correctly' do
+              person1 = Person.create!(name: 'Test1')
+              person2 = Person.create!(name: 'Test2')
+              
+              s = Person.ransack(array_people_ids_eq: 'test')
+              expect { s.result }.not_to raise_error
+            end
+
+            it 'handles array_where_people_ids formatter correctly' do
+              person1 = Person.create!(name: 'Test1')
+              person2 = Person.create!(name: 'Test2')
+              
+              s = Person.ransack(array_where_people_ids_eq: [person1.id, person2.id])
+              expect { s.result }.not_to raise_error
+            end
+          end
+
           context 'regular sorting' do
             it 'allows sort by desc' do
               search = Person.ransack(sorts: ['name desc'])

data/spec/ransack/invalid_search_error_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+module Ransack
+  describe InvalidSearchError do
+    it 'inherits from ArgumentError' do
+      expect(InvalidSearchError.superclass).to eq(ArgumentError)
+    end
+
+    it 'can be instantiated with a message' do
+      error = InvalidSearchError.new('Test error message')
+      expect(error.message).to eq('Test error message')
+    end
+
+    it 'can be instantiated without a message' do
+      error = InvalidSearchError.new
+      expect(error.message).to eq('Ransack::InvalidSearchError')
+    end
+
+    it 'can be raised and caught' do
+      expect { raise InvalidSearchError.new('Test') }.to raise_error(InvalidSearchError, 'Test')
+    end
+
+    it 'can be raised and caught as ArgumentError' do
+      expect { raise InvalidSearchError.new('Test') }.to raise_error(ArgumentError, 'Test')
+    end
+  end
+end

data/spec/ransack/ransacker_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+module Ransack
+  describe Ransacker do
+    let(:klass) { Person }
+    let(:name) { :test_ransacker }
+    let(:opts) { {} }
+
+    describe '#initialize' do
+      context 'with minimal options' do
+        subject { Ransacker.new(klass, name, opts) }
+
+        it 'sets the name' do
+          expect(subject.name).to eq(name)
+        end
+
+        it 'sets default type to string' do
+          expect(subject.type).to eq(:string)
+        end
+
+        it 'sets default args to [:parent]' do
+          expect(subject.args).to eq([:parent])
+        end
+      end
+
+      context 'with custom options' do
+        let(:opts) { { type: :integer, args: [:parent, :custom_arg], formatter: proc { |v| v.to_i } } }
+
+        subject { Ransacker.new(klass, name, opts) }
+
+        it 'sets the custom type' do
+          expect(subject.type).to eq(:integer)
+        end
+
+        it 'sets the custom args' do
+          expect(subject.args).to eq([:parent, :custom_arg])
+        end
+
+        it 'sets the formatter' do
+          expect(subject.formatter).to eq(opts[:formatter])
+        end
+      end
+
+      context 'with callable option' do
+        let(:callable) { proc { |parent| parent.table[:id] } }
+        let(:opts) { { callable: callable } }
+
+        subject { Ransacker.new(klass, name, opts) }
+
+        it 'initializes successfully' do
+          expect(subject).to be_a(Ransacker)
+        end
+      end
+    end
+
+    describe 'basic functionality' do
+      subject { Ransacker.new(klass, name, opts) }
+
+      it 'responds to required methods' do
+        expect(subject).to respond_to(:name)
+        expect(subject).to respond_to(:type)
+        expect(subject).to respond_to(:args)
+        expect(subject).to respond_to(:formatter)
+        expect(subject).to respond_to(:attr_from)
+        expect(subject).to respond_to(:call)
+      end
+    end
+  end
+end

data/spec/ransack/search_spec.rb

@@ -313,6 +313,46 @@ module Ransack
         expect { Search.new(Person, params) }.not_to change { params }
       end
 
+      context 'with empty search parameters' do
+        it 'handles completely empty parameters' do
+          search = Search.new(Person, {})
+          expect(search.result.to_sql).not_to match(/WHERE/)
+        end
+
+        it 'handles nil parameters' do
+          search = Search.new(Person, nil)
+          expect(search.result.to_sql).not_to match(/WHERE/)
+        end
+      end
+
+      context 'with whitespace-only values' do
+        before do
+          Ransack.configure { |c| c.strip_whitespace = true }
+        end
+
+        it 'removes whitespace-only values' do
+          expect_any_instance_of(Search).to receive(:build).with({})
+          Search.new(Person, name_eq: '   ')
+        end
+
+        it 'keeps values with content after whitespace stripping' do
+          expect_any_instance_of(Search).to receive(:build).with({ 'name_eq' => 'test' })
+          Search.new(Person, name_eq: '  test  ')
+        end
+      end
+
+      context 'with special characters in values' do
+        it 'handles values with special regex characters' do
+          search = Search.new(Person, name_cont: 'test[(){}^$|?*+.\\')
+          expect { search.result }.not_to raise_error
+        end
+
+        it 'handles values with SQL injection attempts' do
+          search = Search.new(Person, name_cont: "'; DROP TABLE people; --")
+          expect { search.result }.not_to raise_error
+        end
+      end
+
       context "ransackable_scope" do
         around(:each) do |example|
           Person.define_singleton_method(:name_eq) do |name|
@@ -410,9 +450,6 @@ module Ransack
       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")}"
       }
@@ -427,36 +464,6 @@ 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",
@@ -556,7 +563,7 @@ module Ransack
 
         all_or_load, uniq_or_distinct = :load, :distinct
         expect(s.result.send(all_or_load).size)
-        .to eq(9000)
+        .to eq(8998)
         expect(s.result(distinct: true).size)
         .to eq(10)
         expect(s.result.send(all_or_load).send(uniq_or_distinct))

data/spec/spec_helper.rb

@@ -1,37 +1,27 @@
 require 'ransack'
-require 'sham'
+require 'factory_bot'
 require 'faker'
 require 'action_controller'
 require 'ransack/helpers'
 require 'pry'
 require 'simplecov'
 require 'byebug'
-require 'machinist/active_record'
+require 'rspec'
 
 SimpleCov.start
 I18n.enforce_available_locales = false
 Time.zone = 'Eastern Time (US & Canada)'
 I18n.load_path += Dir[File.join(File.dirname(__FILE__), 'support', '*.yml')]
 
-Dir[File.expand_path('../{helpers,support,blueprints}/*.rb', __FILE__)]
+Dir[File.expand_path('../{helpers,support,factories}/*.rb', __FILE__)]
 .each { |f| require f }
 
 Faker::Config.random = Random.new(0)
-Sham.define do
-  name        { Faker::Name.name }
-  title       { Faker::Lorem.sentence }
-  body        { Faker::Lorem.paragraph }
-  salary      { |index| 30000 + (index * 1000) }
-  tag_name    { Faker::Lorem.words(number: 3).join(' ') }
-  note        { Faker::Lorem.words(number: 7).join(' ') }
-  only_admin  { Faker::Lorem.words(number: 3).join(' ') }
-  only_search { Faker::Lorem.words(number: 3).join(' ') }
-  only_sort   { Faker::Lorem.words(number: 3).join(' ') }
-  notable_id  { |id| id }
-end
 
 RSpec.configure do |config|
   config.alias_it_should_behave_like_to :it_has_behavior, 'has behavior'
+  
+  config.include FactoryBot::Syntax::Methods
 
   config.before(:suite) do
     message = "Running Ransack specs with #{
@@ -41,12 +31,9 @@ RSpec.configure do |config|
     line = '=' * message.length
     puts line, message, line
     Schema.create
-    SubDB::Schema.create
+    SubDB::Schema.create if defined?(SubDB)
   end
 
-  config.before(:all)   { Sham.reset(:before_all) }
-  config.before(:each)  { Sham.reset(:before_each) }
-
   config.include RansackHelper
   config.include PolyamorousHelper
 end

data/spec/support/schema.rb

@@ -81,8 +81,6 @@ 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
@@ -118,7 +116,7 @@ class Person < ApplicationRecord
       )
   end
 
-  ransacker :sql_literal_id do
+  ransacker :sql_literal_id, type: :integer do
     Arel.sql('people.id')
   end
 
@@ -302,7 +300,6 @@ 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
@@ -373,23 +370,23 @@ module Schema
     end
 
     10.times do
-      person = Person.make
-      Note.make(notable: person)
+      person = FactoryBot.create(:person)
+      FactoryBot.create(:note, :for_person, notable: person)
       3.times do
-        article = Article.make(person: person)
+        article = FactoryBot.create(:article, person: person)
         3.times do
-          article.tags = [Tag.make, Tag.make, Tag.make]
+          article.tags = [FactoryBot.create(:tag), FactoryBot.create(:tag), FactoryBot.create(:tag)]
         end
-        Note.make(notable: article)
+        FactoryBot.create(:note, :for_article, notable: article)
         10.times do
-          Comment.make(article: article, person: person)
+          FactoryBot.create(:comment, article: article, person: person)
         end
       end
     end
 
-    Comment.make(
+    FactoryBot.create(:comment,
       body: 'First post!',
-      article: Article.make(title: 'Hello, world!')
+      article: FactoryBot.create(:article, title: 'Hello, world!')
     )
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ransack
 version: !ruby/object:Gem::Version
-  version: 4.4.0
+  version: 4.4.1
 platform: ruby
 authors:
 - Ernie Miller
@@ -11,7 +11,7 @@ authors:
 - David Rodríguez
 bindir: bin
 cert_chain: []
-date: 2025-09-25 00:00:00.000000000 Z
+date: 2025-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -19,28 +19,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -130,12 +130,12 @@ files:
 - lib/ransack/translate.rb
 - lib/ransack/version.rb
 - lib/ransack/visitor.rb
-- spec/blueprints/articles.rb
-- spec/blueprints/comments.rb
-- spec/blueprints/notes.rb
-- spec/blueprints/people.rb
-- spec/blueprints/tags.rb
 - spec/console.rb
+- spec/factories/articles.rb
+- spec/factories/comments.rb
+- spec/factories/notes.rb
+- spec/factories/people.rb
+- spec/factories/tags.rb
 - spec/helpers/polyamorous_helper.rb
 - spec/helpers/ransack_helper.rb
 - spec/polyamorous/activerecord_compatibility_spec.rb
@@ -147,10 +147,12 @@ files:
 - spec/ransack/configuration_spec.rb
 - spec/ransack/helpers/form_builder_spec.rb
 - spec/ransack/helpers/form_helper_spec.rb
+- spec/ransack/invalid_search_error_spec.rb
 - spec/ransack/nodes/condition_spec.rb
 - spec/ransack/nodes/grouping_spec.rb
 - spec/ransack/nodes/value_spec.rb
 - spec/ransack/predicate_spec.rb
+- spec/ransack/ransacker_spec.rb
 - spec/ransack/search_spec.rb
 - spec/ransack/translate_spec.rb
 - spec/spec_helper.rb
@@ -168,7 +170,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -179,12 +181,12 @@ rubygems_version: 3.6.2
 specification_version: 4
 summary: Object-based searching for Active Record.
 test_files:
-- spec/blueprints/articles.rb
-- spec/blueprints/comments.rb
-- spec/blueprints/notes.rb
-- spec/blueprints/people.rb
-- spec/blueprints/tags.rb
 - spec/console.rb
+- spec/factories/articles.rb
+- spec/factories/comments.rb
+- spec/factories/notes.rb
+- spec/factories/people.rb
+- spec/factories/tags.rb
 - spec/helpers/polyamorous_helper.rb
 - spec/helpers/ransack_helper.rb
 - spec/polyamorous/activerecord_compatibility_spec.rb
@@ -196,10 +198,12 @@ test_files:
 - spec/ransack/configuration_spec.rb
 - spec/ransack/helpers/form_builder_spec.rb
 - spec/ransack/helpers/form_helper_spec.rb
+- spec/ransack/invalid_search_error_spec.rb
 - spec/ransack/nodes/condition_spec.rb
 - spec/ransack/nodes/grouping_spec.rb
 - spec/ransack/nodes/value_spec.rb
 - spec/ransack/predicate_spec.rb
+- spec/ransack/ransacker_spec.rb
 - spec/ransack/search_spec.rb
 - spec/ransack/translate_spec.rb
 - spec/spec_helper.rb

data/spec/blueprints/articles.rb

@@ -1,5 +0,0 @@
-Article.blueprint do
-  person
-  title
-  body
-end

data/spec/blueprints/comments.rb

@@ -1,5 +0,0 @@
-Comment.blueprint do
-  article
-  person
-  body
-end

data/spec/blueprints/notes.rb

@@ -1,5 +0,0 @@
-Note.blueprint do
-  note
-  notable_type { "Article" }
-  notable_id
-end

data/spec/blueprints/people.rb

@@ -1,8 +0,0 @@
-Person.blueprint do
-  name
-  email { "test@example.com" }
-  salary
-  only_sort
-  only_search
-  only_admin
-end

data/spec/blueprints/tags.rb

@@ -1,3 +0,0 @@
-Tag.blueprint do
-  name    { Sham.tag_name }
-end