Module: OpenSearch::DSL::Search::BaseComponent::InstanceMethods

Defined in:
lib/opensearch/dsl/search/base_component.rb

Instance Method Summary collapse

Instance Method Details

#call ⇒ self

Evaluates any block passed to the query

Returns:

  • (self) 


152
153
154
155
 
# File 'lib/opensearch/dsl/search/base_component.rb', line 152

def call
  @block.arity < 1 ? self.instance_eval(&@block) : @block.call(self) if @block
  self
end

#empty? ⇒ Boolean

Return true when the component definition is empty

Returns:

  • (Boolean) 


159
160
161
 
# File 'lib/opensearch/dsl/search/base_component.rb', line 159

def empty?
  to_hash[name].respond_to?(:empty?) && to_hash[name].empty?
end

#name ⇒ String

Return the name for instance of the DSL class

Returns:

  • (String) 


144
145
146
 
# File 'lib/opensearch/dsl/search/base_component.rb', line 144

def name
  self.class.name
end

#to_hash(options = {}) ⇒ Hash

Convert the query definition to a Hash

A default implementation, DSL classes can overload it.

Returns:

  • (Hash) 


169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/opensearch/dsl/search/base_component.rb', line 169

def to_hash(options={})
  case
    # 1. Create hash from the block
    when @block
      @hash = (@args && ! @args.empty?) ? { name => { @args => {} } } : { name => {} }
      call
      @hash[self.name.to_sym].update @options unless @options.empty?
      @hash
    # 2. Hash created with option methods
    when @hash[self.name.to_sym] && ! @args.is_a?(Hash) && @hash[self.name.to_sym][@args]
      @hash[self.name.to_sym].update @options unless @options.empty?
      @hash
    # 3. Hash passsed as @args
    when @hash[self.name.to_sym] && @args.respond_to?(:to_hash) && ! @args.empty?
      { name => @args.to_hash }
    # 4. Hash already built
    else
      @hash
  end
end