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

Returns a new instance of 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

#persist_totalsObject


98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
# File 'app/models/spree/order_updater.rb', line 98

def persist_totals
  order.update_columns(
    payment_state: order.payment_state,
    shipment_state: order.shipment_state,
    item_total: order.item_total,
    item_count: order.item_count,
    adjustment_total: order.adjustment_total,
    included_tax_total: order.included_tax_total,
    additional_tax_total: order.additional_tax_total,
    payment_total: order.payment_total,
    shipment_total: order.shipment_total,
    promo_total: order.promo_total,
    total: order.total,
    updated_at: Time.now,
  )
end

#recalculate_adjustmentsObject


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

def recalculate_adjustments
  all_adjustments.includes(:adjustable).map(&:adjustable).uniq.each { |adjustable| Spree::ItemAdjustments.new(adjustable).update }
end

#run_hooksObject


28
29
30
# File 'app/models/spree/order_updater.rb', line 28

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
# File 'app/models/spree/order_updater.rb', line 17

def update
  update_totals
  if order.completed?
    update_payment_state
    update_shipments
    update_shipment_state
  end
  run_hooks
  persist_totals
end

#update_adjustment_totalObject


74
75
76
77
78
79
80
81
82
83
84
85
86
87
# File 'app/models/spree/order_updater.rb', line 74

def update_adjustment_total
  recalculate_adjustments
  order.adjustment_total = line_items.sum(:adjustment_total) +
                           shipments.sum(:adjustment_total)  +
                           adjustments.eligible.sum(:amount)
  order.included_tax_total = line_items.sum(:included_tax_total) + shipments.sum(:included_tax_total)
  order.additional_tax_total = line_items.sum(:additional_tax_total) + shipments.sum(:additional_tax_total)

  order.promo_total = line_items.sum(:promo_total) +
                      shipments.sum(:promo_total) +
                      adjustments.promotion.eligible.sum(:amount)

  update_order_total
end

#update_item_countObject


89
90
91
# File 'app/models/spree/order_updater.rb', line 89

def update_item_count
  order.item_count = quantity
end

#update_item_totalObject


93
94
95
96
# File 'app/models/spree/order_updater.rb', line 93

def update_item_total
  order.item_total = line_items.sum('price * quantity')
  update_order_total
end

#update_order_totalObject


70
71
72
# File 'app/models/spree/order_updater.rb', line 70

def update_order_total
  order.total = order.item_total + order.shipment_total + order.adjustment_total
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.


157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
# File 'app/models/spree/order_updater.rb', line 157

def update_payment_state
  last_state = order.payment_state
  if payments.present? && payments.valid.size == 0
    order.payment_state = 'failed'
  elsif !payments.present? && order.state == 'canceled'
    order.payment_state = 'void'
  elsif order.state == 'canceled' && order.payment_total == 0 && payments.completed.size > 0
    order.payment_state = 'void'
  else
    order.payment_state = 'balance_due' if order.outstanding_balance > 0
    order.payment_state = 'credit_owed' if order.outstanding_balance < 0
    order.payment_state = 'paid' if !order.outstanding_balance?
  end
  order.state_changed('payment') if last_state != order.payment_state
  order.payment_state
end

#update_payment_totalObject


61
62
63
# File 'app/models/spree/order_updater.rb', line 61

def update_payment_total
  order.payment_total = payments.completed.sum(:amount)
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.


125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
# File 'app/models/spree/order_updater.rb', line 125

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')
  order.shipment_state
end

#update_shipment_totalObject


65
66
67
68
# File 'app/models/spree/order_updater.rb', line 65

def update_shipment_total
  order.shipment_total = shipments.sum(:cost)
  update_order_total
end

#update_shipmentsObject

give each of the shipments a chance to update themselves


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

def update_shipments
  shipments.each do |shipment|
    next unless shipment.persisted?
    shipment.update!(order)
    shipment.refresh_rates
    shipment.update_amounts
  end
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.) promo_total The total value of all promotion adjustments total The so-called “order total.” This is equivalent to item_total plus adjustment_total.


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

def update_totals
  update_payment_total
  update_item_total
  update_shipment_total
  update_adjustment_total
end