ransack 4.1.1 → 4.4.0

data/CONTRIBUTING.md

@@ -1,171 +0,0 @@
-# Contributing to Ransack
-
-Please take a moment to review this document to make contributing easy and
-effective for everyone involved!
-
-Ransack is an open source project and we encourage contributions.
-
-Please do not use the issue tracker for personal support requests. Stack
-Overflow is a better place for that where a wider community can help you!
-
-## Filing an issue
-
-Good issue reports are extremely helpful!  Please only open 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.
-
-Steps:
-
-1. **Use the GitHub issue search** — check if the issue has already been
-   reported.
-
-2. **Check if the issue has been fixed** — try to reproduce it using the
-   `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/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:
-
-* A comprehensive list of steps to reproduce the issue, or even better, a
-  passing/failing test spec.
-* Whether you are using Ransack through another gem like ActiveAdmin,
-  SimpleForm, etc.
-* The versions of Ruby, Rails, Ransack and the database.
-* Any relevant stack traces ("Full trace" preferred).
-
-Issues filed without the above information or that remain open without activity
-for 14 days will be closed. They can be re-opened if actionable information to reproduce the issue is provided.
-
-## Pull requests
-
-We gladly accept pull requests to fix bugs and, in some circumstances, add new
-features to Ransack. If you'd like to contribute and wonder what would be
-helpful, simply run a search for "FIXME" and "TODO" on the codebase :smiley:
-
-If you're new to contributing to open source, welcome! It can seem scary, so
-here is a [great blog post to help you get started]
-(http://robots.thoughtbot.com/8-new-steps-for-fixing-other-peoples-code),
-step by step.
-
-Before issuing a pull request, please make sure that all specs are passing,
-that any new features have test coverage, and that anything that breaks
-backward compatibility has a very good reason for doing so.
-
-Here's a quick guide:
-
-1. Fork the repo.
-
-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-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:
-
-   ```sh
-   bundle exec rake spec
-   ```
-
-   The test suite runs by default with SQLite3. To run the test suite with PostgreSQL or MySQL, use:
-
-   ```sh
-   DB=pg bundle exec rake spec
-   DB=mysql bundle exec rake spec
-   ```
-   
-   A one-liner to run all three
-   
-   ```sh
-   bundle exec rake spec && DB=pg bundle exec rake spec && DB=mysql bundle exec rake spec
-   ```
-
-   For Postgres and MySQL, databases are expected to exist, called 'ransack'. To create use these commands (assuming OS X and Homebrew):
-
-   ### Postgres
-   
-   ```sh
-   createdb ransack 
-   ```
-
-   ### MySQL
-   
-   ```sh
-   mysql -u root
-   mysql> create database ransack; 
-   ```
-
-   The test suite runs by default
-
-   To run only the tests in a particular file: `bundle exec rspec <path/to/filename>`
-
-   ```sh
-   bundle exec rspec spec/ransack/search_spec.rb
-   ```
-
-   To run a single test in that file: `bundle exec rspec <path/to/filename> -e "test name"`
-
-   ```sh
-   bundle exec rspec spec/ransack/search_spec.rb -e "accepts a context option"
-   ```
-
-5. Add tests for your changes. Only refactoring and documentation changes
-   require no new tests. If you are adding functionality or fixing a bug, we
-   need a test!
-
-6. Make the tests pass.
-
-7. Update the Change Log. If you are adding new functionality, document it in
-   the README.
-
-8. Make sure git knows your name and email address in your `~/.gitconfig` file:
-
-   ```sh
-   git config --global user.name "Your Name"
-   git config --global user.email "contributor@example.com"
-   ```
-
-9. Commit your changes (`git commit -am 'Add feature/fix bug/improve docs'`).
-    If your pull request only contains documentation changes, please remember
-    to add `[skip ci]` to the beginning of your commit message so the CI
-    test suite doesn't :runner: needlessly.
-
-10. If necessary, rebase your commits into logical chunks, without errors. To
-   interactively rebase and cherry-pick from, say, the last 10 commits:
-   `git rebase -i HEAD~10`, then `git push -f`.
-
-11. 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 `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
-day). We may suggest some changes or improvements or alternatives.
-
-Some things that will increase the chance that your pull request is accepted:
-
-* Include tests that fail without your code, and pass with it.
-* Update the README, the change log, the documentation... anything that is
-  affected by your contribution.
-* Use idiomatic Ruby and follow the syntax conventions below.
-
-Syntax:
-
-* Indent with two spaces, no tabs.
-* 80 characters per line.
-* No trailing whitespace. Blank lines should not have any space.
-* Prefer `&&`/`||` over `and`/`or`.
-* `MyClass.my_method(my_arg)` not `my_method( my_arg )` or `my_method my_arg`.
-* `a = b` and not `a=b`.
-* `a_method { |block| ... }` and not `a_method { | block | ... }` or
-`a_method{|block| ...}`.
-* Prefer simplicity, readability, and maintainability over terseness.
-* Follow the conventions you see used in the code already.
-
-And in case we didn't emphasize it enough: We love tests!

