Class: Spree::StockItem

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

Instance Method Summary (collapse)

Methods inherited from Base

display_includes, #initialize_preference_defaults, page, preference

Methods included from Preferences::Preferable

#default_preferences, #defined_preferences, #get_preference, #has_preference!, #has_preference?, #preference_default, #preference_type, #set_preference

Instance Method Details

- (Object) adjust_count_on_hand(value)

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



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

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

- (Boolean) available?

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



60
61
62
# File 'app/models/spree/stock_item.rb', line 60

def available?
  in_stock? || backorderable?
end

- (Array<Spree::InventoryUnit>) backordered_inventory_units

Returns the backordered inventory units associated with this stock item

Returns:



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

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

- (Object) fill_status(quantity)



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

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

- (Boolean) in_stock?

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



55
56
57
# File 'app/models/spree/stock_item.rb', line 55

def in_stock?
  count_on_hand > 0
end

- (String) name

Returns the name of this stock item's variant

Returns:

  • (String)

    the name of this stock item's variant



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

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

- (Object) reduce_count_on_hand_to_zero

Note:

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

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



67
68
69
# File 'app/models/spree/stock_item.rb', line 67

def reduce_count_on_hand_to_zero
  set_count_on_hand(0) if count_on_hand > 0
end

- (Object) set_count_on_hand(value)

Note:

This will cause backorders to be processed.

Sets this stock item's count on hand.

Parameters:

  • value (Fixnum)

    the desired count on hand



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

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

  save!
end