ActiverecordReindex

Add Elasticsearch reindex option to ActiveRecord associations

Add this line to your application's Gemfile:

gem 'activerecord_reindex'

And then execute:

$ bundle

Or install it yourself as:

$ gem install activerecord_reindex

0. ActiveRecord 5.0+
1. elasticsearch-model gem installed
2. model that will be reindexed inherits from Elasticsearch::Model
3. model is inherited from ActiveRecord::Base

Add this to your resque:setup rake task(or define it this way):

  namespace :resque do
    task :setup do
      require 'resque'
      require 'activerecord_reindex'
    end
  end

This will make gem's job class available for jobs.

To reindex associted records just add reindex: options to any ActiveRecord association.

Acceptable values are true, :async.

It will hook on:

1. record update
2. record destroy
3. record reindex

and reindex records reflected in given association.

Reindexing strategy will depend on specified reindex value.

reindex: true # associated in given association records will be reindexed in the same time as
              # current record was updated\destroy\reindexed(Syncronously)

reindex: :async # records will be reindexed (Asyncronously) using ActiveJob as adapter.

There may be a case where you want to trigger recursive reindexation only if some attribute changed. You can solve this with following configuration:

class Tag < ActiveRecord::Base

  self.reindex_attr_whitelist = ['name']
  self.reindex_attr_blacklist = ['email']

end

whitelist/blacklist can be optionally defined in any given model if desired

class Tag < ActiveRecord::Base

  has_many :taggings, reindex: :async
  has_many :super_taggings

end

class Tagging < ActiveRecord::Base

  belongs_to :tag, reindex: true

end

class SuperTagging < ActiveRecord::Base

  belongs_to :tag, reindex: :async

end

In this scenario:

If record of Tag model was updated then:

1. all taggings records associated with given tag will be queued as different jobs for reindexing.
2. super_taggings will remain as is and will be ignored

If record of Tagging model was updated then:

1. associated tag will be Syncronously reindexed
2. all associated taggings(except the one that initiated reindex) will be Asyncronously reindexed

If record of SuperTagging model was updated then:

1. associated tag will be Asyncronously reindexed
2. all associated taggings will be Asyncronously reindexed

# these are the defaults
# config/initializers/activerecord_reindex.rb
ActiverecordReindex.configure do |config|
  config.index_queue = :elastic_index
  config.index_class = ActiverecordReindex::AsyncAdapter::UpdateJob
  config.mass_index_class = ActiverecordReindex::AsyncAdapter::MassUpdateJob
  config.async_reindex_only_in_production = false
end

After checking out the repo, run bin/setup to install dependencies. Then, run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

1. Fork it ( https://github.com/Health24/activerecord_reindex/fork )
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 a new Pull Request