data/Gemfile

@@ -1,53 +0,0 @@
-source 'https://rubygems.org'
-gemspec
-
-gem 'rake'
-
-rails = ENV['RAILS'] || '7-1-stable'
-
-rails_version = case rails
-                when /\// # A path
-                  File.read(File.join(rails, "RAILS_VERSION"))
-                when /^v/ # A tagged version
-                  rails.gsub(/^v/, '')
-                else
-                  rails
-                end
-
-gem 'faker'
-gem 'sqlite3'
-gem 'pg'
-gem 'pry'
-gem 'byebug'
-
-case rails
-when /\// # A path
-  gem 'activesupport', path: "#{rails}/activesupport"
-  gem 'activemodel', path: "#{rails}/activemodel"
-  gem 'activerecord', path: "#{rails}/activerecord", require: false
-  gem 'actionpack', path: "#{rails}/actionpack"
-  gem 'actionview', path: "#{rails}/actionview"
-when /^v/ # A tagged version
-  git 'https://github.com/rails/rails.git', tag: rails do
-    gem 'activesupport'
-    gem 'activemodel'
-    gem 'activerecord', require: false
-    gem 'actionpack'
-  end
-else
-  git 'https://github.com/rails/rails.git', branch: rails do
-    gem 'activesupport'
-    gem 'activemodel'
-    gem 'activerecord', require: false
-    gem 'actionpack'
-  end
-end
-gem 'mysql2'
-
-group :test do
-  gem 'machinist', '~> 1.0.6'
-  gem 'rspec'
-  gem 'simplecov', require: false
-end
-
-gem 'rubocop', require: false

data/Rakefile

@@ -1,24 +0,0 @@
-require 'bundler'
-require 'rspec/core/rake_task'
-
-Bundler::GemHelper.install_tasks
-
-RSpec::Core::RakeTask.new(:spec) do |rspec|
-  ENV['SPEC'] = 'spec/ransack/**/*_spec.rb'
-  # With Rails 3, using `--backtrace` raises 'invalid option' when testing.
-  # With Rails 4 and 5 it can be uncommented to see the backtrace:
-  #
-  # rspec.rspec_opts = ['--backtrace']
-end
-
-task :default do
-  Rake::Task["spec"].invoke
-end
-
-desc "Open an irb session with Ransack and the sample data used in specs"
-task :console do
-  require 'pry'
-  require File.expand_path('../spec/console.rb', __FILE__)
-  ARGV.clear
-  Pry.start
-end

data/bug_report_templates/test-ransack-scope-and-column-same-name.rb

