ransack 2.4.1 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c8153add4e8f7cc4123bb1c6b7f8b6f4db1fdbb65c2d8498a61ef7fc98eea53
-  data.tar.gz: 1bae6d37282b621109534060b7c32ecbff7c02366cff88d271d48607ca6fd4cb
+  metadata.gz: 613abc9bb025f01243aa427878dec0cb7e990e3a9deb3e1436b7f0f3b124bf44
+  data.tar.gz: 1466899c236bc6c9d1e95fc5262b5b3d6cde18f51929273168ff3286ead4be34
 SHA512:
-  metadata.gz: ec86fcdc8b81a73c77f3da4e3e9eb2ce7480cae4ce948d64c55d5514d836474fe0c60c727be5d1bca39814afdc96c8bd997e2d245d557689badea217fce67f92
-  data.tar.gz: 6526a66311015b73c4132d7c1b95b2006526cf929c47cb5aec91fc79287f07eb0df85a47d22e47d2b88547796501ce8ecb57c81c044e0113f716e45e516b151d
+  metadata.gz: 2d8f6c96d9b0d4af4d5d64c3aa24cbe79abefe78388ff35637577a46b99b99decf25e51433368634ae557a72707470a9291c62ca33cae15b7ce0edb51b682712
+  data.tar.gz: 66bcf53be5d9f201f0e51db95140a56b29e3d61c0b9d79fbd3238e3e67a2b0bb5463dc08ebf445155d502f1b8bfb87b0be38040521219733a852471f32385e0b

data/.github/workflows/cronjob.yml

@@ -0,0 +1,102 @@
+name: cronjob
+
+on:
+  schedule:
+    - cron: "0 0 * * *"
+
+jobs:
+  sqlite3:
+    runs-on: ubuntu-20.04
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - 3.0.2
+          - 2.7.4
+    env:
+      DB: sqlite3
+      RAILS: main
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rspec
+
+  mysql:
+    runs-on: ubuntu-20.04
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - 3.0.2
+          - 2.7.4
+    env:
+      DB: mysql
+      RAILS: main
+      MYSQL_USERNAME: root
+      MYSQL_PASSWORD: root
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Startup MySQL
+        run: |
+          sudo systemctl start mysql.service
+      - name: Setup databases
+        run: |
+          mysql --user=root --password=root --host=127.0.0.1 -e 'create database ransack collate utf8_general_ci;';
+          mysql --user=root --password=root --host=127.0.0.1 -e 'use ransack;show variables like "%character%";show variables like "%collation%";';
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rspec
+
+  postgres:
+    runs-on: ubuntu-20.04
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - 3.0.2
+          - 2.7.4
+    env:
+      DB: postgres
+      RAILS: main
+      DATABASE_USERNAME: postgres
+      DATABASE_PASSWORD: postgres
+      DATABASE_HOST: 127.0.0.1
+    services:
+      postgres:
+        image: postgres
+        ports:
+          - 5432:5432
+        env:
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_HOST_AUTH_METHOD: trust
+        # Set health checks to wait until postgres has started
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Setup databases
+        run: |
+          psql -h localhost -p 5432 -W postgres -c 'create database ransack;' -U postgres;
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rspec

data/.github/workflows/rubocop.yml

@@ -0,0 +1,20 @@
+name: rubocop
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-20.04
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0.1
+      - name: Install gems
+        run: bundle install --jobs 4 --retry 3
+      - name: Run RuboCop
+        run: bundle exec rubocop --parallel

data/.github/workflows/test.yml

@@ -11,14 +11,17 @@ jobs:
       fail-fast: false
       matrix:
         rails:
-          - v6.1.0.rc2
-          - v6.0.3
+          - v7.0.0
+          - v6.1.4
+          - v6.0.4
           - 6-0-stable
-          - 5-2-stable
-          - v5.2.4
         ruby:
-          - 2.7.2
-          - 2.6.6
+          - 3.0.2
+          - 2.7.4
+          - 2.6.7
+        exclude:
+          - rails:  v7.0.0
+            ruby:   2.6.7
     env:
       DB: sqlite3
       RAILS: ${{ matrix.rails }}
@@ -39,14 +42,17 @@ jobs:
       fail-fast: false
       matrix:
         rails:
-          - v6.1.0.rc2
-          - v6.0.3
+          - v7.0.0
+          - v6.1.4
+          - v6.0.4
           - 6-0-stable
-          - 5-2-stable
-          - v5.2.4
         ruby:
-          - 2.7.2
-          - 2.6.6
+          - 3.0.2
+          - 2.7.4
+          - 2.6.7
+        exclude:
+          - rails:  v7.0.0
+            ruby:   2.6.7
     env:
       DB: mysql
       RAILS: ${{ matrix.rails }}
