ransack 3.2.0 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f37dfefd63333903d6b36084a8dda1193ca31788777b2645d25b96dd97d2d2c
-  data.tar.gz: dba86f7268c931801e1caf32f3552ebfeecc06fec2f773130118cc2c809c61e9
+  metadata.gz: f4ce966153aee54a3e24eb4ec775569926813ed7273839e5d042dbbc6b3addf8
+  data.tar.gz: 4d96b0ecae077f0096494a99f90e8cfb3555140fe194c79ed691b2760319e51c
 SHA512:
-  metadata.gz: 7c8364c70e6536c5aa5dca37c5539164d89dab6fb9e582501dbf5611ff4a647aa0b5ff69450a0b4d480de4d61e62708b3c376ffb6813c0f06ff6b0a591c670f6
-  data.tar.gz: 4681b4c7f4e03002b968e165abf930a6b42dfc1e4d740a0bb8a034a9c805b1f956d6f82ab5ca0e39117a8a08b8899b849e34ccf665ac5f7c36fd1aec83ebe3e5
+  metadata.gz: 5d23fb2ddc8ef40489c40e02202b3d051305252c21b5f6c2823478442ce326990b22a26ee46861212b690ada0632328ce6c5065cba238bd185eecc46fd5555c5
+  data.tar.gz: 5dffd2910eefdfe2633d13a4b7d36838340f45fb484f025fed264e5df5b69c730df16257f11e7425a0852f99255b1f22e970c6407a9f5f4c59c2ca027f6e8804

data/.github/workflows/test.yml

@@ -11,12 +11,12 @@ jobs:
       fail-fast: false
       matrix:
         rails:
-          - v7.0.2
-          - v6.1.5
+          - v7.0.3
+          - v6.1.6
         ruby:
-          - 3.1.1
-          - 3.0.2
-          - 2.7.4
+          - 3.1.2
+          - 3.0.4
+          - 2.7.6
     env:
       DB: sqlite3
       RAILS: ${{ matrix.rails }}
@@ -37,12 +37,12 @@ jobs:
       fail-fast: false
       matrix:
         rails:
-          - v7.0.2
-          - v6.1.5
+          - v7.0.3
+          - v6.1.6
         ruby:
-          - 3.1.1
-          - 3.0.2
-          - 2.7.4
+          - 3.1.2
+          - 3.0.4
+          - 2.7.6
     env:
       DB: mysql
       RAILS: ${{ matrix.rails }}
@@ -72,12 +72,12 @@ jobs:
       fail-fast: false
       matrix:
         rails:
-          - v7.0.2
-          - v6.1.5
+          - v7.0.3
+          - v6.1.6
         ruby:
-          - 3.1.1
-          - 3.0.2
-          - 2.7.4
+          - 3.1.2
+          - 3.0.4
+          - 2.7.6
     env:
       DB: postgres
       RAILS: ${{ matrix.rails }}
@@ -120,7 +120,7 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.1.1
+          ruby-version: 3.1.2
       - name: Install dependencies
         run: bundle install
       - name: Run bug report templates

data/CHANGELOG.md

@@ -2,13 +2,33 @@
 
 ## Unreleased
 
+## 3.2.1 - 2022-05-24
+
+* Add search functionality to documentation site.
+  PR [1329](https://github.com/activerecord-hackery/ransack/pull/1329)
+
+* Fix contributing URLs and syntax highlight in `README.md`.
+  PR [1326](https://github.com/activerecord-hackery/ransack/pull/1326)
+
+* Cast PostgreSQL's `timestamptz` columns to time.
+  PR [1325](https://github.com/activerecord-hackery/ransack/pull/1325)
+
+* Add Ruby and ERB syntax highlighting support to documentation site.
+  PR [1324](https://github.com/activerecord-hackery/ransack/pull/1324)
+
+* Fix a wrong link in `CHANGELOG.md`.
+  PR [1323](https://github.com/activerecord-hackery/ransack/pull/1323)
+
+* Fix links to bug report templates in `CONTRIBUTING.md`.
+  PR [1321](https://github.com/activerecord-hackery/ransack/pull/1321)
+
 ## 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)
+  PR [1317](https://github.com/activerecord-hackery/ransack/pull/1317)
 
 ## 3.1.0 - 2022-04-21
 

data/CONTRIBUTING.md

@@ -20,14 +20,14 @@ Steps:
    reported.
 
 2. **Check if the issue has been fixed** — try to reproduce it using the
-   `master` branch in the repository.
+   `main` branch in the repository.
 
 3. **Isolate the real problem** — make sure the issue is really a bug in
    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://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
+   gist like [this](https://github.com/activerecord-hackery/ransack/blob/main/bug_report_templates/test-ransack-scope-and-column-same-name.rb) or
+   [this](https://github.com/activerecord-hackery/ransack/blob/main/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:
@@ -123,7 +123,7 @@ Here's a quick guide:
 
 12. Push the branch up to your fork on GitHub
    (`git push origin my-new-feature`) and from GitHub submit a pull request to
-   Ransack's `master` branch.
+   Ransack's `main` branch.
 
 At this point you're waiting on us. We like to at least comment on, if not
 accept, pull requests within three business days (and, typically, one business

data/README.md

@@ -24,7 +24,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'
 ```
 
@@ -32,7 +32,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'
 ```
 
@@ -42,7 +42,7 @@ There is [extensive documentation on Ransack](https://activerecord-hackery.githu
 
 ## Issues tracker
 
-* Before filing an issue, please read the [Contributing Guide](https://github.com/activerecord-hackery/ransack/CONTRIBUTING.md).
+* Before filing an issue, please read the [Contributing Guide](CONTRIBUTING.md).
 * File an issue if a bug is caused by Ransack, is new (has not already been reported), and _can be reproduced from the information you provide_.
 * Please consider adding a branch with a failing spec describing the problem.
 * Contributions are welcome. :smiley:
@@ -58,7 +58,7 @@ To support the project:
 broken or missing. A failing spec to demonstrate the issue is awesome. A pull
 request with passing tests is even better!
 * Before filing an issue or pull request, be sure to read and follow the
-[Contributing Guide](https://github.com/activerecord-hackery/ransack/CONTRIBUTING.md).
+[Contributing Guide](CONTRIBUTING.md).
 * Please use Stack Overflow or other sites for questions or discussion not
 directly related to bug reports, pull requests, or documentation improvements.
 * Spread the word on Twitter, Facebook, and elsewhere if Ransack's been useful

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,7 +20,7 @@ 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])
@@ -35,7 +35,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,7 +48,7 @@ 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.
   # Default is true
@@ -66,7 +66,7 @@ which are defined in
 
 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 +95,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 +105,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 +114,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 +130,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 +148,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 +162,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 +171,7 @@ class Person < ActiveRecord::Base
 
 and you can then sort by this virtual field:
 
-```jsx
+```erb
 <%= sort_link(@q, :reverse_name) %>
 ```
 
@@ -186,7 +186,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 +200,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 +209,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 +219,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 +238,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 +246,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 +258,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 +273,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' ] }
 ```
@@ -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/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,8 +14,9 @@
     "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.0.0-beta.20",
+    "@docusaurus/preset-classic": "^2.0.0-beta.20",
+    "@easyops-cn/docusaurus-search-local": "^0.25.0",
     "@mdx-js/react": "^1.6.22",
     "clsx": "^1.1.1",
     "prism-react-renderer": "^1.3.1",