Class: Spree::Order
Defined Under Namespace
Modules: Checkout, CurrencyUpdater, Payments, StoreCredit
Constant Summary
collapse
- PAYMENT_STATES =
%w(balance_due credit_owed failed paid void)
- SHIPMENT_STATES =
%w(backorder canceled partial pending ready shipped)
- MONEY_THRESHOLD =
100_000_000
- MONEY_VALIDATION =
{
presence: true,
numericality: {
greater_than: -MONEY_THRESHOLD,
less_than: MONEY_THRESHOLD,
allow_blank: true
},
format: { with: /\A-?\d+(?:\.\d{1,2})?\z/, allow_blank: true }
}.freeze
- POSITIVE_MONEY_VALIDATION =
MONEY_VALIDATION.deep_dup.tap do |validation|
validation.fetch(:numericality)[:greater_than_or_equal_to] = 0
end.freeze
- NEGATIVE_MONEY_VALIDATION =
MONEY_VALIDATION.deep_dup.tap do |validation|
validation.fetch(:numericality)[:less_than_or_equal_to] = 0
end.freeze
Instance Attribute Summary collapse
Class Method Summary
collapse
Instance Method Summary
collapse
money_methods
#generate_guest_token
#add_store_credit_payments, #could_use_store_credit?, #covered_by_store_credit?, #display_order_total_after_store_credit, #display_store_credit_remaining_after_capture, #display_total_applicable_store_credit, #display_total_applied_store_credit, #display_total_available_store_credit, #order_total_after_store_credit, #total_applicable_store_credit, #total_applied_store_credit, #total_available_store_credit, #using_store_credit?
#price_from_line_item, #update_line_item_currencies!, #update_line_item_price!
Methods included from Checkout
included
Methods inherited from Base
page, spree_base_scopes
#clear_preferences, #default_preferences, #defined_preferences, #get_preference, #has_preference!, #has_preference?, #preference_default, #preference_type, #set_preference
Instance Attribute Details
#coupon_code ⇒ Object
Returns the value of attribute coupon_code.
58
59
60
|
# File 'app/models/spree/order.rb', line 58
def coupon_code
@coupon_code
end
|
#temporary_address ⇒ Object
Returns the value of attribute temporary_address.
59
60
61
|
# File 'app/models/spree/order.rb', line 59
def temporary_address
@temporary_address
end
|
#temporary_credit_card ⇒ Object
Returns the value of attribute temporary_credit_card.
59
60
61
|
# File 'app/models/spree/order.rb', line 59
def temporary_credit_card
@temporary_credit_card
end
|
#use_billing ⇒ Object
Returns the value of attribute use_billing.
119
120
121
|
# File 'app/models/spree/order.rb', line 119
def use_billing
@use_billing
end
|
Class Method Details
.register_line_item_comparison_hook(hook) ⇒ Object
Use this method in other gems that wish to register their own custom logic that should be called when determining if two line items are equal.
167
168
169
|
# File 'app/models/spree/order.rb', line 167
def self.register_line_item_comparison_hook(hook)
self.line_item_comparison_hooks.add(hook)
end
|
.register_update_hook(hook) ⇒ Object
Use this method in other gems that wish to register their own custom logic that should be called after Order#update
161
162
163
|
# File 'app/models/spree/order.rb', line 161
def self.register_update_hook(hook)
self.update_hooks.add(hook)
end
|
Instance Method Details
#all_inventory_units_returned? ⇒ Boolean
257
258
259
|
# File 'app/models/spree/order.rb', line 257
def all_inventory_units_returned?
inventory_units.all? { |inventory_unit| inventory_unit.returned? }
end
|
#allow_cancel? ⇒ Boolean
252
253
254
255
|
# File 'app/models/spree/order.rb', line 252
def allow_cancel?
return false if !completed? || canceled?
shipment_state.nil? || %w{ready backorder pending}.include?(shipment_state)
end
|
#amount ⇒ Object
For compatiblity with Calculator::PriceSack
172
173
174
|
# File 'app/models/spree/order.rb', line 172
def amount
line_items.inject(0.0) { |sum, li| sum + li.amount }
end
|
#approve! ⇒ Object
578
579
580
|
# File 'app/models/spree/order.rb', line 578
def approve!
update_column(:considered_risky, false)
end
|
#approved? ⇒ Boolean
560
561
562
|
# File 'app/models/spree/order.rb', line 560
def approved?
!!self.approved_at
end
|
#approved_by(user) ⇒ Object
550
551
552
553
554
555
556
557
558
|
# File 'app/models/spree/order.rb', line 550
def approved_by(user)
self.transaction do
approve!
self.update_columns(
approver_id: user.id,
approved_at: Time.current,
)
end
end
|
#associate_user!(user, override_email = true) ⇒ Object
Associates the specified user with the order.
266
267
268
269
270
271
272
273
274
275
276
277
278
|
# File 'app/models/spree/order.rb', line 266
def associate_user!(user, override_email = true)
self.user = user
self.email = user.email if override_email
self.created_by ||= user
self.bill_address ||= user.bill_address
self.ship_address ||= user.ship_address
changes = slice(:user_id, :email, :created_by_id, :bill_address_id, :ship_address_id)
self.class.unscoped.where(id: self).update_all(changes)
end
|
#available_payment_methods ⇒ Object
402
403
404
|
# File 'app/models/spree/order.rb', line 402
def available_payment_methods
@available_payment_methods ||= collect_payment_methods
end
|
#backordered? ⇒ Boolean
216
217
218
|
# File 'app/models/spree/order.rb', line 216
def backordered?
shipments.any?(&:backordered?)
end
|
#can_add_coupon? ⇒ Boolean
#can_approve? ⇒ Boolean
564
565
566
|
# File 'app/models/spree/order.rb', line 564
def can_approve?
!approved?
end
|
#can_ship? ⇒ Boolean
348
349
350
|
# File 'app/models/spree/order.rb', line 348
def can_ship?
self.complete? || self.resumed? || self.awaiting_return? || self.returned?
end
|
#canceled_by(user) ⇒ Object
540
541
542
543
544
545
546
547
548
|
# File 'app/models/spree/order.rb', line 540
def canceled_by(user)
self.transaction do
cancel!
self.update_columns(
canceler_id: user.id,
canceled_at: Time.current,
)
end
end
|
#checkout_allowed? ⇒ Boolean
Indicates whether or not the user is allowed to proceed to checkout. Currently this is implemented as a check for whether or not there is at least one LineItem in the Order. Feel free to override this logic in your own application if you require additional steps before allowing a checkout.
197
198
199
|
# File 'app/models/spree/order.rb', line 197
def checkout_allowed?
line_items.count > 0
end
|
#clone_billing_address ⇒ Object
243
244
245
246
247
248
249
250
|
# File 'app/models/spree/order.rb', line 243
def clone_billing_address
if bill_address and self.ship_address.nil?
self.ship_address = bill_address.clone
else
self.ship_address.attributes = bill_address.attributes.except('id', 'updated_at', 'created_at')
end
true
end
|
#completed? ⇒ Boolean
189
190
191
|
# File 'app/models/spree/order.rb', line 189
def completed?
completed_at.present?
end
|
#confirmation_required? ⇒ Boolean
If true, causes the confirmation step to happen during the checkout process
207
208
209
210
211
212
213
214
|
# File 'app/models/spree/order.rb', line 207
def confirmation_required?
Spree::Config[:always_include_confirm_step] ||
payments.valid.map(&:payment_method).compact.any?(&:payment_profiles_supported?) ||
confirm?
end
|
#consider_risk ⇒ Object
568
569
570
571
572
|
# File 'app/models/spree/order.rb', line 568
def consider_risk
if is_risky? && !approved?
considered_risky!
end
end
|
#considered_risky! ⇒ Object
574
575
576
|
# File 'app/models/spree/order.rb', line 574
def considered_risky!
update_column(:considered_risky, true)
end
|
#contents ⇒ Object
261
262
263
|
# File 'app/models/spree/order.rb', line 261
def contents
@contents ||= Spree::OrderContents.new(self)
end
|
#create_proposed_shipments ⇒ Object
483
484
485
486
487
488
489
490
491
492
|
# File 'app/models/spree/order.rb', line 483
def create_proposed_shipments
all_adjustments.shipping.delete_all
shipments.destroy_all
inventory_units.on_hand_or_backordered.delete_all
self.shipments = Spree::Stock::Coordinator.new(self).shipments
end
|
#create_tax_charge! ⇒ Object
Creates new tax charges if there are any applicable rates. If prices already include taxes then price adjustments are created instead.
311
312
313
314
|
# File 'app/models/spree/order.rb', line 311
def create_tax_charge!
Spree::TaxRate.adjust(self, line_items)
Spree::TaxRate.adjust(self, shipments) if shipments.any?
end
|
#credit_cards ⇒ Object
352
353
354
355
|
# File 'app/models/spree/order.rb', line 352
def credit_cards
credit_card_ids = payments.from_credit_card.pluck(:source_id).uniq
CreditCard.where(id: credit_card_ids)
end
|
#currency ⇒ Object
181
182
183
|
# File 'app/models/spree/order.rb', line 181
def currency
self[:currency] || Spree::Config[:currency]
end
|
#deliver_order_confirmation_email ⇒ Object
392
393
394
395
|
# File 'app/models/spree/order.rb', line 392
def deliver_order_confirmation_email
OrderMailer.confirm_email(id).deliver_later
update_column(:confirmation_delivered, true)
end
|
#empty! ⇒ Object
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
|
# File 'app/models/spree/order.rb', line 433
def empty!
if completed?
raise Spree.t(:cannot_empty_completed_order)
else
line_items.destroy_all
updater.update_item_count
adjustments.destroy_all
shipments.destroy_all
state_changes.destroy_all
order_promotions.destroy_all
update_totals
persist_totals
restart_checkout_flow
self
end
end
|
#ensure_line_item_variants_are_not_discontinued ⇒ Object
Check to see if any line item variants are discontinued. If so add error and restart checkout.
413
414
415
416
417
418
419
420
421
|
# File 'app/models/spree/order.rb', line 413
def ensure_line_item_variants_are_not_discontinued
if line_items.any?{ |li| !li.variant || li.variant.discontinued? }
restart_checkout_flow
errors.add(:base, Spree.t(:discontinued_variants_present))
false
else
true
end
end
|
#ensure_line_items_are_in_stock ⇒ Object
423
424
425
426
427
428
429
430
431
|
# File 'app/models/spree/order.rb', line 423
def ensure_line_items_are_in_stock
if insufficient_stock_lines.present?
restart_checkout_flow
errors.add(:base, Spree.t(:insufficient_stock_lines_present))
false
else
true
end
end
|
#ensure_updated_shipments ⇒ Object
Clean shipments and make order back to address state
At some point the might need to force the order to transition from address to delivery again so that proper updated shipments are created. e.g. customer goes back from payment step and changes order items
506
507
508
509
510
511
512
|
# File 'app/models/spree/order.rb', line 506
def ensure_updated_shipments
if shipments.any? && !self.completed?
self.shipments.destroy_all
self.update_column(:shipment_total, 0)
restart_checkout_flow
end
end
|
#finalize! ⇒ Object
Finalizes an in progress order after checkout is complete. Called after transition to complete state when payments will have been processed
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
|
# File 'app/models/spree/order.rb', line 364
def finalize!
all_adjustments.each{|a| a.close}
updater.update_payment_state
shipments.each do |shipment|
shipment.update!(self)
shipment.finalize!
end
updater.update_shipment_state
save!
updater.run_hooks
touch :completed_at
deliver_order_confirmation_email unless confirmation_delivered?
consider_risk
end
|
#find_line_item_by_variant(variant, options = {}) ⇒ Object
285
286
287
288
289
290
|
# File 'app/models/spree/order.rb', line 285
def find_line_item_by_variant(variant, options = {})
line_items.detect { |line_item|
line_item.variant_id == variant.id &&
line_item_options_match(line_item, options)
}
end
|
#fulfill! ⇒ Object
386
387
388
389
390
|
# File 'app/models/spree/order.rb', line 386
def fulfill!
shipments.each { |shipment| shipment.update!(self) if shipment.persisted? }
updater.update_shipment_state
save!
end
|
#fully_discounted? ⇒ Boolean
Also known as:
fully_discounted
determines whether the inventory is fully discounted
Returns
605
606
607
|
# File 'app/models/spree/order.rb', line 605
def fully_discounted?
adjustment_total + line_items.map(&:final_amount).sum == 0.0
end
|
595
596
597
598
|
# File 'app/models/spree/order.rb', line 595
def has_non_reimbursement_related_refunds?
refunds.non_reimbursement.exists? ||
payments.offset_payment.exists? end
|
#has_step?(step) ⇒ Boolean
451
452
453
|
# File 'app/models/spree/order.rb', line 451
def has_step?(step)
checkout_steps.include?(step)
end
|
#insufficient_stock_lines ⇒ Object
406
407
408
|
# File 'app/models/spree/order.rb', line 406
def insufficient_stock_lines
line_items.select(&:insufficient_stock?)
end
|
#is_risky? ⇒ Boolean
536
537
538
|
# File 'app/models/spree/order.rb', line 536
def is_risky?
payments.risky.size > 0
end
|
#line_item_options_match(line_item, options) ⇒ Object
This method enables extensions to participate in the “Are these line items equal” decision.
When adding to cart, an extension would send something like: params=…
and would provide:
def product_customizations_match
301
302
303
304
305
306
307
|
# File 'app/models/spree/order.rb', line 301
def line_item_options_match(line_item, options)
return true unless options
self.line_item_comparison_hooks.all? { |hook|
self.send(hook, line_item, options)
}
end
|
#merger ⇒ Object
239
240
241
|
# File 'app/models/spree/order.rb', line 239
def merger
@merger ||= Spree::OrderMerger.new(self)
end
|
#name ⇒ Object
342
343
344
345
346
|
# File 'app/models/spree/order.rb', line 342
def name
if (address = bill_address || ship_address)
address.full_name
end
end
|
#outstanding_balance ⇒ Object
323
324
325
326
327
328
329
330
331
332
333
334
335
336
|
# File 'app/models/spree/order.rb', line 323
def outstanding_balance
if canceled?
-1 * payment_total
elsif reimbursements.includes(:refunds).size > 0
reimbursed = reimbursements.includes(:refunds).inject(0) do |sum, reimbursement|
sum + reimbursement.refunds.sum(:amount)
end
total - (payment_total + reimbursed)
else
total - payment_total
end
end
|
#outstanding_balance? ⇒ Boolean
338
339
340
|
# File 'app/models/spree/order.rb', line 338
def outstanding_balance?
self.outstanding_balance != 0
end
|
#paid? ⇒ Boolean
Helper methods for checkout steps
398
399
400
|
# File 'app/models/spree/order.rb', line 398
def paid?
payment_state == 'paid' || payment_state == 'credit_owed'
end
|
#payment_required? ⇒ Boolean
Is this a free order in which case the payment step should be skipped
202
203
204
|
# File 'app/models/spree/order.rb', line 202
def payment_required?
total.to_f > 0.0
end
|
#pre_tax_item_amount ⇒ Object
Sum of all line item amounts pre-tax
177
178
179
|
# File 'app/models/spree/order.rb', line 177
def pre_tax_item_amount
line_items.to_a.sum(&:pre_tax_amount)
end
|
#quantity ⇒ Object
591
592
593
|
# File 'app/models/spree/order.rb', line 591
def quantity
line_items.sum(:quantity)
end
|
#quantity_of(variant, options = {}) ⇒ Object
280
281
282
283
|
# File 'app/models/spree/order.rb', line 280
def quantity_of(variant, options = {})
line_item = find_line_item_by_variant(variant, options)
line_item ? line_item.quantity : 0
end
|
#refresh_shipment_rates(shipping_method_filter = ShippingMethod::DISPLAY_ON_FRONT_END) ⇒ Object
522
523
524
|
# File 'app/models/spree/order.rb', line 522
def refresh_shipment_rates(shipping_method_filter = ShippingMethod::DISPLAY_ON_FRONT_END)
shipments.map { |s| s.refresh_rates(shipping_method_filter) }
end
|
#reload(options = nil) ⇒ Object
582
583
584
585
|
# File 'app/models/spree/order.rb', line 582
def reload(options=nil)
remove_instance_variable(:@tax_zone) if defined?(@tax_zone)
super
end
|
#restart_checkout_flow ⇒ Object
514
515
516
517
518
519
520
|
# File 'app/models/spree/order.rb', line 514
def restart_checkout_flow
self.update_columns(
state: 'cart',
updated_at: Time.current,
)
self.next! if self.line_items.size > 0
end
|
#set_shipments_cost ⇒ Object
530
531
532
533
534
|
# File 'app/models/spree/order.rb', line 530
def set_shipments_cost
shipments.each(&:update_amounts)
updater.update_shipment_total
persist_totals
end
|
#shipped? ⇒ Boolean
479
480
481
|
# File 'app/models/spree/order.rb', line 479
def shipped?
%w(partial shipped).include?(shipment_state)
end
|
#shipping_discount ⇒ Object
185
186
187
|
# File 'app/models/spree/order.rb', line 185
def shipping_discount
shipment_adjustments.eligible.sum(:amount) * - 1
end
|
#shipping_eq_billing_address? ⇒ Boolean
526
527
528
|
# File 'app/models/spree/order.rb', line 526
def shipping_eq_billing_address?
(bill_address.empty? && ship_address.empty?) || bill_address.same_as?(ship_address)
end
|
#state_changed(name) ⇒ Object
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
|
# File 'app/models/spree/order.rb', line 455
def state_changed(name)
state = "#{name}_state"
if persisted?
old_state = self.send("#{state}_was")
new_state = self.send(state)
unless old_state == new_state
self.state_changes.create(
previous_state: old_state,
next_state: new_state,
name: name,
user_id: self.user_id
)
end
end
end
|
#tax_address ⇒ Object
Returns the address for taxation based on configuration
227
228
229
|
# File 'app/models/spree/order.rb', line 227
def tax_address
Spree::Config[:tax_using_ship_address] ? ship_address : bill_address
end
|
#tax_total ⇒ Object
587
588
589
|
# File 'app/models/spree/order.rb', line 587
def tax_total
included_tax_total + additional_tax_total
end
|
#tax_zone ⇒ Object
Returns the relevant zone (if any) to be used for taxation purposes. Uses default tax zone unless there is a specific match
222
223
224
|
# File 'app/models/spree/order.rb', line 222
def tax_zone
@tax_zone ||= Zone.match(tax_address) || Zone.default_tax
end
|
#update_line_item_prices! ⇒ Object
316
317
318
319
320
321
|
# File 'app/models/spree/order.rb', line 316
def update_line_item_prices!
transaction do
line_items.each(&:update_price)
save!
end
end
|
#update_with_updater! ⇒ Object
235
236
237
|
# File 'app/models/spree/order.rb', line 235
def update_with_updater!
updater.update
end
|
#updater ⇒ Object
231
232
233
|
# File 'app/models/spree/order.rb', line 231
def updater
@updater ||= OrderUpdater.new(self)
end
|
#valid_credit_cards ⇒ Object
357
358
359
360
|
# File 'app/models/spree/order.rb', line 357
def valid_credit_cards
credit_card_ids = payments.from_credit_card.valid.pluck(:source_id).uniq
CreditCard.where(id: credit_card_ids)
end
|