ransack 2.4.2 → 3.0.0

data/lib/polyamorous/activerecord_6.0_ruby_2/join_association.rb

@@ -1 +1,20 @@
-require 'polyamorous/activerecord_5.2_ruby_2/join_association'
+module Polyamorous
+  module JoinAssociationExtensions
+    include SwappingReflectionClass
+    def self.prepended(base)
+      base.class_eval { attr_reader :join_type }
+    end
+
+    def initialize(reflection, children, polymorphic_class = nil, join_type = Arel::Nodes::InnerJoin)
+      @join_type = join_type
+      if polymorphic_class && ::ActiveRecord::Base > polymorphic_class
+        swapping_reflection_klass(reflection, polymorphic_class) do |reflection|
+          super(reflection, children)
+          self.reflection.options[:polymorphic] = true
+        end
+      else
+        super(reflection, children)
+      end
+    end
+  end
+end

data/lib/polyamorous/activerecord_6.0_ruby_2/join_dependency.rb

@@ -1,4 +1,3 @@
-# active_record_6.0_ruby_2/join_dependency.rb
 module Polyamorous
   module JoinDependencyExtensions
     # Replaces ActiveRecord::Associations::JoinDependency#build

data/lib/polyamorous/activerecord_6.0_ruby_2/reflection.rb

@@ -1 +1,11 @@
-require 'polyamorous/activerecord_5.2_ruby_2/reflection'
+module Polyamorous
+  module ReflectionExtensions
+    def join_scope(table, foreign_table, foreign_klass)
+      if respond_to?(:polymorphic?) && polymorphic?
+        super.where!(foreign_table[foreign_type].eq(klass.name))
+      else
+        super
+      end
+    end
+  end
+end

data/lib/polyamorous/activerecord_6.1_ruby_2/join_association.rb

@@ -66,9 +66,5 @@ module Polyamorous
 
       joins
     end
-
-    def ==(other)
-      base_klass == other.base_klass
-    end
   end
 end

data/lib/polyamorous/activerecord_6.1_ruby_2/join_dependency.rb

@@ -1,4 +1,3 @@
-# active_record_6.1_ruby_2/join_dependency.rb
 module Polyamorous
   module JoinDependencyExtensions
     # Replaces ActiveRecord::Associations::JoinDependency#build

data/lib/polyamorous.rb

@@ -0,0 +1 @@
+require 'polyamorous/polyamorous'

data/lib/ransack/adapters/active_record/base.rb

@@ -4,7 +4,6 @@ module Ransack
       module Base
 
         def self.extended(base)
-          alias :search :ransack unless base.respond_to? :search
           base.class_eval do
             class_attribute :_ransackers
             class_attribute :_ransack_aliases
@@ -14,7 +13,6 @@ module Ransack
         end
 
         def ransack(params = {}, options = {})
-          ActiveSupport::Deprecation.warn("#search is deprecated and will be removed in 2.3, please use #ransack instead") if __callee__ == :search
           Search.new(self, params, options)
         end
 
@@ -70,7 +68,7 @@ module Ransack
         end
 
         # ransack_scope_skip_sanitize_args, by default, returns an empty array.
-        # i.e. use the sanitize_scope_args setting to determin if args should be converted.
+        # i.e. use the sanitize_scope_args setting to determine if args should be converted.
         # For overriding with a list of scopes which should be passed the args as-is.
         #
         def ransackable_scopes_skip_sanitize_args

data/lib/ransack/adapters/active_record/context.rb

@@ -44,9 +44,13 @@ module Ransack
               else
                 case Ransack.options[:postgres_fields_sort_option]
                 when :nulls_first
-                  scope_or_sort = scope_or_sort.direction == :asc ? "#{scope_or_sort.to_sql} NULLS FIRST" : "#{scope_or_sort.to_sql} NULLS LAST"
+                  scope_or_sort = scope_or_sort.direction == :asc ? Arel.sql("#{scope_or_sort.to_sql} NULLS FIRST") : Arel.sql("#{scope_or_sort.to_sql} NULLS LAST")
                 when :nulls_last
