ransack 2.3.2 → 2.5.0

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

@@ -18,6 +18,10 @@ module Ransack
           Search.new(self, params, options)
         end
 
+        def ransack!(params = {}, options = {})
+          ransack(params, options.merge(ignore_unknown_conditions: false))
+        end
+
         def ransacker(name, opts = {}, &block)
           self._ransackers = _ransackers.merge name.to_s => Ransacker
             .new(self, name, opts, &block)
@@ -66,7 +70,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

@@ -1,5 +1,5 @@
 require 'ransack/context'
-require 'polyamorous'
+require 'polyamorous/polyamorous'
 
 module Ransack
   module Adapters
@@ -42,6 +42,17 @@ module Ransack
               if scope_or_sort.is_a?(Symbol)
                 relation = relation.send(scope_or_sort)
               else
+                case Ransack.options[:postgres_fields_sort_option]
+                when :nulls_first
+                  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 ? 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)
               end
             end
@@ -99,7 +110,9 @@ module Ransack
         def join_sources
           base, joins = begin
             alias_tracker = ::ActiveRecord::Associations::AliasTracker.create(self.klass.connection, @object.table.name, [])
-            constraints   = if ::Gem::Version.new(::ActiveRecord::VERSION::STRING) >= ::Gem::Version.new(Constants::RAILS_6_0)
+            constraints   = if ::Gem::Version.new(::ActiveRecord::VERSION::STRING) >= ::Gem::Version.new(Constants::RAILS_6_1)
+              @join_dependency.join_constraints(@object.joins_values, alias_tracker, @object.references_values)
+            elsif ::Gem::Version.new(::ActiveRecord::VERSION::STRING) >= ::Gem::Version.new(Constants::RAILS_6_0)
               @join_dependency.join_constraints(@object.joins_values, alias_tracker)
             else
               @join_dependency.join_constraints(@object.joins_values, @join_type, alias_tracker)
@@ -172,16 +185,31 @@ module Ransack
         private
 
         def extract_correlated_key(join_root)
-          correlated_key = join_root.right.expr.left
-
-          if correlated_key.is_a? Arel::Nodes::And
-            correlated_key = correlated_key.left.left
-          elsif correlated_key.is_a? Arel::Nodes::Equality
-            correlated_key = correlated_key.left
-          elsif correlated_key.is_a? Arel::Nodes::Grouping
-            correlated_key = join_root.right.expr.right.left
+          case join_root
+          when Arel::Nodes::OuterJoin
+            # one of join_root.right/join_root.left is expected to be Arel::Nodes::On
+            if join_root.right.is_a?(Arel::Nodes::On)
+              extract_correlated_key(join_root.right.expr)
+            elsif join_root.left.is_a?(Arel::Nodes::On)
+              extract_correlated_key(join_root.left.expr)
+            else
+              raise 'Ransack encountered an unexpected arel structure'
+            end
+          when Arel::Nodes::Equality
+            pk = primary_key
+            if join_root.left == pk
+              join_root.right
+            elsif join_root.right == pk
+              join_root.left
+            else
+              nil
+            end
+          when Arel::Nodes::And
+            extract_correlated_key(join_root.left) || extract_correlated_key(join_root.right)
           else
-            correlated_key
+            # eg parent was Arel::Nodes::And and the evaluated side was one of
+            # Arel::Nodes::Grouping or MultiTenant::TenantEnforcementClause
+            nil
           end
         end
 
@@ -310,7 +338,11 @@ module Ransack
           @join_dependency.instance_variable_get(:@join_root).children.push found_association
 
           # Builds the arel nodes properly for this association
-          @join_dependency.send(:construct_tables!, jd.instance_variable_get(:@join_root))
+          if ::Gem::Version.new(::ActiveRecord::VERSION::STRING) >= ::Gem::Version.new(Constants::RAILS_6_1)
+            @tables_pot[found_association] = @join_dependency.construct_tables_for_association!(jd.instance_variable_get(:@join_root), found_association)
+          else
+            @join_dependency.send(:construct_tables!, jd.instance_variable_get(:@join_root))
+          end
 
           # Leverage the stashed association functionality in AR
           @object = @object.joins(jd)
