Class: Spree::Order

Inherits:
Base
  • Object
show all
Extended by:
DisplayMoney
Includes:
Checkout, Payments
Defined in:
app/models/spree/order.rb,
app/models/spree/order/checkout.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:

  • Records and validates attributes like `total` and relationships like

`Spree::LineItem` as an ActiveRecord model.

  • Implements a customizable state machine to manage the lifecycle of an order.

  • Implements business logic to provide a single interface for quesitons like

`checkout_allowed?` or `payment_required?`.

* Implements an interface for mutating the order with methods like

`empty!` and `fulfill!`.

Defined Under Namespace

Modules: Checkout, Payments Classes: CannotRebuildShipments, InsufficientStock, NumberGenerator

Constant Summary

ORDER_NUMBER_LENGTH =
9
ORDER_NUMBER_LETTERS =
false
ORDER_NUMBER_PREFIX =
'R'

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from DisplayMoney

money_methods

Methods included from Payments

#authorize_payments!, #capture_payments!, #process_payments!, #unprocessed_payments

Methods included from Checkout

#can_go_to_state?, #checkout_step_index, #checkout_steps, #has_checkout_step?, included, #passed_checkout_step?

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 Attribute Details

#coupon_codeObject

Returns the value of attribute coupon_code



50
51
52
# File 'app/models/spree/order.rb', line 50

def coupon_code
  @coupon_code
end

#temporary_addressObject

Returns the value of attribute temporary_address



51
52
53
# File 'app/models/spree/order.rb', line 51

def temporary_address
  @temporary_address
end

#temporary_payment_sourceObject Also known as: temporary_credit_card

Returns the value of attribute temporary_payment_source



53
54
55
# File 'app/models/spree/order.rb', line 53

def temporary_payment_source
  @temporary_payment_source
end

#use_billingObject

Returns the value of attribute use_billing



124
125
126
# File 'app/models/spree/order.rb', line 124

def use_billing
  @use_billing
end

Class Method Details

.by_customer(customer) ⇒ Object



162
163
164
# File 'app/models/spree/order.rb', line 162

def self.by_customer(customer)
  joins(:user).where("#{Spree.user_class.table_name}.email" => customer)
end

.by_state(state) ⇒ Object



166
167
168
# File 'app/models/spree/order.rb', line 166

def self.by_state(state)
  where(state: state)
end

.completeObject



170
171
172
# File 'app/models/spree/order.rb', line 170

def self.complete
  where.not(completed_at: nil)
end

.find_by_param(value) ⇒ Object



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

def self.find_by_param(value)
  find_by number: value
end

.find_by_param!(value) ⇒ Object



139
140
141
# File 'app/models/spree/order.rb', line 139

def self.find_by_param!(value)
  find_by! number: value
end

.incompleteObject



174
175
176
# File 'app/models/spree/order.rb', line 174

def self.incomplete
  where(completed_at: nil)
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.



186
187
188
# File 'app/models/spree/order.rb', line 186

def self.register_line_item_comparison_hook(hook)
  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



180
181
182
# File 'app/models/spree/order.rb', line 180

def self.register_update_hook(hook)
  update_hooks.add(hook)
end

Instance Method Details

#add_default_payment_from_walletObject Also known as: assign_default_credit_card



747
748
749
750
751
752
753
754
755
756
757
758
759
# File 'app/models/spree/order.rb', line 747

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?
      # this is one of 2 places still using User#bill_address
      self.bill_address = payment.source.try(:address) ||
                          user.bill_address
    end
  end
end

#add_payment_sources_to_walletObject Also known as: persist_user_credit_card



739
740
741
742
743
# File 'app/models/spree/order.rb', line 739

def add_payment_sources_to_wallet
  Spree::Config.
    add_payment_sources_to_wallet_class.new(self).
    add_to_wallet
end

#add_store_credit_paymentsObject



