ransack 4.3.0 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ea2c1ef5d55f6a67d7d182146f2274d9b4343285920ae69bec3a5902fa4bf14
-  data.tar.gz: db7e3f5f6ae62d9bebc8ac65bc9a50bc451585abd69e88aca20012c6777fbae6
+  metadata.gz: 4fe4a128cacdb920f2efe5fc5063cd21b8fa1a4a527fa07e84123f2ead7a6694
+  data.tar.gz: 82f66ffeaa4d8bed52614374fe71617bb1c2d85ac1745dfca7e4520e07782545
 SHA512:
-  metadata.gz: 8c89ea0cb39b675a116b8c9698acbe106a24415e107435b4035c837e921dc359c77f7806415f9008e76dcaf658b888a02c8df137fd6295b71c1d445feb1846fc
-  data.tar.gz: 197c2f53ab0e98d7a24203fafb81187a44235c2536734ee0976bb78d2e9a552f3cf309d5a06ef5704bd8f4ece49931ad7517defa603067d1a113b230f5554681
+  metadata.gz: a80ce4b0da981c6e3b2d18de8c742d3598a2a7479b44d04adaa1ce3c60a81fa4377f706c78048c1d72f719d488afd379c303b55811053d8613eb82cf0f0dfcad
+  data.tar.gz: cd3f836f63aa19596a3510961bbe64a1f9abcc858473bf9516623e5fe76908bcbb346d36cf1cd7cb83094f0a3c0f4bcdb942b0e137a9020cd8772e28d01d9f51

data/README.md

@@ -33,9 +33,11 @@ gem 'ransack', :github => 'activerecord-hackery/ransack', :branch => 'main'
 
 ### Documentation
 
