Sha256: c74ac6970b140d1b6f1593529b616396728436b16be44a15a4d7fe25240fa175

Contents?: true

Size: 1.52 KB

Versions: 1

Compression:

Stored size: 1.52 KB

Contents

# RubySimpleSearch

RubySimpleSearch allows to search on the table fields. 
e.g. string and text fields.

Sometimes we want to do search on the post's title and content
or user's email, username and description or on other models but in same way.
For those searches we use MySql's or Postgresql's LIKE operator to get the
results. While doing same thing on the differet models you actually add lots of 
duplications in your code.

To avoid duplicating the same code, use RubySimpleSearch :)

## Installation

Add this line to your application's Gemfile:

    gem 'ruby_simple_search'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install ruby_simple_search

## Usage

Define attributes that you want to search through RubySimpleSearch

```Ruby
class Post < ActiveActiveRecord::Base
  include RubySimpleSearch

  simple_search_attributes :title, :description
end

class User < < ActiveActiveRecord::Base
  include RubySimpleSearch

  simple_search_attributes :email, :username, :address
end

Post.simple_serach('tutorial')
# => posts which have 'tutorial' text in title or in description fields

User.simple_search('Mechanciles')
# => users which have 'Mechanicles' text in the email, username and in address

Model.simple_search('string')
# => will return ActiveRecord::Relation object
```
## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
ruby_simple_search-0.0.1 README.md