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
Added `DisplayOn` and `ParameterizableName` to `Property` (#12159)
Damian Legawiecdb4dacebbed7
diff --git a/api/app/serializers/concerns/spree/api/v2/resource_serializer_concern.rb b/api/app/serializers/concerns/spree/api/v2/resource_serializer_concern.rbindex 6ab80a2a26..c015b3622f 100644--- a/api/app/serializers/concerns/spree/api/v2/resource_serializer_concern.rb+++ b/api/app/serializers/concerns/spree/api/v2/resource_serializer_concern.rb@@ -21,6 +21,7 @@ module Spreedef self.display_getter_methods(model_klazz)model_klazz.new.methods.find_all do |method_name|+ next if method_name.to_s.start_with?('display_on')next unless method_name.to_s.start_with?('display_')next if method_name.to_s.end_with?('=')next if [Spree::Product, Spree::Variant].include?(model_klazz) && method_name == :display_amountdiff --git a/api/spec/serializers/spree/api/v2/platform/property_serializer_spec.rb b/api/spec/serializers/spree/api/v2/platform/property_serializer_spec.rbindex 7303739250..bf663c3d91 100644--- a/api/spec/serializers/spree/api/v2/platform/property_serializer_spec.rb+++ b/api/spec/serializers/spree/api/v2/platform/property_serializer_spec.rb@@ -20,6 +20,7 @@ describe Spree::Api::V2::Platform::PropertySerializer doupdated_at: resource.updated_at,filterable: resource.filterable,filter_param: resource.filter_param,+ display_on: resource.display_on,public_metadata: resource.public_metadata,private_metadata: resource.private_metadata}diff --git a/core/app/models/concerns/spree/display_on.rb b/core/app/models/concerns/spree/display_on.rbnew file mode 100644index 0000000000..aa16562d5e--- /dev/null+++ b/core/app/models/concerns/spree/display_on.rb@@ -0,0 +1,13 @@+module Spree+ module DisplayOn+ extend ActiveSupport::Concern++ DISPLAY = [:both, :front_end, :back_end].freeze++ included do+ scope :available, -> { where(display_on: [:both]) }+ scope :available_on_front_end, -> { where(display_on: [:front_end, :both]) }+ scope :available_on_back_end, -> { where(display_on: [:back_end, :both]) }+ end+ end+enddiff --git a/core/app/models/spree/payment_method.rb b/core/app/models/spree/payment_method.rbindex 82b0c81bbe..b558c09184 100644--- a/core/app/models/spree/payment_method.rb+++ b/core/app/models/spree/payment_method.rb@@ -5,12 +5,11 @@ module Spreeinclude Spree::MultiStoreResourceinclude Spree::Metadata+ include Spree::DisplayOnif defined?(Spree::Security::PaymentMethods)include Spree::Security::PaymentMethodsend- DISPLAY = [:both, :front_end, :back_end].freeze-scope :active, -> { where(active: true).order(position: :asc) }scope :available, -> { active.where(display_on: [:front_end, :back_end, :both]) }scope :available_on_front_end, -> { active.where(display_on: [:front_end, :both]) }diff --git a/core/app/models/spree/property.rb b/core/app/models/spree/property.rbindex 3b7bfb01b2..4570f40a84 100644--- a/core/app/models/spree/property.rb+++ b/core/app/models/spree/property.rb@@ -2,6 +2,8 @@ module Spreeclass Property < Spree::Baseinclude Spree::FilterParaminclude Spree::Metadata+ include Spree::ParameterizableName+ include Spree::DisplayOninclude Spree::TranslatableResourceif defined?(Spree::Webhooks::HasWebhooks)include Spree::Webhooks::HasWebhooksdiff --git a/core/app/models/spree/shipping_method.rb b/core/app/models/spree/shipping_method.rbindex 489fef5367..eb33686639 100644--- a/core/app/models/spree/shipping_method.rb+++ b/core/app/models/spree/shipping_method.rb@@ -3,6 +3,7 @@ module Spreeacts_as_paranoidinclude Spree::CalculatedAdjustmentsinclude Spree::Metadata+ include Spree::DisplayOnif defined?(Spree::Webhooks::HasWebhooks)include Spree::Webhooks::HasWebhooksend@@ -10,8 +11,6 @@ module Spreeinclude Spree::VendorConcernend- DISPLAY = [:both, :front_end, :back_end]-# Used for #refresh_ratesDISPLAY_ON_FRONT_END = 1DISPLAY_ON_BACK_END = 2@@ -35,10 +34,6 @@ module Spreevalidate :at_least_one_shipping_category- scope :available, -> { where(display_on: [:both]) }- scope :available_on_front_end, -> { where(display_on: [:front_end, :both]) }- scope :available_on_back_end, -> { where(display_on: [:back_end, :both]) }-def include?(address)return false unless addressdiff --git a/core/db/migrate/20240914153106_add_display_on_to_spree_properties.rb b/core/db/migrate/20240914153106_add_display_on_to_spree_properties.rbnew file mode 100644index 0000000000..be44187ed5--- /dev/null+++ b/core/db/migrate/20240914153106_add_display_on_to_spree_properties.rb@@ -0,0 +1,8 @@+class AddDisplayOnToSpreeProperties < ActiveRecord::Migration[6.1]+ def change+ add_column :spree_properties, :display_on, :string, default: 'both'++ Spree::Property.reset_column_information+ Spree::Property.update_all(display_on: 'both')+ end+enddiff --git a/core/spec/models/spree/product_property_spec.rb b/core/spec/models/spree/product_property_spec.rbindex 13e88d563b..6ab638c9be 100644--- a/core/spec/models/spree/product_property_spec.rb+++ b/core/spec/models/spree/product_property_spec.rb@@ -61,7 +61,8 @@ describe Spree::ProductProperty, type: :model doit 'assigns property' do@pp.property_name = 'Size'- expect(@pp.property.name).to eq('Size')+ expect(@pp.property.name).to eq('size')+ expect(@pp.property.presentation).to eq('Size')endenddiff --git a/core/spec/models/spree/property_spec.rb b/core/spec/models/spree/property_spec.rbindex 9fe275ede9..6207a57332 100644--- a/core/spec/models/spree/property_spec.rb+++ b/core/spec/models/spree/property_spec.rb@@ -24,6 +24,42 @@ describe Spree::Property, type: :model doendend+ describe 'scopes' do+ let!(:properties) { create_list(:property, 2, display_on: 'both') }+ let!(:frontend_properties) { create_list(:property, 2, display_on: 'front_end') }+ let!(:backend_properties) { create_list(:property, 2, display_on: 'back_end') }++ describe '.available' do+ subject { described_class.available }++ it { is_expected.to match_array(properties) }+ end++ describe '.available_on_front_end' do+ subject { described_class.available_on_front_end }++ it { is_expected.to match_array(properties + frontend_properties) }+ end++ describe '.available_on_back_end' do+ subject { described_class.available_on_back_end }++ it { is_expected.to match_array(properties + backend_properties) }+ end+ end++ describe 'callbacks' do+ describe '#normalize_name' do+ let!(:option_type) { build(:option_type, name: 'Shirt Size') }++ it 'should parameterize the name' do+ option_type.name = 'Shirt Size'+ option_type.save!+ expect(option_type.name).to eq('shirt-size')+ end+ end+ end+context 'setting filter param' dosubject { build(:property, name: 'Brand Name') }