@@ -76,14 +82,17 @@ jobs:
       fail-fast: false
       matrix:
         rails:
-          - v6.1.0.rc2
-          - v6.0.3
+          - v7.0.0
+          - v6.1.4
+          - v6.0.4
           - 6-0-stable
-          - 5-2-stable
-          - v5.2.4
         ruby:
-          - 2.7.2
-          - 2.6.6
+          - 3.0.2
+          - 2.7.4
+          - 2.6.7
+        exclude:
+          - rails:  v7.0.0
+            ruby:   2.6.7
     env:
       DB: postgres
       RAILS: ${{ matrix.rails }}
@@ -118,3 +127,19 @@ jobs:
         run: bundle install
       - name: Run tests
         run: bundle exec rspec
+
+  bug-report-templates:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0.2
+      - name: Install dependencies
+        run: bundle install
+      - name: Run bug report templates
+        run: |
+          ruby bug_report_templates/test-ransacker-arel-present-predicate.rb
+          ruby bug_report_templates/test-ransack-scope-and-column-same-name.rb
+          rm Gemfile Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,44 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+  DisabledByDefault: true
+
+Layout/EmptyLineAfterMagicComment:
+  Enabled: true
+
+Layout/EmptyLineBetweenDefs:
+  Enabled: true
+
+Layout/EmptyLines:
+  Enabled: true
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+Layout/SpaceInsideParens:
+  Enabled: true
+
+Layout/TrailingEmptyLines:
+  Enabled: true
+
+Style/RedundantFileExtensionInRequire:
+  Enabled: true
+
+Style/RedundantReturn:
+  Enabled: true
+
+Style/SelfAssignment:
+  Enabled: true
+
+Style/Semicolon:
+  Enabled: true
+

data/CHANGELOG.md

@@ -1,14 +1,32 @@
 # 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
 
   *Aaron Lipman*
 
 ## 2.4.0 - 2020-11-27
 