@@ -1,78 +0,0 @@
-# test-ransack-scope-and-column-same-name.rb
-
-# This is a stand-alone test case.
-
-# Run it in your console with: `ruby test-ransack-scope-and-column-same-name.rb`
-
-# If you change the gem dependencies, run it with:
-# `rm gemfile* && ruby test-ransack-scope-and-column-same-name.rb`
-
-unless File.exist?('Gemfile')
-  File.write('Gemfile', <<-GEMFILE)
-    source 'https://rubygems.org'
-
-    # Rails master
-    gem 'rails', github: 'rails/rails', branch: '7-1-stable'
-
-    # Rails last release
-    # gem 'rails'
-
-    gem 'sqlite3'
-    gem 'ransack', github: 'activerecord-hackery/ransack'
-  GEMFILE
-
-  system 'bundle install'
-end
-
-require 'bundler'
-Bundler.setup(:default)
-
-require 'active_record'
-require 'minitest/autorun'
-require 'logger'
-require 'ransack'
-
-# This connection will do for database-independent bug reports.
-ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
-ActiveRecord::Base.logger = Logger.new(STDOUT)
-
-# Display versions.
-message = "Running test case with Ruby #{RUBY_VERSION}, Active Record #{
-  ::ActiveRecord::VERSION::STRING}, Arel #{Arel::VERSION} and #{
-  ::ActiveRecord::Base.connection.adapter_name}"
-line = '=' * message.length
-puts line, message, line
-
-ActiveRecord::Schema.define do
-  create_table :users, force: true do |t|
-    t.boolean :active, null: false, default: true
-  end
-end
-
-class User < ActiveRecord::Base
-  scope :activated, -> (boolean = true) { where(active: boolean) }
-
-  private
-
-  def self.ransackable_scopes(auth_object = nil)
-    %i(activated)
-  end
-end
-
-class BugTest < Minitest::Test
-  def test_activated_scope_equals_true
-    sql = User.ransack({ activated: true }).result.to_sql
-    puts sql
-    assert_equal(
-      "SELECT \"users\".* FROM \"users\" WHERE \"users\".\"active\" = 1", sql
-      )
-  end
-
-  def test_activated_scope_equals_false
-    sql = User.ransack({ activated: false }).result.to_sql
-    puts sql
-    assert_equal(
-      "SELECT \"users\".* FROM \"users\"", sql
-      )
-  end
-end

data/bug_report_templates/test-ransacker-arel-present-predicate.rb

@@ -1,75 +0,0 @@
-# test-ransacker-arel-present-predicate.rb
-
-# Run it in your console with: `ruby test-ransacker-arel-present-predicate.rb`
-
-# If you change the gem dependencies, run it with:
-# `rm gemfile* && ruby test-ransacker-arel-present-predicate.rb`
-
-unless File.exist?('Gemfile')
-  File.write('Gemfile', <<-GEMFILE)
-    source 'https://rubygems.org'
-
-    # Rails master
-    gem 'rails', github: 'rails/rails', branch: '7-1-stable'
-
-    # Rails last release
-    # gem 'rails'
-
-    gem 'sqlite3'
-    gem 'ransack', github: 'activerecord-hackery/ransack'
-  GEMFILE
-
-  system 'bundle install'
-end
-
-require 'bundler'
-Bundler.setup(:default)
-
-require 'active_record'
-require 'minitest/autorun'
-require 'logger'
-require 'ransack'
-
-# This connection will do for database-independent bug reports.
-ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
-ActiveRecord::Base.logger = Logger.new(STDOUT)
-
-# Display versions.
-message = "Running test case with Ruby #{RUBY_VERSION}, Active Record #{
-  ::ActiveRecord::VERSION::STRING}, Arel #{Arel::VERSION} and #{
-  ::ActiveRecord::Base.connection.adapter_name}"
-line = '=' * message.length
-puts line, message, line
-
-ActiveRecord::Schema.define do
-  create_table :projects, force: true do |t|
-    t.string :name
-    t.string :number
-  end
-end
-
-class Project < ActiveRecord::Base
-  ransacker :name do
-    Arel.sql('projects.name')
-  end
-
-  ransacker :number do |parent|
-    parent.table[:number]
-  end
-
-  def self.ransackable_attributes(_auth_object = nil)
-    ["name", "number"]
-  end
-end
-
-class BugTest < Minitest::Test
-  def test_ransackers
-    sql = Project.ransack({ number_present: 1 }).result.to_sql
-    puts sql
-    assert_equal "SELECT \"projects\".* FROM \"projects\" WHERE (\"projects\".\"number\" IS NOT NULL AND \"projects\".\"number\" != '')", sql
-
-    sql = Project.ransack({ name_present: 1 }).result.to_sql
-    puts sql
-    assert_equal "SELECT \"projects\".* FROM \"projects\" WHERE (projects.name IS NOT NULL AND projects.name != '')", sql
-  end
-end

