Class: Spree::StockItem

Inherits:
Base
  • Object
show all
Includes:
SoftDeletable
Defined in:
app/models/spree/stock_item.rb

Instance Method Summary collapse

Methods inherited from Base

display_includes

Methods included from Core::Permalinks

#generate_permalink, #save_permalink

Instance Method Details

#adjust_count_on_hand(value) ⇒ Object

Note:

This will cause backorders to be processed.

Adjusts the count on hand by a given value.

Parameters:

  • value (Fixnum)

    the amount to change the count on hand by, positive or negative values are valid


36
37
38
39
40
41
42
43
# File 'app/models/spree/stock_item.rb', line 36

def adjust_count_on_hand(value)
  with_lock do
    self.count_on_hand = count_on_hand + value
    process_backorders(count_on_hand - count_on_hand_was)

    save!
  end
end

#available?Boolean

Returns true if this stock item can be included in a shipment.

Returns:

  • (Boolean)

    true if this stock item can be included in a shipment


62
63
64
# File 'app/models/spree/stock_item.rb', line 62

def available?
  in_stock? || backorderable?
end

#backordered_inventory_unitsArray<Spree::InventoryUnit>

Returns the backordered inventory units associated with this stock item.

Returns:


27
28
29
# File 'app/models/spree/stock_item.rb', line 27

def backordered_inventory_units
  Spree::InventoryUnit.backordered_for_stock_item(self)
end

#fill_status(quantity) ⇒ Object


73
74
75
76
77
78
79
80
81
82
83
84
# File 'app/models/spree/stock_item.rb', line 73

def fill_status(quantity)
  if count_on_hand >= quantity
    on_hand = quantity
    backordered = 0
  else
    on_hand = count_on_hand
    on_hand = 0 if on_hand < 0
    backordered = backorderable? ? (quantity - on_hand) : 0
  end

  [on_hand, backordered]
end

#in_stock?Boolean

Returns true if this stock item's count on hand is not zero.

Returns:

  • (Boolean)

    true if this stock item's count on hand is not zero


57
58
59
# File 'app/models/spree/stock_item.rb', line 57

def in_stock?
  count_on_hand > 0
end

#nameString

Returns the name of this stock item's variant.

Returns:

  • (String)

    the name of this stock item's variant


18
# File 'app/models/spree/stock_item.rb', line 18

delegate :name, to: :variant, prefix: true

#reduce_count_on_hand_to_zeroObject

Note:

This processes backorders if the count on hand is not zero.

Sets the count on hand to zero if it not already zero.


69
70
71
# File 'app/models/spree/stock_item.rb', line 69

def reduce_count_on_hand_to_zero
  set_count_on_hand(0) if count_on_hand > 0
end

#set_count_on_hand(value) ⇒ Object

Note:

This will cause backorders to be processed.

Sets this stock item's count on hand.

Parameters:

  • value (Fixnum)

    the desired count on hand


49
50
51
52
53
54
# File 'app/models/spree/stock_item.rb', line 49

def set_count_on_hand(value)
  self.count_on_hand = value
  process_backorders(count_on_hand - count_on_hand_was)

  save!
end