ransack 1.8.4 → 3.2.1

data/lib/ransack/configuration.rb

@@ -5,7 +5,27 @@ module Ransack
   module Configuration
 
     mattr_accessor :predicates, :options
-    self.predicates = {}
+
+    class PredicateCollection
+      attr_reader :sorted_names_with_underscores
+
+      def initialize
+        @collection = {}
+        @sorted_names_with_underscores = []
+      end
+
+      delegate :[], :keys, :has_key?, to: :@collection
+
+      def []=(key, value)
+        @sorted_names_with_underscores << [key, '_' + key]
+        @sorted_names_with_underscores.sort! { |(a, _), (b, _)| b.length <=> a.length }
+
+        @collection[key] = value
+      end
+    end
+
+    self.predicates = PredicateCollection.new
+
     self.options = {
       :search_key => :q,
       :ignore_unknown_conditions => true,
@@ -13,7 +33,9 @@ module Ransack
       :up_arrow => '&#9660;'.freeze,
       :down_arrow => '&#9650;'.freeze,
       :default_arrow => nil,
-      :sanitize_scope_args => true
+      :sanitize_scope_args => true,
+      :postgres_fields_sort_option => nil,
+      :strip_whitespace => true
     }
 
     def configure
@@ -121,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:
@@ -134,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
@@ -45,11 +45,7 @@ module Ransack
     NOT_EQ_ALL          = 'not_eq_all'.freeze
     CONT                = 'cont'.freeze
 
-    RAILS_4_1           = '4.1'.freeze
-    RAILS_5_1           = '5.1'.freeze
-
     RANSACK_SLASH_SEARCHES = 'ransack/searches'.freeze
     RANSACK_SLASH_SEARCHES_SLASH_SEARCH = 'ransack/searches/search'.freeze
   end
 end
-

data/lib/ransack/context.rb

@@ -40,7 +40,7 @@ module Ransack
     # Convert a string representing a chain of associations and an attribute
     # into the attribute itself
     def contextualize(str)
-      parent, attr_name = @bind_pairs[str]
+      parent, attr_name = bind_pair_for(str)
       table_for(parent)[attr_name]
     end
 
@@ -59,31 +59,33 @@ module Ransack
 
     def bind(object, str)
       return nil unless str
-      object.parent, object.attr_name = @bind_pairs[str]
+      object.parent, object.attr_name = bind_pair_for(str)
     end
 
     def traverse(str, base = @base)
       str ||= ''.freeze
-
-      if (segments = str.split(/_/)).size > 0
+      segments = str.split(Constants::UNDERSCORE)
+      unless segments.empty?
         remainder = []
         found_assoc = nil
-        while !found_assoc && segments.size > 0 do
+        until found_assoc || segments.empty?
           # Strip the _of_Model_type text from the association name, but hold
           # onto it in klass, for use as the next base
           assoc, klass = unpolymorphize_association(
-            segments.join('_'.freeze)
-            )
+            segments.join(Constants::UNDERSCORE)
+          )
           if found_assoc = get_association(assoc, base)
             base = traverse(
-              remainder.join('_'.freeze), klass || found_assoc.klass
-              )
+              remainder.join(Constants::UNDERSCORE), klass || found_assoc.klass
+            )
           end
 
           remainder.unshift segments.pop
         end
-        raise UntraversableAssociationError,
-          "No association matches #{str}" unless found_assoc
+        unless found_assoc
+          raise(UntraversableAssociationError,
+                "No association matches #{str}")
+        end
       end
 
       klassify(base)
@@ -93,20 +95,19 @@ module Ransack
       base = klassify(base)
       str ||= ''.freeze
       path = []
-      segments = str.split(/_/)
+      segments = str.split(Constants::UNDERSCORE)
       association_parts = []
-      if (segments = str.split(/_/)).size > 0
-        while segments.size > 0 &&
-        !base.columns_hash[segments.join(Constants::UNDERSCORE)] &&
-        association_parts << segments.shift do
+      unless segments.empty?
+        while !segments.empty? &&
+              !base.columns_hash[segments.join(Constants::UNDERSCORE)] &&
+              association_parts << segments.shift
           assoc, klass = unpolymorphize_association(
             association_parts.join(Constants::UNDERSCORE)
-            )
-          if found_assoc = get_association(assoc, base)
-            path += association_parts
-            association_parts = []
-            base = klassify(klass || found_assoc)
-          end
+          )
+          next unless found_assoc = get_association(assoc, base)
+          path += association_parts
+          association_parts = []
+          base = klassify(klass || found_assoc)
         end
       end
 
