Class: Spree::Order

Inherits:
Object
  • Object
show all
Extended by:
DisplayMoney
Includes:
MemoizedData, Metadata, Metafields, MultiSearchable, NumberAsParam, NumberIdentifier, AddressBook, Checkout, CurrencyUpdater, Digital, Emails, GiftCard, Payments, StoreCredit, Webhooks, Security::Orders, SingleStoreResource, VendorConcern
Defined in:
app/models/spree/order.rb,
app/models/spree/order/emails.rb,
app/models/spree/order/digital.rb,
app/models/spree/order/checkout.rb,
app/models/spree/order/payments.rb,
app/models/spree/order/webhooks.rb,
app/models/spree/order/gift_card.rb,
app/models/spree/order/address_book.rb,
app/models/spree/order/store_credit.rb,
app/models/spree/order/currency_updater.rb

Defined Under Namespace

Modules: AddressBook, Checkout, CurrencyUpdater, Digital, Emails, GiftCard, Payments, StoreCredit, Webhooks

Constant Summary collapse

PAYMENT_STATES = 
%w(balance_due credit_owed failed paid void)
SHIPMENT_STATES = 
%w(backorder canceled partial pending ready shipped)
LINE_ITEM_REMOVABLE_STATES = 
%w(cart address delivery payment confirm resumed)
MEMOIZED_METHODS = 
%w(tax_zone)
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
ASSOCIATED_USER_ATTRIBUTES = 
[:user_id, :email, :created_by_id, :bill_address_id, :ship_address_id]

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from DisplayMoney

money_methods

Methods included from GiftCard

#apply_gift_card, #gift_card_total, #recalculate_gift_card, #redeem_gift_card, #remove_gift_card

Methods included from Webhooks

#send_order_canceled_webhook, #send_order_placed_webhook, #send_order_resumed_webhook

Methods included from Emails

#deliver_order_confirmation_email, #deliver_store_owner_order_notification_email, #deliver_store_owner_order_notification_email?, #send_cancel_email

Methods included from AddressBook

#bill_address_attributes=, #bill_address_id=, #clone_billing_address, #clone_shipping_address, #ship_address_attributes=, #ship_address_id=

Methods included from StoreCredit

#add_store_credit_payments, #available_store_credits, #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, #display_total_minus_store_credits, #order_total_after_store_credit, #remove_store_credit_payments, #total_applicable_store_credit, #total_applied_store_credit, #total_available_store_credit, #total_minus_store_credits, #using_store_credit?

Methods included from Digital

#create_digital_links, #digital?, #digital_line_items, #digital_links, #some_digital?, #with_digital_assets?

Methods included from CurrencyUpdater

#price_from_line_item, #update_line_item_currencies!, #update_line_item_price!

Methods included from Checkout

included

Instance Attribute Details

#coupon_code ⇒ Object

Returns the value of attribute coupon_code.



90
91
92
 
# File 'app/models/spree/order.rb', line 90

def coupon_code
  @coupon_code
end

#temporary_address ⇒ Object

Returns the value of attribute temporary_address.



91
92
93
 
# File 'app/models/spree/order.rb', line 91

def temporary_address
  @temporary_address
end

#temporary_credit_card ⇒ Object

Returns the value of attribute temporary_credit_card.



91
92
93
 
# File 'app/models/spree/order.rb', line 91

def temporary_credit_card
  @temporary_credit_card
end

#use_billing ⇒ Object

Returns the value of attribute use_billing.



160
161
162
 
# File 'app/models/spree/order.rb', line 160

def use_billing
  @use_billing
end

#use_shipping ⇒ Object

Returns the value of attribute use_shipping.



160
161
162
 
# File 'app/models/spree/order.rb', line 160

def use_shipping
  @use_shipping
end

Class Method Details

.multi_search(query) ⇒ Object 



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'app/models/spree/order.rb', line 213

def self.multi_search(query)
  sanitized_query = sanitize_query_for_multi_search(query)
  return none if query.blank?

  query_pattern = "%#{sanitized_query}%"

  conditions = []
  conditions << arel_table[:number].lower.matches(query_pattern)

  conditions << multi_search_condition(Spree::Address, :firstname, sanitized_query)
  conditions << multi_search_condition(Spree::Address, :lastname, sanitized_query)

  full_name = NameOfPerson::PersonName.full(sanitized_query)

  if full_name.first.present? && full_name.last.present?
    conditions << multi_search_condition(Spree::Address, :firstname, full_name.first)
    conditions << multi_search_condition(Spree::Address, :lastname, full_name.last)
  end

  left_joins(:bill_address).where(arel_table[:email].lower.eq(query.downcase)).or(where(conditions.reduce(:or)))
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



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

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

