ransack 3.0.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 400fa6bc00b27207224ee94101cd526a602076669e1824c605e9897d3fd6ba7c
-  data.tar.gz: df6443d69d67e1a59ab97378784c8ddbb3966d3dd6376e3362bacae0afea72c6
+  metadata.gz: 3f37dfefd63333903d6b36084a8dda1193ca31788777b2645d25b96dd97d2d2c
+  data.tar.gz: dba86f7268c931801e1caf32f3552ebfeecc06fec2f773130118cc2c809c61e9
 SHA512:
-  metadata.gz: e620b446afd597cfa16e20be2f20d762791d496cd24ec3441f8553697b81a0ac50280da1ec07a068962f06937cfb7fdbaeeab33dd17fbdb0233226cd42f95d6a
-  data.tar.gz: 30b74e2d17fbb7e215ff60a129f1bf4af779e0b1d6d62865e1d8dfb8b9215d6a06f0008f1704e6fb25ab83e25dafa0f2fa219c57588eafe5260b14a0f9c5f0f0
+  metadata.gz: 7c8364c70e6536c5aa5dca37c5539164d89dab6fb9e582501dbf5611ff4a647aa0b5ff69450a0b4d480de4d61e62708b3c376ffb6813c0f06ff6b0a591c670f6
+  data.tar.gz: 4681b4c7f4e03002b968e165abf930a6b42dfc1e4d740a0bb8a034a9c805b1f956d6f82ab5ca0e39117a8a08b8899b849e34ccf665ac5f7c36fd1aec83ebe3e5

data/.github/workflows/deploy.yml

@@ -0,0 +1,35 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    name: Deploy to GitHub Pages
+
+    runs-on: ubuntu-20.04
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          cache: yarn
+          cache-dependency-path: docs/yarn.lock
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+        working-directory: docs
+
+      - name: Build website
+        run: yarn build
+        working-directory: docs
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/build

data/.github/workflows/test-deploy.yml

@@ -0,0 +1,29 @@
+name: Test deploy to GitHub Pages
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test-deploy:
+    name: Test deploy to GitHub Pages
+
+    runs-on: ubuntu-20.04
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          cache: yarn
+          cache-dependency-path: docs/yarn.lock
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+        working-directory: docs
+
+      - name: Test build website
+        run: yarn build
+        working-directory: docs

data/.github/workflows/test.yml

@@ -11,17 +11,12 @@ jobs:
       fail-fast: false
       matrix:
         rails:
-          - v7.0.0
-          - v6.1.4
-          - v6.0.4
-          - 6-0-stable
+          - v7.0.2
+          - v6.1.5
         ruby:
+          - 3.1.1
           - 3.0.2
           - 2.7.4
-          - 2.6.7
-        exclude:
-          - rails:  v7.0.0
-            ruby:   2.6.7
     env:
       DB: sqlite3
       RAILS: ${{ matrix.rails }}
@@ -42,17 +37,12 @@ jobs:
       fail-fast: false
       matrix:
         rails:
-          - v7.0.0
-          - v6.1.4
-          - v6.0.4
-          - 6-0-stable
+          - v7.0.2
+          - v6.1.5
         ruby:
+          - 3.1.1
           - 3.0.2
           - 2.7.4
-          - 2.6.7
-        exclude:
-          - rails:  v7.0.0
-            ruby:   2.6.7
     env:
       DB: mysql
       RAILS: ${{ matrix.rails }}
@@ -82,17 +72,12 @@ jobs:
       fail-fast: false
       matrix:
         rails:
-          - v7.0.0
-          - v6.1.4
-          - v6.0.4
-          - 6-0-stable
+          - v7.0.2
+          - v6.1.5
         ruby:
+          - 3.1.1
           - 3.0.2
           - 2.7.4
-          - 2.6.7
-        exclude:
-          - rails:  v7.0.0
-            ruby:   2.6.7
     env:
       DB: postgres
       RAILS: ${{ matrix.rails }}
@@ -135,7 +120,7 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.0.2
+          ruby-version: 3.1.1
       - name: Install dependencies
         run: bundle install
       - name: Run bug report templates

