Class: Spree::Shipment

Inherits:
Base
  • Object
show all
Extended by:
DisplayMoney
Defined in:
app/models/spree/shipment.rb

Overview

An order’s planned shipments including tracking and cost.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from DisplayMoney

money_methods

Methods inherited from Base

display_includes, #initialize_preference_defaults, page, preference

Methods included from Preferences::Preferable

#default_preferences, #defined_preferences, #get_preference, #has_preference!, #has_preference?, #preference_default, #preference_type, #set_preference

Instance Attribute Details

#special_instructions ⇒ Object

TODO: remove the suppress_mailer temporary variable once we are calling ‘ship’ from outside of the state machine and can actually pass variables through.



21
22
23
 
# File 'app/models/spree/shipment.rb', line 21

def special_instructions
  @special_instructions
end

#suppress_mailer ⇒ Object

TODO: remove the suppress_mailer temporary variable once we are calling ‘ship’ from outside of the state machine and can actually pass variables through.



21
22
23
 
# File 'app/models/spree/shipment.rb', line 21

def suppress_mailer
  @suppress_mailer
end

Instance Method Details

#add_shipping_method(shipping_method, selected = false) ⇒ Object 



95
96
97
 
# File 'app/models/spree/shipment.rb', line 95

def add_shipping_method(shipping_method, selected = false)
  shipping_rates.create(shipping_method: shipping_method, selected: selected, cost: cost)
end

#address ⇒ Object 



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

def address
  Spree::Deprecation.warn("Calling Shipment#address is deprecated. Use Order#ship_address instead", caller)
  order.ship_address if order
end

#after_cancel ⇒ Object 



100
101
102
 
# File 'app/models/spree/shipment.rb', line 100

def after_cancel
  manifest.each { |item| manifest_restock(item) }
end

#after_resume ⇒ Object 



104
105
106
 
# File 'app/models/spree/shipment.rb', line 104

def after_resume
  manifest.each { |item| manifest_unstock(item) }
end

#backordered? ⇒ Boolean

Returns:

  • (Boolean) 


108
109
110
 
# File 'app/models/spree/shipment.rb', line 108

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

#can_transition_from_canceled_to_ready? ⇒ Boolean

Returns:

  • (Boolean) 


87
88
89
 
# File 'app/models/spree/shipment.rb', line 87

def can_transition_from_canceled_to_ready?
  can_transition_from_pending_to_ready?
end

#can_transition_from_pending_to_ready? ⇒ Boolean

Returns:

  • (Boolean) 


81
82
83
84
85
 
# File 'app/models/spree/shipment.rb', line 81

def can_transition_from_pending_to_ready?
  order.can_ship? &&
    inventory_units.all? { |iu| iu.allow_ship? || iu.canceled? } &&
    (order.paid? || !Spree::Config[:require_payment_to_ship])
end

#can_transition_from_pending_to_shipped? ⇒ Boolean

Returns:

  • (Boolean) 


77
78
79
 
# File 'app/models/spree/shipment.rb', line 77

def can_transition_from_pending_to_shipped?
  !requires_shipment?
end

#currency ⇒ Object 



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

def currency
  order ? order.currency : Spree::Config[:currency]
end

#determine_state(order) ⇒ Object

Determines the appropriate state according to the following logic:

canceled if order is canceled pending unless order is complete and order.payment_state is paid shipped if already shipped (ie. does not change the state) ready all other cases



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

def determine_state(order)
  return 'canceled' if order.canceled?
  return 'shipped' if shipped?
  return 'pending' unless order.can_ship?
  if can_transition_from_pending_to_ready?
    'ready'
  else
    'pending'
  end
end

#discounted_cost ⇒ Object Also known as: discounted_amount 



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

def discounted_cost
  cost + promo_total
end

#editable_by?(_user) ⇒ Boolean

Returns:

  • (Boolean) 


121
122
123
 
# File 'app/models/spree/shipment.rb', line 121

def editable_by?(_user)
  !shipped?
end

#final_price ⇒ Object 



125
126
127
 
# File 'app/models/spree/shipment.rb', line 125

def final_price
  cost + adjustment_total
end

#final_price_with_items ⇒ Object 



129
130
131
 