data/docs/.gitignore

@@ -1,19 +0,0 @@
-# Dependencies
-/node_modules
-
-# Production
-/build
-
-# Generated files
-.docusaurus
-.cache-loader
-
-# Misc
-.DS_Store
-.env.local
-.env.development.local
-.env.test.local
-.env.production.local
-
-yarn-debug.log*
-yarn-error.log*

data/docs/babel.config.js

@@ -1,3 +0,0 @@
-module.exports = {
-  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
-};

data/docs/blog/2022-03-27-ransack-3.0.0.md

@@ -1,20 +0,0 @@
----
-slug: ransack-3-0-0
-title: Ransack 3.0.0
-authors:
-  name: Sean Carroll
-  title: Ransack Core Team
-tags: [ransack, release]
----
-
-Ransack has been a part of many Rubyists toolboxes for years and 3.0.0 is a major release. We have a number of new features and one breaking change. As part of 3.0.0, we decided to launch this documentation website, merging in the Wiki and the content from the README.
-
-With 3.0.0 we are hoping to re-energise the community, we need help on closing out old issues, refactoring the codebase and even some design work.
-
-I also wanted to let you know that Ernie Miller (creator of Ransack) has decided to leave the project completely, he has this message for the community:
-
-> While my own personal development efforts have been spent elsewhere as of late, I'm keenly aware of how many people still depend on some of the software I originally wrote all those years ago.
-
-> That's why I'm grateful to be able to step away from the ActiveRecord Hackery organization (and, specifically, maintenance of Ransack) without impacting those users. I'm thankful that Sean, David, Greg, and others will continue to support users, and wish them the best as they move forward without me!
-
-Please join me in thanking Ernie for bringing Ransack to life, I personally think it is one of the most amazing Rails libraries out there.

data/docs/docs/getting-started/_category_.json

@@ -1,4 +0,0 @@
-{
-  "label": "Getting started",
-  "position": 2
-}

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

