Class: Spree::Stock::Quantifier

Inherits:
Object
  • Object
show all
Defined in:
app/models/spree/stock/quantifier.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(variant, stock_location = nil) ⇒ Quantifier

Returns a new instance of Quantifier.



6
7
8
9
10
11
12
13
14
15
 
# File 'app/models/spree/stock/quantifier.rb', line 6

def initialize(variant, stock_location = nil)
  @variant = variant
  where_args = { variant_id: @variant }
  if stock_location
    where_args.merge!(stock_location: stock_location)
  else
    where_args.merge!(Spree::StockLocation.table_name => { active: true })
  end
  @stock_items = Spree::StockItem.joins(:stock_location).where(where_args)
end

Instance Attribute Details

#stock_items ⇒ Object (readonly)

Returns the value of attribute stock_items.



4
5
6
 
# File 'app/models/spree/stock/quantifier.rb', line 4

def stock_items
  @stock_items
end

Instance Method Details

#backorderable? ⇒ Boolean

Checks if any of its stock items are backorderable.

Returns:

  • (Boolean) —

    true if any stock items are backorderable



32
33
34
 
# File 'app/models/spree/stock/quantifier.rb', line 32

def backorderable?
  stock_items.any?(&:backorderable)
end

#can_supply?(required) ⇒ Boolean

Checks if it is possible to supply a given number of units.

Parameters:

  • required (Fixnum) —

    the number of required stock units

Returns:

  • (Boolean) —

    true if we have the required amount on hand or the variant is backorderable, otherwise false



41
42
43
 
# File 'app/models/spree/stock/quantifier.rb', line 41

def can_supply?(required)
  total_on_hand >= required || backorderable?
end

#total_on_hand ⇒ Fixnum

Returns the total number of inventory units on hand for the variant.

Returns:

  • (Fixnum) —

    number of inventory units on hand, or infinity if inventory is not tracked on the variant.



21
22
23
24
25
26
27
 
# File 'app/models/spree/stock/quantifier.rb', line 21

def total_on_hand
  if @variant.should_track_inventory?
    stock_items.sum(:count_on_hand)
  else
    Float::INFINITY
  end
end