Comfortable searching pants for ActiveRecord Models. Stretchie simplifies using elastic search in your models and provides hooks to ease testing.
Stretchie simply builds on elasticsearch-model, allowing you to pull the details out into a concern.
With a model like this:
class User < ActiveRecord::Base
attr_accessor :name, :email, :misc_id
endYour concern could look like this:
module Search
module User
extend ActiveSupport::Concern
include Stretchie::Pants
included do
settings index: { number_of_shards: 1 } do
mappings dynamic: 'false' do
indexes :name, analyzer: 'whitespace', index_options: 'offsets'
indexes :email
indexes :misc_id
indexes :sortable_name
end
end
end
def as_indexed_json(options={})
json = as_json(only: [:name, :email, :misc_id])
json['sortable_name'] = self.name.downcase
json
end
end
endAnd you would add this to your model:
include Search::UserIf you have linked models, you can have them re-index automatically with index_dependent_models:
class User < ActiveRecord::Base
include Search::User
attr_accessor :name, :email
has_may :tags
end
class Tag < ActiveRecord::Base
include Search::Tag
attr_accessor :name
belongs_to :user
end
module Search
module Tag
extend ActiveSupport::Concern
include Stretchie::Pants
included do
settings index: { number_of_shards: 1 } do
mappings dynamic: 'false' do
indexes :name, analyzer: 'whitespace', index_options: 'offsets'
indexes :sortable_name
end
end
end
def as_indexed_json(options={})
json = as_json(only: [:name])
json['sortable_name'] = self.name.downcase
json
end
def index_dependent_models
self.users
end
end
endCreate / Update your indices:
Stretchie.update_indices
Stretchie.update_indices :usersDelete your indices:
Stretchie.delete_indices
Stretchie.delete_indices :usersRefresh your indices:
Stretchie.refresh_indices
Stretchie.refresh_indices :usersTo add or update changes:
user = User.create(name: 'Adam Bregenzer', email: 'adam@bregenzer.net')
user.update_in_indexTo remove:
user.delete_from_indexYou can do a simple search:
User.search 'Adam'
User.search 'Adam', limit: 10, skip: 20, order: {'name' => 'asc'}You can scope searches:
Tag.search 'rails', terms: {'user_id': current_user.id}You can search specific fields:
User.field_search :email, 'adam@bregenzer.net'You can search however you want:
User.query_search {'match' => {'name' => 'Foo'}}Let me know what you think, if you use it, etc.
Add this line to your application's Gemfile:
gem 'stretchie'
And then execute:
$ bundle
Or install it yourself as:
$ gem install stretchie
- Fork it ( https://github.com/adambregenzer/stretchie/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request