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
Deprecate `OrderWalkthrough`
Damian Legawiecec17ababf33b
diff --git a/docs/developer/upgrades/5.6-to-6.0.mdx b/docs/developer/upgrades/5.6-to-6.0.mdxindex ae8e459c9c..dd724a50b2 100644--- a/docs/developer/upgrades/5.6-to-6.0.mdx+++ b/docs/developer/upgrades/5.6-to-6.0.mdx@@ -230,6 +230,7 @@ Every rename keeps the legacy name working for one release with a deprecation wa| `Cart#number` (Store API field) | `id` — carts have no order-style number; the field mirrors the prefixed ID for one release || `order.completed` event | `order.placed` || Calling cart services with `order:` kwargs | `cart:` kwargs |+| `OrderWalkthrough` (testing support) | factories: `:cart_ready_for_delivery`, `:cart_ready_to_complete`, `:completed_order_with_totals` |## For extension authorsdiff --git a/spree/core/lib/spree/testing_support/factories/cart_factory.rb b/spree/core/lib/spree/testing_support/factories/cart_factory.rbindex 9096c3a745..225f697408 100644--- a/spree/core/lib/spree/testing_support/factories/cart_factory.rb+++ b/spree/core/lib/spree/testing_support/factories/cart_factory.rb@@ -14,6 +14,50 @@ FactoryBot.define docart.line_items.reloadcart.recalculate_totals!end++ # Mid-checkout: addresses set and delivery proposals built against a+ # real shipping method — the factory replacement for+ # OrderWalkthrough.up_to(:payment).+ factory :cart_ready_for_delivery do+ email { '[email protected]' }++ transient do+ shipping_cost { 10 }+ end++ after(:create) do |cart, evaluator|+ create(:check_payment_method, store: cart.store) if Spree::PaymentMethod.none?++ zone = create(:zone)+ country = create(:country)+ zone.members.create!(zoneable: country)+ create(:state, country: country)++ if Spree::DeliveryMethod.none?+ create(:shipping_method).tap do |delivery_method|+ delivery_method.calculator.preferred_amount = evaluator.shipping_cost+ delivery_method.calculator.preferred_currency = cart.store.default_currency+ delivery_method.calculator.save!+ end+ end++ cart.update!(+ ship_address: create(:address, country: country, state: country.states.first),+ bill_address: create(:address, country: country, state: country.states.first)+ )+ cart.rebuild_fulfillments!+ cart.set_fulfillments_cost+ cart.recalculate_totals!+ end++ # Payment-covered and completable — the factory replacement for a+ # walkthrough cart with a full check payment.+ factory :cart_ready_to_complete do+ after(:create) do |cart|+ create(:payment, cart: cart, order: nil, payment_method: Spree::PaymentMethod.first, amount: cart.reload.total)+ end+ end+ endendendenddiff --git a/spree/core/lib/spree/testing_support/order_walkthrough.rb b/spree/core/lib/spree/testing_support/order_walkthrough.rbindex 0e55d76409..a41303badf 100644--- a/spree/core/lib/spree/testing_support/order_walkthrough.rb+++ b/spree/core/lib/spree/testing_support/order_walkthrough.rb@@ -2,8 +2,13 @@# every step BEFORE the given one satisfied (matching the legacy contract# where `up_to(:delivery)` had completed the address step). `up_to(:complete)`# runs the real completion pipeline and returns the resulting Spree::Order.+# @deprecated Removed in Spree 6.1 — build checkout state with the factories+# instead: create(:cart_ready_for_delivery) (address + delivery proposals),+# create(:cart_ready_to_complete) (payment-covered), or+# create(:completed_order_with_totals) for a placed order.class OrderWalkthroughdef self.up_to(state, store = nil)+ Spree::Deprecation.warn('OrderWalkthrough is deprecated and will be removed in Spree 6.1. Use the cart factories instead: :cart_ready_for_delivery, :cart_ready_to_complete, or :completed_order_with_totals.')store ||= Spree::Store.default# A payment method must exist for checkout to proceeddiff --git a/spree/core/spec/models/spree/order_updater_spec.rb b/spree/core/spec/models/spree/order_updater_spec.rbindex 4d65f58d3e..23187c7566 100644--- a/spree/core/spec/models/spree/order_updater_spec.rb+++ b/spree/core/spec/models/spree/order_updater_spec.rb@@ -1,5 +1,4 @@require 'spec_helper'-require 'spree/testing_support/order_walkthrough'module Spreedescribe OrderUpdater, type: :model do@@ -299,7 +298,7 @@ module Spreedescribe '#update_shipments' doinclude_context 'with original shipping method gone backend only'- let(:order) { ::OrderWalkthrough.up_to(:delivery) }+ let(:order) { create(:cart_ready_for_delivery, store: @default_store) }it 'resets shipping method to frontend-available' doSpree::OrderUpdater.new(order).update_shipmentsdiff --git a/spree/core/spec/services/spree/checkout/advance_spec.rb b/spree/core/spec/services/spree/checkout/advance_spec.rbindex 846460e015..4400880205 100644--- a/spree/core/spec/services/spree/checkout/advance_spec.rb+++ b/spree/core/spec/services/spree/checkout/advance_spec.rb@@ -1,12 +1,11 @@require 'spec_helper'-require 'spree/testing_support/order_walkthrough'module Spreedescribe Checkout::Advance dosubject { described_class.call(order: cart) }let(:store) { @default_store }- let(:cart) { ::OrderWalkthrough.up_to(:delivery, store) }+ let(:cart) { create(:cart_ready_for_delivery, store: store) }it 'recalculates the cart and returns success' doexpect(subject).to be_successdiff --git a/spree/core/spec/workflows/spree/carts/complete_spec.rb b/spree/core/spec/workflows/spree/carts/complete_spec.rbindex 85f7e59e93..a9e10d5510 100644--- a/spree/core/spec/workflows/spree/carts/complete_spec.rb+++ b/spree/core/spec/workflows/spree/carts/complete_spec.rb@@ -1,19 +1,11 @@require 'spec_helper'-require 'spree/testing_support/order_walkthrough'module Spreedescribe Carts::Complete do- subject { described_class.call(cart: cart) }-let(:store) { @default_store }- let(:cart) { ::OrderWalkthrough.up_to(:complete, store).cart || raise('walkthrough returned no cart') }- # Build a payment-ready cart without completing it- let(:ready_cart) do- cart = ::OrderWalkthrough.up_to(:payment, store)- FactoryBot.create(:payment, cart: cart, order: nil, payment_method: Spree::PaymentMethod.first, amount: cart.reload.total)- cart- end+ # Payment-covered cart, one completion attempt away from an order.+ let(:ready_cart) { create(:cart_ready_to_complete, store: store) }describe 'the three-phase pipeline' dosubject { described_class.call(cart: ready_cart) }@@ -153,7 +145,7 @@ module Spreeenddescribe 'net-terms completion (payment_pending)' do- let(:uncovered_cart) { ::OrderWalkthrough.up_to(:payment, store) }+ let(:uncovered_cart) { create(:cart_ready_for_delivery, store: store) }it 'does not waive the payment requirement on carts — net terms is a draft-order flow' doresult = described_class.call(cart: uncovered_cart, payment_pending: true)