# File 'app/models/spree/shipment.rb', line 129

def final_price_with_items
  item_cost + final_price
end

#finalize! ⇒ Object

Decrement the stock counts for all pending inventory units in this shipment and mark. Any previous non-pending inventory units are skipped as their stock had already been allocated.



137
138
139
140
141
142
143
144
 
# File 'app/models/spree/shipment.rb', line 137

def finalize!
  transaction do
    pending_units = inventory_units.select(&:pending?)
    pending_manifest = Spree::ShippingManifest.new(inventory_units: pending_units)
    pending_manifest.items.each { |item| manifest_unstock(item) }
    Spree::InventoryUnit.finalize_units!(pending_units)
  end
end

#include?(variant) ⇒ Boolean

Returns:

  • (Boolean) 


146
147
148
 
# File 'app/models/spree/shipment.rb', line 146

def include?(variant)
  inventory_units_for(variant).present?
end

#inventory_units_for(variant) ⇒ Object 



150
151
152
 
# File 'app/models/spree/shipment.rb', line 150

def inventory_units_for(variant)
  inventory_units.where(variant_id: variant.id)
end

#inventory_units_for_item(line_item, variant = nil) ⇒ Object 



154
155
156
 
# File 'app/models/spree/shipment.rb', line 154

def inventory_units_for_item(line_item, variant = nil)
  inventory_units.where(line_item_id: line_item.id, variant_id: line_item.variant.id || variant.id)
end

#item_cost ⇒ Object 



158
159
160
 
# File 'app/models/spree/shipment.rb', line 158

def item_cost
  line_items.map(&:final_amount).sum
end

#line_items ⇒ Object 



162
163
164
 
# File 'app/models/spree/shipment.rb', line 162

def line_items
  inventory_units.includes(:line_item).map(&:line_item).uniq
end

#manifest ⇒ Object 



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

def manifest
  @manifest ||= Spree::ShippingManifest.new(inventory_units: inventory_units).items
end

#pre_tax_amount ⇒ Object 



166
167
168
 
# File 'app/models/spree/shipment.rb', line 166

def pre_tax_amount
  discounted_amount - included_tax_total
end

#ready_or_pending? ⇒ Boolean

Returns:

  • (Boolean) 


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

def ready_or_pending?
  ready? || pending?
end

#refresh_rates ⇒ Object 



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'app/models/spree/shipment.rb', line 174

def refresh_rates
  return shipping_rates if shipped?
  return [] unless can_get_rates?

  # StockEstimator.new assigment below will replace the current shipping_method
  original_shipping_method_id = shipping_method.try!(:id)

  new_rates = Spree::Config.stock.estimator_class.new.shipping_rates(to_package)

  # If one of the new rates matches the previously selected shipping
  # method, select that instead of the default provided by the estimator.
  # Otherwise, keep the default.
  selected_rate = new_rates.detect{ |rate| rate.shipping_method_id == original_shipping_method_id }
  if selected_rate
    new_rates.each do |rate|
      rate.selected = (rate == selected_rate)
    end
  end

  self.shipping_rates = new_rates
  save!

  shipping_rates
end

#requires_shipment? ⇒ Boolean

Returns:

  • (Boolean) 


358
359
360
 
# File 'app/models/spree/shipment.rb', line 358

def requires_shipment?
  !stock_location || stock_location.fulfillable?
end

#selected_shipping_rate ⇒ Object 



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

def selected_shipping_rate
  shipping_rates.detect(&:selected?)
end

#selected_shipping_rate_id ⇒ Object 



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

def selected_shipping_rate_id
  selected_shipping_rate.try(:id)
end

#selected_shipping_rate_id=(id) ⇒ Object 



211
212
213
214
215
216
217
218
219
220
 
# File 'app/models/spree/shipment.rb', line 211

def selected_shipping_rate_id=(id)
  selected_shipping_rate.update(selected: false) if selected_shipping_rate
  new_rate = shipping_rates.detect { |rate| rate.id == id.to_i }
  fail(
    ArgumentError,
    "Could not find shipping rate id #{id} for shipment #{number}"
  ) unless new_rate
  new_rate.update(selected: true)
  save!
end

