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
Open source addresses management
Damian Legawiec2a092e4d578f
diff --git a/storefront/app/controllers/spree/addresses_controller.rb b/storefront/app/controllers/spree/addresses_controller.rbnew file mode 100644index 0000000000..52d787516b--- /dev/null+++ b/storefront/app/controllers/spree/addresses_controller.rb@@ -0,0 +1,101 @@+module Spree+ class AddressesController < Spree::StoreController+ helper Spree::AddressesHelper+ load_and_authorize_resource class: Spree::Address++ def create+ order_token = params[:order_token]+ @order = current_store.orders.incomplete.not_canceled.find_by(token: order_token) if order_token.present?+ result = create_service.call(+ user: try_spree_current_user,+ address_params: address_params,+ default_billing: params[:default_billing].to_b,+ default_shipping: params[:default_shipping].to_b,+ order: @order+ )+ @address = result.value++ if result.success?+ if @order.present?+ respond_to do |format|+ format.html { redirect_to spree.checkout_state_path(order_token, 'address') }+ format.turbo_stream do+ render turbo_stream: turbo_stream.update('checkout_content', partial: 'spree/checkout/address', locals: { order: @order })+ end+ end+ else+ redirect_to spree.account_addresses_path, notice: Spree.t(:successfully_created, scope: :address_book)+ end+ else+ render action: 'new', status: :unprocessable_entity+ end+ end++ def edit+ store_location(request.env['HTTP_REFERER'])+ end++ def new+ @address = Spree::Address.new(country: current_store.default_country, user: try_spree_current_user)+ end++ def update+ @order = if params[:checkout].present?+ current_store.orders.incomplete.not_canceled.find_by(token: params[:checkout])+ else+ try_spree_current_user.orders.incomplete.not_canceled.where(ship_address_id: @address.id).+ or(try_spree_current_user.orders.incomplete.not_canceled.where(bill_address_id: @address.id)).take+ end+ result = update_service.call(+ address: @address,+ address_params: address_params,+ default_billing: params[:default_billing].to_b,+ default_shipping: params[:default_shipping].to_b,+ order: @order,+ address_changes_except: address_changes_except+ )+ @address = result.value++ if result.success?+ flash[:notice] = Spree.t(:successfully_updated, scope: :address_book) unless turbo_frame_request?++ if params[:checkout].present?+ respond_to do |format|+ format.turbo_stream do+ render turbo_stream: turbo_stream.update('checkout_content', partial: 'spree/checkout/address', locals: { order: @order })+ end+ format.html { redirect_to spree.checkout_state_path(@order.token, 'address') }+ end+ else+ redirect_back_or_default(spree.account_addresses_path)+ end+ else+ render :edit, status: :unprocessable_entity+ end+ end++ def destroy+ @address.destroy++ redirect_to(spree.account_addresses_path, status: :see_other, notice: Spree.t(:successfully_removed, scope: :address_book))+ end++ private++ def address_params+ params.require(:address).permit(permitted_address_attributes)+ end++ def create_service+ Spree::Dependencies.address_create_service.constantize+ end++ def update_service+ Spree::Dependencies.address_update_service.constantize+ end++ def address_changes_except+ []+ end+ end+enddiff --git a/storefront/app/views/spree/addresses/destroy.turbo_stream.erb b/storefront/app/views/spree/addresses/destroy.turbo_stream.erbnew file mode 100644index 0000000000..c3413b9b13--- /dev/null+++ b/storefront/app/views/spree/addresses/destroy.turbo_stream.erb@@ -0,0 +1 @@+<%= turbo_stream.remove(@address) %>diff --git a/storefront/app/views/spree/addresses/edit.html.erb b/storefront/app/views/spree/addresses/edit.html.erbnew file mode 100644index 0000000000..08f887f3fd--- /dev/null+++ b/storefront/app/views/spree/addresses/edit.html.erb@@ -0,0 +1,57 @@+<% if params[:checkout].present? %>+ <%= turbo_frame_tag dom_id(@address) do %>+ <%= render 'spree/shared/error_messages', target: @address %>+ <%= form_for @address, html: { id: 'checkout_form_address' } do |f| %>+ <%= render 'spree/addresses/form',+ address_name: 'address',+ address_form: f,+ address_type: 'shipping',+ address: @address %>++ <%= hidden_field_tag :checkout, params[:checkout] %>+ <div class="flex justify-between items-center">+ <%= f.submit Spree.t(:update), class: 'btn btn-primary w-25 !py-2' %>+ <%= link_to Spree.t('actions.discard'), :back, class: 'btn btn-light w-25 !py-2' %>+ </div>+ <% end %>+ <% end %>+<% else %>+ <div class="page-container grid grid-cols-1 lg:grid-cols-12 lg:gap-6 lg:mt-6">+ <div class="lg:col-span-2">+ <%= render 'spree/account/account_nav', current: 'address' %>+ </div>+ <div class="lg:col-span-6 lg:col-start-4">+ <div class="pb-4 border-b border-default -mx-4 lg:mx-0 px-4 lg:px-8">+ <h3 class="text-xl uppercase font-medium lg:font-semibold"><%= Spree.t(:edit_address, scope: :address_book) %></h3>+ </div>+ <%= render 'spree/shared/error_messages', target: @address %>+ <%= form_for @address, html: { id: 'checkout_form_address' }, method: :put do |f| %>+ <div class="lg:px-8 pt-4">+ <%= render 'spree/addresses/form',+ address_name: 'address',+ address_form: f,+ address_type: 'shipping',+ address: @address %>+ </div>+ <div class="lg:px-8 pb-4">+ <%= label_tag "default_shipping", class: "flex items-center gap-2 text-sm mb-4" do %>+ <%= check_box_tag "default_shipping", "true", @address.user_default_shipping?,+ class: 'input-checkbox input-address-default',+ disabled: @address.user_default_shipping? %>+ Set as default delivery address+ <% end %>+ <%= label_tag "default_billing", class: "flex items-center gap-2 text-sm mb-4" do %>+ <%= check_box_tag "default_billing", "true", @address.user_default_billing?,+ class: 'input-checkbox input-address-default',+ disabled: @address.user_default_billing? %>+ Set as default billing address+ <% end %>+ </div>+ <div class="border-t border-default -mx-4 lg:mx-0 px-4 flex justify-end items-center gap-4 py-6 lg:px-8">+ <%= link_to Spree.t('actions.cancel'), :back, class: 'uppercase text-sm font-semibold tracking-widest' %>+ <%= f.submit Spree.t(:update), class: 'btn-primary' %>+ </div>+ <% end %>+ </div>+ </div>+<% end %>diff --git a/storefront/app/views/spree/addresses/new.html.erb b/storefront/app/views/spree/addresses/new.html.erbnew file mode 100644index 0000000000..7ee177da8c--- /dev/null+++ b/storefront/app/views/spree/addresses/new.html.erb@@ -0,0 +1,71 @@+<% if turbo_frame_request? %>+ <%= turbo_frame_tag :new_address do %>+ <div class="card-dialog">+ <%= render 'spree/shared/error_messages', target: @address %>+ <%= form_for @address, html: { id: 'checkout_form_address' } do |f| %>+ <%= render 'spree/addresses/form',+ address_name: 'address',+ address_form: f,+ address_type: 'shipping',+ address: @address %>+ <%= hidden_field_tag :order_token, params[:order_token] %>+ <%= hidden_field_tag "default_shipping", true %>+ <%= hidden_field_tag "default_billing", true %>+ <%= f.submit t(:save, scope: :address_book), class: 'btn-primary w-48 text-center', id: 'save-btn' %>+ <% end %>+ </div>+ <% end %>+<% else %>+ <% if params[:checkout].present? %>+ <div class="card-dialog mx-auto lg:w-1/3">+ <h3 class="mb-5 font-semibold"><%= Spree.t(:new_address, scope: :address_book) %></h3>+ <%= render 'spree/shared/error_messages', target: @address %>+ <%= form_for @address, html: { id: 'checkout_form_address' } do |f| %>+ <%= render 'spree/addresses/form',+ address_name: 'address',+ address_form: f,+ address_type: 'shipping',+ address: @address %>+ <div class="flex justify-between items-center">+ <%= f.submit t(:save, scope: :address_book), class: 'btn-primary w-48 text-center', id: 'save-btn' %>+ <%= link_to Spree.t('actions.discard'), :back, class: 'btn btn-light w-25 !py-2' %>+ </div>+ <% end %>+ </div>+ <% else %>+ <div class="page-container grid grid-cols-1 lg:grid-cols-12 lg:gap-6 lg:mt-6">+ <div class="lg:col-span-2">+ <%= render 'spree/account/account_nav', current: 'address' %>+ </div>+ <div class="lg:col-span-6 lg:col-start-4">+ <div class="pb-4 border-b border-default -mx-4 lg:mx-0 px-4 lg:px-8">+ <h3 class="text-xl uppercase font-medium lg:font-semibold"><%= Spree.t(:add_address, scope: :address_book) %></h3>+ </div>+ <%= render 'spree/shared/error_messages', target: @address %>+ <%= form_for @address, html: { id: 'checkout_form_address' } do |f| %>+ <div class="lg:px-8 pt-4">+ <%= render 'spree/addresses/form',+ address_name: 'address',+ address_form: f,+ address_type: 'shipping',+ address: @address %>+ </div>+ <div class="lg:px-8 pb-4">+ <%= label_tag "default_shipping", class: 'flex items-center gap-2 text-sm mb-4' do %>+ <%= check_box_tag "default_shipping", "true", true, class: 'input-checkbox' %>+ <%= Spree.t(:set_as_default_delivery_address, scope: :address_book) %>+ <% end %>+ <%= label_tag "default_billing", class: 'flex items-center gap-2 text-sm mb-4' do %>+ <%= check_box_tag "default_billing", "true", true, class: 'input-checkbox' %>+ <%= Spree.t(:set_as_default_billing_address, scope: :address_book) %>+ <% end %>+ </div>+ <div class="border-t border-default -mx-4 lg:mx-0 px-4 flex justify-end items-center gap-4 py-6 lg:px-8">+ <%= link_to Spree.t('actions.cancel'), :back, class: 'uppercase text-sm font-semibold tracking-widest' %>+ <%= f.submit Spree.t('actions.save'), class: 'btn-primary' %>+ </div>+ <% end %>+ </div>+ </div>+ <% end %>+<% end %>diff --git a/storefront/config/routes.rb b/storefront/config/routes.rbindex 9e36dd1b7d..b21513978d 100644--- a/storefront/config/routes.rb+++ b/storefront/config/routes.rb@@ -5,6 +5,7 @@ Spree::Core::Engine.add_routes doget '/cart', to: 'orders#edit', as: :cartpatch '/cart', to: 'orders#update', as: :update_cart+ resources :addresses, except: [:index]namespace :account doresource :wishlist, only: [:show], controller: '/spree/wishlists' doresources :wished_items, only: [:create, :destroy]diff --git a/storefront/spec/controllers/spree/addresses_controller_spec.rb b/storefront/spec/controllers/spree/addresses_controller_spec.rbnew file mode 100644index 0000000000..93c5d3c480--- /dev/null+++ b/storefront/spec/controllers/spree/addresses_controller_spec.rb@@ -0,0 +1,210 @@+require 'spec_helper'++describe Spree::AddressesController, type: :controller do+ let(:store) { Spree::Store.default }+ let(:country) { store.default_country }+ let(:state) { create(:state, country: country) }+ let(:user) { create(:user, first_name: nil, last_name: nil, phone: nil) }+ let(:order) { create(:order_with_totals, store: store) }+ let(:default_billing) { 'true' }+ let(:default_shipping) { 'true' }++ before do+ allow(controller).to receive_messages try_spree_current_user: user+ allow(controller).to receive_messages spree_current_user: user+ allow(controller).to receive_messages current_order: order+ allow_any_instance_of(CanCan::ControllerResource).to receive(:load_resource)+ allow_any_instance_of(CanCan::ControllerResource).to receive(:authorize_resource)+ end++ describe '#create' do+ subject :post_create do+ post :create, params: { address: address_params, default_billing: default_billing, default_shipping: default_shipping }+ end++ context 'when data is valid' do+ let(:address_params) do+ address = build(:address, country: country, state: state)+ address.attributes.except('created_at', 'updated_at', 'quick_checkout')+ end++ it 'returns 302 status code' do+ post_create++ expect(response.status).to eq(302)+ end++ it 'redirects to /account/addresses' do+ post_create++ expect(response).to redirect_to('/account/addresses')+ end++ it 'creates address' do+ expect { post_create }.to change { user.addresses.count }.by(1)+ end++ it 'sets flash message' do+ post_create++ expect(flash[:notice]).to eq Spree.t(:successfully_created, scope: :address_book)+ end++ context 'default address' do+ let!(:default_address) { create(:address, user: user) }++ before { user.update!(ship_address: default_address, bill_address: default_address) }++ context 'when default_shipping param is false' do+ let(:default_shipping) { nil }++ it 'does not set default shipping address' do+ post_create++ expect(user.reload.shipping_address).to eq(default_address)+ expect(user.billing_address).to eq(Spree::Address.last)+ end+ end++ context 'when default_billing param is false' do+ let(:default_billing) { nil }++ it 'does not set default billing address' do+ post_create++ expect(user.reload.billing_address).to eq(default_address)+ expect(user.shipping_address).to eq(Spree::Address.last)+ end+ end+ end+ end++ context 'when data is not valid' do+ let(:address_params) do+ address = build(:address, country: country, state: state, first_name: nil)+ address.attributes.except('created_at', 'updated_at')+ end++ it 'does not create address' do+ expect { post_create }.not_to change { user.addresses.count }+ end++ it 'returns 422 status code' do+ post_create++ expect(response.status).to eq(422)+ end++ it 'renders address form template' do+ expect(post_create).to render_template(:new)+ end+ end+ end++ describe '#update' do+ subject :put_update do+ put :update, params: { address: address_params, id: address.id }+ end++ before { controller.instance_variable_set(:@address, address) }++ context 'when address is editable' do+ let(:address) { create(:address, country: country, state: state, label: 'label', user: user) }++ context 'with data is valid' do+ let(:address_params) { address.attributes.symbolize_keys.merge(firstname: 'Test') }++ it 'updates address' do+ expect(address.attributes.symbolize_keys.except(:created_at, :updated_at)).not_to match(address_params.except(:created_at, :updated_at))++ put_update++ expect(address.firstname).to eq 'Test'+ end++ it 'sets flash message' do+ put_update++ expect(flash[:notice]).to eq Spree.t(:successfully_updated, scope: :address_book)+ end++ it 'returns 302 status code' do+ put_update++ expect(response.status).to eq(302)+ end++ it 'redirects to /account/addresses' do+ put_update++ expect(response).to redirect_to(spree.account_addresses_path)+ end+ end++ context 'when data is not valid' do+ let(:address_params) { address.attributes.symbolize_keys.merge(firstname: nil) }++ it 'does not update address' do+ expect { put_update }.not_to change { address }+ end++ it 'renders address form template' do+ expect(put_update).to render_template(:edit)+ end+ end+ end++ context 'when address is not editable' do+ let(:address) { create(:address, country: country, state: state, label: 'label', user: user) }+ let!(:order) { create(:completed_order_with_totals, ship_address: address) }++ context 'with data is valid' do+ let(:address_params) { address.attributes.symbolize_keys.except(:id, :quick_checkout).merge(firstname: 'test', label: '') }++ it 'creates address' do+ expect { put_update }.to change { Spree::Address.count }.by(1)+ end++ it 'sets deleted_at attribute of original address' do+ Timecop.freeze(Time.current) do+ expect(address.deleted_at).to be_nil++ put_update++ expect(address.deleted_at).not_to be nil+ end+ end++ it 'sets flash message' do+ put_update++ expect(flash[:notice]).to eq Spree.t(:successfully_updated, scope: :address_book)+ end++ it 'returns 302 status code' do+ put_update++ expect(response.status).to eq(302)+ end++ it 'redirects to /account/addresses' do+ put_update++ expect(response).to redirect_to(spree.account_addresses_path)+ end+ end++ context 'when data is not valid' do+ let(:address_params) { address.attributes.symbolize_keys.except(:skip_mainstreet_validation, :quick_checkout).merge(address1: nil) }++ it 'does not create address' do+ expect { put_update }.to change { Spree::Address.count }.by(0)+ end++ it 'renders address form template' do+ expect(put_update).to render_template(:edit)+ end+ end+ end+ end+end