ransack 3.0.0 → 3.2.1

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/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/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/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: [
     [
@@ -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'),
@@ -101,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",