ransack 2.4.2 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7e53f2a86ba264e751c3311254c7cb4b25efdb0c876310835b6f6221ab24928
-  data.tar.gz: 161ca5255a24fa42c63d6afbbf38e518581189db773e7e43940b31b1b8d86850
+  metadata.gz: 613abc9bb025f01243aa427878dec0cb7e990e3a9deb3e1436b7f0f3b124bf44
+  data.tar.gz: 1466899c236bc6c9d1e95fc5262b5b3d6cde18f51929273168ff3286ead4be34
 SHA512:
-  metadata.gz: 17c4701dbf3523dfa16feae0dd0dddc8bd077237d7e695eb69664f1b9c5ab5e2fea4a59b5878fe8e607b135ea834f12284f03c42a9ce2971f2f9c9b65d347205
-  data.tar.gz: 4c9d09980609ffc43bc505a947781b9fcdc97efb7897c3bbc3278d8391ab219e4fdffd8a813272a3af7403eefc162fddb6f9f379b713894d3951ff2fc7a141f3
+  metadata.gz: 2d8f6c96d9b0d4af4d5d64c3aa24cbe79abefe78388ff35637577a46b99b99decf25e51433368634ae557a72707470a9291c62ca33cae15b7ce0edb51b682712
+  data.tar.gz: 66bcf53be5d9f201f0e51db95140a56b29e3d61c0b9d79fbd3238e3e67a2b0bb5463dc08ebf445155d502f1b8bfb87b0be38040521219733a852471f32385e0b

data/.github/workflows/cronjob.yml

@@ -11,9 +11,8 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
-          - 3.0.0
-          - 2.7.2
-          - 2.6.6
+          - 3.0.2
+          - 2.7.4
     env:
       DB: sqlite3
       RAILS: main
@@ -34,9 +33,8 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
-          - 3.0.0
-          - 2.7.2
-          - 2.6.6
+          - 3.0.2
+          - 2.7.4
     env:
       DB: mysql
       RAILS: main
@@ -66,9 +64,8 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
-          - 3.0.0
-          - 2.7.2
-          - 2.6.6
+          - 3.0.2
+          - 2.7.4
     env:
       DB: postgres
       RAILS: main

data/.github/workflows/rubocop.yml

@@ -13,7 +13,7 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.0.0
+          ruby-version: 3.0.1
       - name: Install gems
         run: bundle install --jobs 4 --retry 3
       - name: Run RuboCop

data/.github/workflows/test.yml

@@ -11,20 +11,17 @@ jobs:
       fail-fast: false
       matrix:
         rails:
-          - v6.1.1
-          - v6.0.3
+          - v7.0.0
+          - v6.1.4
+          - v6.0.4
           - 6-0-stable
-          - 5-2-stable
-          - v5.2.4
         ruby:
-          - 3.0.0
-          - 2.7.2
-          - 2.6.6
+          - 3.0.2
+          - 2.7.4
+          - 2.6.7
         exclude:
-          - rails:  v5.2.4
-            ruby:   3.0.0
-          - rails:  5-2-stable
-            ruby:   3.0.0
+          - rails:  v7.0.0
+            ruby:   2.6.7
     env:
       DB: sqlite3
       RAILS: ${{ matrix.rails }}
@@ -45,20 +42,17 @@ jobs:
       fail-fast: false
       matrix:
         rails:
-          - v6.1.1
-          - v6.0.3
+          - v7.0.0
+          - v6.1.4
+          - v6.0.4
           - 6-0-stable
-          - 5-2-stable
-          - v5.2.4
         ruby:
-          - 3.0.0
-          - 2.7.2
-          - 2.6.6
+          - 3.0.2
+          - 2.7.4
+          - 2.6.7
         exclude:
-          - rails:  v5.2.4
-            ruby:   3.0.0
-          - rails:  5-2-stable
-            ruby:   3.0.0
+          - rails:  v7.0.0
+            ruby:   2.6.7
     env:
       DB: mysql
       RAILS: ${{ matrix.rails }}
@@ -88,20 +82,17 @@ jobs:
       fail-fast: false
       matrix:
         rails:
-          - v6.1.1
-          - v6.0.3
+          - v7.0.0
+          - v6.1.4
+          - v6.0.4
           - 6-0-stable
-          - 5-2-stable
-          - v5.2.4
         ruby:
