Class: Spree::Stock::LocationFilter::Base Abstract

Inherits:

Object

• Object
• Spree::Stock::LocationFilter::Base

Defined in:

app/models/spree/stock/location_filter/base.rb

Overview

This class is abstract.

To implement your own location filter, subclass and implement #filter.

Stock location filters are used to which stock location should be considered when allocating stocks for a new shipment

Direct Known Subclasses

Active

Instance Attribute Summary

• #order ⇒ Object readonly

  Returns the value of attribute order.

• #stock_locations ⇒ Object readonly

  Returns the value of attribute stock_locations.

Instance Method Summary

• #filter ⇒ Enumerable<Spree::StockLocation>

  Filter the stock locations.

• #initialize(stock_locations, order) ⇒ Base constructor

  Initializes the stock location filter.

Constructor Details

#initialize(stock_locations, order) ⇒ Base

Initializes the stock location filter.

Parameters:

• stock_locations (Enumerable<Spree::StockLocation>) —

  a collection of locations to sort

• order (Spree::Order) —

  the order we are creating the shipment for

# File 'app/models/spree/stock/location_filter/base.rb', line 28

def initialize(stock_locations, order)
  @stock_locations = stock_locations
  @order = order
end

Instance Attribute Details

#order ⇒ Object (readonly)

Returns the value of attribute order.

# File 'app/models/spree/stock/location_filter/base.rb', line 20

def order
  @order
end

#stock_locations ⇒ Object (readonly)

Returns the value of attribute stock_locations.

# File 'app/models/spree/stock/location_filter/base.rb', line 15

def stock_locations
  @stock_locations
end

Instance Method Details

#filter ⇒ Enumerable<Spree::StockLocation>

Filter the stock locations.

Returns:

• (Enumerable<Spree::StockLocation>) —

  a collection of filtered stock locations

Raises:

• (NotImplementedError)

# File 'app/models/spree/stock/location_filter/base.rb', line 37

def filter
  raise NotImplementedError
end