@@ -320,12 +352,22 @@ module Ransack
         def extract_joins(association)
           parent = @join_dependency.instance_variable_get(:@join_root)
           reflection = association.reflection
-          join_constraints = association.join_constraints(
+          join_constraints = if ::Gem::Version.new(::ActiveRecord::VERSION::STRING) >= ::Gem::Version.new(Constants::RAILS_6_1)
+                               association.join_constraints_with_tables(
+                                 parent.table,
+                                 parent.base_klass,
+                                 Arel::Nodes::OuterJoin,
+                                 @join_dependency.instance_variable_get(:@alias_tracker),
+                                 @tables_pot[association]
+                               )
+                             else
+                               association.join_constraints(
                                  parent.table,
                                  parent.base_klass,
                                  Arel::Nodes::OuterJoin,
                                  @join_dependency.instance_variable_get(:@alias_tracker)
                                )
+                             end
           join_constraints.to_a.flatten
         end
       end

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

@@ -97,7 +97,7 @@ module Ransack
         arel_predicate: proc { |v| v ? EQ : NOT_EQ },
         compounds: false,
         type: :boolean,
-        validator: proc { |v| BOOLEAN_VALUES.include?(v)},
+        validator: proc { |v| BOOLEAN_VALUES.include?(v) },
         formatter: proc { |v| nil }
         }
       ],

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

@@ -28,6 +28,7 @@ module Ransack
       @join_type = options[:join_type] || Polyamorous::OuterJoin
       @search_key = options[:search_key] || Ransack.options[:search_key]
       @associations_pot = {}
+      @tables_pot = {}
       @lock_associations = []
 
       @base = @join_dependency.instance_variable_get(:@join_root)

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

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

data/lib/ransack/configuration.rb

@@ -33,7 +33,9 @@ module Ransack
       :up_arrow => '▼'.freeze,
       :down_arrow => '▲'.freeze,
       :default_arrow => nil,
-      :sanitize_scope_args => true
+      :sanitize_scope_args => true,
+      :postgres_fields_sort_option => nil,
+      :strip_whitespace => true
     }
 
     def configure
@@ -141,6 +143,21 @@ module Ransack
       self.options[:sanitize_scope_args] = boolean
     end
 
+    # The `NULLS FIRST` and `NULLS LAST` options can be used to determine
+    # whether nulls appear before or after non-null values in the sort ordering.
+    #
+    # User may want to configure it like this:
+    #
+    # Ransack.configure do |c|
+    #   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
+    #
+    def postgres_fields_sort_option=(setting)
+      self.options[:postgres_fields_sort_option] = setting
+    end
+
     # By default, Ransack displays sort order indicator arrows in sort links.
     # The default may be globally overridden in an initializer file like
     # `config/initializers/ransack.rb` as follows:
@@ -154,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/constants.rb

@@ -36,7 +36,7 @@ module Ransack
       'lt'.freeze, 'lteq'.freeze,
       'gt'.freeze, 'gteq'.freeze,
       'in'.freeze, 'not_in'.freeze
-      ].freeze
+    ].freeze
     A_S_I               = ['a'.freeze, 's'.freeze, 'i'.freeze].freeze
 
     EQ                  = 'eq'.freeze
@@ -46,9 +46,9 @@ module Ransack
     CONT                = 'cont'.freeze
 
     RAILS_6_0           = '6.0.0'.freeze
+    RAILS_6_1           = '6.1.0'.freeze
 
     RANSACK_SLASH_SEARCHES = 'ransack/searches'.freeze
     RANSACK_SLASH_SEARCHES_SLASH_SEARCH = 'ransack/searches/search'.freeze
   end
 end
