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.

Fixes #13411 Admin Order Notes (#13434)

Damian Legawieca3fc41841d58
diff --git a/admin/app/assets/tailwind/spree/admin/components/_dialogs.css b/admin/app/assets/tailwind/spree/admin/components/_dialogs.css
index 8ebd9929b0..2fb58412b1 100644
--- a/admin/app/assets/tailwind/spree/admin/components/_dialogs.css
+++ b/admin/app/assets/tailwind/spree/admin/components/_dialogs.css
@@ -119,6 +119,13 @@
@apply flex justify-between items-center p-4 bg-gray-25 border-t border-gray-100 rounded-b-2xl;
}
+ .drawer .card, .drawer .card-header, .drawer .card-body, .drawer .card-footer {
+ @apply border-none p-0;
+ }
+ .drawer .card-header {
+ @apply h-auto pb-4 pt-2;
+ }
+
/* ==========================================================================
Dialog (Centered Modal - Native Dialog)
========================================================================== */
diff --git a/admin/app/controllers/spree/admin/orders_controller.rb b/admin/app/controllers/spree/admin/orders_controller.rb
index 54596677bb..9858f062a7 100644
--- a/admin/app/controllers/spree/admin/orders_controller.rb
+++ b/admin/app/controllers/spree/admin/orders_controller.rb
@@ -120,6 +120,10 @@ module Spree
def permitted_resource_params
params.require(:order).permit(permitted_order_attributes)
end
+
+ def update_turbo_stream_enabled?
+ true
+ end
end
end
end
diff --git a/admin/app/controllers/spree/admin/users_controller.rb b/admin/app/controllers/spree/admin/users_controller.rb
index e319c4c229..0b9933774f 100644
--- a/admin/app/controllers/spree/admin/users_controller.rb
+++ b/admin/app/controllers/spree/admin/users_controller.rb
@@ -37,19 +37,24 @@ module Spree
end
end
- def update
- if @user.update(user_params)
- flash[:success] = flash_message_for(@user, :successfully_updated)
- redirect_to spree.admin_user_path(@user)
- else
- render :edit, status: :unprocessable_entity
- end
- end
-
def model_class
Spree.user_class
end
+ def update_turbo_stream_enabled?
+ true
+ end
+
+ # Skip setting current store for users as they don't need store assignment
+ # and the stores association goes through role_users which requires a role
+ def set_current_store
+ # no-op for users
+ end
+
+ def location_after_save
+ spree.admin_user_path(@user)
+ end
+
protected
def collection_includes
@@ -71,6 +76,10 @@ module Spree
private
+ def permitted_resource_params
+ user_params
+ end
+
def user_params
params.require(:user).permit(permitted_user_attributes | [spree_role_ids: []])
end
@@ -85,6 +94,12 @@ module Spree
return if params[:user].blank?
params[:user][:tag_list] = params.dig(:user, :tag_list).present? ? params.dig(:user, :tag_list).reject(&:empty?) : []
+
+ # Remove spree_role_ids if it only contains empty strings to avoid clearing roles
+ role_ids = params[:user][:spree_role_ids]
+ if role_ids.present? && role_ids.reject(&:empty?).empty?
+ params[:user].delete(:spree_role_ids)
+ end
end
def load_last_order_data
diff --git a/admin/app/views/spree/admin/orders/show.html.erb b/admin/app/views/spree/admin/orders/show.html.erb
index eb99ab1b80..f5a5ddd2b1 100644
--- a/admin/app/views/spree/admin/orders/show.html.erb
+++ b/admin/app/views/spree/admin/orders/show.html.erb
@@ -18,6 +18,7 @@
<div class="col-span-12 lg:col-span-4">
<%= render 'customer' %>
<%= render 'special_instructions' %>
+ <%= render 'spree/admin/shared/internal_note', notable: @order %>
<%= render_admin_partials(:order_page_sidebar_partials, order: @order) %>
</div>
</div>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/orders/update.turbo_stream.erb b/admin/app/views/spree/admin/orders/update.turbo_stream.erb
new file mode 100644
index 0000000000..ba6d220dc9
--- /dev/null
+++ b/admin/app/views/spree/admin/orders/update.turbo_stream.erb
@@ -0,0 +1,5 @@
+<%= turbo_render_alerts %>
+
+<%= turbo_stream.replace 'internal_note' do %>
+ <%= render 'spree/admin/shared/internal_note', notable: @order %>
+<% end %>
diff --git a/admin/app/views/spree/admin/price_lists/update.turbo_stream.erb b/admin/app/views/spree/admin/price_lists/update.turbo_stream.erb
index e5c53209df..825d65ff19 100644
--- a/admin/app/views/spree/admin/price_lists/update.turbo_stream.erb
+++ b/admin/app/views/spree/admin/price_lists/update.turbo_stream.erb
@@ -1,10 +1,17 @@
-<%= turbo_render_alerts :drawer_alerts %>
+<% if @price_list.valid? %>
+ <%= turbo_close_drawer %>
+ <%= turbo_render_alerts %>
-<%= turbo_stream.replace spree_dom_id(@price_list) + '_details' do %>
- <%= render 'spree/admin/price_lists/details', price_list: @price_list %>
-<% end %>
+ <%= turbo_stream.replace spree_dom_id(@price_list) + '_details' do %>
+ <%= render 'spree/admin/price_lists/details', price_list: @price_list %>
+ <% end %>
-<%= turbo_stream.update 'page_title' do %>
- <%= page_header_back_button(spree.admin_price_lists_path) %>
- <%= @price_list.name %>
-<% end %>
+ <%= turbo_stream.update 'page_title' do %>
+ <%= page_header_back_button(spree.admin_price_lists_path) %>
+ <%= @price_list.name %>
+ <% end %>
+<% else %>
+ <%= turbo_stream.replace :drawer do %>
+ <%= render 'spree/admin/shared/edit_resource_in_drawer' %>
+ <% end %>
+<% end %>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/shared/_internal_note.html.erb b/admin/app/views/spree/admin/shared/_internal_note.html.erb
new file mode 100644
index 0000000000..19e2645118
--- /dev/null
+++ b/admin/app/views/spree/admin/shared/_internal_note.html.erb
@@ -0,0 +1,41 @@
+<%# locals: (notable:, form_url: nil, param_key: nil) %>
+<% form_url ||= spree.polymorphic_path([:admin, notable]) %>
+<% param_key ||= notable.model_name.param_key %>
+
+<div class="card mb-6" id="internal_note" data-controller="dialog">
+ <div class="card-header flex justify-between items-center">
+ <h5 class="card-title">
+ <%= Spree.t(:internal_note) %>
+ </h5>
+ <% if can?(:update, notable) %>
+ <%= button_tag type: 'button', class: 'btn btn-light btn-sm', data: { action: 'dialog#open' } do %>
+ <%= icon('pencil', class: 'mr-1') %>
+ <%= Spree.t('actions.edit') %>
+ <% end %>
+ <% end %>
+ </div>
+ <div class="card-body">
+ <% if notable.internal_note.present? %>
+ <div class="prose prose-sm max-w-none">
+ <%= notable.internal_note %>
+ </div>
+ <% else %>
+ <p class="text-gray-500 text-sm"><%= Spree.t(:no_internal_note) %></p>
+ <% end %>
+ </div>
+
+ <% if can?(:update, notable) %>
+ <dialog class="dialog" data-dialog-target="dialog">
+ <%= dialog_header(Spree.t(:internal_note)) %>
+ <%= form_with url: form_url, scope: param_key, method: :put do |f| %>
+ <div class="dialog-body">
+ <%= f.spree_rich_text_area :internal_note, label: false %>
+ </div>
+ <div class="dialog-footer">
+ <%= dialog_discard_button %>
+ <%= turbo_save_button_tag Spree.t('actions.save') %>
+ </div>
+ <% end %>
+ </dialog>
+ <% end %>
+</div>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/users/_details.html.erb b/admin/app/views/spree/admin/users/_details.html.erb
index d384426741..3d5a1eae02 100644
--- a/admin/app/views/spree/admin/users/_details.html.erb
+++ b/admin/app/views/spree/admin/users/_details.html.erb
@@ -1,55 +1,54 @@
-<div class="card mb-6" id="user-details">
- <%= turbo_frame_tag :edit_user do %>
- <div class="card-header flex items-center justify-between">
- <h5 class="card-title">
- <%= Spree.t(:details) %>
- </h5>
- <%= link_to_with_icon 'edit', Spree.t(:edit), spree.edit_admin_user_path(@user), class: 'btn btn-light btn-sm', data: { turbo_frame: :edit_user } %>
- </div>
- <div class="card-body p-0">
- <ul class="list-group list-group-flush">
- <% cache [spree_base_cache_key, @user] do %>
- <li class="list-group-item flex justify-between items-center">
- <%= Spree.t(:email) %>
- <span>
- <%= @user.email %>
- <%= clipboard_component(@user.email) %>
- </span>
- </li>
- <li class="list-group-item flex justify-between items-center">
- <%= Spree.t(:phone) %>
- <span>
- <%= @user.phone.presence || Spree.t(:not_available) %>
- </span>
- </li>
- <li class="list-group-item flex justify-between items-center">
- <%= Spree.t(:name) %>
- <span>
- <%= customer_full_name(@user) %>
- </span>
- </li>
- <li class="list-group-item flex justify-between items-center">
- <%= Spree.t(:email_marketing) %>
- <%= active_badge(@user.accepts_email_marketing?) %>
- </li>
- <li class="list-group-item flex justify-between items-center">
- <%= Spree.t(:tags) %>
- <span>
- <% @user.tag_list.each do |tag| %>
- <span class="badge badge-light"><%= tag %></span>
- <% end %>
- </span>
- </li>
- <li class="list-group-item flex justify-between items-center">
- <%= Spree.t(:roles) %>
- <span>
- <% @user.spree_roles.pluck(:name).each do |role_name| %>
- <span class="badge badge-light"><%= role_name %></span>
- <% end %>
- </span>
- </li>
- <% end %>
- </ul>
- </div>
- <% end %>
-</div>
\ No newline at end of file
+<div class="card" id="user-details">
+ <div class="card-header flex items-center justify-between">
+ <h5 class="card-title">
+ <%= Spree.t(:details) %>
+ </h5>
+ <%= link_to_with_icon 'edit', Spree.t(:edit), spree.edit_admin_user_path(@user),
+ class: 'btn btn-light btn-sm', data: { turbo_frame: :drawer, action: 'drawer#open' } %>
+ </div>
+ <div class="card-body p-0">
+ <ul class="list-group list-group-flush">
+ <% cache [spree_base_cache_key, @user] do %>
+ <li class="list-group-item flex justify-between items-center">
+ <%= Spree.t(:email) %>
+ <span>
+ <%= @user.email %>
+ <%= clipboard_component(@user.email) %>
+ </span>
+ </li>
+ <li class="list-group-item flex justify-between items-center">
+ <%= Spree.t(:phone) %>
+ <span>
+ <%= @user.phone.presence || Spree.t(:not_available) %>
+ </span>
+ </li>
+ <li class="list-group-item flex justify-between items-center">
+ <%= Spree.t(:name) %>
+ <span>
+ <%= customer_full_name(@user) %>
+ </span>
+ </li>
+ <li class="list-group-item flex justify-between items-center">
+ <%= Spree.t(:email_marketing) %>
+ <%= active_badge(@user.accepts_email_marketing?) %>
+ </li>
+ <li class="list-group-item flex justify-between items-center">
+ <%= Spree.t(:tags) %>
+ <span>
+ <% @user.tag_list.each do |tag| %>
+ <span class="badge badge-light"><%= tag %></span>
+ <% end %>
+ </span>
+ </li>
+ <li class="list-group-item flex justify-between items-center">
+ <%= Spree.t(:roles) %>
+ <span>
+ <% @user.spree_roles.pluck(:name).each do |role_name| %>
+ <span class="badge badge-light"><%= role_name %></span>
+ <% end %>
+ </span>
+ </li>
+ <% end %>
+ </ul>
+ </div>
+</div>
diff --git a/admin/app/views/spree/admin/users/_form.html.erb b/admin/app/views/spree/admin/users/_form.html.erb
index 7e2ca873a7..553004d76f 100644
--- a/admin/app/views/spree/admin/users/_form.html.erb
+++ b/admin/app/views/spree/admin/users/_form.html.erb
@@ -1,5 +1,19 @@
<div class="card mb-6">
<div class="card-body">
- <%= render 'spree/admin/users/form_fields', f: f %>
+ <%= f.spree_email_field :email, required: true, autofocus: f.object.new_record? %>
+ <%= f.spree_text_field :first_name, required: true %>
+ <%= f.spree_text_field :last_name, required: true %>
+ <%= f.spree_text_field :phone %>
+ <div class="form-group">
+ <%= f.label :tag_list, Spree.t(:tags) %>
+ <%= tom_select_tag 'user[tag_list]', multiple: true, class: 'w-full', options: user_tags_json_array, active_option: @user.tag_list, value_field: :name, create: true %>
+ </div>
+ <% if @user.class == Spree.admin_user_class && can?(:manage, Spree::Role) %>
+ <%= f.spree_select :spree_role_ids,
+ options_from_collection_for_select(Spree::Role.all, 'id', 'name', @user.spree_roles.pluck(:id)),
+ { prompt: false, label: Spree.t(:roles), autocomplete: true },
+ { multiple: true } %>
+ <% end %>
+ <%= f.spree_check_box :accepts_email_marketing %>
</div>
-</div>
\ No newline at end of file
+</div>
diff --git a/admin/app/views/spree/admin/users/_shipping.html.erb b/admin/app/views/spree/admin/users/_shipping.html.erb
index ef4bc9f8f3..f81eeb96a5 100644
--- a/admin/app/views/spree/admin/users/_shipping.html.erb
+++ b/admin/app/views/spree/admin/users/_shipping.html.erb
@@ -1,4 +1,4 @@
-<div class="card mb-6" id="user-ship-address">
+<div class="card" id="user-ship-address">
<div class="card-header flex items-center justify-between">
<h5 class="card-title"><%= Spree.t(:shipping_address) %></h5>
diff --git a/admin/app/views/spree/admin/users/edit.html.erb b/admin/app/views/spree/admin/users/edit.html.erb
index cf9843c07d..7a4cc4153e 100644
--- a/admin/app/views/spree/admin/users/edit.html.erb
+++ b/admin/app/views/spree/admin/users/edit.html.erb
@@ -1,17 +1 @@
-<%= turbo_frame_tag :edit_user do %>
- <div class="card-header flex items-center justify-between">
- <h5 class="card-title">
- <%= Spree.t(:details) %>
- </h5>
- <%= link_to Spree.t('actions.discard'), spree.admin_user_path(@user), class: 'btn btn-light btn-sm' %>
- </div>
- <%= form_for [:admin, @user], as: :user, url: spree.admin_user_path(@user), method: :put do |f| %>
- <div class="card-body pb-0">
- <%= render partial: 'spree/admin/shared/error_messages', locals: { target: @user } %>
- <%= render 'form_fields', f: f %>
- </div>
- <div class="card-footer">
- <%= render 'spree/admin/shared/edit_resource_links', f: f, turbo_frame: '_top' %>
- </div>
- <% end %>
-<% end%>
\ No newline at end of file
+<%= render 'spree/admin/shared/edit_resource_in_drawer' %>
diff --git a/admin/app/views/spree/admin/users/new.html.erb b/admin/app/views/spree/admin/users/new.html.erb
index 65a817edc9..0fd3668cab 100644
--- a/admin/app/views/spree/admin/users/new.html.erb
+++ b/admin/app/views/spree/admin/users/new.html.erb
@@ -1 +1 @@
-<%= render 'spree/admin/shared/new_resource' %>
+<%= render 'spree/admin/shared/new_resource' %>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/users/show.html.erb b/admin/app/views/spree/admin/users/show.html.erb
index d497f52121..1f0c7bcabb 100644
--- a/admin/app/views/spree/admin/users/show.html.erb
+++ b/admin/app/views/spree/admin/users/show.html.erb
@@ -24,10 +24,11 @@
<%= render 'spree/admin/users/tabs' %>
</div>
- <div class="col-span-12 lg:col-span-4">
+ <div class="col-span-12 lg:col-span-4 flex flex-col gap-6">
<%= render 'spree/admin/users/details' %>
<%= render 'spree/admin/users/shipping' %>
<%= render 'spree/admin/users/billing' %>
+ <%= render 'spree/admin/shared/internal_note', notable: @user, form_url: spree.admin_user_path(@user) %>
</div>
</div>
diff --git a/admin/app/views/spree/admin/users/update.turbo_stream.erb b/admin/app/views/spree/admin/users/update.turbo_stream.erb
new file mode 100644
index 0000000000..3fbb9b1f4c
--- /dev/null
+++ b/admin/app/views/spree/admin/users/update.turbo_stream.erb
@@ -0,0 +1,24 @@
+<% if @user.valid? %>
+ <%= turbo_close_drawer %>
+ <%= turbo_render_alerts %>
+
+ <%= turbo_stream.replace 'user-details' do %>
+ <%= render 'spree/admin/users/details' %>
+ <% end %>
+
+ <%= turbo_stream.replace 'user-ship-address' do %>
+ <%= render 'spree/admin/users/shipping' %>
+ <% end %>
+
+ <%= turbo_stream.replace 'user-bill-address' do %>
+ <%= render 'spree/admin/users/billing' %>
+ <% end %>
+
+ <%= turbo_stream.replace 'internal_note' do %>
+ <%= render 'spree/admin/shared/internal_note', notable: @user, form_url: spree.admin_user_path(@user) %>
+ <% end %>
+<% else %>
+ <%= turbo_stream.replace :drawer do %>
+ <%= render 'spree/admin/shared/edit_resource_in_drawer' %>
+ <% end %>
+<% end %>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/webhook_endpoints/_form.html.erb b/admin/app/views/spree/admin/webhook_endpoints/_form.html.erb
index 9f32789a72..07db79ba57 100644
--- a/admin/app/views/spree/admin/webhook_endpoints/_form.html.erb
+++ b/admin/app/views/spree/admin/webhook_endpoints/_form.html.erb
@@ -1,4 +1,4 @@
-<div class="card mb-4">
+<div class="card mb-6">
<div class="card-header">
<h5 class="card-title"><%= Spree.t('admin.webhook_endpoints.endpoint_settings') %></h5>
</div>
@@ -8,7 +8,7 @@
</div>
</div>
-<div class="card mb-4">
+<div class="card mb-6">
<div class="card-header">
<h5 class="card-title"><%= Spree.t('admin.webhook_endpoints.event_subscriptions') %></h5>
</div>
diff --git a/admin/spec/controllers/spree/admin/orders_controller_spec.rb b/admin/spec/controllers/spree/admin/orders_controller_spec.rb
index 23ae28066e..842c6fbc39 100644
--- a/admin/spec/controllers/spree/admin/orders_controller_spec.rb
+++ b/admin/spec/controllers/spree/admin/orders_controller_spec.rb
@@ -317,4 +317,37 @@ RSpec.describe Spree::Admin::OrdersController, type: :controller do
end
end
end
+
+ describe '#update' do
+ let(:order) { create(:completed_order_with_totals, store: store) }
+
+ context 'updating internal_note' do
+ subject do
+ put :update, params: { id: order.number, order: { internal_note: internal_note_content } }, format: :turbo_stream
+ end
+
+ let(:internal_note_content) { 'This is a test internal note for the order.' }
+
+ it 'updates the internal_note' do
+ subject
+ order.reload
+ expect(order.internal_note.to_plain_text).to eq(internal_note_content)
+ end
+
+ it 'responds with turbo_stream' do
+ subject
+ expect(response.media_type).to eq('text/vnd.turbo-stream.html')
+ end
+
+ it 'sets a success flash message' do
+ subject
+ expect(flash[:success]).to be_present
+ end
+
+ it 'renders the internal_note partial' do
+ subject
+ expect(response.body).to include('internal_note')
+ end
+ end
+ end
end
diff --git a/admin/spec/controllers/spree/admin/users_controller_spec.rb b/admin/spec/controllers/spree/admin/users_controller_spec.rb
index 5fec2fcc5b..2a245ad5ea 100644
--- a/admin/spec/controllers/spree/admin/users_controller_spec.rb
+++ b/admin/spec/controllers/spree/admin/users_controller_spec.rb
@@ -156,6 +156,55 @@ RSpec.describe Spree::Admin::UsersController, type: :controller do
expect(response).to redirect_to(spree.admin_user_path(user))
end
end
+
+ context 'when spree_role_ids contains only empty strings' do
+ let!(:role) { Spree::Role.find_or_create_by!(name: 'admin') }
+ let!(:user) { create(:user) }
+
+ before do
+ user.add_role('admin', store)
+ end
+
+ it 'does not clear existing roles' do
+ expect(user.spree_roles).to include(role)
+
+ put :update, params: { id: user.id, user: { last_name: 'Test', spree_role_ids: [''] } }
+
+ expect(user.reload.last_name).to eq('Test')
+ expect(user.spree_roles).to include(role)
+ expect(response).to redirect_to(spree.admin_user_path(user))
+ end
+ end
+
+ context 'updating internal_note' do
+ subject do
+ put :update, params: { id: user.id, user: { internal_note: internal_note_content } }, format: :turbo_stream
+ end
+
+ let(:user) { create(:user) }
+ let(:internal_note_content) { 'This is a test internal note for the customer.' }
+
+ it 'updates the internal_note' do
+ subject
+ user.reload
+ expect(user.internal_note.to_plain_text).to eq(internal_note_content)
+ end
+
+ it 'responds with turbo_stream' do
+ subject
+ expect(response.media_type).to eq('text/vnd.turbo-stream.html')
+ end
+
+ it 'sets a success flash message' do
+ subject
+ expect(flash[:success]).to be_present
+ end
+
+ it 'renders the internal_note partial' do
+ subject
+ expect(response.body).to include('internal_note')
+ end
+ end
end
describe 'POST #bulk_add_tags' do
diff --git a/admin/spec/features/spree/admin/customers_spec.rb b/admin/spec/features/spree/admin/customers_spec.rb
index 64b1e34a28..bfc58789d0 100644
--- a/admin/spec/features/spree/admin/customers_spec.rb
+++ b/admin/spec/features/spree/admin/customers_spec.rb
@@ -119,13 +119,19 @@ RSpec.feature 'Customers', :js do
it 'can update user' do
within '#user-details' do
click_on 'Edit'
+ end
+ within '#drawer-dialog' do
fill_in 'Phone', with: phone
- click_button 'Update'
+ click_button 'Save'
end
- expect(page).to have_content(phone)
+ wait_for_turbo
+
+ within '#user-details' do
+ expect(page).to have_content(phone)
+ end
expect(customer_user.reload.phone).to eq phone
end
@@ -169,6 +175,8 @@ RSpec.feature 'Customers', :js do
find('label', text: 'Use Shipping Address').click
end
+ wait_for_turbo
+
within('#user-bill-address') do
expect(page).to have_text('Same as shipping address')
end
diff --git a/api/spec/serializers/spree/api/v2/platform/order_serializer_spec.rb b/api/spec/serializers/spree/api/v2/platform/order_serializer_spec.rb
deleted file mode 100644
index df85c0f1b0..0000000000
--- a/api/spec/serializers/spree/api/v2/platform/order_serializer_spec.rb
+++ /dev/null
@@ -1,23 +0,0 @@
-require 'spec_helper'
-
-describe Spree::Api::V2::Platform::OrderSerializer do
- include_context 'API v2 serializers params'
-
- subject { described_class.new(order, params: serializer_params).serializable_hash }
-
- context 'cart' do
- let(:order) { create(:order) }
-
- it { expect(subject).to be_kind_of(Hash) }
-
- it_behaves_like 'an ActiveJob serializable hash'
- end
-
- context 'completed order' do
- let(:order) { create(:shipped_order) }
-
- it { expect(subject).to be_kind_of(Hash) }
-
- it_behaves_like 'an ActiveJob serializable hash'
- end
-end
diff --git a/core/app/models/concerns/spree/user_methods.rb b/core/app/models/concerns/spree/user_methods.rb
index 108a2c13e6..158a78ee4f 100644
--- a/core/app/models/concerns/spree/user_methods.rb
+++ b/core/app/models/concerns/spree/user_methods.rb
@@ -45,6 +45,7 @@ module Spree
# Attachments
#
has_one_attached :avatar, service: Spree.public_storage_service_name
+ has_rich_text :internal_note
#
# Attributes
diff --git a/core/app/models/spree/order.rb b/core/app/models/spree/order.rb
index 6c76bc06a0..b134cf2002 100644
--- a/core/app/models/spree/order.rb
+++ b/core/app/models/spree/order.rb
@@ -42,6 +42,7 @@ module Spree
end
has_secure_token :token, length: 35
+ has_rich_text :internal_note
MEMOIZED_METHODS = %w(tax_zone)
diff --git a/core/config/locales/en.yml b/core/config/locales/en.yml
index 8ca169cddd..b150a96c9c 100644
--- a/core/config/locales/en.yml
+++ b/core/config/locales/en.yml
@@ -80,6 +80,7 @@ en:
coupon_code: Coupon Code
created_at: Order Date
email: Email
+ internal_note: Internal Note
ip_address: IP Address
item_count: Items
item_total: Item Total
@@ -1232,6 +1233,7 @@ en:
intercept_email_address: Intercept Email Address
intercept_email_instructions: Override email recipient and replace with this address.
internal_name: Internal Name
+ internal_note: Internal Note
internal_server_error: Internal Server Error
internal_server_error_message: The server encountered an internal error and was unable to complete your request.
internationalization: Internationalization
@@ -1449,6 +1451,7 @@ en:
no_cc_type: N/A
no_country: No country set
no_email_provided: No email provided
+ no_internal_note: No internal note
no_limits_zone: No Limits
no_payment_found: No payment found
no_payment_provider_settings_message: This payment provider has no custom settings available
diff --git a/core/lib/spree/permitted_attributes.rb b/core/lib/spree/permitted_attributes.rb
index e2868c55d3..926ada4e93 100644
--- a/core/lib/spree/permitted_attributes.rb
+++ b/core/lib/spree/permitted_attributes.rb
@@ -90,7 +90,8 @@ module Spree
@@checkout_attributes = [
:coupon_code, :email, :shipping_method_id, :special_instructions, :use_billing, :use_shipping,
- :user_id, :bill_address_id, :ship_address_id, :accept_marketing, :signup_for_an_account, :currency
+ :user_id, :bill_address_id, :ship_address_id, :accept_marketing, :signup_for_an_account, :currency,
+ :internal_note
]
@@classification_attributes = [
@@ -294,6 +295,7 @@ module Spree
@@user_attributes = [:email, :bill_address_id, :ship_address_id, :password, :first_name, :last_name,
:password_confirmation, :selected_locale, :avatar, :accepts_email_marketing, :phone,
+ :internal_note,
{ public_metadata: {}, private_metadata: {}, tag_list: [] }]
@@variant_attributes = [
diff --git a/docs/developer/admin/admin.mdx b/docs/developer/admin/admin.mdx
index 558b717b21..e3c993e555 100644
--- a/docs/developer/admin/admin.mdx
+++ b/docs/developer/admin/admin.mdx
@@ -101,7 +101,7 @@ Views use standard Rails ERB templates with Spree's [Form Builder](/developer/ad
```erb
<%# app/views/spree/admin/brands/_form.html.erb %>
-<div class="card mb-4">
+<div class="card mb-6">
<div class="card-header">
<h5 class="card-title"><%= Spree.t(:general_settings) %></h5>
</div>
diff --git a/docs/developer/admin/extending-ui.mdx b/docs/developer/admin/extending-ui.mdx
index 34f8b58c59..f687efe344 100644
--- a/docs/developer/admin/extending-ui.mdx
+++ b/docs/developer/admin/extending-ui.mdx
@@ -338,7 +338,7 @@ Here's a list of all places you can inject your custom code:
To add a new section to the order page, you can use the following code:
```erb
- <div class="card mb-4">
+ <div class="card mb-6">
<div class="card-header">
<h5 class="card-title">ERP Integration</h5>
</div>
@@ -1617,7 +1617,7 @@ Here's a list of all places you can inject your custom code:
To add a new section to the product form, you can use the following code:
```erb
- <div class="card mb-4">
+ <div class="card mb-6">
<div class="card-header">
<h5 class="card-title">ERP Integration</h5>
</div>
@@ -1673,7 +1673,7 @@ Here's a list of all places you can inject your custom code:
To add a new section to the product form sidebar, you can use the following code:
```erb
- <div class="card mb-4">
+ <div class="card mb-6">
<div class="card-header">
<h5 class="card-title">ERP Integration</h5>
</div>
@@ -1728,7 +1728,7 @@ Here's a list of all places you can inject your custom code:
To add a new section to the shipping method form, you can use the following code:
```erb
- <div class="card mb-4">
+ <div class="card mb-6">
<div class="card-header">
<h5 class="card-title">ERP Integration</h5>
</div>
@@ -1765,7 +1765,7 @@ Here's a list of all places you can inject your custom code:
To add a new section to the store form, you can use the following code:
```erb
- <div class="card mb-4">
+ <div class="card mb-6">
<div class="card-header">
<h5 class="card-title">ERP Integration</h5>
</div>
diff --git a/docs/developer/admin/form-builder.mdx b/docs/developer/admin/form-builder.mdx
index e8f3a01f90..ed749caaac 100644
--- a/docs/developer/admin/form-builder.mdx
+++ b/docs/developer/admin/form-builder.mdx
@@ -302,7 +302,7 @@ All common FormBuilder options (`:label`, `:required`, `:help`, `:help_bubble`)
Here's a complete example showing various FormBuilder methods:
```erb
-<div class="card mb-4">
+<div class="card mb-6">
<div class="card-header">
<h5 class="card-title">
<%= Spree.t(:general_settings) %>
diff --git a/docs/developer/tutorial/extending-models.mdx b/docs/developer/tutorial/extending-models.mdx
index 5a851de9a2..df15a486e2 100644
--- a/docs/developer/tutorial/extending-models.mdx
+++ b/docs/developer/tutorial/extending-models.mdx
@@ -171,7 +171,7 @@ Create a partial to inject the brand selector into the product form. Spree's adm
Create the partial:
```erb app/views/spree/admin/products/_brand_field.html.erb
-<div class="card mb-4">
+<div class="card mb-6">
<div class="card-header">
<h5 class="card-title"><%= Spree.t(:brand) %></h5>
</div>
diff --git a/docs/developer/tutorial/file-uploads.mdx b/docs/developer/tutorial/file-uploads.mdx
index 31bc37dc54..baef6f688a 100644
--- a/docs/developer/tutorial/file-uploads.mdx
+++ b/docs/developer/tutorial/file-uploads.mdx
@@ -59,7 +59,7 @@ Now let's add the file upload field to the brand form. Spree provides a `spree_f
Update your brand form partial:
```erb app/views/spree/admin/brands/_form.html.erb {11-19}
-<div class="card mb-4">
+<div class="card mb-6">
<div class="card-header">
<h5 class="card-title"><%= Spree.t(:general_settings) %></h5>
</div>
@@ -69,7 +69,7 @@ Update your brand form partial:
</div>
</div>
-<div class="card mb-4">
+<div class="card mb-6">
<div class="card-header">
<h5 class="card-title"><%= Spree.t(:logo) %></h5>
</div>
diff --git a/docs/developer/tutorial/rich-text.mdx b/docs/developer/tutorial/rich-text.mdx
index f57acabbbf..37b5d7b81d 100644
--- a/docs/developer/tutorial/rich-text.mdx
+++ b/docs/developer/tutorial/rich-text.mdx
@@ -43,7 +43,7 @@ brand.description.to_plain_text
In the Admin dashboard we want to use a WYSIWYG editor to add formatted text to the brand description. To do this, edit the `app/views/spree/admin/brands/_form.html.erb` file and add the following code:
```erb app/views/spree/admin/brands/_form.html.erb {4}
-<div class="card mb-4">
+<div class="card mb-6">
<div class="card-body">
<%= f.spree_text_field :name %>
<%= f.spree_rich_text_area :description %>
diff --git a/docs/developer/tutorial/seo.mdx b/docs/developer/tutorial/seo.mdx
index 20f6f9b2b3..e4ca47c6cf 100644
--- a/docs/developer/tutorial/seo.mdx
+++ b/docs/developer/tutorial/seo.mdx
@@ -78,7 +78,7 @@ Spree provides a reusable SEO partial that handles slug, meta title, and meta de
```erb app/views/spree/admin/brands/_form.html.erb {1-2,5-12,15,25-32}
<div class="row" data-controller="slug-form seo-form">
<div class="col-lg-8">
- <div class="card mb-4">
+ <div class="card mb-6">
<div class="card-body">
<%= f.spree_text_field :name,
required: true,
@@ -94,7 +94,7 @@ Spree provides a reusable SEO partial that handles slug, meta title, and meta de
</div>
<div class="col-lg-4">
- <div class="card mb-4">
+ <div class="card mb-6">
<div class="card-header">
<h5 class="card-title"><%= Spree.t(:logo) %></h5>
</div>