ransack 2.4.2 → 3.2.1

data/spec/ransack/configuration_spec.rb

@@ -45,6 +45,20 @@ module Ransack
       Ransack.options = default
     end
 
+    it 'should have default value for strip_whitespace' do
+      expect(Ransack.options[:strip_whitespace]).to eq true
+    end
+
+    it 'changes default search key parameter' do
+      default = Ransack.options.clone
+
+      Ransack.configure { |c| c.strip_whitespace = false }
+
+      expect(Ransack.options[:strip_whitespace]).to eq false
+
+      Ransack.options = default
+    end
+
     it 'should have default values for arrows' do
       expect(Ransack.options[:up_arrow]).to eq '▼'
       expect(Ransack.options[:down_arrow]).to eq '▲'

data/spec/ransack/helpers/form_helper_spec.rb

@@ -469,8 +469,7 @@ module Ransack
           it { should match /exist\=existing/ }
         end
 
-        context 'using a real ActionController::Parameter object',
-          if: ::ActiveRecord::VERSION::MAJOR > 3 do
+        context 'using a real ActionController::Parameter object' do
 
           describe 'with symbol q:, #sort_link should include search params' do
             subject { @controller.view_context.sort_link(Person.ransack, :name) }
@@ -727,6 +726,62 @@ module Ransack
         it { should match /Block label ▼/ }
       end
 