Instance Method Details

#all_inventory_units_returned? ⇒ Boolean

Returns:



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

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

#all_line_items ⇒ Object 



862
863
864
 
# File 'app/models/spree/order.rb', line 862

def all_line_items
  line_items
end

#all_line_items_invalid? ⇒ Boolean

Checks if all line items cannot be shipped

Returns:



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

def all_line_items_invalid?
  line_items_without_shipping_rates.size == line_items.count
end

#allow_cancel? ⇒ Boolean

Returns:



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

def allow_cancel?
  return false if !completed? || canceled?

  shipment_state.nil? || %w{ready backorder pending canceled}.include?(shipment_state)
end

#amount ⇒ Object

For compatibility with Calculator::PriceSack



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

def amount
  line_items.inject(0.0) { |sum, li| sum + li.amount }
end

#analytics_subtotal ⇒ Float

Returns the subtotal used for analytics integrations It’s a sum of the item total and the promo total

Returns:

  • (Float) 


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

def analytics_subtotal
  (item_total + line_items.sum(:promo_total)).to_f
end

#apply_free_shipping_promotions ⇒ Object 



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

def apply_free_shipping_promotions
  Spree::PromotionHandler::FreeShipping.new(self).activate
  shipments.each { |shipment| Spree::Adjustable::AdjustmentsUpdater.update(shipment) }
  create_shipment_tax_charge!
  update_with_updater!
end

#apply_unassigned_promotions ⇒ Object

Applies user promotions when login after filling the cart



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

def apply_unassigned_promotions
  ::Spree::PromotionHandler::Cart.new(self).activate
end

#approve! ⇒ Object 



781
782
783
 
# File 'app/models/spree/order.rb', line 781

def approve!
  update_column(:considered_risky, false)
end

#approved? ⇒ Boolean

Returns:



756
757
758
 
# File 'app/models/spree/order.rb', line 756

def approved?
  !!approved_at
end

#approved_by(user) ⇒ Object 



746
747
748
749
750
751
752
753
754
 
# File 'app/models/spree/order.rb', line 746

def approved_by(user)
  transaction do
    approve!
    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.



378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'app/models/spree/order.rb', line 378

def associate_user!(user, override_email = true)
  self.user           = user
  self.email          = user.email if override_email
  # we need to check if user is of admin user class to avoid mismatch type error
  # in a scenario where we have separate classes for admin and regular users
  self.created_by   ||= user if user.is_a?(Spree.admin_user_class)
  self.bill_address ||= user.bill_address
  self.ship_address ||= user.ship_address

  changes = slice(*ASSOCIATED_USER_ATTRIBUTES)

  # immediately persist the changes we just made, but don't use save
  # since we might have an invalid address associated
  ActiveRecord::Base.connected_to(role: :writing) do
    self.class.unscoped.where(id: self).update_all(changes)
  end
end

#available_payment_methods(store = nil) ⇒ Object 



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

def available_payment_methods(store = nil)
  Spree::Deprecation.warn('`Order#available_payment_methods` is deprecated and will be removed in Spree 6. Use `collect_frontend_payment_methods` instead.')
  if store.present?
    Spree::Deprecation.warn('The `store` parameter is deprecated and will be removed in Spree 5. Order is already associated with Store')
  end

  @available_payment_methods ||= collect_payment_methods(store)
end

#backordered? ⇒ Boolean

Returns:



314
315
316
 
# File 'app/models/spree/order.rb', line 314

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

#backordered_variants ⇒ Array<Spree::Variant>

Returns the backordered variants for the order

Returns:



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

def backordered_variants
  variants.
    where(track_inventory: true).
    joins(:stock_items, :product).
    where(Spree::StockItem.table_name => { count_on_hand: ..0, backorderable: true })
end

#can_add_coupon? ⇒ Boolean

Returns:



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

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

#can_approve? ⇒ Boolean

Returns:



760
761
762
 
# File 'app/models/spree/order.rb', line 760

def can_approve?
  !approved?