628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
# File 'app/models/spree/order.rb', line 628

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!)

  # this can happen when multiple payments are present, auto_capture is
  # turned off, and one of the payments fails when the user tries to
  # complete the order, which sends the order back to the 'payment' state.
  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_attributes!(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

Returns:

  • (Boolean)


286
287
288
# File 'app/models/spree/order.rb', line 286

def all_inventory_units_returned?
  inventory_units.all?(&:returned?)
end

#allow_cancel?Boolean

Returns:

  • (Boolean)


281
282
283
284
# File 'app/models/spree/order.rb', line 281

def allow_cancel?
  return false unless completed? && state != 'canceled'
  shipment_state.nil? || %w{ready backorder pending}.include?(shipment_state)
end

#amountObject

For compatiblity with Calculator::PriceSack



191
192
193
# File 'app/models/spree/order.rb', line 191

def amount
  line_items.map(&:amount).sum
end

#apply_shipping_promotionsObject



545
546
547
548
# File 'app/models/spree/order.rb', line 545

def apply_shipping_promotions
  Spree::PromotionHandler::Shipping.new(self).activate
  recalculate
end

#approved?Boolean

Returns:

  • (Boolean)


602
603
604
# File 'app/models/spree/order.rb', line 602

def approved?
  !!approved_at
end

#assign_billing_to_shipping_addressObject



276
277
278
279
# File 'app/models/spree/order.rb', line 276

def assign_billing_to_shipping_address
  self.ship_address = bill_address if bill_address
  true
end

#assign_default_user_addressesObject Also known as: assign_default_user_addresses!, assign_default_addresses!

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.



716
717
718
719
720
721
722
723
724
725
726
# File 'app/models/spree/order.rb', line 716

def assign_default_user_addresses
  if user
    bill_address = (user.bill_address || user.default_address)
    ship_address = (user.ship_address || user.default_address)
    # this is one of 2 places still using User#bill_address
    self.bill_address ||= bill_address if bill_address.try!(:valid?)
    # Skip setting ship address if order doesn't have a delivery checkout step
    # to avoid triggering validations on shipping address
    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.



303
304
305
306
307
308
309
310
311
312
313
314
315
# File 'app/models/spree/order.rb', line 303

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?
    # immediately persist the changes we just made, but don't use save since we might have an invalid address associated
    self.class.unscoped.where(id: id).update_all(attrs_to_set)
  end

  assign_attributes(attrs_to_set)
end

#available_payment_methodsObject



454
455
456
457
458
459
460
# File 'app/models/spree/order.rb', line 454

def available_payment_methods
  @available_payment_methods ||= Spree::PaymentMethod
    .active
    .available_to_store(store)
    .available_to_users
    .order(:position)
end

#backordered?Boolean

Returns:

  • (Boolean)


246
247
248
# File 'app/models/spree/order.rb', line 246

def backordered?
  shipments.any?(&:backordered?)
end

#bill_address_attributes=(attributes) ⇒ Object



705
706
707
# File 'app/models/spree/order.rb', line 705

def bill_address_attributes=(attributes)
  self.bill_address = Spree::Address.immutable_merge(bill_address, attributes)
end

#can_add_coupon?Boolean

Returns:

  • (Boolean)


520
521
522
# File 'app/models/spree/order.rb', line 520

def can_add_coupon?
  Spree::Promotion.order_activatable?(self)
end

#can_approve?Boolean

Returns:

  • (Boolean)


606
607
608
# File 'app/models/spree/order.rb', line 606

def can_approve?
  !approved?
end

#can_ship?Boolean

Returns:

  • (Boolean)


402
403
404
# File 'app/models/spree/order.rb', line 402

def can_ship?
  complete? || resumed? || awaiting_return? || returned?
end

#canceled_by(user) ⇒ Object



592
593
594
595
596
597
598
599
600
# File 'app/models/spree/order.rb', line 592

def canceled_by(user)
  transaction do
    cancel!
    update_columns(
      canceler_id: user.id,
      canceled_at: Time.current
    )
  end
end

#cancellationsObject



298
299
300
# File 'app/models/spree/order.rb', line 298

def cancellations
  @cancellations ||= Spree::OrderCancellations.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.

Returns:

  • (Boolean)


232
233
234
# File 'app/models/spree/order.rb', line 232

def checkout_allowed?
  line_items.count > 0
end

#completed?Boolean

Returns:

  • (Boolean)


224
225
226
# File 'app/models/spree/order.rb', line 224

def completed?
  completed_at.present?
end

#confirmation_required?Boolean

Returns:

  • (Boolean)


241
242
243
# File 'app/models/spree/order.rb', line 241

def confirmation_required?
  true
end

#contains?(variant, options = {}) ⇒ Boolean

Returns:

  • (Boolean)


332
333
334
# File 'app/models/spree/order.rb', line 332

def contains?(variant, options = {})
  find_line_item_by_variant(variant, options).present?
end

#contentsObject



290
291
292
# File 'app/models/spree/order.rb', line 290

def contents
  @contents ||= Spree::OrderContents.new(self)
end

#covered_by_store_credit?Boolean Also known as: covered_by_store_credit

Returns:

  • (Boolean)


674
675
676
677
# File 'app/models/spree/order.rb', line 674

def covered_by_store_credit?
  return false unless user
  user.available_store_credit_total(currency: currency) >= total
end

#create_proposed_shipmentsObject



534
535
536
537
538
539
540
541
542
543
# File 'app/models/spree/order.rb', line 534

def create_proposed_shipments
  if completed?
    raise CannotRebuildShipments.new(I18n.t('spree.cannot_rebuild_shipments_order_completed'))
  elsif shipments.any? { |s| !s.pending? }
    raise CannotRebuildShipments.new(I18n.t('spree.cannot_rebuild_shipments_shipments_not_pending'))
  else
    shipments.destroy_all
    self.shipments = Spree::Config.stock.coordinator_class.new(self).shipments
  end
end

#create_tax_charge!Object

Deprecated.

This now happens during #update!

Creates new tax charges if there are any applicable rates. If prices already include taxes then price adjustments are created instead.



368
369
370
# File 'app/models/spree/order.rb', line 368

def create_tax_charge!
  Spree::Config.tax_adjuster_class.new(self).adjust!
end

#credit_cardsObject



406
407
408
409
# File 'app/models/spree/order.rb', line 406

def credit_cards
  credit_card_ids = payments.from_credit_card.pluck(:source_id).uniq
  Spree::CreditCard.where(id: credit_card_ids)
end

#currencyObject



212
213
214
# File 'app/models/spree/order.rb', line 212

def currency
  self[:currency] || Spree::Config[:currency]
end

#deliver_order_confirmation_emailObject



444
445
446
447
# File 'app/models/spree/order.rb', line 444

def deliver_order_confirmation_email
  Spree::OrderMailer.confirm_email(self).deliver_later
  update_column(:confirmation_delivered, true)
end

#discounted_item_amountObject

Sum of all line item amounts after promotions, before added tax



196
197
198
# File 'app/models/spree/order.rb', line 196

def discounted_item_amount
  line_items.to_a.sum(&:discounted_amount)
end

#display_store_credit_remaining_after_captureObject



701
702
703
# File 'app/models/spree/order.rb', line 701

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_creditObject



697
698
699
# File 'app/models/spree/order.rb', line 697

def display_total_applicable_store_credit
  Spree::Money.new(-total_applicable_store_credit, { currency: currency })
end

#empty!Object



483
484
485
486
487
488
489
490
# File 'app/models/spree/order.rb', line 483

def empty!
  line_items.destroy_all
  adjustments.destroy_all
  shipments.destroy_all
  order_promotions.destroy_all

  recalculate
end

#ensure_line_item_variants_are_not_deletedObject

Check to see if any line item variants are soft, deleted. If so add error and restart checkout.



469
470
471
472
473
474
475
476
477
# File 'app/models/spree/order.rb', line 469

def ensure_line_item_variants_are_not_deleted
  if line_items.any? { |li| li.variant.paranoia_destroyed? }
    errors.add(:base, I18n.t('spree.deleted_variants_present'))
    restart_checkout_flow
    false
  else
    true
  end
end

#ensure_shipping_addressObject



528
529
530
531
532
# File 'app/models/spree/order.rb', line 528

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_shipmentsObject

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



556
557
558
559
560
561
562
# File 'app/models/spree/order.rb', line 556

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



418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
# File 'app/models/spree/order.rb', line 418

def finalize!
  # lock all adjustments (coupon promotions, etc.)
  all_adjustments.each(&:finalize!)

  # update payment and shipment(s) states, and save
  updater.update_payment_state
  shipments.each do |shipment|
    shipment.update_state
    shipment.finalize!
  end

  updater.update_shipment_state
  save!
  updater.run_hooks

  touch :completed_at

  deliver_order_confirmation_email unless confirmation_delivered?
end

#find_line_item_by_variant(variant, options = {}) ⇒ Object



341
342
343
344
345
346
# File 'app/models/spree/order.rb', line 341

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



438
439
440
441
442
# File 'app/models/spree/order.rb', line 438

def fulfill!
  shipments.each { |shipment| shipment.update_state if shipment.persisted? }
  updater.update_shipment_state
  save!
end

#generate_order_number(options = nil) ⇒ Object



317
318
319
320
321
322
323
324
325
326
# File 'app/models/spree/order.rb', line 317

def generate_order_number(options = nil)
  if options
    Spree::Deprecation.warn \
      "Passing options to Order#generate_order_number is deprecated. " \
      "Please add your own instance of the order number generator " \
      "with your options (#{options.inspect}) and store it as " \
      "Spree::Config.order_number_generator in your stores config."
  end
  self.number ||= Spree::Config.order_number_generator.generate
end

Returns:

  • (Boolean)


614
615
616
617
# File 'app/models/spree/order.rb', line 614

def has_non_reimbursement_related_refunds?
  refunds.non_reimbursement.exists? ||
    payments.offset_payment.exists? # how old versions of spree stored refunds
end

#insufficient_stock_linesObject



462
463
464
# File 'app/models/spree/order.rb', line 462

def insufficient_stock_lines
  line_items.select(&:insufficient_stock?)
end

#is_risky?Boolean

Returns:

  • (Boolean)


588
589
590
# File 'app/models/spree/order.rb', line 588

def is_risky?
  payments.risky.count > 0
end

#item_total_before_taxObject



201
202
203
# File 'app/models/spree/order.rb', line 201

def item_total_before_tax
  line_items.to_a.sum(&:total_before_tax)
end

#item_total_excluding_vatObject Also known as: pre_tax_item_amount

Sum of all line item amounts pre-tax



206
207
208
# File 'app/models/spree/order.rb', line 206

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



357
358
359
360
361
362
363
# File 'app/models/spree/order.rb', line 357

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



479
480
481
# File 'app/models/spree/order.rb', line 479

def merge!(*args)
  Spree::Config.order_merger_class.new(self).merge!(*args)
end

#nameObject



396
397
398
399
400
# File 'app/models/spree/order.rb', line 396

def name
  if (address = bill_address || ship_address)
    "#{address.firstname} #{address.lastname}"
  end
end

#order_total_after_store_creditObject



685
686
687
# File 'app/models/spree/order.rb', line 685

def order_total_after_store_credit
  total - total_applicable_store_credit
end

#outstanding_balanceObject



377
378
379
380
381
382
383
384
385
386
# File 'app/models/spree/order.rb', line 377

def outstanding_balance
  # If reimbursement has happened add it back to total to prevent balance_due payment state
  # See: https://github.com/spree/spree/issues/6229

  if state == 'canceled'
    -1 * payment_total
  else
    total - reimbursement_total - payment_total
  end
end

#outstanding_balance?Boolean

Returns:

  • (Boolean)


388
389
390
# File 'app/models/spree/order.rb', line 388

def outstanding_balance?
  outstanding_balance != 0
end

#paid?Boolean

Helper methods for checkout steps

Returns:

  • (Boolean)


450
451
452
# File 'app/models/spree/order.rb', line 450

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

Returns:

  • (Boolean)


237
238
239
# File 'app/models/spree/order.rb', line 237

def payment_required?
  total > 0
end

#persist_user_address!Object



733
734
735
736
737
# File 'app/models/spree/order.rb', line 733

def persist_user_address!
  if !temporary_address && user && user.respond_to?(:persist_order_address) && bill_address_id
    user.persist_order_address(self)
  end
end

#quantityObject



610
611
612
# File 'app/models/spree/order.rb', line 610

def quantity
  line_items.sum(:quantity)
end

#quantity_of(variant, options = {}) ⇒ Object



336
337
338
339
# File 'app/models/spree/order.rb', line 336

def quantity_of(variant, options = {})
  line_item = find_line_item_by_variant(variant, options)
  line_item ? line_item.quantity : 0
end

#recalculateObject



263
264
265
# File 'app/models/spree/order.rb', line 263

def recalculate
  updater.update
end

#record_ip_address(ip_address) ⇒ Object



763
764
765
766
767
# File 'app/models/spree/order.rb', line 763

def record_ip_address(ip_address)
  if last_ip_address != ip_address
    update_attributes!(last_ip_address: ip_address)
  end
end

#refresh_shipment_ratesObject



574
575
576
# File 'app/models/spree/order.rb', line 574

def refresh_shipment_rates
  shipments.map(&:refresh_rates)
end

#refund_totalObject



392
393
394
# File 'app/models/spree/order.rb', line 392

def refund_total
  payments.flat_map(&:refunds).sum(&:amount)
end

#reimbursement_totalObject



373
374
375
# File 'app/models/spree/order.rb', line 373

def reimbursement_total
  reimbursements.sum(:total)
end

#restart_checkout_flowObject



564
565
566
567
568
569
570
571
572
# File 'app/models/spree/order.rb', line 564

def restart_checkout_flow
  return if state == 'cart'

  update_columns(
    state: 'cart',
    updated_at: Time.current
  )
  next! if line_items.size > 0
end

#set_shipments_costObject



582
583
584
585
# File 'app/models/spree/order.rb', line 582

def set_shipments_cost
  shipments.each(&:update_amounts)
  recalculate
end

#ship_address_attributes=(attributes) ⇒ Object



709
710
711
# File 'app/models/spree/order.rb', line 709

def ship_address_attributes=(attributes)
  self.ship_address = Spree::Address.immutable_merge(ship_address, attributes)
end

#shipped?Boolean

Returns:

  • (Boolean)


524
525
526
# File 'app/models/spree/order.rb', line 524

def shipped?
  %w(partial shipped).include?(shipment_state)
end

#shipped_shipmentsObject



328
329
330
# File 'app/models/spree/order.rb', line 328

def shipped_shipments
  shipments.shipped
end

#shippingObject



294
295
296
# File 'app/models/spree/order.rb', line 294

def shipping
  @shipping ||= Spree::OrderShipping.new(self)
end

#shipping_discountObject



216
217
218
# File 'app/models/spree/order.rb', line 216

def shipping_discount
  shipment_adjustments.eligible.sum(:amount) * - 1
end

#shipping_eq_billing_address?Boolean

Returns:

  • (Boolean)


578
579
580
# File 'app/models/spree/order.rb', line 578

def shipping_eq_billing_address?
  bill_address == ship_address
end

#state_changed(name) ⇒ Object



495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
# File 'app/models/spree/order.rb', line 495

def state_changed(name)
  state = "#{name}_state"
  if persisted?
    old_state = send("#{state}_was")
    new_state = send(state)
    unless old_state == new_state
      state_changes.create(
        previous_state: old_state,
        next_state:     new_state,
        name:           name,
        user_id:        user_id
      )
    end
  end
end

#tax_addressObject

Returns the address for taxation based on configuration



251
252
253
254
255
256
257
# File 'app/models/spree/order.rb', line 251

def tax_address
  if Spree::Config[:tax_using_ship_address]
    ship_address
  else
    bill_address
  end || store.default_cart_tax_location
end

#tax_totalObject



624
625
626
# File 'app/models/spree/order.rb', line 624

def tax_total
  additional_tax_total + included_tax_total
end

#to_paramObject



220
221
222
# File 'app/models/spree/order.rb', line 220

def to_param
  number
end

#tokenObject



619
620
621
622
# File 'app/models/spree/order.rb', line 619

def token
  Spree::Deprecation.warn("Spree::Order#token is DEPRECATED, please use #guest_token instead.", caller)
  guest_token
end

#total_applicable_store_creditObject



689
690
691
692
693
694
695
# File 'app/models/spree/order.rb', line 689

def total_applicable_store_credit
  if can_complete? || complete?
    payments.store_credits.valid.sum(:amount)
  else
    [total, (user.try(:available_store_credit_total, currency: currency) || 0.0)].min
  end
end

#total_available_store_creditObject



680
681
682
683
# File 'app/models/spree/order.rb', line 680

def total_available_store_credit
  return 0.0 unless user
  user.available_store_credit_total(currency: currency)
end

#update!(*args) ⇒ Object



267
268
269
270
271
272
273
274
# File 'app/models/spree/order.rb', line 267

def update!(*args)
  if args.empty?
    Spree::Deprecation.warn "Calling order.update! with no arguments as a way to invoke the OrderUpdater is deprecated, since it conflicts with AR::Base#update! Please use order.recalculate instead"
    recalculate
  else
    super
  end
end

#updaterObject



259
260
261
# File 'app/models/spree/order.rb', line 259

def updater
  @updater ||= Spree::OrderUpdater.new(self)
end

#valid_credit_cardsObject



411
412
413
414
# File 'app/models/spree/order.rb', line 411

def valid_credit_cards
  credit_card_ids = payments.from_credit_card.valid.pluck(:source_id).uniq
  Spree::CreditCard.where(id: credit_card_ids)
end