ransack 1.7.0 → 2.4.1

data/CHANGELOG.md

@@ -1,9 +1,458 @@
 # Change Log
 
-## Unreleased
+* Add `ActiveRecord::Base.ransack!` which raises error if passed unknown condition
 
+  *Aaron Lipman*
+
+## 2.4.0 - 2020-11-27
+
+*
+  PR []()
+
+* Support ActiveRecord 6.1.0.rc1.
+  PR [1172](https://github.com/activerecord-hackery/ransack/pull/1172)
+
+* Fix for ActiveRecord 5.2.4 (note security fix in 5.2.4.2 for ActiveView's escape_javascript CVE-2020-5267 for all earlier versions)
+
+* Drop support for ActiveRecord older than 5.2.4.
+  PR [1166](https://github.com/activerecord-hackery/ransack/pull/1166)
+
+## 2.3.2 - 2020-01-11
+
+* Breakfix to bump Polyamorous
+
+## 2.3.1 - 2020-01-11
+
+* Drop support for Active Record 5.0, 5.1, and 5.2.0.
+  PR [#1073](https://github.com/activerecord-hackery/ransack/pull/1073)
+
+* Drop support for rubies under 2.3.
+  PR [#1070](https://github.com/activerecord-hackery/ransack/pull/1070)
+
+  ... and others
+
+## 2.3.0 - 2019-08-18
+
+* Arabic translations PR [979](https://github.com/activerecord-hackery/ransack/pull/979)
+
+* Rails 6 PR [1027](https://github.com/activerecord-hackery/ransack/pull/1027)
+ *vrodokanakis*
+
+* Make polyamorous a separate gem PR [1002](https://github.com/activerecord-hackery/ransack/pull/1002)
+
+* Catalan translations PR[1007](https://github.com/activerecord-hackery/ransack/pull/1007)
+ *roslavych*
+
+* Don't escape period characters with wildcard searches in mysql2 PR [1013](https://github.com/activerecord-hackery/ransack/pull/1013)
+ *daflip*
+
+* Farsi translations PR [1030](https://github.com/activerecord-hackery/ransack/pull/1030)
+
+* Finnish translations PR [1049](https://github.com/activerecord-hackery/ransack/pull/1049)
+
+* Fix wrong table alias when using nested join. for ActiveRecord >= 5.2
+  PR [374](https://github.com/activerecord-hackery/ransack/pull/374)
+
+  *hiichan*
+
+## Version 2.1.1 - 2018-12-05
+
+* Add `arabic` translation
+  https://github.com/activerecord-hackery/ransack/pull/979
+
+* Deprecate #search
+  PR [975](https://github.com/activerecord-hackery/ransack/pull/975)
+
+## Version 2.1.0 - 2018-10-26
+
+* Add support for sorting by scopes
+  PR [973](https://github.com/activerecord-hackery/ransack/pull/973)
+
+  *Diego Borges*
+
+* Added a new logo for Ransack
+  PR [972](https://github.com/activerecord-hackery/ransack/pull/972)
+
+  *Anıl Kılıç*, *Greg Molnar*
+
+* Greek translations
+  PR [971](https://github.com/activerecord-hackery/ransack/pull/971)
+  PR [960](https://github.com/activerecord-hackery/ransack/pull/960)
+
+  *Sean Carroll*, *Greg Molnar*
+
+* README improvements
+  PR [963](https://github.com/activerecord-hackery/ransack/pull/963)
+
+  *tommaso1*
+
+* Bulgarian translations
+  PR [961](https://github.com/activerecord-hackery/ransack/pull/961)
+
+  *Sean Carroll*
+
+* README improvements
+  PR [956](https://github.com/activerecord-hackery/ransack/pull/956)
+
+  *Alex Konoval*
+
+* Remove lib/ransack/adapters/active_record/compat.rb
+  PR [954](https://github.com/activerecord-hackery/ransack/pull/954)
+
+  *Ryuta Kamizono*
+
+* Remove unused aliases
+  PR [953](https://github.com/activerecord-hackery/ransack/pull/953)
+
+  *Ryuta Kamizono*
+
+## Version 2.0.1 - 2018-08-18
+
+* Don't return association if table is nil
+  PR [952](https://github.com/activerecord-hackery/ransack/pull/952)
+
+  *Christian Gregg*
+
+## Version 2.0.0 - 2018-08-09
+
+* Add support for Active Record 5.2.1
+  PR [#938](https://github.com/activerecord-hackery/ransack/pull/938)
+
+* Fix sort with joins on existing association
+  PR [#937](https://github.com/activerecord-hackery/ransack/pull/937)
+
+* Add the ability to skip arg sanitization on a per scope basis. Using
+  `ransackable_scopes_skip_sanitize_args`, users can define a list of
+  scopes which will bypass parameter sanitization. This allows passing 0,
+  1, t, f, etc. to a scope as an actual parameter.
+  PR [#933](https://github.com/activerecord-hackery/ransack/pull/933)
+
+* Drop support for Active Record < 5.0.
+  PR [#929](https://github.com/activerecord-hackery/ransack/pull/929)
+
+* Extract mongoid support to a separate gem.
+  PR [#928](https://github.com/activerecord-hackery/ransack/pull/928)
+
+* Absorb polyamorous
+  PR [#927](https://github.com/activerecord-hackery/ransack/pull/927)
+
+* Fix broken monkey patch of #form_with
+  PR [#922](https://github.com/activerecord-hackery/ransack/pull/922)
+
+## Version 1.8.8 - 2018-03-16
+* Fix multiple database support
+  PR [#893](https://github.com/activerecord-hackery/ransack/pull/893)
+
+* Updated Dutch translations
+  PR [#887](https://github.com/activerecord-hackery/ransack/pull/887)
+
+* Fixed no method error 'asc' for Rails 4.2
+  PR [#885](https://github.com/activerecord-hackery/ransack/pull/885)
+
+
+## Version 1.8.7 - 2018-02-05
+
+* Rails 5.2 support
+  PR [#868](https://github.com/activerecord-hackery/ransack/pull/868)
+
+* Lock pg gem to 0.21 to support older releases
+
+* Warnings cleanup
+  PR [#867](https://github.com/activerecord-hackery/ransack/pull/867)
+
+* Wildcard escaping
+  PR [#866]
+
+## Version 1.8.6 - 2018-01-23
+
+### Added
+
+* Improve memory usage
+  PR [#820](https://github.com/activerecord-hackery/ransack/pull/820)
+
+* Bump Polyamorous version to 1.3.2
+  PR [#858](https://github.com/activerecord-hackery/ransack/pull/858)
+
+## Version 1.8.5
+
+### Added
+
+* Added Turkish Translations
+  PR [#835](https://github.com/activerecord-hackery/ransack/issues/835).
+
+## Version 1.8.4 - 2017-10-09
+
+### Added
+
+*   Added italian translations.
+    PR [#833](https://github.com/activerecord-hackery/ransack/pull/833).
+
+*   Add an optional default arrow for unsorted fields.
+    PR [#816](https://github.com/activerecord-hackery/ransack/pull/816/files).
+
+### Fixed
+
+*   Cast Postgres money type to float.
+    PR [#823](https://github.com/activerecord-hackery/ransack/pull/823).
+
+*   Fix the bug in sort_link, which causes the multiple fields option to be
+    ignored when block parameter is specified.
+    PR [#818](https://github.com/activerecord-hackery/ransack/pull/818).
+
+*   No need pass some arugments to JoinAssociation#join_constraints in Rails 5.1.
+    PR [#814](https://github.com/activerecord-hackery/ransack/pull/814).
+    Fixes [#807](https://github.com/activerecord-hackery/ransack/issues/807).
+    Reference [rails/rails#28267](https://github.com/rails/rails/pull/28267)
+    and [rails/rails#27851](https://github.com/rails/rails/pull/27851).
+
+## Version 1.8.3 - 2017-06-15
+
+### Added
+
+*   Add a config option to customize the up and down arrows used for direction
+    indicators in Ransack sort links.
+    PR [#726](https://github.com/activerecord-hackery/ransack/pull/726).
+
+    *Garett Arrowood*
+
+*   Add ability to turn off sanitization of custom scope arguments.
+    PR [#742](https://github.com/activerecord-hackery/ransack/pull/742).
+
+    *Garett Arrowood*
+
+### Fixed
+
+*   Use class attributes properly so that inheritance is respected.
+    PR [#717](https://github.com/activerecord-hackery/ransack/pull/717).
+    This fixes two bugs:
+
+    1. In the Mongoid adapter, subclasses were not properly inheriting their
+       parents' Ransack aliases because each class defined its own set of
+       aliases.
+
+    2. In the Active Record adapter, Ransack aliases were defined in such a way
+       that the parent's (and grandparent's, etc.) aliases were overwritten by
+       the child, meaning that all aliases were ultimately kept on
+       `ActiveRecord::Base`. This had the unfortunate effect of enforcing
+       uniqueness of Ransack alias names across all models rather than per
+       model. Depending on the load order of models, earlier definitions of an
+       alias in other models were clobbered.
+
+    *Steve Richert (laserlemon)*
+
+*   Use `ActiveSupport.on_load` hooks to include Ransack in Active Record,
+    avoiding autoloading the constant too soon. PR
+    [#719](https://github.com/activerecord-hackery/ransack/pull/719). Reference:
+    [This comment in rails#23589]
+    (https://github.com/rails/rails/issues/23589#issuecomment-229247727).
+
+    *Yuji Yaginuma (y-yagi)*
+
+## Version 1.8.2 - 2016-08-08
+### Fixed
+
+*   Fix empty attribute_fields regression in advanced search mode introduced by
+    [235eae3](https://github.com/activerecord-hackery/ransack/commit/235eae3).
+    Closes
+    [#701](https://github.com/activerecord-hackery/ransack/issues/701). Commit
+    [2839acf](https://github.com/activerecord-hackery/ransack/commit/2839acf).
+
+    *Jon Atack, Jay Dorsey, Stefan Haslinger, Igor Kasyanchuk*
+
+### Added
+
+*   Add `sort_url` view helper that returns only the url of a `sort_link`. PR
+    [#706](https://github.com/activerecord-hackery/ransack/pull/706).
+
+    *amatotsuji*
+
+## Version 1.8.1 - 2016-07-27
+### Fixed
+
+*   Fix `rake console` to run a command-line console with ransack + seed data.
+    Commits
+    [2cc781e](https://github.com/activerecord-hackery/ransack/commit/2cc781e),
+    [f2e85ad](https://github.com/activerecord-hackery/ransack/commit/f2e85ad),
+    [6a059ba](https://github.com/activerecord-hackery/ransack/commit/6a059ba).
+
+    *Jon Atack*
+
+*   Fix returned value of `Ransack::Nodes::Condition#format_predicate`. PR
+    [#692](https://github.com/activerecord-hackery/ransack/pull/692).
+
+    *Masahiro Saito*
+
+*   Better test coverage on passing arrays to ransackers. Commit
+    [98df2c5](https://github.com/activerecord-hackery/ransack/commit/98df2c5).
+
+    *Jon Atack*
+
+*   Fix missing Ransack::Constants::ASC constant. Commit
+    [aece23c](https://github.com/activerecord-hackery/ransack/commit/aece23c).
+
+    *Jon Atack*
+
+### Changed
+
+*   Replace arrow constants with frozen strings in public methods. Commits
+    [c0dff33](https://github.com/activerecord-hackery/ransack/commit/c0dff33),
+    [e489ca7](https://github.com/activerecord-hackery/ransack/commit/e489ca7).
+
+    *Jon Atack*
+
+## Version 1.8.0 - 2016-07-14
+### Added
+
+*   Support Mongoid 5. PR [#636](https://github.com/activerecord-hackery/ransack/pull/636), commit
+    [9e5faf4](https://github.com/activerecord-hackery/ransack/commit/9e5faf4).
+
+    *Josef Šimánek*
+
+*   Add optional block argument for the `sort_link` method. PR
+    [#604](https://github.com/activerecord-hackery/ransack/pull/604).
+
+    *Andrea Dal Ponte*
+
+*   Add `ransack_alias` to allow users to customize the names for long
+    ransack field names. PR
+    [#623](https://github.com/activerecord-hackery/ransack/pull/623).
+
+    *Ray Zane*
+
+*   Add support for searching on attributes that have been added to
+    Active Record models with `alias_attribute` (Rails >= 4 only). PR
+    [#592](https://github.com/activerecord-hackery/ransack/pull/592), commit
+    [549342a](https://github.com/activerecord-hackery/ransack/commit/549342a).
+
+    *Marten Schilstra*
+
+*   Add ability to globally hide sort link order indicator arrows with
+    `Ransack.configure#hide_sort_order_indicators = true`. PR
+    [#577](https://github.com/activerecord-hackery/ransack/pull/577), commit
+    [95d4591](https://github.com/activerecord-hackery/ransack/commit/95d4591).
+
+    *Josh Hunter*, *Jon Atack*
+
+*   Add test for `ActionController:Parameter` object params in `sort_link` to
+    ensure Ransack is handling the Rails 5 changes correctly. Commit
+    [b1cfed8](https://github.com/activerecord-hackery/ransack/commit/b1cfed8).
+
+    *Ryan Wood*
+
+*   Add failing tests to facilitate work on issue
+    [#566](https://github.com/activerecord-hackery/ransack/issues/566)
+    of passing boolean values to search scopes. PR
+    [#575](https://github.com/activerecord-hackery/ransack/pull/575).
+
+    *Marcel Eeken*
+
+*   Add i18n locale files:
+  *   Taiwanese Hokkien/Mandarin (`zh-TW.yml`). PR
+    [#674](https://github.com/activerecord-hackery/ransack/pull/674). *Sibevin Wang*
+  *   Danish (`da.yml`). PR
+    [#663](https://github.com/activerecord-hackery/ransack/pull/663). *Kasper Johansen*
+  *   Brazilian Portuguese (`pt-BR.yml`). PR
+    [#581](https://github.com/activerecord-hackery/ransack/pull/581). *Diego Henrique Domingues*
+  *   Indonesian (Bahasa) (`id.yml`). PR
+    [#612](https://github.com/activerecord-hackery/ransack/pull/612). *Adam Pahlevi Baihaqi*
+  *   Japanese (`ja.yml`). PR
+    [#622](https://github.com/activerecord-hackery/ransack/pull/622). *Masanobu Mizutani*
+
+### Fixed
+
+*   In `FormHelper::SortLink#parameters_hash`, convert `params#to_unsafe_h`
+    only if Rails 5, and add tests. Commit
+    [14e66ca](https://github.com/activerecord-hackery/ransack/commit/14e66ca).
+
+    *Jon Atack*
+
+*   Respect negative conditions for collection associations and fix Mongoid
+    compat. PR [#645](https://github.com/activerecord-hackery/ransack/pull/645).
+
+    *Andrew Vit*
+
+*   Ensure conditions differing only by ransacker_args aren't filtered out.
+    PR [#665](https://github.com/activerecord-hackery/ransack/pull/665).
+
+    *Andrew Porterfield*
+
+*   Fix using aliased attributes in association searches, and add a failing
+    spec. PR [#602](https://github.com/activerecord-hackery/ransack/pull/602).
+
+    *Marten Schilstra*
+
+*   Replace Active Record `table_exists?` API that was deprecated
+    [here](https://github.com/rails/rails/commit/152b85f) in Rails 5. Commit
+    [c9d2297](https://github.com/activerecord-hackery/ransack/commit/c9d2297).
+
+    *Jon Atack*
+
+*   Adapt to changes in Rails 5 where AC::Parameters composes a HWIA instead of
+    inheriting from Hash starting from Rails commit rails/rails@14a3bd5. Commit
+    [ceafc05](https://github.com/activerecord-hackery/ransack/commit/ceafc05).
+
+    *Jon Atack*
+
+*   Fix test `#sort_link with hide order indicator set to true` to fail properly
+    ([4f65b09](https://github.com/activerecord-hackery/ransack/commit/4f65b09)).
+    This spec, added in
+    [#473](https://github.com/activerecord-hackery/ransack/pull/473), tested
+    the presence of the attribute name instead of the absence of the order
+    indicators and did not fail when it should.
+
+    *Josh Hunter*, *Jon Atack*
+
+*   Fix rspec-mocks `stub` deprecation warnings when running the tests. Commit
+    [600892e](https://github.com/activerecord-hackery/ransack/commit/600892e).
+
+    *Jon Atack*
+
+*   Revert
+    [f858dd6](https://github.com/activerecord-hackery/ransack/commit/f858dd6).
+    Fixes [#553](https://github.com/activerecord-hackery/ransack/issues/553)
+    performance regression with the SQL Server adapter.
+
+    *sschwing3*
+
+*   Fix invalid Chinese I18n locale file name by replacing "zh" with "zh-CN".
+    PR [#590](https://github.com/activerecord-hackery/ransack/pull/590).
+
+    *Ethan Yang*
+
+### Changed
+
+*   Memory/speed perf improvement: Freeze strings in array global constants and
+    partially move from using global string constants to frozen strings
+    ([381a83c](https://github.com/activerecord-hackery/ransack/commit/381a83c)
+    and
+    [ce114ec](https://github.com/activerecord-hackery/ransack/commit/ce114ec)).
+
+    *Jon Atack*
+
+*   Escape underscore `_` wildcard characters with PostgreSQL and MySQL. PR
+    [#584](https://github.com/activerecord-hackery/ransack/issues/584).
+
+    *Igor Dobryn*
+
+*   Refactor `Ransack::Adapters` from conditionals to classes
+    ([94a404c](https://github.com/activerecord-hackery/ransack/commit/94a404c)).
+
+    *Jon Atack*
 
 ## Version 1.7.0 - 2015-08-20
+### Added
+
+*   Add Mongoid support for referenced/embedded relations. PR
+    [#498](https://github.com/activerecord-hackery/ransack/pull/498).
+    TODO: Missing spec coverage! Add documentation!
+
+    *Penn Su*
+
+*   Add German i18n locale file (`de.yml`). PR
+    [#537](https://github.com/activerecord-hackery/ransack/pull/537).
+
+    *Philipp Weissensteiner*
+
 ### Fixed
 
 *   Fix
@@ -44,8 +493,8 @@
 
     *Andrew Vit*
 
-*   Fix RSpec `its` method deprecation warning: 'Use of rspec-core's `its`
-    method is deprecated. Use the rspec-its gem instead
+*   Fix RSpec `its` method deprecation warning: "Use of rspec-core's its
+    method is deprecated. Use the rspec-its gem instead"
     ([c09aa17](https://github.com/activerecord-hackery/ransack/commit/c09aa17)).
 
 *   Fix deprecated RSpec syntax in `grouping_spec.rb`
@@ -53,24 +502,11 @@
 
     *Jon Atack*
 
-### Added
-
-*   Add Mongoid support for referenced/embedded relations. PR
-    [#498](https://github.com/activerecord-hackery/ransack/pull/498).
-    TODO: Missing spec coverage! Add documentation!
-
-    *Penn Su*
-
-*   Add German locale file (de.yml). PR
-    [#537](https://github.com/activerecord-hackery/ransack/pull/537).
-
-    *Philipp Weissensteiner*
-
 ### Changed
 
 *   Upgrade gemspec dependencies: MySQL2 from '0.3.14' to '0.3.18', and RSpec
     from '~> 2.14.0' to '~> 2' which loads 2.99
-    ([000cd2](https://github.com/activerecord-hackery/ransack/commit/000cd2)).
+    ([000cd22](https://github.com/activerecord-hackery/ransack/commit/000cd22)).
 
 *   Upgrade spec suite to RSpec 3 `expect` syntax backward compatible with
     RSpec 2.9
@@ -89,10 +525,12 @@
 
 
 ## Version 1.6.6 - 2015-04-05
-### Changed
+### Added
 
-*   Upgrade Polyamorous dependency to version 1.2.0, which uses `Module#prepend`
-    instead of `alias_method` for hooking into Active Record (with Ruby 2.x).
+*   Add the Ruby version to the the header message that shows the database,
+    Active Record and Arel versions when running tests.
+
+*   Add Code Climate analysis.
 
     *Jon Atack*
 
@@ -117,12 +555,10 @@
 
     *Jon Atack*
 
-### Added
-
-*   Add the Ruby version to the the header message that shows the database,
-    Active Record and Arel versions when running tests.
+### Changed
 
-*   Add Code Climate analysis.
+*   Upgrade Polyamorous dependency to version 1.2.0, which uses `Module#prepend`
+    instead of `alias_method` for hooking into Active Record (with Ruby 2.x).
 
     *Jon Atack*
 
@@ -239,7 +675,7 @@
 
     *Josh Kovach*
 
-*   Add an sort_link option to not display sort direction arrows
+*   Add an sort_link option to not display sort order indicator arrows
     ([PR #473](https://github.com/activerecord-hackery/ransack/pull/473)).
 
     *Fred Bergman*
@@ -427,7 +863,7 @@
 
     *Pedro Chambino*
 
-*   Add `ro.yml` Romanian translation file.
+*   Add Romanian i18n locale file (`ro.yml`).
 
     *Andreas Philippi*
 

data/CONTRIBUTING.md

@@ -5,15 +5,15 @@ 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.
 
-Please do not use the issue tracker personal support requests. Stack Overflow
-is a better place for that where a wider community can help you.
-
 Steps:
 
 1. **Use the GitHub issue search** — check if the issue has already been
@@ -22,18 +22,25 @@ Steps:
 2. **Check if the issue has been fixed** — try to reproduce it using the
    `master` branch in the repository.
 
-3. **Isolate and report the problem** — ideally create a reduced test
-   case.
+3. **Isolate the real problem** — make sure the issue is really a bug in
+   Ransack and not in your code or another gem.
 
-When filing an issue, please provide these details:
+4. **Report the issue** by providing the link to a self-contained
+   gist like [this](https://gist.github.com/jonatack/63048bc5062a84ba9e09) or
+   [this](https://gist.github.com/jonatack/5df41a0edb53b7bad989). Please use
+   these code examples as a bug-report template for your Ransack issue!
 
-* A comprehensive list of steps to reproduce the issue :smiley: or even better, a failing spec!
-* The versions of Ruby, Rails, Ransack and your operating system and database.
+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).
 
-Any issue that is open for 14 days without actionable information or activity
-will be marked as "stalled" and then closed. Stalled issues can be re-opened
-if actionable information to reproduce the issue is provided.
+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
 
@@ -57,6 +64,9 @@ Here's a quick guide:
 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='5-2-stable' bundle install`
+
+        $ RAILS='5-2-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:
@@ -65,11 +75,30 @@ Here's a quick guide:
 
    The test suite runs by default with SQLite3. To run the test suite with PostgreSQL or MySQL, use:
 
-        $ DB=postgresql bundle exec rake spec (`DB=pg` & `DB=postgres` work too)
+        $ DB=pg bundle exec rake spec (`DB=postgres` & `DB=postgresql` work too)
         $ DB=mysql bundle exec rake spec
 
-5. Hack away! Please use Ruby features that are compatible down to Ruby 1.9.
-   Since version 1.5, Ransack no longer maintains Ruby 1.8 compatibility.
+   For Postgres and MySQL, databases are expected to exist, called 'ransack'. To create use these commands (assuming OS X and Homebrew):
+
+   ### Postgres
+       $ createdb ransack 
+
+   ### MySQL
+       $ 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>`
+
+        $ 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"`
+
+        $ bundle exec rspec spec/ransack/search_spec.rb -e "accepts a context option"
+
+5. Hack away! Please use Ruby features that are compatible down to Ruby 2.3.
+   Since version 2.3.1, Ransack no longer maintains Ruby 2.2 compatibility.
 
 6. Add tests for your changes. Only refactoring and documentation changes
    require no new tests. If you are adding functionality or fixing a bug, we
@@ -80,20 +109,21 @@ Here's a quick guide:
 8. Update the Change Log. If you are adding new functionality, document it in
    the README.
 
-9. Commit your changes (`git commit -am 'Add feature/fix bug/improve docs'`).
+9. Make sure git knows your name and email address in your `~/.gitconfig` file:
 
-10. If necessary, rebase your commits into logical chunks, without errors. To
+        $ git config --global user.name "Your Name"
+        $ git config --global user.email "contributor@example.com"
+
+10. Commit your changes (`git commit -am 'Add feature/fix bug/improve docs'`).
+
+11. 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
+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.
 
-12. If your pull request only contains documentation changes, please remember
-   to add `[skip ci]` to the beginning of your commit message so the Travis
-   test suite doesn't :runner: needlessly.
-
 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.