@@ -127,7 +128,7 @@ module Ransack
 
     def ransackable_attribute?(str, klass)
       klass.ransackable_attributes(auth_object).include?(str) ||
-      klass.ransortable_attributes(auth_object).include?(str)
+        klass.ransortable_attributes(auth_object).include?(str)
     end
 
     def ransackable_association?(str, klass)
@@ -135,7 +136,11 @@ module Ransack
     end
 
     def ransackable_scope?(str, klass)
-      klass.ransackable_scopes(auth_object).any? { |s| s.to_s == str }
+      klass.ransackable_scopes(auth_object).any? { |s| s.to_sym == str.to_sym }
+    end
+
+    def ransackable_scope_skip_sanitize_args?(str, klass)
+      klass.ransackable_scopes_skip_sanitize_args.any? { |s| s.to_sym == str.to_sym }
     end
 
     def searchable_attributes(str = ''.freeze)

data/lib/ransack/helpers/form_builder.rb

@@ -6,8 +6,14 @@ module ActionView::Helpers::Tags
   # https://github.com/rails/rails/commit/c1a118a
   class Base
     private
-    def value(object)
-      object.send @method_name if object # use send instead of public_send
+    if defined? ::ActiveRecord
+      def value
+        if @allow_method_names_outside_object
+          object.send @method_name if object && object.respond_to?(@method_name, true)
+        else
+          object.send @method_name if object
+        end
+      end
     end
   end
 end
@@ -39,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)
@@ -237,7 +243,7 @@ module Ransack
             Translate.association(base, :context => object.context),
             collection_for_base(action, base)
           ]
-        rescue UntraversableAssociationError => e
+        rescue UntraversableAssociationError
           nil
         end
       end

data/lib/ransack/helpers/form_helper.rb

