Class: Jsonapi::QueryBuilder::BaseFilter

Inherits:

Object

• Object
• Jsonapi::QueryBuilder::BaseFilter

Defined in:

lib/jsonapi/query_builder/base_filter.rb

Instance Attribute Summary

• #collection ⇒ Object readonly

  Returns the value of attribute collection.

• #query ⇒ Object readonly

  Returns the value of attribute query.

Instance Method Summary

• #initialize(collection, query) ⇒ BaseFilter constructor

  A new instance of BaseFilter.

• #results ⇒ ActiveRecord::Relation

  Collection with the filter applied.

Constructor Details

#initialize(collection, query) ⇒ BaseFilter

Returns a new instance of BaseFilter.

Parameters:

• collection (ActiveRecord::Relation)
• query (String) —

  the query value used for filtering

# File 'lib/jsonapi/query_builder/base_filter.rb', line 10

def initialize(collection, query)
  @collection = collection
  @query = query
end

Instance Attribute Details

#collection ⇒ Object (readonly)

Returns the value of attribute collection.

# File 'lib/jsonapi/query_builder/base_filter.rb', line 6

def collection
  @collection
end

#query ⇒ Object (readonly)

Returns the value of attribute query.

# File 'lib/jsonapi/query_builder/base_filter.rb', line 6

def query
  @query
end

Instance Method Details

#results ⇒ ActiveRecord::Relation

Returns Collection with the filter applied.

Returns:

• (ActiveRecord::Relation) —

  Collection with the filter applied

Raises:

• (NotImplementedError)

# File 'lib/jsonapi/query_builder/base_filter.rb', line 16

def results
  raise NotImplementedError, "#{self.class} should implement #results"
end