Class: Decidim::ResourceSearch

Inherits:
Searchlight::Search
  • Object
show all
Defined in:
app/services/decidim/resource_search.rb

Overview

This is the base class to be used by other search services. Searchlight documentation: github.com/nathanl/searchlight

Instance Method Summary collapse

Constructor Details

#initialize(scope, options = {}) ⇒ ResourceSearch

Initialize the Searchlight::Search base class with the options provided.

scope - The scope used to create the base query options - A hash of options to modify the search. These options will be

converted to methods by SearchLight so they can be used on filter
methods. (Default {})



13
14
15
16
 
# File 'app/services/decidim/resource_search.rb', line 13

def initialize(scope, options = {})
  super(options)
  @scope = scope
end

Instance Method Details

#base_query ⇒ Object

Creates the SearchLight base query. Check if the option feature was provided.



20
21
22
23
24
25
 
# File 'app/services/decidim/resource_search.rb', line 20

def base_query
  # raise order_start_time.inspect
  raise "Missing feature" unless feature

  @scope.where(feature: feature)
end

#search_category_id ⇒ Object

Handle the category_id filter



28
29
30
31
32
 
# File 'app/services/decidim/resource_search.rb', line 28

def search_category_id
  query
    .includes(:categorization)
    .where(decidim_categorizations: { decidim_category_id: category_ids })
end

#search_scope_id ⇒ Object

Handles the scope_id filter. When we want to show only those that do not have a scope_id set, we cannot pass an empty String or nil because Searchlight will automatically filter out these params, so the method will not be used. Instead, we need to pass a fake ID and then convert it inside. In this case, in order to select those elements that do not have a scope_id set we use ‘“global”` as parameter, and in the method we do the needed changes to search properly.

You can use the ‘search_organization_scopes` helper method, defined in `Decidim::OrganizationScopesHelper`, to render the collection needed for the `collection_check_boxes` form method.



45
46
47
48
 
# File 'app/services/decidim/resource_search.rb', line 45

def search_scope_id
  clean_scope_ids = [scope_id].flatten.map { |id| id == "global" ? nil : id }
  query.where(decidim_scope_id: clean_scope_ids)
end