ransack 2.3.0 → 4.1.0

data/lib/ransack/configuration.rb

@@ -27,13 +27,15 @@ module Ransack
     self.predicates = PredicateCollection.new
 
     self.options = {
-      :search_key => :q,
-      :ignore_unknown_conditions => true,
-      :hide_sort_order_indicators => false,
-      :up_arrow => '▼'.freeze,
-      :down_arrow => '▲'.freeze,
-      :default_arrow => nil,
-      :sanitize_scope_args => true
+      search_key: :q,
+      ignore_unknown_conditions: true,
+      hide_sort_order_indicators: false,
+      up_arrow: '▼'.freeze,
+      down_arrow: '▲'.freeze,
+      default_arrow: nil,
+      sanitize_scope_args: true,
+      postgres_fields_sort_option: nil,
+      strip_whitespace: true
     }
 
     def configure
@@ -53,11 +55,11 @@ module Ransack
         compound_name = name + suffix
         self.predicates[compound_name] = Predicate.new(
           opts.merge(
-            :name => compound_name,
-            :arel_predicate => arel_predicate_with_suffix(
+            name: compound_name,
+            arel_predicate: arel_predicate_with_suffix(
               opts[:arel_predicate], suffix
               ),
-            :compound => true
+            compound: true
           )
         )
       end if compounds
@@ -99,6 +101,19 @@ module Ransack
       self.options[:ignore_unknown_conditions] = boolean
     end
 
+    # By default Ransack ignores empty predicates. Ransack can also fallback to
+    # a default predicate by setting it in an initializer file
+    # like `config/initializers/ransack.rb` as follows:
+    #
+    # Ransack.configure do |config|
+    #   # Use the 'eq' predicate if an unknown predicate is passed
+    #   config.default_predicate = 'eq'
+    # end
+    #
+    def default_predicate=(name)
+      self.options[:default_predicate] = name
+    end
+
     # By default, Ransack displays sort order indicator arrows with HTML codes:
     #
     #   up_arrow:   '▼'
@@ -141,6 +156,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 +184,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,13 +45,132 @@ module Ransack
     NOT_EQ_ALL          = 'not_eq_all'.freeze
     CONT                = 'cont'.freeze
 
-    RAILS_5_1           = '5.1'.freeze
-    RAILS_5_2           = '5.2'.freeze
-    RAILS_5_2_0         = '5.2.0'.freeze
-    RAILS_6_0           = '6.0.0'.freeze
-
     RANSACK_SLASH_SEARCHES = 'ransack/searches'.freeze
     RANSACK_SLASH_SEARCHES_SLASH_SEARCH = 'ransack/searches/search'.freeze
+
+    DISTINCT = 'DISTINCT '.freeze
+
+    DERIVED_PREDICATES = [
+      [CONT, {
+        arel_predicate: 'matches'.freeze,
+        formatter: proc { |v| "%#{escape_wildcards(v)}%" }
+        }
+      ],
+      ['not_cont'.freeze, {
+        arel_predicate: 'does_not_match'.freeze,
+        formatter: proc { |v| "%#{escape_wildcards(v)}%" }
+        }
+      ],
+      ['i_cont'.freeze, {
+        arel_predicate: 'matches'.freeze,
+        formatter: proc { |v| "%#{escape_wildcards(v.downcase)}%" },
+        case_insensitive: true
+        }
+      ],
+      ['not_i_cont'.freeze, {
+        arel_predicate: 'does_not_match'.freeze,
+        formatter: proc { |v| "%#{escape_wildcards(v.downcase)}%" },
+        case_insensitive: true
+        }
+      ],
+      ['start'.freeze, {
+        arel_predicate: 'matches'.freeze,
+        formatter: proc { |v| "#{escape_wildcards(v)}%" }
+        }
+      ],
+      ['not_start'.freeze, {
+        arel_predicate: 'does_not_match'.freeze,
+        formatter: proc { |v| "#{escape_wildcards(v)}%" }
+        }
+      ],
+      ['end'.freeze, {
+        arel_predicate: 'matches'.freeze,
+        formatter: proc { |v| "%#{escape_wildcards(v)}" }
+        }
+      ],
+      ['not_end'.freeze, {
+        arel_predicate: 'does_not_match'.freeze,
+        formatter: proc { |v| "%#{escape_wildcards(v)}" }
+        }
+      ],
+      ['true'.freeze, {
+        arel_predicate: proc { |v| v ? EQ : NOT_EQ },
+        compounds: false,
+        type: :boolean,
+        validator: proc { |v| BOOLEAN_VALUES.include?(v) },
+        formatter: proc { |v| true }
+        }
+      ],
+      ['not_true'.freeze, {
+        arel_predicate: proc { |v| v ? NOT_EQ : EQ },
+        compounds: false,
+        type: :boolean,
+        validator: proc { |v| BOOLEAN_VALUES.include?(v) },
+        formatter: proc { |v| true }
+        }
+      ],
+      ['false'.freeze, {
+        arel_predicate: proc { |v| v ? EQ : NOT_EQ },
+        compounds: false,
+        type: :boolean,
+        validator: proc { |v| BOOLEAN_VALUES.include?(v) },
+        formatter: proc { |v| false }
+        }
+      ],
+      ['not_false'.freeze, {
+        arel_predicate: proc { |v| v ? NOT_EQ : EQ },
+        compounds: false,
+        type: :boolean,
+        validator: proc { |v| BOOLEAN_VALUES.include?(v) },
+        formatter: proc { |v| false }
+        }
+      ],
+      ['present'.freeze, {
+        arel_predicate: proc { |v| v ? NOT_EQ_ALL : EQ_ANY },
+        compounds: false,
+        type: :boolean,
+        validator: proc { |v| BOOLEAN_VALUES.include?(v) },
+        formatter: proc { |v| [nil, ''.freeze].freeze }
+        }
+      ],
+      ['blank'.freeze, {
+        arel_predicate: proc { |v| v ? EQ_ANY : NOT_EQ_ALL },
+        compounds: false,
+        type: :boolean,
+        validator: proc { |v| BOOLEAN_VALUES.include?(v) },
+        formatter: proc { |v| [nil, ''.freeze].freeze }
+        }
+      ],
+      ['null'.freeze, {
+        arel_predicate: proc { |v| v ? EQ : NOT_EQ },
+        compounds: false,
+        type: :boolean,
+        validator: proc { |v| BOOLEAN_VALUES.include?(v) },
+        formatter: proc { |v| nil }
+        }
+      ],
+      ['not_null'.freeze, {
+        arel_predicate: proc { |v| v ? NOT_EQ : EQ },
+        compounds: false,
+        type: :boolean,
+        validator: proc { |v| BOOLEAN_VALUES.include?(v) },
+        formatter: proc { |v| nil } }
+      ]
+    ].freeze
+
+  module_function
+    # replace % \ to \% \\
+    def escape_wildcards(unescaped)
+      case ActiveRecord::Base.connection.adapter_name
+      when "Mysql2".freeze
+        # Necessary for MySQL
+        unescaped.to_s.gsub(/([\\%_])/, '\\\\\\1')
+      when "PostgreSQL".freeze
+        # Necessary for PostgreSQL
+        unescaped.to_s.gsub(/([\\%_.])/, '\\\\\\1')
+      else
+        unescaped
+      end
+    end
   end
 end
-

data/lib/ransack/context.rb

@@ -1,19 +1,24 @@
 require 'ransack/visitor'
-Ransack::Adapters.object_mapper.require_context
 
 module Ransack
   class Context
     attr_reader :search, :object, :klass, :base, :engine, :arel_visitor
     attr_accessor :auth_object, :search_key
+    attr_reader :arel_visitor
 
     class << self
 
       def for_class(klass, options = {})
-        raise "not implemented"
+        if klass < ActiveRecord::Base
+          Adapters::ActiveRecord::Context.new(klass, options)
+        end
       end
 
       def for_object(object, options = {})
-        raise "not implemented"
+        case object
+        when ActiveRecord::Relation
+          Adapters::ActiveRecord::Context.new(object.klass, options)
+        end
       end
 
       def for(object, options = {})
@@ -30,11 +35,35 @@ module Ransack
     end # << self
 
     def initialize(object, options = {})
-      raise "not implemented"
+      @object = relation_for(object)
+      @klass = @object.klass
+      @join_dependency = join_dependency(@object)
+      @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)
+    end
+
+    def bind_pair_for(key)
+      @bind_pairs ||= {}
+
+      @bind_pairs[key] ||= begin
+        parent, attr_name = get_parent_and_attribute_name(key.to_s)
+        [parent, attr_name] if parent && attr_name
+      end
     end
 
     def klassify(obj)