-

data/lib/ransack/helpers/form_builder.rb

@@ -45,9 +45,9 @@ module Ransack
       end
 
       def attribute_select(options = nil, html_options = nil, action = nil)
-        options = options || {}
-        html_options = html_options || {}
-        action = action || Constants::SEARCH
+        options ||= {}
+        html_options ||= {}
+        action ||= Constants::SEARCH
         default = options.delete(:default)
         raise ArgumentError, formbuilder_error_message(
           "#{action}_select") unless object.respond_to?(:context)

data/lib/ransack/helpers.rb

@@ -1,2 +1,2 @@
 require 'ransack/helpers/form_builder'
-require 'ransack/helpers/form_helper'
+require 'ransack/helpers/form_helper'

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/attribute.rb

@@ -30,7 +30,7 @@ module Ransack
 
       def type
         if ransacker
-          return ransacker.type
+          ransacker.type
         else
           context.type_for(self)
         end

data/lib/ransack/nodes/condition.rb

@@ -127,7 +127,6 @@ module Ransack
       alias :m= :combinator=
       alias :m :combinator
 
-
       # == build_attribute
       #
       #  This method was originally called from Nodes::Grouping#new_condition
@@ -263,7 +262,6 @@ module Ransack
         attr.attr
       end
 
-
       def default_type
         predicate.type || (attributes.first && attributes.first.type)
       end

data/lib/ransack/nodes/grouping.rb

@@ -108,7 +108,7 @@ module Ransack
       alias :g= :groupings=
 
       def method_missing(method_id, *args)
-        method_name = method_id.to_s
+        method_name = method_id.to_s.dup
         writer = method_name.sub!(/\=$/, ''.freeze)
         if attribute_method?(method_name)
           if writer

data/lib/ransack/nodes/sort.rb

@@ -9,7 +9,7 @@ module Ransack
       class << self
         def extract(context, str)
           return unless str
-          attr, direction = str.split(/\s+/,2)
+          attr, direction = str.split(/\s+/, 2)
           self.new(context).build(name: attr, dir: direction)
         end
       end
@@ -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/nodes/value.rb

@@ -50,7 +50,7 @@ module Ransack
           y, m, d = *[val].flatten
           m ||= 1
           d ||= 1
-          Date.new(y,m,d) rescue nil
+          Date.new(y, m, d) rescue nil
         end
       end
 

data/lib/ransack/search.rb

@@ -15,9 +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) && strip_whitespace ? v.strip : v }
         params.delete_if { |k, v| [*v].all?{ |i| i.blank? && i != false } }
       else
         params = {}
@@ -29,6 +31,7 @@ module Ransack
         )
       @scope_args = {}
       @sorts ||= []
+      @ignore_unknown_conditions = options[:ignore_unknown_conditions] == false ? false : true
       build(params.with_indifferent_access)
     end
 
@@ -44,7 +47,7 @@ module Ransack
           base.send("#{key}=", value)
         elsif @context.ransackable_scope?(key, @context.object)
           add_scope(key, value)
-        elsif !Ransack.options[:ignore_unknown_conditions]
+        elsif !Ransack.options[:ignore_unknown_conditions] || !@ignore_unknown_conditions
           raise ArgumentError, "Invalid search term #{key}"
         end
       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,9 +49,8 @@ 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))
+        I18n.translate(defaults.shift, **options.merge(interpolations))
       end
 
       def association(key, options = {})
@@ -67,7 +67,7 @@ module Ransack
           end
         defaults << context.traverse(key).model_name.human
         options = { :count => 1, :default => defaults }
-        I18n.translate(defaults.shift, options)
+        I18n.translate(defaults.shift, **options)
       end
 
       private
@@ -83,7 +83,7 @@ module Ransack
         options = { count: 1, default: defaults }
         interpolations = build_interpolations(associated_class)
 