+      describe '#sort_link with class option' do
+        subject { @controller.view_context
+          .sort_link(
+            [:main_app, Person.ransack(sorts: ['name desc'])],
+            :name,
+            class: 'people', controller: 'people'
+          )
+        }
+        it { should match /class="sort_link desc people"/ }
+        it { should_not match /people\?class=people/ }
+      end
+
+      describe '#sort_link with class option workaround' do
+        it "generates a correct link and prints a deprecation" do
+          expect do
+            link = @controller.view_context
+              .sort_link(
+                [:main_app, Person.ransack(sorts: ['name desc'])],
+                :name,
+                'name',
+                { controller: 'people' },
+                class: 'people'
+              )
+
+            expect(link).to match(/class="sort_link desc people"/)
+            expect(link).not_to match(/people\?class=people/)
+          end.to output(
+            /Passing two trailing hashes to `sort_link` is deprecated, merge the trailing hashes into a single one\. \(called at #{Regexp.escape(__FILE__)}:/
+          ).to_stderr
+        end
+      end
+
+      describe '#sort_link with data option' do
+        subject { @controller.view_context
+          .sort_link(
+            [:main_app, Person.ransack(sorts: ['name desc'])],
+            :name,
+            data: { turbo_action: :advance }, controller: 'people'
+          )
+        }
+        it { should match /data-turbo-action="advance"/ }
+        it { should_not match /people\?data%5Bturbo_action%5D=advance/ }
+      end
+
+      describe "#sort_link with host option" do
+        subject { @controller.view_context
+          .sort_link(
+            [:main_app, Person.ransack(sorts: ['name desc'])],
+            :name,
+            host: 'foo', controller: 'people'
+          )
+        }
+        it { should match /href="\/people\?q/ }
+        it { should_not match /href=".*foo/ }
+      end
+
       describe '#search_form_for with default format' do
         subject { @controller.view_context
           .search_form_for(Person.ransack) {} }

data/spec/ransack/nodes/condition_spec.rb

@@ -3,6 +3,19 @@ require 'spec_helper'
 module Ransack
   module Nodes
     describe Condition do
+      context 'bug report #1245' do
+        it 'preserves tuple behavior' do
+          ransack_hash = {
+              m: 'and',
+              g: [
+                { title_type_in: ['["title 1", ""]'] }
+              ]
+            }
+
+          sql = Article.ransack(ransack_hash).result.to_sql
+          expect(sql).to include("IN (('title 1', ''))")
+        end
+      end
 
       context 'with an alias' do
         subject {

data/spec/ransack/nodes/value_spec.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+
+module Ransack
+  module Nodes
+    describe Value do
+      let(:context) { Context.for(Person) }
+
+      subject do
+        Value.new(context, raw_value)
+      end
+
+      context "with a date value" do
+        let(:raw_value) { "2022-05-23" }
+
+        [:date].each do |type|
+          it "should cast #{type} correctly" do
+            result = subject.cast(type)
+
+            expect(result).to be_a_kind_of(Date)
+            expect(result).to eq(Date.parse(raw_value))
+          end
+        end
+      end
+
+      context "with a timestamp value" do
+        let(:raw_value) { "2022-05-23 10:40:02 -0400" }
+
+        [:datetime, :timestamp, :time, :timestamptz].each do |type|
+          it "should cast #{type} correctly" do
+            result = subject.cast(type)
+
+            expect(result).to be_a_kind_of(Time)
+            expect(result).to eq(Time.zone.parse(raw_value))
+          end
+        end
+      end
+
+      Constants::TRUE_VALUES.each do |value|
+        context "with a true boolean value (#{value})" do
+          let(:raw_value) { value.to_s }
+
+          it "should cast boolean correctly" do
+            result = subject.cast(:boolean)
+            expect(result).to eq(true)
+          end
+        end
+      end
+
+      Constants::FALSE_VALUES.each do |value|
+        context "with a false boolean value (#{value})" do
+          let(:raw_value) { value.to_s }
+
+          it "should cast boolean correctly" do
+            result = subject.cast(:boolean)
+
+            expect(result).to eq(false)
+          end
+        end
+      end
+
+      ["12", "101.5"].each do |value|
+        context "with an integer value (#{value})" do
+          let(:raw_value) { value }
+
+          it "should cast #{value} to integer correctly" do
+            result = subject.cast(:integer)
+
+            expect(result).to be_an(Integer)
+            expect(result).to eq(value.to_i)
+          end
+        end
+      end
+
+      ["12", "101.5"].each do |value|
+        context "with a float value (#{value})" do
+          let(:raw_value) { value }
+
+          it "should cast #{value} to float correctly" do
+            result = subject.cast(:float)
+
+            expect(result).to be_an(Float)
+            expect(result).to eq(value.to_f)
+          end
+        end
+      end
+
+      ["12", "101.5"].each do |value|
+        context "with a decimal value (#{value})" do
+          let(:raw_value) { value }
+
+          it "should cast #{value} to decimal correctly" do
+            result = subject.cast(:decimal)
+
+            expect(result).to be_a(BigDecimal)
+            expect(result).to eq(value.to_d)
+          end
+        end
+      end
+
+      ["12", "101.513"].each do |value|
+        context "with a money value (#{value})" do
+          let(:raw_value) { value }
+
+          it "should cast #{value} to money correctly" do
+            result = subject.cast(:money)
+
+            expect(result).to be_a(String)
+            expect(result).to eq(value.to_f.to_s)
+          end
+        end
+      end
+
+    end
+  end
+end

data/spec/ransack/search_spec.rb

@@ -20,10 +20,42 @@ module Ransack
         Search.new(Person, name_eq: 'foobar')
       end
 
-      it 'strip leading & trailing whitespace before building' do
-        expect_any_instance_of(Search).to receive(:build)
-        .with({ 'name_eq' => 'foobar' })
-        Search.new(Person, name_eq: '   foobar     ')
+      context 'whitespace stripping' do
+        context 'when whitespace_strip option is true' do
+          before do
+            Ransack.configure { |c| c.strip_whitespace = true }
+          end
+
+          it 'strips leading & trailing whitespace before building' do
+            expect_any_instance_of(Search).to receive(:build)
+            .with({ 'name_eq' => 'foobar' })
+            Search.new(Person, name_eq: '   foobar     ')
+          end
+        end
+
+        context 'when whitespace_strip option is false' do
+          before do
+            Ransack.configure { |c| c.strip_whitespace = false }
+          end
+
+          it 'doesn\'t strip leading & trailing whitespace before building' do
+            expect_any_instance_of(Search).to receive(:build)
+            .with({ 'name_eq' => '   foobar     ' })
+            Search.new(Person, name_eq: '   foobar     ')
+          end
+        end
+
+        it 'strips leading & trailing whitespace when strip_whitespace search parameter is true' do
+          expect_any_instance_of(Search).to receive(:build)
+          .with({ 'name_eq' => 'foobar' })
+          Search.new(Person, { name_eq: '   foobar     ' }, { strip_whitespace: true })
+        end
+
+        it 'doesn\'t strip leading & trailing whitespace when strip_whitespace search parameter is false' do
+          expect_any_instance_of(Search).to receive(:build)
+          .with({ 'name_eq' => '   foobar     ' })
+          Search.new(Person, { name_eq: '   foobar     ' }, { strip_whitespace: false })
+        end
       end
 
       it 'removes empty suffixed conditions before building' do
@@ -280,6 +312,29 @@ module Ransack
         expect { Search.new(Person, params) }.not_to change { params }
       end
 
+      context "ransackable_scope" do
+        around(:each) do |example|
+          Person.define_singleton_method(:name_eq) do |name|
+            self.where(name: name)
+          end
+
+          begin
+            example.run
+          ensure
+            Person.singleton_class.undef_method :name_eq
+          end
+        end
+
+        it "is prioritized over base predicates" do
+          allow(Person).to receive(:ransackable_scopes)
+            .and_return(Person.ransackable_scopes + [:name_eq])
+
+          s = Search.new(Person, name_eq: "Johny")
+          expect(s.instance_variable_get(:@scope_args)["name_eq"]).to eq("Johny")
+          expect(s.base[:name_eq]).to be_nil
+        end
+      end
+
     end
 
     describe '#result' do
@@ -300,8 +355,6 @@ module Ransack
       end
 
       it 'use appropriate table alias' do
-        skip "Rails 6 regressed here, but it's fixed in 6-0-stable since https://github.com/rails/rails/commit/f9ba52477ca288e7effa5f6794ae3df3f4e982bc" if ENV["RAILS"] == "v6.0.3"
-
         s = Search.new(Person, {
           name_eq: "person_name_query",
           articles_title_eq: "person_article_title_query",
@@ -451,82 +504,109 @@ module Ransack
         expect(sort.dir).to eq 'asc'
       end
 
-      it 'creates sorts based on multiple attributes/directions in array format' do
-        @s.sorts = ['id desc', { name: 'name', dir: 'asc' }]
+      it 'creates sorts based on a single alias/direction' do
+        @s.sorts = 'daddy desc'
+        expect(@s.sorts.size).to eq(1)
+        sort = @s.sorts.first
+        expect(sort).to be_a Nodes::Sort
+        expect(sort.name).to eq 'parent_name'
+        expect(sort.dir).to eq 'desc'
+      end
+
+      it 'creates sorts based on a single alias and uppercase direction' do
+        @s.sorts = 'daddy DESC'
+        expect(@s.sorts.size).to eq(1)
+        sort = @s.sorts.first
+        expect(sort).to be_a Nodes::Sort
+        expect(sort.name).to eq 'parent_name'
+        expect(sort.dir).to eq 'desc'
+      end
+
+      it 'creates sorts based on a single alias and without direction' do
+        @s.sorts = 'daddy'
+        expect(@s.sorts.size).to eq(1)
+        sort = @s.sorts.first
+        expect(sort).to be_a Nodes::Sort
+        expect(sort.name).to eq 'parent_name'
+        expect(sort.dir).to eq 'asc'
+      end
+
+      it 'creates sorts based on attributes, alias and directions in array format' do
+        @s.sorts = ['id desc', { name: 'daddy', dir: 'asc' }]
         expect(@s.sorts.size).to eq(2)
         sort1, sort2 = @s.sorts
         expect(sort1).to be_a Nodes::Sort
         expect(sort1.name).to eq 'id'
         expect(sort1.dir).to eq 'desc'
         expect(sort2).to be_a Nodes::Sort
-        expect(sort2.name).to eq 'name'
+        expect(sort2.name).to eq 'parent_name'
         expect(sort2.dir).to eq 'asc'
       end
 
-      it 'creates sorts based on multiple attributes and uppercase directions in array format' do
-        @s.sorts = ['id DESC', { name: 'name', dir: 'ASC' }]
+      it 'creates sorts based on attributes, alias and uppercase directions in array format' do
+        @s.sorts = ['id DESC', { name: 'daddy', dir: 'ASC' }]
         expect(@s.sorts.size).to eq(2)
         sort1, sort2 = @s.sorts
         expect(sort1).to be_a Nodes::Sort
         expect(sort1.name).to eq 'id'
         expect(sort1.dir).to eq 'desc'
         expect(sort2).to be_a Nodes::Sort
-        expect(sort2.name).to eq 'name'
+        expect(sort2.name).to eq 'parent_name'
         expect(sort2.dir).to eq 'asc'
       end
 
-      it 'creates sorts based on multiple attributes and different directions
+      it 'creates sorts based on attributes, alias and different directions
         in array format' do
-        @s.sorts = ['id DESC', { name: 'name', dir: nil }]
+        @s.sorts = ['id DESC', { name: 'daddy', dir: nil }]
         expect(@s.sorts.size).to eq(2)
         sort1, sort2 = @s.sorts
         expect(sort1).to be_a Nodes::Sort
         expect(sort1.name).to eq 'id'
         expect(sort1.dir).to eq 'desc'
         expect(sort2).to be_a Nodes::Sort
-        expect(sort2.name).to eq 'name'
+        expect(sort2.name).to eq 'parent_name'
         expect(sort2.dir).to eq 'asc'
       end
 
-      it 'creates sorts based on multiple attributes/directions in hash format' do
+      it 'creates sorts based on attributes, alias and directions in hash format' do
         @s.sorts = {
           '0' => { name: 'id', dir: 'desc' },
-          '1' => { name: 'name', dir: 'asc' }
+          '1' => { name: 'daddy', dir: 'asc' }
         }
         expect(@s.sorts.size).to eq(2)
         expect(@s.sorts).to be_all { |s| Nodes::Sort === s }
         id_sort = @s.sorts.detect { |s| s.name == 'id' }
-        name_sort = @s.sorts.detect { |s| s.name == 'name' }
+        daddy_sort = @s.sorts.detect { |s| s.name == 'parent_name' }
         expect(id_sort.dir).to eq 'desc'
-        expect(name_sort.dir).to eq 'asc'
+        expect(daddy_sort.dir).to eq 'asc'
       end
 
-      it 'creates sorts based on multiple attributes and uppercase directions
+      it 'creates sorts based on attributes, alias and uppercase directions
         in hash format' do
         @s.sorts = {
           '0' => { name: 'id', dir: 'DESC' },
-          '1' => { name: 'name', dir: 'ASC' }
+          '1' => { name: 'daddy', dir: 'ASC' }
         }
         expect(@s.sorts.size).to eq(2)
         expect(@s.sorts).to be_all { |s| Nodes::Sort === s }
         id_sort = @s.sorts.detect { |s| s.name == 'id' }
-        name_sort = @s.sorts.detect { |s| s.name == 'name' }
+        daddy_sort = @s.sorts.detect { |s| s.name == 'parent_name' }
         expect(id_sort.dir).to eq 'desc'
-        expect(name_sort.dir).to eq 'asc'
+        expect(daddy_sort.dir).to eq 'asc'
       end
 
-      it 'creates sorts based on multiple attributes and different directions
+      it 'creates sorts based on attributes, alias and different directions
         in hash format' do
         @s.sorts = {
           '0' => { name: 'id', dir: 'DESC' },
-          '1' => { name: 'name', dir: nil }
+          '1' => { name: 'daddy', dir: nil }
         }
         expect(@s.sorts.size).to eq(2)
         expect(@s.sorts).to be_all { |s| Nodes::Sort === s }
         id_sort = @s.sorts.detect { |s| s.name == 'id' }
-        name_sort = @s.sorts.detect { |s| s.name == 'name' }
+        daddy_sort = @s.sorts.detect { |s| s.name == 'parent_name' }
         expect(id_sort.dir).to eq 'desc'
-        expect(name_sort.dir).to eq 'asc'
+        expect(daddy_sort.dir).to eq 'asc'
       end
 
       it 'overrides existing sort' do
@@ -554,6 +634,39 @@ module Ransack
 
         Ransack.options = default
       end
+
+      it "PG's sort option with double name", if: ::ActiveRecord::Base.connection.adapter_name == "PostgreSQL" do
+        default = Ransack.options.clone
+
+        s = Search.new(Person, s: 'doubled_name asc')
+        expect(s.result.to_sql).to eq "SELECT \"people\".* FROM \"people\" ORDER BY \"people\".\"name\" || \"people\".\"name\" ASC"
+
+        Ransack.configure { |c| c.postgres_fields_sort_option = :nulls_first }
+        s = Search.new(Person, s: 'doubled_name asc')
+        expect(s.result.to_sql).to eq "SELECT \"people\".* FROM \"people\" ORDER BY \"people\".\"name\" || \"people\".\"name\" ASC NULLS FIRST"
+        s = Search.new(Person, s: 'doubled_name desc')
+        expect(s.result.to_sql).to eq "SELECT \"people\".* FROM \"people\" ORDER BY \"people\".\"name\" || \"people\".\"name\" DESC NULLS LAST"
+
+        Ransack.configure { |c| c.postgres_fields_sort_option = :nulls_last }
+        s = Search.new(Person, s: 'doubled_name asc')
+        expect(s.result.to_sql).to eq "SELECT \"people\".* FROM \"people\" ORDER BY \"people\".\"name\" || \"people\".\"name\" ASC NULLS LAST"
+        s = Search.new(Person, s: 'doubled_name desc')
+        expect(s.result.to_sql).to eq "SELECT \"people\".* FROM \"people\" ORDER BY \"people\".\"name\" || \"people\".\"name\" DESC NULLS FIRST"
+
+        Ransack.configure { |c| c.postgres_fields_sort_option = :nulls_always_first }
+        s = Search.new(Person, s: 'doubled_name asc')
+        expect(s.result.to_sql).to eq "SELECT \"people\".* FROM \"people\" ORDER BY \"people\".\"name\" || \"people\".\"name\" ASC NULLS FIRST"
+        s = Search.new(Person, s: 'doubled_name desc')
+        expect(s.result.to_sql).to eq "SELECT \"people\".* FROM \"people\" ORDER BY \"people\".\"name\" || \"people\".\"name\" DESC NULLS FIRST"
+
+        Ransack.configure { |c| c.postgres_fields_sort_option = :nulls_always_last }
+        s = Search.new(Person, s: 'doubled_name asc')
+        expect(s.result.to_sql).to eq "SELECT \"people\".* FROM \"people\" ORDER BY \"people\".\"name\" || \"people\".\"name\" ASC NULLS LAST"
+        s = Search.new(Person, s: 'doubled_name desc')
+        expect(s.result.to_sql).to eq "SELECT \"people\".* FROM \"people\" ORDER BY \"people\".\"name\" || \"people\".\"name\" DESC NULLS LAST"
+
+        Ransack.options = default
+      end
     end
 
     describe '#method_missing' do

data/spec/support/schema.rb

@@ -138,6 +138,45 @@ class Article < ActiveRecord::Base
   alias_attribute :content, :body
 
   default_scope { where("'default_scope' = 'default_scope'") }
+  scope :latest_comment_cont, lambda { |msg|
+    join = <<-SQL
+      (LEFT OUTER JOIN (
+          SELECT
+            comments.*,
+            row_number() OVER (PARTITION BY comments.article_id ORDER BY comments.id DESC) AS rownum
+          FROM comments
+        ) AS latest_comment
+        ON latest_comment.article_id = article.id
+        AND latest_comment.rownum = 1
+      )
+    SQL
+    .squish
+
+    joins(join).where("latest_comment.body ILIKE ?", "%#{msg}%")
+  }
+
+  ransacker :title_type, formatter: lambda { |tuples|
+    title, type = JSON.parse(tuples)
+    Arel::Nodes::Grouping.new(
+      [
+        Arel::Nodes.build_quoted(title),
+        Arel::Nodes.build_quoted(type)
+      ]
+    )
+  } do |_parent|
+    articles = Article.arel_table
+    Arel::Nodes::Grouping.new(
+      %i[title type].map do |field|
+        Arel::Nodes::NamedFunction.new(
+          'COALESCE',
+          [
+            Arel::Nodes::NamedFunction.new('TRIM', [articles[field]]),
+            Arel::Nodes.build_quoted('')
+          ]
+        )
+      end
+    )
+  end
 end
 
 class StoryArticle < Article
@@ -176,6 +215,11 @@ class Note < ActiveRecord::Base
   belongs_to :notable, polymorphic: true
 end
 
+class Account < ActiveRecord::Base
+  belongs_to :agent_account, class_name: "Account"
+  belongs_to :trade_account, class_name: "Account"
+end
+
 module Schema
   def self.create
     ActiveRecord::Migration.verbose = false
@@ -234,6 +278,11 @@ module Schema
         t.integer  :target_person_id
         t.integer  :article_id
       end
+
+      create_table :accounts, force: true do |t|
+        t.belongs_to :agent_account
+        t.belongs_to :trade_account
+      end
     end
 
     10.times do