@@ -1,46 +0,0 @@
----
-sidebar_position: 2
-title: Advanced Mode
----
-
-
-"Advanced" searches Rails's nested attributes functionality in order to
-generate complex queries with nested AND/OR groupings, etc. This takes a bit
-more work but can generate some pretty cool search interfaces that put a lot of
-power in the hands of your users.
-
-A notable drawback with these searches is
-that the increased size of the parameter string will typically force you to use
-the HTTP POST method instead of GET.
-
-
-## Tweak your routes
-
-```ruby
-resources :people do
-  collection do
-    match 'search' => 'people#search', via: [:get, :post], as: :search
-  end
-end
-```
-
-## Add a controller action
-
-```ruby
-def search
-  index
-  render :index
-end
-```
-
-## Update your form
-
-```erb
-<%= search_form_for @q, url: search_people_path,
-                        html: { method: :post } do |f| %>
-```
-
-Once you've done so, you can make use of the helpers in [Ransack::Helpers::FormBuilder](https://github.com/activerecord-hackery/ransack/blob/main/lib/ransack/helpers/form_builder.rb) to
-construct much more complex search forms, such as the one on the
-[demo app](http://ransack-demo.herokuapp.com/users/advanced_search)
-(source code [here](https://github.com/activerecord-hackery/ransack_demo)).

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

@@ -1,47 +0,0 @@
----
-sidebar_position: 3
-title: Configuration
----
-
-
-
-Ransack may be easily configured. The best place to put configuration is in an initializer file at `config/initializers/ransack.rb`, containing code such as:
-
-```ruby
-Ransack.configure do |config|
-
-  # Change default search parameter key name.
-  # Default key name is :q
-  config.search_key = :query
-
-  # Raise errors if a query contains an unknown predicate or attribute.
-  # Default is true (do not raise error on unknown conditions).
-  config.ignore_unknown_conditions = false
-
-  # Globally display sort links without the order indicator arrow.
-  # Default is false (sort order indicators are displayed).
-  # This can also be configured individually in each sort link (see the README).
-  config.hide_sort_order_indicators = true
-
-end
-```
-
-## Custom search parameter key name
-
-Sometimes there are situations when the default search parameter name cannot be used, for instance,
-if there are two searches on one page. Another name may be set using the `search_key` option in the `ransack` or `search` methods in the controller, and in the `@search_form_for` method in the view.
-
-### In the controller
-
-```ruby
-@search = Log.ransack(params[:log_search], search_key: :log_search)
-# or
-@search = Log.search(params[:log_search], search_key: :log_search)
-```
-
-### In the view
-
-```erb
-<%= f.search_form_for @search, as: :log_search %>
-<%= sort_link(@search) %>
-```

data/docs/docs/getting-started/search-matches.md

@@ -1,67 +0,0 @@
----
-title: Search Matchers
----
-
-### Search Matchers
-
-List of all possible predicates
-
-
-| Predicate | Description | Notes |
-| ------------- | ------------- |-------- |
-| `*_eq`  | equal  | |
-| `*_not_eq` | not equal | |
-| `*_matches` | matches with `LIKE` | e.g. `q[email_matches]=%@gmail.com`|
-| `*_does_not_match` | does not match with `LIKE` | |
-| `*_matches_any` | Matches any | |
-| `*_matches_all` | Matches all  | |
-| `*_does_not_match_any` | Does not match any | |
-| `*_does_not_match_all` | Does not match all | |
-| `*_lt` | less than | |
-| `*_lteq` | less than or equal | |
-| `*_gt` | greater than | |
-| `*_gteq` | greater than or equal | |
-| `*_present` | not null and not empty | Only compatible with string columns. Example: `q[name_present]=1` (SQL: `col is not null AND col != ''`) |
-| `*_blank` | is null or empty. | (SQL: `col is null OR col = ''`) |
-| `*_null` | is null | |
-| `*_not_null` | is not null | |
-| `*_in` | match any values in array | e.g. `q[name_in][]=Alice&q[name_in][]=Bob` |
-| `*_not_in` | match none of values in array | |
-| `*_lt_any` | Less than any |  SQL: `col < value1 OR col < value2` |
-| `*_lteq_any` | Less than or equal to any | |
-| `*_gt_any` | Greater than any | |
-| `*_gteq_any` | Greater than or equal to any | |
-| `*_lt_all` | Less than all | SQL: `col < value1 AND col < value2` |
-| `*_lteq_all` | Less than or equal to all | |
-| `*_gt_all` | Greater than all | |
-| `*_gteq_all` | Greater than or equal to all | |
-| `*_not_eq_all` | none of values in a set | |
-| `*_start` | Starts with | SQL: `col LIKE 'value%'` |
-| `*_not_start` | Does not start with | |
-| `*_start_any` | Starts with any of | |
-| `*_start_all` | Starts with all of | |
-| `*_not_start_any` | Does not start with any of | |
-| `*_not_start_all` | Does not start with all of | |
-| `*_end` | Ends with | SQL: `col LIKE '%value'` |
-| `*_not_end` | Does not end with | |
-| `*_end_any` | Ends with any of | |
-| `*_end_all` | Ends with all of | |
-| `*_not_end_any` | | |
-| `*_not_end_all` | | |
-| `*_cont` | Contains value | uses `LIKE` |
-| `*_cont_any` | Contains any of | |
-| `*_cont_all` | Contains all of | |
-| `*_not_cont` | Does not contain |
-| `*_not_cont_any` | Does not contain any of | |
-| `*_not_cont_all` | Does not contain all of | |
-| `*_i_cont` | Contains value with case insensitive | uses `ILIKE` |
-| `*_i_cont_any` | Contains any of values with case insensitive | |
-| `*_i_cont_all` | Contains all of values with case insensitive | |
-| `*_not_i_cont` | Does not contain with case insensitive |
-| `*_not_i_cont_any` | Does not contain any of values with case insensitive | |
-| `*_not_i_cont_all` | Does not contain all of values with case insensitive | |
-| `*_true` | is true | |
-| `*_false` | is false | |
-
-
-See full list: https://github.com/activerecord-hackery/ransack/blob/main/lib/ransack/locale/en.yml#L16