-                  scope_or_sort = scope_or_sort.direction == :asc ? "#{scope_or_sort.to_sql} NULLS LAST" : "#{scope_or_sort.to_sql} NULLS FIRST"
+                  scope_or_sort = scope_or_sort.direction == :asc ? Arel.sql("#{scope_or_sort.to_sql} NULLS LAST") : Arel.sql("#{scope_or_sort.to_sql} NULLS FIRST")
+                when :nulls_always_first
+                  scope_or_sort = Arel.sql("#{scope_or_sort.to_sql} NULLS FIRST")
+                when :nulls_always_last
+                  scope_or_sort = Arel.sql("#{scope_or_sort.to_sql} NULLS LAST")
                 end
 
                 relation = relation.order(scope_or_sort)
@@ -139,6 +143,7 @@ module Ransack
             stashed.eql?(association)
           }
           @object.joins_values.delete_if { |jd|
+            jd.instance_variables.include?(:@join_root) &&
             jd.instance_variable_get(:@join_root).children.map(&:object_id) == [association.object_id]
           }
         end

data/lib/ransack/adapters/active_record/ransack/nodes/condition.rb

@@ -47,18 +47,19 @@ module Ransack
         end
 
         def casted_array?(predicate)
-          (predicate.respond_to?(:value) && predicate.value.is_a?(Array)) || # Rails 6.1
-            (predicate.respond_to?(:val) && predicate.val.is_a?(Array)) # Rails 5.2, 6.0
+          value_from(predicate).is_a?(Array) && predicate.is_a?(Arel::Nodes::Casted)
         end
 
-        def format_values_for(predicate)
-          value = if predicate.respond_to?(:value)
-                    predicate.value # Rails 6.1
-                  else
-                    predicate.val # Rails 5.2, 6.0
-                  end
+        def value_from(predicate)
+          if predicate.respond_to?(:value)
+            predicate.value # Rails 6.1
+          elsif predicate.respond_to?(:val)
+            predicate.val # Rails 6.0
+          end
+        end
 
-          value.map do |val|
+        def format_values_for(predicate)
+          value_from(predicate).map do |val|
             val.is_a?(String) ? Arel::Nodes.build_quoted(val) : val
           end
         end

data/lib/ransack/configuration.rb

@@ -34,7 +34,8 @@ module Ransack
       :down_arrow => '▲'.freeze,
       :default_arrow => nil,
       :sanitize_scope_args => true,
-      :postgres_fields_sort_option => nil
+      :postgres_fields_sort_option => nil,
+      :strip_whitespace => true
     }
 
     def configure
@@ -148,7 +149,7 @@ module Ransack
     # User may want to configure it like this:
     #
     # Ransack.configure do |c|
-    #   c.postgres_fields_sort_option = :nulls_first # or :nulls_last
+    #   c.postgres_fields_sort_option = :nulls_first # or e.g. :nulls_always_last
     # end
     #
     # See this feature: https://www.postgresql.org/docs/13/queries-order.html
@@ -170,6 +171,19 @@ module Ransack
       self.options[:hide_sort_order_indicators] = boolean
     end
 
+    # By default, Ransack displays strips all whitespace when searching for a string.
+    # The default may be globally changed in an initializer file like
+    # `config/initializers/ransack.rb` as follows:
+    #
+    # Ransack.configure do |config|
+    #   # Enable whitespace stripping for string searches
+    #   config.strip_whitespace = true
+    # end
+    #
+    def strip_whitespace=(boolean)
+      self.options[:strip_whitespace] = boolean
+    end
+
     def arel_predicate_with_suffix(arel_predicate, suffix)
       if arel_predicate === Proc
         proc { |v| "#{arel_predicate.call(v)}#{suffix}" }

data/lib/ransack/helpers/form_helper.rb

