Class: Spree::OrderUpdater

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(order) ⇒ OrderUpdater


6
7
8
# File 'app/models/spree/order_updater.rb', line 6

def initialize(order)
  @order = order
end

Instance Attribute Details

#orderObject (readonly)

Returns the value of attribute order


3
4
5
# File 'app/models/spree/order_updater.rb', line 3

def order
  @order
end

Instance Method Details

#run_hooksObject


45
46
47
# File 'app/models/spree/order_updater.rb', line 45

def run_hooks
  update_hooks.each { |hook| order.send hook }
end

#updateObject

This is a multi-purpose method for processing logic related to changes in the Order. It is meant to be called from various observers so that the Order is aware of changes that affect totals and other values stored in the Order.

This method should never do anything to the Order that results in a save call on the object with callbacks (otherwise you will end up in an infinite recursion as the associations try to save and then in turn try to call update! again.)


17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
# File 'app/models/spree/order_updater.rb', line 17

def update
  update_totals

  if order.completed?
    update_payment_state

    # give each of the shipments a chance to update themselves
    shipments.each { |shipment| shipment.update!(order) }
    update_shipment_state
  end
  
  update_promotion_adjustments
  update_shipping_adjustments
  # update totals a second time in case updated adjustments have an effect on the total
  update_totals

  order.update_attributes_without_callbacks({
    payment_state: order.payment_state,
    shipment_state: order.shipment_state,
    item_total: order.item_total,
    adjustment_total: order.adjustment_total,
    payment_total: order.payment_total,
    total: order.total
  })

  run_hooks
end

#update_payment_stateObject

Updates the payment_state attribute according to the following logic:

paid when payment_total is equal to total balance_due when payment_total is less than total credit_owed when payment_total is greater than total failed when most recent payment is in the failed state

The payment_state value helps with reporting, etc. since it provides a quick and easy way to locate Orders needing attention.


103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
# File 'app/models/spree/order_updater.rb', line 103

def update_payment_state

  #line_item are empty when user empties cart
  if line_items.empty? || round_money(order.payment_total) < round_money(order.total)
    if payments.present? && payments.last.state == 'failed'
      order.payment_state = 'failed'
    else
      order.payment_state = 'balance_due'
    end
  elsif round_money(order.payment_total) > round_money(order.total)
    order.payment_state = 'credit_owed'
  else
    order.payment_state = 'paid'
  end

  order.state_changed('payment')
end

#update_promotion_adjustmentsObject

Updates each of the Order adjustments.

This is intended to be called from an Observer so that the Order can respond to external changes to LineItem, Shipment, other Adjustments, etc.

Adjustments will check if they are still eligible. Ineligible adjustments are preserved but not counted towards adjustment_total.


128
129
130
131
# File 'app/models/spree/order_updater.rb', line 128

def update_promotion_adjustments
  order.adjustments.reload.promotion.each { |adjustment| adjustment.update!(order) }
  choose_best_promotion_adjustment
end

#update_shipment_stateObject

Updates the shipment_state attribute according to the following logic:

shipped when all Shipments are in the “shipped” state partial when at least one Shipment has a state of “shipped” and there is another Shipment with a state other than “shipped”

or there are InventoryUnits associated with the order that have a state of "sold" but are not associated with a Shipment.

ready when all Shipments are in the “ready” state backorder when there is backordered inventory associated with an order pending when all Shipments are in the “pending” state

The shipment_state value helps with reporting, etc. since it provides a quick and easy way to locate Orders needing attention.


72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
# File 'app/models/spree/order_updater.rb', line 72

def update_shipment_state
  if order.backordered?
    order.shipment_state = 'backorder'
  else
    # get all the shipment states for this order
    shipment_states = shipments.states
    if shipment_states.size > 1
      # multiple shiment states means it's most likely partially shipped
      order.shipment_state = 'partial'
    else
      # will return nil if no shipments are found
      order.shipment_state = shipment_states.first
      # TODO inventory unit states?
      # if order.shipment_state && order.inventory_units.where(:shipment_id => nil).exists?
      #   shipments exist but there are unassigned inventory units
      #   order.shipment_state = 'partial'
      # end
    end
  end

  order.state_changed('shipment')
end

#update_shipping_adjustmentsObject

Shipping adjustments don't receive order on update! because they calculated over a shipping / package object rather than an order object


135
136
137
# File 'app/models/spree/order_updater.rb', line 135

def update_shipping_adjustments
  order.adjustments.reload.shipping.each { |adjustment| adjustment.update! }
end

#update_totalsObject

Updates the following Order total values:

payment_total The total value of all finalized Payments (NOTE: non-finalized Payments are excluded) item_total The total value of all LineItems adjustment_total The total value of all adjustments (promotions, credits, etc.) total The so-called “order total.” This is equivalent to item_total plus adjustment_total.


55
56
57
58
59
60
# File 'app/models/spree/order_updater.rb', line 55

def update_totals
  order.payment_total = payments.completed.map(&:amount).sum
  order.item_total = line_items.map(&:amount).sum
  order.adjustment_total = adjustments.eligible.map(&:amount).sum
  order.total = order.item_total + order.adjustment_total
end