end

#can_be_deleted? ⇒ Boolean

Returns:



769
770
771
 
# File 'app/models/spree/order.rb', line 769

def can_be_deleted?
  !completed? && payments.completed.empty?
end

#can_be_destroyed? ⇒ Boolean

Returns:



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

def can_be_destroyed?
  Spree::Deprecation.warn('Spree::Order#can_be_destroyed? is deprecated and will be removed in the next major version. Use Spree::Order#can_be_deleted? instead.')
  can_be_deleted?
end

#can_ship? ⇒ Boolean

Returns:



486
487
488
 
# File 'app/models/spree/order.rb', line 486

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

#canceled_by(user, canceled_at = nil) ⇒ Object 



734
735
736
737
738
739
740
741
742
743
744
 
# File 'app/models/spree/order.rb', line 734

def canceled_by(user, canceled_at = nil)
  canceled_at ||= Time.current

  transaction do
    update_columns(
      canceler_id: user.id,
      canceled_at: canceled_at
    )
    cancel!
  end
end

#cart_promo_total ⇒ BigDecimal

Returns item and whole order discount amount for Order without Shipment disccounts (eg. Free Shipping)

Returns:

  • (BigDecimal) 


837
838
839
840
841
 
# File 'app/models/spree/order.rb', line 837

def cart_promo_total
  all_adjustments.eligible.nonzero.promotion.
    where.not(adjustable_type: 'Spree::Shipment').
    sum(:amount)
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:



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

def checkout_allowed?
  line_items.exists?
end

#collect_backend_payment_methods ⇒ Object 



798
799
800
 
# File 'app/models/spree/order.rb', line 798

def collect_backend_payment_methods
  store.payment_methods.active.available_on_back_end.select { |pm| pm.available_for_order?(self) }
end

#collect_frontend_payment_methods ⇒ Object 



802
803
804
 
# File 'app/models/spree/order.rb', line 802

def collect_frontend_payment_methods
  store.payment_methods.active.available_on_front_end.select { |pm| pm.available_for_order?(self) }
end

#completed? ⇒ Boolean

Returns:



267
268
269
 
# File 'app/models/spree/order.rb', line 267

def completed?
  completed_at.present?
end

#confirmation_required? ⇒ Boolean

If true, causes the confirmation step to happen during the checkout process

Returns:



301
302
303
304
305
306
307
308
 
# File 'app/models/spree/order.rb', line 301

def confirmation_required?
  Spree::Config[:always_include_confirm_step] ||
    payments.valid.map(&:payment_method).compact.any?(&:confirmation_required?) ||
    # Little hacky fix for #4117
    # If this wasn't here, order would transition to address state on confirm failure
    # because there would be no valid payments any more.
    confirm?
end

#consider_risk ⇒ Object 



773
774
775
 
# File 'app/models/spree/order.rb', line 773

def consider_risk
  considered_risky! if is_risky? && !approved?
end

#considered_risky! ⇒ Object 



777
778
779
 
# File 'app/models/spree/order.rb', line 777

def considered_risky!
  update_column(:considered_risky, true)
end

#create_proposed_shipments ⇒ Object 



633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
 
# File 'app/models/spree/order.rb', line 633

def create_proposed_shipments
  all_adjustments.shipping.delete_all

  shipment_ids = shipments.map(&:id)
  StateChange.where(stateful_type: 'Spree::Shipment', stateful_id: shipment_ids).delete_all
  ShippingRate.where(shipment_id: shipment_ids).delete_all

  shipments.delete_all

  # Inventory Units which are not associated to any shipment (unshippable)
  # and are not returned or shipped should be deleted
  inventory_units.on_hand_or_backordered.delete_all

  self.shipments = Spree::Stock::Coordinator.new(self).shipments
end

#create_shipment_tax_charge! ⇒ Object 



421
422
423
 
# File 'app/models/spree/order.rb', line 421

def create_shipment_tax_charge!
  Spree::TaxRate.adjust(self, shipments) if shipments.any?
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.



416
417
418
419
 
# File 'app/models/spree/order.rb', line 416

def create_tax_charge!
  Spree::TaxRate.adjust(self, line_items)
  Spree::TaxRate.adjust(self, shipments) if shipments.any?
end

#credit_cards ⇒ Object 



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

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

#delivery_required? ⇒ Boolean