@@ -130,12 +130,20 @@ module Ransack
 
         def url_options
           @params.merge(
-            @options.merge(
+            @options.except(:class).merge(
               @search.context.search_key => search_and_sort_params))
         end
 
         def html_options(args)
-          html_options = extract_options_and_mutate_args!(args)
+          if args.empty?
+            html_options = @options
+          else
+            deprecation_message = "Passing two trailing hashes to `sort_link` is deprecated, merge the trailing hashes into a single one."
+            caller_location = caller_locations(2, 2).first
+            warn "#{deprecation_message} (called at #{caller_location.path}:#{caller_location.lineno})"
+            html_options = extract_options_and_mutate_args!(args)
+          end
+
           html_options.merge(
             class: [['sort_link'.freeze, @current_dir], html_options[:class]]
                    .compact.join(' '.freeze)
@@ -145,7 +153,7 @@ module Ransack
         private
 
           def parameters_hash(params)
-            if ::ActiveRecord::VERSION::MAJOR >= 5 && params.respond_to?(:to_unsafe_h)
+            if params.respond_to?(:to_unsafe_h)
               params.to_unsafe_h
             else
               params

data/lib/ransack/locale/sv.yml

@@ -0,0 +1,70 @@
+sv:
+  ransack:
+    search: "sök"
+    predicate: "predikat"
+    and: "och"
+    or: "eller"
+    any: "vilken som"
+    all: "alla"
+    combinator: "kombinator"
+    attribute: "attribut"
+    value: "värde"
+    condition: "villkor"
+    sort: "sortera"
+    asc: "stigande"
+    desc: "fallande"
+    predicates:
+      eq: "lika med"
+      eq_any: "lika med vilket som"
+      eq_all: "lika med alla"
+      not_eq: "inte lika med"
+      not_eq_any: "inte lika med någon"
+      not_eq_all: "inte lika med alla"
+      matches: "matchar"
+      matches_any: "matchar någon"
+      matches_all: "matchar alla"
+      does_not_match: "matchar inte"
+      does_not_match_any: "matchar inte någon"
+      does_not_match_all: "matchar inte alla"
+      lt: "mindre än"
+      lt_any: "mindre än någon"
+      lt_all: "mindre än alla"
+      lteq: "mindre än eller lika med"
+      lteq_any: "mindre än eller lika med någon"
+      lteq_all: "mindre än eller lika med alla"
+      gt: "större än"
+      gt_any: "större än någon"
+      gt_all: "större än alla"
+      gteq: "större än eller lika med"
+      gteq_any: "större än eller lika med någon"
+      gteq_all: "större än eller lika med alla"
+      in: "i"
+      in_any: "i någon"
+      in_all: "i alla"
+      not_in: "inte i"
+      not_in_any: "inte i någon"
+      not_in_all: "inte i alla"
+      cont: "innehåller"
+      cont_any: "innehåller någon"
+      cont_all: "innehåller alla"
+      not_cont: "innehåller inte"
+      not_cont_any: "innehåller inte någon"
+      not_cont_all: "innehåller inte alla"
+      start: "börjar med"
+      start_any: "börjar med någon"
+      start_all: "börjar med alla"
+      not_start: "börjar inte med"
+      not_start_any: "börjar inte med någon"
+      not_start_all: "börjar inte med alla"
+      end: "slutar med"
+      end_any: "slutar med någon"
+      end_all: "slutar med alla"
+      not_end: "slutar inte med"
+      not_end_any: "slutar inte med någon"
+      not_end_all: "slutar inte med alla"
+      'true': "är sant"
+      'false': "är falskt"
+      present: "existerar"
+      blank: "är tom"
+      'null': "är null"
+      not_null: "är inte null"

data/lib/ransack/nodes/sort.rb

@@ -31,8 +31,8 @@ module Ransack
       end
 
       def name=(name)
-        @name = name
-        context.bind(self, name)
+        @name = context.ransackable_alias(name) || name
+        context.bind(self, @name)
       end
 
       def dir=(dir)

data/lib/ransack/search.rb

@@ -15,10 +15,11 @@ module Ransack
              :translate, :to => :base
 
     def initialize(object, params = {}, options = {})
+      strip_whitespace = options.fetch(:strip_whitespace, Ransack.options[:strip_whitespace])
       params = params.to_unsafe_h if params.respond_to?(:to_unsafe_h)
       if params.is_a? Hash
         params = params.dup
-        params = params.transform_values { |v| v.is_a?(String) ? v.strip : v }
+        params = params.transform_values { |v| v.is_a?(String) && strip_whitespace ? v.strip : v }
         params.delete_if { |k, v| [*v].all?{ |i| i.blank? && i != false } }
       else
         params = {}
@@ -42,10 +43,10 @@ module Ransack
       collapse_multiparameter_attributes!(params).each do |key, value|
         if ['s'.freeze, 'sorts'.freeze].freeze.include?(key)
           send("#{key}=", value)
-        elsif base.attribute_method?(key)
-          base.send("#{key}=", value)
         elsif @context.ransackable_scope?(key, @context.object)
           add_scope(key, value)
+        elsif base.attribute_method?(key)
+          base.send("#{key}=", value)
         elsif !Ransack.options[:ignore_unknown_conditions] || !@ignore_unknown_conditions
           raise ArgumentError, "Invalid search term #{key}"
         end

data/lib/ransack/translate.rb

@@ -32,6 +32,7 @@ module Ransack
         defaults = base_ancestors.map do |klass|
           "ransack.attributes.#{i18n_key(klass)}.#{original_name}".to_sym
         end
+        defaults << options.delete(:default) if options[:default]
 
         translated_names = attribute_names.map do |name|
           attribute_name(context, name, options[:include_associations])
@@ -48,7 +49,6 @@ module Ransack
           defaults << "%{attributes}".freeze
         end
 
-        defaults << options.delete(:default) if options[:default]
         options.reverse_merge! count: 1, default: defaults
         I18n.translate(defaults.shift, **options.merge(interpolations))
       end

data/lib/ransack/version.rb

@@ -1,3 +1,3 @@
 module Ransack
-  VERSION = '2.4.2'
+  VERSION = '3.0.0'
 end

data/ransack.gemspec

@@ -7,16 +7,16 @@ Gem::Specification.new do |s|
   s.name        = "ransack"
   s.version     = Ransack::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Ernie Miller", "Ryan Bigg", "Jon Atack", "Sean Carroll"]
+  s.authors     = ["Ernie Miller", "Ryan Bigg", "Jon Atack", "Sean Carroll", "David Rodríguez"]
   s.email       = ["ernie@erniemiller.org", "radarlistener@gmail.com", "jonnyatack@gmail.com", "sfcarroll@gmail.com"]
   s.homepage    = "https://github.com/activerecord-hackery/ransack"
-  s.summary     = %q{Object-based searching for Active Record and Mongoid (currently).}
+  s.summary     = %q{Object-based searching for Active Record.}
   s.description = %q{Ransack is the successor to the MetaSearch gem. It improves and expands upon MetaSearch's functionality, but does not have a 100%-compatible API.}
   s.required_ruby_version = '>= 2.6'
   s.license     = 'MIT'
 
-  s.add_dependency 'activerecord', '>= 5.2.4'
-  s.add_dependency 'activesupport', '>= 5.2.4'
+  s.add_dependency 'activerecord', '>= 6.0.4'
+  s.add_dependency 'activesupport', '>= 6.0.4'
   s.add_dependency 'i18n'
 
   s.files         = `git ls-files`.split("\n")

data/spec/polyamorous/activerecord_compatibility_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+module Polyamorous
+  describe "ActiveRecord Compatibility" do
+    it 'works with self joins and includes' do
+      trade_account = Account.create!
+      Account.create!(trade_account: trade_account)
+
+      accounts = Account.joins(:trade_account).includes(:trade_account, :agent_account)
+      account = accounts.first
+
+      expect(account.agent_account).to be_nil
+    end
+  end
+end

data/spec/polyamorous/join_association_spec.rb

@@ -12,12 +12,7 @@ module Polyamorous
 
     subject { new_join_association(reflection, parent.children, Person) }
 
-    it 'respects polymorphism on equality test' do
-      expect(subject).to eq new_join_association(reflection, parent.children, Person)
-      expect(subject).not_to eq new_join_association(reflection, parent.children, Article)
-    end
-
-    it 'leaves the orginal reflection intact for thread safety' do
+    it 'leaves the original reflection intact for thread safety' do
       reflection.instance_variable_set(:@klass, Article)
       join_association
       .swapping_reflection_klass(reflection, Person) do |new_reflection|

data/spec/polyamorous/join_dependency_spec.rb

@@ -77,21 +77,5 @@ module Polyamorous
       specify { expect(subject.send(:join_root).drop(1)[1].table_name)
         .to eq 'comments' }
     end
-
-    context '#left_outer_join in Rails 5 overrides join type specified',
-            if: ActiveRecord::VERSION::MAJOR >= 5 && ActiveRecord::VERSION::MAJOR < 6 && ActiveRecord::VERSION::MINOR < 2 do
-
-      let(:join_type_class) do
-        new_join_dependency(
-          Person,
-          new_join(:articles)
-        ).join_constraints(
-          [],
-          Arel::Nodes::OuterJoin
-        ).first.joins.map(&:class)
-      end
-
-      specify { expect(join_type_class).to eq [Arel::Nodes::OuterJoin] }
-    end
   end
 end

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

@@ -8,7 +8,6 @@ module Ransack
         subject { ::ActiveRecord::Base }
 
         it { should respond_to :ransack }
-        it { should respond_to :search }
 
         describe '#search' do
           subject { Person.ransack }
@@ -44,12 +43,12 @@ module Ransack
 
             it 'applies stringy boolean scopes with true value in an array' do
               s = Person.ransack('of_age' => ['true'])
-              expect(s.result.to_sql).to (include 'age >= 18')
+              expect(s.result.to_sql).to (include rails7_and_mysql ? %q{(age >= '18')} : 'age >= 18')
             end
 
             it 'applies stringy boolean scopes with false value in an array' do
               s = Person.ransack('of_age' => ['false'])
-              expect(s.result.to_sql).to (include 'age < 18')
+              expect(s.result.to_sql).to (include rails7_and_mysql ? %q{age < '18'} : 'age < 18')
             end
 
             it 'ignores unlisted scopes' do
@@ -69,15 +68,25 @@ module Ransack
 
             it 'passes values to scopes' do
               s = Person.ransack('over_age' => 18)
-              expect(s.result.to_sql).to (include 'age > 18')
+              expect(s.result.to_sql).to (include rails7_and_mysql ? %q{age > '18'} : 'age > 18')
             end
 
             it 'chains scopes' do
               s = Person.ransack('over_age' => 18, 'active' => true)
-              expect(s.result.to_sql).to (include 'age > 18')
+              expect(s.result.to_sql).to (include rails7_and_mysql ? %q{age > '18'} : 'age > 18')
               expect(s.result.to_sql).to (include 'active = 1')
             end
 
+            it 'applies scopes that define string SQL joins' do
+              allow(Article)
+                .to receive(:ransackable_scopes)
+                .and_return([:latest_comment_cont])
+
+              # Including a negative condition to test removing the scope
+              s = Search.new(Article, notes_note_not_eq: 'Test', latest_comment_cont: 'Test')
+              expect(s.result.to_sql).to include 'latest_comment'
+            end
+
             context "with sanitize_custom_scope_booleans set to false" do
               before(:all) do
                 Ransack.configure { |c| c.sanitize_custom_scope_booleans = false }
@@ -89,12 +98,12 @@ module Ransack
 
               it 'passes true values to scopes' do
                 s = Person.ransack('over_age' => 1)
-                expect(s.result.to_sql).to (include 'age > 1')
+                expect(s.result.to_sql).to (include rails7_and_mysql ? %q{age > '1'} : 'age > 1')
               end
 
               it 'passes false values to scopes'  do
                 s = Person.ransack('over_age' => 0)
-                expect(s.result.to_sql).to (include 'age > 0')
+                expect(s.result.to_sql).to (include rails7_and_mysql ? %q{age > '0'} : 'age > 0')
               end
             end
 
@@ -107,12 +116,12 @@ module Ransack
 
               it 'passes true values to scopes' do
                 s = Person.ransack('over_age' => 1)
-                expect(s.result.to_sql).to (include 'age > 1')
+                expect(s.result.to_sql).to (include rails7_and_mysql ? %q{age > '1'} : 'age > 1')
               end
 
               it 'passes false values to scopes'  do
                 s = Person.ransack('over_age' => 0)
-                expect(s.result.to_sql).to (include 'age > 0')
+                expect(s.result.to_sql).to (include  rails7_and_mysql ? %q{age > '0'} : 'age > 0')
               end
             end
 
@@ -123,7 +132,7 @@ module Ransack
           end
 
           it 'raises exception if ransack! called with unknown condition' do
-            expect { Person.ransack!(unknown_attr_eq: 'Ernie') }.to raise_error
+            expect { Person.ransack!(unknown_attr_eq: 'Ernie') }.to raise_error(ArgumentError)
           end
 
           it 'does not modify the parameters' do
@@ -314,7 +323,11 @@ module Ransack
           end
 
           it 'should function correctly with a multi-parameter attribute' do
-            ::ActiveRecord::Base.default_timezone = :utc
+            if ::ActiveRecord::VERSION::MAJOR >= 7
+              ::ActiveRecord.default_timezone = :utc
+            else
+              ::ActiveRecord::Base.default_timezone = :utc
+            end
             Time.zone = 'UTC'
 
             date = Date.current
@@ -690,6 +703,10 @@ module Ransack
           it { should eq [] }
         end
 
+        private
+        def rails7_and_mysql
+          ::ActiveRecord::VERSION::MAJOR >= 7 && ENV['DB'] == 'mysql'
+        end
       end
     end
   end

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,38 @@ 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 '#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 {