ransack 3.1.0 → 4.0.0

data/docs/docs/getting-started/simple-mode.md

@@ -11,7 +11,7 @@ mode should meet your needs.
 
 ## In your controller
 
-```jsx
+```ruby
 def index
   @q = Person.ransack(params[:q])
   @people = @q.result(distinct: true)
@@ -20,13 +20,17 @@ end
 or without `distinct: true`, for sorting on an associated table's columns (in
 this example, with preloading each Person's Articles and pagination):
 
-```jsx
+```ruby
 def index
   @q = Person.ransack(params[:q])
   @people = @q.result.includes(:articles).page(params[:page])
 end
 ```
 
+:::caution
+By default, searching and sorting are authorized on any column of your model. See [Authorization (allowlisting/denylisting)](/going-further/other-notes.md#authorization-allowlistingdenylisting) on how to prevent this.
+:::
+
 ### Default search options
 
 #### Search parameter
@@ -35,7 +39,7 @@ 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`):
 
-```jsx
+```ruby
 Ransack.configure do |c|
   # Change default search parameter key name.
   # Default key name is :q
@@ -48,9 +52,9 @@ end
 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:
 
-```jsx
+```ruby
 Ransack.configure do |c|
-  # Change whitespace stripping behaviour.
+  # Change whitespace stripping behavior.
   # Default is true
   c.strip_whitespace = false
 end
@@ -60,13 +64,13 @@ end
 
 The two primary Ransack view helpers are `search_form_for` and `sort_link`,
 which are defined in
