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.

Product Details Page 2.0 (#13154)

Damian Legawiec66733a648f96
diff --git a/.cursor/rules/spree.mdc b/.cursor/rules/spree.mdc
index 23614b8a48..c022d8f34a 100644
--- a/.cursor/rules/spree.mdc
+++ b/.cursor/rules/spree.mdc
@@ -29,7 +29,6 @@ class Spree::Product < Spree.base_class
include Spree::Metafields
has_many :variants, class_name: 'Spree::Variant', dependent: :destroy
- has_many :product_properties, class_name: 'Spree::ProductProperty', dependent: :destroy
scope :available, -> { where(available_on: ..Time.current) }
diff --git a/CLAUDE.md b/CLAUDE.md
index 7144604eed..6be046c50d 100644
--- a/CLAUDE.md
+++ b/CLAUDE.md
@@ -75,8 +75,6 @@ class Spree::Product < ApplicationRecord
include Spree::Metafields
has_many :variants, class_name: 'Spree::Variant', dependent: :destroy
- has_many :product_properties, class_name: 'Spree::ProductProperty', dependent: :destroy
- has_many :properties, through: :product_properties, source: :property
scope :available, -> { where(available_on: ..Time.current) }
diff --git a/admin/app/assets/stylesheets/spree/admin/views/_page_builder.scss b/admin/app/assets/stylesheets/spree/admin/views/_page_builder.scss
index 345a5aaa70..71941de187 100644
--- a/admin/app/assets/stylesheets/spree/admin/views/_page_builder.scss
+++ b/admin/app/assets/stylesheets/spree/admin/views/_page_builder.scss
@@ -2,7 +2,9 @@ $sidebar-width: 345px;
$header-height: 43px;
#page-builder {
- background-color: $gray-100;
+ background-color: $gray-50;
+ height: 100vh;
+ overflow: hidden;
#content {
margin-left: 0;
@@ -20,18 +22,16 @@ $header-height: 43px;
.nav-pills {
border-radius: $border-radius;
- background-color: $gray-100;
- padding: 0.1rem;
+ background-color: $gray-50;
+ padding: 0.2rem;
.nav-link {
background-color: transparent;
padding: 0.25rem 0.5rem;
border-radius: $border-radius-sm;
- border: 1px solid transparent;
&.active {
background-color: $white;
- border: 1px solid $border-color;
}
}
}
@@ -59,7 +59,6 @@ $header-height: 43px;
left: 0px;
background-color: $body-bg;
border-right: 1px solid $border-color;
- overflow-y: scroll;
overflow-x: hidden;
height: calc(100vh - $header-height);
.sidebar-header {
@@ -96,7 +95,7 @@ $header-height: 43px;
}
#page-builder-preview {
border-radius: $border-radius;
- border: 1px solid $gray-300;
+ border: 1px solid $gray-200;
margin-top: calc($header-height + 1rem);
}
@@ -106,7 +105,7 @@ $header-height: 43px;
&:hover,
&:focus {
color: theme-color('black') !important;
- background-color: $gray-100 !important;
+ background-color: $gray-50 !important;
a {
text-decoration: none !important;
}
@@ -120,7 +119,7 @@ $header-height: 43px;
&:hover,
&:focus,
&:active {
- background-color: $gray-200 !important;
+ background-color: $gray-100 !important;
}
}
}
diff --git a/admin/app/controllers/spree/admin/page_blocks_controller.rb b/admin/app/controllers/spree/admin/page_blocks_controller.rb
index c2a22fa713..92c36ac418 100644
--- a/admin/app/controllers/spree/admin/page_blocks_controller.rb
+++ b/admin/app/controllers/spree/admin/page_blocks_controller.rb
@@ -49,7 +49,8 @@ module Spree
params.require(:page_block).permit(
permitted_page_block_attributes +
[link_attributes: permitted_page_link_attributes + [:id]] +
- @object.preferences.keys.map { |key| "preferred_#{key}" }
+ @object.preferences.keys.map { |key| "preferred_#{key}" } +
+ [preferred_metafield_definition_ids: []]
)
end
end
diff --git a/admin/app/controllers/spree/admin/products_controller.rb b/admin/app/controllers/spree/admin/products_controller.rb
index 45ce2c5982..4e7bae14e3 100644
--- a/admin/app/controllers/spree/admin/products_controller.rb
+++ b/admin/app/controllers/spree/admin/products_controller.rb
@@ -322,6 +322,8 @@ module Spree
end
def build_product_properties
+ return unless Spree::Config[:product_properties_enabled]
+
Spree::Property.all.each do |property|
@product.product_properties.build(property: property) unless @product.product_properties.find { |product_property| product_property.property_id == property.id }
end
diff --git a/admin/app/javascript/spree/admin/application.js b/admin/app/javascript/spree/admin/application.js
index 7b967b3a0e..e7b13f9157 100644
--- a/admin/app/javascript/spree/admin/application.js
+++ b/admin/app/javascript/spree/admin/application.js
@@ -77,6 +77,7 @@ import SelectController from 'spree/admin/controllers/select_controller'
import SeoFormController from 'spree/admin/controllers/seo_form_controller'
import SlugFormController from 'spree/admin/controllers/slug_form_controller'
import StickyController from 'spree/admin/controllers/sticky_controller'
+import SortableAutoSubmit from 'spree/admin/controllers/sortable_auto_submit_controller'
import SortableTree from 'spree/admin/controllers/sortable_tree_controller'
import StockTransferController from 'spree/admin/controllers/stock_transfer_controller'
import StoreFormController from 'spree/admin/controllers/store_form_controller'
@@ -135,6 +136,7 @@ application.register('seo-form', SeoFormController)
application.register('slug-form', SlugFormController)
application.register('sticky', StickyController)
application.register('sortable', Sortable)
+application.register('sortable-auto-submit', SortableAutoSubmit)
application.register('sortable-tree', SortableTree)
application.register('stock-transfer', StockTransferController)
application.register('store-form', StoreFormController)
diff --git a/admin/app/javascript/spree/admin/controllers/sortable_auto_submit_controller.js b/admin/app/javascript/spree/admin/controllers/sortable_auto_submit_controller.js
new file mode 100644
index 0000000000..33fcff0b47
--- /dev/null
+++ b/admin/app/javascript/spree/admin/controllers/sortable_auto_submit_controller.js
@@ -0,0 +1,10 @@
+import Sortable from "stimulus-sortable"
+
+export default class extends Sortable {
+ async onUpdate({ item, newIndex }) {
+ const form = item.closest('form')
+ if (form) {
+ form.requestSubmit()
+ }
+ }
+}
\ No newline at end of file
diff --git a/admin/app/views/layouts/spree/page_builder.html.erb b/admin/app/views/layouts/spree/page_builder.html.erb
index 5b85127cb8..c9dd150a29 100644
--- a/admin/app/views/layouts/spree/page_builder.html.erb
+++ b/admin/app/views/layouts/spree/page_builder.html.erb
@@ -23,7 +23,7 @@
<main id="main-part">
<div class="desktopLiveView" data-page-builder-target="previewContainer">
<div class="embed-responsive embed-responsive-4by3">
- <iframe class="embed-responsive-item"
+ <iframe class="embed-responsive-item overflow-y-auto"
data-page-builder-target="iframe"
data-action="load->page-builder#initializeVisualEditor"
id="page-builder-preview"
diff --git a/admin/app/views/spree/admin/page_blocks/edit.html.erb b/admin/app/views/spree/admin/page_blocks/edit.html.erb
index ae5fa59e0b..753b87723a 100644
--- a/admin/app/views/spree/admin/page_blocks/edit.html.erb
+++ b/admin/app/views/spree/admin/page_blocks/edit.html.erb
@@ -21,7 +21,7 @@
</div>
<div class="tab-content" id="pills-tabContent">
<div class="tab-pane fade <%= tab_selected == :content ? 'show active' : '' %>" id="pills-home" role="tabpanel" aria-labelledby="pills-home-tab">
- <%= render "spree/admin/page_blocks/forms/#{@page_block.type.demodulize.underscore}", f: f %>
+ <%= render "spree/admin/page_blocks/forms/#{@page_block.form_partial_name}", f: f %>
<%= render 'spree/admin/page_blocks/form_tab_buttons', tab: :content %>
</div>
<div class="tab-pane fade <%= tab_selected == :design ? 'show active' : '' %>" id="pills-profile" role="tabpanel" aria-labelledby="pills-profile-tab">
diff --git a/admin/app/views/spree/admin/page_blocks/forms/_metafields.html.erb b/admin/app/views/spree/admin/page_blocks/forms/_metafields.html.erb
new file mode 100644
index 0000000000..f285d84d3a
--- /dev/null
+++ b/admin/app/views/spree/admin/page_blocks/forms/_metafields.html.erb
@@ -0,0 +1,34 @@
+<div class="form-group">
+ <div class="mb-2">
+ <label class="form-label"><%= Spree.t(:metafields) %></label>
+ <div class="p-1 border rounded d-flex flex-column gap-1 mb-3"
+ data-controller="sortable-auto-submit"
+ data-sortable-auto-submit-handle-value=".handle"
+ >
+ <% selected_keys = f.object.preferred_metafield_definition_ids.map(&:to_s) %>
+ <% sorted_definitions = f.object.available_metafield_definitions.sort_by { |definition| selected_keys.index(definition.id.to_s) || selected_keys.length } %>
+ <% sorted_definitions.each do |definition| %>
+ <div class="rounded hover-light pl-2 pr-1 py-1 d-flex align-items-center justify-content-between"
+ id="<%= spree_dom_id(definition) %>"
+ >
+ <div class="custom-control custom-checkbox flex-grow-1 d-flex">
+ <input type="checkbox"
+ class="custom-control-input"
+ name="<%= "#{f.object_name}[preferred_metafield_definition_ids][]" %>"
+ id="<%= "#{f.object_name}_preferred_metafield_definition_ids_#{definition.id}" %>"
+ value="<%= definition.id %>"
+ data-action="change->auto-submit#submit"
+ <%= 'checked' if selected_keys.include?(definition.id.to_s) %>>
+ <label class="custom-control-label flex-grow-1" for="<%= "#{f.object_name}_preferred_metafield_definition_ids_#{definition.id}" %>" data-controller="tooltip">
+ <%= definition.name %>
+ <%= tooltip(definition.full_key) %>
+ </label>
+ </div>
+ <button class="btn btn-sm pr-0 handle hover-gray h-100 mr-1 px-1" type="button">
+ <%= icon('grip-vertical', class: 'mr-0') %>
+ </button>
+ </div>
+ <% end %>
+ </div>
+ </div>
+</div>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/page_blocks/forms/_buy_buttons.html.erb b/admin/app/views/spree/admin/page_blocks/forms/products/_buy_buttons.html.erb
similarity index 100%
rename from admin/app/views/spree/admin/page_blocks/forms/_buy_buttons.html.erb
rename to admin/app/views/spree/admin/page_blocks/forms/products/_buy_buttons.html.erb
diff --git a/admin/app/views/spree/admin/page_blocks/forms/products/_description.html.erb b/admin/app/views/spree/admin/page_blocks/forms/products/_description.html.erb
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/admin/app/views/spree/admin/page_blocks/forms/_quantity_selector.html.erb b/admin/app/views/spree/admin/page_blocks/forms/products/_quantity_selector.html.erb
similarity index 100%
rename from admin/app/views/spree/admin/page_blocks/forms/_quantity_selector.html.erb
rename to admin/app/views/spree/admin/page_blocks/forms/products/_quantity_selector.html.erb
diff --git a/admin/app/views/spree/admin/page_builder/_sidebar.html.erb b/admin/app/views/spree/admin/page_builder/_sidebar.html.erb
index 3f0d603c1f..655383d2ce 100644
--- a/admin/app/views/spree/admin/page_builder/_sidebar.html.erb
+++ b/admin/app/views/spree/admin/page_builder/_sidebar.html.erb
@@ -1,4 +1,4 @@
-<aside id="page-builder-sidebar">
+<aside id="page-builder-sidebar" class="overflow-y-auto">
<div class="tab-content mb5">
<div class="tab-pane fade show active" id="sections" role="tabpanel" aria-labelledby="sidebar-icon-page">
<%= render 'spree/admin/page_builder/sidebar_sections' %>
diff --git a/admin/app/views/spree/admin/page_sections/forms/_breadcrumbs.html.erb b/admin/app/views/spree/admin/page_sections/forms/_breadcrumbs.html.erb
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/admin/app/views/spree/admin/products/_form.html.erb b/admin/app/views/spree/admin/products/_form.html.erb
index e4e507e784..f3b2de54d7 100644
--- a/admin/app/views/spree/admin/products/_form.html.erb
+++ b/admin/app/views/spree/admin/products/_form.html.erb
@@ -7,7 +7,7 @@
<% end unless @product.has_variants? %>
<%= render 'spree/admin/products/form/variants', f: f %>
<%= render 'spree/admin/products/form/inventory', f: f unless @product.has_variants? %>
- <%= render 'spree/admin/products/form/properties', f: f %>
+ <%= render 'spree/admin/products/form/properties', f: f if Spree::Config[:product_properties_enabled] %>
<%= render_admin_partials(:product_form_partials, f: f, product: @product) %>
</div>
diff --git a/admin/app/views/spree/admin/shared/sidebar/_products_nav.html.erb b/admin/app/views/spree/admin/shared/sidebar/_products_nav.html.erb
index 67074c16fb..6beebf2692 100644
--- a/admin/app/views/spree/admin/shared/sidebar/_products_nav.html.erb
+++ b/admin/app/views/spree/admin/shared/sidebar/_products_nav.html.erb
@@ -12,7 +12,7 @@
<% if can?(:manage, Spree::OptionType) %>
<%= nav_item(Spree.t(:options), spree.admin_option_types_path, active: %w[option_types option_values].include?(controller_name)) %>
<% end %>
- <% if can?(:manage, Spree::Property) %>
+ <% if can?(:manage, Spree::Property) && Spree::Config[:product_properties_enabled] %>
<%= nav_item(Spree.t(:properties), spree.admin_properties_path) %>
<% end %>
diff --git a/admin/spec/features/spree/admin/products/edit/properties_spec.rb b/admin/spec/features/spree/admin/products/edit/properties_spec.rb
index 5e9c59786d..6a57af4bc7 100644
--- a/admin/spec/features/spree/admin/products/edit/properties_spec.rb
+++ b/admin/spec/features/spree/admin/products/edit/properties_spec.rb
@@ -11,6 +11,12 @@ describe 'Product Properties', type: :feature, js: true do
before do
product.set_property('brand', 'Epsilon')
+
+ Spree::Config[:product_properties_enabled] = true
+ end
+
+ after do
+ Spree::Config[:product_properties_enabled] = false
end
it 'shows associated properties in the form plus a new property' do
diff --git a/core/app/models/spree/page_block.rb b/core/app/models/spree/page_block.rb
index e7e537d145..7d2005f217 100644
--- a/core/app/models/spree/page_block.rb
+++ b/core/app/models/spree/page_block.rb
@@ -56,6 +56,10 @@ module Spree
name
end
+ def form_partial_name
+ type.demodulize.underscore
+ end
+
def icon_name
'fullscreen'
end
diff --git a/core/app/models/spree/page_blocks/metafields.rb b/core/app/models/spree/page_blocks/metafields.rb
new file mode 100644
index 0000000000..c498a095de
--- /dev/null
+++ b/core/app/models/spree/page_blocks/metafields.rb
@@ -0,0 +1,18 @@
+module Spree
+ module PageBlocks
+ class Metafields < Spree::PageBlock
+ RESOURCE_TYPE_DEFAULT = 'Spree::Product'
+
+ preference :resource_type, :string, default: -> { self.class::RESOURCE_TYPE_DEFAULT if defined?(self.class::RESOURCE_TYPE_DEFAULT) }
+ preference :metafield_definition_ids, :array, default: -> { available_metafield_definitions.pluck(:id) }
+
+ def icon_name
+ 'list'
+ end
+
+ def available_metafield_definitions
+ @available_metafield_definitions ||= Spree::MetafieldDefinition.where(resource_type: preferred_resource_type).available_on_front_end
+ end
+ end
+ end
+end
diff --git a/core/app/models/spree/page_blocks/products/brand.rb b/core/app/models/spree/page_blocks/products/brand.rb
new file mode 100644
index 0000000000..eddd16031e
--- /dev/null
+++ b/core/app/models/spree/page_blocks/products/brand.rb
@@ -0,0 +1,15 @@
+module Spree
+ module PageBlocks
+ module Products
+ class Brand < Spree::PageBlocks::Heading
+ preference :text_color, :string
+
+ SIZE_DEFAULT = 'medium'
+
+ def display_name
+ Spree.t(:brand)
+ end
+ end
+ end
+ end
+end
diff --git a/core/app/models/spree/page_blocks/products/buy_buttons.rb b/core/app/models/spree/page_blocks/products/buy_buttons.rb
index 42fcd0c1c6..cb98610126 100644
--- a/core/app/models/spree/page_blocks/products/buy_buttons.rb
+++ b/core/app/models/spree/page_blocks/products/buy_buttons.rb
@@ -2,7 +2,7 @@ module Spree
module PageBlocks
module Products
class BuyButtons < Spree::PageBlock
- TOP_PADDING_DEFAULT = 20
+ TOP_PADDING_DEFAULT = 0
BOTTOM_PADDING_DEFAULT = 20
preference :text_color, :string
diff --git a/core/app/models/spree/page_blocks/products/description.rb b/core/app/models/spree/page_blocks/products/description.rb
new file mode 100644
index 0000000000..7baf5958c9
--- /dev/null
+++ b/core/app/models/spree/page_blocks/products/description.rb
@@ -0,0 +1,18 @@
+module Spree
+ module PageBlocks
+ module Products
+ class Description < Spree::PageBlocks::Text
+ TOP_PADDING_DEFAULT = 0
+ BOTTOM_PADDING_DEFAULT = 20
+
+ def form_partial_name
+ 'products/description'
+ end
+
+ def display_name
+ I18n.t('activerecord.attributes.spree/product.description')
+ end
+ end
+ end
+ end
+end
diff --git a/core/app/models/spree/page_blocks/products/price.rb b/core/app/models/spree/page_blocks/products/price.rb
index 1ed28be30c..721fd10ac8 100644
--- a/core/app/models/spree/page_blocks/products/price.rb
+++ b/core/app/models/spree/page_blocks/products/price.rb
@@ -10,7 +10,7 @@ module Spree
end
def display_name
- 'Price'
+ Spree.t(:price)
end
end
end
diff --git a/core/app/models/spree/page_blocks/products/quantity_selector.rb b/core/app/models/spree/page_blocks/products/quantity_selector.rb
index 614c97cc8f..4d8981c53d 100644
--- a/core/app/models/spree/page_blocks/products/quantity_selector.rb
+++ b/core/app/models/spree/page_blocks/products/quantity_selector.rb
@@ -2,13 +2,17 @@ module Spree
module PageBlocks
module Products
class QuantitySelector < Spree::PageBlock
- TOP_PADDING_DEFAULT = 20
+ TOP_PADDING_DEFAULT = 0
BOTTOM_PADDING_DEFAULT = 20
preference :text_color, :string
def icon_name
- 'selector'
+ 'plus-minus'
+ end
+
+ def form_partial_name
+ 'products/quantity_selector'
end
end
end
diff --git a/core/app/models/spree/page_blocks/products/title.rb b/core/app/models/spree/page_blocks/products/title.rb
index 5ea8fa5710..c45d872ce3 100644
--- a/core/app/models/spree/page_blocks/products/title.rb
+++ b/core/app/models/spree/page_blocks/products/title.rb
@@ -7,7 +7,11 @@ module Spree
preference :text_color, :string
def display_name
- section.product_name.presence || 'Title'
+ I18n.t('activerecord.attributes.spree/product.name')
+ end
+
+ def icon_name
+ 'h-1'
end
end
end
diff --git a/core/app/models/spree/page_blocks/products/variant_picker.rb b/core/app/models/spree/page_blocks/products/variant_picker.rb
index 1a28b20792..234374c207 100644
--- a/core/app/models/spree/page_blocks/products/variant_picker.rb
+++ b/core/app/models/spree/page_blocks/products/variant_picker.rb
@@ -5,7 +5,7 @@ module Spree
preference :text_color, :string
def icon_name
- 'select'
+ 'list-details'
end
end
end
diff --git a/core/app/models/spree/page_section.rb b/core/app/models/spree/page_section.rb
index 52062d6d30..6d7c7b793e 100644
--- a/core/app/models/spree/page_section.rb
+++ b/core/app/models/spree/page_section.rb
@@ -5,7 +5,7 @@ module Spree
# Magic methods
#
acts_as_paranoid
- acts_as_list scope: [:pageable_id, { deleted_at: nil }]
+ acts_as_list scope: [:pageable_type, :pageable_id, { deleted_at: nil }]
#
# Associations
diff --git a/core/app/models/spree/page_sections/breadcrumbs.rb b/core/app/models/spree/page_sections/breadcrumbs.rb
new file mode 100644
index 0000000000..80d23a8e0d
--- /dev/null
+++ b/core/app/models/spree/page_sections/breadcrumbs.rb
@@ -0,0 +1,12 @@
+module Spree
+ module PageSections
+ class Breadcrumbs < Spree::PageSection
+ TOP_PADDING_DEFAULT = 20
+ BOTTOM_PADDING_DEFAULT = 20
+
+ def icon_name
+ 'chevron-right'
+ end
+ end
+ end
+end
diff --git a/core/app/models/spree/page_sections/product_details.rb b/core/app/models/spree/page_sections/product_details.rb
index fcd6135819..97d8029cca 100644
--- a/core/app/models/spree/page_sections/product_details.rb
+++ b/core/app/models/spree/page_sections/product_details.rb
@@ -1,7 +1,8 @@
module Spree
module PageSections
class ProductDetails < Spree::PageSection
- TOP_PADDING_DEFAULT = 20
+ TOP_BORDER_WIDTH_DEFAULT = 0
+ TOP_PADDING_DEFAULT = 0
BOTTOM_PADDING_DEFAULT = 40
def icon_name
@@ -11,6 +12,42 @@ module Spree
def self.role
'system'
end
+
+ def default_blocks
+ product_metafield_definition_ids = Spree::MetafieldDefinition.where(resource_type: 'Spree::Product').ids
+
+ [
+ Spree::PageBlocks::Products::Brand.new,
+ Spree::PageBlocks::Products::Title.new,
+ Spree::PageBlocks::Products::Price.new(text: Spree.t(:price), preferred_text_alignment: 'left'),
+ Spree::PageBlocks::Products::VariantPicker.new,
+ Spree::PageBlocks::Products::QuantitySelector.new,
+ Spree::PageBlocks::Products::BuyButtons.new,
+ Spree::PageBlocks::Products::Description.new,
+ Spree::PageBlocks::Metafields.new(preferred_metafield_definition_ids: product_metafield_definition_ids),
+ ]
+ end
+
+ def blocks_available?
+ true
+ end
+
+ def can_sort_blocks?
+ true
+ end
+
+ def available_blocks_to_add
+ [
+ Spree::PageBlocks::Products::Brand,
+ Spree::PageBlocks::Products::Title,
+ Spree::PageBlocks::Products::Price,
+ Spree::PageBlocks::Products::VariantPicker,
+ Spree::PageBlocks::Products::QuantitySelector,
+ Spree::PageBlocks::Products::BuyButtons,
+ Spree::PageBlocks::Products::Description,
+ Spree::PageBlocks::Metafields,
+ ]
+ end
end
end
end
diff --git a/core/app/models/spree/pages/product_details.rb b/core/app/models/spree/pages/product_details.rb
index 716b8dc0d8..b843f44284 100644
--- a/core/app/models/spree/pages/product_details.rb
+++ b/core/app/models/spree/pages/product_details.rb
@@ -16,6 +16,7 @@ module Spree
def default_sections
[
+ Spree::PageSections::Breadcrumbs.new,
Spree::PageSections::ProductDetails.new,
Spree::PageSections::RelatedProducts.new
]
diff --git a/core/config/locales/en.yml b/core/config/locales/en.yml
index 6264aa0695..840b368b17 100644
--- a/core/config/locales/en.yml
+++ b/core/config/locales/en.yml
@@ -736,6 +736,7 @@ en:
body_tag_end: Body tag end
body_tag_start: Body tag start
both: Both
+ brand: Brand
breadcrumbs: Breadcrumbs
calculated_reimbursements: Calculated Reimbursements
calculator: Calculator
diff --git a/core/lib/spree/core/configuration.rb b/core/lib/spree/core/configuration.rb
index 7e2b791fb0..c70718f2a7 100644
--- a/core/lib/spree/core/configuration.rb
+++ b/core/lib/spree/core/configuration.rb
@@ -50,6 +50,7 @@ module Spree
preference :mailer_logo, :string, deprecated: true
preference :max_level_in_taxons_menu, :integer, deprecated: true
preference :non_expiring_credit_types, :array, default: []
+ preference :product_properties_enabled, :boolean, default: false # enable legacy product properties
preference :products_per_page, :integer, default: 12
preference :require_master_price, :boolean, default: false
preference :restock_inventory, :boolean, default: true # Determines if a return item is restocked automatically once it has been received
diff --git a/core/lib/spree/core/engine.rb b/core/lib/spree/core/engine.rb
index 9c447e7e3b..6ace43b1e3 100644
--- a/core/lib/spree/core/engine.rb
+++ b/core/lib/spree/core/engine.rb
@@ -194,6 +194,7 @@ module Spree
]
Rails.application.config.spree.page_sections = [
+ Spree::PageSections::Breadcrumbs,
Spree::PageSections::FeaturedPosts,
Spree::PageSections::TaxonGrid,
Spree::PageSections::ImageWithText,
diff --git a/core/lib/tasks/core.rake b/core/lib/tasks/core.rake
index 2c15654fa1..b1f7148d56 100644
--- a/core/lib/tasks/core.rake
+++ b/core/lib/tasks/core.rake
@@ -194,7 +194,7 @@ use rake db:load_file[/absolute/path/to/sample/filename.rb]}
end
desc 'Migrate policies to store policies'
- task migrate_policies_to_store_policies: :environment do |_t, _args|
+ task migrate_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$/, '')
@@ -246,6 +246,28 @@ use rake db:load_file[/absolute/path/to/sample/filename.rb]}
end
end
end
+
+ desc 'Migrate product details sections to PDP 2.0 with blocks and metafields'
+ task migrate_product_details_pages: :environment do |_t, _args|
+ Spree::PageSections::ProductDetails.find_each do |section|
+ next if section.blocks.any?
+
+ section.send(:create_blocks)
+ end
+
+ Spree::Pages::ProductDetails.find_each do |page|
+ next if page.sections.exists?(type: 'Spree::PageSections::Breadcrumbs')
+
+ breadcrumbs = page.sections.create!(type: 'Spree::PageSections::Breadcrumbs')
+ breadcrumbs.move_to_top
+
+ page_details = page.sections.find_by(type: 'Spree::PageSections::ProductDetails')
+
+ if page_details.present?
+ page_details.update!(preferred_top_padding: 0, preferred_top_border_width: 0)
+ end
+ end
+ end
end
namespace :core do
diff --git a/sample/db/samples/metafields.rb b/sample/db/samples/metafields.rb
index 501c25c1da..7dbee6aec1 100644
--- a/sample/db/samples/metafields.rb
+++ b/sample/db/samples/metafields.rb
@@ -2,14 +2,12 @@ Spree::Sample.load_sample('products')
metafield_values = {
manufacturer: %w[Wilson Jerseys Wannabe Resiliance Conditioned],
- brand: %w[Alpha Beta Gamma Delta Theta Epsilon Zeta],
material: ['90% Cotton 10% Elastan', '50% Cotton 50% Elastan', '10% Cotton 90% Elastan'],
fit: %w[Form Lose]
}
Spree::Product.find_each do |product|
product.set_metafield('properties.manufacturer', metafield_values[:manufacturer].sample)
- product.set_metafield('properties.brand', metafield_values[:brand].sample)
product.set_metafield('properties.material', metafield_values[:material].sample)
product.set_metafield('properties.fit', metafield_values[:fit].sample)
product.save! if product.changed?
diff --git a/storefront/app/views/themes/default/spree/metafields/_long_text.html.erb b/storefront/app/views/themes/default/spree/metafields/_long_text.html.erb
new file mode 100644
index 0000000000..52172fe269
--- /dev/null
+++ b/storefront/app/views/themes/default/spree/metafields/_long_text.html.erb
@@ -0,0 +1 @@
+<%= metafield.value %>
\ No newline at end of file
diff --git a/storefront/app/views/themes/default/spree/metafields/_rich_text.html.erb b/storefront/app/views/themes/default/spree/metafields/_rich_text.html.erb
new file mode 100644
index 0000000000..4cfbce7b16
--- /dev/null
+++ b/storefront/app/views/themes/default/spree/metafields/_rich_text.html.erb
@@ -0,0 +1 @@
+<%= metafield.value.to_s %>
\ No newline at end of file
diff --git a/storefront/app/views/themes/default/spree/metafields/_short_text.html.erb b/storefront/app/views/themes/default/spree/metafields/_short_text.html.erb
new file mode 100644
index 0000000000..52172fe269
--- /dev/null
+++ b/storefront/app/views/themes/default/spree/metafields/_short_text.html.erb
@@ -0,0 +1 @@
+<%= metafield.value %>
\ No newline at end of file
diff --git a/storefront/app/views/themes/default/spree/page_sections/_breadcrumbs.html.erb b/storefront/app/views/themes/default/spree/page_sections/_breadcrumbs.html.erb
new file mode 100644
index 0000000000..914f20a2a8
--- /dev/null
+++ b/storefront/app/views/themes/default/spree/page_sections/_breadcrumbs.html.erb
@@ -0,0 +1,18 @@
+<div style="<%= section_styles(section) %>">
+ <div class="page-container">
+ <nav id="breadcrumbs" aria-label="breadcrumbs">
+ <% if @product.present? %>
+ <% taxons = product_breadcrumb_taxons(@product) %>
+
+ <ul class="inline-flex space-x-3 text-sm">
+ <% taxons.each_with_index do |taxon, index| %>
+ <li class="opacity-50"><%= link_to taxon.name, spree.nested_taxons_path(taxon), title: taxon.name %></li>
+ <div class="breadcrumb-square opacity-50 <%= 'hidden md:block' if index == taxons.length - 1 %>"></div>
+ <% end %>
+
+ <li class="hidden lg:block text-text opacity-100"><%= @product.name %></li>
+ </ul>
+ <% end %>
+ </nav>
+ </div>
+</div>
\ No newline at end of file
diff --git a/storefront/app/views/themes/default/spree/page_sections/_product_details.html.erb b/storefront/app/views/themes/default/spree/page_sections/_product_details.html.erb
index 9284f5c0d5..776cc3b83c 100644
--- a/storefront/app/views/themes/default/spree/page_sections/_product_details.html.erb
+++ b/storefront/app/views/themes/default/spree/page_sections/_product_details.html.erb
@@ -12,35 +12,11 @@
<template data-product-form-target="spinnerTemplate">
<%= render "spree/shared/icons/spinner" %>
</template>
- <%= render 'spree/products/breadcrumbs', product: product, taxons: product_breadcrumb_taxons(product) %>
+
<div id="product-details-page" class="grid grid-cols-1 lg:grid-cols-12 gap-x-14">
- <div class="lg:hidden">
- <% if product.brand %>
- <%= link_to spree.nested_taxons_path(product.brand), title: product.brand_name do %>
- <h3 class="text-sm lg:mt-0 inline-block mb-1">
- <%= product.brand_name %>
- </h3>
- <% end %>
- <% end %>
- <h1 class="text-2xl uppercase tracking-tight mb-4 font-medium">
- <%= product.name %>
- </h1>
- <%= link_to spree.product_path(product), class: "text-2xl uppercase tracking-tight font-medium hidden" do %>
- <%= product.name %>
- <% end %>
- <%=
- render 'spree/products/price',
- product: product,
- use_variant: true,
- selected_variant: @selected_variant,
- price_class: "my-4 lg:text-lg lg:font-medium",
- price_container_class: "w-full"
- %>
- </div>
+ <% images = product_media_gallery_images(product, selected_variant: @selected_variant, variant_from_options: @variant_from_options) %>
<div class="lg:col-span-7 relative">
- <% images = product_media_gallery_images(product, selected_variant: @selected_variant, variant_from_options: @variant_from_options) %>
-
<div class="lg:hidden mb-6">
<%= render 'spree/products/media_gallery', images: images, product: product %>
</div>
@@ -50,53 +26,73 @@
</div>
<div class="lg:col-span-5 lg:col-start-8">
- <div data-controller='sticky-button' data-product-form-target="productDetails">
- <div class="hidden lg:block">
- <% if product.brand %>
- <%= link_to spree.nested_taxons_path(product.brand), title: product.brand_name do %>
- <h3 class="text-sm mt-3 lg:mt-0 inline-block uppercase">
- <%= product.brand_name %>
- </h3>
- <% end %>
- <% end %>
- <h1 class="text-2xl uppercase tracking-tight mb-4 mt-2 font-medium">
- <%= product.name %>
- </h1>
+ <% show_waitlist_modal = spree.respond_to?(:waitlists_path) && current_variant.present? %>
+ <div
+ <% if show_waitlist_modal %>
+ data-controller="modal"
+ <% end %>
+ data-modal-allow-background-close="true"
+ class="h-full w-full waitlist-modal"
+ data-modal-backdrop-color-value="rgba(0,0,0,0.32)">
+ <%= form_with(url: spree.line_items_path, method: :post, data: { controller: "turbo-stream-form", product_form_target: "form" }) do |f| %>
+ <%= hidden_field_tag :variant_id, current_variant&.id %>
- <%=
- render 'spree/products/price',
- product: product,
- use_variant: true,
- selected_variant: @selected_variant,
- price_class: "my-4 lg:text-lg lg:font-medium"
- %>
- </div>
- <%= render 'spree/products/tags', product: product %>
- <% show_waitlist_modal = spree.respond_to?(:waitlists_path) && current_variant.present? %>
- <div
- <% if show_waitlist_modal %>
- data-controller="modal"
- <% end %>
- data-modal-allow-background-close="true"
- class="h-full w-full waitlist-modal"
- data-modal-backdrop-color-value="rgba(0,0,0,0.32)">
- <%= form_with(url: spree.line_items_path, method: :post, data: { controller: "turbo-stream-form", product_form_target: "form" }) do |f| %>
- <%= render 'spree/products/variant_picker', product: product, selected_variant: @selected_variant %>
- <%= render 'spree/products/quantity_selector', product: product, selected_variant: @selected_variant %>
- <div class="flex w-full my-5">
- <%= render 'spree/products/add_to_cart_button', product: product, selected_variant: @selected_variant, sticky_button_classes: "w-full" %>
- <%= render 'spree/products/add_to_wishlist', variant: current_variant, css_classes: 'btn-secondary ml-5 h-12 !py-0 !px-3 border-default', icon_size: 24 %>
- </div>
+ <div data-product-form-target="productDetails">
+ <% section.blocks.each do |block| %>
+ <div <%= block_attributes(block) %>>
+ <% case block.class.name %>
+ <% when 'Spree::PageBlocks::Products::Title' %>
+ <h1 class="text-2xl uppercase tracking-tight font-medium">
+ <%= product.name %>
+ </h1>
+ <% when 'Spree::PageBlocks::Products::Brand' %>
+ <% if product.brand %>
+ <%= link_to spree.nested_taxons_path(product.brand), title: product.brand_name do %>
+ <h3 class="text-sm lg:mt-0 inline-block mb-1">
+ <%= product.brand_name %>
+ </h3>
+ <% end %>
+ <% end %>
+ <% when 'Spree::PageBlocks::Products::Price' %>
+ <%= render 'spree/products/price', product: product, use_variant: true, selected_variant: @selected_variant, price_class: "lg:text-lg lg:font-medium", price_container_class: "w-full" %>
+ <% when 'Spree::PageBlocks::Products::VariantPicker' %>
+ <%= render 'spree/products/variant_picker', product: product, selected_variant: @selected_variant %>
+ <% when 'Spree::PageBlocks::Products::QuantitySelector' %>
+ <%= render 'spree/products/quantity_selector', product: product, selected_variant: @selected_variant %>
+ <% when 'Spree::PageBlocks::Products::BuyButtons' %>
+ <div class="flex w-full" data-controller='sticky-button'>
+ <%= render 'spree/products/add_to_cart_button', product: product, selected_variant: @selected_variant, sticky_button_classes: "w-full" %>
+ <%= render 'spree/products/add_to_wishlist', variant: current_variant, css_classes: 'btn-secondary ml-5 h-12 !py-0 !px-3 border-default', icon_size: 24 %>
+ </div>
+ <%= render 'spree/products/add_to_waitlist', variant: current_variant if show_waitlist_modal %>
+ <% when 'Spree::PageBlocks::Products::Description' %>
+ <%= render 'spree/products/description', product: product, block: block, section: section %>
+ <% when 'Spree::PageBlocks::Metafields' %>
+ <div class="st-accordion" data-controller="accordion">
+ <% metafields_by_definition = @product.metafields.index_by { |m| m.metafield_definition.id.to_s } %>
+ <% block.preferred_metafield_definition_ids.each do |definition_id| %>
+ <% metafield = metafields_by_definition[definition_id.to_s] %>
+ <% next unless metafield %>
+
+ <details class="product-metafield border-b border-default group" id="metafield_<%= metafield.id %>">
+ <summary class="text-sm uppercase tracking-widest inline-flex w-full justify-between items-center py-4 cursor-pointer focus:outline-none">
+ <span><%= metafield.name %></span>
+ <span class="ml-2 transition-transform group-open:rotate-180">
+ <%= render 'spree/shared/icons/chevron_down' %>
+ </span>
+ </summary>
+ <%= render "spree/metafields/#{metafield.type.demodulize.underscore}", metafield: metafield %>
+ </details>
+ <% end %>
+ </div>
+ <% end %>
+ </div>
<% end %>
- <%= render 'spree/products/add_to_waitlist', variant: current_variant if show_waitlist_modal %>
- </div>
-
- <%= render 'spree/products/details', product: product %>
+ <% end %>
</div>
</div>
</div>
</div>
</div>
-
<%= render 'spree/products/json_ld', product: product, selected_variant: @selected_variant %>
</turbo-frame>
diff --git a/storefront/app/views/themes/default/spree/products/_description.html.erb b/storefront/app/views/themes/default/spree/products/_description.html.erb
new file mode 100644
index 0000000000..1f712bbf2a
--- /dev/null
+++ b/storefront/app/views/themes/default/spree/products/_description.html.erb
@@ -0,0 +1,11 @@
+<% if product.storefront_description.present? %>
+ <% description_text = strip_tags(product.storefront_description) %>
+ <div data-controller="read-more" class="flex flex-col gap-4" data-read-more-more-text-value="<%= Spree.t(:read_more) %>" data-read-more-less-text-value="Read less">
+ <div class="prose product-description text-sm <%= 'product-description-truncated' if description_text.size > 250 %>" data-read-more-target="content">
+ <%= raw(product.storefront_description) %>
+ </div>
+ <% if description_text.size > 250 %>
+ <%= button_tag Spree.t(:read_more), data: { action: "read-more#toggle" }, class: "font-bold underline text-sm" %>
+ <% end %>
+ </div>
+<% end %>
\ No newline at end of file
diff --git a/storefront/app/views/themes/default/spree/products/_quantity_selector.html.erb b/storefront/app/views/themes/default/spree/products/_quantity_selector.html.erb
index 896d09a7fa..ba75336539 100644
--- a/storefront/app/views/themes/default/spree/products/_quantity_selector.html.erb
+++ b/storefront/app/views/themes/default/spree/products/_quantity_selector.html.erb
@@ -1,5 +1,5 @@
<% selected_variant ||= nil %>
-<p class="quantity-selector-label text-sm tracking-widest uppercase py-2"><%= Spree.t(:quantity) %></p>
+<p class="quantity-selector-label text-sm tracking-widest uppercase pb-2"><%= Spree.t(:quantity) %></p>
<div class="inline-block">
<div class="quantity-picker" data-controller="quantity-picker">
<%= button_tag class: 'decrease-quantity',
@@ -22,7 +22,6 @@
<% end %>
</div>
</div>
-<%= hidden_field_tag :variant_id, selected_variant&.id %>
<% if selected_variant && !selected_variant.backorderable? %>
<% if selected_variant.total_on_hand.between?(1, 4) %>
<p class="text-red-500 text-center text-sm mt-1" style="width: 117px">
diff --git a/storefront/lib/generators/spree/storefront/install/templates/application.tailwind.css b/storefront/lib/generators/spree/storefront/install/templates/application.tailwind.css
index fda1f2c86d..ec71240b1b 100644
--- a/storefront/lib/generators/spree/storefront/install/templates/application.tailwind.css
+++ b/storefront/lib/generators/spree/storefront/install/templates/application.tailwind.css
@@ -1122,6 +1122,7 @@ html[aria-busy="true"] .hide-on-load {
opacity: 1;
transition: all 0.2s;
visibility: visible;
+ margin-bottom: 1rem;
}
.st-accordion button {
@@ -1607,7 +1608,7 @@ html[aria-busy="true"] .hide-on-load {
}
/* PDP properties */
-.product-property {
+.product-property, .product-metafield {
ul {
list-style: disc;
padding-left: 2rem;
diff --git a/storefront/spec/features/product_details_page_spec.rb b/storefront/spec/features/product_details_page_spec.rb
index 2f88b8f072..1962b8f6f5 100644
--- a/storefront/spec/features/product_details_page_spec.rb
+++ b/storefront/spec/features/product_details_page_spec.rb
@@ -613,13 +613,11 @@ RSpec.describe 'Product detail page', type: :feature do
end
it 'shows taxon tree in breadcrumbs' do
- within turbo_frame do |c|
- within('nav#breadcrumbs') do
- expect(c).to have_text('Men')
- expect(c).to have_text('Clothing')
- expect(c).to have_text('Shoes')
- expect(c).to have_text(product.name)
- end
+ within('nav#breadcrumbs') do
+ expect(page).to have_text('Men')
+ expect(page).to have_text('Clothing')
+ expect(page).to have_text('Shoes')
+ expect(page).to have_text(product.name)
end
end