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

[skip ci] README: Fix RubyGems YARD rendering, add Code Climate 

badge.

Add ‘Ransack’ to the specs header message.
This commit is contained in:
Jon Atack 2015-04-05 15:41:02 +05:30
parent ff774ed84d
commit 211191e737
2 changed files with 12 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -4,6 +4,8 @@
(https://travis-ci.org/activerecord-hackery/ransack)
[![Gem Version](https://badge.fury.io/rb/ransack.svg)]
(http://badge.fury.io/rb/ransack)
[![Code Climate](https://codeclimate.com/github/activerecord-hackery/ransack/badges/gpa.svg)]
(https://codeclimate.com/github/activerecord-hackery/ransack)
Ransack is a rewrite of [MetaSearch]
(https://github.com/activerecord-hackery/meta_search)
@ -27,7 +29,7 @@ instead.
If you're viewing this at
[github.com/activerecord-hackery/ransack](https://github.com/activerecord-hackery/ransack),
you're reading the documentation for the master branch with the latest features.
[View documentation for the last release (1.6.5).]
[View documentation for the last release (1.6.6).]
(https://github.com/activerecord-hackery/ransack/tree/v1.6.5)
## Getting started
@ -120,7 +122,7 @@ The two primary Ransack view helpers are `search_form_for` and `sort_link`,
which are defined in
[Ransack::Helpers::FormHelper](lib/ransack/helpers/form_helper.rb).
#####Ransack's `search_form_for` helper replaces `form_for` for creating the view search form:
####Ransack's `search_form_for` helper replaces `form_for` for creating the view search form
```erb
<%= search_form_for @q do |f| %>
@ -142,20 +144,21 @@ which are defined in
```
`cont` (contains) and `start` (starts with) are just two of the available
search predicates. See [Constants]
(https://github.com/activerecord-hackery/ransack/blob/master/lib/ransack/constants.rb)
for a full list and the [wiki]
(https://github.com/activerecord-hackery/ransack/wiki/Basic-Searching)
search predicates. See
[Constants](https://github.com/activerecord-hackery/ransack/blob/master/lib/ransack/constants.rb)
for a full list and the
[wiki](https://github.com/activerecord-hackery/ransack/wiki/Basic-Searching)
for more information.
The `search_form_for` answer format can be set like this:
```erb
<%= search_form_for(@q, format: :pdf) do |f| %>
<%= search_form_for(@q, format: :json) do |f| %>
```
#####Ransack's `sort_link` helper creates table headers that are sortable links:
####Ransack's `sort_link` helper creates table headers that are sortable links
```erb
<%= sort_link(@q, :name) %>

3
spec/spec_helper.rb
View File

@ -28,7 +28,8 @@ RSpec.configure do |config|
config.alias_it_should_behave_like_to :it_has_behavior, 'has behavior'
config.before(:suite) do
message = "Running specs with #{ActiveRecord::Base.connection.adapter_name
message = "Running Ransack specs with #{
ActiveRecord::Base.connection.adapter_name
}, Active Record #{::ActiveRecord::VERSION::STRING}, Arel #{Arel::VERSION
} and Ruby #{RUBY_VERSION}"
line = '=' * message.length