-[Ransack::Helpers::FormHelper](https://github.com/activerecord-hackery/ransack/lib/ransack/helpers/form_helper.rb).
+[Ransack::Helpers::FormHelper](https://github.com/activerecord-hackery/ransack/blob/main/lib/ransack/helpers/form_helper.rb).
 
 ### Form helper
 
 Ransack's `search_form_for` helper replaces `form_for` for creating the view search form
 
-```jsx
+```erb
 <%= search_form_for @q do |f| %>
 
   # Search if the name field contains...
@@ -95,7 +99,7 @@ search predicates.
 
 The `search_form_for` answer format can be set like this:
 
-```jsx
+```erb
 <%= search_form_for(@q, format: :pdf) do |f| %>
 
 <%= search_form_for(@q, format: :json) do |f| %>
@@ -105,7 +109,7 @@ The `search_form_for` answer format can be set like this:
 
 Ransack's `sort_link` helper creates table headers that are sortable links
 
-```jsx
+```erb
 <%= sort_link(@q, :name) %>
 ```
 Additional options can be passed after the column parameter, like a different
@@ -114,13 +118,13 @@ column title or a default sort order.
 If the first option after the column parameter is a String, it's considered a
 custom label for the link:
 
-```jsx
+```erb
 <%= sort_link(@q, :name, 'Last Name', default_order: :desc) %>
 ```
 
 You can use a block if the link markup is hard to fit into the label parameter:
 
-```jsx
+```erb
 <%= sort_link(@q, :name) do %>
   <strong>Player Name</strong>
 <% end %>
@@ -130,14 +134,14 @@ With a polymorphic association, you may need to specify the name of the link
 explicitly to avoid an `uninitialized constant Model::Xxxable` error (see issue
 [#421](https://github.com/activerecord-hackery/ransack/issues/421)):
 
-```jsx
+```erb
 <%= sort_link(@q, :xxxable_of_Ymodel_type_some_attribute, 'Attribute Name') %>
 ```
 
 If the first option after the column parameter and/or the label parameter is an
 Array, it will be used for sorting on multiple fields:
 
-```jsx
+```erb
 <%= sort_link(@q, :last_name, [:last_name, 'first_name asc'], 'Last Name') %>
 ```
 
@@ -148,7 +152,7 @@ Ransack to _always_ sort that particular field in the specified direction.
 Multiple `default_order` fields may also be specified with a trailing options
 Hash:
 
-```jsx
+```erb
 <%= sort_link(@q, :last_name, %i(last_name first_name),
   default_order: { last_name: 'asc', first_name: 'desc' }) %>
 ```
@@ -162,7 +166,7 @@ of a SQL function, you may do so using scopes. In your model, define scopes
 whose names line up with the name of the virtual field you wish to sort by,
 as so:
 
-```jsx
+```ruby
 class Person < ActiveRecord::Base
   scope :sort_by_reverse_name_asc, lambda { order("REVERSE(name) ASC") }
   scope :sort_by_reverse_name_desc, lambda { order("REVERSE(name) DESC") }
@@ -171,7 +175,7 @@ class Person < ActiveRecord::Base
 
 and you can then sort by this virtual field:
 
-```jsx
+```erb
 <%= sort_link(@q, :reverse_name) %>
 ```
 
@@ -186,7 +190,7 @@ You can also enable a `default_arrow` which is displayed on all sortable fields
 which are not currently used in the sorting. This is disabled by default so
 nothing will be displayed:
 
-```jsx
+```ruby
 Ransack.configure do |c|
   c.custom_arrows = {
     up_arrow: '<i class="custom-up-arrow-icon"></i>',
@@ -200,7 +204,7 @@ All sort links may be displayed without the order indicator
 arrows by setting `hide_sort_order_indicators` to true in the initializer file.
 Note that this hides the arrows even if they were customized:
 
-```jsx
+```ruby
 Ransack.configure do |c|
   c.hide_sort_order_indicators = true
 end
@@ -209,7 +213,7 @@ end
 Without setting it globally, individual sort links may be displayed without
 the order indicator arrow by passing `hide_indicator: true` in the sort link:
 
-```jsx
+```erb
 <%= sort_link(@q, :name, hide_indicator: true) %>
 ```
 
@@ -219,15 +223,15 @@ Ransack's `sort_url` helper is like a `sort_link` but returns only the url
 
 `sort_url` has the same API as `sort_link`:
 
-```jsx
+```erb
 <%= sort_url(@q, :name, default_order: :desc) %>
 ```
 
-```jsx
+```erb
 <%= sort_url(@q, :last_name, [:last_name, 'first_name asc']) %>
 ```
 
-```jsx
+```erb
 <%= sort_url(@q, :last_name, %i(last_name first_name),
   default_order: { last_name: 'asc', first_name: 'desc' }) %>
 ```
@@ -238,7 +242,7 @@ The `NULLS FIRST` and `NULLS LAST` options can be used to determine whether null
 
 You may want to configure it like this:
 
-```jsx
+```ruby
 Ransack.configure do |c|
   c.postgres_fields_sort_option = :nulls_first # or :nulls_last
 end
@@ -246,7 +250,7 @@ end
 
 To treat nulls as having the lowest or highest value respectively. To force nulls to always be first or last, use
 
-```jsx
+```ruby
 Ransack.configure do |c|
   c.postgres_fields_sort_option = :nulls_always_first # or :nulls_always_last
 end
@@ -258,7 +262,7 @@ See this feature: https://www.postgresql.org/docs/13/queries-order.html
 
 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:
 
-```jsx
+```ruby
 module RansackObject
 
   def self.included(base)
@@ -273,7 +277,7 @@ module RansackObject
 end
 ```
 
-```jsx
+```ruby
 class UserWithManyAttributes < ActiveRecord::Base
   include RansackObject
 end

data/docs/docs/getting-started/sorting.md

@@ -9,7 +9,7 @@ title: Sorting
 
 You can add a form to capture sorting and filtering options together.
 
-```jsx
+```erb
 <div class="filters" id="filtersSidebar">
   <header class="filters-header">
     <div class="filters-header-content">

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

@@ -14,7 +14,7 @@ chances are you might want to search on tagged fields. Follow the instructions t
 
 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
+```ruby
 class Task < ApplicationRecord
   acts_as_taggable_on :projects
 end
@@ -26,7 +26,7 @@ Add a field to strong params in the controller. Use the singular name with `_lis
 
 `app/controllers/tasks_controller.rb`
 
-```rb
+```ruby
 def strong_params
   params
     .require(:tasks)
@@ -37,7 +37,7 @@ def strong_params
 
 We need to `send` the tag fieldname to our model, also using the singular naming.
 
-```
+```erb
 <div class='form-group'>
   <%= f.label :project_list %>
   <%= f.text_field :project_list, value: @task.send(:project_list).to_s %>
@@ -50,7 +50,7 @@ Now we can collect our data via the form, with tags separated by commas.
 
 Imagine you have the following two instances of `Task`:
 
-```rb
+```ruby
 { id: 1, name: 'Clean up my room',        projects: [ 'Home', 'Personal' ] }
 { id: 2, name: 'Complete math exercises', projects: [ 'Homework', 'Study' ] }
 ```
@@ -67,24 +67,24 @@ When you're writing a `Ransack` search form, you can choose any of the following
 
 ### 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):
+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:
+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:
+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.
+In Option `D` we allow the user to select a list of valid tags and then search against them. We use the plural name here.
 
 ```erb
 <div class='form-group'>
@@ -97,7 +97,7 @@ In Option D we allow the user to select a list of valid tags and then search aga
 
 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
+```ruby
 class Task < ApplicationRecord
   acts_as_taggable_on :projects
   acts_as_taggable_tenant :language
@@ -106,7 +106,7 @@ end
 
 The Ransack search is then filtered using the `for_tenant` method
 
-```
+```erb
 <div class='form-group'>
   <%= f.label :projects_name, 'Project' %>
   <%= f.select :projects_name_in, ActsAsTaggableOn::Tag.for_tenant('fr').distinct.order(:name).pluck(:name) %>

data/docs/docs/going-further/exporting-to-csv.md

@@ -7,7 +7,7 @@ Exporting to CSV
 
 Example downloading a csv file preserving ransack search, based on [this gist](https://gist.github.com/pama/adff25ed1f4b796ce088ea362a08e1c5)
 
-```jsx title='index.html.erb'
+```ruby title='index.html.erb'
 <h1>Users</h1>
 
 <%= search_form_for @q, url: dashboard_index_path do |f| %>
@@ -30,7 +30,7 @@ Example downloading a csv file preserving ransack search, based on [this gist](h
 <% end %>
 ```
 
-```jsx title='user.rb'
+```ruby title='user.rb'
 require 'csv'
 
 class User < ApplicationRecord

data/docs/docs/going-further/form-customisation.md

@@ -3,7 +3,7 @@ sidebar_position: 4
 title: Form customisation
 ---
 
-Predicate and attribute labels in forms may be specified with I18n in a translation file (see the locale files in [Ransack::Locale](https://github.com/activerecord-hackery/ransack/activerecord-hackery/ransack/tree/master/lib/ransack/locale) for more examples):
+Predicate and attribute labels in forms may be specified with I18n in a translation file (see the locale files in [Ransack::Locale](https://github.com/activerecord-hackery/ransack/tree/main/lib/ransack/locale) for more examples):
 
 ```yml
 # locales/en.yml

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

@@ -6,12 +6,12 @@ title: i18n
 # i18n and Ransack
 
 Ransack translation files are available in
-[Ransack::Locale](https://github.com/activerecord-hackery/ransack/lib/ransack/locale). You may also be interested in one of the
+[Ransack::Locale](https://github.com/activerecord-hackery/ransack/tree/main/lib/ransack/locale). You may also be interested in one of the
 many translations for Ransack available at
 http://www.localeapp.com/projects/2999.
 
 Predicate and attribute translations in forms may be specified as follows (see
-the translation files in [Ransack::Locale](https://github.com/activerecord-hackery/ransack/lib/ransack/locale) for more examples):
+the translation files in [Ransack::Locale](https://github.com/activerecord-hackery/ransack/tree/main/lib/ransack/locale) for more examples):
 
 locales/en.yml:
 ```yml
@@ -27,7 +27,7 @@ en:
       gt: greater than
       lt: less than
     models:
-      person: Passanger
+      person: Passenger
     attributes:
       person:
         name: Full Name

data/docs/docs/going-further/other-notes.md

@@ -354,7 +354,7 @@ argument are not easily usable yet, because the array currently needs to be
 wrapped in an array to function (see
 [this issue](https://github.com/activerecord-hackery/ransack/issues/404)),
 which is not compatible with Ransack form helpers. For this use case, it may be
-better for now to use [ransackers](https://github.com/activerecord-hackery/ransack/wiki/Using-Ransackers) instead,
+better for now to use [ransackers](https://activerecord-hackery.github.io/ransack/going-further/ransackers) instead,
 where feasible. Pull requests with solutions and tests are welcome!
 
 ### Grouping queries by OR instead of AND

data/docs/docs/going-further/saving-queries.md

@@ -72,7 +72,7 @@ class ApplicationController < ActionController::Base
   end
 
 protected
-  # GENERATE A GENERIC SESSION KEY BASED ON TEH CONTROLLER NAME
+  # GENERATE A GENERIC SESSION KEY BASED ON THE CONTROLLER NAME
   def search_key
     "#{controller_name}_search".to_sym
   end

data/docs/docs/going-further/searching-postgres.md

@@ -13,7 +13,7 @@ See [this issue](https://github.com/activerecord-hackery/ransack/issues/321) for
 
 ### Using a fixed key
 
-See here for searching on a fixed key in a JSONB column: https://github.com/activerecord-hackery/ransack/wiki/Using-Ransackers#3-search-on-a-fixed-key-in-a-jsonb--hstore-column
+See here for searching on a fixed key in a JSONB column: https://activerecord-hackery.github.io/ransack/going-further/ransackers/#postgres-columns
 
 ### Using the JSONB contains operator
 

data/docs/docs/intro.md

@@ -17,7 +17,7 @@ Ransack is supported for Rails 7.0, 6.x on Ruby 2.6.6 and later.
 
 To install `ransack` and add it to your Gemfile, run
 
-```jsx title='Gemfile'
+```ruby title='Gemfile'
 gem 'ransack'
 ```
 
@@ -25,7 +25,7 @@ gem 'ransack'
 
 If you would like to use the latest updates not yet published to RubyGems, use the `main` branch:
 
-```jsx title='Gemfile'
+```ruby title='Gemfile'
 gem 'ransack', :github => 'activerecord-hackery/ransack', :branch => 'main'
 ```
 

data/docs/docusaurus.config.js

@@ -15,7 +15,7 @@ const config = {
   favicon: 'img/favicon.ico',
   organizationName: 'activerecord-hackery',
   projectName: 'ransack',
-  trailingSlash: false,
+  trailingSlash: true,
 
   presets: [
     [
@@ -100,8 +100,21 @@ const config = {
       prism: {
         theme: lightCodeTheme,
         darkTheme: darkCodeTheme,
+        additionalLanguages: ['ruby', 'erb'],
       },
     }),
+
+  themes: [
+    [
+      require.resolve("@easyops-cn/docusaurus-search-local"),
+      {
+        // `hashed` is recommended as long-term-cache of index file is possible.
+        hashed: true,
+        // needs to be the same as routeBasePath in @docusaurus/preset-classic config
+        docsRouteBasePath: '/'
+      },
+    ]
+  ]
 };
 
 module.exports = config;

data/docs/package.json

@@ -14,14 +14,19 @@
     "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
-    "@docusaurus/core": "2.0.0-beta.18",
-    "@docusaurus/preset-classic": "2.0.0-beta.18",
+    "@docusaurus/core": "^2.2.0",
+    "@docusaurus/preset-classic": "^2.2.0",
+    "@easyops-cn/docusaurus-search-local": "^0.33.5",
     "@mdx-js/react": "^1.6.22",
     "clsx": "^1.1.1",
     "prism-react-renderer": "^1.3.1",
     "react": "^17.0.2",
     "react-dom": "^17.0.2"
   },
+  "resolutions": {
+    "trim": "^0.0.3",
+    "got": "^11.8.5"
+  },
   "browserslist": {
     "production": [
       ">0.5%",