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.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
Rename delivery predicates to say what they decide
Damian Legawiec3ce7f5a69362
diff --git a/spree/api/spec/controllers/spree/api/v3/store/carts_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/store/carts_controller_spec.rbindex 3b365c6273..3ca7268f77 100644--- a/spree/api/spec/controllers/spree/api/v3/store/carts_controller_spec.rb+++ b/spree/api/spec/controllers/spree/api/v3/store/carts_controller_spec.rb@@ -548,7 +548,7 @@ RSpec.describe Spree::Api::V3::Store::CartsController, type: :controller doexpect(json_response['fulfillments']).to be_emptyexpect(json_response['warnings'].map { |warning| warning['code'] }).to include('delivery_unavailable')expect(json_response['requirements']).to include(- a_hash_including('step' => 'delivery', 'field' => 'shipping_method')+ a_hash_including('step' => 'delivery', 'field' => 'delivery_method'))end@@ -652,7 +652,7 @@ RSpec.describe Spree::Api::V3::Store::CartsController, type: :controller doexpect(json_response['fulfillments']).to be_emptyexpect(json_response['warnings'].map { |warning| warning['code'] }).to include('delivery_unavailable')expect(json_response['requirements']).to include(- a_hash_including('step' => 'delivery', 'field' => 'shipping_method')+ a_hash_including('step' => 'delivery', 'field' => 'delivery_method'))endenddiff --git a/spree/core/app/models/concerns/spree/purchase/addresses.rb b/spree/core/app/models/concerns/spree/purchase/addresses.rbindex 22cf38ca5a..9986110fc8 100644--- a/spree/core/app/models/concerns/spree/purchase/addresses.rb+++ b/spree/core/app/models/concerns/spree/purchase/addresses.rb@@ -40,6 +40,29 @@ module Spreebill_address == ship_addressend+ # Whether checkout must collect a customer shipping address. Selected+ # delivery methods are the source of truth — their fulfillment+ # providers decide (digital and pickup deliveries need none). Before+ # any selection, falls back to the record's merchant-pickup intent and+ # the items' possible fulfillment types, matched against the store's+ # configured address-requiring delivery methods.+ #+ # @return [Boolean]+ def shipping_address_required?+ selected_methods = fulfillments.filter_map(&:delivery_method)+ return selected_methods.any?(&:requires_address?) if selected_methods.any?++ return false if preferred_stock_location_id.present?++ address_requiring_types = store.delivery_methods.select(&:requires_address?).map(&:fulfillment_type).uniq+ return false if address_requiring_types.empty?++ line_items.includes(variant: :product).any? do |line_item|+ fulfillment_types = line_item.variant&.product&.fulfillment_types || ['shipping']+ (fulfillment_types & address_requiring_types).any?+ end+ end+# @deprecated The shipping address is canonical — use +use_shipping+ to# copy it onto the billing address. Removed in 6.1.def use_billing=(value)@@ -68,9 +91,10 @@ module Spreereturn unless userself.bill_address = user.bill_address if !bill_address_id && user.bill_address&.valid?- # Skip the ship address for orders without physical delivery to- # avoid triggering shipping-address validations- self.ship_address = user.ship_address if !ship_address_id && user.ship_address&.valid? && delivery_required?+ # Skip the ship address only for all-digital records to avoid+ # triggering shipping-address validations (an empty record still+ # gets one — items usually arrive after the address).+ self.ship_address = user.ship_address if !ship_address_id && user.ship_address&.valid? && !digital?end# Copies the ship address onto the bill address and promotes it to thediff --git a/spree/core/app/models/concerns/spree/purchase/digital_items.rb b/spree/core/app/models/concerns/spree/purchase/digital_items.rbindex be5d3026c0..75f5b6c83b 100644--- a/spree/core/app/models/concerns/spree/purchase/digital_items.rb+++ b/spree/core/app/models/concerns/spree/purchase/digital_items.rb@@ -41,15 +41,13 @@ module Spreedigital_line_items.map(&:digital_links).flattenend- def requires_ship_address?- !digital?- end-- # Whether any line item needs physical delivery (digital-only- # purchases skip the address/delivery steps).+ # Whether the customer must choose a delivery option in checkout —+ # shipping and both pickup kinds are chosen; digital fulfillments are+ # created by their provider without a selection. Delivery itself+ # happens for all of them.## @return [Boolean]- def delivery_required?+ def delivery_step_required?line_items.any? && !digital?endenddiff --git a/spree/core/app/models/spree/checkout/default_requirements.rb b/spree/core/app/models/spree/checkout/default_requirements.rbindex 729ad42686..962ea90c4b 100644--- a/spree/core/app/models/spree/checkout/default_requirements.rb+++ b/spree/core/app/models/spree/checkout/default_requirements.rb@@ -31,8 +31,8 @@ module Spree[].tap do |r|r << req('cart', 'line_items', Spree.t('checkout_requirements.line_items_required')) unless @cart.line_items.any?r << req('address', 'email', Spree.t('checkout_requirements.email_required')) unless @cart.email.present?- r << req('address', 'ship_address', Spree.t('checkout_requirements.ship_address_required')) if @cart.requires_ship_address? && @cart.ship_address.blank?- r << req('delivery', 'shipping_method', Spree.t('checkout_requirements.shipping_method_required')) if delivery_required? && !shipping_method_selected?+ r << req('address', 'ship_address', Spree.t('checkout_requirements.ship_address_required')) if @cart.shipping_address_required? && @cart.ship_address.blank?+ r << req('delivery', 'delivery_method', Spree.t('checkout_requirements.delivery_method_required')) if delivery_step_required? && !delivery_method_selected?r << req('payment', 'payment', Spree.t('checkout_requirements.payment_required')) if payment_required? && !payment_satisfied?endend@@ -56,11 +56,11 @@ module Spreeendend- def delivery_required?- @cart.delivery_required?+ def delivery_step_required?+ @cart.delivery_step_required?end- def shipping_method_selected?+ def delivery_method_selected?@cart.fulfillments.any? && @cart.fulfillments.all? { |fulfillment| fulfillment.delivery_method.present? }enddiff --git a/spree/core/app/models/spree/checkout/registry.rb b/spree/core/app/models/spree/checkout/registry.rbindex e4f7aaead0..da3ec1ea92 100644--- a/spree/core/app/models/spree/checkout/registry.rb+++ b/spree/core/app/models/spree/checkout/registry.rb@@ -81,7 +81,7 @@ module Spreedef base_steps@base_steps ||= {'address' => nil,- 'delivery' => ->(record) { record.delivery_required? },+ 'delivery' => ->(record) { record.delivery_step_required? },'payment' => ->(record) { record.payment_required? },'confirm' => ->(record) { record.confirmation_required? },'complete' => nildiff --git a/spree/core/app/models/spree/fulfillment.rb b/spree/core/app/models/spree/fulfillment.rbindex e6ed804b3d..343a685df4 100644--- a/spree/core/app/models/spree/fulfillment.rb+++ b/spree/core/app/models/spree/fulfillment.rb@@ -638,7 +638,7 @@ module Spree# publish_shipment_resumed_event are defined in Spree::Fulfillment::CustomEventsdef can_get_rates?- return true unless owner&.requires_ship_address?+ return true unless owner&.shipping_address_required?owner.ship_address&.valid?enddiff --git a/spree/core/app/models/spree/order.rb b/spree/core/app/models/spree/order.rbindex 0cdf125378..14564fb642 100644--- a/spree/core/app/models/spree/order.rb+++ b/spree/core/app/models/spree/order.rb@@ -426,14 +426,13 @@ module Spree# Either fully digital or not digital at all# @return [Boolean]def quick_checkout_available?- payment_required? && fulfillments.count <= 1 && (digital? || !some_digital? || !delivery_required?)+ payment_required? && fulfillments.count <= 1 && (digital? || !some_digital? || !delivery_step_required?)end# Check if quick checkout requires an address collection- # If the order is digital or not delivery required, then we don't need to collect an address# @return [Boolean]def quick_checkout_require_address?- !digital? && delivery_required?+ shipping_address_required?end# @deprecated Use {#recalculate_totals!} for money and {#update_statuses!}@@ -709,6 +708,18 @@ module Spreerebuild_fulfillments!end+ # @deprecated Use {#delivery_step_required?}; removed in 6.1.+ def delivery_required?+ Spree::Deprecation.warn('Spree::Order#delivery_required? is deprecated and will be removed in Spree 6.1. Use #delivery_step_required? (delivery-step applicability) or #shipping_address_required? (address collection) instead.')+ delivery_step_required?+ end++ # @deprecated Use {#shipping_address_required?}; removed in 6.1.+ def requires_ship_address?+ Spree::Deprecation.warn('Spree::Order#requires_ship_address? is deprecated and will be removed in Spree 6.1. Use #shipping_address_required? instead.')+ shipping_address_required?+ end+# Resolves the routing strategy from the channel override first, then the# store default. Only a registered Spree::OrderRouting::Strategy::Base# subclass is used; any other value (an unregistered/typo'd class, or adiff --git a/spree/core/app/services/spree/carts/associate.rb b/spree/core/app/services/spree/carts/associate.rbindex d43add22e5..c2e89ecbd8 100644--- a/spree/core/app/services/spree/carts/associate.rb+++ b/spree/core/app/services/spree/carts/associate.rb@@ -16,7 +16,7 @@ module Spree# validations, so a broken address-book entry must not land on the# cart. Digital-only checkouts never receive a ship address.guest_cart.bill_address ||= user.bill_address if user.bill_address&.valid?- guest_cart.ship_address ||= user.ship_address if user.ship_address&.valid? && guest_cart.delivery_required?+ guest_cart.ship_address ||= user.ship_address if user.ship_address&.valid? && guest_cart.delivery_step_required?owner_key = guest_cart.is_a?(Spree::Cart) ? :customer_id : :user_idchanges = {diff --git a/spree/core/app/services/spree/checkout/advance.rb b/spree/core/app/services/spree/checkout/advance.rbindex 45de3baac1..2ad7a90219 100644--- a/spree/core/app/services/spree/checkout/advance.rb+++ b/spree/core/app/services/spree/checkout/advance.rb@@ -11,7 +11,10 @@ module Spreedef call(order:, state: nil, shipping_method_id: nil)cart = order- if cart.fulfillments.empty? && cart.delivery_required? && cart.ship_address.present? && cart.respond_to?(:rebuild_fulfillments!)+ # A destination is either a shipping address or a pickup intent — a+ # pure-pickup cart never gets an address, but still needs proposals.+ has_destination = cart.ship_address.present? || cart.preferred_stock_location_id.present?+ if cart.fulfillments.empty? && cart.delivery_step_required? && has_destination && cart.respond_to?(:rebuild_fulfillments!)cart.rebuild_fulfillments!enddiff --git a/spree/core/app/services/spree/orders/build_fulfillments.rb b/spree/core/app/services/spree/orders/build_fulfillments.rbindex b3e0f67939..62e2dcc494 100644--- a/spree/core/app/services/spree/orders/build_fulfillments.rb+++ b/spree/core/app/services/spree/orders/build_fulfillments.rb@@ -15,7 +15,7 @@ module Spreedef call(order:)return success(order) unless order.ship_address_id.present?return success(order) unless order.line_items.any?- return success(order) unless order.delivery_required?+ return success(order) unless order.delivery_step_required?order.rebuild_fulfillments!order.create_shipment_tax_charge!diff --git a/spree/core/config/locales/en.yml b/spree/core/config/locales/en.ymlindex 9ae0a59d83..79c5fdc2c3 100644--- a/spree/core/config/locales/en.yml+++ b/spree/core/config/locales/en.yml@@ -763,7 +763,7 @@ en:line_items_required: Add at least one item to your cartpayment_required: Add a payment methodship_address_required: Shipping address is required- shipping_method_required: Select a shipping method for all shipments+ delivery_method_required: Select a delivery method for all fulfillmentschoose_currency: Choose Currencycity: Cityclear: Cleardiff --git a/spree/core/spec/models/concerns/spree/purchase/addresses_spec.rb b/spree/core/spec/models/concerns/spree/purchase/addresses_spec.rbindex 12e69aea50..0c519b88c5 100644--- a/spree/core/spec/models/concerns/spree/purchase/addresses_spec.rb+++ b/spree/core/spec/models/concerns/spree/purchase/addresses_spec.rb@@ -104,21 +104,78 @@ RSpec.shared_examples 'an addresses host' doendit 'fills both addresses from the user defaults' do- allow(record).to receive(:delivery_required?).and_return(true)-record.assign_default_addresses!expect(record.bill_address.id).to eq(default_bill.id)expect(record.ship_address.id).to eq(default_ship.id)end- it 'skips the ship address when no physical delivery is required' do- allow(record).to receive(:delivery_required?).and_return(false)+ it 'skips the ship address for an all-digital record' do+ allow(record).to receive(:digital?).and_return(true)record.assign_default_addresses!expect(record.ship_address).to be_nilend++ it 'still assigns the ship address to an empty record — items usually arrive after the address' do+ record.assign_default_addresses!++ expect(record.ship_address).to be_present+ end+ end++ describe '#shipping_address_required?' do+ let(:shipping_method) { instance_double(Spree::DeliveryMethod, requires_address?: true) }+ let(:pickup_method) { instance_double(Spree::DeliveryMethod, requires_address?: false) }++ def fulfillment_with(delivery_method)+ instance_double(Spree::Fulfillment, delivery_method: delivery_method)+ end++ context 'with delivery methods selected' do+ it 'is false when every selected method delivers without an address' do+ allow(record).to receive(:fulfillments).and_return([fulfillment_with(pickup_method)])++ expect(record.shipping_address_required?).to be false+ end++ it 'is true when any selected method requires one' do+ allow(record).to receive(:fulfillments)+ .and_return([fulfillment_with(pickup_method), fulfillment_with(shipping_method)])++ expect(record.shipping_address_required?).to be true+ end+ end++ context 'before any selection' do+ let!(:store_shipping_method) { create(:delivery_method, store: store) }++ it 'is false for an empty record' do+ expect(record.shipping_address_required?).to be false+ end++ it 'is true when an item can only be fulfilled by an address-requiring type' do+ create(:line_item, "#{record.model_name.element}": record)++ expect(record.reload.shipping_address_required?).to be true+ end++ it 'is false when merchant pickup intent is expressed' do+ create(:line_item, "#{record.model_name.element}": record)+ record.preferred_stock_location_id = create(:stock_location, pickup_enabled: true).id++ expect(record.shipping_address_required?).to be false+ end++ it 'is false when every item is deliverable only by address-free types' do+ digital_type = create(:product_type, fulfillment_types: ['digital'])+ product = create(:product, product_type: digital_type, store: store)+ create(:line_item, "#{record.model_name.element}": record, variant: product.default_variant)++ expect(record.reload.shipping_address_required?).to be false+ end+ endenddescribe '#shipping_eq_billing_address?' dodiff --git a/spree/core/spec/models/concerns/spree/purchase/digital_items_spec.rb b/spree/core/spec/models/concerns/spree/purchase/digital_items_spec.rbindex 966366b588..159bab7674 100644--- a/spree/core/spec/models/concerns/spree/purchase/digital_items_spec.rb+++ b/spree/core/spec/models/concerns/spree/purchase/digital_items_spec.rb@@ -83,13 +83,20 @@ RSpec.shared_examples 'a digital items host' doendend- describe '#requires_ship_address?' do- it 'is false only for an all-digital record' do+ describe '#delivery_step_required?' do+ it 'is false for an empty record — nothing to deliver yet' do+ expect(record.delivery_step_required?).to be false+ end++ it 'is false for an all-digital record — the provider fulfills without a selection' doadd_line_item(record, digital_variant, 1)- expect(record.requires_ship_address?).to be false+ expect(record.delivery_step_required?).to be false+ end+ it 'is true once any item needs a delivery choice' do+ add_line_item(record, digital_variant, 1)add_line_item(record, create(:variant), 1)- expect(record.requires_ship_address?).to be true+ expect(record.delivery_step_required?).to be trueendendenddiff --git a/spree/core/spec/models/spree/cart_spec.rb b/spree/core/spec/models/spree/cart_spec.rbindex 931e8807b8..68cd5b18dd 100644--- a/spree/core/spec/models/spree/cart_spec.rb+++ b/spree/core/spec/models/spree/cart_spec.rb@@ -26,7 +26,7 @@ describe Spree::Cart, type: :model dodescribe '#checkout_steps' dolet(:cart) { build(:cart, store: store) }- before { allow(cart).to receive_messages(delivery_required?: true) }+ before { allow(cart).to receive_messages(delivery_step_required?: true) }context 'when confirmation not required' dobefore do@@ -51,7 +51,7 @@ describe Spree::Cart, type: :model doendcontext 'when delivery not required' do- before { allow(cart).to receive_messages delivery_required?: false }+ before { allow(cart).to receive_messages delivery_step_required?: false }specify doexpect(cart.checkout_steps).to eq(%w(address complete))@@ -78,7 +78,7 @@ describe Spree::Cart, type: :model dodescribe '#checkout_step_index' dolet(:cart) { build(:cart, store: store) }- before { allow(cart).to receive_messages(delivery_required?: true) }+ before { allow(cart).to receive_messages(delivery_step_required?: true) }it 'always returns an integer' doexpect(cart.checkout_step_index('imnotthere')).to be_a Integer@@ -237,17 +237,6 @@ describe Spree::Cart, type: :model doendend- describe '#create_proposed_fulfillments (deprecated)' do- it 'delegates to #rebuild_fulfillments! with a deprecation warning' do- cart = build(:cart, store: store)-- expect(Spree::Deprecation).to receive(:warn).with(/create_proposed_fulfillments/)- expect(cart).to receive(:rebuild_fulfillments!)-- cart.create_proposed_fulfillments- end- end-describe '#coupon_code=' doit 'normalizes to a stripped, lowercased code' doexpect(build(:cart, coupon_code: ' SAVE10 ').read_attribute(:coupon_code)).to eq('save10')diff --git a/spree/core/spec/models/spree/checkout/requirements_spec.rb b/spree/core/spec/models/spree/checkout/requirements_spec.rbindex 5560cccb83..4fa1836603 100644--- a/spree/core/spec/models/spree/checkout/requirements_spec.rb+++ b/spree/core/spec/models/spree/checkout/requirements_spec.rb@@ -47,7 +47,7 @@ RSpec.describe Spree::Checkout::Requirements dodescribe 'ship_address requirement' doit 'requires ship_address for physical orders without address' do- allow(order).to receive(:requires_ship_address?).and_return(true)+ allow(order).to receive(:shipping_address_required?).and_return(true)order.ship_address = nilexpect(subject).to include(@@ -56,7 +56,7 @@ RSpec.describe Spree::Checkout::Requirements doendit 'does not require ship_address for digital orders' do- allow(order).to receive(:requires_ship_address?).and_return(false)+ allow(order).to receive(:shipping_address_required?).and_return(false)expect(subject).not_to include(a_hash_including(step: 'address', field: 'ship_address')@@ -70,11 +70,11 @@ RSpec.describe Spree::Checkout::Requirements doit 'requires shipping_method when delivery step exists and no shipments have methods' doallow(order).to receive(:has_checkout_step?).with('delivery').and_return(true)allow(order).to receive(:has_checkout_step?).with('payment').and_return(true)- allow(order).to receive(:delivery_required?).and_return(true)+ allow(order).to receive(:delivery_step_required?).and_return(true)order.shipments.destroy_allexpect(subject).to include(- a_hash_including(step: 'delivery', field: 'shipping_method')+ a_hash_including(step: 'delivery', field: 'delivery_method'))end@@ -83,7 +83,7 @@ RSpec.describe Spree::Checkout::Requirements doallow(order).to receive(:has_checkout_step?).with('payment').and_return(true)expect(subject).not_to include(- a_hash_including(step: 'delivery', field: 'shipping_method')+ a_hash_including(step: 'delivery', field: 'delivery_method'))endenddiff --git a/spree/core/spec/models/spree/order_spec.rb b/spree/core/spec/models/spree/order_spec.rbindex 323c6c814f..88a7b68ef9 100644--- a/spree/core/spec/models/spree/order_spec.rb+++ b/spree/core/spec/models/spree/order_spec.rb@@ -586,7 +586,7 @@ describe Spree::Order, type: :model do# The user-default ship address only copies onto records needing# physical delivery (Spree::Carts::Associate).- before { allow(order).to receive(:delivery_required?).and_return(true) }+ before { allow(order).to receive(:delivery_step_required?).and_return(true) }it 'does not copy the ship address onto a record without physical delivery' doempty_order = create(:order, user: nil, ship_address: nil)@@ -1823,6 +1823,26 @@ describe Spree::Order, type: :model doendend+ describe 'legacy delivery-predicate bridges' do+ it 'delegates #delivery_required? to #delivery_step_required? with a deprecation warning' do+ order = build(:order)++ expect(Spree::Deprecation).to receive(:warn).with(/delivery_required\?/)+ expect(order).to receive(:delivery_step_required?)++ order.delivery_required?+ end++ it 'delegates #requires_ship_address? to #shipping_address_required? with a deprecation warning' do+ order = build(:order)++ expect(Spree::Deprecation).to receive(:warn).with(/requires_ship_address\?/)+ expect(order).to receive(:shipping_address_required?)++ order.requires_ship_address?+ end+ end+describe 'legacy proposal-rebuild bridges' doit 'delegates #create_proposed_fulfillments to #rebuild_fulfillments! with a deprecation warning' doorder = create(:order)@@ -2272,8 +2292,10 @@ describe Spree::Order, type: :model doexpect(digital_order.reload.quick_checkout_require_address?).to be falseend- it 'returns false if the order does not require delivery' do- allow(order).to receive(:delivery_required?).and_return(false)+ it 'returns false when every selected delivery method is address-free' do+ pickup_method = instance_double(Spree::DeliveryMethod, requires_address?: false)+ pickup_fulfillment = instance_double(Spree::Fulfillment, delivery_method: pickup_method)+ allow(order).to receive(:fulfillments).and_return([pickup_fulfillment])expect(order.quick_checkout_require_address?).to be falseenddiff --git a/spree/core/spec/models/spree/shipment_spec.rb b/spree/core/spec/models/spree/shipment_spec.rbindex df9e39634b..a92924c99e 100644--- a/spree/core/spec/models/spree/shipment_spec.rb+++ b/spree/core/spec/models/spree/shipment_spec.rb@@ -436,20 +436,29 @@ describe Spree::Shipment, type: :model doexpect(shipment.send(:can_get_rates?)).to be_truthyend- it 'returns false if order is not digital and it does not have a ship address' do+ it 'returns false if order has physical items and no ship address' doorder.ship_address = nil+ create(:line_item, order: order)+ order.line_items.reload+expect(order.digital?).to eq(false)expect(shipment.send(:can_get_rates?)).to be_falseyendit 'returns false when order\'s ship address is not valid' doorder.ship_address = build(:address, address1: nil)+ create(:line_item, order: order)+ order.line_items.reload+expect(order.digital?).to eq(false)expect(shipment.send(:can_get_rates?)).to be_falseyendit 'returns true when order\'s ship address is valid' doorder.ship_address = build(:address)+ create(:line_item, order: order)+ order.line_items.reload+expect(order.digital?).to eq(false)expect(shipment.send(:can_get_rates?)).to be_truthyenddiff --git a/spree/core/spec/services/spree/orders/create_spec.rb b/spree/core/spec/services/spree/orders/create_spec.rbindex fb84f3fbd4..a274d44f7b 100644--- a/spree/core/spec/services/spree/orders/create_spec.rb+++ b/spree/core/spec/services/spree/orders/create_spec.rb@@ -129,7 +129,7 @@ module Spreeendbefore do- allow_any_instance_of(Spree::Order).to receive(:delivery_required?).and_return(false)+ allow_any_instance_of(Spree::Order).to receive(:delivery_step_required?).and_return(false)endit 'does not build shipments' do