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

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

Instance Attribute Details

#special_instructionsObject

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



23
24
25
# File 'app/models/spree/shipment.rb', line 23

def special_instructions
  @special_instructions
end

#suppress_mailerObject

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



23
24
25
# File 'app/models/spree/shipment.rb', line 23

def suppress_mailer
  @suppress_mailer
end

Instance Method Details

#add_shipping_method(shipping_method, selected = false) ⇒ Object



102
103
104
# File 'app/models/spree/shipment.rb', line 102

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

#addressObject



392
393
394
395
# File 'app/models/spree/shipment.rb', line 392

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

#after_cancelObject



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

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

#after_resumeObject



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

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

#backordered?Boolean

Returns:

  • (Boolean)


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

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

#can_transition_from_canceled_to_ready?Boolean

Returns:

  • (Boolean)


89
90
91
# File 'app/models/spree/shipment.rb', line 89

def can_transition_from_canceled_to_ready?
  can_transition_from_pending_to_ready?
end

#can_transition_from_pending_to_ready?Boolean

Returns:

  • (Boolean)


83
84
85
86
87
# File 'app/models/spree/shipment.rb', line 83

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)


79
80
81
# File 'app/models/spree/shipment.rb', line 79

def can_transition_from_pending_to_shipped?
  !requires_shipment?
end

#currencyObject



119
120
121
# File 'app/models/spree/shipment.rb', line 119

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



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

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_costObject Also known as: discounted_amount



123
124
125
# File 'app/models/spree/shipment.rb', line 123

def discounted_cost
  cost + promo_total
end

#editable_by?(_user) ⇒ Boolean

Returns:

  • (Boolean)


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

def editable_by?(_user)
  !shipped?
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.



166
167
168
169
170
171
172
173
# File 'app/models/spree/shipment.rb', line 166

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)


175
176
177
# File 'app/models/spree/shipment.rb', line 175

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

#inventory_units_for(variant) ⇒ Object



179
180
181
# File 'app/models/spree/shipment.rb', line 179

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

#inventory_units_for_item(line_item, variant = nil) ⇒ Object



183
184
185
# File 'app/models/spree/shipment.rb', line 183

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_costObject



187
188
189
# File 'app/models/spree/shipment.rb', line 187

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

#line_itemsObject



191
192
193
# File 'app/models/spree/shipment.rb', line 191

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

#manifestObject



236
237
238
# File 'app/models/spree/shipment.rb', line 236

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

#ready_or_pending?Boolean

Returns:

  • (Boolean)


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

def ready_or_pending?
  ready? || pending?
end

#refresh_ratesObject



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
# File 'app/models/spree/shipment.rb', line 199

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)


388
389
390
# File 'app/models/spree/shipment.rb', line 388

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

#select_shipping_method(shipping_method) ⇒ Object



224
225
226
227
228
229
230
# File 'app/models/spree/shipment.rb', line 224

def select_shipping_method(shipping_method)
  estimator = Spree::Config.stock.estimator_class.new
  rates = estimator.shipping_rates(to_package, false)
  rate = rates.detect { |r| r.shipping_method_id == shipping_method.id }
  rate.selected = true
  self.shipping_rates = [rate]
end

#selected_shipping_rateObject



232
233
234
# File 'app/models/spree/shipment.rb', line 232

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

#selected_shipping_rate_idObject



240
241
242
# File 'app/models/spree/shipment.rb', line 240

def selected_shipping_rate_id
  selected_shipping_rate.try(:id)
end

#selected_shipping_rate_id=(id) ⇒ Object



244
245
246
247
248
249
250
251
252
253
254
255
256
# File 'app/models/spree/shipment.rb', line 244

def selected_shipping_rate_id=(id)
  return if selected_shipping_rate_id == id
  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

  transaction do
    selected_shipping_rate.update!(selected: false) if selected_shipping_rate
    new_rate.update!(selected: true)
  end