-      raise "not implemented"
+      if Class === obj && ::ActiveRecord::Base > obj
+        obj
+      elsif obj.respond_to? :klass
+        obj.klass
+      else
+        raise ArgumentError, "Don't know how to klassify #{obj.inspect}"
+      end
     end
 
     # Convert a string representing a chain of associations and an attribute

data/lib/ransack/helpers/form_builder.rb

@@ -7,17 +7,11 @@ module ActionView::Helpers::Tags
   class Base
     private
     if defined? ::ActiveRecord
-      if ::ActiveRecord::VERSION::STRING < '5.2'
-        def value(object)
-          object.send @method_name if object # use send instead of public_send
-        end
-      else # rails/rails#29791
-        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
+      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
@@ -39,7 +33,7 @@ module Ransack
         text = args.first
         i18n = options[:i18n] || {}
         text ||= object.translate(
-          method, i18n.reverse_merge(:include_associations => true)
+          method, i18n.reverse_merge(include_associations: true)
           ) if object.respond_to? :translate
         super(method, text, options, &block)
       end
@@ -51,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)
@@ -246,7 +240,7 @@ module Ransack
       def get_attribute_element(action, base)
         begin
           [
-            Translate.association(base, :context => object.context),
+            Translate.association(base, context: object.context),
             collection_for_base(action, base)
           ]
         rescue UntraversableAssociationError
