Class: Spree::Order
- Inherits:
-
Base
- Object
- ActiveRecord::Base
- Base
- Spree::Order
show all
- Includes:
- Checkout, CurrencyUpdater, Payments
- Defined in:
- app/models/spree/order.rb,
app/models/spree/order/checkout.rb,
app/models/spree/order/payments.rb,
app/models/spree/order/currency_updater.rb
Defined Under Namespace
Modules: Checkout, CurrencyUpdater, Payments
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
#price_from_line_item, #update_line_item_currencies!, #update_line_item_price!
Methods included from Checkout
included
Methods inherited from Base
page
#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.
24
25
26
|
# File 'app/models/spree/order.rb', line 24
def coupon_code
@coupon_code
end
|
#temporary_address ⇒ Object
Returns the value of attribute temporary_address.
25
26
27
|
# File 'app/models/spree/order.rb', line 25
def temporary_address
@temporary_address
end
|
#temporary_credit_card ⇒ Object
Returns the value of attribute temporary_credit_card.
25
26
27
|
# File 'app/models/spree/order.rb', line 25
def temporary_credit_card
@temporary_credit_card
end
|
#use_billing ⇒ Object
Returns the value of attribute use_billing.
78
79
80
|
# File 'app/models/spree/order.rb', line 78
def use_billing
@use_billing
end
|
Class Method Details
.by_customer(customer) ⇒ Object
110
111
112
|
# File 'app/models/spree/order.rb', line 110
def self.by_customer(customer)
joins(:user).where("#{Spree.user_class.table_name}.email" => customer)
end
|
.by_number(number) ⇒ Object
100
101
102
|
# File 'app/models/spree/order.rb', line 100
def self.by_number(number)
where(number: number)
end
|
.by_state(state) ⇒ Object
114
115
116
|
# File 'app/models/spree/order.rb', line 114
def self.by_state(state)
where(state: state)
end
|
.complete ⇒ Object
118
119
120
|
# File 'app/models/spree/order.rb', line 118
def self.complete
where.not(completed_at: nil)
end
|
.incomplete ⇒ Object
122
123
124
|
# File 'app/models/spree/order.rb', line 122
def self.incomplete
where(completed_at: nil)
end
|
.register_line_item_comparison_hook(hook) ⇒ Object
Use this method in other gems that wish to register their own custom logic that should be called when determining if two line items are equal.
134
135
136
|
# File 'app/models/spree/order.rb', line 134
def self.register_line_item_comparison_hook(hook)
self.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
128
129
130
|
# File 'app/models/spree/order.rb', line 128
def self.register_update_hook(hook)
self.update_hooks.add(hook)
end
|
Instance Method Details
#all_adjustments ⇒ Object
138
139
140
141
|
# File 'app/models/spree/order.rb', line 138
def all_adjustments
Adjustment.where("order_id = :order_id OR (adjustable_id = :order_id AND adjustable_type = 'Spree::Order')",
order_id: self.id)
end
|
#all_inventory_units_returned? ⇒ Boolean
262
263
264
|
# File 'app/models/spree/order.rb', line 262
def all_inventory_units_returned?
inventory_units.all? { |inventory_unit| inventory_unit.returned? }
end
|
#allow_cancel? ⇒ Boolean
257
258
259
260
|
# File 'app/models/spree/order.rb', line 257
def allow_cancel?
return false unless completed? and state != 'canceled'
shipment_state.nil? || %w{ready backorder pending}.include?(shipment_state)
end
|
#amount ⇒ Object
For compatiblity with Calculator::PriceSack
144
145
146
|
# File 'app/models/spree/order.rb', line 144
def amount
line_items.inject(0.0) { |sum, li| sum + li.amount }
end
|
#approve! ⇒ Object
628
629
630
|
# File 'app/models/spree/order.rb', line 628
def approve!
update_column(:considered_risky, false)
end
|
#approved? ⇒ Boolean
610
611
612
|
# File 'app/models/spree/order.rb', line 610
def approved?
!!self.approved_at
end
|
#approved_by(user) ⇒ Object
600
601
602
603
604
605
606
607
608
|
# File 'app/models/spree/order.rb', line 600
def approved_by(user)
self.transaction do
approve!
self.update_columns(
approver_id: user.id,
approved_at: Time.now,
)
end
end
|
#associate_user!(user, override_email = true) ⇒ Object
Associates the specified user with the order.
271
272
273
274
275
276
277
278
279
280
281
282
|
# File 'app/models/spree/order.rb', line 271
def associate_user!(user, override_email = true)
self.user = user
attrs_to_set = { user_id: user.id }
attrs_to_set[:email] = user.email if override_email
attrs_to_set[:created_by_id] = user.id if self.created_by.blank?
assign_attributes(attrs_to_set)
if persisted?
self.class.unscoped.where(id: id).update_all(attrs_to_set)
end
end
|
#available_payment_methods ⇒ Object
#backordered? ⇒ Boolean
225
226
227
|
# File 'app/models/spree/order.rb', line 225
def backordered?
shipments.any?(&:backordered?)
end
|
#billing_firstname ⇒ Object
427
428
429
|
# File 'app/models/spree/order.rb', line 427
def billing_firstname
bill_address.try(:firstname)
end
|
#billing_lastname ⇒ Object
431
432
433
|
# File 'app/models/spree/order.rb', line 431
def billing_lastname
bill_address.try(:lastname)
end
|
#can_add_coupon? ⇒ Boolean
#can_approve? ⇒ Boolean
614
615
616
|
# File 'app/models/spree/order.rb', line 614
def can_approve?
!approved?
end
|
#can_ship? ⇒ Boolean
369
370
371
|
# File 'app/models/spree/order.rb', line 369
def can_ship?
self.complete? || self.resumed? || self.awaiting_return? || self.returned?
end
|
#canceled_by(user) ⇒ Object
590
591
592
593
594
595
596
597
598
|
# File 'app/models/spree/order.rb', line 590
def canceled_by(user)
self.transaction do
cancel!
self.update_columns(
canceler_id: user.id,
canceled_at: Time.now,
)
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.
206
207
208
|
# File 'app/models/spree/order.rb', line 206
def checkout_allowed?
line_items.count > 0
end
|
#clone_billing_address ⇒ Object
248
249
250
251
252
253
254
255
|
# File 'app/models/spree/order.rb', line 248
def clone_billing_address
if bill_address and self.ship_address.nil?
self.ship_address = bill_address.clone
else
self.ship_address.attributes = bill_address.attributes.except('id', 'updated_at', 'created_at')
end
true
end
|
#completed? ⇒ Boolean
198
199
200
|
# File 'app/models/spree/order.rb', line 198
def completed?
completed_at.present?
end
|
#confirmation_required? ⇒ Boolean
If true, causes the confirmation step to happen during the checkout process
216
217
218
219
220
221
222
223
|
# File 'app/models/spree/order.rb', line 216
def confirmation_required?
Spree::Config[:always_include_confirm_step] ||
payments.valid.map(&:payment_method).compact.any?(&:payment_profiles_supported?) ||
state == 'confirm'
end
|
#consider_risk ⇒ Object
618
619
620
621
622
|
# File 'app/models/spree/order.rb', line 618
def consider_risk
if is_risky? && !approved?
considered_risky!
end
end
|
#considered_risky! ⇒ Object
624
625
626
|
# File 'app/models/spree/order.rb', line 624
def considered_risky!
update_column(:considered_risky, true)
end
|
#contains?(variant, options = {}) ⇒ Boolean
309
310
311
|
# File 'app/models/spree/order.rb', line 309
def contains?(variant, options = {})
find_line_item_by_variant(variant, options).present?
end
|
#contents ⇒ Object
266
267
268
|
# File 'app/models/spree/order.rb', line 266
def contents
@contents ||= Spree::OrderContents.new(self)
end
|
#create_proposed_shipments ⇒ Object
538
539
540
541
542
|
# File 'app/models/spree/order.rb', line 538
def create_proposed_shipments
adjustments.shipping.delete_all
shipments.destroy_all
self.shipments = Spree::Stock::Coordinator.new(self).shipments
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.
344
345
346
347
348
349
|
# File 'app/models/spree/order.rb', line 344
def create_tax_charge!
order_tax_zone = self.tax_zone
Spree::TaxRate.adjust(order_tax_zone, line_items)
Spree::TaxRate.adjust(order_tax_zone, shipments) if shipments.any?
end
|
#credit_cards ⇒ Object
373
374
375
376
|
# File 'app/models/spree/order.rb', line 373
def credit_cards
credit_card_ids = payments.from_credit_card.pluck(:source_id).uniq
CreditCard.where(id: credit_card_ids)
end
|
#currency ⇒ Object
153
154
155
|
# File 'app/models/spree/order.rb', line 153
def currency
self[:currency] || Spree::Config[:currency]
end
|
#deliver_order_confirmation_email ⇒ Object
413
414
415
416
|
# File 'app/models/spree/order.rb', line 413
def deliver_order_confirmation_email
OrderMailer.confirm_email(self.id).deliver
update_column(:confirmation_delivered, true)
end
|
#display_additional_tax_total ⇒ Object
173
174
175
|
# File 'app/models/spree/order.rb', line 173
def display_additional_tax_total
Spree::Money.new(additional_tax_total, { currency: currency })
end
|
#display_adjustment_total ⇒ Object
165
166
167
|
# File 'app/models/spree/order.rb', line 165
def display_adjustment_total
Spree::Money.new(adjustment_total, { currency: currency })
end
|
#display_included_tax_total ⇒ Object
169
170
171
|
# File 'app/models/spree/order.rb', line 169
def display_included_tax_total
Spree::Money.new(included_tax_total, { currency: currency })
end
|
#display_item_total ⇒ Object
161
162
163
|
# File 'app/models/spree/order.rb', line 161
def display_item_total
Spree::Money.new(item_total, { currency: currency })
end
|
#display_outstanding_balance ⇒ Object
157
158
159
|
# File 'app/models/spree/order.rb', line 157
def display_outstanding_balance
Spree::Money.new(outstanding_balance, { currency: currency })
end
|
#display_shipment_total ⇒ Object
Also known as:
display_ship_total
181
182
183
|
# File 'app/models/spree/order.rb', line 181
def display_shipment_total
Spree::Money.new(shipment_total, { currency: currency })
end
|
#display_tax_total ⇒ Object
177
178
179
|
# File 'app/models/spree/order.rb', line 177
def display_tax_total
Spree::Money.new(tax_total, { currency: currency })
end
|
#display_total ⇒ Object
186
187
188
|
# File 'app/models/spree/order.rb', line 186
def display_total
Spree::Money.new(total, { currency: currency })
end
|
#empty! ⇒ Object
495
496
497
498
499
500
501
502
503
|
# File 'app/models/spree/order.rb', line 495
def empty!
line_items.destroy_all
updater.update_item_count
adjustments.destroy_all
shipments.destroy_all
update_totals
persist_totals
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.
442
443
444
445
446
447
448
449
450
|
# File 'app/models/spree/order.rb', line 442
def ensure_line_item_variants_are_not_deleted
if line_items.select{ |li| li.variant.destroyed? }.present?
errors.add(:base, Spree.t(:deleted_variants_present))
restart_checkout_flow
false
else
true
end
end
|
#ensure_line_items_are_in_stock ⇒ Object
452
453
454
455
456
457
458
459
460
|
# File 'app/models/spree/order.rb', line 452
def ensure_line_items_are_in_stock
if insufficient_stock_lines.present?
errors.add(:base, Spree.t(:insufficient_stock_lines_present))
restart_checkout_flow
false
else
true
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
556
557
558
559
560
561
562
|
# File 'app/models/spree/order.rb', line 556
def ensure_updated_shipments
if shipments.any? && !self.completed?
self.shipments.destroy_all
self.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
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
|
# File 'app/models/spree/order.rb', line 385
def finalize!
all_adjustments.each{|a| a.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
318
319
320
321
322
323
|
# File 'app/models/spree/order.rb', line 318
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
407
408
409
410
411
|
# File 'app/models/spree/order.rb', line 407
def fulfill!
shipments.each { |shipment| shipment.update!(self) if shipment.persisted? }
updater.update_shipment_state
save!
end
|
#generate_order_number(options = {}) ⇒ Object
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
|
# File 'app/models/spree/order.rb', line 284
def generate_order_number(options = {})
options[:length] ||= ORDER_NUMBER_LENGTH
options[:letters] ||= ORDER_NUMBER_LETTERS
options[:prefix] ||= ORDER_NUMBER_PREFIX
possible = (0..9).to_a
possible += ('A'..'Z').to_a if options[:letters]
self.number ||= loop do
random = "#{options[:prefix]}#{(0...options[:length]).map { possible.shuffle.first }.join}"
if self.class.exists?(number: random)
options[:length] += 1 if self.class.count > (10 ** options[:length] / 2)
else
break random
end
end
end
|
658
659
660
661
|
# File 'app/models/spree/order.rb', line 658
def has_non_reimbursement_related_refunds?
refunds.non_reimbursement.exists? ||
payments.offset_payment.exists? end
|
#has_step?(step) ⇒ Boolean
505
506
507
|
# File 'app/models/spree/order.rb', line 505
def has_step?(step)
checkout_steps.include?(step)
end
|
#insufficient_stock_lines ⇒ Object
435
436
437
|
# File 'app/models/spree/order.rb', line 435
def insufficient_stock_lines
line_items.select(&:insufficient_stock?)
end
|
#is_risky? ⇒ Boolean
586
587
588
|
# File 'app/models/spree/order.rb', line 586
def is_risky?
self.payments.risky.count > 0
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
334
335
336
337
338
339
340
|
# File 'app/models/spree/order.rb', line 334
def line_item_options_match(line_item, options)
return true unless options
self.line_item_comparison_hooks.all? { |hook|
self.send(hook, line_item, options)
}
end
|
#merge!(order, user = nil) ⇒ Object
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
|
# File 'app/models/spree/order.rb', line 462
def merge!(order, user = nil)
order.line_items.each do |other_order_line_item|
next unless other_order_line_item.currency == currency
current_line_item = self.line_items.detect { |my_li|
my_li.variant == other_order_line_item.variant &&
self.line_item_comparison_hooks.all? { |hook|
self.send(hook, my_li, other_order_line_item.serializable_hash)
}
}
if current_line_item
current_line_item.quantity += other_order_line_item.quantity
current_line_item.save!
else
other_order_line_item.order_id = self.id
other_order_line_item.save!
end
end
self.associate_user!(user) if !self.user && !user.blank?
updater.update_item_count
updater.update_item_total
updater.persist_totals
order.line_items.reload
order.destroy
end
|
#name ⇒ Object
363
364
365
366
367
|
# File 'app/models/spree/order.rb', line 363
def name
if (address = bill_address || ship_address)
"#{address.firstname} #{address.lastname}"
end
end
|
#outstanding_balance ⇒ Object
351
352
353
354
355
356
357
|
# File 'app/models/spree/order.rb', line 351
def outstanding_balance
if state == 'canceled'
-1 * payment_total
else
total - payment_total
end
end
|
#outstanding_balance? ⇒ Boolean
359
360
361
|
# File 'app/models/spree/order.rb', line 359
def outstanding_balance?
self.outstanding_balance != 0
end
|
#paid? ⇒ Boolean
Helper methods for checkout steps
419
420
421
|
# File 'app/models/spree/order.rb', line 419
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
211
212
213
|
# File 'app/models/spree/order.rb', line 211
def payment_required?
total.to_f > 0.0
end
|
#pre_tax_item_amount ⇒ Object
Sum of all line item amounts pre-tax
149
150
151
|
# File 'app/models/spree/order.rb', line 149
def pre_tax_item_amount
line_items.to_a.sum(&:pre_tax_amount)
end
|
#quantity ⇒ Object
654
655
656
|
# File 'app/models/spree/order.rb', line 654
def quantity
line_items.sum(:quantity)
end
|
#quantity_of(variant, options = {}) ⇒ Object
313
314
315
316
|
# File 'app/models/spree/order.rb', line 313
def quantity_of(variant, options = {})
line_item = find_line_item_by_variant(variant, options)
line_item ? line_item.quantity : 0
end
|
#refresh_shipment_rates ⇒ Object
572
573
574
|
# File 'app/models/spree/order.rb', line 572
def refresh_shipment_rates
shipments.map &:refresh_rates
end
|
#reload(options = nil) ⇒ Object
645
646
647
648
|
# File 'app/models/spree/order.rb', line 645
def reload(options=nil)
remove_instance_variable(:@tax_zone) if defined?(@tax_zone)
super
end
|
#restart_checkout_flow ⇒ Object
564
565
566
567
568
569
570
|
# File 'app/models/spree/order.rb', line 564
def restart_checkout_flow
self.update_columns(
state: 'cart',
updated_at: Time.now,
)
self.next! if self.line_items.size > 0
end
|
#set_shipments_cost ⇒ Object
580
581
582
583
584
|
# File 'app/models/spree/order.rb', line 580
def set_shipments_cost
shipments.each(&:update_amounts)
updater.update_shipment_total
persist_totals
end
|
#shipped? ⇒ Boolean
534
535
536
|
# File 'app/models/spree/order.rb', line 534
def shipped?
%w(partial shipped).include?(shipment_state)
end
|
#shipped_shipments ⇒ Object
305
306
307
|
# File 'app/models/spree/order.rb', line 305
def shipped_shipments
shipments.shipped
end
|
#shipping_discount ⇒ Object
190
191
192
|
# File 'app/models/spree/order.rb', line 190
def shipping_discount
shipment_adjustments.eligible.sum(:amount) * - 1
end
|
#shipping_eq_billing_address? ⇒ Boolean
576
577
578
|
# File 'app/models/spree/order.rb', line 576
def shipping_eq_billing_address?
(bill_address.empty? && ship_address.empty?) || bill_address.same_as?(ship_address)
end
|
#state_changed(name) ⇒ Object
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
|
# File 'app/models/spree/order.rb', line 509
def state_changed(name)
state = "#{name}_state"
if persisted?
old_state = self.send("#{state}_was")
new_state = self.send(state)
unless old_state == new_state
self.state_changes.create(
previous_state: old_state,
next_state: new_state,
name: name,
user_id: self.user_id
)
end
end
end
|
#tax_address ⇒ Object
Returns the address for taxation based on configuration
236
237
238
|
# File 'app/models/spree/order.rb', line 236
def tax_address
Spree::Config[:tax_using_ship_address] ? ship_address : bill_address
end
|
#tax_total ⇒ Object
650
651
652
|
# File 'app/models/spree/order.rb', line 650
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
231
232
233
|
# File 'app/models/spree/order.rb', line 231
def tax_zone
@tax_zone ||= Zone.match(tax_address) || Zone.default_tax
end
|
#to_param ⇒ Object
194
195
196
|
# File 'app/models/spree/order.rb', line 194
def to_param
number.to_s.to_url.upcase
end
|
#update! ⇒ Object
244
245
246
|
# File 'app/models/spree/order.rb', line 244
def update!
updater.update
end
|
#update_line_items(line_item_params) ⇒ Object
moved from api order_decorator. This is a better place for it.
633
634
635
636
637
638
639
640
641
642
643
|
# File 'app/models/spree/order.rb', line 633
def update_line_items(line_item_params)
return if line_item_params.blank?
line_item_params.each_value do |attributes|
if attributes[:id].present?
self.line_items.find(attributes[:id]).update_attributes!(attributes)
else
self.line_items.create!(attributes)
end
end
self.ensure_updated_shipments
end
|
#updater ⇒ Object
240
241
242
|
# File 'app/models/spree/order.rb', line 240
def updater
@updater ||= OrderUpdater.new(self)
end
|
#valid_credit_cards ⇒ Object
378
379
380
381
|
# File 'app/models/spree/order.rb', line 378
def valid_credit_cards
credit_card_ids = payments.from_credit_card.valid.pluck(:source_id).uniq
CreditCard.where(id: credit_card_ids)
end
|