Class: Spree::Order

Inherits:
Base
  • Object
show all
Extended by:
DisplayMoney
Includes:
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 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

Methods included from DisplayMoney

money_methods

Methods included from Payments

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

Methods inherited from Base

display_includes, page, preference, #preferences

Methods included from Core::Permalinks

#generate_permalink, #save_permalink

Instance Attribute Details

#coupon_code ⇒ Object

Returns the value of attribute coupon_code.



57
58
59
 
# File 'app/models/spree/order.rb', line 57

def coupon_code
  @coupon_code
end

#temporary_address ⇒ Object

Returns the value of attribute temporary_address.



58
59
60
 
# File 'app/models/spree/order.rb', line 58

def temporary_address
  @temporary_address
end

#temporary_payment_source ⇒ Object Also known as: temporary_credit_card

Returns the value of attribute temporary_payment_source.



60
61
62
 
# File 'app/models/spree/order.rb', line 60

def temporary_payment_source
  @temporary_payment_source
end

#use_billing ⇒ Object

Returns the value of attribute use_billing.



131
132
133
 
# File 'app/models/spree/order.rb', line 131

def use_billing
  @use_billing
end

Class Method Details

.by_customer(customer) ⇒ Object 



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

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

.by_state(state) ⇒ Object 



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

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

.canceled ⇒ Object 



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

def self.canceled
  where(state: 'canceled')
end

.complete ⇒ Object 



177
178
179
 
# File 'app/models/spree/order.rb', line 177

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

.find_by_param(value) ⇒ Object 



142
143
144
 
# File 'app/models/spree/order.rb', line 142

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

.find_by_param!(value) ⇒ Object 



146
147
148
 
# File 'app/models/spree/order.rb', line 146

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

.incomplete ⇒ Object 



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

def self.incomplete
  where(completed_at: nil)
end

.not_canceled ⇒ Object 



189
190
191
 
# File 'app/models/spree/order.rb', line 189

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.



204
205
206
 
# File 'app/models/spree/order.rb', line 204

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



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

def self.register_update_hook(hook)
  Spree::Deprecation.warn \
    "Spree::Order::update_hooks are deprecated. Please remove them " \
    "and subscribe to `order_recalculated` and/or `order_finalized` event instead", caller(1)
  update_hooks.add(hook)
end

Instance Method Details

#add_default_payment_from_wallet ⇒ Object Also known as: assign_default_credit_card 



800
801
802
803
804
805
806
807
808
809
810
811
812
 
# File 'app/models/spree/order.rb', line 800

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_wallet ⇒ Object Also known as: persist_user_credit_card 



792
793
794
795
796
 
# File 'app/models/spree/order.rb', line 792

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 



681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
 
# File 'app/models/spree/order.rb', line 681

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


304
305
306
307
308
309
310
 
# File 'app/models/spree/order.rb', line 304

def all_inventory_units_returned?
  # Inventory units are transitioned to the "return" state through CustomerReturn and
  # ReturnItem instead of using Order#inventory_units, thus making the latter method
  # potentially return stale data. This situation requires to *reload* `inventory_units`
  # in order to pick-up the latest changes and make the check on `returned?` reliable.
  inventory_units.reload.all?(&:returned?)
end

#allow_cancel? ⇒ Boolean

Returns:

  • (Boolean) 


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

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



209
210
211
 
# File 'app/models/spree/order.rb', line 209

def amount
  line_items.sum(&:amount)
end

#apply_shipping_promotions ⇒ Object Also known as: apply_free_shipping_promotions 



598
599
600
601
 
# File 'app/models/spree/order.rb', line 598

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

#approved? ⇒ Boolean

Returns:

  • (Boolean) 


655
656
657
 
# File 'app/models/spree/order.rb', line 655

def approved?
  !!approved_at
end

#assign_billing_to_shipping_address ⇒ Object 



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

def assign_billing_to_shipping_address
  self.ship_address = bill_address if bill_address
  true
end

#assign_default_user_addresses ⇒ Object 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.



769
770
771
772
773
774
775
776
777
778
779
 
# File 'app/models/spree/order.rb', line 769

def assign_default_user_addresses
  if user
    bill_address = user.bill_address
    ship_address = user.ship_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.



325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'app/models/spree/order.rb', line 325

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_methods ⇒ Object 



488
489
490
491
492
493
494
 
# File 'app/models/spree/order.rb', line 488

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

#backordered? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#bill_address_attributes=(attributes) ⇒ Object 



758
759
760
 
# File 'app/models/spree/order.rb', line 758

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

#billing_address_required? ⇒ Boolean

Returns:

  • (Boolean) 


576
577
578
 
# File 'app/models/spree/order.rb', line 576

def billing_address_required?
  Spree::Config.billing_address_required
end

#can_add_coupon? ⇒ Boolean

Returns:

  • (Boolean) 


554
555
556
 
# File 'app/models/spree/order.rb', line 554

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

#can_approve? ⇒ Boolean

Returns:

  • (Boolean) 


659
660
661
 
# File 'app/models/spree/order.rb', line 659

def can_approve?
  !approved?
end

#can_ship? ⇒ Boolean

