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 admin stock locations management (#12229)
Damian Legawiece7b4df741bd9
diff --git a/admin/Gemfile b/admin/Gemfileindex 95dc8177c1..070a55c5b1 100644--- a/admin/Gemfile+++ b/admin/Gemfile@@ -2,4 +2,8 @@ eval_gemfile('../common_spree_dependencies.rb')gem 'spree_core', path: '../core'+group :test, :development do+ gem 'selenium-webdriver'+end+gemspecdiff --git a/admin/app/controllers/spree/admin/stock_locations_controller.rb b/admin/app/controllers/spree/admin/stock_locations_controller.rbnew file mode 100644index 0000000000..9991a7c2bc--- /dev/null+++ b/admin/app/controllers/spree/admin/stock_locations_controller.rb@@ -0,0 +1,26 @@+module Spree+ module Admin+ class StockLocationsController < ResourceController+ helper 'spree/addresses'++ before_action :set_country, only: :new++ def mark_as_default+ @stock_location.update(default: true)++ flash[:success] = flash_message_for(@stock_location, :marked_as_default)+ redirect_to spree.admin_stock_locations_path+ end++ private++ def collection+ super.order_default+ end++ def set_country+ @stock_location.country = current_store.default_country+ end+ end+ end+enddiff --git a/admin/app/views/layouts/spree/admin.html.erb b/admin/app/views/layouts/spree/admin.html.erbindex 7a31fc3aec..ff8654267d 100644--- a/admin/app/views/layouts/spree/admin.html.erb+++ b/admin/app/views/layouts/spree/admin.html.erb@@ -1,12 +1,13 @@<!DOCTYPE html><html lang="<%= I18n.locale %>"><head>+ <%= javascript_importmap_tags 'application-spree-backend' %></head><body class="admin min-vh-100 <%= controller_name %> <%= action_name %>" data-controller="spree"><div class="container-fluid"><div class="row justify-content-center"><div class="col-lg-3 col-xl-2 d-none d-lg-block position-relative px-2">- <%= render 'spree/admin/shared/sidebar' %>+ <%#= render 'spree/admin/shared/sidebar' %></div><div class="col-lg-9 col-xl-10 px-0 pb-5 mb-3 pt-lg-2"><main id="content" class="container">diff --git a/admin/app/views/spree/admin/shared/_edit_resource_links.html.erb b/admin/app/views/spree/admin/shared/_edit_resource_links.html.erbnew file mode 100644index 0000000000..159c7bfc92--- /dev/null+++ b/admin/app/views/spree/admin/shared/_edit_resource_links.html.erb@@ -0,0 +1,6 @@+<div class="form-actions">+ <%= turbo_save_button_tag Spree.t('actions.update') %>+ <% if f.object.can_be_deleted? && can?(:delete, f.object) %>+ <%= link_to Spree.t('actions.destroy'), object_url(f.object), data: { turbo_method: :delete, turbo_confirm: Spree.t(:are_you_sure_delete), turbo_frame: defined?(turbo_frame) ? turbo_frame : nil }, class: 'btn btn-danger ml-auto' %>+ <% end %>+</div>diff --git a/admin/app/views/spree/admin/shared/_error_messages.html.erb b/admin/app/views/spree/admin/shared/_error_messages.html.erbnew file mode 100644index 0000000000..4caf117352--- /dev/null+++ b/admin/app/views/spree/admin/shared/_error_messages.html.erb@@ -0,0 +1,12 @@+<% if target && target.errors.any? %>+ <div class="alert alert-danger">+ <p>+ <strong><%= Spree.t(:errors_prohibited_this_record_from_being_saved, count: target.errors.size) %>:</strong><br>+ </p>+ <ul class="list-unstyled mb-0">+ <% target.errors.full_messages.each do |msg| %>+ <li><%= msg %></li>+ <% end %>+ </ul>+ </div>+<% end %>diff --git a/admin/app/views/spree/admin/shared/_new_resource_links.html.erb b/admin/app/views/spree/admin/shared/_new_resource_links.html.erbnew file mode 100644index 0000000000..7c074b0bcb--- /dev/null+++ b/admin/app/views/spree/admin/shared/_new_resource_links.html.erb@@ -0,0 +1,3 @@+<div class="form-actions">+ <%= turbo_save_button_tag Spree.t('actions.create') %>+</div>diff --git a/admin/app/views/spree/admin/stock_locations/_form.html.erb b/admin/app/views/spree/admin/stock_locations/_form.html.erbnew file mode 100644index 0000000000..80afccdf4a--- /dev/null+++ b/admin/app/views/spree/admin/stock_locations/_form.html.erb@@ -0,0 +1,56 @@+<div class="row">+ <div class="col-12">+ <div class="card mb-4">+ <div class="card-header">+ <h5 class="card-title">+ <%= Spree.t(:general_settings) %>+ </h5>+ </div>+ <div class="card-body" >+ <div class="row">+ <div class="col-12 col-lg-6">+ <div class="form-group">+ <%= f.label :name, raw(Spree.t(:name) + required_span_tag) %>+ <%= f.text_field :name, class: 'form-control', required: true %>+ <%= f.error_message_on :name %>+ </div>+ </div>+ <div class="col-12 col-lg-6">+ <div class="form-group">+ <%= f.label :admin_name, Spree.t(:internal_name) %>+ <%= f.text_field :admin_name, class: 'form-control', label: false %>+ </div>+ </div>+ </div>+ <% unless f.object.default? %>+ <div class="row">+ <div class="col-12">+ <div class="form-group">+ <div class="custom-control custom-checkbox">+ <%= f.check_box :active, class: 'custom-control-input' %>+ <%= f.label :active, class: 'custom-control-label' %>+ </div>+ </div>+ </div>+ </div>+ <% end %>+ </div>+ </div>+ </div>+ <div class="col-12">+ <div class="card mb-4">+ <div class="card-header">+ <h5 class="card-title">+ <%= Spree.t(:address) %>+ </h5>+ </div>+ <div class="card-body">+ <%= render 'spree/addresses/form',+ address_name: 'address',+ address_form: f,+ address_type: 'stock_location',+ address: f.object %>+ </div>+ </div>+ </div>+</div>diff --git a/admin/app/views/spree/admin/stock_locations/_stock_location.html.erb b/admin/app/views/spree/admin/stock_locations/_stock_location.html.erbnew file mode 100644index 0000000000..f3c1b4d0ac--- /dev/null+++ b/admin/app/views/spree/admin/stock_locations/_stock_location.html.erb@@ -0,0 +1,30 @@+<tr id="<%= spree_dom_id stock_location %>" data-controller="row-link" class="cursor-pointer">+ <td data-action="click->row-link#openLink"><%= stock_location.display_name %></td>+ <td data-action="click->row-link#openLink">+ <%= flag_emoji(stock_location.country_iso) %>+ <%= stock_location.country_name %>+ </td>+ <td data-action="click->row-link#openLink"><%= active_badge(stock_location.active?) %></td>+ <td data-action="click->row-link#openLink"><%= active_badge(stock_location.default?) %></td>+ <td class="actions">+ <% if can? :edit, stock_location %>+ <div class="d-flex justify-content-end align-items-center">+ <div><%= link_to_edit stock_location, data: { row_link_target: 'link' } %></div>++ <div class="dropdown">+ <button class="btn btn-sm btn-light" type="button" id="dropdownMenuButton" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">+ <%= icon('dots', class: 'mr-0') %>+ </button>++ <div class="dropdown-menu dropdown-menu-right" aria-labelledby="dropdownMenuButton">+ <%= link_to_with_icon 'check',+ Spree.t(:mark_as_default),+ spree.mark_as_default_admin_stock_location_path(stock_location),+ class: 'dropdown-item',+ data: { turbo_method: :put } %>+ </div>+ </div>+ </div>+ <% end %>+ </td>+</tr>diff --git a/admin/app/views/spree/admin/stock_locations/edit.html.erb b/admin/app/views/spree/admin/stock_locations/edit.html.erbnew file mode 100644index 0000000000..8b8e481a9d--- /dev/null+++ b/admin/app/views/spree/admin/stock_locations/edit.html.erb@@ -0,0 +1,9 @@+<% content_for :page_title do %>+ <%= page_header_back_button spree.admin_stock_locations_path %>+ <%= @stock_location.name %>+<% end %>+<%= render partial: 'spree/admin/shared/error_messages', locals: { target: @stock_location } %>+<%= form_for [:admin, @stock_location] do |f| %>+ <%= render 'form', f: f %>+ <%= render 'spree/admin/shared/edit_resource_links', f: f %>+<% end %>diff --git a/admin/app/views/spree/admin/stock_locations/index.html.erb b/admin/app/views/spree/admin/stock_locations/index.html.erbnew file mode 100644index 0000000000..f6c31988b1--- /dev/null+++ b/admin/app/views/spree/admin/stock_locations/index.html.erb@@ -0,0 +1,29 @@+<% content_for :page_title do %>+ <%= Spree.t(:stock_locations) %>+<% end %>+<% content_for :page_actions do %>+ <%= button_link_to Spree.t("admin.stock_locations.new"), new_object_url, class: "btn-primary", icon: 'plus' %>+<% end if can? :create, Spree::StockLocation %>+<% if @stock_locations.any? %>+ <div class="table-responsive card-lg p-0">+ <table class="table" id='listing_tax_rates'>+ <thead class="text-muted">+ <tr data-hook="rate_header">+ <th><%= Spree.t(:name) %></th>+ <th><%= Spree.t(:country) %></th>+ <th><%= Spree.t(:status) %></th>+ <th><%= Spree.t(:default) %></th>+ <th></th>+ </tr>+ </thead>+ <tbody>+ <%= render partial: 'spree/admin/stock_locations/stock_location', collection: @stock_locations, cached: spree_base_cache_scope %>+ </tbody>+ </table>+ </div>+<% else %>+ <div class="text-muted p-5 d-flex align-items-center w-100 justify-content-center">+ <%= Spree.t(:no_resource_found, resource: plural_resource_name(Spree::StockLocation)) %>+ <%= link_to_with_icon('plus', Spree.t(:add_one), new_object_url, class: 'btn btn-link') if can? :create, Spree::StockLocation %>+ </div>+<% end %>diff --git a/admin/app/views/spree/admin/stock_locations/new.html.erb b/admin/app/views/spree/admin/stock_locations/new.html.erbnew file mode 100644index 0000000000..47ff54d542--- /dev/null+++ b/admin/app/views/spree/admin/stock_locations/new.html.erb@@ -0,0 +1,11 @@+<% content_for :page_title do %>+ <%= page_header_back_button spree.admin_stock_locations_path %>+ <%= Spree.t('admin.stock_locations.new') %>+<% end %>+<%= render partial: 'spree/admin/shared/error_messages', locals: { target: @stock_location } %>+<%= form_for [:admin, @stock_location] do |f| %>+ <fieldset>+ <%= render 'form', f: f %>+ <%= render 'spree/admin/shared/new_resource_links' %>+ </fieldset>+<% end %>diff --git a/admin/config/routes.rb b/admin/config/routes.rbindex 61261c8a2b..707c532292 100644--- a/admin/config/routes.rb+++ b/admin/config/routes.rb@@ -12,5 +12,12 @@ Spree::Core::Engine.add_routes do# profile settingsresource :profile, controller: 'profile', only: %i[edit update]++ # store settings+ resources :stock_locations, except: [:show] do+ member do+ put :mark_as_default+ end+ endendenddiff --git a/core/app/helpers/spree/addresses_helper.rb b/core/app/helpers/spree/addresses_helper.rbnew file mode 100644index 0000000000..dfa120aab8--- /dev/null+++ b/core/app/helpers/spree/addresses_helper.rb@@ -0,0 +1,106 @@+# https://github.com/spree-contrib/spree_address_book/blob/master/app/helpers/spree/addresses_helper.rb+module Spree+ module AddressesHelper+ def address_field(form, method, address_id = 'b', required = false, text_field_attributes: {}, &handler)+ content_tag :div, id: [address_id, method].join, class: 'mb-4' do+ if handler+ yield+ else+ method_name = I18n.t("activerecord.attributes.spree/address.#{method}")+ form.label(method, method_name, class: 'block text-xs text-neutral-600 mb-1') ++ form.text_field(method,+ class: ['text-input w-full'].compact,+ placeholder: method_name,+ required: required,+ aria: { label: method_name },+ **text_field_attributes)++ end+ end+ end++ def address_zipcode(form, country, address_id = 'b')+ method_name = Spree.t(:zipcode)+ form.label(:zipcode, method_name, id: address_id + '_zipcode_label', class: 'block text-xs text-neutral-600 mb-1') ++ form.text_field(:zipcode,+ class: 'text-input h-full',+ placeholder: method_name,+ required: country&.zipcode_required?,+ data: { 'address-form-target': 'zipcode', address_autocomplete_target: 'zipcode' },+ aria: { label: Spree.t(:zipcode) })+ end++ def address_state(form, country, address_id = 'b')+ country ||= address_default_country+ states_required = country.states_required?+ have_states = states_required && country.states.any?+ state_elements = [+ form.label(Spree.t(:state).downcase,+ Spree.t(:state),+ class: [have_states ? 'state-select-label' : nil, ' block text-xs text-neutral-600 mb-1'].compact,+ id: address_id + '_state_label',+ data: { 'address-form-target': 'stateLabel' }) ++ form.collection_select(:state_id, checkout_zone_applicable_states_for(country).sort_by(&:name),+ :id, :name,+ { prompt: Spree.t(:state) },+ class: 'select-input min-w-full max-w-full',+ data: { 'address-form-target': 'state', address_autocomplete_target: 'state' },+ required: have_states && states_required,+ aria: { label: Spree.t(:state) }) ++ form.text_field(:state_name,+ class: 'ml-3 text-input',+ aria: { label: Spree.t(:state) },+ required: !have_states && states_required,+ data: { 'address-form-target': 'stateName' },+ placeholder: Spree.t(:state))+ ].join.tr('"', "'").delete("\n")++ content_tag :span, class: 'w-full state-select max-w-full' do+ state_elements.html_safe+ end+ end++ def available_states+ @available_states ||= Rails.cache.fetch(['available-states-v2', current_store.cache_key_with_version]) do+ Spree::State.where(country_id: available_countries).pluck(:country_id, :id, :abbr, :name)+ end+ end++ def current_store_countries_with_states_ids+ @current_store_countries_with_states_ids ||= current_store.countries_available_for_checkout.where(states_required: true).includes(:states).each_with_object([]) do |country, memo|+ memo << current_store.states_available_for_checkout(country)+ end.flatten.pluck(:country_id)+ end++ def current_store_countries_without_states_ids+ @current_store_countries_without_states_ids ||= current_store.countries_available_for_checkout.where(states_required: false).ids+ end++ def current_store_supported_countries_ids+ @current_store_supported_countries_ids ||= Rails.cache.fetch(['current_store_supported_countries_ids', current_store]) do+ (current_store_countries_with_states_ids + current_store_countries_without_states_ids).uniq+ end+ end++ def user_available_addresses+ return [] unless try_spree_current_user++ @user_available_addresses ||= begin+ try_spree_current_user.+ addresses.+ includes(:country, :state).+ not_quick_checkout.+ where(country_id: current_store_supported_countries_ids).+ includes(:user)+ end+ end++ def checkout_zone_applicable_states_for(country)+ current_store.states_available_for_checkout(country)+ end++ def address_default_country+ @address_default_country ||= current_store.default_country+ end+ end+enddiff --git a/core/app/models/spree/address.rb b/core/app/models/spree/address.rbindex 54c3a0d31c..87e9b8f115 100644--- a/core/app/models/spree/address.rb+++ b/core/app/models/spree/address.rb@@ -164,6 +164,10 @@ module Spreetrueend+ def show_company_address_field?+ false+ end+def editable?new_record? || Order.complete.where('bill_address_id = ? OR ship_address_id = ?', id, id).none?enddiff --git a/core/app/models/spree/base.rb b/core/app/models/spree/base.rbindex 5ab3d00293..9bf9c767b2 100644--- a/core/app/models/spree/base.rb+++ b/core/app/models/spree/base.rb@@ -50,6 +50,11 @@ class Spree::Base < ApplicationRecordfalseend+ # this can overridden in subclasses to disallow deletion+ def can_be_deleted?+ true+ end+def self.json_api_columnscolumn_names.reject { |c| c.match(/_id$|id|preferences|(.*)password|(.*)token|(.*)api_key/) }enddiff --git a/core/app/models/spree/stock_location.rb b/core/app/models/spree/stock_location.rbindex 1ef2b8b844..001e9531d1 100644--- a/core/app/models/spree/stock_location.rb+++ b/core/app/models/spree/stock_location.rb@@ -29,6 +29,7 @@ module Spreeafter_update :conditional_touch_recordsdelegate :name, :iso3, :iso, :iso_name, to: :country, prefix: true+ delegate :show_company_address_field?, to: :addressdef state_textstate.try(:abbr) || state.try(:name) || state_name@@ -139,6 +140,20 @@ module Spree)end+ # needed for address form+ def require_name?+ false+ end++ # needed for address form+ def require_company?+ false+ end++ def require_phone?+ false+ end+def display_name@display_name ||= [admin_name, name].delete_if(&:blank?).join(' / ')enddiff --git a/core/app/views/spree/addresses/_form.html.erb b/core/app/views/spree/addresses/_form.html.erbnew file mode 100644index 0000000000..46a439ac7a--- /dev/null+++ b/core/app/views/spree/addresses/_form.html.erb@@ -0,0 +1,58 @@+<% address_id = address_type.chars.first %>+<% address ||= address_form.object %>++<div class="inner"+ data-controller="address-form address-autocomplete"+ data-address-form-countries-value="<%= available_countries.to_json %>"+ data-address-form-states-value="<%= available_states.to_json %>"+ data-address-form-current-state-id-value="<%= address.state_id %>"+>+ <div id="<%= "#{address_id}country" %>">+ <div class="form-group mb-0">+ <div id="<%= "#{address_id}country-selection" %>">+ <%= address_form.label(Spree.t(:country), Spree.t(:country), class: 'block text-xs text-neutral-600 mb-1') %>+ <%= address_form.select :country_id, available_countries.map { |c| [c.name, c.id, data: { iso: c.iso }] },+ { },+ { class: 'w-full select-input mb-4',+ data: {+ 'address-form-target': 'country',+ 'action': "change->address-form#changeCountry",+ 'address-autocomplete-target': 'country'+ },+ aria: { label: Spree.t(:country) } } %>+ </div>+ </div>+ </div>+ <% if address.require_name? %>+ <div class="grid grid-cols-2 gap-4">+ <div>+ <%= address_field(address_form, :firstname, address_id, true) %>+ </div>+ <div>+ <%= address_field(address_form, :lastname, address_id, true) %>+ </div>+ </div>+ <% end %>+ <%= address_field(address_form, :company, address_id, address.require_company?) if address.show_company_address_field? %>+ <div class="mb-4 flex flex-col space-y-2" data-address-autocomplete-target="autocompleteInputContainer" tabindex="-1" >+ <div class="relative">+ <div id="<%= address_id %>address1">+ <% method_name = I18n.t("activerecord.attributes.spree/address.address1") %>+ <%= address_form.label(method_name, method_name, class: 'block text-xs text-neutral-600 mb-1') %>+ <%= address_form.text_field :address1, class: 'text-input w-full', placeholder: method_name, required: true, data: {address_autocomplete_target: "address1"}, autocorrect: "off", autocomplete: "shipping-address-line1", aria: {label: method_name, autocomplete: "list", controls: "suggestions-box-options", owns: "suggestions-box-options", haspopup: "listbox", role: "combobox", expanded: "false"} %>+ </div>+ <%= render "spree/addresses/suggestions_box" %>+ </div>+ <span class="text-sm space-x-2 items-center hidden alert alert-info mt-2 align-items-center" data-address-autocomplete-target="addressWarning">+ <%= heroicon "exclamation-circle", variant: :outline if defined?(heroicon) %>+ <%= Spree.t(:add_house_number, scope: :address_book) %>+ </span>+ </div>+ <%= address_field(address_form, :address2, address_id) %>+ <div class="grid grid-cols-3 gap-4 address-form max-w-full d-flex row mb-4">+ <%= address_field(address_form, :city, address_id, true, text_field_attributes: {data: {address_autocomplete_target: "city"}}) %>+ <%= address_field(address_form, :state, address_id) { address_state(address_form, address.country, address_id) } if Spree::Config[:address_requires_state] %>+ <%= address_field(address_form, :zipcode, address_id) { address_zipcode(address_form, address.country, address_id) } %>+ </div>+ <%= address_field(address_form, :phone, address_id, address.require_phone?) %>+</div>diff --git a/core/app/views/spree/addresses/_suggestions_box.erb b/core/app/views/spree/addresses/_suggestions_box.erbnew file mode 100644index 0000000000..e69de29bb2diff --git a/core/config/locales/en.yml b/core/config/locales/en.ymlindex f1afd5a400..42e7d84155 100644--- a/core/config/locales/en.yml+++ b/core/config/locales/en.yml@@ -491,14 +491,23 @@ en:cancel: Cancelcontinue: Continuecreate: Create- destroy: Destroy+ approve: Approveedit: Edit+ confirm: Confirmlist: Listlisting: Listingnew: New+ connect: Connect+ discard: Discard+ destroy: Delete+ disconnect: Disconnectrefund: Refundsave: Saveupdate: Update+ reject: Reject+ receive: Mark as received+ resolve: Mark as resolved+ send_invitation: Send invitationactivate: Activateactive: Activeadd: Adddiff --git a/core/lib/spree/testing_support/authorization_helpers.rb b/core/lib/spree/testing_support/authorization_helpers.rbindex 6a0c404a53..60b8839a86 100644--- a/core/lib/spree/testing_support/authorization_helpers.rb+++ b/core/lib/spree/testing_support/authorization_helpers.rb@@ -45,15 +45,11 @@ module Spreeendlet(:user) { Spree.admin_user_class.new(email: FFaker::Internet.email) }- let(:admin_app) { Spree::OauthApplication.create!(name: 'Admin Panel', scopes: 'admin') }- let(:admin_token) { Spree::OauthAccessToken.create!(application: admin_app, scopes: 'admin').token }before doallow(Spree.admin_user_class).to receive(:find_by).and_return(user)if defined?(Spree::Admin::BaseController)allow_any_instance_of(Spree::Admin::BaseController).to receive(:try_spree_current_user).and_return(user)- allow_any_instance_of(Spree::Admin::BaseController).to receive(:admin_oauth_application).and_return(admin_app)- allow_any_instance_of(Spree::Admin::BaseController).to receive(:admin_oauth_token).and_return(admin_token)endendend