Class: Spree::Order

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

  • 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: 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

Methods included from Core::Permalinks

#generate_permalink, #save_permalink

Instance Attribute Details

#coupon_code ⇒ Object

Returns the value of attribute coupon_code.



70
71
72
 
# File 'app/models/spree/order.rb', line 70

def coupon_code
  @coupon_code
end

#temporary_address ⇒ Object

Returns the value of attribute temporary_address.



71
72
73
 
# File 'app/models/spree/order.rb', line 71

def temporary_address
  @temporary_address
end

#temporary_payment_source ⇒ Object

Returns the value of attribute temporary_payment_source.



73
74
75
 
# File 'app/models/spree/order.rb', line 73

def temporary_payment_source
  @temporary_payment_source
end

#use_billing ⇒ Object

Returns the value of attribute use_billing.



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

def use_billing
  @use_billing
end

#use_shipping ⇒ Object

Returns the value of attribute use_shipping.



144
145
146
 
# File 'app/models/spree/order.rb', line 144

def use_shipping
  @use_shipping
end

Class Method Details

.by_customer(customer) ⇒ Object 



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

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

.by_state(state) ⇒ Object 



199
200
201
 
# File 'app/models/spree/order.rb', line 199

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

.canceled ⇒ Object 



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

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

.complete ⇒ Object 



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

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

.find_by_param(value) ⇒ Object 



155
156
157
 
# File 'app/models/spree/order.rb', line 155

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

.find_by_param!(value) ⇒ Object 



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

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

.incomplete ⇒ Object 



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

def self.incomplete
  where(completed_at: nil)
end

.line_item_comparison_hooks ⇒ Object 



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

def line_item_comparison_hooks
  Spree::Config.line_item_comparison_hooks
end

.line_item_comparison_hooks=(value) ⇒ Object 



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

def line_item_comparison_hooks=(value)
  Spree::Config.line_item_comparison_hooks = value.to_a
end

.not_canceled ⇒ Object 



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

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

.register_line_item_comparison_hook(hook) ⇒ Object 



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

def register_line_item_comparison_hook(hook)
  Spree::Config.line_item_comparison_hooks << hook
end

Instance Method Details

#add_default_payment_from_wallet ⇒ Object 



696
697
698
699
700
701
702
703
704
705
706
707
708
 
# File 'app/models/spree/order.rb', line 696

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 



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

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 



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
619
620
621
622
623
624
625
626
627
628
 
# File 'app/models/spree/order.rb', line 583

def add_store_credit_payments
  return if user.nil?
  return if payments.store_credits.checkout.empty? && user.available_store_credit_total(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:)

  if matching_store_credits.any?
    payment_method = Spree::PaymentMethod::StoreCredit.first
    sorter = Spree::Config.store_credit_prioritizer_class.new(matching_store_credits, self)

    sorter.call.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:,
                       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 



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

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 



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

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



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

def amount
  line_items.sum(&:amount)
end

#approved? ⇒ Boolean 



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

def approved?
  !!approved_at
end

#assign_billing_to_shipping_address ⇒ Object 



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

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.



672
673
674
675
676
677
678
679
680
681
682
 
# File 'app/models/spree/order.rb', line 672

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

#assign_shipping_to_billing_address ⇒ Object 



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

def assign_shipping_to_billing_address
  self.bill_address = ship_address if ship_address
  true
end

#associate_user!(user, override_email = true) ⇒ Object

Associates the specified user with the order.



321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'app/models/spree/order.rb', line 321

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:).update_all(attrs_to_set)
  end

  assign_attributes(attrs_to_set)
end

#available_payment_methods ⇒ Object 



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

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

#backordered? ⇒ Boolean 



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

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

#bill_address_attributes=(attributes) ⇒ Object 



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

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

#billing_address_required? ⇒ Boolean 



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

def billing_address_required?
  Spree::Config.billing_address_required
end

#can_add_coupon? ⇒ Boolean 



476
477
478
 
# File 'app/models/spree/order.rb', line 476

def can_add_coupon?
  Spree::Config.promotions.coupon_code_handler_class.new(self).can_apply?
end

#can_approve? ⇒ Boolean 



567
568
569
 
# File 'app/models/spree/order.rb', line 567

def can_approve?
  !approved?
end

#can_ship? ⇒ Boolean 



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

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

#canceled_by(user) ⇒ Object 



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

def canceled_by(user)
  transaction do
    cancel!
    update_column(:canceler_id, user.id)
  end
end

#cancellations ⇒ Object 



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

def cancellations
  @cancellations ||= Spree::Config.order_cancellations_class.new(self)
end

#check_shipments_and_restart_checkout ⇒ Object Also known as: ensure_updated_shipments

Clean shipments and make order back to address state (or to whatever state is set by restart_checkout_flow in case of state machine modifications)



523
524
525
526
527
528
529
 
# File 'app/models/spree/order.rb', line 523

def check_shipments_and_restart_checkout
  if !completed? && shipments.all?(&:pending?)
    shipments.destroy_all
    update_column(:shipment_total, 0)
    restart_checkout_flow
  end
end

#checkout_allowed? ⇒ Boolean

Indicates whether or not the user is allowed to proceed to checkout. Currently this is implemented as a check for whether or not there is at least one LineItem in the Order. Feel free to override this logic in your own application if you require additional steps before allowing a checkout.



257
258
259
 
# File 'app/models/spree/order.rb', line 257