@@ -130,12 +130,20 @@ module Ransack
 
         def url_options
           @params.merge(
-            @options.merge(
+            @options.except(:class, :data, :host).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/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/ar.yml

@@ -0,0 +1,70 @@
+ar:
+  ransack:
+    search: "بحث"
+    predicate: "فاعل"
+    and: "و"
+    or: "أو"
+    any: "أيُّ"
+    all: "كل"
+    combinator: "دالة توافقية"
+    attribute: "خاصية"
+    value: "قيمة"
+    condition: "شرط"
+    sort: "ترتيب"
+    asc: "تصاعدي"
+    desc: "تنازلي"
+    predicates:
+      eq: "معادل"
+      eq_any: "معادل على اﻷقل لواحد"
+      eq_all: "معادل للجميع"
+      not_eq: "ليس معادلا لـ"
+      not_eq_any: "ليس معادلا على اﻷقل لواحد"
+      not_eq_all: "ليس معادلا للجميع"
+      matches: "موائم"
+      matches_any: "موائم لواحد على اﻷقل"
+      matches_all: "موائم للجميع"
+      does_not_match: "لا يتواءم"
+      does_not_match_any: "لا يتواءم مع واحد على اﻷقل"
+      does_not_match_all: "لا يتواءم مع الجميع"
+      lt: "أصغر من"
+      lt_any: "أصغر لواحد على اﻷقل"
+      lt_all: "أصغر من الجميع"
+      lteq: "أصغر أو مساو لـ"
+      lteq_any: "أصغر أو مساو لواحد على اﻷقل"
+      lteq_all: "أصغر أو مساو للجميع"
+      gt: "أكبر من"
+      gt_any: "أكبر من واحد على اﻷقل"
+      gt_all: "أكبر من الجميع"
+      gteq: "أكبر أو مساو لـ"
+      gteq_any: "أكبر أو مساو لواحد على اﻷقل"
+      gteq_all: "أكبر أو مساو للجميع"
+      in: "متضمن لـ"
+      in_any: "متضمن لواحد على اﻷقل"
+      in_all: "متضمن للجميع"
+      not_in: "غير متضمن"
+      not_in_any: "غير متضمن لواحد على اﻷقل"
+      not_in_all: "غير متضمن للجميع"
+      cont: "محتو"
+      cont_any: "محتو لواحد على اﻷقل"
+      cont_all: "محتو لجميع"
+      not_cont: "غير محتو"
+      not_cont_any: "غير محتو لواحد على اﻷقل"
+      not_cont_all: "غير محتو للجميع"
+      start: "يبدأ بـ"
+      start_any: "يبدأ بواحد على اﻷقل"
+      start_all: "يبدأ بالجميع"
+      not_start: "لا يبدأ بـ"
+      not_start_any: "لا يبدأ بواحد على اﻷقل"
+      not_start_all: "لا يبدأ بالجميع"
+      end: "ينتهي بـ"
+      end_any: "ينتهي بواحد على اﻷقل"
+      end_all: "ينتهي بالجميع"
+      not_end: "لا ينتهي بـ"
+      not_end_any: "لا ينتهي بواحد على اﻷقل"
+      not_end_all: "لا ينتهي بالجميع"
+      'true': "صحيح"
+      'false': "خطأ"
+      present: "مستقبل"
+      blank: "فراغ"
+      'null': "عدم"
+      not_null: "غير مساو لقيمة عدم"

data/lib/ransack/locale/az.yml

@@ -0,0 +1,70 @@
+az:
+  ransack:
+    search: "axtar"
+    predicate: "təsdiqlə"
+    and: "və"
+    or: "və ya"
+    any: "hər hansı"
+    all: "hamısı"
+    combinator: "birləşdirici"
+    attribute: "xüsusiyyət"
+    value: "dəyər"
+    condition: "şərt"
+    sort: "sırala"
+    asc: "artan"
+    desc: "azalan"
+    predicates:
+      eq: "bərabər"
+      eq_any: "hər hansı birinə bərabər"
+      eq_all: "hamısına bərabər"
+      not_eq: "bərabər deyil"
+      not_eq_any: "hər hansı birinə bərabər deyil"
+      not_eq_all: "heç birinə bərabər deyil"
+      matches: "uyğunlaşan"
+      matches_any: "hər hansı biri ilə uyğunlaşan"
+      matches_all: "hamısı ilə uyğunlaşan"
+      does_not_match: "uyğunlaşmayan"
+      does_not_match_any: "hər hansı biri ilə uyğunlaşmayan"
+      does_not_match_all: "heç biri ilə uyğunlaşmayan"
+      lt: "daha kiçik"
+      lt_any: "hər hansı birindən kiçik"
+      lt_all: "hamısından kiçik"
+      lteq: "daha kiçik və ya bərabər"
+      lteq_any: "daha kiçik və ya hər hansı birinə bərabər"
+      lteq_all: "daha kiçik və ya hamısına bərabər"
+      gt: "daha böyük "
+      gt_any: "hər hansı birindən daha böyük"
+      gt_all: "hamısından daha böyük"
+      gteq: "daha böyük və ya bərabər"
+      gteq_any: "daha böyük və ya hər hansı birine bərabər"
+      gteq_all: "daha böyük və ya hamısıne bərabər"
+      in: "içində"
+      in_any: "hər hansı birində"
+      in_all: "hamısında"
+      not_in: "içində deyil"
+      not_in_any: "hər hansı birində deyil"
+      not_in_all: "heç birində deyil"
+      cont: "ehtiva edən"
+      cont_any: "hər hansı birini ehtiva edən"
+      cont_all: "hamısını ehtiva edən"
+      not_cont: "ehtiva etməyən"
+      not_cont_any: "hər hansı birini ehtiva etməyən"
+      not_cont_all: "heç birini birini ehtiva etməyən"
+      start: "ilə başlayan"
+      start_any: "hər hansı biri ilə başlayan"
+      start_all: "hamısı ilə başlayan"
+      not_start: "ilə başlamayan"
+      not_start_any: "hər hansı biri ilə başlamayan"
+      not_start_all: "hiçbiri ilə başlamayan"
+      end: "ilə bitən"
+      end_any: "hər hansı biri ilə bitən"
+      end_all: "hamısı ilə bitən"
+      not_end: "ilə bitməyən"
+      not_end_any: "hər hansı biri ilə bitməyən"
+      not_end_all: "heç biri ilə bitməyən"
+      'true': "doğru"
+      'false': "yanlış"
+      present: "mövcüd"
+      blank: "boş"
+      'null': "keçərsiz"
+      not_null: "keçərli"

data/lib/ransack/locale/bg.yml

@@ -0,0 +1,70 @@
+bg:
+  ransack:
+    search: "търсене"
+    predicate: "предикат"
+    and: "и"
+    or: "или"
+    any: "всякакво"
+    all: "всички"
+    combinator: "комбинатор"
+    attribute: "атрибут"
+    value: "стойност"
+    condition: "условие"
+    sort: "сортиране"
+    asc: "възходящ"
+    desc: "низходящ"
+    predicates:
+      eq: "се равнява на"
+      eq_any: "се равнява на всяко"
+      eq_all: "се равнява на всички"
+      not_eq: "не е равно на"
+      not_eq_any: "не е равно на никое от"
+      not_eq_all: "не е равно на всички"
+      matches: "съвпада"
+      matches_any: "съвпада с някое"
+      matches_all: "съвпада с всички"
+      does_not_match: "не съвпада"
+      does_not_match_any: "не съвпада с никое"
+      does_not_match_all: "не съвпада с всички"
+      lt: "по-малко от"
+      lt_any: "по-малко от някое"
+      lt_all: "по-малко от всички"
+      lteq: "по-малко или равно на"
+      lteq_any: "по-малко или равно на някое"
+      lteq_all: "по-малко или равно на всички"
+      gt: "по-голямо от"
+      gt_any: "по-голямо от всякое"
+      gt_all: "по-голямо от всички"
+      gteq: "по-голямо или равно на"
+      gteq_any: "по-голямо или равно на всякое"
+      gteq_all: "по-голямо или равно на всички"
+      in: "в"
+      in_any: "във всякое"
+      in_all: "във всички"
+      not_in: "не в"
+      not_in_any: "не в никое"
+      not_in_all: "не във всички"
+      cont: "съдържа"
+      cont_any: "съдържа всякое"
+      cont_all: "съдържа всички"
+      not_cont: "не съдържа"
+      not_cont_any: "не съдържа никое"
+      not_cont_all: "не съдържа всички"
+      start: "започва с"
+      start_any: "започва с всякое"
+      start_all: "започва с всички"
+      not_start: "не започва с"
+      not_start_any: "не започва с никое"
+      not_start_all: "не започва с всички"
+      end: "завършва с"
+      end_any: "завършва с всякое"
+      end_all: "завършва с всички"
+      not_end: "не завършва с"
+      not_end_any: "не завършва с никое"
+      not_end_all: "не завършва с всички"
+      'true': "истина"
+      'false': "неистина"
+      present: "присъства"
+      blank: "е празно"
+      'null': "е нула"
+      not_null: "не е нула"

data/lib/ransack/locale/ca.yml

@@ -0,0 +1,70 @@
+ca:
+  ransack:
+    search: "cercar"
+    predicate: "predicat"
+    and: "i"
+    or: "o"
+    any: "qualsevol"
+    all: "tots"
+    combinator: "combinador"
+    attribute: "atribut"
+    value: "valor"
+    condition: "condició"
+    sort: "ordenar"
+    asc: "ascendent"
+    desc: "descendent"
+    predicates:
+      eq: "és igual a"
+      eq_any: "és igual a qualsevol"
+      eq_all: "és igual a tots"
+      not_eq: "no és igual a"
+      not_eq_any: "no és igual a qualsevol"
+      not_eq_all: "no és igual a tots"
+      matches: "coincideix"
+      matches_any: "coincideix a qualsevol"
+      matches_all: "coincideix a tots"
+      does_not_match: "no coincideix"
+      does_not_match_any: "no coincideix amb cap"
+      does_not_match_all: "no coincideix amb tots"
+      lt: "menor que"
+      lt_any: "menor que qualsevol"
+      lt_all: "menor o igual a"
+      lteq: "menor que o igual a"
+      lteq_any: "menor o igual a qualsevol"
+      lteq_all: "menor o igual a tots"
+      gt: "major que"
+      gt_any: "major que qualsevol"
+      gt_all: "major que tots"
+      gteq: "major que o igual a"
+      gteq_any: "major que o igual a qualsevol"
+      gteq_all: "major que o igual a tots"
+      in: "en"
+      in_any: "en qualsevol"
+      in_all: "en tots"
+      not_in: "no en"
+      not_in_any: "no en qualsevol"
+      not_in_all: "no en tots"
+      cont: "conté"
+      cont_any: "conté qualsevol"
+      cont_all: "conté tots"
+      not_cont: "no conté"
+      not_cont_any: "no conté cap"
+      not_cont_all: "no conté tota"
+      start: "comença per"
+      start_any: "comença per qualsevol"
+      start_all: "comença per tot"
+      not_start: "no comença per"
+      not_start_any: "no comença per qualsevol"
+      not_start_all: "no comença per tot"
+      end: "acaba en"
+      end_any: "acaba en qualsevol"
+      end_all: "acaba en tot"
+      not_end: "no acaba en"
+      not_end_any: "no acaba en qualsevol"
+      not_end_all: "no acaba en tot"
+      'true': "és verdader"
+      'false': "és fals"
+      present: "és present"
+      blank: "està en blanc"
+      'null': "és nul"
+      not_null: "no és nul"

data/lib/ransack/locale/el.yml

@@ -0,0 +1,70 @@
+el:
+  ransack:
+    search: "αναζήτηση"
+    predicate: "κατηγορούμενο"
+    and: "και"
+    or: "ή"
+    any: "οποιοδήποτε"
+    all: "όλα"
+    combinator: "συνδυαστής"
+    attribute: "ιδιότητα"
+    value: "τιμή"
+    condition: "συνθήκη"
+    sort: "ταξινόμηση"
+    asc: "αύξουσα"
+    desc: "φθίνουσα"
+    predicates:
+      eq: "ίσον"
+      eq_any: "ισούται με οποιοδήποτε"
+      eq_all: "ισούται με όλα"
+      not_eq: "άνισο"
+      not_eq_any: "άνισο με οποιοδήποτε"
+      not_eq_all: "άνισο με όλα"
+      matches: "αντιστοιχεί"
+      matches_any: "αντιστοιχεί με οποιοδήποτε"
+      matches_all: "αντιστοιχεί με όλα"
+      does_not_match: "δεν αντιστοιχεί"
+      does_not_match_any: "δεν αντιστοιχεί με οποιοδήποτε"
+      does_not_match_all: "δεν αντιστοιχεί με όλα"
+      lt: "μικρότερο από"
+      lt_any: "μικρότερο από οποιοδήποτε"
+      lt_all: "μικρότερο από όλα"
+      lteq: "μικρότερο ή ίσον"
+      lteq_any: "μικρότερο ή ίσον από οποιοδήποτε"
+      lteq_all: "μικρότερο ή ίσον από όλα"
+      gt: "μεγαλύτερο από"
+      gt_any: "μεγαλύτερο από οποιοδήποτε"
+      gt_all: μεγαλύτερο από όλα"
+      gteq: "μεγαλύτερο ή ίσον από"
+      gteq_any: "μεγαλύτερο ή ίσον από οποιοδήποτε"
+      gteq_all: "μεγαλύτερο ή ίσον από όλα"
+      in: "περιέχεται"
+      in_any: "περιέχεται σε οποιοδήποτε"
+      in_all: "περιέχεται σε όλα"
+      not_in: "δεν περιέχεται"
+      not_in_any: "δεν περιέχεται σε οποιοδήποτε"
+      not_in_all: "δεν περιέχεται σε όλα"
+      cont: "περιέχει"
+      cont_any: "περιέχει οποιοδήποτε"
+      cont_all: "περιέχει όλα"
+      not_cont: "δεν περιέχει"
+      not_cont_any: "δεν περιέχει οποιοδήποτε"
+      not_cont_all: "δεν περιέχει όλα"
+      start: "αρχίζει με"
+      start_any: "αρχίζει με οποιοδήποτε"
+      start_all: "αρχίζει με όλα"
+      not_start: "δεν αρχίζει με"
+      not_start_any: "δεν αρχίζει με οποιοδήποτε"
+      not_start_all: "δεν αρχίζει με όλα"
+      end: "τελειώνει με"
+      end_any: "τελειώνει οποιοδήποτε"
+      end_all: "τελειώνει με όλα"
+      not_end: "δεν τελειώνει με"
+      not_end_any: "δεν τελειώνει οποιοδήποτε"
+      not_end_all: "δεν τελειώνει με όλα"
+      'true': "αληθές"
+      'false': "ψευδές"
+      present: "υπάρχει"
+      blank: "είναι κενό"
+      'null': "άκυρο"
+      not_null: "δεν είναι άκυρο"