Class: Spree::SearchProvider::Base

Inherits:
Object
  • Object
show all
Defined in:
app/models/spree/search_provider/base.rb

Direct Known Subclasses

Database, Meilisearch

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(store) ⇒ Base

Returns a new instance of Base.



12
13
14
 
# File 'app/models/spree/search_provider/base.rb', line 12

def initialize(store)
  @store = store
end

Instance Attribute Details

#store ⇒ Object (readonly)

Returns the value of attribute store.



4
5
6
 
# File 'app/models/spree/search_provider/base.rb', line 4

def store
  @store
end

Class Method Details

.indexing_required? ⇒ Boolean

Whether this provider requires background indexing jobs. Override in subclasses. Database provider returns false.

Returns:

  • (Boolean) 


8
9
10
 
# File 'app/models/spree/search_provider/base.rb', line 8

def self.indexing_required?
  false
end

Instance Method Details

#ensure_index_settings! ⇒ Object

Configure index settings (filterable, sortable, searchable attributes). Called by rake task before indexing. No-op for database provider.



71
72
73
 
# File 'app/models/spree/search_provider/base.rb', line 71

def ensure_index_settings!
  # no-op by default
end

#filters(scope:, query: nil, filters: {}) ⇒ FiltersResult

Compute filter facets, sort options, and total count for the given scope. Called by the dedicated filters endpoint — kept separate from search_and_filter to avoid expensive facet queries on every product listing.

Parameters:

  • scope (ActiveRecord::Relation) —

    base scope

  • query (String, nil) (defaults to: nil) —

    text search query

  • filters (Hash) (defaults to: {}) —

    structured filters

Returns:

Raises:

  • (NotImplementedError) 


37
38
39
 
# File 'app/models/spree/search_provider/base.rb', line 37

def filters(scope:, query: nil, filters: {})
  raise NotImplementedError
end

#index(product) ⇒ Object

Index a product — called after product save. No-op for database provider.

Parameters:



44
45
46
 
# File 'app/models/spree/search_provider/base.rb', line 44

def index(product)
  # no-op by default
end

#index_batch(documents) ⇒ Object

Index a batch of documents. Called by rake task with pre-serialized documents.

Parameters:

  • documents (Array<Hash>) —

    serialized product documents



65
66
67
 
# File 'app/models/spree/search_provider/base.rb', line 65

def index_batch(documents)
  # no-op by default
end

#reindex(scope = nil) ⇒ Object

Bulk reindex — full catalog sync. Called manually or via rake task.

Parameters:

  • scope (ActiveRecord::Relation) (defaults to: nil) —

    products to reindex (default: all in store)



78
79
80
 
# File 'app/models/spree/search_provider/base.rb', line 78

def reindex(scope = nil)
  # no-op by default
end

#remove(product) ⇒ Object

Remove a product from the index.

Parameters:



51
52
53
 
# File 'app/models/spree/search_provider/base.rb', line 51

def remove(product)
  # no-op by default
end

#remove_by_id(prefixed_id) ⇒ Object

Remove a document from the index by prefixed ID (used when record is already deleted).

Parameters:

  • prefixed_id (String) —

    the prefixed ID (e.g. ‘prod_abc’)



58
59
60
 
# File 'app/models/spree/search_provider/base.rb', line 58

def remove_by_id(prefixed_id)
  # no-op by default
end

#search_and_filter(scope:, query: nil, filters: {}, sort: nil, page: 1, limit: 25) ⇒ SearchResult

Search and paginate products. Does NOT compute filter facets — use #filters for that.

Parameters:

  • scope (ActiveRecord::Relation) —

    base scope (store-scoped, visibility-filtered, authorized)

  • query (String, nil) (defaults to: nil) —

    text search query

  • filters (Hash) (defaults to: {}) —

    structured filters (price_gte, with_option_value_ids, in_category, in_categories, etc.)

  • sort (String, nil) (defaults to: nil) —

    sort param (e.g. ‘price’, ‘-price’, ‘best_selling’)

  • page (Integer) (defaults to: 1) —

    page number

  • limit (Integer) (defaults to: 25) —

    results per page

Returns:

Raises:

  • (NotImplementedError) 


25
26
27
 
# File 'app/models/spree/search_provider/base.rb', line 25

def search_and_filter(scope:, query: nil, filters: {}, sort: nil, page: 1, limit: 25)
  raise NotImplementedError
end