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 a shared concern for typed-subclass labels (#14836)
Damian Legawiecf60c9939b512
diff --git a/spree/api/app/controllers/spree/api/v3/admin/commission_rates_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/commission_rates_controller.rbindex 89b3df1b3d..5c3529b718 100644--- a/spree/api/app/controllers/spree/api/v3/admin/commission_rates_controller.rb+++ b/spree/api/app/controllers/spree/api/v3/admin/commission_rates_controller.rb@@ -26,7 +26,7 @@ module Spree{type: klass.api_type,name: klass.human_name,- description: klass.description,+ description: klass.human_description,preference_schema: klass.serialized_preference_schema,# Config a rule takes beyond its preferences — a catalog-scale# reference list lives in its own table, not the blob, and andiff --git a/spree/core/app/models/concerns/spree/type_labels.rb b/spree/core/app/models/concerns/spree/type_labels.rbnew file mode 100644index 0000000000..6bdfa5defb--- /dev/null+++ b/spree/core/app/models/concerns/spree/type_labels.rb@@ -0,0 +1,38 @@+module Spree+ # Names and describes each kind in a family of typed subclasses (promotion+ # rules, collection rules, …) from one translation scope keyed by+ # +api_type+, so the `/types` endpoints and dashboard pickers label+ # extension kinds the same way as built-in ones.+ #+ # class Spree::PromotionRule < Spree.base_class+ # include Spree::TypeLabels+ # self.type_labels_scope = 'spree.promotion_rule_types'+ # end+ #+ # Spree::Promotion::Rules::Currency.human_name # => spree.promotion_rule_types.currency.name+ module TypeLabels+ extend ActiveSupport::Concern++ included do+ class_attribute :type_labels_scope, instance_writer: false+ end++ class_methods do+ # @return [String] the kind's name, falling back to its humanized +api_type++ def human_name+ I18n.t("#{type_labels_scope}.#{api_type}.name", default: api_type.titleize)+ end++ # @return [String] what the kind does, empty when it has no translation+ def human_description+ I18n.t("#{type_labels_scope}.#{api_type}.description", default: '')+ end+ end++ # @return [String]+ def human_name = self.class.human_name++ # @return [String]+ def human_description = self.class.human_description+ end+enddiff --git a/spree/core/app/models/spree/collection_rule.rb b/spree/core/app/models/spree/collection_rule.rbindex 4d0150f39c..e86cfe9ff6 100644--- a/spree/core/app/models/spree/collection_rule.rb+++ b/spree/core/app/models/spree/collection_rule.rb@@ -2,6 +2,10 @@module Spreeclass CollectionRule < Spree.base_class+ include Spree::TypeLabels++ self.type_labels_scope = 'spree.collection_rule_types'+has_prefix_id :cruleMATCH_POLICIES = %w[is_equal_to is_not_equal_to contains does_not_contain].freeze@@ -18,25 +22,6 @@ module Spreevalidate :type_must_be_registered- # @return [String] localized display name for the rule kind, used by admin pickers- def self.human_name- I18n.t("spree.collection_rule_types.#{api_type}.name", default: api_type.titleize)- end-- # @return [String] localized description for the rule kind- def self.human_description- I18n.t("spree.collection_rule_types.#{api_type}.description", default: '')- end-- # Feeds the `description` field of `subclasses_with_preference_schema`- # (the `/types` discovery payload), which only reads `.description`.- def self.description- human_description- end-- def human_name = self.class.human_name- def human_description = self.class.human_description-registers_subclasses_via { Rails.application.config.spree.collection_rules }privatediff --git a/spree/core/app/models/spree/commission_rule.rb b/spree/core/app/models/spree/commission_rule.rbindex 0a29a09bf7..ad09f1ac38 100644--- a/spree/core/app/models/spree/commission_rule.rb+++ b/spree/core/app/models/spree/commission_rule.rb@@ -15,6 +15,9 @@ module Spree# setting. A rate with no rules charges every sale.class CommissionRule < Spree.base_classinclude Spree::PreferenceSchema+ include Spree::TypeLabels++ self.type_labels_scope = 'spree.commission_rule_types'has_prefix_id :comrule@@ -47,16 +50,6 @@ module Spreeregisters_subclasses_via { Spree.commission_rules }- # @return [String] the name an operator picks this rule kind by- def self.human_name- I18n.t("spree.commission_rule_types.#{api_type}.name", default: name.demodulize.titleize)- end-- # @return [String] what the rule does, shown beside the name in the picker- def self.description- I18n.t("spree.commission_rule_types.#{api_type}.description", default: '')- end-# Whether this rule admits the sale.## @param context [Spree::Commissions::Context]diff --git a/spree/core/app/models/spree/delivery_method_rule.rb b/spree/core/app/models/spree/delivery_method_rule.rbindex 7cbaf3a9bc..fa5e269f75 100644--- a/spree/core/app/models/spree/delivery_method_rule.rb+++ b/spree/core/app/models/spree/delivery_method_rule.rb@@ -7,6 +7,9 @@ module Spree# See docs/plans/6.0-delivery-method-rules.md.class DeliveryMethodRule < Spree.base_classinclude Spree::PreferenceSchema+ include Spree::TypeLabels++ self.type_labels_scope = 'spree.delivery_method_rule_types'has_prefix_id :dmrule@@ -27,16 +30,6 @@ module Spreeregisters_subclasses_via { Spree.delivery_method_rules }- # @return [String] localized display name for the rule kind, used by admin pickers- def self.human_name- I18n.t("spree.delivery_method_rule_types.#{api_type}.name", default: api_type.titleize)- end-- # @return [String] localized description for the rule kind- def self.human_description- I18n.t("spree.delivery_method_rule_types.#{api_type}.description", default: '')- end-# @param package [Spree::Stock::Package]# @return [Boolean]def eligible?(_package)diff --git a/spree/core/app/models/spree/order_routing_rule.rb b/spree/core/app/models/spree/order_routing_rule.rbindex 011fd79a39..97d3a78f51 100644--- a/spree/core/app/models/spree/order_routing_rule.rb+++ b/spree/core/app/models/spree/order_routing_rule.rb@@ -14,6 +14,10 @@ module Spree## See docs/plans/6.0-order-routing.md.class OrderRoutingRule < Spree.base_class+ include Spree::TypeLabels++ self.type_labels_scope = 'spree.order_routing_rule_types'+self.table_name = 'spree_order_routing_rules'# `rank` is integer (lower = better) when the rule has an opinion,@@ -50,25 +54,6 @@ module Spreevalidate :type_must_be_registered- # @return [String] localized display name for the rule kind, used by admin pickers- def self.human_name- I18n.t("spree.order_routing_rule_types.#{api_type}.name", default: api_type.titleize)- end-- # @return [String] localized description for the rule kind- def self.human_description- I18n.t("spree.order_routing_rule_types.#{api_type}.description", default: '')- end-- # Feeds the `description` field of `subclasses_with_preference_schema`- # (the `/types` discovery payload), which only reads `.description`.- def self.description- human_description- end-- def human_name = self.class.human_name- def human_description = self.class.human_description-# Subclasses override. Returns an Array<LocationRanking> — one per location,# with rank=nil to abstain.#diff --git a/spree/core/app/models/spree/promotion_action.rb b/spree/core/app/models/spree/promotion_action.rbindex 94d62aff18..beaeb455d2 100644--- a/spree/core/app/models/spree/promotion_action.rb+++ b/spree/core/app/models/spree/promotion_action.rb@@ -2,6 +2,10 @@# PromotionActions perform the necessary tasks when a promotion is activated by an event and determined to be eligible.module Spreeclass PromotionAction < Spree.base_class+ include Spree::TypeLabels++ self.type_labels_scope = 'spree.promotion_action_types'+has_prefix_id :pactregisters_subclasses_via { Spree.promotions.actions }@@ -74,17 +78,6 @@ module Spreeendend- def self.human_name- I18n.t("spree.promotion_action_types.#{api_type}.name", default: api_type.titleize)- end-- def self.human_description- I18n.t("spree.promotion_action_types.#{api_type}.description", default: '')- end-- def human_name = self.class.human_name- def human_description = self.class.human_description-# Returns the key of the promotion action## @return [String] eg. free_shippingdiff --git a/spree/core/app/models/spree/promotion_rule.rb b/spree/core/app/models/spree/promotion_rule.rbindex f0552e06bf..4791c5f223 100644--- a/spree/core/app/models/spree/promotion_rule.rb+++ b/spree/core/app/models/spree/promotion_rule.rb@@ -1,6 +1,10 @@# Base class for all promotion rulesmodule Spreeclass PromotionRule < Spree.base_class+ include Spree::TypeLabels++ self.type_labels_scope = 'spree.promotion_rule_types'+has_prefix_id :proruleregisters_subclasses_via { Spree.promotions.rules }@@ -35,17 +39,6 @@ module Spree@eligibility_errors ||= ActiveModel::Errors.new(self)end- def self.human_name- I18n.t("spree.promotion_rule_types.#{api_type}.name", default: api_type.titleize)- end-- def self.human_description- I18n.t("spree.promotion_rule_types.#{api_type}.description", default: '')- end-- def human_name = self.class.human_name- def human_description = self.class.human_description-# Returns the key of the promotion rule## @return [String] eg. currencydiff --git a/spree/core/app/models/spree/seller_requirement.rb b/spree/core/app/models/spree/seller_requirement.rbindex a6a2ff082c..778200386e 100644--- a/spree/core/app/models/spree/seller_requirement.rb+++ b/spree/core/app/models/spree/seller_requirement.rb@@ -16,6 +16,9 @@ module Spreeinclude Spree::HasListPositioninclude Spree::PreferenceSchemainclude Spree::Metadata+ include Spree::TypeLabels++ self.type_labels_scope = 'spree.seller_requirement_types'has_prefix_id :selreq@@ -87,16 +90,6 @@ module Spreeendend- # @return [String] the localized name of the kind, used by operator pickers- def self.human_name- I18n.t("spree.seller_requirement_types.#{api_type}.name", default: api_type.titleize)- end-- # @return [String] the localized description of the kind- def self.human_description- I18n.t("spree.seller_requirement_types.#{api_type}.description", default: '')- end-# Whether the operator may configure this kind more than once per store.# True for the kinds whose meaning comes from the operator's own copy.#diff --git a/spree/core/config/i18n-tasks.yml b/spree/core/config/i18n-tasks.ymlindex 2e2ea65031..ce830ef0ea 100644--- a/spree/core/config/i18n-tasks.yml+++ b/spree/core/config/i18n-tasks.yml@@ -159,6 +159,8 @@ ignore_unused:# Keys built with interpolation, which the scanner cannot follow.- 'spree.reporting.*'- 'spree.permissions_catalog.*'+ # Spree::TypeLabels reads <family>_types.<api_type>.{name,description}.+ - 'spree.{collection_rule,commission_rule,delivery_method_rule,order_routing_rule,promotion_action,promotion_rule,seller_requirement}_types.*'- 'spree.i18n.this_file_language'## Exclude these keys from the `i18n-tasks eq-base' report:diff --git a/spree/core/spec/models/spree/collection_rule_spec.rb b/spree/core/spec/models/spree/collection_rule_spec.rbindex ba9ff225da..4737bb2306 100644--- a/spree/core/spec/models/spree/collection_rule_spec.rb+++ b/spree/core/spec/models/spree/collection_rule_spec.rb@@ -1,6 +1,9 @@require 'spec_helper'RSpec.describe Spree::CollectionRule, type: :model do++ it_behaves_like 'type labels'+let(:store) { @default_store }let(:collection) { create(:automatic_collection, store: store) }diff --git a/spree/core/spec/models/spree/commission_rules/product_rule_spec.rb b/spree/core/spec/models/spree/commission_rules/product_rule_spec.rbindex 72b1bba637..5d59c36c60 100644--- a/spree/core/spec/models/spree/commission_rules/product_rule_spec.rb+++ b/spree/core/spec/models/spree/commission_rules/product_rule_spec.rb@@ -1,6 +1,9 @@require 'spec_helper'RSpec.describe Spree::CommissionRules::ProductRule do++ it_behaves_like 'type labels'+let(:store) { @default_store }let(:rate) { create(:commission_rate, store: store) }let(:rule) { described_class.create!(commission_rate: rate) }diff --git a/spree/core/spec/models/spree/delivery_method_rule_spec.rb b/spree/core/spec/models/spree/delivery_method_rule_spec.rbindex b2b032a95c..d55e5162f4 100644--- a/spree/core/spec/models/spree/delivery_method_rule_spec.rb+++ b/spree/core/spec/models/spree/delivery_method_rule_spec.rb@@ -1,6 +1,9 @@require 'spec_helper'describe Spree::DeliveryMethodRule, type: :model do++ it_behaves_like 'type labels'+let(:store) { @default_store }let(:delivery_method) { create(:delivery_method) }let(:package) dodiff --git a/spree/core/spec/models/spree/order_routing_rule_spec.rb b/spree/core/spec/models/spree/order_routing_rule_spec.rbindex cc41c3303c..3dbec5f632 100644--- a/spree/core/spec/models/spree/order_routing_rule_spec.rb+++ b/spree/core/spec/models/spree/order_routing_rule_spec.rb@@ -1,6 +1,9 @@require 'spec_helper'RSpec.describe Spree::OrderRoutingRule, type: :model do++ it_behaves_like 'type labels'+let(:store) { @default_store }let(:channel) { store.default_channel }diff --git a/spree/core/spec/models/spree/promotion_action_spec.rb b/spree/core/spec/models/spree/promotion_action_spec.rbindex 32a89ff3e4..1706d6bb71 100644--- a/spree/core/spec/models/spree/promotion_action_spec.rb+++ b/spree/core/spec/models/spree/promotion_action_spec.rb@@ -1,6 +1,9 @@require 'spec_helper'describe Spree::PromotionAction, type: :model do++ it_behaves_like 'type labels'+it "forces developer to implement 'perform' method" doexpect { MyAction.new.perform }.to raise_error(NameError)enddiff --git a/spree/core/spec/models/spree/promotion_rule_spec.rb b/spree/core/spec/models/spree/promotion_rule_spec.rbindex c3f057ab18..28fb39850c 100644--- a/spree/core/spec/models/spree/promotion_rule_spec.rb+++ b/spree/core/spec/models/spree/promotion_rule_spec.rb@@ -2,6 +2,8 @@ require 'spec_helper'module Spreedescribe Spree::PromotionRule, type: :model do+ it_behaves_like 'type labels'+class BadTestRule < Spree::PromotionRule; endclass TestRule < Spree::PromotionRulediff --git a/spree/core/spec/models/spree/seller_requirement_spec.rb b/spree/core/spec/models/spree/seller_requirement_spec.rbindex de5d27a805..5838c9f305 100644--- a/spree/core/spec/models/spree/seller_requirement_spec.rb+++ b/spree/core/spec/models/spree/seller_requirement_spec.rb@@ -1,6 +1,9 @@require 'spec_helper'RSpec.describe Spree::SellerRequirement, type: :model do++ it_behaves_like 'type labels'+let(:store) { @default_store }let(:seller) { create(:seller, store: store) }diff --git a/spree/core/spec/support/shared_examples/type_labels.rb b/spree/core/spec/support/shared_examples/type_labels.rbnew file mode 100644index 0000000000..63f36c23da--- /dev/null+++ b/spree/core/spec/support/shared_examples/type_labels.rb@@ -0,0 +1,22 @@+# Shared behavior for families that include Spree::TypeLabels.+RSpec.shared_examples 'type labels' do+ describe 'type labels' do+ let(:kind) { stub_const('MyApp::LoyaltyTierKind', Class.new(described_class.base_class)) }++ it "reads the kind's name and description from the family's scope" do+ labels = { loyalty_tier_kind: { name: 'Loyalty tier', description: 'Members of a tier' } }+ I18n.backend.store_translations(:en, kind.type_labels_scope.split('.').reverse.reduce(labels) { |tree, key| { key => tree } })++ expect(kind.human_name).to eq('Loyalty tier')+ expect(kind.human_description).to eq('Members of a tier')+ expect(kind.new.human_name).to eq('Loyalty tier')+ end++ it 'falls back to the humanized type for a kind without translations' do+ untranslated = stub_const('MyApp::UntranslatedKind', Class.new(described_class.base_class))++ expect(untranslated.human_name).to eq('Untranslated Kind')+ expect(untranslated.human_description).to eq('')+ end+ end+end