-There is [extensive documentation on Ransack](https://activerecord-hackery.github.io/ransack/), which is a [Docusaurus](https://docusaurus.io/) project and run as a GitHub Pages site.
+There is [extensive documentation on Ransack](https://activerecord-hackery.github.io/ransack/), which is a [Docusaurus](https://docusaurus.io/) project and run as a GitHub Pages site. Alternatively there is [AI Generated documentation](https://deepwiki.com/activerecord-hackery/ransack/1-overview) produced by [devin.ai](https://devin.ai/).
 
-## Issues tracker
+This [gist](https://gist.github.com/raghubetina/d5fc3df67ddbadcac271) has a quick-start cheatsheet, created by [@raghubetina](https://gist.github.com/raghubetina)
+
+## Issue tracker
 
 * Before filing an issue, please read the [Contributing Guide](CONTRIBUTING.md).
 * File an issue if a bug is caused by Ransack, is new (has not already been reported), and _can be reproduced from the information you provide_.

data/lib/polyamorous/polyamorous.rb

@@ -1,4 +1,4 @@
-if defined?(::ActiveRecord)
+ActiveSupport.on_load(:active_record) do
   module Polyamorous
     InnerJoin = Arel::Nodes::InnerJoin
     OuterJoin = Arel::Nodes::OuterJoin

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

@@ -19,7 +19,8 @@ module Ransack
           unless schema_cache.send(:data_source_exists?, table)
             raise "No table named #{table} exists."
           end
-          attr.klass.columns.find { |column| column.name == name }.type
+          column = attr.klass.columns.find { |column| column.name == name }
+          column&.type
         end
 
         def evaluate(search, opts = {})
@@ -171,7 +172,25 @@ module Ransack
           join_constraints.each do |j|
             subquery.join_sources << Arel::Nodes::InnerJoin.new(j.left, j.right)
           end
-          subquery.where(correlated_key.eq(primary_key))
+
+          # Handle polymorphic associations where correlated_key is an array
+          if correlated_key.is_a?(Array)
+            # For polymorphic associations, we need to add conditions for both the foreign key and type
+            correlated_key.each_with_index do |key, index|
+              if index == 0
+                # This is the foreign key
+                subquery = subquery.where(key.eq(primary_key))
+              else
+                # This is the type key, which should be equal to the model name
+                subquery = subquery.where(key.eq(@klass.name))
+              end
+            end
+          else
+            # Original behavior for non-polymorphic associations
+            subquery = subquery.where(correlated_key.eq(primary_key))
+          end
+
+          subquery
         end
 
         def primary_key
@@ -201,7 +220,15 @@ module Ransack
               nil
             end
           when Arel::Nodes::And
-            extract_correlated_key(join_root.left) || extract_correlated_key(join_root.right)
+            # And may have multiple children, so we need to check all, not via left/right
+            if join_root.children.any?
+              join_root.children.each do |child|
+                key = extract_correlated_key(child)
+                return key if key
+              end
+            else
+              extract_correlated_key(join_root.left) || extract_correlated_key(join_root.right)
+            end
           else
             # eg parent was Arel::Nodes::And and the evaluated side was one of
             # Arel::Nodes::Grouping or MultiTenant::TenantEnforcementClause

data/lib/ransack/context.rb

@@ -77,6 +77,9 @@ module Ransack
       return unless @klass.method(scope) && args != false
       @object = if scope_arity(scope) < 1 && args == true
                   @object.public_send(scope)
+                elsif scope_arity(scope) == 1 && args.is_a?(Array)
+                  # For scopes with arity 1, pass the array as a single argument instead of splatting
+                  @object.public_send(scope, args)
                 else
                   @object.public_send(scope, *args)
                 end

data/lib/ransack/helpers/form_builder.rb

@@ -6,13 +6,12 @@ module ActionView::Helpers::Tags
   # https://github.com/rails/rails/commit/c1a118a
   class Base
     private
-    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
+
+    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

data/lib/ransack/helpers/form_helper.rb

@@ -7,30 +7,48 @@ module Ransack
       #   <%= search_form_for(@q) do |f| %>
       #
       def search_form_for(record, options = {}, &proc)
-        if record.is_a? Ransack::Search
-          search = record
-          options[:url] ||= polymorphic_path(
-            search.klass, format: options.delete(:format)
-            )
-        elsif record.is_a?(Array) &&
-        (search = record.detect { |o| o.is_a?(Ransack::Search) })
-          options[:url] ||= polymorphic_path(
-            options_for(record), format: options.delete(:format)
-            )
+        search = extract_search_and_set_url(record, options, 'search_form_for')
+        options[:html] ||= {}
+        html_options = build_html_options(search, options, :get)
+        finalize_form_options(options, html_options)
+        form_for(record, options, &proc)
+      end
+
+      # +search_form_with+
+      #
+      #   <%= search_form_with(model: @q) do |f| %>
+      #
+      def search_form_with(record_or_options = {}, options = {}, &proc)
+        if record_or_options.is_a?(Hash) && record_or_options.key?(:model)
+          # Called with keyword arguments: search_form_with(model: @q)
+          options = record_or_options
+          record = options.delete(:model)
         else
-          raise ArgumentError,
-          'No Ransack::Search object was provided to search_form_for!'
+          # Called with positional arguments: search_form_with(@q)
+          record = record_or_options
         end
+        search = extract_search_and_set_url(record, options, 'search_form_with')
         options[:html] ||= {}
-        html_options = {
-          class:  html_option_for(options[:class], search),
-          id:     html_option_for(options[:id], search),
-          method: :get
-        }
-        options[:as] ||= Ransack.options[:search_key]
-        options[:html].reverse_merge!(html_options)
-        options[:builder] ||= FormBuilder
+        html_options = build_html_options(search, options, :get)
+        finalize_form_with_options(options, html_options)
+        form_with(model: search, **options, &proc)
+      end
 
+      # +turbo_search_form_for+
+      #
+      #   <%= turbo_search_form_for(@q) do |f| %>
+      #
+      # This is a turbo-enabled version of search_form_for that submits via turbo streams
+      # instead of traditional HTML GET requests. Useful for seamless integration with
+      # paginated results and other turbo-enabled components.
+      #
+      def turbo_search_form_for(record, options = {}, &proc)
+        search = extract_search_and_set_url(record, options, 'turbo_search_form_for')
+        options[:html] ||= {}
+        turbo_options = build_turbo_options(options)
+        method = options.delete(:method) || :post
+        html_options = build_html_options(search, options, method).merge(turbo_options)
+        finalize_form_options(options, html_options)
         form_for(record, options, &proc)
       end
 
@@ -68,6 +86,54 @@ module Ransack
 
       private
 
+        def extract_search_and_set_url(record, options, method_name)
+          if record.is_a? Ransack::Search
+            search = record
+            options[:url] ||= polymorphic_path(
+              search.klass, format: options.delete(:format)
+            )
+            search
+          elsif record.is_a?(Array) &&
+          (search = record.detect { |o| o.is_a?(Ransack::Search) })
+            options[:url] ||= polymorphic_path(
+              options_for(record), format: options.delete(:format)
+            )
+            search
+          else
+            raise ArgumentError,
+            "No Ransack::Search object was provided to #{method_name}!"
+          end
+        end
+
+        def build_turbo_options(options)
+          data_options = {}
+          if options[:turbo_frame]
+            data_options[:turbo_frame] = options.delete(:turbo_frame)
+          end
+          data_options[:turbo_action] = options.delete(:turbo_action) || 'advance'
+          { data: data_options }
+        end
+
+        def build_html_options(search, options, method)
+          {
+            class:  html_option_for(options[:class], search),
+            id:     html_option_for(options[:id], search),
+            method: method
+          }
+        end
+
+        def finalize_form_options(options, html_options)
+          options[:as] ||= Ransack.options[:search_key]
+          options[:html].reverse_merge!(html_options)
+          options[:builder] ||= FormBuilder
+        end
+
+        def finalize_form_with_options(options, html_options)
+          options[:scope] ||= Ransack.options[:search_key]
+          options[:html].reverse_merge!(html_options)
+          options[:builder] ||= FormBuilder
+        end
+
         def options_for(record)
           record.map { |r| parse_record(r) }
         end

data/lib/ransack/locale/ja.yml

@@ -14,57 +14,57 @@ ja:
     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: "は以下の全てで終わらない"
+      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: "は空である"
+      present: "存在する"
+      blank: "空である"
       'null': "無効"
-      not_null: "は無効ではない"
+      not_null: "無効ではない"

data/lib/ransack/locale/ko.yml

@@ -62,9 +62,9 @@ ko:
       not_end: "끝나지 않음"
       not_end_any: "어떤 것이든 끝나지 않음"
       not_end_all: "모두 끝나지 않음"
-      'true': "is true"
-      'false': "is false"
-      present: "is present"
-      blank: "is blank"
-      'null': "is null"
-      not_null: "is not null"
+      'true': "참"
+      'false': "거짓"
+      present: "존재함"
+      blank: "비어있음"
+      'null': "널"
+      not_null: "널이 아님"

data/lib/ransack/locale/uk.yml

@@ -0,0 +1,72 @@
+# Інші переклади на https://github.com/activerecord-hackery/ransack/blob/main/lib/ransack/locale
+#
+uk:
+  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/nodes/condition.rb

@@ -226,7 +226,7 @@ module Ransack
       end
 
       def casted_values_for_attribute(attr)
-        validated_values.map { |v| v.cast(predicate.type || attr.type) }
+        validated_values.map(&:cast_array)
       end
 
       def formatted_values_for_attribute(attr)
@@ -235,6 +235,9 @@ module Ransack
             val = attr.ransacker.formatter.call(val)
           end
           val = predicate.format(val)
+          if val.is_a?(String) && val.include?('%')
+            val = Arel::Nodes::Quoted.new(val)
+          end
           val
         end
         if predicate.wants_array
@@ -288,12 +291,24 @@ module Ransack
       def arel_predicate
         predicate = attributes.map { |attribute|
           association = attribute.parent
-          if negative? && attribute.associated_collection?
+          parent_table = association.table
+
+          if negative? && attribute.associated_collection? && not_nested_condition(attribute, parent_table)
             query = context.build_correlated_subquery(association)
             context.remove_association(association)
-            if self.predicate_name == 'not_null' && self.value
-              query.where(format_predicate(attribute))
-              Arel::Nodes::In.new(context.primary_key, Arel.sql(query.to_sql))
+
+            case self.predicate_name
+            when 'not_null'
+              if self.value
+                query.where(format_predicate(attribute))
+                Arel::Nodes::In.new(context.primary_key, Arel.sql(query.to_sql))
+              else
+                query.where(format_predicate(attribute).not)
+                Arel::Nodes::NotIn.new(context.primary_key, Arel.sql(query.to_sql))
+              end
+            when 'not_cont'
+              query.where(attribute.attr.matches(formatted_values_for_attribute(attribute)))
+              Arel::Nodes::NotIn.new(context.primary_key, Arel.sql(query.to_sql))
             else
               query.where(format_predicate(attribute).not)
               Arel::Nodes::NotIn.new(context.primary_key, Arel.sql(query.to_sql))
@@ -315,6 +330,10 @@ module Ransack
         predicate
       end
 
+      def not_nested_condition(attribute, parent_table)
+        parent_table.class != Arel::Nodes::TableAlias && attribute.name.starts_with?(parent_table.name)
+      end
+
       private
 
       def combinator_method
@@ -324,6 +343,13 @@ module Ransack
       def format_predicate(attribute)
         arel_pred = arel_predicate_for_attribute(attribute)
         arel_values = formatted_values_for_attribute(attribute)
+        
+        # For LIKE predicates, wrap the value in Arel::Nodes.build_quoted to prevent
+        # ActiveRecord normalization from affecting wildcard patterns
+        if like_predicate?(arel_pred)
+          arel_values = Arel::Nodes.build_quoted(arel_values)
+        end
+        
         predicate = attr_value_for_attribute(attribute).public_send(arel_pred, arel_values)
 
         if in_predicate?(predicate)
@@ -340,8 +366,12 @@ module Ransack
         predicate.class == Arel::Nodes::In || predicate.class == Arel::Nodes::NotIn
       end
 
+      def like_predicate?(arel_predicate)
+        arel_predicate == 'matches' || arel_predicate == 'does_not_match'
+      end
+
       def casted_array?(predicate)
-        predicate.value.is_a?(Array) && predicate.is_a?(Arel::Nodes::Casted)
+        predicate.is_a?(Arel::Nodes::Casted) && predicate.value.is_a?(Array)
       end
 
       def format_values_for(predicate)

data/lib/ransack/nodes/grouping.rb

@@ -53,7 +53,7 @@ module Ransack
       end
 
       def []=(key, value)
-        conditions.reject! { |c| c.key == key.to_s }
+        conditions.reject! { |c| c.key == key.to_s && c&.value == value&.value }
         self.conditions << value
       end
 

data/lib/ransack/nodes/sort.rb

@@ -8,7 +8,7 @@ module Ransack
 
       class << self
         def extract(context, str)
-          return unless str
+          return if str.blank?
           attr, direction = str.split(/\s+/, 2)
           self.new(context).build(name: attr, dir: direction)
         end

data/lib/ransack/nodes/value.rb

@@ -43,6 +43,14 @@ module Ransack
         end
       end
 
+      def cast_array
+        if value.is_a?(Array)
+          cast_to_date(value)
+        else
+          value
+        end
+      end
+
       def cast_to_date(val)
         if val.respond_to?(:to_date)
           val.to_date rescue nil
@@ -80,7 +88,7 @@ module Ransack
       end
 
       def cast_to_integer(val)
-        val.blank? ? nil : val.to_i
+        val.respond_to?(:to_i) && !val.blank? ? val.to_i : nil
       end
 
       def cast_to_float(val)

data/lib/ransack/search.rb

@@ -69,7 +69,7 @@ module Ransack
           else
             sort = Nodes::Sort.extract(@context, sort)
           end
-          self.sorts << sort
+          self.sorts << sort if sort
         end
       when Hash
         args.each do |index, attrs|

data/lib/ransack/version.rb

@@ -1,3 +1,3 @@
 module Ransack
-  VERSION = '4.3.0'
+  VERSION = '4.4.0'
 end

data/lib/ransack.rb

@@ -1,3 +1,11 @@
+require 'active_support/dependencies/autoload'
+require 'active_support/deprecation'
+require 'active_support/version'
+
+if ::ActiveSupport.version >= ::Gem::Version.new("7.1")
+  require 'active_support/deprecator'
+end
+
 require 'active_support/core_ext'
 require 'ransack/configuration'
 require 'polyamorous/polyamorous'

data/spec/polyamorous/join_association_spec.rb

@@ -2,7 +2,6 @@ require 'spec_helper'
 
 module Polyamorous
   describe JoinAssociation do
-
     let(:join_dependency) { new_join_dependency Note, {} }
     let(:reflection) { Note.reflect_on_association(:notable) }
     let(:parent) { join_dependency.send(:join_root) }

data/spec/polyamorous/join_dependency_spec.rb

@@ -2,7 +2,6 @@ require 'spec_helper'
 
 module Polyamorous
   describe JoinDependency do
-
     context 'with symbol joins' do
       subject { new_join_dependency Person, articles: :comments }