Class: Spree::Shipment
Defined Under Namespace
Classes: ManifestItem
Constant Summary
NumberGenerator::NUMBER_LENGTH, NumberGenerator::NUMBER_LETTERS, NumberGenerator::NUMBER_PREFIX
Instance Attribute Summary collapse
Instance Method Summary
collapse
money_methods
by_number
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
#special_instructions ⇒ Object
Returns the value of attribute special_instructions.
30
31
32
|
# File 'app/models/spree/shipment.rb', line 30
def special_instructions
@special_instructions
end
|
Instance Method Details
#add_shipping_method(shipping_method, selected = false) ⇒ Object
90
91
92
|
# File 'app/models/spree/shipment.rb', line 90
def add_shipping_method(shipping_method, selected = false)
shipping_rates.create(shipping_method: shipping_method, selected: selected, cost: cost)
end
|
#after_cancel ⇒ Object
94
95
96
|
# File 'app/models/spree/shipment.rb', line 94
def after_cancel
manifest.each { |item| manifest_restock(item) }
end
|
#after_resume ⇒ Object
98
99
100
|
# File 'app/models/spree/shipment.rb', line 98
def after_resume
manifest.each { |item| manifest_unstock(item) }
end
|
#backordered? ⇒ Boolean
102
103
104
|
# File 'app/models/spree/shipment.rb', line 102
def backordered?
inventory_units.any? { |inventory_unit| inventory_unit.backordered? }
end
|
#currency ⇒ Object
106
107
108
|
# File 'app/models/spree/shipment.rb', line 106
def currency
order ? order.currency : Spree::Config[:currency]
end
|
#determine_state(order) ⇒ Object
Determines the appropriate state
according to the following logic:
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
115
116
117
118
119
120
121
|
# File 'app/models/spree/shipment.rb', line 115
def determine_state(order)
return 'canceled' if order.canceled?
return 'pending' unless order.can_ship?
return 'pending' if inventory_units.any? &:backordered?
return 'shipped' if state == 'shipped'
order.paid? || Spree::Config[:auto_capture_on_dispatch] ? 'ready' : 'pending'
end
|
#discounted_cost ⇒ Object
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
128
129
130
|
# File 'app/models/spree/shipment.rb', line 128
def editable_by?(user)
!shipped?
end
|
#final_price ⇒ Object
132
133
134
|
# File 'app/models/spree/shipment.rb', line 132
def final_price
cost + adjustment_total
end
|
#final_price_with_items ⇒ Object
136
137
138
|
# File 'app/models/spree/shipment.rb', line 136
def final_price_with_items
item_cost + final_price
end
|
#finalize! ⇒ Object
140
141
142
143
|
# File 'app/models/spree/shipment.rb', line 140
def finalize!
InventoryUnit.finalize_units!(inventory_units)
manifest.each { |item| manifest_unstock(item) }
end
|
#generate_number(options = {}) ⇒ Object
10
11
12
13
14
|
# File 'app/models/spree/shipment.rb', line 10
def generate_number(options = {})
options[:prefix] ||= 'H'
options[:length] ||= 11
super(options)
end
|
#include?(variant) ⇒ Boolean
145
146
147
|
# File 'app/models/spree/shipment.rb', line 145
def include?(variant)
inventory_units_for(variant).present?
end
|
#inventory_units_for(variant) ⇒ Object
149
150
151
|
# File 'app/models/spree/shipment.rb', line 149
def inventory_units_for(variant)
inventory_units.where(variant_id: variant.id)
end
|
#inventory_units_for_item(line_item, variant = nil) ⇒ Object
153
154
155
|
# File 'app/models/spree/shipment.rb', line 153
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
157
158
159
|
# File 'app/models/spree/shipment.rb', line 157
def item_cost
line_items.map(&:final_amount).sum
end
|
#line_items ⇒ Object
161
162
163
|
# File 'app/models/spree/shipment.rb', line 161
def line_items
inventory_units.includes(:line_item).map(&:line_item).uniq
end
|
#manifest ⇒ Object
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
# File 'app/models/spree/shipment.rb', line 167
def manifest
inventory_units.group_by(&:variant_id).map do |variant_id, units|
units.group_by(&:line_item_id).map do |line_item_id, units|
states = {}
units.group_by(&:state).each { |state, iu| states[state] = iu.count }
line_item = units.first.line_item
variant = units.first.variant
ManifestItem.new(line_item, variant, units.length, states)
end
end.flatten
end
|
#process_order_payments ⇒ Object
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
# File 'app/models/spree/shipment.rb', line 183
def process_order_payments
pending_payments = order.pending_payments
.sort_by(&:uncaptured_amount).reverse
shipment_to_pay = final_price_with_items
payments_amount = 0
payments_pool = pending_payments.each_with_object([]) do |payment, pool|
break if payments_amount >= shipment_to_pay
payments_amount += payment.uncaptured_amount
pool << payment
end
payments_pool.each do |payment|
capturable_amount = if payment.amount >= shipment_to_pay
shipment_to_pay
else
payment.amount
end
cents = (capturable_amount * 100).to_i
payment.capture!(cents)
shipment_to_pay -= capturable_amount
end
end
|
#ready_or_pending? ⇒ Boolean
209
210
211
|
# File 'app/models/spree/shipment.rb', line 209
def ready_or_pending?
self.ready? || self.pending?
end
|
#refresh_rates(shipping_method_filter = ShippingMethod::DISPLAY_ON_FRONT_END) ⇒ Object
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
|
# File 'app/models/spree/shipment.rb', line 213
def refresh_rates(shipping_method_filter = ShippingMethod::DISPLAY_ON_FRONT_END)
return shipping_rates if shipped?
return [] unless can_get_rates?
original_shipping_method_id = shipping_method.try(:id)
self.shipping_rates = Stock::Estimator.new(order).
shipping_rates(to_package, shipping_method_filter)
if shipping_method
selected_rate = shipping_rates.detect { |rate|
rate.shipping_method_id == original_shipping_method_id
}
self.selected_shipping_rate_id = selected_rate.id if selected_rate
end
shipping_rates
end
|
#selected_shipping_rate ⇒ Object
233
234
235
|
# File 'app/models/spree/shipment.rb', line 233
def selected_shipping_rate
shipping_rates.where(selected: true).first
end
|
#selected_shipping_rate_id ⇒ Object
237
238
239
|
# File 'app/models/spree/shipment.rb', line 237
def selected_shipping_rate_id
selected_shipping_rate.try(:id)
end
|
#selected_shipping_rate_id=(id) ⇒ Object
241
242
243
244
245
|
# File 'app/models/spree/shipment.rb', line 241
def selected_shipping_rate_id=(id)
shipping_rates.update_all(selected: false)
shipping_rates.update(id, selected: true)
self.save!
end
|
#set_up_inventory(state, variant, order, line_item) ⇒ Object
247
248
249
250
251
252
253
254
|
# File 'app/models/spree/shipment.rb', line 247
def set_up_inventory(state, variant, order, line_item)
self.inventory_units.create(
state: state,
variant_id: variant.id,
order_id: order.id,
line_item_id: line_item.id
)
end
|
#shipped=(value) ⇒ Object
256
257
258
259
|
# File 'app/models/spree/shipment.rb', line 256
def shipped=(value)
return unless value == '1' && shipped_at.nil?
self.shipped_at = Time.now
end
|
#shipping_method ⇒ Object
261
262
263
|
# File 'app/models/spree/shipment.rb', line 261
def shipping_method
selected_shipping_rate.try(:shipping_method) || shipping_rates.first.try(:shipping_method)
end
|
#tax_category ⇒ Object
265
266
267
|
# File 'app/models/spree/shipment.rb', line 265
def tax_category
selected_shipping_rate.try(:tax_rate).try(:tax_category)
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.
272
273
274
|
# File 'app/models/spree/shipment.rb', line 272
def tax_total
included_tax_total + additional_tax_total
end
|
#to_package ⇒ Object
276
277
278
279
280
281
282
|
# File 'app/models/spree/shipment.rb', line 276
def to_package
package = Stock::Package.new(stock_location)
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
|
#tracking_url ⇒ Object
284
285
286
|
# File 'app/models/spree/shipment.rb', line 284
def tracking_url
@tracking_url ||= shipping_method.build_tracking_url(tracking)
end
|
#transfer_to_location(variant, quantity, stock_location) ⇒ Object
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
|
# File 'app/models/spree/shipment.rb', line 341
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
save!
new_shipment.save!
end
end
|
#transfer_to_shipment(variant, quantity, shipment_to_transfer_to) ⇒ Object
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
|
# File 'app/models/spree/shipment.rb', line 358
def transfer_to_shipment(variant, quantity, shipment_to_transfer_to)
quantity_already_shipment_to_transfer_to = shipment_to_transfer_to.manifest.find{|mi| mi.line_item.variant == variant}.try(:quantity) || 0
final_quantity = quantity + quantity_already_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.
331
332
333
334
335
336
337
338
339
|
# File 'app/models/spree/shipment.rb', line 331
def update!(order)
old_state = state
new_state = determine_state(order)
update_columns(
state: new_state,
updated_at: Time.now,
)
after_ship if new_state == 'shipped' and old_state != 'shipped'
end
|
#update_amounts ⇒ Object
288
289
290
291
292
293
294
295
296
|
# File 'app/models/spree/shipment.rb', line 288
def update_amounts
if selected_shipping_rate
self.update_columns(
cost: selected_shipping_rate.cost,
adjustment_total: adjustments.additional.map(&:update!).compact.sum,
updated_at: Time.now,
)
end
end
|
#update_attributes_and_order(params = {}) ⇒ Object
Update Shipment and make sure Order states follow the shipment changes
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
|
# File 'app/models/spree/shipment.rb', line 299
def update_attributes_and_order(params = {})
if self.update_attributes params
if params.has_key? :selected_shipping_rate_id
self.update_amounts
order.updater.update_shipment_total
order.updater.update_payment_state
self.update_columns(
state: determine_state(order),
updated_at: Time.now
)
order.updater.update_shipment_state
order.updater.persist_totals
end
true
end
end
|