Does this order require a delivery (physical or digital).

Returns:



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

def delivery_required?
  true # true for Spree, can be decorated
end

#disassociate_user! ⇒ Object 



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

def disassociate_user!
  nullified_attributes = ASSOCIATED_USER_ATTRIBUTES.index_with(nil)

  update!(nullified_attributes)
end

#email_required? ⇒ Boolean

Returns:



310
311
312
 
# File 'app/models/spree/order.rb', line 310

def email_required?
  require_email
end

#empty! ⇒ Object 



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

def empty!
  raise Spree.t(:cannot_empty_completed_order) if completed?

  result = Spree::Dependencies.cart_empty_service.constantize.call(order: self)
  result.value
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.



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

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 



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

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



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

def ensure_store_presence
  self.store ||= Spree::Store.default
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



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

def ensure_updated_shipments
  if shipments.any? && !completed?
    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



506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
 
# File 'app/models/spree/order.rb', line 506

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

  # update payment and shipment(s) states, and save
  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?
  deliver_store_owner_order_notification_email if deliver_store_owner_order_notification_email?

  send_order_placed_webhook

  consider_risk
end

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



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

def find_line_item_by_variant(variant, options = {})
  line_items.detect do |line_item|
    line_item.variant_id == variant.id &&
      Spree::Dependencies.cart_compare_line_items_service.constantize.new.call(order: self, line_item: line_item, options: options).value
  end
end

#fulfill! ⇒ Object 



531
532
533
534
535
 
# File 'app/models/spree/order.rb', line 531

def fulfill!
  shipments.each { |shipment| shipment.update!(self) if shipment.persisted? }
  updater.update_shipment_state
  save!
end

#full_name ⇒ Object 



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

def full_name
  @full_name ||= if user.present? && user.name.present?
                   user.full_name
                 else
                   billing_address&.full_name || email
                 end
end

#fully_discounted? ⇒ Boolean Also known as: fully_discounted

determines whether the inventory is fully discounted

Returns

  • true if inventory amount is the exact negative of inventory related adjustments

  • false otherwise

Returns:



811
812
813
 
# File 'app/models/spree/order.rb', line 811

def fully_discounted?
  adjustment_total + line_items.map(&:final_amount).sum == 0.0
end

#fully_shipped? ⇒ Boolean

Returns:



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

def fully_shipped?
  shipments.shipped.size == shipments.size
end

#has_free_shipping? ⇒ Boolean

Returns:



843
844
845
846
847
848
 
# File 'app/models/spree/order.rb', line 843

def has_free_shipping?
  shipment_adjustments.
    joins(:promotion_action).
    where(spree_adjustments: { eligible: true, source_type: 'Spree::PromotionAction' },
          spree_promotion_actions: { type: 'Spree::Promotion::Actions::FreeShipping' }).exists?
end

#has_non_reimbursement_related_refunds? ⇒ Boolean

Returns:



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

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

#has_step?(step) ⇒ Boolean

Returns:



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

def has_step?(step)
  checkout_steps.include?(step)
end

#insufficient_stock_lines ⇒ Object 



551
552
553
 
# File 'app/models/spree/order.rb', line 551

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

#is_risky? ⇒ Boolean

Returns:



730
731
732
 
# File 'app/models/spree/order.rb', line 730

def is_risky?
  !payments.risky.empty?
end

#line_items_without_shipping_rates ⇒ Array<Spree::LineItem>

Returns line items that have no shipping rates

Returns:



660
661
662
663
664
 
# File 'app/models/spree/order.rb', line 660

def line_items_without_shipping_rates
  @line_items_without_shipping_rates ||= shipments.map do |shipment|
    shipment.manifest.map(&:line_item) if shipment.shipping_rates.blank?
  end.flatten.compact
end

#log_state_changes(state_name:, old_state:, new_state:) ⇒ Object 



604
605
606
607
608
609
610
611
 
# File 'app/models/spree/order.rb', line 604

def log_state_changes(state_name:, old_state:, new_state:)
  state_changes.create(
    previous_state: old_state,
    next_state: new_state,
    name: state_name,
    user_id: user_id
  )
end

#merger ⇒ Object 



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

def merger
  @merger ||= Spree::OrderMerger.new(self)
end

#name ⇒ Object 



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

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

#order_refunded? ⇒ Boolean

Returns:



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