data/CHANGELOG.md

@@ -2,6 +2,53 @@
 
 ## Unreleased
 
+## 3.2.0 - 2022-05-08
+
+* Drop Rails 6.0 support.
+  PR [1318](https://github.com/activerecord-hackery/ransack/pull/1318)
+
+* Exclude "host" from params sent to url generator.
+  PR [1319](https://github.com/activerecord-hackery/ransack/pull/1319)
+
+## 3.1.0 - 2022-04-21
+
+* Fix predicate name in "Using Predicates" documentation page.
+  PR [1313](https://github.com/activerecord-hackery/ransack/pull/1313)
+
+* Drop Ruby 2.6 support.
+  PR [1311](https://github.com/activerecord-hackery/ransack/pull/1311)
+
+* Allow Ransack to be used with Rails 7.1.0.alpha.
+  PR [1309](https://github.com/activerecord-hackery/ransack/pull/1309)
+
+* Put contributor list last in documentation site.
+  PR [1308](https://github.com/activerecord-hackery/ransack/pull/1308)
+
+* Add `acts-as-taggable-on` and polymorphic searches to documentation.
+  PR [1306](https://github.com/activerecord-hackery/ransack/pull/1306)
+  PR [1312](https://github.com/activerecord-hackery/ransack/pull/1312)
+
+* Add full link to issue about merging searches to documentation.
+  PR [1305](https://github.com/activerecord-hackery/ransack/pull/1305)
+
+## 3.0.1 - 2022-04-08
+
+* Fix `:data` option to `sort_link` being incorrectly appended to the generated
+  link query parameters.
+  PR [1301](https://github.com/activerecord-hackery/ransack/pull/1301)
+
+* Fix "Edit this page" links in documentation site
+  PR [1303](https://github.com/activerecord-hackery/ransack/pull/1303)
+
+* Auto deploy documentation site after merging PRs
+  PR [1302](https://github.com/activerecord-hackery/ransack/pull/1302)
+
+* Add list of former wiki contributors to documentation site
+  PR [1300](https://github.com/activerecord-hackery/ransack/pull/1300)
+
+* Reduce gem package size
+  PR [1297](https://github.com/activerecord-hackery/ransack/pull/1297)
+
 ## 3.0.0 - 2022-03-30
 
 * Move documentation into Docusaurus.

data/CONTRIBUTING.md

@@ -64,7 +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='6-0-stable' bundle install`
+   To install rails other than latest (set in Gemfile): `RAILS='6-1-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:

data/Gemfile

@@ -3,7 +3,7 @@ gemspec
 
 gem 'rake'
 
-rails = ENV['RAILS'] || '6-0-stable'
+rails = ENV['RAILS'] || '6-1-stable'
 
 rails_version = case rails
                 when /\// # A path
@@ -15,7 +15,7 @@ rails_version = case rails
                 end
 
 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 'sqlite3', '~> 1.4.1'
 gem 'pg', '~> 1.0'
 gem 'pry', '~> 0.12.2'
 gem 'byebug'

data/README.md

@@ -96,7 +96,7 @@ Support this project by becoming a sponsor. Your logo will show up here with a l
 <a href="https://opencollective.com/ransack/sponsor/1/website" target="_blank"><img src="https://opencollective.com/ransack/sponsor/1/avatar.svg" /></a>
 <a href="https://opencollective.com/ransack/sponsor/2/website" target="_blank"><img src="https://opencollective.com/ransack/sponsor/2/avatar.svg" /></a>
 <a href="https://opencollective.com/ransack/sponsor/3/website" target="_blank"><img src="https://opencollective.com/ransack/sponsor/3/avatar.svg" /></a>
-<a href="https://opencollective.com/ransack/sponsor/4/website" target="_blank"><img src="https://opencollective.com/ransack/sponsor/4/avatar.svg"/ ></a>
+<a href="https://opencollective.com/ransack/sponsor/4/website" target="_blank"><img src="https://opencollective.com/ransack/sponsor/4/avatar.svg" /></a>
 <a href="https://opencollective.com/ransack/sponsor/5/website" target="_blank"><img src="https://opencollective.com/ransack/sponsor/5/avatar.svg" /></a>
 <a href="https://opencollective.com/ransack/sponsor/6/website" target="_blank"><img src="https://opencollective.com/ransack/sponsor/6/avatar.svg" /></a>
 <a href="https://opencollective.com/ransack/sponsor/7/website" target="_blank"><img src="https://opencollective.com/ransack/sponsor/7/avatar.svg" /></a>

data/docs/.gitignore

@@ -15,6 +15,5 @@
 .env.test.local
 .env.production.local
 
-npm-debug.log*
 yarn-debug.log*
 yarn-error.log*

data/docs/docs/getting-started/using-predicates.md

@@ -23,7 +23,7 @@ You can also combine predicates for OR queries:
 The syntax for `OR` queries on an associated model is not immediately obvious, but makes sense. Assuming a `User` `has_one` `Account` and the `Account` has `attributes` `foo` and `bar`:
 
 ```ruby
->> User.ransack(account_foo_or_account_bar: 'val').result.to_sql
+>> User.ransack(account_foo_or_account_bar_cont: 'val').result.to_sql
 => SELECT "users".* FROM "users" INNER JOIN accounts ON accounts.user_id = users.id WHERE ("accounts.foo LIKE '%val%' OR accounts.bar LIKE '%val%')
 ```
 

data/docs/docs/going-further/acts-as-taggable-on.md

@@ -0,0 +1,114 @@
+---
+title: Acts-as-taggable-on
+sidebar_position: 13
+---
+
+## Using Acts As Taggable On
+
+If you have an `ActiveRecord` model and you're using [acts-as-taggable-on](https://github.com/mbleigh/acts-as-taggable-on),
+chances are you might want to search on tagged fields. Follow the instructions to install the gem and then set up your project files.
+
+### Configure the model
+
+`app/models/tasks.rb`
+
+You can call the tagging field anything you like, it just needs to be plural. No migration is needed as this is stored in the internal ActsAsTaggable tables (`tags` and `taggings`).
+
+```rb
+class Task < ApplicationRecord
+  acts_as_taggable_on :projects
+end
+```
+
+### Controller
+
+Add a field to strong params in the controller. Use the singular name with `_list`.
+
+`app/controllers/tasks_controller.rb`
+
+```rb
+def strong_params
+  params
+    .require(:tasks)
+    .permit(:task, :example_field, :project_list)
+```
+
+### Form
+
+We need to `send` the tag fieldname to our model, also using the singular naming.
+
+```
+<div class='form-group'>
+  <%= f.label :project_list %>
+  <%= f.text_field :project_list, value: @task.send(:project_list).to_s %>
+ </div>
+```
+
+Now we can collect our data via the form, with tags separated by commas.
+
+## Ransack Search
+
+Imagine you have the following two instances of `Task`:
+
+```rb
+{ id: 1, name: 'Clean up my room',        projects: [ 'Home', 'Personal' ] }
+{ id: 2, name: 'Complete math exercises', projects: [ 'Homework', 'Study' ] }
+```
+
+When you're writing a `Ransack` search form, you can choose any of the following options:
+
+```erb
+<%= search_form_for @search do |f| %>
+  <%= f.text_field :projects_name_in   %> <!-- option a -->
+  <%= f.text_field :projects_name_eq   %> <!-- option b -->
+  <%= f.text_field :projects_name_cont %> <!-- option c -->
+<% end %>
+```
+
+### Option A - Match keys exactly
+
+Option `a` will match keys exactly. This is the solution to choose if you want to distinguish 'Home' from 'Homework': searching for 'Home' will return just the `Task` with id 1. It also allows searching for more than one tag at once (comma separated):
+- `Home, Personal` will return task 1
+- `Home, Homework` will return task 1 and 2
+
+### Option B - match key combinations
+
+Option `b` will match all keys exactly. This is the solution if you wanna search for specific combinations of tags:
+- `Home` will return nothing, as there is no Task with just the `Home` tag
+- `Home, Personal` will return task 1
+
+### Option C - match substrings
+
+Option `c` is used to match substrings. This is useful when you don't care for the exact tag, but only for part of it:
+- `Home` will return task 1 and 2 (`/Home/` matches both `"Home"` and `"Homework"`)
+
+### Option D - select from a list of tags
+
+In Option D we allow the user to select a list of valid tags and then search againt them. We use the plural name here.
+
+```erb
+<div class='form-group'>
+  <%= f.label :projects_name, 'Project' %>
+  <%= f.select :projects_name_in, ActsAsTaggableOn::Tag.distinct.order(:name).pluck(:name) %>
+</div>
+```
+
+## Multitenancy 
+
+ActsAsTaggableOn allows scoping of tags based on another field on the model. Suppose we have a `language` field on the model, as an effective second level key. We would adjust our model to look like this:
+
+```rb
+class Task < ApplicationRecord
+  acts_as_taggable_on :projects
+  acts_as_taggable_tenant :language
+end
+```
+
+The Ransack search is then filtered using the `for_tenant` method
+
+```
+<div class='form-group'>
+  <%= f.label :projects_name, 'Project' %>
+  <%= f.select :projects_name_in, ActsAsTaggableOn::Tag.for_tenant('fr').distinct.order(:name).pluck(:name) %>
+</div>
+      

data/docs/docs/going-further/documentation.md

@@ -7,12 +7,24 @@ Ransack uses [Docusaurus](https://docusaurus.io/) for documentation. To contribu
 
 ### Local Development
 
+Switch to docs folder
+
 ```
 cd docs
-yarn start
 ```
 
-This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+Install docusaurus and other dependencies
+
+```
+yarn install
+```
+
+
+Start a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
+
+```
+yarn start
+```
 
 ### Build
 

data/docs/docs/going-further/merging-searches.md

@@ -38,4 +38,4 @@ WHERE (
 ORDER BY "people"."id" DESC
 ```
 
-Admittedly this is not as simple as it should be, but it's workable for now. (Implementing #417 could make this more straightforward.)
+Admittedly this is not as simple as it should be, but it's workable for now. (Implementing [issue 417](https://github.com/activerecord-hackery/ransack/issues/417) could make this more straightforward.)

data/docs/docs/going-further/polymorphic-search.md

@@ -0,0 +1,40 @@
+---
+title: Polymorphic Searches
+sidebar_position: 14
+---
+
+When making searches from polymorphic models it is necessary to specify the type of model you are searching. 
+
+For example:
+
+Given two models
+
+```ruby
+class House < ActiveRecord::Base
+  has_one :location, as: :locatable
+end
+
+class Location < ActiveRecord::Base
+  belongs_to :locatable, polymorphic: true
+end
+```
+
+Normally (without polymorphic relationship) you would be able to search as per below:
+
+```ruby
+Location.ransack(locatable_number_eq: 100).result
+```
+
+However when this is searched you will get the following error
+
+```ruby
+ActiveRecord::EagerLoadPolymorphicError: Can not eagerly load the polymorphic association :locatable
+```
+
+In order to search for locations by house number when the relationship is polymorphic you have to specify the type of records you will be searching and construct your search as below:
+
+```ruby
+Location.ransack(locatable_of_House_type_number_eq: 100).result
+```
+
+note the `_of_House_type_` added to the search key. This allows Ransack to correctly specify the table names in SQL join queries.

data/docs/docs/going-further/wiki-contributors.md

@@ -0,0 +1,82 @@
+---
+title: Wiki Contributors
+sidebar_position: 20
+---
+
+Ransack previously had documentation contained in a GitHub Wiki, and this content has been merged into this documentation website. The following long list of _amazing_ people all made contributions to the Wiki:
+
+* Abinoam P. Marques Jr
+* Alex Stophel
+* Andrea Schiavini
+* Andrew Vit
+* Ben Koshy
+* Brainkurv
+* Brandan Lennox
+* Brendon Muir
+* Chris Salzberg
+* Colleen McGuckin
+* David Aldridge
+* Davidson Mohanty
+* Denis Tataurov
+* Drew Moore
+* Eike Send
+* Feodor Cherashev
+* Glauco Custódio
+* Grey Baker
+* Harold.Luo
+* Herman Singh
+* Ian Smith
+* Jake Haber
+* Jan Klimo
+* Jared Beck
+* Jon Atack
+* Juanito Fatas
+* JungaJk
+* Leo Chen
+* Leon Miller-Out
+* Luca F
+* Marc Poris
+* Matt Oakley
+* Michael Kopchick
+* Nathan Colgate
+* Nguyen Phi Viet(Sun*)
+* Nguyễn Đức Long
+* NielsKSchjoedt
+* Patrick Copeland
+* Pedro Chambino
+* Rene Hopf
+* Richa Arora
+* Rob Jones
+* Roman Sokhan
+* Ryan Bates
+* Ryan Bigg
+* Sean
+* Sean Linsley
+* Sergey
+* Sunny Ripert
+* Tanbir Hasan
+* ThuyNguyen97
+* Vanda
+* Yana Agun Siswanto
+* bonyiii
+* charly
+* chifung7
+* colorfulberry
+* ddonahue99
+* ernie
+* gaaady
+* gingerlime
+* grumpit
+* itsalongstory
+* jonatack
+* kogre
+* nguyentrungson97
+* nslocum
+* omitter
+* radar
+* rilian
+* terraplane
+* tyronewilson
+* vansy61
+* willnet
+* wzcolon

data/docs/docusaurus.config.js

@@ -25,12 +25,11 @@ const config = {
         docs: {
           routeBasePath: '/',
           sidebarPath: require.resolve('./sidebars.js'),
-          editUrl: 'https://github.com/activerecord-hackery/ransack/docs/docs/',
+          editUrl: 'https://github.com/activerecord-hackery/ransack/edit/main/docs/',
         },
         blog: {
           showReadingTime: true,
-          editUrl:
-            'https://github.com/activerecord-hackery/ransack/docs/blog/',
+          editUrl: 'https://github.com/activerecord-hackery/ransack/edit/main/blog/',
         },
         theme: {
           customCss: require.resolve('./src/css/custom.css'),

data/docs/yarn.lock

@@ -2347,9 +2347,9 @@ asap@~2.0.3:
   integrity sha1-5QNHYR1+aQlDIIu9r+vLwvuGbUY=
 
 async@^2.6.2:
-  version "2.6.3"
-  resolved "https://registry.yarnpkg.com/async/-/async-2.6.3.tgz#d72625e2344a3656e3a3ad4fa749fa83299d82ff"
-  integrity sha512-zflvls11DCy+dQWzTW2dzuilv8Z5X/pjfmZOWba6TNIVDm+2UDaJmXSOXlasHKfNBs8oo3M0aT50fDEWfKZjXg==
+  version "2.6.4"
+  resolved "https://registry.yarnpkg.com/async/-/async-2.6.4.tgz#706b7ff6084664cd7eae713f6f965433b5504221"
+  integrity sha512-mzo5dfJYwAn29PeiJ0zvwTo04zj8HDJj0Mn8TD7sno7q12prdbnasKJHhkm2c1LgrhlJ0teaea8860oxi51mGA==
   dependencies:
     lodash "^4.17.14"
 

data/lib/polyamorous/activerecord_6.1_ruby_2/reflection.rb

@@ -1 +1,11 @@
-require 'polyamorous/activerecord_6.0_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_7.1_ruby_2/join_association.rb

@@ -0,0 +1 @@
+require 'polyamorous/activerecord_6.1_ruby_2/join_association'

data/lib/polyamorous/activerecord_7.1_ruby_2/join_dependency.rb

@@ -0,0 +1 @@
+require 'polyamorous/activerecord_6.1_ruby_2/join_dependency'

data/lib/polyamorous/activerecord_7.1_ruby_2/reflection.rb

@@ -0,0 +1 @@
+require 'polyamorous/activerecord_6.1_ruby_2/reflection'