-        I18n.translate(defaults.shift, options.merge(interpolations))
+        I18n.translate(defaults.shift, **options.merge(interpolations))
       end
 
       def default_attribute_name

data/lib/ransack/version.rb

@@ -1,3 +1,3 @@
 module Ransack
-  VERSION = '2.3.2'
+  VERSION = '2.5.0'
 end

data/lib/ransack.rb

@@ -1,13 +1,13 @@
 require 'active_support/core_ext'
 require 'ransack/configuration'
 require 'ransack/adapters'
-require 'polyamorous'
+require 'polyamorous/polyamorous'
 
 Ransack::Adapters.object_mapper.require_constants
 
 module Ransack
   extend Configuration
-  class UntraversableAssociationError < StandardError; end;
+  class UntraversableAssociationError < StandardError; end
 end
 
 Ransack.configure do |config|

data/ransack.gemspec

@@ -1,4 +1,5 @@
 # -*- encoding: utf-8 -*-
+
 $:.push File.expand_path("../lib", __FILE__)
 require "ransack/version"
 
@@ -6,27 +7,20 @@ 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.email       = ["ernie@erniemiller.org", "radarlistener@gmail.com", "jonnyatack@gmail.com","sfcarroll@gmail.com"]
+  s.authors     = ["Ernie Miller", "Ryan Bigg", "Jon Atack", "Sean Carroll"]
+  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.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.3'
+  s.required_ruby_version = '>= 2.6'
   s.license     = 'MIT'
 
-  s.add_dependency 'activerecord', '>= 5.2.1'
-  s.add_dependency 'activesupport', '>= 5.2.1'
+  s.add_dependency 'activerecord', '>= 5.2.4'
+  s.add_dependency 'activesupport', '>= 5.2.4'
   s.add_dependency 'i18n'
-  s.add_dependency 'polyamorous', Ransack::VERSION.to_s
 
   s.files         = `git ls-files`.split("\n")
-
-  s.test_files    = `git ls-files -- {test,spec,features}/*`
-                    .split("\n")
-
-  s.executables   = `git ls-files -- bin/*`
-                    .split("\n")
-                    .map { |f| File.basename(f) }
-
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 end

data/spec/blueprints/articles.rb

@@ -2,4 +2,4 @@ Article.blueprint do
   person
   title
   body
-end
+end

data/spec/blueprints/comments.rb

@@ -2,4 +2,4 @@ Comment.blueprint do
   article
   person
   body
-end
+end

data/spec/blueprints/notes.rb

@@ -2,4 +2,4 @@ Note.blueprint do
   note
   notable_type { "Article" }
   notable_id
-end
+end

data/spec/blueprints/tags.rb

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

data/spec/console.rb

@@ -14,11 +14,11 @@ Sham.define do
   title    { Faker::Lorem.sentence }
   body     { Faker::Lorem.paragraph }
   salary   { |index| 30000 + (index * 1000) }
-  tag_name { Faker::Lorem.words(3).join(' ') }
-  note     { Faker::Lorem.words(7).join(' ') }
-  only_admin  { Faker::Lorem.words(3).join(' ') }
-  only_search { Faker::Lorem.words(3).join(' ') }
-  only_sort   { Faker::Lorem.words(3).join(' ') }
+  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
 

data/spec/helpers/ransack_helper.rb

@@ -6,4 +6,4 @@ module RansackHelper
   def quote_column_name(column)
     ActiveRecord::Base.connection.quote_column_name(column)
   end
-end
+end

data/spec/{ransack → polyamorous}/join_association_spec.rb

@@ -10,7 +10,14 @@ module Polyamorous
       new_join_association(reflection, parent.children, Article)
     }
 
-    it 'leaves the orginal reflection intact for thread safety' do
+    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 original reflection intact for thread safety' do
       reflection.instance_variable_set(:@klass, Article)
       join_association
       .swapping_reflection_klass(reflection, Person) do |new_reflection|