def checkout_allowed?
  line_items.count > 0
end

#completed? ⇒ Boolean 



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

def completed?
  completed_at.present?
end

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



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

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

#contents ⇒ Object 



308
309
310
 
# File 'app/models/spree/order.rb', line 308

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

#covered_by_store_credit? ⇒ Boolean Also known as: covered_by_store_credit 



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

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

#create_proposed_shipments ⇒ Object 



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

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 



513
514
515
516
517
518
519
 
# File 'app/models/spree/order.rb', line 513

def create_shipments_for_line_item(line_item)
  units = Spree::Config.stock.inventory_unit_builder_class.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

#credit_cards ⇒ Object 



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

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

#currency ⇒ Object 



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

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

#display_store_credit_remaining_after_capture ⇒ Object 



657
658
659
 
# File 'app/models/spree/order.rb', line 657

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

#display_total_applicable_store_credit ⇒ Object 



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

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

#empty! ⇒ Object 



459
460
461
462
463
464
465
466
 
# File 'app/models/spree/order.rb', line 459

def empty!
  line_items.destroy_all
  adjustments.destroy_all
  shipments.destroy_all
  Spree::Bus.publish :order_emptied, order: self

  recalculate
end

#ensure_billing_address ⇒ Object 



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

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.



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

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 



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

def ensure_shipping_address
  unless ship_address && ship_address.valid?
    errors.add(:base, I18n.t('spree.ship_address_required')) && (return false)
  end
end

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



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

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 



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

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

#generate_order_number ⇒ Object 



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

def generate_order_number
  self.number ||= Spree::Config.order_number_generator.generate
end

#has_non_reimbursement_related_refunds? ⇒ Boolean 



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

def has_non_reimbursement_related_refunds?
  refunds.non_reimbursement.exists?
end

#insufficient_stock_lines ⇒ Object 



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

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

#is_risky? ⇒ Boolean 



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

def is_risky?
  payments.risky.count > 0
end

#item_total_before_tax ⇒ Object 



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

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



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

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



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

def line_item_options_match(line_item, options)
  return true unless options

  Spree::Config.line_item_comparison_hooks.all? { |hook|
    send(hook, line_item, options)
  }
end

#merge!(*args) ⇒ Object 



455
456
457
 
# File 'app/models/spree/order.rb', line 455

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

#name ⇒ Object 



399
400
401
402
403
 
# File 'app/models/spree/order.rb', line 399

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

#order_total_after_store_credit ⇒ Object 



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

def order_total_after_store_credit
  total - total_applicable_store_credit
end

#outstanding_balance ⇒ Object 



380
381
382
383
384
385
386
387
388
389
 
# File 'app/models/spree/order.rb', line 380

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 



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

def outstanding_balance?
  outstanding_balance != 0
end

#paid? ⇒ Boolean

Helper methods for checkout steps



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

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



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

def payment_required?
  total > 0
end

#payments_attributes=(attributes) ⇒ Object 



718
719
720
721
 
# File 'app/models/spree/order.rb', line 718

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

#persist_user_address! ⇒ Object 



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

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 



571
572
573
 
# File 'app/models/spree/order.rb', line 571

def quantity
  line_items.sum(:quantity)
end

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



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

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

#recalculator ⇒ Object Also known as: updater 



279
280
281
 
# File 'app/models/spree/order.rb', line 279

def recalculator
  @recalculator ||= Spree::Config.order_recalculator_class.new(self)
end

#record_ip_address(ip_address) ⇒ Object 



710
711
712
713
714
715
716
 
# File 'app/models/spree/order.rb', line 710

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 



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

def refresh_shipment_rates
  shipments.map(&:refresh_rates)
end

#refund_total ⇒ Object 



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

def refund_total
  refunds.sum(&:amount)
end

#reimbursement_total ⇒ Object 



376
377
378
 
# File 'app/models/spree/order.rb', line 376

def reimbursement_total
  reimbursements.sum(:total)
end

#restart_checkout_flow ⇒ Object 



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

def restart_checkout_flow
  return if state == 'cart'

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

#ship_address_attributes=(attributes) ⇒ Object 



665
666
667
 
# File 'app/models/spree/order.rb', line 665

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

#shipment_total_before_tax ⇒ Object 



228
229
230
 
# File 'app/models/spree/order.rb', line 228

def shipment_total_before_tax
  shipments.to_a.sum(&:total_before_tax)
end

#shipped? ⇒ Boolean 



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

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

#shipped_shipments ⇒ Object 



339
340
341
 
# File 'app/models/spree/order.rb', line 339

def shipped_shipments
  shipments.shipped
end

#shipping ⇒ Object 



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

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

#shipping_discount ⇒ Object 



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

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

#shipping_eq_billing_address? ⇒ Boolean 



548
549
550
 
# File 'app/models/spree/order.rb', line 548

def shipping_eq_billing_address?
  bill_address == ship_address
end

#tax_address ⇒ Object

Returns the address for taxation based on configuration



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

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 



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

def tax_total
  additional_tax_total + included_tax_total
end

#to_param ⇒ Object 



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

def to_param
  number
end

#total_applicable_store_credit ⇒ Object 



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

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:) || 0.0].min
  end
end

#total_available_store_credit ⇒ Object 



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

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

#valid_credit_cards ⇒ Object 



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

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 



723
724
725
726
727
728
729
730
731
732
 
# File 'app/models/spree/order.rb', line 723

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