kotovalexarian-likes-github
/
activerecord-hackery--ransack
mirror of https://github.com/activerecord-hackery/ransack.git
1
0
Fork 0
Code Releases Activity

Clarify Ransack#search vs #ransack [skip ci]

This commit is contained in:
jonatack 2015-01-14 13:09:45 +01:00
parent 6c59e96ada
commit e045e37f37
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -265,17 +265,18 @@ construct much more complex search forms, such as the one on the
### Ransack #search method
Ransack will try to to make `#search` available in your models, but in the case
that `#search` has already been defined, you can always use the default
`#ransack` method. For example, the following would be equivalent:
Ransack will try to to make the class method `#search` available in your
models, but if `#search` has already been defined elsewhere, you can always use
the default `#ransack` class method. So the following are equivalent:
```ruby
Article.ransack(params[:q])
Article.search(params[:q])
```
Users have reported issues of name conflicts with other gems, so `#search` may
possibly be deprecated in the next major version of Ransack (2.0).
Users have reported issues of `#search` name conflicts with other gems, so
the `#search` method alias might be deprecated in the next major version of
Ransack (2.0). It's advisable to use the default `#ransack` instead.
For now, if Ransack's `#search` method conflicts with the name of another
method named `search` in your code or another gem, you may resolve it either by