Class: Spree::Order
- Inherits:
-
Base
- Object
- ActiveRecord::Base
- Base
- Spree::Order
show all
- Extended by:
- DisplayMoney
- Includes:
- Payments
- Defined in:
- app/models/spree/order.rb,
app/models/spree/order/payments.rb
Overview
The customers cart until completed, then acts as permanent record of the transaction.
‘Spree::Order` is the heart of the Solidus system, as it acts as the customer’s cart as they shop. Once an order is complete, it serves as the permanent record of their purchase. It has many responsibilities:
‘Spree::LineItem` as an ActiveRecord model.
‘checkout_allowed?` or `payment_required?`.
* Implements an interface for mutating the order with methods like
‘empty!` and `fulfill!`.
Defined Under Namespace
Modules: Payments
Classes: CannotRebuildShipments, InsufficientStock, NumberGenerator
Constant Summary
collapse
- ORDER_NUMBER_LENGTH =
9
- ORDER_NUMBER_LETTERS =
false
- ORDER_NUMBER_PREFIX =
'R'
Instance Attribute Summary collapse
Class Method Summary
collapse
Instance Method Summary
collapse
money_methods
Methods included from Payments
#authorize_payments!, #capture_payments!, #process_payments!, #unprocessed_payments
Methods inherited from Base
display_includes
#generate_permalink, #save_permalink
Instance Attribute Details
#coupon_code ⇒ Object
Returns the value of attribute coupon_code.
56
57
58
|
# File 'app/models/spree/order.rb', line 56
def coupon_code
@coupon_code
end
|
#temporary_address ⇒ Object
Returns the value of attribute temporary_address.
57
58
59
|
# File 'app/models/spree/order.rb', line 57
def temporary_address
@temporary_address
end
|
#temporary_payment_source ⇒ Object
Returns the value of attribute temporary_payment_source.
59
60
61
|
# File 'app/models/spree/order.rb', line 59
def temporary_payment_source
@temporary_payment_source
end
|
#use_billing ⇒ Object
Returns the value of attribute use_billing.
126
127
128
|
# File 'app/models/spree/order.rb', line 126
def use_billing
@use_billing
end
|
Class Method Details
.by_customer(customer) ⇒ Object
159
160
161
|
# File 'app/models/spree/order.rb', line 159
def self.by_customer(customer)
joins(:user).where("#{Spree.user_class.table_name}.email" => customer)
end
|
.by_state(state) ⇒ Object
163
164
165
|
# File 'app/models/spree/order.rb', line 163
def self.by_state(state)
where(state: state)
end
|
.canceled ⇒ Object
175
176
177
|
# File 'app/models/spree/order.rb', line 175
def self.canceled
where(state: 'canceled')
end
|
.complete ⇒ Object
167
168
169
|
# File 'app/models/spree/order.rb', line 167
def self.complete
where.not(completed_at: nil)
end
|
.find_by_param(value) ⇒ Object
137
138
139
|
# File 'app/models/spree/order.rb', line 137
def self.find_by_param(value)
find_by number: value
end
|
.find_by_param!(value) ⇒ Object
141
142
143
|
# File 'app/models/spree/order.rb', line 141
def self.find_by_param!(value)
find_by! number: value
end
|
.incomplete ⇒ Object
171
172
173
|
# File 'app/models/spree/order.rb', line 171
def self.incomplete
where(completed_at: nil)
end
|
.not_canceled ⇒ Object
179
180
181
|
# File 'app/models/spree/order.rb', line 179
def self.not_canceled
where.not(state: 'canceled')
end
|
.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.
185
186
187
|
# File 'app/models/spree/order.rb', line 185
def self.register_line_item_comparison_hook(hook)
line_item_comparison_hooks.add(hook)
end
|
Instance Method Details
#add_default_payment_from_wallet ⇒ Object
686
687
688
689
690
691
692
693
694
695
696
697
698
|
# File 'app/models/spree/order.rb', line 686
def add_default_payment_from_wallet
builder = Spree::Config.default_payment_builder_class.new(self)
if payment = builder.build
payments << payment
if bill_address.nil?
self.bill_address = payment.source.try(:address) ||
user.bill_address
end
end
end
|
#add_payment_sources_to_wallet ⇒ Object
680
681
682
683
684
|
# File 'app/models/spree/order.rb', line 680
def add_payment_sources_to_wallet
Spree::Config.
add_payment_sources_to_wallet_class.new(self).
add_to_wallet
end
|
#add_store_credit_payments ⇒ Object
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
|
# File 'app/models/spree/order.rb', line 574
def add_store_credit_payments
return if user.nil?
return if payments.store_credits.checkout.empty? && user.available_store_credit_total(currency: currency).zero?
payments.store_credits.checkout.each(&:invalidate!)
authorized_total = payments.pending.sum(:amount)
remaining_total = outstanding_balance - authorized_total
matching_store_credits = user.store_credits.where(currency: currency)
if matching_store_credits.any?
payment_method = Spree::PaymentMethod::StoreCredit.first
matching_store_credits.order_by_priority.each do |credit|
break if remaining_total.zero?
next if credit.amount_remaining.zero?
amount_to_take = [credit.amount_remaining, remaining_total].min
payments.create!(source: credit,
payment_method: payment_method,
amount: amount_to_take,
state: 'checkout',
response_code: credit.generate_authorization_code)
remaining_total -= amount_to_take
end
end
other_payments = payments.checkout.not_store_credits
if remaining_total.zero?
other_payments.each(&:invalidate!)
elsif other_payments.size == 1
other_payments.first.update!(amount: remaining_total)
end
payments.reset
if payments.where(state: %w(checkout pending completed)).sum(:amount) != total
errors.add(:base, I18n.t('spree.store_credit.errors.unable_to_fund')) && (return false)
end
end
|
#all_inventory_units_returned? ⇒ Boolean
263
264
265
266
267
268
269
|
# File 'app/models/spree/order.rb', line 263
def all_inventory_units_returned?
inventory_units.reload.all?(&:returned?)
end
|
#allow_cancel? ⇒ Boolean
258
259
260
261
|
# File 'app/models/spree/order.rb', line 258
def allow_cancel?
return false unless completed? && state != 'canceled'
shipment_state.nil? || %w{ready backorder pending}.include?(shipment_state)
end
|
#amount ⇒ Object
For compatiblity with Calculator::PriceSack
190
191
192
|
# File 'app/models/spree/order.rb', line 190
def amount
line_items.sum(&:amount)
end
|
#approved? ⇒ Boolean
553
554
555
|
# File 'app/models/spree/order.rb', line 553
def approved?
!!approved_at
end
|
#assign_billing_to_shipping_address ⇒ Object
253
254
255
256
|
# File 'app/models/spree/order.rb', line 253
def assign_billing_to_shipping_address
self.ship_address = bill_address if bill_address
true
end
|
#assign_default_user_addresses ⇒ Object
Note:
This doesn’t persist the change bill_address or ship_address
Assigns a default bill_address and ship_address to the order based on the associated user’s bill_address and ship_address.
662
663
664
665
666
667
668
669
670
671
672
|
# File 'app/models/spree/order.rb', line 662
def assign_default_user_addresses
if user
bill_address = user.bill_address
ship_address = user.ship_address
self.bill_address ||= bill_address if bill_address.try!(:valid?)
self.ship_address ||= ship_address if ship_address.try!(:valid?) && checkout_steps.include?("delivery")
end
end
|
#associate_user!(user, override_email = true) ⇒ Object
Associates the specified user with the order.
284
285
286
287
288
289
290
291
292
293
294
295
296
|
# File 'app/models/spree/order.rb', line 284
def associate_user!(user, override_email = true)
self.user = user
attrs_to_set = { user_id: user.try(:id) }
attrs_to_set[:email] = user.try(:email) if override_email
attrs_to_set[:created_by_id] = user.try(:id) if created_by.blank?
if persisted?
self.class.unscoped.where(id: id).update_all(attrs_to_set)
end
assign_attributes(attrs_to_set)
end
|
#available_payment_methods ⇒ Object
414
415
416
417
418
419
420
|
# File 'app/models/spree/order.rb', line 414
def available_payment_methods
@available_payment_methods ||= Spree::PaymentMethod
.active
.available_to_store(store)
.available_to_users
.order(:position)
end
|
#backordered? ⇒ Boolean
232
233
234
|
# File 'app/models/spree/order.rb', line 232
def backordered?
shipments.any?(&:backordered?)
end
|
#bill_address_attributes=(attributes) ⇒ Object
651
652
653
|
# File 'app/models/spree/order.rb', line 651
def bill_address_attributes=(attributes)
self.bill_address = Spree::Address.immutable_merge(bill_address, attributes)
end
|
#billing_address_required? ⇒ Boolean
482
483
484
|
# File 'app/models/spree/order.rb', line 482
def billing_address_required?
Spree::Config.billing_address_required
end
|
#can_add_coupon? ⇒ Boolean
#can_approve? ⇒ Boolean
557
558
559
|
# File 'app/models/spree/order.rb', line 557
def can_approve?
!approved?
end
|
#can_ship? ⇒ Boolean
368
369
370
|
# File 'app/models/spree/order.rb', line 368
def can_ship?
complete? || resumed? || awaiting_return? || returned?
end
|
#canceled_by(user) ⇒ Object
544
545
546
547
548
549
550
551
|
# File 'app/models/spree/order.rb', line 544
def canceled_by(user)
transaction do
cancel!
update_column(:canceler_id, user.id)
end
end
|
#cancellations ⇒ Object
279
280
281
|
# File 'app/models/spree/order.rb', line 279
def cancellations
@cancellations ||= Spree::Config.order_cancellations_class.new(self)
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.
223
224
225
|
# File 'app/models/spree/order.rb', line 223
def checkout_allowed?
line_items.count > 0
end
|
#completed? ⇒ Boolean
215
216
217
|
# File 'app/models/spree/order.rb', line 215
def completed?
completed_at.present?
end
|
#contains?(variant, options = {}) ⇒ Boolean
306
307
308
|
# File 'app/models/spree/order.rb', line 306
def contains?(variant, options = {})
find_line_item_by_variant(variant, options).present?
end
|
#contents ⇒ Object
271
272
273
|
# File 'app/models/spree/order.rb', line 271
def contents
@contents ||= Spree::Config.order_contents_class.new(self)
end
|
#covered_by_store_credit? ⇒ Boolean
Also known as:
covered_by_store_credit
620
621
622
623
|
# File 'app/models/spree/order.rb', line 620
def covered_by_store_credit?
return false unless user
user.available_store_credit_total(currency: currency) >= total
end
|
#create_proposed_shipments ⇒ Object
486
487
488
489
490
491
492
493
494
495
|
# File 'app/models/spree/order.rb', line 486
def create_proposed_shipments
if completed?
raise CannotRebuildShipments.new(I18n.t('spree.cannot_rebuild_shipments_order_completed'))
elsif shipments.any? { |shipment| !shipment.pending? }
raise CannotRebuildShipments.new(I18n.t('spree.cannot_rebuild_shipments_shipments_not_pending'))
else
shipments.destroy_all
shipments.push(*Spree::Config.stock.coordinator_class.new(self).shipments)
end
end
|
#create_shipments_for_line_item(line_item) ⇒ Object
#credit_cards ⇒ Object
372
373
374
375
|
# File 'app/models/spree/order.rb', line 372
def credit_cards
credit_card_ids = payments.from_credit_card.pluck(:source_id).uniq
Spree::CreditCard.where(id: credit_card_ids)
end
|
#currency ⇒ Object
203
204
205
|
# File 'app/models/spree/order.rb', line 203
def currency
self[:currency] || Spree::Config[:currency]
end
|
#display_store_credit_remaining_after_capture ⇒ Object
647
648
649
|
# File 'app/models/spree/order.rb', line 647
def display_store_credit_remaining_after_capture
Spree::Money.new(total_available_store_credit - total_applicable_store_credit, { currency: currency })
end
|
#display_total_applicable_store_credit ⇒ Object
643
644
645
|
# File 'app/models/spree/order.rb', line 643
def display_total_applicable_store_credit
Spree::Money.new(-total_applicable_store_credit, { currency: currency })
end
|
#empty! ⇒ Object
443
444
445
446
447
448
449
450
|
# File 'app/models/spree/order.rb', line 443
def empty!
line_items.destroy_all
adjustments.destroy_all
shipments.destroy_all
order_promotions.destroy_all
recalculate
end
|
#ensure_billing_address ⇒ Object
474
475
476
477
478
479
480
|
# File 'app/models/spree/order.rb', line 474
def ensure_billing_address
return unless billing_address_required?
return if bill_address&.valid?
errors.add(:base, I18n.t('spree.bill_address_required'))
false
end
|
#ensure_line_item_variants_are_not_deleted ⇒ Object
Check to see if any line item variants are soft, deleted. If so add error and restart checkout.
429
430
431
432
433
434
435
436
437
|
# File 'app/models/spree/order.rb', line 429
def ensure_line_item_variants_are_not_deleted
if line_items.any? { |li| li.variant.discarded? }
errors.add(:base, I18n.t('spree.deleted_variants_present'))
restart_checkout_flow
false
else
true
end
end
|
#ensure_shipping_address ⇒ Object
468
469
470
471
472
|
# File 'app/models/spree/order.rb', line 468
def ensure_shipping_address
unless ship_address && ship_address.valid?
errors.add(:base, I18n.t('spree.ship_address_required')) && (return false)
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
514
515
516
517
518
519
520
|
# File 'app/models/spree/order.rb', line 514
def ensure_updated_shipments
if !completed? && shipments.all?(&:pending?)
shipments.destroy_all
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
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
|
# File 'app/models/spree/order.rb', line 384
def finalize!
all_adjustments.each(&:finalize!)
updater.update_payment_state
shipments.each do |shipment|
shipment.update_state
shipment.finalize!
end
updater.update_shipment_state
save!
touch :completed_at
Spree::Event.fire 'order_finalized', order: self
end
|
#find_line_item_by_variant(variant, options = {}) ⇒ Object
315
316
317
318
319
320
|
# File 'app/models/spree/order.rb', line 315
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
403
404
405
406
407
|
# File 'app/models/spree/order.rb', line 403
def fulfill!
shipments.each { |shipment| shipment.update_state if shipment.persisted? }
updater.update_shipment_state
save!
end
|
#generate_order_number ⇒ Object
298
299
300
|
# File 'app/models/spree/order.rb', line 298
def generate_order_number
self.number ||= Spree::Config.order_number_generator.generate
end
|
565
566
567
568
|
# File 'app/models/spree/order.rb', line 565
def has_non_reimbursement_related_refunds?
refunds.non_reimbursement.exists? ||
payments.offset_payment.exists? end
|
#insufficient_stock_lines ⇒ Object
422
423
424
|
# File 'app/models/spree/order.rb', line 422
def insufficient_stock_lines
line_items.select(&:insufficient_stock?)
end
|
#is_risky? ⇒ Boolean
540
541
542
|
# File 'app/models/spree/order.rb', line 540
def is_risky?
payments.risky.count > 0
end
|
#item_total_before_tax ⇒ Object
194
195
196
|
# File 'app/models/spree/order.rb', line 194
def item_total_before_tax
line_items.to_a.sum(&:total_before_tax)
end
|
#item_total_excluding_vat ⇒ Object
Sum of all line item amounts pre-tax
199
200
201
|
# File 'app/models/spree/order.rb', line 199
def item_total_excluding_vat
line_items.to_a.sum(&:total_excluding_vat)
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
331
332
333
334
335
336
337
|
# File 'app/models/spree/order.rb', line 331
def line_item_options_match(line_item, options)
return true unless options
line_item_comparison_hooks.all? { |hook|
send(hook, line_item, options)
}
end
|
#merge!(*args) ⇒ Object
439
440
441
|
# File 'app/models/spree/order.rb', line 439
def merge!(*args)
Spree::Config.order_merger_class.new(self).merge!(*args)
end
|
#name ⇒ Object
362
363
364
365
366
|
# File 'app/models/spree/order.rb', line 362
def name
if (address = bill_address || ship_address)
address.name
end
end
|
#order_total_after_store_credit ⇒ Object
631
632
633
|
# File 'app/models/spree/order.rb', line 631
def order_total_after_store_credit
total - total_applicable_store_credit
end
|
#outstanding_balance ⇒ Object
343
344
345
346
347
348
349
350
351
352
|
# File 'app/models/spree/order.rb', line 343
def outstanding_balance
if state == 'canceled'
-1 * payment_total
else
total - reimbursement_total - payment_total
end
end
|
#outstanding_balance? ⇒ Boolean
354
355
356
|
# File 'app/models/spree/order.rb', line 354
def outstanding_balance?
outstanding_balance != 0
end
|
#paid? ⇒ Boolean
Helper methods for checkout steps
410
411
412
|
# File 'app/models/spree/order.rb', line 410
def paid?
%w(paid credit_owed).include?(payment_state)
end
|
#payment_required? ⇒ Boolean
Is this a free order in which case the payment step should be skipped
228
229
230
|
# File 'app/models/spree/order.rb', line 228
def payment_required?
total > 0
end
|
#payments_attributes=(attributes) ⇒ Object
708
709
710
711
|
# File 'app/models/spree/order.rb', line 708
def payments_attributes=(attributes)
validate_payments_attributes(attributes)
super(attributes)
end
|
#persist_user_address! ⇒ Object
674
675
676
677
678
|
# File 'app/models/spree/order.rb', line 674
def persist_user_address!
if !temporary_address && user && user.respond_to?(:persist_order_address) && bill_address_id
user.persist_order_address(self)
end
end
|
#quantity ⇒ Object
561
562
563
|
# File 'app/models/spree/order.rb', line 561
def quantity
line_items.sum(:quantity)
end
|
#quantity_of(variant, options = {}) ⇒ Object
310
311
312
313
|
# File 'app/models/spree/order.rb', line 310
def quantity_of(variant, options = {})
line_item = find_line_item_by_variant(variant, options)
line_item ? line_item.quantity : 0
end
|
#recalculate ⇒ Object
249
250
251
|
# File 'app/models/spree/order.rb', line 249
def recalculate
updater.update
end
|
#record_ip_address(ip_address) ⇒ Object
700
701
702
703
704
705
706
|
# File 'app/models/spree/order.rb', line 700
def record_ip_address(ip_address)
if new_record?
self.last_ip_address = ip_address
elsif last_ip_address != ip_address
update_column(:last_ip_address, ip_address)
end
end
|
#refresh_shipment_rates ⇒ Object
532
533
534
|
# File 'app/models/spree/order.rb', line 532
def refresh_shipment_rates
shipments.map(&:refresh_rates)
end
|
#refund_total ⇒ Object
358
359
360
|
# File 'app/models/spree/order.rb', line 358
def refund_total
refunds.sum(&:amount)
end
|
#reimbursement_total ⇒ Object
339
340
341
|
# File 'app/models/spree/order.rb', line 339
def reimbursement_total
reimbursements.sum(:total)
end
|
#restart_checkout_flow ⇒ Object
522
523
524
525
526
527
528
529
530
|
# File 'app/models/spree/order.rb', line 522
def restart_checkout_flow
return if state == 'cart'
update_columns(
state: 'cart',
updated_at: Time.current
)
next! if !line_items.empty?
end
|
#ship_address_attributes=(attributes) ⇒ Object
655
656
657
|
# File 'app/models/spree/order.rb', line 655
def ship_address_attributes=(attributes)
self.ship_address = Spree::Address.immutable_merge(ship_address, attributes)
end
|
#shipped? ⇒ Boolean
464
465
466
|
# File 'app/models/spree/order.rb', line 464
def shipped?
%w(partial shipped).include?(shipment_state)
end
|
#shipped_shipments ⇒ Object
302
303
304
|
# File 'app/models/spree/order.rb', line 302
def shipped_shipments
shipments.shipped
end
|
#shipping ⇒ Object
275
276
277
|
# File 'app/models/spree/order.rb', line 275
def shipping
@shipping ||= Spree::Config.order_shipping_class.new(self)
end
|
#shipping_discount ⇒ Object
207
208
209
|
# File 'app/models/spree/order.rb', line 207
def shipping_discount
shipment_adjustments.credit.eligible.sum(:amount) * - 1
end
|
#shipping_eq_billing_address? ⇒ Boolean
536
537
538
|
# File 'app/models/spree/order.rb', line 536
def shipping_eq_billing_address?
bill_address == ship_address
end
|
#tax_address ⇒ Object
Returns the address for taxation based on configuration
237
238
239
240
241
242
243
|
# File 'app/models/spree/order.rb', line 237
def tax_address
if Spree::Config[:tax_using_ship_address]
ship_address
else
bill_address
end || store.default_cart_tax_location
end
|
#tax_total ⇒ Object
570
571
572
|
# File 'app/models/spree/order.rb', line 570
def tax_total
additional_tax_total + included_tax_total
end
|
#to_param ⇒ Object
211
212
213
|
# File 'app/models/spree/order.rb', line 211
def to_param
number
end
|
#total_applicable_store_credit ⇒ Object
635
636
637
638
639
640
641
|
# File 'app/models/spree/order.rb', line 635
def total_applicable_store_credit
if can_complete? || complete?
valid_store_credit_payments.to_a.sum(&:amount)
else
[total, (user.try(:available_store_credit_total, currency: currency) || 0.0)].min
end
end
|
#total_available_store_credit ⇒ Object
626
627
628
629
|
# File 'app/models/spree/order.rb', line 626
def total_available_store_credit
return 0.0 unless user
user.available_store_credit_total(currency: currency)
end
|
#updater ⇒ Object
245
246
247
|
# File 'app/models/spree/order.rb', line 245
def updater
@updater ||= Spree::OrderUpdater.new(self)
end
|
#valid_credit_cards ⇒ Object
377
378
379
380
|
# File 'app/models/spree/order.rb', line 377
def valid_credit_cards
credit_card_ids = payments.from_credit_card.valid.pluck(:source_id).uniq
Spree::CreditCard.where(id: credit_card_ids)
end
|
#validate_payments_attributes(attributes) ⇒ Object
713
714
715
716
717
718
719
720
721
722
|
# File 'app/models/spree/order.rb', line 713
def validate_payments_attributes(attributes)
attributes = Array(attributes)
attributes.each do |payment_attributes|
payment_method_id = payment_attributes[:payment_method_id]
available_payment_methods.find(payment_method_id) if payment_method_id
end
end
|