module SearchFlip::Explainable

The SearchFlip::Sortable mixin provides the chainable explain method to control elasticsearch query explanations

Public Class Methods

included(base) click to toggle source
# File lib/search_flip/explainable.rb, line 6
def self.included(base)
  base.class_eval do
    attr_accessor :explain_value
  end
end

Public Instance Methods

explain(value) click to toggle source

Specifies whether or not to enable explanation for each hit on how its score was computed.

@example

CommentIndex.explain(true)

@param value [Boolean] The value for explain

@return [SearchFlip::Criteria] A newly created extended criteria

# File lib/search_flip/explainable.rb, line 22
def explain(value)
  fresh.tap do |criteria|
    criteria.explain_value = value
  end
end