#set_up_inventory(state, variant, order, line_item) ⇒ Object 



239
240
241
242
243
244
245
246
 
# File 'app/models/spree/shipment.rb', line 239

def set_up_inventory(state, variant, order, line_item)
  inventory_units.create(
    state: state,
    variant_id: variant.id,
    order_id: order.id,
    line_item_id: line_item.id
  )
end

#shipped=(value) ⇒ Object 



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

def shipped=(value)
  return unless value == '1' && shipped_at.nil?
  self.shipped_at = Time.current
end

#shipping_method ⇒ Object 



253
254
255
 
# File 'app/models/spree/shipment.rb', line 253

def shipping_method
  selected_shipping_rate.try(:shipping_method)
end

#tax_total ⇒ Object

Only one of either included_tax_total or additional_tax_total is set This method returns the total of the two. Saves having to check if tax is included or additional.



260
261
262
 
# File 'app/models/spree/shipment.rb', line 260

def tax_total
  included_tax_total + additional_tax_total
end

#to_package ⇒ Object 



264
265
266
267
268
269
270
271
 
# File 'app/models/spree/shipment.rb', line 264

def to_package
  package = Stock::Package.new(stock_location)
  package.shipment = self
  inventory_units.includes(:variant).joins(:variant).group_by(&:state).each do |state, state_inventory_units|
    package.add_multiple state_inventory_units, state.to_sym
  end
  package
end

#to_param ⇒ Object 



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

def to_param
  number
end

#tracking_url ⇒ Object 



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

def tracking_url
  return nil unless tracking && shipping_method

  @tracking_url ||= shipping_method.build_tracking_url(tracking)
end

#transfer_to_location(variant, quantity, stock_location) ⇒ Object 



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'app/models/spree/shipment.rb', line 324

def transfer_to_location(variant, quantity, stock_location)
  if quantity <= 0
    raise ArgumentError
  end

  transaction do
    new_shipment = order.shipments.create!(stock_location: stock_location)

    order.contents.remove(variant, quantity, { shipment: self })
    order.contents.add(variant, quantity, { shipment: new_shipment })

    refresh_rates
    new_shipment.refresh_rates
    save!
    new_shipment.save!
  end
end

#transfer_to_shipment(variant, quantity, shipment_to_transfer_to) ⇒ Object 



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'app/models/spree/shipment.rb', line 342

def transfer_to_shipment(variant, quantity, shipment_to_transfer_to)
  if quantity <= 0 || self == shipment_to_transfer_to
    raise ArgumentError
  end

  transaction do
    order.contents.remove(variant, quantity, { shipment: self })
    order.contents.add(variant, quantity, { shipment: shipment_to_transfer_to })

    refresh_rates
    save!
    shipment_to_transfer_to.refresh_rates
    shipment_to_transfer_to.save!
  end
end

#update!(order) ⇒ Object

Updates various aspects of the Shipment while bypassing any callbacks. Note that this method takes an explicit reference to the Order object. This is necessary because the association actually has a stale (and unsaved) copy of the Order and so it will not yield the correct results.



312
313
314
315
316
317
318
319
320
321
322
 
# File 'app/models/spree/shipment.rb', line 312

def update!(order)
  old_state = state
  new_state = determine_state(order)
  if new_state != old_state
    update_columns(
      state: new_state,
      updated_at: Time.current
    )
    after_ship if new_state == 'shipped'
  end
end

#update_amounts ⇒ Object 



283
284
285
286
287
288
289
290
291
292
293
 
# File 'app/models/spree/shipment.rb', line 283

def update_amounts
  if selected_shipping_rate
    self.cost = selected_shipping_rate.cost
    if changed?
      update_columns(
        cost: cost,
        updated_at: Time.current
      )
    end
  end
end

#update_attributes_and_order(params = {}) ⇒ Object

Update Shipment and make sure Order states follow the shipment changes



296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'app/models/spree/shipment.rb', line 296

def update_attributes_and_order(params = {})
  if update_attributes params
    if params.key? :selected_shipping_rate_id
      # Changing the selected Shipping Rate won't update the cost (for now)
      # so we persist the Shipment#cost before running `order.update!`
      update_amounts
      order.update!
    end

    true
  end
end