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.

Do not require shipping address for digital orders (#12906)

Damian Kaczmarczyk2ee4cdb1d6bc
diff --git a/storefront/app/controllers/spree/checkout_controller.rb b/storefront/app/controllers/spree/checkout_controller.rb
index c8e9144166..a01ba2ba65 100644
--- a/storefront/app/controllers/spree/checkout_controller.rb
+++ b/storefront/app/controllers/spree/checkout_controller.rb
@@ -258,7 +258,7 @@ module Spree
end
def should_restart_checkout?
- (@order.quick_checkout? || @order.ship_address.nil?) && (@order.delivery? || @order.payment?)
+ (@order.quick_checkout? || (@order.requires_ship_address? && @order.ship_address.nil?)) && (@order.delivery? || @order.payment?)
end
def restart_checkout
@@ -315,7 +315,9 @@ module Spree
@order.bill_address ||= try_spree_current_user.bill_address
end
# for guest users or users without addresses, we need to build an empty one here
- @order.ship_address ||= Address.new(country: current_store.default_country, user: try_spree_current_user)
+ if @order.requires_ship_address?
+ @order.ship_address ||= Address.new(country: current_store.default_country, user: try_spree_current_user)
+ end
end
def before_delivery
@@ -326,7 +328,11 @@ module Spree
end
def before_payment
- @order.bill_address ||= @order.ship_address.clone
+ @order.bill_address ||= if @order.requires_ship_address?
+ @order.ship_address.clone
+ else
+ Spree::Address.new(country: current_store.default_country, user: try_spree_current_user)
+ end
if @order.checkout_steps.include? 'delivery'
packages = @order.shipments.map(&:to_package)
diff --git a/storefront/app/views/spree/checkout/_address.html.erb b/storefront/app/views/spree/checkout/_address.html.erb
index db70eb176f..d9272d7c84 100644
--- a/storefront/app/views/spree/checkout/_address.html.erb
+++ b/storefront/app/views/spree/checkout/_address.html.erb
@@ -123,28 +123,30 @@
<% end %>
<% end %>
- <div class="mb-4" data-controller="checkout-address-book" data-checkout-address-book-target="list">
- <div id="<%= address_type %>">
- <h5 class="mt-5 mb-4 font-body">
- <%= Spree.t(address_type + '_address') %>
- </h5>
- <%= form.fields_for address_name do |address_form| %>
- <div class="inner checkout-content-inner" data-hook='<%= "#{address_type}_inner" %>'>
- <%= render partial: 'spree/addresses/form', locals: {
- address_name: address_name,
- address_form: address_form,
- address_type: address_type,
- address: address_form.object.persisted? ? address_form.object : Spree::Address.new(country: current_store.default_country, user: try_spree_current_user),
- form: form
- } %>
- </div>
- <% end %>
+ <% if @order.requires_ship_address? %>
+ <div class="mb-4" data-controller="checkout-address-book" data-checkout-address-book-target="list">
+ <div id="<%= address_type %>">
+ <h5 class="mt-5 mb-4 font-body">
+ <%= Spree.t(address_type + '_address') %>
+ </h5>
+ <%= form.fields_for address_name do |address_form| %>
+ <div class="inner checkout-content-inner" data-hook='<%= "#{address_type}_inner" %>'>
+ <%= render partial: 'spree/addresses/form', locals: {
+ address_name: address_name,
+ address_form: address_form,
+ address_type: address_type,
+ address: address_form.object.persisted? ? address_form.object : Spree::Address.new(country: current_store.default_country, user: try_spree_current_user),
+ form: form
+ } %>
+ </div>
+ <% end %>
+ </div>
</div>
- </div>
+ <%= hidden_field_tag 'save_user_address', true, data: { hook: "save_user_address" } %>
+ <% end %>
<%= render 'spree/checkout/special_instructions', form: form %>
- <%= hidden_field_tag 'save_user_address', true, data: { hook: "save_user_address" } %>
</div>
<div class="flex justify-end w-full">
<%= button_tag Spree.t(:save_and_continue),
diff --git a/storefront/app/views/spree/checkout/_payment.html.erb b/storefront/app/views/spree/checkout/_payment.html.erb
index 8e3252afba..a3e2f00985 100644
--- a/storefront/app/views/spree/checkout/_payment.html.erb
+++ b/storefront/app/views/spree/checkout/_payment.html.erb
@@ -1,23 +1,25 @@
<%= form_for @order, url: spree.update_checkout_path(@order.token, @order.state), html: { id: "checkout_form_#{@order.state}" } do |form| %>
<%= form.hidden_field :state_lock_version %>
-
+
<% if @order.respond_to?(:gift_card) %>
<%= turbo_frame_tag :gift_card_code_field do %>
<%= hidden_field_tag 'order[gift_card_code]', @order.gift_card&.code %>
<%= hidden_field_tag 'order[gift_card_amount]', @order.gift_card_total %>
<% end %>
<% end %>
-
- <% use_shipping = @order.shipping_eq_billing_address? || @order.bill_address.nil? || @order.bill_address.new_record? %>
-
+
+ <% use_shipping = (@order.shipping_eq_billing_address? || @order.bill_address.nil? || @order.bill_address.new_record?) && @order.requires_ship_address? %>
+
<div id="billing-address" class="mb-8 max-w-full" data-controller="toggle">
<h5 class="mb-3 font-body font-semibold">
<%= Spree.t(:billing_address) %>
</h5>
- <div class="flex items-center">
- <%= form.check_box :use_shipping, { checked: use_shipping, class: 'checkbox-input', data: { action: 'change->toggle#toggle' } } %>
- <%= form.label :use_shipping, Spree.t(:use_shipping_address), class: 'ml-1 cursor-pointer select-none' %>
- </div>
+ <% if @order.requires_ship_address? %>
+ <div class="flex items-center">
+ <%= form.check_box :use_shipping, { checked: use_shipping, class: 'checkbox-input', data: { action: 'change->toggle#toggle' } } %>
+ <%= form.label :use_shipping, Spree.t(:use_shipping_address), class: 'ml-1 cursor-pointer select-none' %>
+ </div>
+ <% end %>
<%= form.fields_for :bill_address do |address_form| %>
<div class="mt-4 <%= 'hidden' if use_shipping %>" data-toggle-target='toggleable'>
<%= render partial: 'spree/addresses/form', locals: {
diff --git a/storefront/spec/controllers/spree/checkout_controller_spec.rb b/storefront/spec/controllers/spree/checkout_controller_spec.rb
index 71efb63294..3ef3d35a0a 100644
--- a/storefront/spec/controllers/spree/checkout_controller_spec.rb
+++ b/storefront/spec/controllers/spree/checkout_controller_spec.rb
@@ -2,6 +2,11 @@ require 'spec_helper'
describe Spree::CheckoutController, type: :controller do
let(:store) { @default_store }
+ let(:address_params) do
+ address = build(:address, country: country, state: state)
+ address.attributes.except('created_at', 'updated_at')
+ end
+ let(:accept_marketing) { true }
let(:country) { store.default_country || create(:country_us) }
let!(:state) { create(:state, country: country, name: 'New York', abbr: 'NY') }
let(:user) { nil }
@@ -9,11 +14,6 @@ describe Spree::CheckoutController, type: :controller do
render_views
- let(:address_params) do
- address = build(:address, country: country, state: state)
- address.attributes.except('created_at', 'updated_at')
- end
- let(:accept_marketing) { true }
before do
allow(controller).to receive_messages(
@@ -80,6 +80,7 @@ describe Spree::CheckoutController, type: :controller do
context 'when special instructions preference is enabled' do
before { store.update!(preferred_special_instructions_enabled: true) }
+
after { store.update!(preferred_special_instructions_enabled: false) }
it 'renders the special instructions field' do
@@ -247,12 +248,26 @@ describe Spree::CheckoutController, type: :controller do
context 'on quick checkout' do
let(:address) { create(:address, quick_checkout: true, country: country, state: state) }
+
include_examples 'restarting checkout'
end
context 'with a missing shipping address' do
let(:address) { nil }
+
include_examples 'restarting checkout'
+
+ context 'when the order does not require a shipping address' do
+ let(:digital_shipping_method) { create(:digital_shipping_method) }
+ let(:digital_product) { create(:product, shipping_category: digital_shipping_method.shipping_categories.first) }
+ let(:order) { create(:order_with_line_items, variants: [digital_product.default_variant], state: 'payment', ship_address: nil, store: store, user: user, email: '[email protected]') }
+
+ it 'does not redirect to the address step' do
+ get :edit, params: { token: order.token }
+ expect(response).to be_ok
+ expect(response).not_to redirect_to(spree.checkout_state_path(order.token, 'address'))
+ end
+ end
end
end
@@ -549,6 +564,7 @@ describe Spree::CheckoutController, type: :controller do
let(:ship_address_params) { build(:address, company: company_name, country: country, state: state).attributes.except(:user_id, :created_at, :updated_at) }
before { store.update!(preferred_company_field_enabled: true) }
+
after { store.update!(preferred_company_field_enabled: false) }
it 'saves company field when provided' do
@@ -587,6 +603,7 @@ describe Spree::CheckoutController, type: :controller do
end
before { store.update!(preferred_special_instructions_enabled: true) }
+
after { store.update!(preferred_special_instructions_enabled: false) }
it 'saves special instructions when provided' do
@@ -609,16 +626,12 @@ describe Spree::CheckoutController, type: :controller do
end
context 'with the order in the delivery state' do
- let(:ship_address) { create(:address, user: user, country: country, state: state) }
- let(:order) { create(:order_with_line_items, state: 'delivery', ship_address: ship_address, user: user, store: store, email: '[email protected]') }
-
- before do
- order.create_proposed_shipments
- order.send(:ensure_available_shipping_rates)
- order.set_shipments_cost
+ subject :update do
+ patch :update, params: update_params
order.reload
end
+ let(:ship_address) { create(:address, user: user, country: country, state: state) }
let(:update_params) do
{
token: order.token,
@@ -628,12 +641,17 @@ describe Spree::CheckoutController, type: :controller do
}
}
end
+ let(:order) { create(:order_with_line_items, state: 'delivery', ship_address: ship_address, user: user, store: store, email: '[email protected]') }
- subject :update do
- patch :update, params: update_params
+ before do
+ order.create_proposed_shipments
+ order.send(:ensure_available_shipping_rates)
+ order.set_shipments_cost
order.reload
end
+
+
it 'sets shipping rate and moves to payment state' do
expect(controller).to receive(:track_event).with('checkout_step_completed', { order: order, step: 'delivery' })
expect { update }.to change { order.state }.from('delivery').to('payment')
@@ -642,6 +660,11 @@ describe Spree::CheckoutController, type: :controller do
end
context 'with the order in the payment state' do
+ subject :update do
+ patch :update, params: update_params
+ order.reload
+ end
+
let(:order) { create(:order_with_line_items, state: 'payment', user: user,store: store, email: '[email protected]') }
let(:payment_method) { create(:credit_card_payment_method, stores: [store]) }
@@ -681,10 +704,6 @@ describe Spree::CheckoutController, type: :controller do
}
end
- subject :update do
- patch :update, params: update_params
- order.reload
- end
it 'saves payment method' do
expect { update }.to change { order.payments.count }.by(1)
@@ -1007,6 +1026,7 @@ describe Spree::CheckoutController, type: :controller do
let(:bill_address_with_company) { bill_address_attributes.merge(company: company_name) }
before { store.update!(preferred_company_field_enabled: true) }
+
after { store.update!(preferred_company_field_enabled: false) }
context 'when company field is provided' do
@@ -1062,6 +1082,8 @@ describe Spree::CheckoutController, type: :controller do
end
describe '#apply_coupon_code' do
+ subject { patch :apply_coupon_code, params: { token: order.token, coupon_code: coupon_code } }
+
let(:user) { create(:user) }
let!(:order) { create(:order_with_line_items, state: 'payment', store: store, bill_address: nil, user: user) }
let!(:line_item) { create(:line_item, order: order) }
@@ -1069,7 +1091,6 @@ describe Spree::CheckoutController, type: :controller do
let!(:promotion) { create(:promotion, name: 'Free shipping', code: 'freeship', stores: [store]) }
let!(:promotion_action) { Spree::PromotionAction.create(promotion_id: promotion.id, type: 'Spree::Promotion::Actions::FreeShipping') }
- subject { patch :apply_coupon_code, params: { token: order.token, coupon_code: coupon_code } }
context 'when coupon code is valid' do
let(:coupon_code) { 'FREESHIP' }
@@ -1098,11 +1119,12 @@ describe Spree::CheckoutController, type: :controller do
end
describe 'apply gift card' do
+ subject { patch :apply_coupon_code, params: { token: order.token, coupon_code: gift_card.code.upcase } }
+
let(:user) { create(:user) }
let(:gift_card) { create :gift_card, store: store, user: user }
let(:coupon_code) { gift_card.code.upcase }
- subject { patch :apply_coupon_code, params: { token: order.token, coupon_code: gift_card.code.upcase } }
context 'when gift card is valid' do
it 'applies the gift card' do
@@ -1141,6 +1163,8 @@ describe Spree::CheckoutController, type: :controller do
end
describe '#remove_coupon_code' do
+ subject { delete :remove_coupon_code, params: { token: order.token, coupon_code: coupon_code } }
+
let(:user) { create(:user) }
let!(:order) { create(:order_with_line_items, state: 'payment', store: store, bill_address: nil, user: user) }
let!(:line_item) { create(:line_item, order: order) }
@@ -1149,7 +1173,6 @@ describe Spree::CheckoutController, type: :controller do
let!(:promotion) { create(:promotion, name: 'Free shipping', code: coupon_code, stores: [store]) }
let!(:promotion_action) { Spree::PromotionAction.create(promotion_id: promotion.id, type: 'Spree::Promotion::Actions::FreeShipping') }
- subject { delete :remove_coupon_code, params: { token: order.token, coupon_code: coupon_code } }
before do
order.coupon_code = coupon_code
@@ -1167,10 +1190,11 @@ describe Spree::CheckoutController, type: :controller do
end
context 'for a gift card' do
+ subject { patch :remove_coupon_code, params: { token: order.token, gift_card: coupon_code } }
+
let(:gift_card) { create :gift_card, store: store }
let(:coupon_code) { gift_card.code.upcase }
- subject { patch :remove_coupon_code, params: { token: order.token, gift_card: coupon_code } }
before do
Spree::GiftCards::Apply.call(order: order, gift_card: gift_card)