Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Rename LineItem#target_shipment to target_fulfillment

Damian Legawiec9335da69a830
diff --git a/spree/core/app/models/spree/line_item.rb b/spree/core/app/models/spree/line_item.rb
index 6c8d4d9dea..96965a5a7b 100644
--- a/spree/core/app/models/spree/line_item.rb
+++ b/spree/core/app/models/spree/line_item.rb
@@ -72,7 +72,21 @@ module Spree
scope :with_digital_assets, -> { joins(:variant).merge(Spree::Variant.with_digital_assets) }
- attr_accessor :target_shipment
+ # Pins inventory-unit placement to a specific fulfillment when set
+ # (admin add-to-this-fulfillment flows).
+ attr_accessor :target_fulfillment
+
+ # @deprecated Use {#target_fulfillment}; removed in 6.1.
+ def target_shipment
+ Spree::Deprecation.warn('Spree::LineItem#target_shipment is deprecated and will be removed in Spree 6.1. Use #target_fulfillment instead.')
+ target_fulfillment
+ end
+
+ # @deprecated Use {#target_fulfillment=}; removed in 6.1.
+ def target_shipment=(value)
+ Spree::Deprecation.warn('Spree::LineItem#target_shipment= is deprecated and will be removed in Spree 6.1. Use #target_fulfillment= instead.')
+ self.target_fulfillment = value
+ end
self.whitelisted_ransackable_associations = %w[variant order tax_category]
self.whitelisted_ransackable_attributes = %w[variant_id order_id tax_category_id quantity
@@ -322,17 +336,17 @@ module Spree
end
def update_inventory
- if (saved_changes? || target_shipment.present?) && order&.has_checkout_step?('delivery')
+ if (saved_changes? || target_fulfillment.present?) && order&.has_checkout_step?('delivery')
verify_order_inventory
end
end
def verify_order_inventory
- Spree::OrderInventory.new(order, self).verify(target_shipment, is_updated: true)
+ Spree::OrderInventory.new(order, self).verify(target_fulfillment, is_updated: true)
end
def verify_order_inventory_before_destroy
- Spree::OrderInventory.new(order, self).verify(target_shipment, removing: true)
+ Spree::OrderInventory.new(order, self).verify(target_fulfillment, removing: true)
end
def update_adjustments
diff --git a/spree/core/app/models/spree/order_inventory.rb b/spree/core/app/models/spree/order_inventory.rb
index bdfd2469d1..bfc086418d 100644
--- a/spree/core/app/models/spree/order_inventory.rb
+++ b/spree/core/app/models/spree/order_inventory.rb
@@ -42,7 +42,7 @@ module Spree
elsif units_count < line_item.quantity
quantity = line_item.quantity - units_count
- shipment ||= determine_target_shipment
+ shipment ||= determine_target_fulfillment
add_to_shipment(shipment, quantity)
elsif (units_count > line_item.quantity) || (units_count == line_item.quantity && line_item_changed)
remove(units_count, shipment)
@@ -51,11 +51,11 @@ module Spree
private
- def remove(units_count, target_shipment = nil)
+ def remove(units_count, target_fulfillment = nil)
quantity = set_quantity_to_remove(units_count)
- if target_shipment.present?
- remove_from_shipment(target_shipment, quantity)
+ if target_fulfillment.present?
+ remove_from_shipment(target_fulfillment, quantity)
else
order.fulfillments.each do |shipment|
break if quantity.zero?
@@ -65,9 +65,9 @@ module Spree
end
end
- def remove_all_units(quantity, target_shipment = nil)
- if target_shipment.present?
- remove_from_shipment(target_shipment, quantity)
+ def remove_all_units(quantity, target_fulfillment = nil)
+ if target_fulfillment.present?
+ remove_from_shipment(target_fulfillment, quantity)
else
order.fulfillments.each do |shipment|
break if quantity.zero?
@@ -89,12 +89,12 @@ module Spree
#
# first unshipped that already includes this variant
# first unshipped that's leaving from a stock_location that stocks this variant
- def determine_target_shipment
- target_shipment = order.fulfillments.detect do |shipment|
+ def determine_target_fulfillment
+ target_fulfillment = order.fulfillments.detect do |shipment|
shipment.ready_or_pending? && shipment.include?(variant)
end
- target_shipment || order.fulfillments.detect do |shipment|
+ target_fulfillment || order.fulfillments.detect do |shipment|
shipment.ready_or_pending? && variant.stock_location_ids.include?(shipment.stock_location_id)
end
end
diff --git a/spree/core/app/services/spree/carts/add_item.rb b/spree/core/app/services/spree/carts/add_item.rb
index 9f0e6e9e11..32e7dcd268 100644
--- a/spree/core/app/services/spree/carts/add_item.rb
+++ b/spree/core/app/services/spree/carts/add_item.rb
@@ -34,7 +34,7 @@ module Spree
line_item.quantity += quantity.to_i
end
- line_item.target_shipment = options[:shipment] if options.key? :shipment
+ line_item.target_fulfillment = options[:shipment] if options.key? :shipment
# `metadata` is the primary API param (maps to private_metadata).
# Legacy `public_metadata`/`private_metadata` params kept for backward compatibility.
diff --git a/spree/core/app/services/spree/carts/remove_item.rb b/spree/core/app/services/spree/carts/remove_item.rb
index 21060a43c2..b2eea5bd6e 100644
--- a/spree/core/app/services/spree/carts/remove_item.rb
+++ b/spree/core/app/services/spree/carts/remove_item.rb
@@ -24,7 +24,7 @@ module Spree
raise ActiveRecord::RecordNotFound if line_item.nil?
line_item.quantity -= quantity
- line_item.target_shipment = options[:shipment]
+ line_item.target_fulfillment = options[:shipment]
if line_item.quantity.zero?
order.line_items.destroy(line_item)
diff --git a/spree/core/spec/models/spree/line_item_spec.rb b/spree/core/spec/models/spree/line_item_spec.rb
index 83a3f59885..fe1cb195a4 100644
--- a/spree/core/spec/models/spree/line_item_spec.rb
+++ b/spree/core/spec/models/spree/line_item_spec.rb
@@ -200,9 +200,9 @@ describe Spree::LineItem, type: :model do
end
end
- context 'target_shipment is provided' do
+ context 'target_fulfillment is provided' do
it 'verifies inventory' do
- line_item.target_shipment = Spree::Shipment.new
+ line_item.target_fulfillment = Spree::Shipment.new
expect_any_instance_of(Spree::OrderInventory).to receive(:verify)
line_item.save
end
@@ -384,7 +384,7 @@ describe Spree::LineItem, type: :model do
it 'allows to decrease item quantity' do
line_item = order.line_items.first
line_item.quantity -= 1
- line_item.target_shipment = order.shipments.first
+ line_item.target_fulfillment = order.shipments.first
line_item.valid?
expect(line_item.errors).to be_empty
@@ -393,7 +393,7 @@ describe Spree::LineItem, type: :model do
it 'doesnt allow to increase item quantity' do
line_item = order.line_items.first
line_item.quantity += 2
- line_item.target_shipment = order.shipments.first
+ line_item.target_fulfillment = order.shipments.first
line_item.valid?
expect(line_item.errors).not_to be_empty
@@ -413,7 +413,7 @@ describe Spree::LineItem, type: :model do
it 'allows to increase quantity up to stock availability' do
line_item = order.line_items.first
line_item.quantity += 2
- line_item.target_shipment = order.shipments.first
+ line_item.target_fulfillment = order.shipments.first
line_item.valid?
expect(line_item.errors).to be_empty
@@ -422,7 +422,7 @@ describe Spree::LineItem, type: :model do
it 'doesnt allow to increase quantity over stock availability' do
line_item = order.line_items.first
line_item.quantity += 3
- line_item.target_shipment = order.shipments.first
+ line_item.target_fulfillment = order.shipments.first
line_item.valid?
expect(line_item.errors).not_to be_empty
diff --git a/spree/core/spec/models/spree/order_inventory_spec.rb b/spree/core/spec/models/spree/order_inventory_spec.rb
index 032ef8fb2d..786425c447 100644
--- a/spree/core/spec/models/spree/order_inventory_spec.rb
+++ b/spree/core/spec/models/spree/order_inventory_spec.rb
@@ -89,7 +89,7 @@ describe Spree::OrderInventory, type: :model do
end
end
- context '#determine_target_shipment' do
+ context '#determine_target_fulfillment' do
let(:stock_location) { create :stock_location }
let(:variant) { line_item.variant }
@@ -104,7 +104,7 @@ describe Spree::OrderInventory, type: :model do
end
it 'selects first non-shipped shipment that already contains given variant' do
- shipment = subject.send(:determine_target_shipment)
+ shipment = subject.send(:determine_target_fulfillment)
expect(shipment.fulfilled?).to be false
expect(shipment.inventory_units_for(variant)).not_to be_empty
@@ -118,7 +118,7 @@ describe Spree::OrderInventory, type: :model do
end
it 'selects first non-shipped shipment that leaves from same stock_location' do
- shipment = subject.send(:determine_target_shipment)
+ shipment = subject.send(:determine_target_fulfillment)
shipment.reload
expect(shipment.fulfilled?).to be false
expect(shipment.inventory_units_for(variant)).to be_empty