ransack 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2599d5bd405561f9dd3c9b1b585baef6132a23653ebaf079f65aa7a326b20998
-  data.tar.gz: '0899eeb3faebe29e31c6ec2ec248d1b106f6fdb5175532fdb55b82abce928d19'
+  metadata.gz: 9db4893295fd342185cf668f2b3edbc59f1e649945024147778bdc52978e53fa
+  data.tar.gz: 9f57ba51a61d63f1f4023735d8a2ef9384e7840461af65169f4c0214f4b619a8
 SHA512:
-  metadata.gz: 0cd85c2c70494e50e4ce67351a3abb7822424372fbe5e3062415b7c3471094883f955cf6c6c57f1f783442b68d18593c0d8a220e4f1f1e68c9e1e48d80b2d9be
-  data.tar.gz: 24c878aceb15a2a914f4c99743df78af82aef65fda072301678bde8307ed0dfafc5506366929babf19524a221d2a57d191d7d3e4ebb2bf73760f5b4b6928d082
+  metadata.gz: 625d61491c96bd319e95d65d0d704f3906b8087e21f8fd2f8f2d1515ac4debdd3e39b678bbea8f0d39d6a5e58d5b46ba66919cb8b4770c8bb7fc4a77421c743e
+  data.tar.gz: cec0aa2875df4b9b8d5e8ae222fba9970ec0aaaf66de05ae21110a981828704a294f8f16fb55037ea0db39429611d7ea0e5f5d4ff51dbcd01cd66fca171b4ecf

data/.github/workflows/test.yml

@@ -11,17 +11,13 @@ jobs:
       fail-fast: false
       matrix:
         rails:
-          - v7.0.0
-          - v6.1.4
+          - v7.0.2
+          - v6.1.5
           - v6.0.4
-          - 6-0-stable
         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 +38,13 @@ jobs:
       fail-fast: false
       matrix:
         rails:
-          - v7.0.0
-          - v6.1.4
+          - v7.0.2
+          - v6.1.5
           - v6.0.4
-          - 6-0-stable
         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 +74,13 @@ jobs:
       fail-fast: false
       matrix:
         rails:
-          - v7.0.0
-          - v6.1.4
+          - v7.0.2
+          - v6.1.5
           - v6.0.4
-          - 6-0-stable
         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 +123,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,27 @@
 
 ## Unreleased
 
+## 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

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/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

@@ -1,6 +1,6 @@
 ---
 title: Wiki Contributors
-sidebar_position: 12
+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:

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'

data/lib/ransack/version.rb

@@ -1,3 +1,3 @@
 module Ransack
-  VERSION = '3.0.1'
+  VERSION = '3.1.0'
 end

data/ransack.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
   s.homepage    = "https://github.com/activerecord-hackery/ransack"
   s.summary     = %q{Object-based searching for Active Record.}
   s.description = %q{Ransack is the successor to the MetaSearch gem. It improves and expands upon MetaSearch's functionality, but does not have a 100%-compatible API.}
-  s.required_ruby_version = '>= 2.6'
+  s.required_ruby_version = '>= 2.7'
   s.license     = 'MIT'
 
   s.add_dependency 'activerecord', '>= 6.0.4'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ransack
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - Ernie Miller
@@ -12,7 +12,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-07 00:00:00.000000000 Z
+date: 2022-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -97,6 +97,7 @@ files:
 - docs/docs/getting-started/sorting.md
 - docs/docs/getting-started/using-predicates.md
 - docs/docs/going-further/_category_.json
+- docs/docs/going-further/acts-as-taggable-on.md
 - docs/docs/going-further/associations.md
 - docs/docs/going-further/custom-predicates.md
 - docs/docs/going-further/documentation.md
@@ -107,6 +108,7 @@ files:
 - docs/docs/going-further/img/create_release.png
 - docs/docs/going-further/merging-searches.md
 - docs/docs/going-further/other-notes.md
+- docs/docs/going-further/polymorphic-search.md
 - docs/docs/going-further/ransackers.md
 - docs/docs/going-further/release_process.md
 - docs/docs/going-further/saving-queries.md
@@ -147,6 +149,9 @@ files:
 - lib/polyamorous/activerecord_7.0_ruby_2/join_association.rb
 - lib/polyamorous/activerecord_7.0_ruby_2/join_dependency.rb
 - lib/polyamorous/activerecord_7.0_ruby_2/reflection.rb
+- lib/polyamorous/activerecord_7.1_ruby_2/join_association.rb
+- lib/polyamorous/activerecord_7.1_ruby_2/join_dependency.rb
+- lib/polyamorous/activerecord_7.1_ruby_2/reflection.rb
 - lib/polyamorous/join.rb
 - lib/polyamorous/polyamorous.rb
 - lib/polyamorous/swapping_reflection_class.rb
@@ -246,14 +251,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.11
+rubygems_version: 3.3.10
 signing_key:
 specification_version: 4
 summary: Object-based searching for Active Record.