Class: Spree::Order

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

Constants included from NumberGenerator

NumberGenerator::NUMBER_LENGTH, NumberGenerator::NUMBER_LETTERS, NumberGenerator::NUMBER_PREFIX

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from DisplayMoney

money_methods

Methods included from NumberGenerator

by_number

Methods included from CurrencyUpdater

#price_from_line_item, #update_line_item_currencies!, #update_line_item_price!

Methods included from Checkout

included

Methods inherited from Base

page

Methods included from Preferences::Preferable

#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.



36
37
38
 
# File 'app/models/spree/order.rb', line 36

def coupon_code
  @coupon_code
end

#temporary_address ⇒ Object

Returns the value of attribute temporary_address.



37
38
39
 
# File 'app/models/spree/order.rb', line 37

def temporary_address
  @temporary_address
end

#temporary_credit_card ⇒ Object

Returns the value of attribute temporary_credit_card.



37
38
39
 
# File 'app/models/spree/order.rb', line 37

def temporary_credit_card
  @temporary_credit_card
end

#use_billing ⇒ Object

Returns the value of attribute use_billing.



88
89
90
 
# File 'app/models/spree/order.rb', line 88

def use_billing
  @use_billing
end

Class Method Details

.complete ⇒ Object 



112
113
114
 
# File 'app/models/spree/order.rb', line 112

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

.incomplete ⇒ Object 



116
117
118
 
# File 'app/models/spree/order.rb', line 116

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.



128
129
130
 
# File 'app/models/spree/order.rb', line 128

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



122
123
124
 
# File 'app/models/spree/order.rb', line 122

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

Instance Method Details

#all_adjustments ⇒ Object 



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

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

Returns:

  • (Boolean) 


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

def all_inventory_units_returned?
  inventory_units.all? { |inventory_unit| inventory_unit.returned? }
end

#allow_cancel? ⇒ Boolean

Returns:

  • (Boolean) 


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

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



138
139
140
 
# File 'app/models/spree/order.rb', line 138

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

#apply_free_shipping_promotions ⇒ Object 



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

def apply_free_shipping_promotions
  Spree::PromotionHandler::FreeShipping.new(self).activate
  shipments.each { |shipment| Adjustable::AdjustmentsUpdater.update(shipment) }
  updater.update_shipment_total
  persist_totals
end

#approve! ⇒ Object 



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

def approve!
  update_column(:considered_risky, false)
end

#approved? ⇒ Boolean

Returns:

  • (Boolean) 


536
537
538
 
# File 'app/models/spree/order.rb', line 536

def approved?
  !!self.approved_at
end

#approved_by(user) ⇒ Object 



526
527
528
529
530
531
532
533
534
 
# File 'app/models/spree/order.rb', line 526

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.



228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'app/models/spree/order.rb', line 228

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?
    # immediately persist the changes we just made, but don't use save since we might have an invalid address associated
    self.class.unscoped.where(id: id).update_all(attrs_to_set)
  end
end

#available_payment_methods ⇒ Object 



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

def available_payment_methods
  @available_payment_methods ||= (PaymentMethod.available(:front_end) + PaymentMethod.available(:both)).uniq
end

#backordered? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#billing_firstname ⇒ Object 



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

def billing_firstname
  bill_address.try(:firstname)
end

#billing_lastname ⇒ Object 



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

def billing_lastname
  bill_address.try(:lastname)
end

#can_add_coupon? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#can_approve? ⇒ Boolean

Returns:

  • (Boolean) 


540
541
542
 
# File 'app/models/spree/order.rb', line 540

def can_approve?
  !approved?
end

#can_ship? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#canceled_by(user) ⇒ Object 



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

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.

Returns:

  • (Boolean) 


163
164
165
 
# File 'app/models/spree/order.rb', line 163

def checkout_allowed?
  line_items.count > 0
end

#clone_billing_address ⇒ Object 



205
206
207
208
209
210
211
212
 
# File 'app/models/spree/order.rb', line 205

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

Returns:

  • (Boolean) 


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

def completed?
  completed_at.present?
end

#confirmation_required? ⇒ Boolean

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

Returns:

  • (Boolean) 


173
174
175
176
177
178
179
180
 
# File 'app/models/spree/order.rb', line 173

def confirmation_required?
  Spree::Config[:always_include_confirm_step] ||
    payments.valid.map(&:payment_method).compact.any?(&:payment_profiles_supported?) ||
    # 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.
    state == 'confirm'
end

#consider_risk ⇒ Object 



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

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

#considered_risky! ⇒ Object 



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

def considered_risky!
  update_column(:considered_risky, true)
end

