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
Store Policies (#13008)
Damian Legawiecb046a4631c02
diff --git a/admin/app/controllers/spree/admin/policies_controller.rb b/admin/app/controllers/spree/admin/policies_controller.rbnew file mode 100644index 0000000000..04956d5914--- /dev/null+++ b/admin/app/controllers/spree/admin/policies_controller.rb@@ -0,0 +1,21 @@+module Spree+ module Admin+ class PoliciesController < ResourceController+ add_breadcrumb Spree.t(:policies), :admin_policies_path++ private++ def collection+ super.order(:position)+ end++ def permitted_resource_params+ params.require(:policy).permit(permitted_policy_attributes)+ end++ def update_turbo_stream_enabled?+ true+ end+ end+ end+enddiff --git a/admin/app/helpers/spree/admin/base_helper.rb b/admin/app/helpers/spree/admin/base_helper.rbindex cbf93aa46f..7ba17d8341 100644--- a/admin/app/helpers/spree/admin/base_helper.rb+++ b/admin/app/helpers/spree/admin/base_helper.rb@@ -38,7 +38,7 @@ module Spree@settings_active || %w[admin_users audits custom_domains exports imports invitations oauth_applicationspayment_methods refund_reasons reimbursement_types return_authorization_reasons rolesshipping_categories shipping_methods stock_locations store_credit_categories- stores tax_categories tax_rates webhooks webhooks_subscribers zones].include?(controller_name)+ stores tax_categories tax_rates webhooks webhooks_subscribers zones policies].include?(controller_name)end# @return [Array<String>] the available countries for checkoutdiff --git a/admin/app/helpers/spree/admin/page_builder_helper.rb b/admin/app/helpers/spree/admin/page_builder_helper.rbindex 1329f0f5f8..566bca67fa 100644--- a/admin/app/helpers/spree/admin/page_builder_helper.rb+++ b/admin/app/helpers/spree/admin/page_builder_helper.rb@@ -88,12 +88,7 @@ module Spreeenddef all_linkable_policies- @all_linkable_policies = [- current_store.customer_privacy_policy,- current_store.customer_terms_of_service,- current_store.customer_returns_policy,- current_store.customer_shipping_policy- ].compact.map { |policy| [policy.name.humanize, policy.id] }+ @all_linkable_policies ||= current_store.policies.pluck(:name, :id)enddef refresh_theme_preview(section = nil, block = nil)diff --git a/admin/app/views/spree/admin/customer_returns/_table_header.html.erb b/admin/app/views/spree/admin/customer_returns/_table_header.html.erbindex cc78dd4d8c..b003d6454a 100644--- a/admin/app/views/spree/admin/customer_returns/_table_header.html.erb+++ b/admin/app/views/spree/admin/customer_returns/_table_header.html.erb@@ -1,4 +1,4 @@-<tr data-hook="rate_header">+<tr><th scope="col"><%= Spree.t(:number) %></th><th scope="col"><%= Spree.t(:created_at) %></th><th scope="col"><%= Spree.t(:customer) %></th>diff --git a/admin/app/views/spree/admin/page_links/_linkable_type_dropdown.html.erb b/admin/app/views/spree/admin/page_links/_linkable_type_dropdown.html.erbindex a5cac7dfcd..9a64010a01 100644--- a/admin/app/views/spree/admin/page_links/_linkable_type_dropdown.html.erb+++ b/admin/app/views/spree/admin/page_links/_linkable_type_dropdown.html.erb@@ -5,9 +5,9 @@<% elsif page_link.linkable_type == 'Spree::Post' %><%= tom_select_tag "#{form_name}[linkable_id]", class: 'w-100', url: spree.select_options_admin_posts_path(format: :json), active_option: page_link.linkable_id, select_data: { action: 'auto-submit#submit' } %><% elsif page_link.linkable_type == 'Spree::Page' %>- <%= select_tag "#{form_name}[linkable_id]", options_for_select(all_linkable_pages, page_link.linkable_id), { class: 'custom-select', data: { action: 'auto-submit#submit' } } %>-<% elsif page_link.linkable_type == 'ActionText::RichText' %>- <%= select_tag "#{form_name}[linkable_id]", options_for_select(all_linkable_policies, page_link.linkable_id), { class: 'custom-select', data: { action: 'auto-submit#submit' } } %>+ <%= select_tag "#{form_name}[linkable_id]", options_for_select(all_linkable_pages, page_link.linkable_id), { data: { controller: 'autocomplete-select', action: 'auto-submit#submit' } } %>+<% elsif page_link.linkable_type == 'Spree::Policy' %>+ <%= select_tag "#{form_name}[linkable_id]", options_for_select(all_linkable_policies, page_link.linkable_id), { data: { controller: 'autocomplete-select', action: 'auto-submit#submit' } } %><% elsif page_link.linkable_type == 'Spree::Vendor' %><%= tom_select_tag "#{form_name}[linkable_id]", class: 'w-100', url: spree.select_options_admin_vendors_path(format: :json), active_option: page_link.linkable_id, select_data: { action: 'auto-submit#submit' } %><% else %>diff --git a/admin/app/views/spree/admin/payments/source_views/_storecredit.html.erb b/admin/app/views/spree/admin/payments/source_views/_storecredit.html.erbindex 10fbdb8957..6d621ac7d1 100644--- a/admin/app/views/spree/admin/payments/source_views/_storecredit.html.erb+++ b/admin/app/views/spree/admin/payments/source_views/_storecredit.html.erb@@ -1,4 +1,4 @@-<fieldset data-hook="store_credit">+<fieldset><legend><%= Spree.t(:store_credits) %></legend><div class="table-responsive border rounded bg-white"><table class="table table-condensed border rounded">diff --git a/admin/app/views/spree/admin/policies/_form.html.erb b/admin/app/views/spree/admin/policies/_form.html.erbnew file mode 100644index 0000000000..5f71a1adff--- /dev/null+++ b/admin/app/views/spree/admin/policies/_form.html.erb@@ -0,0 +1,8 @@+<div class="card mb-4">+ <div class="card-body" data-controller="slug-form">+ <%= f.spree_text_field :name, required: true, autofocus: f.object.new_record?, data: { slug_form_target: 'name', action: 'slug-form#updateUrlFromName' } %>+ <%= f.spree_text_field :slug, required: true, data: { slug_form_target: 'url' } %>+ <%= f.spree_rich_text_area :body %>+ <%= f.spree_check_box :show_in_checkout_footer %>+ </div>+</div>\ No newline at end of filediff --git a/admin/app/views/spree/admin/policies/_table_header.html.erb b/admin/app/views/spree/admin/policies/_table_header.html.erbnew file mode 100644index 0000000000..5b41229976--- /dev/null+++ b/admin/app/views/spree/admin/policies/_table_header.html.erb@@ -0,0 +1,8 @@+<tr>+ <th scope="col"></th>+ <th scope="col"><%= Spree.t(:name) %></th>+ <th scope="col"><%= Spree.t(:slug) %></th>+ <th scope="col"><%= I18n.t('activerecord.attributes.spree/policy.show_in_checkout_footer') %></th>+ <th scope="col"><%= Spree.t(:updated_at) %></th>+ <th scope="col"></th>+</tr>\ No newline at end of filediff --git a/admin/app/views/spree/admin/policies/_table_row.html.erb b/admin/app/views/spree/admin/policies/_table_row.html.erbnew file mode 100644index 0000000000..6e5dfcb25f--- /dev/null+++ b/admin/app/views/spree/admin/policies/_table_row.html.erb@@ -0,0 +1,20 @@+<tr id="<%= spree_dom_id policy %>" data-controller="row-link" data-sortable-update-url="<%= spree.admin_policy_path(policy) %>">+ <td class="w-10 move-handle text-center">+ <%= icon('grip-vertical', class: 'rounded hover-gray p-2') %>+ </td>+ <td class="w-30 cursor-pointer" data-action="click->row-link#openLink">+ <%= policy.name %>+ </td>+ <td class="w-30 cursor-pointer" data-action="click->row-link#openLink">+ <%= link_to policy.slug, spree.edit_admin_policy_path(policy), class: 'text-decoration-none d-flex align-items-center font-weight-bold text-dark', data: { row_link_target: :link, turbo_frame: '_top' } %>+ </td>+ <td class="w-10 cursor-pointer" data-action="click->row-link#openLink">+ <%= active_badge(policy.show_in_checkout_footer) %>+ </td>+ <td class="w-10 cursor-pointer" data-action="click->row-link#openLink">+ <%= spree_time(policy.updated_at) %>+ </td>+ <td class="w-10 actions">+ <%= link_to_edit(policy, class: 'btn btn-light btn-sm', data: { turbo_frame: '_top' }) if can?(:edit, policy) %>+ </td>+</tr>\ No newline at end of filediff --git a/admin/app/views/spree/admin/policies/edit.html.erb b/admin/app/views/spree/admin/policies/edit.html.erbnew file mode 100644index 0000000000..ed808fbbca--- /dev/null+++ b/admin/app/views/spree/admin/policies/edit.html.erb@@ -0,0 +1,5 @@+<% content_for :page_actions_dropdown do %>+ <%= link_to_edit_translations(@policy) %>+<% end %>++<%= render 'spree/admin/shared/edit_resource' %>diff --git a/admin/app/views/spree/admin/policies/index.html.erb b/admin/app/views/spree/admin/policies/index.html.erbnew file mode 100644index 0000000000..c15f7cb6aa--- /dev/null+++ b/admin/app/views/spree/admin/policies/index.html.erb@@ -0,0 +1,9 @@+<%= content_for :page_title do %>+ <%= Spree.t(:policies) %>+<% end %>++<% content_for :page_actions do %>+ <%= link_to_with_icon 'plus', Spree.t(:new_policy), new_object_url, class: 'btn btn-primary' if can?(:create, Spree::Policy) %>+<% end %>++<%= render 'spree/admin/shared/index_table', sortable: true %>\ No newline at end of filediff --git a/admin/app/views/spree/admin/policies/new.html.erb b/admin/app/views/spree/admin/policies/new.html.erbnew file mode 100644index 0000000000..0fd3668cab--- /dev/null+++ b/admin/app/views/spree/admin/policies/new.html.erb@@ -0,0 +1 @@+<%= render 'spree/admin/shared/new_resource' %>\ No newline at end of filediff --git a/admin/app/views/spree/admin/policies/update.turbo_stream.erb b/admin/app/views/spree/admin/policies/update.turbo_stream.erbnew file mode 100644index 0000000000..d9fb79328e--- /dev/null+++ b/admin/app/views/spree/admin/policies/update.turbo_stream.erb@@ -0,0 +1 @@+<%= turbo_render_alerts %>\ No newline at end of filediff --git a/admin/app/views/spree/admin/shared/sidebar/_store_nav.html.erb b/admin/app/views/spree/admin/shared/sidebar/_store_nav.html.erbindex e5e6820536..2f10c3f24a 100644--- a/admin/app/views/spree/admin/shared/sidebar/_store_nav.html.erb+++ b/admin/app/views/spree/admin/shared/sidebar/_store_nav.html.erb@@ -10,7 +10,7 @@<% if can?(:manage, current_store) %><%= nav_item(Spree.t(:emails), spree.edit_admin_store_path(section: 'emails'), icon: 'send', active: params[:section] == 'emails') %>- <%= nav_item(Spree.t(:policies), spree.edit_admin_store_path(section: 'policies'), icon: 'list-check', active: params[:section] == 'policies') %>+ <%= nav_item(Spree.t(:policies), spree.admin_policies_path, icon: 'list-check') if can?(:manage, Spree::Policy) %><%= nav_item(Spree.t(:checkout), spree.edit_admin_store_path(section: 'checkout'), icon: 'shopping-cart', active: params[:section] == 'checkout') %><%= render_admin_partials(:store_settings_nav_partials) %><% end %>diff --git a/admin/app/views/spree/admin/stores/form/_checkout.html.erb b/admin/app/views/spree/admin/stores/form/_checkout.html.erbindex 50a1d3622e..9cfbb211ad 100644--- a/admin/app/views/spree/admin/stores/form/_checkout.html.erb+++ b/admin/app/views/spree/admin/stores/form/_checkout.html.erb@@ -4,7 +4,7 @@<div class="alert alert-info mb-3"><p>- <%= Spree.t('admin.checkout_settings.policy_copy', policies_link: link_to(Spree.t(:policies), spree.edit_admin_store_path + '?section=policies', class: 'alert-link')).html_safe %>+ <%= Spree.t('admin.checkout_settings.policy_copy', policies_link: link_to(Spree.t(:policies), spree.admin_policies_path, class: 'alert-link')).html_safe %></p></div>diff --git a/admin/app/views/spree/admin/tax_rates/_table_header.html.erb b/admin/app/views/spree/admin/tax_rates/_table_header.html.erbindex 28b8f00d7a..6a97dedfdb 100644--- a/admin/app/views/spree/admin/tax_rates/_table_header.html.erb+++ b/admin/app/views/spree/admin/tax_rates/_table_header.html.erb@@ -1,4 +1,4 @@-<tr data-hook="rate_header">+<tr><th scope="col"><%= sort_link search_collection, :name, Spree.t(:name) %></th><th scope="col"><%= Spree.t(:tax_category) %></th><th scope="col"><%= Spree.t(:zone) %></th>diff --git a/admin/app/views/spree/admin/translations/edit.html.erb b/admin/app/views/spree/admin/translations/edit.html.erbindex 11d22b4195..8b1c9dbcc8 100644--- a/admin/app/views/spree/admin/translations/edit.html.erb+++ b/admin/app/views/spree/admin/translations/edit.html.erb@@ -39,6 +39,8 @@<%= render 'spree/admin/translations/taxons/form', options %><% when 'Spree::Taxonomy' %><%= render 'spree/admin/translations/taxonomies/form', options %>+ <% when 'Spree::Policy' %>+ <%= render 'spree/admin/translations/policies/form', options %><% end %></tbody></table>diff --git a/admin/app/views/spree/admin/translations/policies/_form.html.erb b/admin/app/views/spree/admin/translations/policies/_form.html.erbnew file mode 100644index 0000000000..4141f65ebc--- /dev/null+++ b/admin/app/views/spree/admin/translations/policies/_form.html.erb@@ -0,0 +1,12 @@+<%# locals: (f:, resource:, locale:) %>++<% resource.class.translatable_fields.each do |field| %>+ <% case field %>+ <% when :name %>+ <%= render "spree/admin/translations/translation_rows/text_field_row", f: f, field: field, locale: locale %>+ <% when :body %>+ <%= render "spree/admin/translations/translation_rows/rich_textarea_row", f: f, field: field, locale: locale %>+ <% else %>+ <%= render "spree/admin/translations/translation_rows/text_field_row", f: f, field: field, locale: locale %>+ <% end %>+<% end %>\ No newline at end of filediff --git a/admin/config/routes.rb b/admin/config/routes.rbindex 81dc5e91ff..b580bca952 100644--- a/admin/config/routes.rb+++ b/admin/config/routes.rb@@ -156,6 +156,7 @@ Spree::Core::Engine.add_routes doresources :stores, only: [:new, :create] doresources :role_users, only: [:destroy]end+ resources :policies, except: :showresources :payment_methods, except: :showresources :shipping_methods, except: :showresources :shipping_categories, except: :showdiff --git a/admin/lib/spree/admin/runtime_configuration.rb b/admin/lib/spree/admin/runtime_configuration.rbindex 594579a8cd..d0e44bfc32 100644--- a/admin/lib/spree/admin/runtime_configuration.rb+++ b/admin/lib/spree/admin/runtime_configuration.rb@@ -1,3 +1,6 @@+require 'spree/core/preferences/runtime_configuration'+require 'kaminari'+module Spreemodule Adminclass RuntimeConfiguration < ::Spree::Preferences::RuntimeConfigurationdiff --git a/api/app/controllers/spree/api/v2/storefront/policies_controller.rb b/api/app/controllers/spree/api/v2/storefront/policies_controller.rbnew file mode 100644index 0000000000..4f8644ad37--- /dev/null+++ b/api/app/controllers/spree/api/v2/storefront/policies_controller.rb@@ -0,0 +1,31 @@+module Spree+ module Api+ module V2+ module Storefront+ class PoliciesController < ::Spree::Api::V2::ResourceController+ private++ def collection_serializer+ Spree::Api::Dependencies.storefront_policy_serializer.constantize+ end++ def resource_serializer+ Spree::Api::Dependencies.storefront_policy_serializer.constantize+ end++ def resource+ @resource ||= find_with_fallback_default_locale { scope.find_by(slug: params[:id]) } || scope.find(params[:id])+ end++ def model_class+ Spree::Policy+ end++ def scope_includes+ [:rich_text_translations]+ end+ end+ end+ end+ end+enddiff --git a/api/app/serializers/spree/v2/storefront/policy_serializer.rb b/api/app/serializers/spree/v2/storefront/policy_serializer.rbnew file mode 100644index 0000000000..5213aeb964--- /dev/null+++ b/api/app/serializers/spree/v2/storefront/policy_serializer.rb@@ -0,0 +1,19 @@+module Spree+ module V2+ module Storefront+ class PolicySerializer < BaseSerializer+ set_type :policy++ attributes :name, :slug, :show_in_checkout_footer, :created_at, :updated_at++ attribute :body do |object|+ object.body.to_plain_text+ end++ attribute :body_html do |object|+ object.body.to_s+ end+ end+ end+ end+enddiff --git a/api/config/routes.rb b/api/config/routes.rbindex 4309960131..88b3f4132c 100644--- a/api/config/routes.rb+++ b/api/config/routes.rb@@ -53,6 +53,7 @@ Spree::Core::Engine.add_routes doresources :menus, only: %i[index show]resources :cms_pages, only: %i[index show]+ resources :policies, only: %i[index show]resources :wishlists doget :default, on: :collectiondiff --git a/api/lib/spree/api/dependencies.rb b/api/lib/spree/api/dependencies.rbindex 4d48402737..f972550867 100644--- a/api/lib/spree/api/dependencies.rb+++ b/api/lib/spree/api/dependencies.rb@@ -65,6 +65,7 @@ module Spreestorefront_product_serializer: 'Spree::V2::Storefront::ProductSerializer',storefront_estimated_shipment_serializer: 'Spree::V2::Storefront::EstimatedShippingRateSerializer',storefront_store_serializer: 'Spree::V2::Storefront::StoreSerializer',+ storefront_policy_serializer: 'Spree::V2::Storefront::PolicySerializer',storefront_order_serializer: 'Spree::V2::Storefront::OrderSerializer',storefront_variant_serializer: 'Spree::V2::Storefront::VariantSerializer',diff --git a/api/spec/requests/spree/api/v2/storefront/policies_spec.rb b/api/spec/requests/spree/api/v2/storefront/policies_spec.rbnew file mode 100644index 0000000000..63d2cc35b1--- /dev/null+++ b/api/spec/requests/spree/api/v2/storefront/policies_spec.rb@@ -0,0 +1,106 @@+require 'spec_helper'++describe 'Storefront API v2 Policies spec', type: :request do+ let(:store) { Spree::Store.default }+ let(:other_store) { create(:store, name: 'Other Store') }+ let!(:policy) { store.policies.first }++ before do+ allow_any_instance_of(Spree::Api::V2::Storefront::PoliciesController).to receive(:current_store).and_return(store)+ end++ describe 'policies#index' do+ let!(:other_store_policy) { create(:policy, slug: 'other-store-policy', store: other_store) }++ before { get '/api/v2/storefront/policies' }++ it 'returns policies for current store' do+ expect(json_response['data'].count).to eq(4)+ policy_names = json_response['data'].map { |p| p['attributes']['name'] }+ expect(policy_names).to include('Privacy Policy', 'Terms of Service', 'Returns Policy', 'Shipping Policy')+ expect(policy_names).not_to include('My Policy') # other store policy+ end+ end++ describe 'policies#show' do+ context 'with slug param' do+ before { get "/api/v2/storefront/policies/#{policy.slug}" }++ it 'returns policy with attributes' do+ expect(json_response['data']['id']).to eq(policy.id.to_s)+ expect(json_response['data']['type']).to eq('policy')+ expect(json_response['data']['attributes']['name']).to eq(policy.name)+ expect(json_response['data']['attributes']['slug']).to eq(policy.slug)+ expect(json_response['data']['attributes']['show_in_checkout_footer']).to eq(policy.show_in_checkout_footer)+ expect(json_response['data']['attributes']['body']).to eq(policy.body.to_plain_text)+ expect(json_response['data']['attributes']['body_html']).to eq(policy.body.to_s)+ expect(json_response['data']['attributes']['created_at']).to be_present+ expect(json_response['data']['attributes']['updated_at']).to be_present+ end+ end++ context 'with id param' do+ before { get "/api/v2/storefront/policies/#{policy.id}" }++ it 'returns policy with attributes' do+ expect(response.status).to eq(200)+ expect(json_response['data']['id']).to eq(policy.id.to_s)+ end+ end++ context 'with locale set to pl' do+ let!(:localized_policy) do+ policy = create(:policy, store: store, slug: 'localized-policy', name: 'Privacy Policy EN')++ I18n.with_locale(:pl) do+ policy.name = 'Polityka Prywatności'+ policy.body = 'To jest polityka prywatności'+ policy.save!+ end++ policy+ end++ before do+ store.update!(supported_locales: 'en,pl')+ get "/api/v2/storefront/policies/#{localized_policy.slug}?locale=pl"+ end++ after do+ I18n.locale = :en+ store.update!(supported_locales: 'en')+ end++ it 'returns policy with translated attributes' do+ expect(json_response['data']).to have_attribute(:name).with_value('Polityka Prywatności')+ expect(json_response['data']).to have_attribute(:body).with_value('To jest polityka prywatności')+ end+ end++ context 'with invalid slug param' do+ before { get '/api/v2/storefront/policies/non-existent-policy' }++ it 'returns error' do+ expect(json_response['error']).to eq('The resource you were looking for could not be found.')+ end+ end++ context 'with invalid id param' do+ before { get '/api/v2/storefront/policies/999999' }++ it 'returns error' do+ expect(json_response['error']).to eq('The resource you were looking for could not be found.')+ end+ end++ context 'accessing policy from different store' do+ let(:other_store_policy) { create(:policy, store: other_store, slug: 'other-policy') }++ before { get "/api/v2/storefront/policies/#{other_store_policy.slug}" }++ it 'returns error when policy belongs to different store' do+ expect(json_response['error']).to eq('The resource you were looking for could not be found.')+ end+ end+ end+enddiff --git a/core/app/models/concerns/spree/has_one_link.rb b/core/app/models/concerns/spree/has_one_link.rbindex 7ad2be4973..1923aa9c65 100644--- a/core/app/models/concerns/spree/has_one_link.rb+++ b/core/app/models/concerns/spree/has_one_link.rb@@ -12,7 +12,7 @@ module Spree[Spree.t(:product), 'Spree::Product'],[Spree.t(:post), 'Spree::Post'],[Spree.t(:taxon), 'Spree::Taxon'],- [Spree.t(:policy), 'ActionText::RichText'],+ [Spree.t(:policy), 'Spree::Policy'],[Spree.t(:url), nil]]enddiff --git a/core/app/models/concerns/spree/has_page_links.rb b/core/app/models/concerns/spree/has_page_links.rbindex 5c4c356064..a7cce76bfe 100644--- a/core/app/models/concerns/spree/has_page_links.rb+++ b/core/app/models/concerns/spree/has_page_links.rb@@ -17,7 +17,7 @@ module Spree[Spree.t(:product), 'Spree::Product'],[Spree.t(:post), 'Spree::Post'],[Spree.t(:taxon), 'Spree::Taxon'],- [Spree.t(:policy), 'ActionText::RichText'],+ [Spree.t(:policy), 'Spree::Policy'],[Spree.t(:url), nil]]enddiff --git a/core/app/models/spree/ability.rb b/core/app/models/spree/ability.rbindex e986dade12..f8bb58d812 100644--- a/core/app/models/spree/ability.rb+++ b/core/app/models/spree/ability.rb@@ -99,6 +99,8 @@ module Spreewished_item.wishlist.user == userendcan :accept, Spree::Invitation, invitee_id: [user.id, nil], invitee_type: user.class.name, status: 'pending'+ can :read, ::Spree::Policy+ can :read, ::Spree::Pageenddef protect_admin_rolediff --git a/core/app/models/spree/base.rb b/core/app/models/spree/base.rbindex 391351cfc4..0102cea743 100644--- a/core/app/models/spree/base.rb+++ b/core/app/models/spree/base.rb@@ -87,7 +87,7 @@ class Spree::Base < ApplicationRecord# Try building a slug based on the following fields in increasing order of specificity.def slug_candidates- if defined?(:deleted_at) && deleted_at.present?+ if defined?(deleted_at) && deleted_at.present?[['deleted', :name],['deleted', :name, :uuid_for_friendly_id]diff --git a/core/app/models/spree/page_sections/footer.rb b/core/app/models/spree/page_sections/footer.rbindex 9370c2b1e9..b47609c38e 100644--- a/core/app/models/spree/page_sections/footer.rb+++ b/core/app/models/spree/page_sections/footer.rb@@ -48,16 +48,32 @@ module Spreeshop_default_links << Spree::PageLink.new(linkable: new_arrivals_collection) if new_arrivals_collection.present?end+ default_info_links = []++ if store.policies.find_by(name: Spree.t('terms_of_service')).present?+ default_info_links << Spree::PageLink.new(+ label: Spree.t('terms_of_service'),+ linkable: store.policies.find_by(name: Spree.t('terms_of_service'))+ )+ end++ if store.policies.find_by(name: Spree.t('privacy_policy')).present?+ default_info_links << Spree::PageLink.new(+ label: Spree.t('privacy_policy'),+ linkable: store.policies.find_by(name: Spree.t('privacy_policy'))+ )+ end+[Spree::PageBlocks::Nav.new(preferred_label: 'Shop',default_links: shop_default_links),Spree::PageBlocks::Nav.new(- preferred_label: 'Account',+ preferred_label: Spree.t('account'),default_links: [Spree::PageLink.new(- label: 'My Account',+ label: Spree.t('my_account'),linkable: pages.find_by(type: 'Spree::Pages::Account')),Spree::PageLink.new(@@ -72,17 +88,8 @@ module Spree),Spree::PageBlocks::Nav.new(preferred_label: 'Info',- default_links: [- Spree::PageLink.new(- label: 'Privacy Policy',- linkable: store.customer_privacy_policy- ),- Spree::PageLink.new(- label: 'Terms of Service',- linkable: store.customer_terms_of_service- ),- ]- ),+ default_links: default_info_links+ )]enddiff --git a/core/app/models/spree/policy.rb b/core/app/models/spree/policy.rbnew file mode 100644index 0000000000..fd70925954--- /dev/null+++ b/core/app/models/spree/policy.rb@@ -0,0 +1,47 @@+module Spree+ class Policy < Spree.base_class+ extend FriendlyId+ include Spree::SingleStoreResource+ include Spree::TranslatableResource++ acts_as_list scope: %i[store_id]++ #+ # FriendlyId+ #+ friendly_id :slug_candidates, use: %i[slugged scoped history], scope: %i[store_id]++ #+ # Associations+ #+ belongs_to :store, class_name: 'Spree::Store', touch: true++ #+ # Translations+ #+ TRANSLATABLE_FIELDS = %i[name body].freeze+ translates(*TRANSLATABLE_FIELDS, column_fallback: !Spree.always_use_translations?)++ #+ # ActionText+ #+ translates :body, backend: :action_text++ #+ # Validations+ #+ validates :slug, presence: true, uniqueness: { scope: %i[store_id] }+ validates :name, :body, presence: true+ validates :show_in_checkout_footer, inclusion: { in: [true, false] }++ #+ # Scopes+ #+ scope :show_in_checkout_footer, -> { where(show_in_checkout_footer: true) }++ #+ # Ransack+ #+ self.whitelisted_ransackable_attributes = %w[name show_in_checkout_footer]+ end+enddiff --git a/core/app/models/spree/store.rb b/core/app/models/spree/store.rbindex 9acadc03a2..20968fc074 100644--- a/core/app/models/spree/store.rb+++ b/core/app/models/spree/store.rb@@ -111,6 +111,8 @@ module Spreehas_many :gift_cards, class_name: 'Spree::GiftCard', dependent: :destroy+ has_many :policies, class_name: 'Spree::Policy', dependent: :destroy+## Page Builder associations#@@ -185,6 +187,7 @@ module Spreeafter_create :import_products_from_store, if: -> { import_products_from_store_id.present? }after_create :import_payment_methods_from_store, if: -> { import_payment_methods_from_store_id.present? }after_create :create_default_theme+ after_create :create_default_policiesbefore_destroy :validate_not_last, unless: :skip_validate_not_lastbefore_destroy :pass_default_flag_to_other_storeafter_commit :clear_cache@@ -403,6 +406,14 @@ module SpreeStorePaymentMethod.insert_all(payment_method_ids.map { |payment_method_id| { store_id: id, payment_method_id: payment_method_id } })end+ %w[customer_terms_of_service customer_privacy_policy customer_returns_policy customer_shipping_policy].each do |policy_method|+ define_method policy_method do+ Spree::Deprecation.warn("Store##{policy_method} is deprecated and will be removed in Spree 6.0. Please use Store#policies instead.")++ ActionText::RichText.find_by(name: policy_method, record: self)+ end+ end+privatedef countries_available_for_checkout_cache_key@@ -496,6 +507,25 @@ module Spreepost_categories.find_or_create_by(title: Spree.t('default_post_categories.news'))end+ def create_default_policies+ policies.find_or_initialize_by(name: Spree.t('terms_of_service')) do |policy|+ policy.body = Spree.t('terms_of_service')+ policy.save!+ end+ policies.find_or_initialize_by(name: Spree.t('privacy_policy')) do |policy|+ policy.body = Spree.t('privacy_policy')+ policy.save!+ end+ policies.find_or_initialize_by(name: Spree.t('returns_policy')) do |policy|+ policy.body = Spree.t('returns_policy')+ policy.save!+ end+ policies.find_or_initialize_by(name: Spree.t('shipping_policy')) do |policy|+ policy.body = Spree.t('shipping_policy')+ policy.save!+ end+ end+# code is slug, so we don't want to generate new slug when code changes# we use friendlyId only for history featuredef should_generate_new_friendly_id?diff --git a/core/config/locales/en.yml b/core/config/locales/en.ymlindex 629f90e363..cf7fd5d7dd 100644--- a/core/config/locales/en.yml+++ b/core/config/locales/en.yml@@ -101,6 +101,9 @@ en:number: Numberspree/payment_method:name: Name+ spree/policy:+ body: Body+ show_in_checkout_footer: Show in checkout footerspree/product:available_on: Available Oncost_currency: Cost Currency@@ -1312,6 +1315,7 @@ en:new_password: New passwordnew_payment: New Paymentnew_payment_method: New Payment Method+ new_policy: New Policynew_post: New Postnew_post_category: New Post Categorynew_product: New Productdiff --git a/core/db/migrate/20250811112056_create_spree_policies.rb b/core/db/migrate/20250811112056_create_spree_policies.rbnew file mode 100644index 0000000000..2e5de3dab3--- /dev/null+++ b/core/db/migrate/20250811112056_create_spree_policies.rb@@ -0,0 +1,26 @@+class CreateSpreePolicies < ActiveRecord::Migration[7.2]+ def change+ create_table :spree_policies do |t|+ t.belongs_to :store, null: false+ t.string :slug, null: false+ t.string :name, null: false+ t.boolean :show_in_checkout_footer, null: false, default: true+ t.integer :position, null: false, default: 0++ t.timestamps+ end++ add_index :spree_policies, [:store_id, :slug], unique: true+ add_index :spree_policies, [:store_id, :show_in_checkout_footer]+ add_index :spree_policies, [:store_id, :position]+ create_table :spree_policy_translations do |t|+ t.string :locale, null: false+ t.string :name+ t.references :spree_policy, null: false++ t.timestamps+ end++ add_index :spree_policy_translations, [:spree_policy_id, :locale], unique: true+ end+enddiff --git a/core/lib/spree/core/engine.rb b/core/lib/spree/core/engine.rbindex 073e766bbe..94fce23f73 100644--- a/core/lib/spree/core/engine.rb+++ b/core/lib/spree/core/engine.rb@@ -247,7 +247,8 @@ module SpreeSpree::Property,Spree::Taxon,Spree::Taxonomy,- Spree::Store+ Spree::Store,+ Spree::Policy]Rails.application.config.spree.analytics_events = {diff --git a/core/lib/spree/permitted_attributes.rb b/core/lib/spree/permitted_attributes.rbindex 7a988557c7..fc801e4893 100644--- a/core/lib/spree/permitted_attributes.rb+++ b/core/lib/spree/permitted_attributes.rb@@ -29,6 +29,7 @@ module Spree:page_section_attributes,:payment_attributes,:payment_method_attributes,+ :policy_attributes,:post_attributes,:post_category_attributes,:product_attributes,@@ -143,6 +144,8 @@ module Spree@@payment_method_attributes = [:name, :type, :description, :active, :display_on, :auto_capture, :position]+ @@policy_attributes = [:name, :slug, :body, :show_in_checkout_footer, :position]+@@post_attributes = [:title, :meta_title, :meta_description, :slug, :author_id, :post_category_id, :published_at, :content, :excerpt, :image, tag_list: []]@@post_category_attributes = [:title, :slug, :description]diff --git a/core/lib/spree/testing_support/factories/policy_factory.rb b/core/lib/spree/testing_support/factories/policy_factory.rbnew file mode 100644index 0000000000..19ec1080bb--- /dev/null+++ b/core/lib/spree/testing_support/factories/policy_factory.rb@@ -0,0 +1,9 @@+FactoryBot.define do+ factory :policy, class: 'Spree::Policy' do+ store { Spree::Store.default }+ slug { 'my-policy' }+ name { 'My Policy' }+ show_in_checkout_footer { true }+ body { 'This is the my policy' }+ end+enddiff --git a/core/lib/tasks/core.rake b/core/lib/tasks/core.rakeindex 3ce4f2f90a..fa574d2793 100644--- a/core/lib/tasks/core.rake+++ b/core/lib/tasks/core.rake@@ -192,6 +192,60 @@ use rake db:load_file[/absolute/path/to/sample/filename.rb]}endendend++ desc 'Migrate policies to store policies'+ task migrate_policies_to_store_policies: :environment do |_t, _args|+ # Helper to consistently derive policy name+ derive_policy_name = lambda do |name_str|+ name_str.to_s.gsub(/customer_/, '').gsub(/_policy$/, '')+ end++ # Check if migration has already been run+ if Spree::Policy.any?+ puts "Policies already exist. Skipping migration to prevent duplicates."+ exit+ end++ Spree::Store.all.each do |store|+ %w[customer_terms_of_service customer_privacy_policy customer_returns_policy customer_shipping_policy].each do |policy_slug|+ policy = store.send(policy_slug)+ next unless policy.present?++ store.policies.create(+ name: Spree.t(derive_policy_name.call(policy_slug)),+ body: policy.body+ )++ puts "Migrated #{policy_slug} to store #{store.id}"+ end+ end++ Spree::PageLink.where(linkable_type: 'ActionText::RichText').each do |page_link|+ # Check if this page link is attached to ActionText content+ # Find the ActionText record+ action_text = ActionText::RichText.find_by(id: page_link.linkable_id)+ next unless action_text++ # Check if the ActionText belongs to a store policy+ if action_text.record_type == 'Spree::Store' && action_text.name.to_s.include?('policy')+ # Find the corresponding policy in the new policies system+ store = action_text.record+ policy_name = derive_policy_name.call(action_text.name)++ policy = store.policies.find_by(name: Spree.t(policy_name))++ if policy+ # Update the page link to point to the policy instead+ page_link.update!(+ linked_resource_type: 'Spree::Policy',+ linked_resource_id: policy.id+ )++ puts "Migrated #{policy_name} to store #{store.id}"+ end+ end+ end+ endendnamespace :core dodiff --git a/core/spec/models/spree/policy_spec.rb b/core/spec/models/spree/policy_spec.rbnew file mode 100644index 0000000000..6a389bf061--- /dev/null+++ b/core/spec/models/spree/policy_spec.rb@@ -0,0 +1,80 @@+require 'spec_helper'++RSpec.describe Spree::Policy, type: :model do+ let(:store) { Spree::Store.default }+ let(:policy) { create(:policy, store: store) }++ describe 'validations' do+ context 'slug uniqueness' do+ before { policy }++ it 'allows same slug for different stores' do+ other_store = create(:store)+ other_policy = create(:policy, store: other_store, slug: policy.slug)+ expect(other_policy.slug).to eq(policy.slug)+ end+ end+ end++ describe 'friendly_id' do+ it 'generates friendly URLs from slug' do+ policy = create(:policy, slug: 'my-policy')+ expect(policy.to_param).to eq('my-policy')+ end++ it 'maintains slug history' do+ policy = create(:policy, slug: 'old-slug')+ policy.update(slug: 'new-slug')++ expect(policy.to_param).to eq('new-slug')+ expect(policy.friendly_id_config.uses?(:history)).to be true+ end+ end++ describe 'translations' do+ it 'has translatable name field' do+ expect(described_class::TRANSLATABLE_FIELDS).to include(:name)+ end++ it 'supports translations for name' do+ policy = create(:policy, name: 'Privacy Policy')++ I18n.with_locale(:es) do+ policy.name = 'Política de Privacidad'+ policy.body = 'Política de Privacidad'+ policy.save!+ end++ expect(policy.name).to eq('Privacy Policy')+ I18n.with_locale(:es) do+ expect(policy.name).to eq('Política de Privacidad')+ expect(policy.body.to_plain_text).to eq('Política de Privacidad')+ end+ end+ end++ describe 'scopes' do+ describe '.show_in_checkout_footer' do+ let!(:visible_policy) { create(:policy, show_in_checkout_footer: true) }+ let!(:hidden_policy) { create(:policy, show_in_checkout_footer: false) }++ it 'returns only policies that should be shown in checkout footer' do+ result = described_class.show_in_checkout_footer+ expect(result).to include(visible_policy)+ expect(result).not_to include(hidden_policy)+ end+ end++ describe '.for_store' do+ let(:other_store) { create(:store) }+ let!(:store1_policy) { create(:policy, store: store) }+ let!(:store2_policy) { create(:policy, store: other_store) }++ it 'returns policies for specific store' do+ result = described_class.for_store(store)+ expect(result).to include(store1_policy)+ expect(result).not_to include(store2_policy)+ end+ end+ end+enddiff --git a/storefront/app/controllers/spree/policies_controller.rb b/storefront/app/controllers/spree/policies_controller.rbindex 335086e07b..ee78820d16 100644--- a/storefront/app/controllers/spree/policies_controller.rb+++ b/storefront/app/controllers/spree/policies_controller.rb@@ -1,26 +1,8 @@module Spreeclass PoliciesController < StoreController+ # GET /policies/<policy_slug>def show- if params[:id].in?(supported_policies)- @policy = case params[:id]- when 'privacy_policy'- current_store.customer_privacy_policy- when 'terms_of_service'- current_store.customer_terms_of_service- when 'returns_policy'- current_store.customer_returns_policy- when 'shipping_policy'- current_store.customer_shipping_policy- end- else- raise ActiveRecord::RecordNotFound- end- end-- private-- def supported_policies- %w[privacy_policy terms_of_service returns_policy shipping_policy]+ @policy = current_store.policies.friendly.find(params[:id])endendenddiff --git a/storefront/app/views/themes/default/spree/checkout/_footer.html.erb b/storefront/app/views/themes/default/spree/checkout/_footer.html.erbindex f0cd400f1a..e69c0d3668 100644--- a/storefront/app/views/themes/default/spree/checkout/_footer.html.erb+++ b/storefront/app/views/themes/default/spree/checkout/_footer.html.erb@@ -1,10 +1,11 @@<% cache spree_base_cache_scope.call(current_store) do %>- <div class="flex flex-col gap-4 text-sm">- <ul class="flex justify-center flex-wrap gap-4">- <%= link_to Spree.t(:privacy_policy), "/policies/privacy_policy", target: '_blank' if legal_policy('privacy_policy').present? %>- <%= link_to Spree.t(:terms_of_service), "/policies/terms_of_service", target: '_blank' if legal_policy('terms_of_service').present? %>- <%= link_to Spree.t(:returns_policy), "/policies/returns_policy", target: '_blank' if legal_policy('returns_policy').present? %>- <%= link_to Spree.t(:shipping_policy), "/policies/shipping_policy", target: '_blank' if legal_policy('shipping_policy').present? %>- </ul>- </div>+ <% if current_store.policies.show_in_checkout_footer.any? %>+ <div class="flex flex-col gap-4 text-sm">+ <ul class="flex justify-center flex-wrap gap-4">+ <% current_store.policies.show_in_checkout_footer.order(:position).each do |policy| %>+ <%= link_to policy.name, spree.policy_path(policy), target: '_blank' %>+ <% end %>+ </ul>+ </div>+ <% end %><% end %>diff --git a/storefront/app/views/themes/default/spree/policies/show.html.erb b/storefront/app/views/themes/default/spree/policies/show.html.erbindex f375aab73d..6435909428 100644--- a/storefront/app/views/themes/default/spree/policies/show.html.erb+++ b/storefront/app/views/themes/default/spree/policies/show.html.erb@@ -1,15 +1,14 @@<div class="page-container py-12"><h1 class="text-2xl tracking-tight text-center lg:text-left mb-3 uppercase">- <%= Spree.t(params[:id]) %>+ <%= @policy.name %></h1>- <% if @policy.present? %>- <p class="mb-8 text-center lg:text-left">- <%= Spree.t("storefront.policies.last_update_at", date: l(@policy.updated_at.to_date)) %>- </p>+ <p class="mb-8 text-center lg:text-left">+ <%= Spree.t(:updated_at) %>:+ <%= l(@policy.updated_at.to_date) %>+ </p>- <div class="mb-5">- <%= @policy&.to_s %>- </div>- <% end %>+ <div class="mb-5">+ <%= @policy.body.to_s %>+ </div></div>diff --git a/storefront/config/locales/en.yml b/storefront/config/locales/en.ymlindex f162799622..7188976b4d 100644--- a/storefront/config/locales/en.yml+++ b/storefront/config/locales/en.yml@@ -55,8 +55,6 @@ en:description: Take control of your settings and tailor your experience according to your preferences. Customize your notifications to suit your needs.join: Email me about new products, sales, and more. You can unsubscribe at any time.status: You are currently %{status} to the newsletters.- policies:- last_update_at: Last update %{date}products:pinch_to_zoom_html: Pinch to<br>zoomrefund_action_not_required_message:diff --git a/storefront/spec/controllers/spree/policies_controller_spec.rb b/storefront/spec/controllers/spree/policies_controller_spec.rbindex cfcc8f599f..f718dd32eb 100644--- a/storefront/spec/controllers/spree/policies_controller_spec.rb+++ b/storefront/spec/controllers/spree/policies_controller_spec.rb@@ -10,42 +10,12 @@ describe Spree::PoliciesController, type: :controller doenddescribe 'GET #show' do- context 'with valid policy types' do- it 'renders privacy_policy' do- get :show, params: { id: 'privacy_policy' }- expect(assigns(:policy)).to eq(store.customer_privacy_policy)- expect(response).to render_template(:show)- expect(response).to have_http_status(:ok)- end+ let(:policy) { create(:policy, store: store) }- it 'renders terms_of_service' do- get :show, params: { id: 'terms_of_service' }- expect(assigns(:policy)).to eq(store.customer_terms_of_service)- expect(response).to render_template(:show)- expect(response).to have_http_status(:ok)- end-- it 'renders returns_policy' do- get :show, params: { id: 'returns_policy' }- expect(assigns(:policy)).to eq(store.customer_returns_policy)- expect(response).to render_template(:show)- expect(response).to have_http_status(:ok)- end-- it 'renders shipping_policy' do- get :show, params: { id: 'shipping_policy' }- expect(assigns(:policy)).to eq(store.customer_shipping_policy)- expect(response).to render_template(:show)- expect(response).to have_http_status(:ok)- end- end-- context 'with invalid policy type' do- it 'raises RecordNotFound error' do- expect {- get :show, params: { id: 'invalid_policy' }- }.to raise_error(ActiveRecord::RecordNotFound)- end+ it 'renders the policy' do+ get :show, params: { id: policy.slug }+ expect(response).to be_successful+ expect(response.body).to include(policy.body.to_plain_text)endendend