Returns:

  • (Boolean) 


424
425
426
 
# File 'app/models/spree/order.rb', line 424

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

#canceled_by(user) ⇒ Object 



646
647
648
649
650
651
652
653
 
# File 'app/models/spree/order.rb', line 646

def canceled_by(user)
  transaction do
    cancel!
    # rubocop:disable Rails/SkipsModelValidations
    update_column(:canceler_id, user.id)
    # rubocop:enable Rails/SkipsModelValidations
  end
end

#cancellations ⇒ Object 



320
321
322
 
# File 'app/models/spree/order.rb', line 320

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) 


250
251
252
 
# File 'app/models/spree/order.rb', line 250

def checkout_allowed?
  line_items.count > 0
end

#completed? ⇒ Boolean

Returns:

  • (Boolean) 


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

def completed?
  completed_at.present?
end

#confirmation_required? ⇒ Boolean

Returns:

  • (Boolean) 


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

def confirmation_required?
  true
end

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

Returns:

  • (Boolean) 


354
355
356
 
# File 'app/models/spree/order.rb', line 354

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

#contents ⇒ Object 



312
313
314
 
# File 'app/models/spree/order.rb', line 312

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

#covered_by_store_credit? ⇒ Boolean Also known as: covered_by_store_credit

Returns:

  • (Boolean) 


727
728
729
730
 
# File 'app/models/spree/order.rb', line 727

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

#create_proposed_shipments ⇒ Object 



580
581
582
583
584
585
586
587
588
589
 
# File 'app/models/spree/order.rb', line 580

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
    self.shipments = Spree::Config.stock.coordinator_class.new(self).shipments
  end
end

#create_shipments_for_line_item(line_item) ⇒ Object 



591
592
593
594
595
596
 
# File 'app/models/spree/order.rb', line 591

def create_shipments_for_line_item(line_item)
  units = Spree::Stock::InventoryUnitBuilder.new(self).missing_units_for_line_item(line_item)
  Spree::Config.stock.coordinator_class.new(self, units).shipments.each do |shipment|
    shipments << shipment
  end
end

#create_tax_charge! ⇒ Object

Deprecated.

This now happens during #recalculate

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



390
391
392
 
# File 'app/models/spree/order.rb', line 390

def create_tax_charge!
  recalculate
end

#credit_cards ⇒ Object 



428
429
430
431
 
# File 'app/models/spree/order.rb', line 428

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

#currency ⇒ Object 



230
231
232
 
# File 'app/models/spree/order.rb', line 230

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

#deliver_order_confirmation_email ⇒ Object 



473
474
475
476
477
478
479
480
481
 
# File 'app/models/spree/order.rb', line 473

def deliver_order_confirmation_email
  Spree::Deprecation.warn \
    "deliver_order_confirmation_email has been deprecated and moved to " \
    "Spree::MailerSubscriber#order_finalized.",
    caller(1)

  Spree::Config.order_mailer_class.confirm_email(order).deliver_later
  order.update_column(:confirmation_delivered, true)
end

#discounted_item_amount ⇒ Object

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



214
215
216
 
# File 'app/models/spree/order.rb', line 214

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

#display_store_credit_remaining_after_capture ⇒ Object 



754
755
756
 
# File 'app/models/spree/order.rb', line 754

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 



750
751
752
 
# File 'app/models/spree/order.rb', line 750

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

#empty! ⇒ Object 



517
518
519
520
521
522
523
524
 
# File 'app/models/spree/order.rb', line 517

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

  recalculate
end

#ensure_billing_address ⇒ Object 



568
569
570
571
572
573
574
 
# File 'app/models/spree/order.rb', line 568

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.



503
504
505
506
507
508
509
510
511
 
# File 'app/models/spree/order.rb', line 503

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 



562
563
564
565
566
 
# File 'app/models/spree/order.rb', line 562

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



610
611
612
613
614
615
616
 
# File 'app/models/spree/order.rb', line 610

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



440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'app/models/spree/order.rb', line 440

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 if update_hooks.any?

  touch :completed_at

  Spree::Event.fire 'order_finalized', order: self

  if method(:deliver_order_confirmation_email).owner != self.class
    Spree::Deprecation.warn \
      "deliver_order_confirmation_email has been deprecated and moved to " \
      "Spree::MailerSubscriber#order_finalized, please move there any customizations.",
      caller(1)
  end
end

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



363
364
365
366
367
368
 
# File 'app/models/spree/order.rb', line 363

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 



467
468
469
470
471
 
# File 'app/models/spree/order.rb', line 467

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

#generate_order_number(options = nil) ⇒ Object 



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

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

#has_non_reimbursement_related_refunds? ⇒ Boolean

Returns:

  • (Boolean) 


667
668
669
670
 
# File 'app/models/spree/order.rb', line 667

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

#insufficient_stock_lines ⇒ Object 



496
497
498
 
# File 'app/models/spree/order.rb', line 496

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

#is_risky? ⇒ Boolean

Returns:

  • (Boolean) 


642
643
644
 
# File 'app/models/spree/order.rb', line 642

def is_risky?
  payments.risky.count > 0