-          - 3.0.0
-          - 2.7.2
-          - 2.6.6
+          - 3.0.2
+          - 2.7.4
+          - 2.6.7
         exclude:
-          - rails:  v5.2.4
-            ruby:   3.0.0
-          - rails:  5-2-stable
-            ruby:   3.0.0
+          - rails:  v7.0.0
+            ruby:   2.6.7
     env:
       DB: postgres
       RAILS: ${{ matrix.rails }}
@@ -144,7 +135,7 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.0.0
+          ruby-version: 3.0.2
       - name: Install dependencies
         run: bundle install
       - name: Run bug report templates

data/CHANGELOG.md

@@ -1,7 +1,24 @@
 # Change Log
 
+## Unreleased
+
+## 2.6.0 - 2022-03-08
+
+* Fix regression when joining a table with itself.
+  PR [1275](https://github.com/activerecord-hackery/ransack/pull/1276)
+
+* Drop support for ActiveRecord older than 6.0.4.
+  PR [1276](https://github.com/activerecord-hackery/ransack/pull/1276)
+
+## 2.5.0 - 2021-12-26
+
+* ActiveRecord 7.0 support
+
 * Drop support for rubies under 2.5. PR #1189
 
+* Have casted array predicates type checked to Arel::Nodes::Casted fixing non-casted array predicates.
+  PR [1246](https://github.com/activerecord-hackery/ransack/pull/1246)
+
 ## 2.4.1 - 2020-12-21
 
 * Add `ActiveRecord::Base.ransack!` which raises error if passed unknown condition
@@ -200,7 +217,7 @@
     ignored when block parameter is specified.
     PR [#818](https://github.com/activerecord-hackery/ransack/pull/818).
 
-*   No need pass some arugments to JoinAssociation#join_constraints in Rails 5.1.
+*   No need pass some arguments to JoinAssociation#join_constraints in Rails 5.1.
     PR [#814](https://github.com/activerecord-hackery/ransack/pull/814).
     Fixes [#807](https://github.com/activerecord-hackery/ransack/issues/807).
     Reference [rails/rails#28267](https://github.com/rails/rails/pull/28267)

data/CONTRIBUTING.md

@@ -64,9 +64,7 @@ Here's a quick guide:
 2. Create a thoughtfully-named branch for your changes (`git checkout -b my-new-feature`).
 
 3. Install the development dependencies by running `bundle install`.
-   To install rails other than latest (set in Gemfile): `RAILS='5-2-stable' bundle install`
-
-        $ RAILS='5-2-stable' bundle install
+   To install rails other than latest (set in Gemfile): `RAILS='6-0-stable' bundle install`
 
 4. Begin by running the tests. We only take pull requests with passing tests,
    and it's great to know that you have a clean slate:
@@ -115,6 +113,9 @@ Here's a quick guide:
         $ git config --global user.email "contributor@example.com"
 
 10. Commit your changes (`git commit -am 'Add feature/fix bug/improve docs'`).
+    If your pull request only contains documentation changes, please remember
+    to add `[skip ci]` to the beginning of your commit message so the CI
+    test suite doesn't :runner: needlessly.
 
 11. If necessary, rebase your commits into logical chunks, without errors. To
    interactively rebase and cherry-pick from, say, the last 10 commits:

data/README.md

@@ -11,13 +11,11 @@ Ransack enables the creation of both
 for your Ruby on Rails application
 ([demo source code here](https://github.com/activerecord-hackery/ransack_demo)).
 If you're looking for something that simplifies query generation at the model
-or controller layer, you're probably not looking for Ransack (or MetaSearch,
-for that matter). Try [Squeel](https://github.com/activerecord-hackery/squeel)
-instead.
+or controller layer, you're probably not looking for Ransack.
 
 ## Getting started
 
-Ransack is supported for Rails 6.1, 6.0, 5.2 on Ruby 2.6.6 and later.
+Ransack is supported for Rails 7.0, 6.x on Ruby 2.6.6 and later.
 
 In your Gemfile, for the last officially released gem:
 
@@ -65,19 +63,18 @@ this example, with preloading each Person's Articles and pagination):
 def index
   @q = Person.ransack(params[:q])
   @people = @q.result.includes(:articles).page(params[:page])
-
-  # or use `to_a.uniq` to remove duplicates (can also be done in the view):
-  @people = @q.result.includes(:articles).page(params[:page]).to_a.uniq
 end
 ```
 
-##### Default search parameter
+##### Default search options
+
+**Search parameter**
 
 Ransack uses a default `:q` param key for search params. This may be changed by
 setting the `search_key` option in a Ransack initializer file (typically
 `config/initializers/ransack.rb`):
 
-```
+```ruby
 Ransack.configure do |c|
   # Change default search parameter key name.
   # Default key name is :q
@@ -85,6 +82,19 @@ Ransack.configure do |c|
 end
 ```
 
+**String search**
+
+After version 2.4.0 when searching a string query Ransack by default strips all whitespace around the query string.
+This may be disabled by setting the `strip_whitespace` option in a Ransack initializer file:
+
+```ruby
+Ransack.configure do |c|
+  # Change whitespace stripping behaviour.
+  # Default is true
+  c.strip_whitespace = false
+end
+```
+
 #### In your view
 
 The two primary Ransack view helpers are `search_form_for` and `sort_link`,
@@ -263,8 +273,45 @@ Ransack.configure do |c|
 end
 ```
 
+To treat nulls as having the lowest or highest value respectively. To force nulls to always be first or last, use
+
+```rb
+Ransack.configure do |c|
+  c.postgres_fields_sort_option = :nulls_always_first # or :nulls_always_last
+end
+```
+
 See this feature: https://www.postgresql.org/docs/13/queries-order.html
 
+#### Case Insensitive Sorting in PostgreSQL
+
+In order to request PostgreSQL to do a case insensitive sort for all string columns of a model at once, Ransack can be extended by using this approach:
+
+```ruby
+module RansackObject
+
+  def self.included(base)
+    base.columns.each do |column|
+      if column.type == :string
+        base.ransacker column.name.to_sym, type: :string do
+          Arel.sql("lower(#{base.table_name}.#{column.name})")
+        end
+      end
+    end
+  end
+end
+```
+
+```ruby
+class UserWithManyAttributes < ActiveRecord::Base
+  include RansackObject
+end
+```
+
+If this approach is taken, it is advisable to [add a functional index](https://www.postgresql.org/docs/13/citext.html).
+
+This was originally asked in [a Ransack issue](https://github.com/activerecord-hackery/ransack/issues/1201) and a solution was found on [Stack Overflow](https://stackoverflow.com/a/34677378).
+
 ### Advanced Mode
 
 "Advanced" searches (ab)use Rails' nested attributes functionality in order to
@@ -423,6 +470,25 @@ query parameters in your URLs.
 <% end %>
 ```
 
+You can also use `ransack_alias` for sorting.
+
+```ruby
+class Post < ActiveRecord::Base
+  belongs_to :author
+
+  # Abbreviate :author_first_name to :author
+  ransack_alias :author, :author_first_name
+end
+```
+
+Now, you can use `:author` instead of `:author_first_name` in a `sort_link`.
+
+```erb
+<%= sort_link(@q, :author) %>
+```
+
+Note that using `:author_first_name_or_author_last_name_cont` would produce an invalid sql query. In those cases, Ransack ignores the sorting clause.
+
 ### Search Matchers
 
 List of all possible predicates
@@ -719,7 +785,7 @@ Article.ransack!(unknown_attr_eq: 'Ernie')
 # ArgumentError: Invalid search term unknown_attr_eq
 ```
 
-This is equivilent to the `ignore_unknown_conditions` configuration option,
+This is equivalent to the `ignore_unknown_conditions` configuration option,
 except it may be applied on a case-by-case basis.
 
 ### Using Scopes/Class Methods

data/docs/release_process.md

@@ -5,12 +5,9 @@
 To release a new version of Ransack and publish it to RubyGems, take the following steps:
 
 - Create a new release, marked `Prerelease`.
-<<<<<<< Updated upstream
 - Update the versions file to the new release, commit and push to `master`.
-=======
-- Update the [version.rb](../lib/ransack/version.rb) file to the new release, commit and push to `master`.
->>>>>>> Stashed changes
-- From the terminal, run the following commands
+- Update the [`version.rb`](../lib/ransack/version.rb) file to the new release, commit and push to `master`.
+- From the terminal, run the following commands:
 
 ```bash
 rake build

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

@@ -70,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

@@ -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)

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

@@ -145,7 +145,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 = {}

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 = '2.6.0'
 end