Class: Spree::Order
- Inherits:
-
Base
- Object
- ApplicationRecord
- Base
- Spree::Order
show all
- Extended by:
- DisplayMoney
- Includes:
- Core::TokenGenerator, NumberAsParam, AddressBook, Checkout, CurrencyUpdater, Payments, StoreCredit
- Defined in:
- app/models/spree/order.rb,
app/models/spree/order/checkout.rb,
app/models/spree/order/payments.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, Payments, StoreCredit
Constant Summary
collapse
- PAYMENT_STATES =
%w(balance_due credit_owed failed paid void)
- SHIPMENT_STATES =
%w(backorder canceled partial pending ready shipped)
- 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
Instance Attribute Summary collapse
Class Method Summary
collapse
Instance Method Summary
collapse
money_methods
#to_param
#generate_token
#bill_address_attributes=, #bill_address_id=, #clone_billing_address, #clone_shipping_address, #ship_address_attributes=, #ship_address_id=
#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, #order_total_after_store_credit, #total_applicable_store_credit, #total_applied_store_credit, #total_available_store_credit, #using_store_credit?
#price_from_line_item, #update_line_item_currencies!, #update_line_item_price!
Methods included from Checkout
included
Methods inherited from Base
belongs_to_required_by_default, page, spree_base_scopes
#clear_preferences, #default_preferences, #defined_preferences, #get_preference, #has_preference!, #has_preference?, #preference_default, #preference_type, #set_preference
Instance Attribute Details
#coupon_code ⇒ Object
Returns the value of attribute coupon_code.
60
61
62
|
# File 'app/models/spree/order.rb', line 60
def coupon_code
@coupon_code
end
|
#temporary_address ⇒ Object
Returns the value of attribute temporary_address.
61
62
63
|
# File 'app/models/spree/order.rb', line 61
def temporary_address
@temporary_address
end
|
#temporary_credit_card ⇒ Object
Returns the value of attribute temporary_credit_card.
61
62
63
|
# File 'app/models/spree/order.rb', line 61
def temporary_credit_card
@temporary_credit_card
end
|
#use_billing ⇒ Object
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
.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
165
166
167
|
# File 'app/models/spree/order.rb', line 165
def self.register_update_hook(hook)
update_hooks.add(hook)
end
|
Instance Method Details
#all_inventory_units_returned? ⇒ Boolean
247
248
249
|
# File 'app/models/spree/order.rb', line 247
def all_inventory_units_returned?
inventory_units.all?(&:returned?)
end
|
#allow_cancel? ⇒ Boolean
241
242
243
244
245
|
# File 'app/models/spree/order.rb', line 241
def allow_cancel?
return false if !completed? || canceled?
shipment_state.nil? || %w{ready backorder pending}.include?(shipment_state)
end
|
#amount ⇒ Object
For compatiblity with Calculator::PriceSack
170
171
172
|
# File 'app/models/spree/order.rb', line 170
def amount
line_items.inject(0.0) { |sum, li| sum + li.amount }
end
|
Applies user promotions when login after filling the cart
#approve! ⇒ Object
564
565
566
|
# File 'app/models/spree/order.rb', line 564
def approve!
update_column(:considered_risky, false)
end
|
#approved? ⇒ Boolean
548
549
550
|
# File 'app/models/spree/order.rb', line 548
def approved?
!!approved_at
end
|
#approved_by(user) ⇒ Object
538
539
540
541
542
543
544
545
546
|
# File 'app/models/spree/order.rb', line 538
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.
252
253
254
255
256
257
258
259
260
261
262
263
264
|
# File 'app/models/spree/order.rb', line 252
def associate_user!(user, override_email = true)
self.user = user
self.email = user.email if override_email
self.created_by ||= user
self.bill_address ||= user.bill_address.try(:clone)
self.ship_address ||= user.ship_address.try(:clone)
changes = slice(:user_id, :email, :created_by_id, :bill_address_id, :ship_address_id)
self.class.unscoped.where(id: self).update_all(changes)
end
|
#available_payment_methods ⇒ Object
372
373
374
|
# File 'app/models/spree/order.rb', line 372
def available_payment_methods
@available_payment_methods ||= collect_payment_methods
end
|
#backordered? ⇒ Boolean
210
211
212
|
# File 'app/models/spree/order.rb', line 210
def backordered?
shipments.any?(&:backordered?)
end
|
#can_add_coupon? ⇒ Boolean
#can_approve? ⇒ Boolean
552
553
554
|
# File 'app/models/spree/order.rb', line 552
def can_approve?
!approved?
end
|
#can_ship? ⇒ Boolean
318
319
320
|
# File 'app/models/spree/order.rb', line 318
def can_ship?
complete? || resumed? || awaiting_return? || returned?
end
|
#canceled_by(user) ⇒ Object
528
529
530
531
532
533
534
535
536
|
# File 'app/models/spree/order.rb', line 528
def canceled_by(user)
transaction do
cancel!
update_columns(
canceler_id: user.id,
canceled_at: Time.current
)
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.
191
192
193
|
# File 'app/models/spree/order.rb', line 191
def checkout_allowed?
line_items.exists?
end
|
#collect_backend_payment_methods ⇒ Object
586
587
588
|
# File 'app/models/spree/order.rb', line 586
def collect_backend_payment_methods
PaymentMethod.available_on_back_end.select { |pm| pm.available_for_order?(self) }
end
|
#completed? ⇒ Boolean
183
184
185
|
# File 'app/models/spree/order.rb', line 183
def completed?
completed_at.present?
end
|
#confirmation_required? ⇒ Boolean
If true, causes the confirmation step to happen during the checkout process
201
202
203
204
205
206
207
208
|
# File 'app/models/spree/order.rb', line 201
def confirmation_required?
Spree::Config[:always_include_confirm_step] ||
payments.valid.map(&:payment_method).compact.any?(&:payment_profiles_supported?) ||
confirm?
end
|
#consider_risk ⇒ Object
556
557
558
|
# File 'app/models/spree/order.rb', line 556
def consider_risk
considered_risky! if is_risky? && !approved?
end
|
#considered_risky! ⇒ Object
560
561
562
|
# File 'app/models/spree/order.rb', line 560
def considered_risky!
update_column(:considered_risky, true)
end
|
#create_proposed_shipments ⇒ Object
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
|
# File 'app/models/spree/order.rb', line 461
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.on_hand_or_backordered.delete_all
self.shipments = Spree::Stock::Coordinator.new(self).shipments
end
|
#create_shipment_tax_charge! ⇒ Object
285
286
287
|
# File 'app/models/spree/order.rb', line 285
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.
280
281
282
283
|
# File 'app/models/spree/order.rb', line 280
def create_tax_charge!
Spree::TaxRate.adjust(self, line_items)
Spree::TaxRate.adjust(self, shipments) if shipments.any?
end
|
#credit_cards ⇒ Object
322
323
324
325
|
# File 'app/models/spree/order.rb', line 322
def credit_cards
credit_card_ids = payments.from_credit_card.pluck(:source_id).uniq
CreditCard.where(id: credit_card_ids)
end
|
#deliver_order_confirmation_email ⇒ Object
362
363
364
365
|
# File 'app/models/spree/order.rb', line 362
def deliver_order_confirmation_email
OrderMailer.confirm_email(id).deliver_later
update_column(:confirmation_delivered, true)
end
|
#empty! ⇒ Object
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
|
# File 'app/models/spree/order.rb', line 403
def empty!
if completed?
raise Spree.t(:cannot_empty_completed_order)
else
line_items.destroy_all
updater.update_item_count
adjustments.destroy_all
shipments.destroy_all
state_changes.destroy_all
order_promotions.destroy_all
update_totals
persist_totals
restart_checkout_flow
self
end
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.
383
384
385
386
387
388
389
390
391
|
# File 'app/models/spree/order.rb', line 383
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
393
394
395
396
397
398
399
400
401
|
# File 'app/models/spree/order.rb', line 393
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
237
238
239
|
# File 'app/models/spree/order.rb', line 237
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
494
495
496
497
498
499
500
|
# File 'app/models/spree/order.rb', line 494
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
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
|
# File 'app/models/spree/order.rb', line 334
def finalize!
all_adjustments.each(&:close)
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?
consider_risk
end
|
#find_line_item_by_variant(variant, options = {}) ⇒ Object
271
272
273
274
275
276
|
# File 'app/models/spree/order.rb', line 271
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
356
357
358
359
360
|
# File 'app/models/spree/order.rb', line 356
def fulfill!
shipments.each { |shipment| shipment.update!(self) if shipment.persisted? }
updater.update_shipment_state
save!
end
|
#fully_discounted? ⇒ Boolean
Also known as:
fully_discounted
determines whether the inventory is fully discounted
Returns
595
596
597
|
# File 'app/models/spree/order.rb', line 595
def fully_discounted?
adjustment_total + line_items.map(&:final_amount).sum == 0.0
end
|
581
582
583
584
|
# File 'app/models/spree/order.rb', line 581
def has_non_reimbursement_related_refunds?
refunds.non_reimbursement.exists? ||
payments.offset_payment.exists? end
|
#has_step?(step) ⇒ Boolean
421
422
423
|
# File 'app/models/spree/order.rb', line 421
def has_step?(step)
checkout_steps.include?(step)
end
|
#insufficient_stock_lines ⇒ Object
376
377
378
|
# File 'app/models/spree/order.rb', line 376
def insufficient_stock_lines
line_items.select(&:insufficient_stock?)
end
|
#is_risky? ⇒ Boolean
524
525
526
|
# File 'app/models/spree/order.rb', line 524
def is_risky?
!payments.risky.empty?
end
|
#log_state_changes(state_name:, old_state:, new_state:) ⇒ Object
436
437
438
439
440
441
442
443
|
# File 'app/models/spree/order.rb', line 436
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
233
234
235
|
# File 'app/models/spree/order.rb', line 233
def merger
@merger ||= Spree::OrderMerger.new(self)
end
|
#name ⇒ Object
312
313
314
315
316
|
# File 'app/models/spree/order.rb', line 312
def name
if (address = bill_address || ship_address)
address.full_name
end
end
|
#outstanding_balance ⇒ Object
296
297
298
299
300
301
302
303
304
305
306
|
# File 'app/models/spree/order.rb', line 296
def outstanding_balance
if canceled?
-1 * payment_total
elsif refunds.exists?
total - (payment_total + refunds.sum(:amount))
else
total - payment_total
end
end
|
#outstanding_balance? ⇒ Boolean
308
309
310
|
# File 'app/models/spree/order.rb', line 308
def outstanding_balance?
outstanding_balance != 0
end
|
#paid? ⇒ Boolean
Helper methods for checkout steps
368
369
370
|
# File 'app/models/spree/order.rb', line 368
def paid?
payment_state == 'paid' || payment_state == 'credit_owed'
end
|
#payment_required? ⇒ Boolean
Is this a free order in which case the payment step should be skipped
196
197
198
|
# File 'app/models/spree/order.rb', line 196
def payment_required?
total.to_f > 0.0
end
|
#payments_attributes=(attributes) ⇒ Object
604
605
606
607
|
# File 'app/models/spree/order.rb', line 604
def payments_attributes=(attributes)
validate_payments_attributes(attributes)
super(attributes)
end
|
#pre_tax_item_amount ⇒ Object
Sum of all line item amounts pre-tax
175
176
177
|
# File 'app/models/spree/order.rb', line 175
def pre_tax_item_amount
line_items.to_a.sum(&:pre_tax_amount)
end
|
600
601
602
|
# File 'app/models/spree/order.rb', line 600
def promo_code
promotions.pluck(:code).compact.first
end
|
#quantity ⇒ Object
577
578
579
|
# File 'app/models/spree/order.rb', line 577
def quantity
line_items.sum(:quantity)
end
|
#quantity_of(variant, options = {}) ⇒ Object
266
267
268
269
|
# File 'app/models/spree/order.rb', line 266
def quantity_of(variant, options = {})
line_item = find_line_item_by_variant(variant, options)
line_item ? line_item.quantity : 0
end
|
#refresh_shipment_rates(shipping_method_filter = ShippingMethod::DISPLAY_ON_FRONT_END) ⇒ Object
510
511
512
|
# File 'app/models/spree/order.rb', line 510
def refresh_shipment_rates(shipping_method_filter = ShippingMethod::DISPLAY_ON_FRONT_END)
shipments.map { |s| s.refresh_rates(shipping_method_filter) }
end
|
#reload(options = nil) ⇒ Object
568
569
570
571
|
# File 'app/models/spree/order.rb', line 568
def reload(options = nil)
remove_instance_variable(:@tax_zone) if defined?(@tax_zone)
super
end
|
#restart_checkout_flow ⇒ Object
502
503
504
505
506
507
508
|
# File 'app/models/spree/order.rb', line 502
def restart_checkout_flow
update_columns(
state: 'cart',
updated_at: Time.current
)
next! unless line_items.empty?
end
|
#set_shipments_cost ⇒ Object
518
519
520
521
522
|
# File 'app/models/spree/order.rb', line 518
def set_shipments_cost
shipments.each(&:update_amounts)
updater.update_shipment_total
persist_totals
end
|
#shipped? ⇒ Boolean
457
458
459
|
# File 'app/models/spree/order.rb', line 457
def shipped?
%w(partial shipped).include?(shipment_state)
end
|
#shipping_discount ⇒ Object
179
180
181
|
# File 'app/models/spree/order.rb', line 179
def shipping_discount
shipment_adjustments.non_tax.eligible.sum(:amount) * - 1
end
|
#shipping_eq_billing_address? ⇒ Boolean
514
515
516
|
# File 'app/models/spree/order.rb', line 514
def shipping_eq_billing_address?
bill_address == ship_address
end
|
#state_changed(name) ⇒ Object
425
426
427
428
429
430
431
432
433
434
|
# File 'app/models/spree/order.rb', line 425
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
221
222
223
|
# File 'app/models/spree/order.rb', line 221
def tax_address
Spree::Config[:tax_using_ship_address] ? ship_address : bill_address
end
|
#tax_total ⇒ Object
573
574
575
|
# File 'app/models/spree/order.rb', line 573
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
216
217
218
|
# File 'app/models/spree/order.rb', line 216
def tax_zone
@tax_zone ||= Zone.match(tax_address) || Zone.default_tax
end
|
#update_line_item_prices! ⇒ Object
289
290
291
292
293
294
|
# File 'app/models/spree/order.rb', line 289
def update_line_item_prices!
transaction do
line_items.reload.each(&:update_price)
save!
end
end
|
#update_with_updater! ⇒ Object
229
230
231
|
# File 'app/models/spree/order.rb', line 229
def update_with_updater!
updater.update
end
|
#updater ⇒ Object
225
226
227
|
# File 'app/models/spree/order.rb', line 225
def updater
@updater ||= OrderUpdater.new(self)
end
|
#valid_credit_cards ⇒ Object
327
328
329
330
|
# File 'app/models/spree/order.rb', line 327
def valid_credit_cards
credit_card_ids = payments.from_credit_card.valid.pluck(:source_id).uniq
CreditCard.where(id: credit_card_ids)
end
|
624
625
626
|
# File 'app/models/spree/order.rb', line 624
def valid_promotion_ids
all_adjustments.eligible.nonzero.promotion.map { |a| a.source.promotion_id }.uniq
end
|
620
621
622
|
# File 'app/models/spree/order.rb', line 620
def valid_promotions
order_promotions.where(promotion_id: valid_promotion_ids).uniq(&:promotion_id)
end
|
#validate_payments_attributes(attributes) ⇒ Object
609
610
611
612
613
614
615
616
617
618
|
# File 'app/models/spree/order.rb', line 609
def validate_payments_attributes(attributes)
payment_methods = Spree::PaymentMethod.where(id: available_payment_methods.map(&:id))
attributes.each do |payment_attributes|
payment_method_id = payment_attributes[:payment_method_id]
payment_methods.find(payment_method_id) if payment_method_id
end
end
|