@@ -259,7 +253,7 @@ module Ransack
           [
             attr_from_base_and_column(base, c),
             Translate.attribute(
-              attr_from_base_and_column(base, c), :context => object.context
+              attr_from_base_and_column(base, c), context: object.context
             )
           ]
         end

data/lib/ransack/helpers/form_helper.rb

@@ -129,13 +129,21 @@ module Ransack
         end
 
         def url_options
-          @params.merge(
-            @options.merge(
+          @params.except(:host).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
@@ -172,7 +180,8 @@ module Ransack
           end
 
           def search_params
-            @params[@search.context.search_key].presence || {}
+            query_params = @params[@search.context.search_key]
+            query_params.is_a?(Hash) ? query_params : {}
           end
 
           def sort_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/sk.yml

@@ -0,0 +1,70 @@
+sk:
+  ransack:
+    search: "vyhľadávanie"
+    predicate: "predikát"
+    and: "a"
+    or: "alebo"
+    any: "akýkoľvek"
+    all: "každý"
+    combinator: "kombinátor"
+    attribute: "atribút"
+    value: "hodnota"
+    condition: "podmienka"
+    sort: "poradie"
+    asc: "vzostupne"
+    desc: "zostupne"
+    predicates:
+      eq: "sa rovná"
+      eq_any: "sa rovná akémukoľvek"
+      eq_all: "sa rovná všetkým"
+      not_eq: "sa nerovná"
+      not_eq_any: "sa nerovná akémukoľvek"
+      not_eq_all: "sa nerovná všetkým"
+      matches: "zodpovedá"
+      matches_any: "zodpovedá akémukoľvek"
+      matches_all: "zodpovedá všetkým"
+      does_not_match: "nezodpovedá"
+      does_not_match_any: "nezodpovedá akémukoľvek"
+      does_not_match_all: "nezodpovedá všetkým"
+      lt: "menší ako"
+      lt_any: "menší ako akýkoľvek"
+      lt_all: "menší ako všetky"
+      lteq: "menší alebo rovný"
+      lteq_any: "menší alebo rovný akémukoľvek"
+      lteq_all: "menší alebo rovný všetkým"
+      gt: "väčší ako"
+      gt_any: "väčší ako akýkoľvek"
+      gt_all: "väčší ako všetky"
+      gteq: "väčší alebo rovný"
+      gteq_any: "väčší alebo rovný akémukoľvek"
+      gteq_all: "väčší alebo rovný všetkým"
+      in: "v"
+      in_any: "v akejkoľvek"
+      in_all: "vo všetkých"
+      not_in: "nie je v"
+      not_in_any: "nie je v akejkoľvek"
+      not_in_all: "nie je vo všetkých"
+      cont: "obsahuje"
+      cont_any: "obsahuje akúkoľvek"
+      cont_all: "obsahuje všetky"
+      not_cont: "neobsahuje"
+      not_cont_any: "neobsahuje akúkoľvek"
+      not_cont_all: "neobsahuje všetky"
+      start: "začína na"
+      start_any: "začína s akoukoľvek"
+      start_all: "začína so všetkými"
+      not_start: "nezačíná s"
+      not_start_any: "nezačíná s akoukoľvek"
+      not_start_all: "nezačíná so všetkými"
+      end: "končí s"
+      end_any: "končí s akoukoľvek"
+      end_all: "končí so všetkými"
+      not_end: "nekončí s"
+      not_end_any: "nekončí s akoukoľvek"
+      not_end_all: "nekončí so všetkými"
+      'true': "je pravdivé"
+      'false': "nie je pravdivé"
+      present: "je vyplnené"
+      blank: "je prázdne"
+      'null': "je null"
+      not_null: "nie je null"

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

@@ -5,8 +5,8 @@ module Ransack
 
       attr_reader :name, :ransacker_args
 
-      delegate :blank?, :present?, :to => :name
-      delegate :engine, :to => :context
+      delegate :blank?, :present?, to: :name
+      delegate :engine, to: :context
 
       def initialize(context, name = nil, ransacker_args = [])
         super(context)
@@ -30,7 +30,7 @@ module Ransack
 
       def type
         if ransacker
-          return ransacker.type
+          ransacker.type
         else
           context.type_for(self)
         end