-*
-  PR []()
-
 * Support ActiveRecord 6.1.0.rc1.
   PR [1172](https://github.com/activerecord-hackery/ransack/pull/1172)
 
@@ -199,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

@@ -26,8 +26,8 @@ Steps:
    Ransack and not in your code or another gem.
 
 4. **Report the issue** by providing the link to a self-contained
-   gist like [this](https://gist.github.com/jonatack/63048bc5062a84ba9e09) or
-   [this](https://gist.github.com/jonatack/5df41a0edb53b7bad989). Please use
+   gist like [this](https://github.com/activerecord-hackery/ransack/blob/run_bug_report_templates/bug_report_templates/test-ransack-scope-and-column-same-name.rb) or
+   [this](https://github.com/activerecord-hackery/ransack/blob/run_bug_report_templates/bug_report_templates/test-ransacker-arel-present-predicate.rb). Please use
    these code examples as a bug-report template for your Ransack issue!
 
 If you do not provide a self-contained gist and would like your issue to be reviewed, do provide at a minimum:
@@ -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/Gemfile

@@ -14,8 +14,8 @@ rails_version = case rails
                   rails
                 end
 
-gem 'faker', '~> 1.0'
-gem 'sqlite3', ::Gem::Version.new(rails_version) >= ::Gem::Version.new('6-0-stable') ? '~> 1.4.1' : '~> 1.3.3'
+gem 'faker', '~> 2.0'
+gem 'sqlite3', ::Gem::Version.new(rails_version == 'main' ? '6.2.0.alpha' : rails_version) >= ::Gem::Version.new('6-0-stable') ? '~> 1.4.1' : '~> 1.3.3'
 gem 'pg', '~> 1.0'
 gem 'pry', '~> 0.12.2'
 gem 'byebug'
@@ -49,3 +49,5 @@ group :test do
   gem 'rspec', '~> 3'
   gem 'simplecov', :require => false
 end
+
+gem 'rubocop', require: false

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/bug_report_templates/test-ransack-scope-and-column-same-name.rb

@@ -0,0 +1,78 @@
+# test-ransack-scope-and-column-same-name.rb
+
+# This is a stand-alone test case.
+
+# Run it in your console with: `ruby test-ransack-scope-and-column-same-name.rb`
+
+# If you change the gem dependencies, run it with:
+# `rm gemfile* && ruby test-ransack-scope-and-column-same-name.rb`
+
+unless File.exist?('Gemfile')
+  File.write('Gemfile', <<-GEMFILE)
+    source 'https://rubygems.org'
+
+    # Rails master
+    gem 'rails', github: 'rails/rails', branch: '6-1-stable'
+
+    # Rails last release
+    # gem 'rails'
+
+    gem 'sqlite3'
+    gem 'ransack', github: 'activerecord-hackery/ransack'
+  GEMFILE
+
+  system 'bundle install'
+end
+
+require 'bundler'
+Bundler.setup(:default)
+
+require 'active_record'
+require 'minitest/autorun'
+require 'logger'
+require 'ransack'
+
+# This connection will do for database-independent bug reports.
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+ActiveRecord::Base.logger = Logger.new(STDOUT)
+
+# Display versions.
+message = "Running test case with Ruby #{RUBY_VERSION}, Active Record #{
+  ::ActiveRecord::VERSION::STRING}, Arel #{Arel::VERSION} and #{
+  ::ActiveRecord::Base.connection.adapter_name}"
+line = '=' * message.length
+puts line, message, line
+
+ActiveRecord::Schema.define do
+  create_table :users, force: true do |t|
+    t.boolean :active, null: false, default: true
+  end
+end
+
+class User < ActiveRecord::Base
+  scope :activated, -> (boolean = true) { where(active: boolean) }
+
+  private
+
+  def self.ransackable_scopes(auth_object = nil)
+    %i(activated)
+  end
+end
+
+class BugTest < Minitest::Test
+  def test_activated_scope_equals_true
+    sql = User.ransack({ activated: true }).result.to_sql
+    puts sql
+    assert_equal(
+      "SELECT \"users\".* FROM \"users\" WHERE \"users\".\"active\" = 1", sql
+      )
+  end
+
+  def test_activated_scope_equals_false
+    sql = User.ransack({ activated: false }).result.to_sql
+    puts sql
+    assert_equal(
+      "SELECT \"users\".* FROM \"users\"", sql
+      )
+  end
+end

data/bug_report_templates/test-ransacker-arel-present-predicate.rb

@@ -0,0 +1,71 @@
+# test-ransacker-arel-present-predicate.rb
+
+# Run it in your console with: `ruby test-ransacker-arel-present-predicate.rb`
+
+# If you change the gem dependencies, run it with:
+# `rm gemfile* && ruby test-ransacker-arel-present-predicate.rb`
+
+unless File.exist?('Gemfile')
+  File.write('Gemfile', <<-GEMFILE)
+    source 'https://rubygems.org'
+
+    # Rails master
+    gem 'rails', github: 'rails/rails', branch: '6-1-stable'
+
+    # Rails last release
+    # gem 'rails'
+
+    gem 'sqlite3'
+    gem 'ransack', github: 'activerecord-hackery/ransack'
+  GEMFILE
+
+  system 'bundle install'
+end
+
+require 'bundler'
+Bundler.setup(:default)
+
+require 'active_record'
+require 'minitest/autorun'
+require 'logger'
+require 'ransack'
+
+# This connection will do for database-independent bug reports.
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+ActiveRecord::Base.logger = Logger.new(STDOUT)
+
+# Display versions.
+message = "Running test case with Ruby #{RUBY_VERSION}, Active Record #{
+  ::ActiveRecord::VERSION::STRING}, Arel #{Arel::VERSION} and #{
+  ::ActiveRecord::Base.connection.adapter_name}"
+line = '=' * message.length
+puts line, message, line
+
+ActiveRecord::Schema.define do
+  create_table :projects, force: true do |t|
+    t.string :name
+    t.string :number
+  end
+end
+
+class Project < ActiveRecord::Base
+  ransacker :name do
+    Arel.sql('projects.name')
+  end
+
+  ransacker :number do |parent|
+    parent.table[:number]
+  end
+end
+
+class BugTest < Minitest::Test
+  def test_ransackers
+    sql = Project.ransack({ number_present: 1 }).result.to_sql
+    puts sql
+    assert_equal "SELECT \"projects\".* FROM \"projects\" WHERE (\"projects\".\"number\" IS NOT NULL AND \"projects\".\"number\" != '')", sql
+
+    sql = Project.ransack({ name_present: 1 }).result.to_sql
+    puts sql
+    assert_equal "SELECT \"projects\".* FROM \"projects\" WHERE (projects.name IS NOT NULL AND projects.name != '')", sql
+  end
+end

data/docs/release_process.md

@@ -0,0 +1,17 @@
+## Release Process
+
+*For maintainers of Ransack.*
+
+To release a new version of Ransack and publish it to RubyGems, take the following steps:
+
+- Create a new release, marked `Prerelease`.
+- 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`.
+- From the terminal, run the following commands:
+
+```bash
+rake build
+rake release
+```
+
+![Create a Release](img/create_release.png)