end

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



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

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

#shipped=(value) ⇒ Object



283
284
285
286
# File 'app/models/spree/shipment.rb', line 283

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

#shipping_methodObject



288
289
290
# File 'app/models/spree/shipment.rb', line 288

def shipping_method
  selected_shipping_rate.try(:shipping_method)
end

#tax_totalObject

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.



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

def tax_total
  included_tax_total + additional_tax_total
end

#to_packageObject



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

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_paramObject



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

def to_param
  number
end

#totalBigDecimal Also known as: final_price

Returns the amount of this shipment, taking into consideration all its adjustments.

Returns:

  • (BigDecimal)

    the amount of this shipment, taking into consideration all its adjustments.



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

def total
  cost + adjustment_total
end

#total_before_taxBigDecimal

Returns the amount of this item, taking into consideration all non-tax adjustments.

Returns:

  • (BigDecimal)

    the amount of this item, taking into consideration all non-tax adjustments.



140
141
142
# File 'app/models/spree/shipment.rb', line 140

def total_before_tax
  amount + adjustments.select { |a| !a.tax? && a.eligible? }.sum(&:amount)
end

#total_excluding_vatBigDecimal Also known as: pre_tax_amount

Note:

just like `cost`, this does not include any additional tax

Returns the amount of this shipment before VAT tax

Returns:

  • (BigDecimal)

    the amount of this shipment before VAT tax



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

def total_excluding_vat
  total_before_tax - included_tax_total
end

#total_with_itemsObject Also known as: final_price_with_items



152
153
154
# File 'app/models/spree/shipment.rb', line 152

def total_with_items
  total + item_cost
end

#tracking_urlObject



312
313
314
315
316
# File 'app/models/spree/shipment.rb', line 312

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



372
373
374
375
376
# File 'app/models/spree/shipment.rb', line 372

def transfer_to_location(variant, quantity, stock_location)
  Spree::Deprecation.warn("Please use the Spree::FulfilmentChanger class instead of Spree::Shipment#transfer_to_location", caller)
  new_shipment = order.shipments.create!(stock_location: stock_location)
  transfer_to_shipment(variant, quantity, new_shipment)
end

#transfer_to_shipment(variant, quantity, shipment_to_transfer_to) ⇒ Object



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

def transfer_to_shipment(variant, quantity, shipment_to_transfer_to)
  Spree::Deprecation.warn("Please use the Spree::FulfilmentChanger class instead of Spree::Shipment#transfer_to_location", caller)
  Spree::FulfilmentChanger.new(
    current_shipment: self,
    desired_shipment: shipment_to_transfer_to,
    variant: variant,
    quantity: quantity
  ).run!
end

#update!(order_or_attrs) ⇒ Object



360
361
362
363
364
365
366
367
368
369
370
# File 'app/models/spree/shipment.rb', line 360

def update!(order_or_attrs)
  if order_or_attrs.is_a?(Spree::Order)
    Spree::Deprecation.warn "Calling Shipment#update! with an order to update the shipments state is deprecated. Please use Shipment#update_state instead."
    if order_or_attrs.object_id != order.object_id
      Spree::Deprecation.warn "Additionally, update! is being passed an instance of order which isn't the same object as the shipment's order association"
    end
    update_state
  else
    super
  end
end

#update_amountsObject



318
319
320
321
322
323
324
325
326
327
328
# File 'app/models/spree/shipment.rb', line 318

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



331
332
333
334
335
336
337
338
339
340
341
342
# File 'app/models/spree/shipment.rb', line 331

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.recalculate`
      update_amounts
      order.recalculate
    end

    true
  end
end

#update_stateObject

Updates the state of the Shipment bypassing any callbacks.

If this moves the shipmnent to the 'shipped' state, after_ship will be called.



348
349
350
351
352
353
354
355
356
357
358
# File 'app/models/spree/shipment.rb', line 348

def update_state
  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