end

#item_total_before_tax ⇒ Object 



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

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

#item_total_excluding_vat ⇒ Object Also known as: pre_tax_item_amount

Sum of all line item amounts pre-tax



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

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



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

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 



513
514
515
 
# File 'app/models/spree/order.rb', line 513

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

#name ⇒ Object 



418
419
420
421
422
 
# File 'app/models/spree/order.rb', line 418

def name
  if (address = bill_address || ship_address)
    address.name
  end
end

#order_total_after_store_credit ⇒ Object 



738
739
740
 
# File 'app/models/spree/order.rb', line 738

def order_total_after_store_credit
  total - total_applicable_store_credit
end

#outstanding_balance ⇒ Object 



399
400
401
402
403
404
405
406
407
408
 
# File 'app/models/spree/order.rb', line 399

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) 


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

def outstanding_balance?
  outstanding_balance != 0
end

#paid? ⇒ Boolean

Helper methods for checkout steps

Returns:

  • (Boolean) 


484
485
486
 
# File 'app/models/spree/order.rb', line 484

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) 


255
256
257
 
# File 'app/models/spree/order.rb', line 255

def payment_required?
  total > 0
end

#payments_attributes=(attributes) ⇒ Object 



824
825
826
827
 
# File 'app/models/spree/order.rb', line 824

def payments_attributes=(attributes)
  validate_payments_attributes(attributes)
  super(attributes)
end

#persist_user_address! ⇒ Object 



786
787
788
789
790
 
# File 'app/models/spree/order.rb', line 786

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 



663
664
665
 
# File 'app/models/spree/order.rb', line 663

def quantity
  line_items.sum(:quantity)
end

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



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

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

#recalculate ⇒ Object 



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

def recalculate
  updater.update
end

#record_ip_address(ip_address) ⇒ Object 



816
817
818
819
820
821
822
 
# File 'app/models/spree/order.rb', line 816

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 



628
629
630
 
# File 'app/models/spree/order.rb', line 628

def refresh_shipment_rates
  shipments.map(&:refresh_rates)
end

#refund_total ⇒ Object 



414
415
416
 
# File 'app/models/spree/order.rb', line 414

def refund_total
  refunds.sum(&:amount)
end

#reimbursement_total ⇒ Object 



395
396
397
 
# File 'app/models/spree/order.rb', line 395

def reimbursement_total
  reimbursements.sum(:total)
end

#restart_checkout_flow ⇒ Object 



618
619
620
621
622
623
624
625
626
 
# File 'app/models/spree/order.rb', line 618

def restart_checkout_flow
  return if state == 'cart'

  update_columns(
    state: 'cart',
    updated_at: Time.current
  )
  next! if !line_items.empty?
end

#set_shipments_cost ⇒ Object

Deprecated.

This now happens during #recalculate



637
638
639
 
# File 'app/models/spree/order.rb', line 637

def set_shipments_cost
  recalculate
end

#ship_address_attributes=(attributes) ⇒ Object 



762
763
764
 
# File 'app/models/spree/order.rb', line 762

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

#shipped? ⇒ Boolean

Returns:

  • (Boolean) 


558
559
560
 
# File 'app/models/spree/order.rb', line 558

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

#shipped_shipments ⇒ Object 



350
351
352
 
# File 'app/models/spree/order.rb', line 350

def shipped_shipments
  shipments.shipped
end

#shipping ⇒ Object 



316
317
318
 
# File 'app/models/spree/order.rb', line 316

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

#shipping_discount ⇒ Object 



234
235
236
 
# File 'app/models/spree/order.rb', line 234

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

#shipping_eq_billing_address? ⇒ Boolean

Returns:

  • (Boolean) 


632
633
634
 
# File 'app/models/spree/order.rb', line 632

def shipping_eq_billing_address?
  bill_address == ship_address
end

#state_changed(name) ⇒ Object 



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

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_address ⇒ Object

Returns the address for taxation based on configuration



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

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 



677
678
679
 
# File 'app/models/spree/order.rb', line 677

def tax_total
  additional_tax_total + included_tax_total
end

#to_param ⇒ Object 



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

def to_param
  number
end

#token ⇒ Object 



672
673
674
675
 
# File 'app/models/spree/order.rb', line 672

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

#total_applicable_store_credit ⇒ Object 



742
743
744
745
746
747
748
 
# File 'app/models/spree/order.rb', line 742

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 



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

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

#update!(*args) ⇒ Object 



285
286
287
288
289
290
291
292
 
# File 'app/models/spree/order.rb', line 285

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

#updater ⇒ Object 



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

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

#valid_credit_cards ⇒ Object 



433
434
435
436
 
# File 'app/models/spree/order.rb', line 433

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 



829
830
831
832
833
834
835
836
837
838
 
# File 'app/models/spree/order.rb', line 829

def validate_payments_attributes(attributes)
  attributes = Array(attributes)

  attributes.each do |payment_attributes|
    payment_method_id = payment_attributes[:payment_method_id]

    # raise RecordNotFound unless it is an allowed payment method
    available_payment_methods.find(payment_method_id) if payment_method_id
  end
end