def order_refunded?
  (payment_state.in?(%w[void failed]) && refunds.sum(:amount).positive?) ||
    refunds.sum(:amount) == total_minus_store_credits - additional_tax_total.abs
end

#outstanding_balance ⇒ Object 



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

def outstanding_balance
  if canceled?
    -1 * payment_total
  else
    total - (payment_total + reimbursement_paid_total)
  end
end

#outstanding_balance? ⇒ Boolean

Returns:



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

def outstanding_balance?
  outstanding_balance != 0
end

#paid? ⇒ Boolean

Helper methods for checkout steps

Returns:



538
539
540
 
# File 'app/models/spree/order.rb', line 538

def paid?
  payments.valid.completed.size == payments.valid.size && payments.valid.sum(:amount) >= total
end

#partially_refunded? ⇒ Boolean

Returns:



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

def partially_refunded?
  return false if refunds.empty? || payment_state.in?(%w[void failed])

  refunds.sum(:amount) < total_minus_store_credits - additional_tax_total.abs
end

#payment_method ⇒ Spree::PaymentMethod

Returns the payment method for the order

Returns:



465
466
467
 
# File 'app/models/spree/order.rb', line 465

def payment_method
  payments.valid.not_store_credits.first&.payment_method
end

#payment_required? ⇒ Boolean

Is this a free order in which case the payment step should be skipped

Returns:



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

def payment_required?
  total.to_f > 0.0
end

#payment_source ⇒ Spree::PaymentSource

Returns the payment source for the order

Returns:



472
473
474
 
# File 'app/models/spree/order.rb', line 472

def payment_source
  payments.valid.not_store_credits.first&.source
end

#pre_tax_item_amount ⇒ Object

Sum of all line item amounts pre-tax



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

def pre_tax_item_amount
  line_items.sum(:pre_tax_amount)
end

#pre_tax_total ⇒ Object

Sum of all line item and shipment pre-tax



252
253
254
 
# File 'app/models/spree/order.rb', line 252

def pre_tax_total
  pre_tax_item_amount + shipments.sum(:pre_tax_amount)
end

#promo_code ⇒ Object 



816
817
818
 
# File 'app/models/spree/order.rb', line 816

def promo_code
  Spree::CouponCode.find_by(order: self, promotion: promotions).try(:code) || promotions.pluck(:code).compact.first
end

#quantity ⇒ Object 



789
790
791
 
# File 'app/models/spree/order.rb', line 789

def quantity
  line_items.sum(:quantity)
end

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



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

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

#quick_checkout? ⇒ Boolean

Check if the shipping address is a quick checkout address quick checkout addresses are incomplete as wallet providers like Apple Pay and Google Pay do not provide all the address fields until the checkout is completed (confirmed) on their side

Returns:



322
323
324
 
# File 'app/models/spree/order.rb', line 322

def quick_checkout?
  shipping_address.present? && shipping_address.quick_checkout?
end

#quick_checkout_available? ⇒ Boolean

Check if quick checkout is available for this order Either fully digital or not digital at all

Returns:



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

def quick_checkout_available?
  payment_required? && shipments.count <= 1 && (digital? || !some_digital? || !delivery_required?)
end

#quick_checkout_require_address? ⇒ Boolean

Check if quick checkout requires an address collection If the order is digital or not delivery required, then we don’t need to collect an address

Returns:



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

def quick_checkout_require_address?
  !digital? && delivery_required?
end

#refresh_shipment_rates(shipping_method_filter = ShippingMethod::DISPLAY_ON_FRONT_END) ⇒ Object 



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

def refresh_shipment_rates(shipping_method_filter = ShippingMethod::DISPLAY_ON_FRONT_END)
  shipments.map { |s| s.refresh_rates(shipping_method_filter) }
end

#reimbursement_paid_total ⇒ Object 



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

def reimbursement_paid_total
  reimbursements.sum(&:paid_amount)
end

#requires_ship_address? ⇒ Boolean

Returns:



866
867
868
 
# File 'app/models/spree/order.rb', line 866

def requires_ship_address?
  !digital?
end

#restart_checkout_flow ⇒ Object 



698
699
700
701
702
703
704
 
# File 'app/models/spree/order.rb', line 698

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

#set_shipments_cost ⇒ Object 



714
715
716
717
718
719
 
# File 'app/models/spree/order.rb', line 714