#contents ⇒ Object 



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

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

#create_proposed_shipments ⇒ Object 



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

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.



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

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

#credit_cards ⇒ Object 



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

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

#currency ⇒ Object 



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

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

#deliver_order_confirmation_email ⇒ Object 



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

def deliver_order_confirmation_email
  OrderMailer.confirm_email(id).deliver_later
  update_column(:confirmation_delivered, true)
end

#empty! ⇒ Object 



421
422
423
424
425
426
427
428
429
 
# File 'app/models/spree/order.rb', line 421

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.



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

def ensure_line_item_variants_are_not_deleted
  if line_items.any?{ |li| !li.variant || li.variant.paranoia_destroyed? }
    errors.add(:base, Spree.t(:deleted_variants_present))
    restart_checkout_flow
    false
  else
    true
  end
end

#ensure_line_items_are_in_stock ⇒ Object 



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

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



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

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



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'app/models/spree/order.rb', line 311

def finalize!
  # lock all adjustments (coupon promotions, etc.)
  all_adjustments.each{|a| a.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?

  consider_risk
end

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



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

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 



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

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

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

  • false otherwise

Returns:

  • (Boolean) 


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

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

#generate_number(options = {}) ⇒ Object 



14
15
16
17
 
# File 'app/models/spree/order.rb', line 14

def generate_number(options = {})
  options[:prefix] ||= 'R'
  super(options)
end

#has_non_reimbursement_related_refunds? ⇒ Boolean

Returns:

  • (Boolean) 


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

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:

  • (Boolean) 


431
432
433
 
# File 'app/models/spree/order.rb', line 431

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

#insufficient_stock_lines ⇒ Object 



361
362
363
 
# File 'app/models/spree/order.rb', line 361

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

#is_risky? ⇒ Boolean

Returns:

  • (Boolean) 


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

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



262
263
264
265
266
267
268
 
# File 'app/models/spree/order.rb', line 262

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 



388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'app/models/spree/order.rb', line 388

def merge!(order, user = nil)
  order.line_items.each do |other_order_line_item|
    next unless other_order_line_item.currency == currency

    # Compare the line items of the other order with mine.
    # Make sure you allow any extensions to chime in on whether or
    # not the extension-specific parts of the line item match
    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

  # So that the destroy doesn't take out line items which may have been re-assigned
  order.line_items.reload
  order.destroy
end

#name ⇒ Object 



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

def name
  if (address = bill_address || ship_address)
    "#{address.firstname} #{address.lastname}"
  end
end

#outstanding_balance ⇒ Object 



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

def outstanding_balance
  if state == 'canceled'
    -1 * payment_total
  else
    total - payment_total
  end
end

#outstanding_balance? ⇒ Boolean

Returns:

  • (Boolean) 


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

def outstanding_balance?
  self.outstanding_balance != 0
end

#paid? ⇒ Boolean

Helper methods for checkout steps

Returns:

  • (Boolean) 


345
346
347
 
# File 'app/models/spree/order.rb', line 345

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

Returns:

  • (Boolean) 


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

def payment_required?
  total.to_f > 0.0
end

#pre_tax_item_amount ⇒ Object

Sum of all line item amounts pre-tax



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

def pre_tax_item_amount
  line_items.to_a.sum(&:pre_tax_amount)
end

#quantity ⇒ Object 



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

def quantity
  line_items.sum(:quantity)
end

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



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

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 



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

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 



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

def reload(options=nil)
  remove_instance_variable(:@tax_zone) if defined?(@tax_zone)
  super
end

#restart_checkout_flow ⇒ Object 



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

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 



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

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

#shipped? ⇒ Boolean

Returns:

  • (Boolean) 


460
461
462
 
# File 'app/models/spree/order.rb', line 460

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

#shipping_discount ⇒ Object 



151
152
153
 
# File 'app/models/spree/order.rb', line 151

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

#shipping_eq_billing_address? ⇒ Boolean

Returns:

  • (Boolean) 


502
503
504
 
# File 'app/models/spree/order.rb', line 502

def shipping_eq_billing_address?
  (bill_address.empty? && ship_address.empty?) || bill_address.same_as?(ship_address)
end

#state_changed(name) ⇒ Object 



435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'app/models/spree/order.rb', line 435

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



193
194
195
 
# File 'app/models/spree/order.rb', line 193

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

#tax_total ⇒ Object 



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

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



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

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

#update! ⇒ Object 



201
202
203
 
# File 'app/models/spree/order.rb', line 201

def update!
  updater.update
end

#updater ⇒ Object 



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

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

#valid_credit_cards ⇒ Object 



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

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