def set_shipments_cost
  shipments.each(&:update_amounts)
  updater.update_shipment_total
  updater.update_adjustment_total
  persist_totals
end

#shipped? ⇒ Boolean

Returns:



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

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

#shipping_discount ⇒ Object 



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

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

#shipping_eq_billing_address? ⇒ Boolean

Returns:



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

def shipping_eq_billing_address?
  bill_address == ship_address
end

#shipping_method ⇒ Object 



721
722
723
724
725
726
727
728
 
# File 'app/models/spree/order.rb', line 721

def shipping_method
  # This query will select the first available shipping method from the shipments.
  # It will use subquery to first select the shipping method id from the shipments' selected_shipping_rate.
  Spree::ShippingMethod.
    where(id: shipments.with_selected_shipping_method.limit(1).pluck(:shipping_method_id)).
    limit(1).
    first
end

#state_changed(name) ⇒ Object 



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

def state_changed(name)
  state = "#{name}_state"
  if persisted?
    old_state = send("#{state}_was")
    new_state = send(state)
    unless old_state == new_state
      log_state_changes(state_name: name, old_state: old_state, new_state: new_state)
    end
  end
end

#tax_address ⇒ Object

Returns the address for taxation based on configuration



347
348
349
 
# File 'app/models/spree/order.rb', line 347

def tax_address
  Spree::Config[:tax_using_ship_address] ? ship_address : bill_address
end

#tax_total ⇒ Object 



785
786
787
 
# File 'app/models/spree/order.rb', line 785

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



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

def tax_zone
  @tax_zone ||= Zone.match(tax_address) || Zone.default_tax
end

#to_csv(_store = nil) ⇒ Object 



850
851
852
853
854
855
856
857
858
859
860
 
# File 'app/models/spree/order.rb', line 850

def to_csv(_store = nil)
  metafields_for_csv ||= Spree::MetafieldDefinition.for_resource_type('Spree::Order').order(:namespace, :key).map do |mf_def|
    metafields.find { |mf| mf.metafield_definition_id == mf_def.id }&.csv_value
  end

  csv_lines = []
  all_line_items.each_with_index do |line_item, index|
    csv_lines << Spree::CSV::OrderLineItemPresenter.new(self, line_item, index, metafields_for_csv).call
  end
  csv_lines
end

#total_weight ⇒ BigDecimal

Returns the total weight of the inventory units in the order This is used to calculate the shipping rates for the order

Returns:

  • (BigDecimal) —

    the total weight of the inventory units in the order



653
654
655
 
# File 'app/models/spree/order.rb', line 653

def total_weight
  @total_weight ||= line_items.joins(:variant).includes(:variant).map(&:item_weight).sum
end

#uneditable? ⇒ Boolean

Returns:



490
491
492
 
# File 'app/models/spree/order.rb', line 490

def uneditable?
  complete? || canceled? || returned?
end

#update_line_item_prices! ⇒ Object 



425
426
427
428
429
430
 
# File 'app/models/spree/order.rb', line 425

def update_line_item_prices!
  transaction do
    line_items.reload.each(&:update_price)
    save!
  end
end

#update_with_updater! ⇒ Object 



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

def update_with_updater!
  updater.update
end

#updater ⇒ Object 



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

def updater
  @updater ||= Spree::Dependencies.order_updater.constantize.new(self)
end

#use_all_coupon_codes ⇒ Object 



585
586
587
 
# File 'app/models/spree/order.rb', line 585

def use_all_coupon_codes
  Spree::CouponCodes::CouponCodesHandler.new(order: self).use_all_codes
end

#valid_coupon_promotions ⇒ Object 



828
829
830
831
832
 
# File 'app/models/spree/order.rb', line 828

def valid_coupon_promotions
  promotions.
    where(id: valid_promotion_ids).
    coupons
end

#valid_credit_cards ⇒ Object 



499
500
501
502
 
# File 'app/models/spree/order.rb', line 499

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

#valid_promotion_ids ⇒ Object 



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

def valid_promotion_ids
  all_adjustments.eligible.nonzero.promotion.map { |a| a.source.promotion_id }.uniq
end

#valid_promotions ⇒ Object 



820
821
822
 
# File 'app/models/spree/order.rb', line 820

def valid_promotions
  order_promotions.where(promotion_id: valid_promotion_ids).uniq(&:promotion_id)
end