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.

Metafields (#13143)

Damian Legawiec175a1b141559
diff --git a/.cursor/rules/spree.mdc b/.cursor/rules/spree.mdc
index 47b76a7c6c..23614b8a48 100644
--- a/.cursor/rules/spree.mdc
+++ b/.cursor/rules/spree.mdc
@@ -20,13 +20,13 @@ alwaysApply: true
## Model Standards
- Use ActiveRecord associations with `class_name` and `dependent` options
- For uniqueness validation, always use `scope: spree_base_uniqueness_scope`
-- Include `Spree::Metadata` concern for models that need metadata support
+- Include `Spree::Metafields` concern for models that need metadata support
- Use scopes for reusable query patterns
```ruby
# ✅ Correct model structure
class Spree::Product < Spree.base_class
- include Spree::Metadata
+ include Spree::Metafields
has_many :variants, class_name: 'Spree::Variant', dependent: :destroy
has_many :product_properties, class_name: 'Spree::ProductProperty', dependent: :destroy
@@ -98,13 +98,13 @@ end
## Model Standards
- Use ActiveRecord associations with `class_name` and `dependent` options
- For uniqueness validation, always use `scope: spree_base_uniqueness_scope`
-- Include `Spree::Metadata` concern for models that need metadata support
+- Include `Spree::Metafields` concern for models that need metadata support
- Use scopes for reusable query patterns
```ruby
# ✅ Correct model structure
class Spree::Product < Spree.base_class
- include Spree::Metadata
+ include Spree::Metafields
has_many :variants, class_name: 'Spree::Variant', dependent: :destroy
has_many :product_properties, class_name: 'Spree::ProductProperty', dependent: :destroy
diff --git a/CLAUDE.md b/CLAUDE.md
index 1f5c4ef800..7144604eed 100644
--- a/CLAUDE.md
+++ b/CLAUDE.md
@@ -65,12 +65,14 @@ Always inherit from `Spree.base_class` when creating models.
- Use ActiveRecord associations appropriately, always pass `class_name` and `dependent` options
- Implement concerns for shared functionality
- Use scopes for reusable query patterns
-- Include `Spree::Metadata` concern for models that need metadata support
+- Include `Spree::Metafields` concern for models that need metadata support
+- Don't use enums, use string columns instead
+- For models that require state machine, please use https://github.com/state-machines/state_machines-activerecord gem, default column should be `status`, legacy models use `state`
```ruby
# ✅ Good model structure
class Spree::Product < ApplicationRecord
- include Spree::Metadata
+ include Spree::Metafields
has_many :variants, class_name: 'Spree::Variant', dependent: :destroy
has_many :product_properties, class_name: 'Spree::ProductProperty', dependent: :destroy
@@ -150,6 +152,7 @@ This will create a dummy rails application and run migrations. If there's alread
- Use Spree's factory bot definitions
- For controller specs always add `render_views` to the test
- For controller spec authentication use `stub_authorization!`
+- Don't create test scenarios for standard rails validation, only for custom validations
```ruby
# ✅ Proper spec structure
@@ -219,12 +222,12 @@ class CreateSpreeMetafields < ActiveRecord::Migration[7.0]
t.text :value, null: false
t.string :kind, null: false
t.string :visibility, null: false
- t.references :owner, polymorphic: true, null: false
+ t.references :resource, polymorphic: true, null: false
t.timestamps
end
- add_index :spree_metafields, [:owner_type, :owner_id, :key, :visibility],
- name: 'index_spree_metafields_on_owner_and_key_and_visibility'
+ add_index :spree_metafields, [:resource_type, :resource_id, :key, :visibility],
+ name: 'index_spree_metafields_on_resource_and_key_and_visibility'
end
end
```
@@ -347,6 +350,10 @@ end
This document should be updated as Spree evolves and new patterns emerge. Always refer to the official Spree documentation for the most current practices and guidelines.
+## Routes
+
+- Always use `spree.` routes engine when using routes in views and controllers
+
## Internationalization
- Use Rails 18n for internationalization
diff --git a/admin/app/assets/stylesheets/spree/admin/components/_dialogs.scss b/admin/app/assets/stylesheets/spree/admin/components/_dialogs.scss
index b668722492..1b2f3f01f3 100644
--- a/admin/app/assets/stylesheets/spree/admin/components/_dialogs.scss
+++ b/admin/app/assets/stylesheets/spree/admin/components/_dialogs.scss
@@ -59,6 +59,7 @@ dialog:open {
right: 0;
left: auto;
height: calc(100vh - 2rem);
+ max-height: calc(100vh - 2rem);
width: calc(100vw - 2rem);
max-width: 600px;
min-width: 320px;
@@ -66,6 +67,12 @@ dialog:open {
flex-direction: column;
justify-content: space-between;
padding: 0;
+ overflow-y: hidden;
+ overflow-x: hidden;
+
+ .drawer-title {
+ margin-bottom: 0;
+ }
&:open {
display: flex;
@@ -89,6 +96,7 @@ dialog:open {
justify-content: space-between;
align-items: center;
padding: $modal-inner-padding;
+ border-bottom: 1px solid $gray-50;
}
.drawer-body {
@@ -98,10 +106,14 @@ dialog:open {
}
.drawer-footer {
+ position: sticky;
+ bottom: 0;
padding: $modal-inner-padding;
display: flex;
justify-content: space-between;
align-items: center;
+ background-color: $gray-25;
+ border-top: 1px solid $gray-50;
}
}
diff --git a/admin/app/controllers/spree/admin/metafield_definitions_controller.rb b/admin/app/controllers/spree/admin/metafield_definitions_controller.rb
new file mode 100644
index 0000000000..3590e641fe
--- /dev/null
+++ b/admin/app/controllers/spree/admin/metafield_definitions_controller.rb
@@ -0,0 +1,27 @@
+module Spree
+ module Admin
+ class MetafieldDefinitionsController < ResourceController
+ add_breadcrumb Spree.t(:metafield_definitions), :admin_metafield_definitions_path
+
+ new_action.before :set_resource_type_from_params
+
+ private
+
+ def update_turbo_stream_enabled?
+ true
+ end
+
+ def set_resource_type_from_params
+ @object.resource_type = Spree::MetafieldDefinition.available_resources.find { |type| type.name.to_s == params[:resource_type] }
+ end
+
+ def location_after_save
+ collection_url
+ end
+
+ def permitted_resource_params
+ params.require(:metafield_definition).permit(permitted_metafield_definition_attributes)
+ end
+ end
+ end
+end
diff --git a/admin/app/controllers/spree/admin/metafields_controller.rb b/admin/app/controllers/spree/admin/metafields_controller.rb
new file mode 100644
index 0000000000..a94ba75a16
--- /dev/null
+++ b/admin/app/controllers/spree/admin/metafields_controller.rb
@@ -0,0 +1,52 @@
+module Spree
+ module Admin
+ class MetafieldsController < BaseController
+ before_action :load_resource
+
+ # GET /admin/<resource_name_plural>/<id>/edit
+ def edit
+ @metafields = @resource.metafields
+ @metafield_definitions = Spree::MetafieldDefinition.where(resource_type: @resource.class.name)
+
+ @metafield_definitions.each do |metafield_definition|
+ @resource.metafields.build(type: metafield_definition.metafield_type, metafield_definition: metafield_definition) unless @resource.has_metafield?(metafield_definition)
+ end
+ end
+
+ # PUT /admin/<resource_name_plural>/<id>
+ def update
+ if @resource.update(permitted_metafields_params)
+ flash.now[:success] = flash_message_for(@resource, :successfully_updated)
+ else
+ flash.now[:error] = @resource.errors.full_messages.to_sentence
+ end
+ end
+
+ private
+
+ def permitted_metafields_params
+ params.require(resource_type.model_name.param_key).permit(metafields_attributes: permitted_metafield_attributes)
+ end
+
+ # eg. Spree::Product
+ def resource_type
+ @resource_type ||= allowed_resource_types.find { |type| type.name == params[:resource_type] }
+ end
+
+ def load_resource
+ raise ActiveRecord::RecordNotFound if params[:resource_type].blank?
+ raise ActiveRecord::RecordNotFound if resource_type.blank?
+
+ @resource = if resource_type.respond_to?(:friendly)
+ resource_type.friendly.find(params[:id])
+ else
+ resource_type.find(params[:id])
+ end
+ end
+
+ def allowed_resource_types
+ @allowed_resource_types ||= Rails.application.config.spree.metafield_enabled_resources
+ end
+ end
+ end
+end
diff --git a/admin/app/helpers/spree/admin/base_helper.rb b/admin/app/helpers/spree/admin/base_helper.rb
index 7ba17d8341..30ab479f1a 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_applications
payment_methods refund_reasons reimbursement_types return_authorization_reasons roles
shipping_categories shipping_methods stock_locations store_credit_categories
- stores tax_categories tax_rates webhooks webhooks_subscribers zones policies].include?(controller_name)
+ stores tax_categories tax_rates webhooks webhooks_subscribers zones policies metafield_definitions].include?(controller_name)
end
# @return [Array<String>] the available countries for checkout
@@ -76,8 +76,10 @@ module Spree
# returns the available display on options, eg backend, frontend, both
# @return [Array<Array<String, String>>] the available display on options
- def display_on_options
- Spree::DisplayOn::DISPLAY.map do |display_on|
+ def display_on_options(model = nil)
+ model ||= Spree::DisplayOn
+
+ model::DISPLAY.map do |display_on|
[Spree.t("admin.display_on_options.#{display_on}"), display_on]
end
end
@@ -115,11 +117,12 @@ module Spree
icon_name = 'plus' if icon_name == 'add'
icon_name = 'x' if icon_name == 'cancel'
- styles = options[:style]
- styles ||= ''
- styles += ";font-size: #{options[:height]}px !important;line-height:#{options[:height]}px !important" if options[:height]
+ options[:style] ||= ''
+ options[:style] += ";font-size: #{options[:height]}px !important;line-height:#{options[:height]}px !important" if options[:height]
+
+ options[:class] = "ti ti-#{icon_name} #{options[:class]}"
- content_tag :i, nil, class: "ti ti-#{icon_name} #{options[:class]}", style: styles
+ content_tag :i, nil, options
end
# returns the flag emoji for a country
diff --git a/admin/app/helpers/spree/admin/metafields_helper.rb b/admin/app/helpers/spree/admin/metafields_helper.rb
new file mode 100644
index 0000000000..453b0139ab
--- /dev/null
+++ b/admin/app/helpers/spree/admin/metafields_helper.rb
@@ -0,0 +1,27 @@
+module Spree
+ module Admin
+ module MetafieldsHelper
+ def link_to_edit_metafields(record, options = {})
+ return unless Spree::MetafieldDefinition.available_resources.map(&:name).include?(record.class.name)
+ return unless record.respond_to?(:metafields)
+
+ options[:class] ||= 'dropdown-item'
+ options[:data] ||= { action: 'drawer#open', turbo_frame: :drawer }
+
+ link_to_with_icon 'edit', Spree.t(:edit_metafields), spree.edit_admin_metafield_path(record, resource_type: record.class.name), options
+ end
+
+ def metafield_definition_resource_types
+ @metafield_definition_resource_types ||= Spree::MetafieldDefinition.available_resources.map do |type|
+ [type.to_s.demodulize.titleize, type]
+ end
+ end
+
+ def metafield_definition_types
+ @metafield_definition_types ||= Spree::MetafieldDefinition.available_types.map do |type|
+ [type.to_s.demodulize.titleize, type]
+ end
+ end
+ end
+ end
+end
diff --git a/admin/app/views/spree/admin/metafield_definitions/_filters.html.erb b/admin/app/views/spree/admin/metafield_definitions/_filters.html.erb
new file mode 100644
index 0000000000..f32d185f0f
--- /dev/null
+++ b/admin/app/views/spree/admin/metafield_definitions/_filters.html.erb
@@ -0,0 +1,18 @@
+<%= search_form_for [:admin, search_collection], class: "filter-wrap", data: {controller: "filters auto-submit"} do |f| %>
+ <div class="d-flex">
+ <%= render 'spree/admin/shared/filters_search_bar', param: :name_cont, label: Spree.t(:title) %>
+
+ <%= select_tag 'q[resource_type_eq]',
+ options_for_select(metafield_definition_resource_types, params.dig(:q, :resource_type_eq)),
+ {
+ include_blank: Spree.t(:all),
+ class: 'custom-select w-20',
+ data: {
+ filters_target: :input,
+ action: 'auto-submit#submit'
+ }
+ } %>
+ </div>
+ <%= render "spree/admin/shared/filter_badge_template" %>
+ <div data-filters-target="badgesContainer" class="filter-badges-container"></div>
+<% end %>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/metafield_definitions/_form.html.erb b/admin/app/views/spree/admin/metafield_definitions/_form.html.erb
new file mode 100644
index 0000000000..e06dc3838f
--- /dev/null
+++ b/admin/app/views/spree/admin/metafield_definitions/_form.html.erb
@@ -0,0 +1,30 @@
+<div class="card mb-4">
+ <div class="card-body">
+ <div class="form-group">
+ <%= f.spree_text_field :name, required: true, autofocus: f.object.new_record? %>
+ </div>
+
+ <div class="row">
+ <div class="form-group col-lg-4">
+ <%= f.spree_text_field :namespace, required: true, placeholder: 'eg. custom' %>
+ </div>
+ <div class="form-group col-lg-8">
+ <%= f.spree_text_field :key, required: true, placeholder: 'eg. id' %>
+ </div>
+ </div>
+
+ <% if f.object.new_record? %>
+ <div class="form-group">
+ <%= f.spree_select :resource_type, metafield_definition_resource_types, { include_blank: true, autocomplete: true, label: Spree.t(:resource) }, { required: true } %>
+ </div>
+
+ <div class="form-group">
+ <%= f.spree_select :metafield_type, metafield_definition_types, { include_blank: true, autocomplete: true, label: Spree.t(:type) }, { required: true } %>
+ </div>
+ <% end %>
+
+ <div class="form-group">
+ <%= f.spree_select :display_on, display_on_options(Spree::MetafieldDefinition), { include_blank: true, autocomplete: true }, { required: true } %>
+ </div>
+ </div>
+</div>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/metafield_definitions/_table_header.html.erb b/admin/app/views/spree/admin/metafield_definitions/_table_header.html.erb
new file mode 100644
index 0000000000..996417a9ca
--- /dev/null
+++ b/admin/app/views/spree/admin/metafield_definitions/_table_header.html.erb
@@ -0,0 +1,10 @@
+<thead>
+ <tr>
+ <th><%= Spree.t(:key) %></th>
+ <th><%= Spree.t(:name) %></th>
+ <th><%= Spree.t(:resource) %></th>
+ <th><%= Spree.t(:type) %></th>
+ <th><%= Spree.t(:display_on) %></th>
+ <th></th>
+ </tr>
+</thead>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/metafield_definitions/_table_row.html.erb b/admin/app/views/spree/admin/metafield_definitions/_table_row.html.erb
new file mode 100644
index 0000000000..66e59c3fd9
--- /dev/null
+++ b/admin/app/views/spree/admin/metafield_definitions/_table_row.html.erb
@@ -0,0 +1,14 @@
+<tr id="<%= spree_dom_id(metafield_definition) %>">
+ <td><code><%= metafield_definition.full_key %></code></td>
+ <td><%= metafield_definition.name %></td>
+ <td><%= metafield_definition.resource_type.demodulize.titleize %></td>
+ <td><span class="badge badge-light"><%= metafield_definition.metafield_type.demodulize.titleize %></span></td>
+ <td>
+ <%= form_with model: metafield_definition, url: admin_metafield_definition_path(metafield_definition), method: :patch, data: { controller: 'auto-submit' } do |f| %>
+ <%= f.select :display_on, display_on_options(Spree::MetafieldDefinition), {}, { class: 'custom-select custom-select-sm w-auto', data: { action: 'auto-submit#submit' } } %>
+ <% end %>
+ </td>
+ <td class="text-right">
+ <%= link_to_edit(metafield_definition, data: { turbo_frame: '_top' }) %>
+ </td>
+</tr>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/metafield_definitions/edit.html.erb b/admin/app/views/spree/admin/metafield_definitions/edit.html.erb
new file mode 100644
index 0000000000..520a6f47c2
--- /dev/null
+++ b/admin/app/views/spree/admin/metafield_definitions/edit.html.erb
@@ -0,0 +1 @@
+<%= render 'spree/admin/shared/edit_resource' %>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/metafield_definitions/index.html.erb b/admin/app/views/spree/admin/metafield_definitions/index.html.erb
new file mode 100644
index 0000000000..688142c1c9
--- /dev/null
+++ b/admin/app/views/spree/admin/metafield_definitions/index.html.erb
@@ -0,0 +1,9 @@
+<%= content_for :page_title do %>
+ <%= Spree.t(:metafield_definitions) %>
+<% end %>
+
+<%= content_for :page_actions do %>
+ <%= link_to_with_icon 'plus', Spree.t(:new_metafield_definition), new_object_url, class: 'btn btn-primary' %>
+<% end %>
+
+<%= render 'spree/admin/shared/index_table' %>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/metafield_definitions/new.html.erb b/admin/app/views/spree/admin/metafield_definitions/new.html.erb
new file mode 100644
index 0000000000..0fd3668cab
--- /dev/null
+++ b/admin/app/views/spree/admin/metafield_definitions/new.html.erb
@@ -0,0 +1 @@
+<%= render 'spree/admin/shared/new_resource' %>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/metafield_definitions/update.turbo_stream.erb b/admin/app/views/spree/admin/metafield_definitions/update.turbo_stream.erb
new file mode 100644
index 0000000000..d9fb79328e
--- /dev/null
+++ b/admin/app/views/spree/admin/metafield_definitions/update.turbo_stream.erb
@@ -0,0 +1 @@
+<%= turbo_render_alerts %>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/metafields/edit.html.erb b/admin/app/views/spree/admin/metafields/edit.html.erb
new file mode 100644
index 0000000000..26f42f147f
--- /dev/null
+++ b/admin/app/views/spree/admin/metafields/edit.html.erb
@@ -0,0 +1,40 @@
+<%= turbo_frame_tag :drawer do %>
+ <%= drawer_header(Spree.t(:metafields)) %>
+ <% if @metafields.present? %>
+ <%= form_for [:admin, @resource], url: spree.admin_metafield_path(@resource, resource_type: @resource.class.to_s), method: :put do |f| %>
+ <div class="drawer-body">
+ <%= f.fields_for :metafields, @metafields do |metafield_form| %>
+ <%= metafield_form.hidden_field :id %>
+ <%= metafield_form.hidden_field :metafield_definition_id %>
+ <%= metafield_form.hidden_field :type %>
+ <% metafield_definition = metafield_form.object.metafield_definition %>
+ <div class="form-group">
+ <div class="d-flex justify-content-between">
+ <%= metafield_form.label :value do %>
+ <strong><%= metafield_definition.name %></strong>
+ <small class="text-muted mt-2"><code><%= metafield_definition.full_key %></code></small>
+ <% end %>
+
+ <% if metafield_definition.display_on == 'back_end' %>
+ <%= icon('eye-off', title: Spree.t("admin.display_on_options.#{metafield_definition.display_on}"), class: 'with-tip text-muted') %>
+ <% end %>
+ </div>
+ <%= render "spree/admin/metafields/types/#{metafield_form.object.type.demodulize.underscore}", f: metafield_form %>
+ </div>
+ <% end %>
+ </div>
+ <div class="drawer-footer">
+ <%= turbo_save_button_tag %>
+ <%= drawer_discard_button %>
+ </div>
+ <% end %>
+ <% else %>
+ <div class="drawer-body">
+ <div class="text-muted p-5 d-flex align-items-center w-100 justify-content-center flex-column">
+ <%= icon 'map-search', class: 'mb-3 opacity-50', style: 'font-size: 2rem;' %>
+ <p>No metafield definitions configured for <%= @resource.class.name.demodulize.titleize.pluralize %>.</p>
+ <%= link_to_with_icon 'plus', Spree.t(:add_one), spree.new_admin_metafield_definition_path(resource_type: @resource.class.to_s), class: 'btn btn-primary btn-sm ml-3', data: { 'turbo-frame': '_top' } if can?(:create, Spree::MetafieldDefinition) %>
+ </div>
+ </div>
+ <% end %>
+<% end %>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/metafields/types/_boolean.html.erb b/admin/app/views/spree/admin/metafields/types/_boolean.html.erb
new file mode 100644
index 0000000000..5465ca9df1
--- /dev/null
+++ b/admin/app/views/spree/admin/metafields/types/_boolean.html.erb
@@ -0,0 +1 @@
+<%= f.spree_check_box :value %>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/metafields/types/_json.html.erb b/admin/app/views/spree/admin/metafields/types/_json.html.erb
new file mode 100644
index 0000000000..9dcc23a7d1
--- /dev/null
+++ b/admin/app/views/spree/admin/metafields/types/_json.html.erb
@@ -0,0 +1 @@
+<%= f.text_area :value, class: 'form-control', data: { controller: 'textarea-autogrow' } %>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/metafields/types/_long_text.html.erb b/admin/app/views/spree/admin/metafields/types/_long_text.html.erb
new file mode 100644
index 0000000000..41e818b155
--- /dev/null
+++ b/admin/app/views/spree/admin/metafields/types/_long_text.html.erb
@@ -0,0 +1 @@
+ <%= f.text_area :value, class: 'form-control', data: { controller: 'textarea-autogrow' } %>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/metafields/types/_number.html.erb b/admin/app/views/spree/admin/metafields/types/_number.html.erb
new file mode 100644
index 0000000000..0b57f469df
--- /dev/null
+++ b/admin/app/views/spree/admin/metafields/types/_number.html.erb
@@ -0,0 +1 @@
+<%= f.number_field :value, class: 'form-control' %>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/metafields/types/_rich_text.html.erb b/admin/app/views/spree/admin/metafields/types/_rich_text.html.erb
new file mode 100644
index 0000000000..a3fba5e510
--- /dev/null
+++ b/admin/app/views/spree/admin/metafields/types/_rich_text.html.erb
@@ -0,0 +1,3 @@
+<div class="trix-container">
+ <%= f.rich_text_area :value %>
+</div>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/metafields/types/_short_text.html.erb b/admin/app/views/spree/admin/metafields/types/_short_text.html.erb
new file mode 100644
index 0000000000..b31f2dda67
--- /dev/null
+++ b/admin/app/views/spree/admin/metafields/types/_short_text.html.erb
@@ -0,0 +1 @@
+<%= f.text_field :value, class: 'form-control' %>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/metafields/update.turbo_stream.erb b/admin/app/views/spree/admin/metafields/update.turbo_stream.erb
new file mode 100644
index 0000000000..950adbe67d
--- /dev/null
+++ b/admin/app/views/spree/admin/metafields/update.turbo_stream.erb
@@ -0,0 +1,2 @@
+<%= turbo_hide_drawer %>
+<%= turbo_render_alerts %>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/orders/_header.html.erb b/admin/app/views/spree/admin/orders/_header.html.erb
index c55e1c69b3..ca4a348bbb 100644
--- a/admin/app/views/spree/admin/orders/_header.html.erb
+++ b/admin/app/views/spree/admin/orders/_header.html.erb
@@ -16,11 +16,6 @@
<% end %>
<% end %>
-<%# TODO: Fix mobile %>
-<% content_for :page_actions do %>
-
-<% end %>
-
<% content_for(:page_actions_dropdown) do %>
<% if @order.completed? && spree.respond_to?(:order_path) %>
<%= link_to_with_icon "eye",
diff --git a/admin/app/views/spree/admin/products/_form.html.erb b/admin/app/views/spree/admin/products/_form.html.erb
index adea4e42c5..e4e507e784 100644
--- a/admin/app/views/spree/admin/products/_form.html.erb
+++ b/admin/app/views/spree/admin/products/_form.html.erb
@@ -8,6 +8,7 @@
<%= 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_admin_partials(:product_form_partials, f: f, product: @product) %>
</div>
<div class="col-md-4">
diff --git a/admin/app/views/spree/admin/shared/_content_header.html.erb b/admin/app/views/spree/admin/shared/_content_header.html.erb
index 4ff40b34d4..68fb520e29 100644
--- a/admin/app/views/spree/admin/shared/_content_header.html.erb
+++ b/admin/app/views/spree/admin/shared/_content_header.html.erb
@@ -1,5 +1,4 @@
<% record = @object || @customer_return || @order || @product || @vendor || @user || @admin_user || @taxon || @store_credit %>
-<% record = nil if @user&.is_a?(Spree.admin_user_class) %>
<% show_record_subtitle = record && record.persisted? && record.has_attribute?(:updated_at) %>
<% content_for(:page_subtitle) do %>
@@ -26,7 +25,9 @@
<% end %>
<div class="dropdown-menu dropdown-menu-right">
<%= yield :page_actions_dropdown if content_for(:page_actions_dropdown) %>
- <% if record %>
+ <% if record && record.persisted? %>
+ <%= link_to_edit_metafields(record) %>
+
<% if record.respond_to?(:audits) && spree.respond_to?(:admin_audits_path) && defined?(Audited) && can?(:read, Audited.audit_class) %>
<a href="<%= spree.admin_audits_path(q: { auditable_id_eq: record.id, auditable_type_eq: record.class.to_s }) %>" target="_blank" class="dropdown-item">
<%= icon 'history' %>
diff --git a/admin/app/views/spree/admin/shared/sidebar/_store_nav.html.erb b/admin/app/views/spree/admin/shared/sidebar/_store_nav.html.erb
index cb16c5a6fa..59e4c51fd8 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
@@ -41,6 +41,10 @@
<%= nav_item(Spree.t(:stock_locations), spree.admin_stock_locations_path, icon: 'map-pin') %>
<% end %>
+ <% if can?(:manage, Spree::MetafieldDefinition) %>
+ <%= nav_item(Spree.t(:metafield_definitions), spree.admin_metafield_definitions_path, icon: 'list-details') %>
+ <% end %>
+
<% if can?(:manage, Spree::Store) %>
<% if spree.respond_to?(:admin_audits_path) %>
<%= nav_item(Spree.t('admin.audit_log'), spree.admin_audits_path, icon: 'history', active: %w[audits exports imports].include?(controller_name)) %>
diff --git a/admin/config/routes.rb b/admin/config/routes.rb
index fd0896f778..8d31284a6c 100644
--- a/admin/config/routes.rb
+++ b/admin/config/routes.rb
@@ -136,6 +136,10 @@ Spree::Core::Engine.add_routes do
# translations
resources :translations, only: [:edit, :update], path: '/translations/:resource_type'
+ # metafields
+ resources :metafields, only: [:edit, :update], path: '/metafields/:resource_type'
+ resources :metafield_definitions, except: :show
+
# audit log
resources :exports, only: [:index, :new, :create, :show]
diff --git a/admin/spec/controllers/spree/admin/metafield_definitions_controller_spec.rb b/admin/spec/controllers/spree/admin/metafield_definitions_controller_spec.rb
new file mode 100644
index 0000000000..aa94b79e1b
--- /dev/null
+++ b/admin/spec/controllers/spree/admin/metafield_definitions_controller_spec.rb
@@ -0,0 +1,116 @@
+require 'spec_helper'
+
+RSpec.describe Spree::Admin::MetafieldDefinitionsController, type: :controller do
+ stub_authorization!
+ render_views
+
+ let!(:metafield_definition) { create(:metafield_definition) }
+ let(:valid_attributes) do
+ {
+ name: 'External ID',
+ namespace: 'external',
+ key: 'id',
+ metafield_type: 'Spree::Metafields::ShortText',
+ resource_type: 'Spree::Product'
+ }
+ end
+
+ let(:invalid_attributes) do
+ {
+ name: '',
+ namespace: '',
+ key: '',
+ metafield_type: '',
+ resource_type: ''
+ }
+ end
+
+ describe 'GET #index' do
+ let!(:metafield_definitions) { create_list(:metafield_definition, 3) }
+ let!(:taxon_rich_text_field) { create(:metafield_definition, :rich_text_field, resource_type: 'Spree::Taxon') }
+
+ it 'renders the index template' do
+ get :index
+ expect(response).to render_template(:index)
+ expect(assigns(:search_collection).result).to include(*metafield_definitions)
+ expect(assigns(:search_collection).result).to include(taxon_rich_text_field)
+ end
+
+ context 'filtering by resource type' do
+ it 'renders the index template' do
+ get :index, params: { q: { resource_type_eq: 'Spree::Taxon' } }
+ expect(response).to render_template(:index)
+ expect(assigns(:search_collection).result).to eq([taxon_rich_text_field])
+ end
+ end
+ end
+
+ describe 'GET #new' do
+ it 'renders the new template' do
+ get :new, params: { resource_type: 'Spree::Product' }
+ expect(response).to render_template(:new)
+ expect(assigns(:object)).to be_a(Spree::MetafieldDefinition)
+ expect(assigns(:object).resource_type).to eq('Spree::Product')
+ end
+ end
+
+ describe 'POST #create' do
+ context 'with valid params' do
+ it 'creates a new MetafieldDefinition and redirects' do
+ expect {
+ post :create, params: { metafield_definition: valid_attributes }
+ }.to change(Spree::MetafieldDefinition, :count).by(1)
+ expect(response).to redirect_to(spree.admin_metafield_definitions_path)
+ expect(flash[:success]).to be_present
+ end
+ end
+
+ context 'with invalid params' do
+ it 'does not create a new MetafieldDefinition and re-renders new' do
+ expect {
+ post :create, params: { metafield_definition: invalid_attributes }
+ }.not_to change(Spree::MetafieldDefinition, :count)
+ expect(response).to render_template(:new)
+ end
+ end
+ end
+
+ describe 'GET #edit' do
+ it 'renders the edit template' do
+ get :edit, params: { id: metafield_definition.id }
+ expect(response).to render_template(:edit)
+ expect(assigns(:object)).to eq(metafield_definition)
+ end
+ end
+
+ describe 'PUT #update' do
+ context 'with valid params' do
+ it 'updates the MetafieldDefinition and redirects' do
+ put :update, params: { id: metafield_definition.id, metafield_definition: { name: 'Size' } }
+ expect(response).to redirect_to(spree.admin_metafield_definitions_path)
+ expect(assigns(:object).reload.name).to eq('Size')
+ expect(flash[:success]).to be_present
+ end
+ end
+
+ context 'with invalid params' do
+ it 'does not update and re-renders edit' do
+ put :update, params: { id: metafield_definition.id, metafield_definition: { name: '' } }
+ expect(response).to render_template(:edit)
+ expect(response).to have_http_status(:unprocessable_entity)
+ expect(assigns(:object).reload.name).not_to eq('')
+ end
+ end
+ end
+
+ describe 'DELETE #destroy' do
+ it 'destroys the MetafieldDefinition and redirects' do
+ metafield = create(:metafield_definition, :short_text_field)
+ expect {
+ delete :destroy, params: { id: metafield.id }
+ }.to change(Spree::MetafieldDefinition, :count).by(-1)
+ expect(response).to redirect_to(spree.admin_metafield_definitions_path)
+ expect(flash[:success]).to be_present
+ end
+ end
+end
diff --git a/admin/spec/controllers/spree/admin/metafields_controller_spec.rb b/admin/spec/controllers/spree/admin/metafields_controller_spec.rb
new file mode 100644
index 0000000000..eb975d20be
--- /dev/null
+++ b/admin/spec/controllers/spree/admin/metafields_controller_spec.rb
@@ -0,0 +1,116 @@
+require 'spec_helper'
+
+RSpec.describe Spree::Admin::MetafieldsController, type: :controller do
+ stub_authorization!
+ render_views
+
+ let(:product) { create(:product) }
+ let!(:metafield_definition) { create(:metafield_definition, resource_type: 'Spree::Product') }
+ let(:resource_type) { 'Spree::Product' }
+
+ describe 'GET #edit' do
+ it 'assigns @resource and @metafields and renders the edit template' do
+ get :edit, params: { resource_type: resource_type, id: product.slug }
+ expect(response).to render_template(:edit)
+ expect(assigns(:resource)).to eq(product)
+ expect(assigns(:metafields)).to be_present
+ expect(assigns(:metafields).map(&:metafield_definition)).to include(metafield_definition)
+ expect(assigns(:metafields).first.value).to be_blank
+ expect(assigns(:metafields).first.type).to eq(metafield_definition.metafield_type)
+ expect(assigns(:metafields).first.metafield_definition).to eq(metafield_definition)
+ expect(assigns(:metafields).first.id).to be_blank
+ expect(assigns(:metafield_definitions)).to include(metafield_definition)
+ end
+
+ context 'with existing metafields' do
+ let!(:metafield_definition_2) { create(:metafield_definition, resource_type: 'Spree::Product') }
+ let!(:metafield) { create(:metafield, resource: product, metafield_definition: metafield_definition) }
+
+ it 'assigns @resource and @metafields and renders the edit template' do
+ get :edit, params: { resource_type: resource_type, id: product.slug }
+ expect(response).to render_template(:edit)
+ expect(assigns(:resource)).to eq(product)
+ expect(assigns(:metafields)).to be_present
+ expect(assigns(:metafields).map(&:metafield_definition)).to contain_exactly(metafield_definition, metafield_definition_2)
+ expect(assigns(:metafields).map(&:value)).to contain_exactly(metafield.value, nil)
+ expect(assigns(:metafields).map(&:type)).to contain_exactly(metafield_definition.metafield_type, metafield_definition_2.metafield_type)
+ expect(assigns(:metafields).map(&:metafield_definition)).to contain_exactly(metafield_definition, metafield_definition_2)
+ expect(assigns(:metafields).map(&:id)).to contain_exactly(metafield.id, nil)
+ end
+ end
+
+ context 'when resource_type is missing' do
+ it 'raises ActiveRecord::RecordNotFound' do
+ expect {
+ get :edit, params: { id: product.slug, resource_type: '' }
+ }.to raise_error(ActiveRecord::RecordNotFound)
+ end
+ end
+
+ context 'when resource_type is invalid' do
+ it 'raises ActiveRecord::RecordNotFound' do
+ expect {
+ get :edit, params: { resource_type: 'InvalidType', id: product.slug }
+ }.to raise_error(ActiveRecord::RecordNotFound)
+ end
+ end
+ end
+
+ describe 'PUT #update' do
+ let!(:metafield) { create(:metafield, resource: product, metafield_definition: metafield_definition) }
+ let!(:metafield_definition_2) { create(:metafield_definition, :rich_text_field, resource_type: 'Spree::Product') }
+
+ let(:metafield_attributes) do
+ {
+ metafields_attributes: {
+ "0" => {
+ id: metafield.id,
+ type: metafield_definition.metafield_type,
+ metafield_definition_id: metafield_definition.id,
+ value: 'Test Value'
+ },
+ "1" => {
+ id: nil,
+ type: metafield_definition_2.metafield_type,
+ metafield_definition_id: metafield_definition_2.id,
+ value: '<strong>Test Value</strong>'
+ }
+ }
+ }
+ end
+
+ it 'updates metafields and sets flash success' do
+ put :update, format: :turbo_stream, params: {
+ resource_type: resource_type,
+ id: product.slug,
+ product: metafield_attributes
+ }
+ expect(response).to have_http_status(:ok)
+ expect(flash.now[:success]).to be_present
+ product.reload
+
+ metafield = product.metafields.find_by(metafield_definition_id: metafield_definition.id)
+ expect(metafield.value).to eq('Test Value')
+
+ metafield2 = product.metafields.find_by(metafield_definition_id: metafield_definition_2.id)
+ expect(metafield2.value).to be_kind_of(ActionText::RichText)
+ expect(metafield2.value.to_s).to include('<strong>Test Value</strong>')
+ end
+
+ context 'when resource_type is missing' do
+ it 'raises ActiveRecord::RecordNotFound' do
+ expect {
+ put :update, format: :turbo_stream, params: { id: product.slug, resource_type: '', product: metafield_attributes }
+ }.to raise_error(ActiveRecord::RecordNotFound)
+ end
+ end
+
+ context 'when resource_type is invalid' do
+ it 'raises ActiveRecord::RecordNotFound' do
+ expect {
+ put :update, format: :turbo_stream, params: { resource_type: 'InvalidType', id: product.slug, product: metafield_attributes }
+ }.to raise_error(ActiveRecord::RecordNotFound)
+ end
+ end
+ end
+end
diff --git a/api/app/controllers/spree/api/v2/platform/resource_controller.rb b/api/app/controllers/spree/api/v2/platform/resource_controller.rb
index 552f0af702..b9c2e2b359 100644
--- a/api/app/controllers/spree/api/v2/platform/resource_controller.rb
+++ b/api/app/controllers/spree/api/v2/platform/resource_controller.rb
@@ -117,7 +117,7 @@ module Spree
[]
end
- model_class.json_api_permitted_attributes + store_ids + metadata_params
+ model_class.json_api_permitted_attributes + store_ids + metadata_params + metafields_params
end
def metadata_params
@@ -128,6 +128,14 @@ module Spree
end
end
+ def metafields_params
+ if Spree::MetafieldDefinition.available_resources.map(&:name).include?(model_class.name) && model_class.method_defined?(:metafields)
+ [{ metafields_attributes: Spree::PermittedAttributes.metafield_attributes }]
+ else
+ []
+ end
+ end
+
def permitted_resource_params
params.require(model_param_name).permit(spree_permitted_attributes)
end
diff --git a/api/app/serializers/concerns/spree/api/v2/public_metafields_concern.rb b/api/app/serializers/concerns/spree/api/v2/public_metafields_concern.rb
new file mode 100644
index 0000000000..6988625380
--- /dev/null
+++ b/api/app/serializers/concerns/spree/api/v2/public_metafields_concern.rb
@@ -0,0 +1,15 @@
+module Spree
+ module Api
+ module V2
+ module PublicMetafieldsConcern
+ extend ActiveSupport::Concern
+
+ included do
+ has_many :metafields, serializer: Spree::Api::Dependencies.storefront_metafield_serializer.constantize,
+ record_type: :metafield,
+ object_method_name: :public_metafields
+ end
+ end
+ end
+ end
+end
\ No newline at end of file
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.rb
index c015b3622f..6d3223af25 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
@@ -17,6 +17,12 @@ module Spree
object.public_send(method_name).to_s
end
end
+
+ if Spree::MetafieldDefinition.available_resources.map(&:name).include?(model_klazz.name) && model_klazz.method_defined?(:metafields)
+ base.has_many :metafields, serializer: Spree::Api::Dependencies.platform_metafield_serializer.constantize,
+ record_type: :metafield,
+ object_method_name: :metafields
+ end
end
def self.display_getter_methods(model_klazz)
diff --git a/api/app/serializers/spree/api/v2/platform/metafield_serializer.rb b/api/app/serializers/spree/api/v2/platform/metafield_serializer.rb
new file mode 100644
index 0000000000..790ba4b0ee
--- /dev/null
+++ b/api/app/serializers/spree/api/v2/platform/metafield_serializer.rb
@@ -0,0 +1,21 @@
+module Spree
+ module Api
+ module V2
+ module Platform
+ class MetafieldSerializer < BaseSerializer
+ set_type :metafield
+
+ attributes :name, :type, :display_on
+
+ attribute :key do |metafield|
+ metafield.full_key
+ end
+
+ attribute :value do |metafield|
+ metafield.serialize_value
+ end
+ end
+ end
+ end
+ end
+end
diff --git a/api/app/serializers/spree/v2/storefront/address_serializer.rb b/api/app/serializers/spree/v2/storefront/address_serializer.rb
index 33110b8ec8..64925660aa 100644
--- a/api/app/serializers/spree/v2/storefront/address_serializer.rb
+++ b/api/app/serializers/spree/v2/storefront/address_serializer.rb
@@ -2,6 +2,8 @@ module Spree
module V2
module Storefront
class AddressSerializer < BaseSerializer
+ include Spree::Api::V2::PublicMetafieldsConcern
+
set_type :address
attributes :firstname, :lastname, :address1, :address2, :city, :zipcode, :phone, :state_name,
diff --git a/api/app/serializers/spree/v2/storefront/cart_serializer.rb b/api/app/serializers/spree/v2/storefront/cart_serializer.rb
index 7f49221c1f..87ee88499b 100644
--- a/api/app/serializers/spree/v2/storefront/cart_serializer.rb
+++ b/api/app/serializers/spree/v2/storefront/cart_serializer.rb
@@ -2,6 +2,8 @@ module Spree
module V2
module Storefront
class CartSerializer < BaseSerializer
+ include Spree::Api::V2::PublicMetafieldsConcern
+
set_type :cart
attributes :number, :item_total, :total, :ship_total, :adjustment_total, :created_at,
diff --git a/api/app/serializers/spree/v2/storefront/credit_card_serializer.rb b/api/app/serializers/spree/v2/storefront/credit_card_serializer.rb
index ee3a599cc4..18239ac66b 100644
--- a/api/app/serializers/spree/v2/storefront/credit_card_serializer.rb
+++ b/api/app/serializers/spree/v2/storefront/credit_card_serializer.rb
@@ -2,6 +2,8 @@ module Spree
module V2
module Storefront
class CreditCardSerializer < BaseSerializer
+ include Spree::Api::V2::PublicMetafieldsConcern
+
set_type :credit_card
attributes :cc_type, :last_digits, :month, :year, :name, :default, :gateway_payment_profile_id, :public_metadata
diff --git a/api/app/serializers/spree/v2/storefront/gift_card_serializer.rb b/api/app/serializers/spree/v2/storefront/gift_card_serializer.rb
index ece050200c..962039874f 100644
--- a/api/app/serializers/spree/v2/storefront/gift_card_serializer.rb
+++ b/api/app/serializers/spree/v2/storefront/gift_card_serializer.rb
@@ -2,6 +2,8 @@ module Spree
module V2
module Storefront
class GiftCardSerializer < BaseSerializer
+ include Spree::Api::V2::PublicMetafieldsConcern
+
set_type :gift_card
attributes :amount, :amount_used, :amount_remaining, :display_amount, :display_amount_used,
diff --git a/api/app/serializers/spree/v2/storefront/line_item_serializer.rb b/api/app/serializers/spree/v2/storefront/line_item_serializer.rb
index 0bc1fcd623..da4d973836 100644
--- a/api/app/serializers/spree/v2/storefront/line_item_serializer.rb
+++ b/api/app/serializers/spree/v2/storefront/line_item_serializer.rb
@@ -2,6 +2,8 @@ module Spree
module V2
module Storefront
class LineItemSerializer < BaseSerializer
+ include Spree::Api::V2::PublicMetafieldsConcern
+
set_type :line_item
attributes :name, :quantity, :price, :slug, :options_text, :currency,
diff --git a/api/app/serializers/spree/v2/storefront/metafield_serializer.rb b/api/app/serializers/spree/v2/storefront/metafield_serializer.rb
new file mode 100644
index 0000000000..80ea4e3f0c
--- /dev/null
+++ b/api/app/serializers/spree/v2/storefront/metafield_serializer.rb
@@ -0,0 +1,19 @@
+module Spree
+ module V2
+ module Storefront
+ class MetafieldSerializer < BaseSerializer
+ set_type :metafield
+
+ attributes :name, :type
+
+ attribute :key do |metafield|
+ metafield.full_key
+ end
+
+ attribute :value do |metafield|
+ metafield.serialize_value
+ end
+ end
+ end
+ end
+end
diff --git a/api/app/serializers/spree/v2/storefront/option_type_serializer.rb b/api/app/serializers/spree/v2/storefront/option_type_serializer.rb
index c7df35ce75..9017627a28 100644
--- a/api/app/serializers/spree/v2/storefront/option_type_serializer.rb
+++ b/api/app/serializers/spree/v2/storefront/option_type_serializer.rb
@@ -2,6 +2,8 @@ module Spree
module V2
module Storefront
class OptionTypeSerializer < BaseSerializer
+ include Spree::Api::V2::PublicMetafieldsConcern
+
set_type :option_type
attributes :name, :presentation, :position, :public_metadata
diff --git a/api/app/serializers/spree/v2/storefront/order_serializer.rb b/api/app/serializers/spree/v2/storefront/order_serializer.rb
index 22468b4d69..52f1cc3784 100644
--- a/api/app/serializers/spree/v2/storefront/order_serializer.rb
+++ b/api/app/serializers/spree/v2/storefront/order_serializer.rb
@@ -2,6 +2,8 @@ module Spree
module V2
module Storefront
class OrderSerializer < CartSerializer
+ include Spree::Api::V2::PublicMetafieldsConcern
+
set_type :order
end
end
diff --git a/api/app/serializers/spree/v2/storefront/payment_method_serializer.rb b/api/app/serializers/spree/v2/storefront/payment_method_serializer.rb
index ce5af3ee4d..26a8cad9f6 100644
--- a/api/app/serializers/spree/v2/storefront/payment_method_serializer.rb
+++ b/api/app/serializers/spree/v2/storefront/payment_method_serializer.rb
@@ -2,6 +2,8 @@ module Spree
module V2
module Storefront
class PaymentMethodSerializer < BaseSerializer
+ include Spree::Api::V2::PublicMetafieldsConcern
+
set_type :payment_method
attributes :type, :name, :description, :public_metadata
diff --git a/api/app/serializers/spree/v2/storefront/payment_serializer.rb b/api/app/serializers/spree/v2/storefront/payment_serializer.rb
index b221672857..f2d0f6d316 100644
--- a/api/app/serializers/spree/v2/storefront/payment_serializer.rb
+++ b/api/app/serializers/spree/v2/storefront/payment_serializer.rb
@@ -2,6 +2,8 @@ module Spree
module V2
module Storefront
class PaymentSerializer < BaseSerializer
+ include Spree::Api::V2::PublicMetafieldsConcern
+
set_type :payment
has_one :source, polymorphic: true
diff --git a/api/app/serializers/spree/v2/storefront/payment_source_serializer.rb b/api/app/serializers/spree/v2/storefront/payment_source_serializer.rb
index 7931d73b57..f842c3df22 100644
--- a/api/app/serializers/spree/v2/storefront/payment_source_serializer.rb
+++ b/api/app/serializers/spree/v2/storefront/payment_source_serializer.rb
@@ -2,6 +2,8 @@ module Spree
module V2
module Storefront
class PaymentSourceSerializer < BaseSerializer
+ include Spree::Api::V2::PublicMetafieldsConcern
+
belongs_to :payment_method, serializer: Spree::Api::Dependencies.storefront_payment_method_serializer.constantize
belongs_to :user, serializer: Spree::Api::Dependencies.storefront_user_serializer.constantize
end
diff --git a/api/app/serializers/spree/v2/storefront/product_serializer.rb b/api/app/serializers/spree/v2/storefront/product_serializer.rb
index 1a61950514..d7ee7ce69f 100644
--- a/api/app/serializers/spree/v2/storefront/product_serializer.rb
+++ b/api/app/serializers/spree/v2/storefront/product_serializer.rb
@@ -3,6 +3,7 @@ module Spree
module Storefront
class ProductSerializer < BaseSerializer
include ::Spree::Api::V2::DisplayMoneyHelper
+ include Spree::Api::V2::PublicMetafieldsConcern
set_type :product
diff --git a/api/app/serializers/spree/v2/storefront/promotion_serializer.rb b/api/app/serializers/spree/v2/storefront/promotion_serializer.rb
index 480d88bed6..ae0bc6532b 100644
--- a/api/app/serializers/spree/v2/storefront/promotion_serializer.rb
+++ b/api/app/serializers/spree/v2/storefront/promotion_serializer.rb
@@ -1,3 +1,5 @@
+# this is actually a serializer for Spree::OrderPromotion, not Spree::Promotion
+# we should fix this in the future
module Spree
module V2
module Storefront
diff --git a/api/app/serializers/spree/v2/storefront/shipment_serializer.rb b/api/app/serializers/spree/v2/storefront/shipment_serializer.rb
index 135dcd8284..83ec90fd1f 100644
--- a/api/app/serializers/spree/v2/storefront/shipment_serializer.rb
+++ b/api/app/serializers/spree/v2/storefront/shipment_serializer.rb
@@ -2,6 +2,8 @@ module Spree
module V2
module Storefront
class ShipmentSerializer < BaseSerializer
+ include Spree::Api::V2::PublicMetafieldsConcern
+
set_type :shipment
attributes :number, :final_price, :display_final_price,
diff --git a/api/app/serializers/spree/v2/storefront/shipping_method_serializer.rb b/api/app/serializers/spree/v2/storefront/shipping_method_serializer.rb
index d821d98648..b152c38968 100644
--- a/api/app/serializers/spree/v2/storefront/shipping_method_serializer.rb
+++ b/api/app/serializers/spree/v2/storefront/shipping_method_serializer.rb
@@ -2,6 +2,8 @@ module Spree
module V2
module Storefront
class ShippingMethodSerializer < BaseSerializer
+ include Spree::Api::V2::PublicMetafieldsConcern
+
set_type :shipping_method
attributes :name, :public_metadata
end
diff --git a/api/app/serializers/spree/v2/storefront/store_credit_serializer.rb b/api/app/serializers/spree/v2/storefront/store_credit_serializer.rb
index 713694ceed..5d8eebefc1 100644
--- a/api/app/serializers/spree/v2/storefront/store_credit_serializer.rb
+++ b/api/app/serializers/spree/v2/storefront/store_credit_serializer.rb
@@ -2,6 +2,8 @@ module Spree
module V2
module Storefront
class StoreCreditSerializer < BaseSerializer
+ include Spree::Api::V2::PublicMetafieldsConcern
+
set_type :store_credit
belongs_to :category, serializer: Spree::Api::Dependencies.storefront_store_credit_category_serializer.constantize
diff --git a/api/app/serializers/spree/v2/storefront/store_serializer.rb b/api/app/serializers/spree/v2/storefront/store_serializer.rb
index a8c0186adb..09d37fe5c1 100644
--- a/api/app/serializers/spree/v2/storefront/store_serializer.rb
+++ b/api/app/serializers/spree/v2/storefront/store_serializer.rb
@@ -3,6 +3,7 @@ module Spree
module Storefront
class StoreSerializer < BaseSerializer
include Spree::Api::V2::StoreMediaSerializerImagesConcern
+ include Spree::Api::V2::PublicMetafieldsConcern
set_type :store
diff --git a/api/app/serializers/spree/v2/storefront/taxon_serializer.rb b/api/app/serializers/spree/v2/storefront/taxon_serializer.rb
index 790a5cc265..923d47c7b2 100644
--- a/api/app/serializers/spree/v2/storefront/taxon_serializer.rb
+++ b/api/app/serializers/spree/v2/storefront/taxon_serializer.rb
@@ -2,6 +2,8 @@ module Spree
module V2
module Storefront
class TaxonSerializer < BaseSerializer
+ include Spree::Api::V2::PublicMetafieldsConcern
+
set_type :taxon
attributes :name, :pretty_name, :permalink, :seo_title, :meta_title, :meta_description,
diff --git a/api/app/serializers/spree/v2/storefront/taxonomy_serializer.rb b/api/app/serializers/spree/v2/storefront/taxonomy_serializer.rb
index 2c4792a475..3268de3cd0 100644
--- a/api/app/serializers/spree/v2/storefront/taxonomy_serializer.rb
+++ b/api/app/serializers/spree/v2/storefront/taxonomy_serializer.rb
@@ -2,6 +2,8 @@ module Spree
module V2
module Storefront
class TaxonomySerializer < BaseSerializer
+ include Spree::Api::V2::PublicMetafieldsConcern
+
set_type :taxonomy
attributes :name, :position, :public_metadata
diff --git a/api/app/serializers/spree/v2/storefront/variant_serializer.rb b/api/app/serializers/spree/v2/storefront/variant_serializer.rb
index 27928fd9d4..e7e50652ee 100644
--- a/api/app/serializers/spree/v2/storefront/variant_serializer.rb
+++ b/api/app/serializers/spree/v2/storefront/variant_serializer.rb
@@ -3,6 +3,7 @@ module Spree
module Storefront
class VariantSerializer < BaseSerializer
include ::Spree::Api::V2::DisplayMoneyHelper
+ include Spree::Api::V2::PublicMetafieldsConcern
set_type :variant
diff --git a/api/lib/spree/api/dependencies.rb b/api/lib/spree/api/dependencies.rb
index 3f207ebd3b..94413a8523 100644
--- a/api/lib/spree/api/dependencies.rb
+++ b/api/lib/spree/api/dependencies.rb
@@ -88,6 +88,10 @@ module Spree
storefront_taxon_image_serializer: 'Spree::V2::Storefront::TaxonImageSerializer',
storefront_wishlist_serializer: 'Spree::V2::Storefront::WishlistSerializer',
storefront_wished_item_serializer: 'Spree::V2::Storefront::WishedItemSerializer',
+ storefront_metafield_serializer: 'Spree::V2::Storefront::MetafieldSerializer',
+
+ # platform serializers
+ platform_metafield_serializer: 'Spree::Api::V2::Platform::MetafieldSerializer',
# sorters
storefront_collection_sorter: -> { Spree::Dependencies.collection_sorter },
diff --git a/api/spec/controllers/spree/api/v2/platform/resource_controller_spec.rb b/api/spec/controllers/spree/api/v2/platform/resource_controller_spec.rb
index 6310c8356d..d47dc2e5b6 100644
--- a/api/spec/controllers/spree/api/v2/platform/resource_controller_spec.rb
+++ b/api/spec/controllers/spree/api/v2/platform/resource_controller_spec.rb
@@ -63,5 +63,24 @@ describe Spree::Api::V2::Platform::ResourceController, type: :controller do
end
it { expect(dummy_controller.send(:permitted_resource_params)).to eq(ActionController::Parameters.new(valid_attributes).require(:product).permit!) }
+
+ context 'when model supports metafields' do
+ before do
+ allow(dummy_controller).to receive(:model_class).and_return(Spree::Product)
+ end
+
+ let!(:metafield_definition) { create(:metafield_definition, :short_text_field, resource_type: Spree::Product) }
+
+ let(:valid_attributes) do
+ {
+ product: {
+ name: 'Test',
+ metafields_attributes: [{ metafield_definition_id: metafield_definition.id, value: 'Test' }]
+ }
+ }
+ end
+
+ it { expect(dummy_controller.send(:permitted_resource_params)).to include(:metafields_attributes) }
+ end
end
end
diff --git a/api/spec/requests/spree/api/v2/platform/products_spec.rb b/api/spec/requests/spree/api/v2/platform/products_spec.rb
index 69092c0f75..2703b410e9 100644
--- a/api/spec/requests/spree/api/v2/platform/products_spec.rb
+++ b/api/spec/requests/spree/api/v2/platform/products_spec.rb
@@ -306,6 +306,28 @@ describe 'API V2 Platform Products Spec' do
expect(json_response['data']['attributes']['private_metadata']).to eq private_metadata
end
end
+
+ context 'with metafields' do
+ let(:metafield_definition) { create(:metafield_definition, :short_text_field, resource_type: Spree::Product) }
+
+ let(:params) { { product: { metafields_attributes: [{ metafield_definition_id: metafield_definition.id, value: 'Test' }] }, include: 'metafields' } }
+
+ before { put "/api/v2/platform/products/#{product.id}", params: params, headers: bearer_token }
+
+ it 'returns product with metafields' do
+ product.reload
+
+ expect(product.has_metafield?(metafield_definition.full_key)).to be_truthy
+
+ expect(json_response['included'].count).to eq 1
+ expect(json_response['included'].first['type']).to eq 'metafield'
+ expect(json_response['included'].first['attributes']['name']).to eq metafield_definition.name
+ expect(json_response['included'].first['attributes']['type']).to eq 'Spree::Metafields::ShortText'
+ expect(json_response['included'].first['attributes']['value']).to eq 'Test'
+ expect(json_response['included'].first['attributes']['display_on']).to eq 'both'
+ expect(json_response['included'].first['attributes']['key']).to eq metafield_definition.full_key
+ end
+ end
end
describe 'products#show' do
diff --git a/api/spec/requests/spree/api/v2/storefront/account/credit_cards_spec.rb b/api/spec/requests/spree/api/v2/storefront/account/credit_cards_spec.rb
index 957764d490..53539da1e6 100644
--- a/api/spec/requests/spree/api/v2/storefront/account/credit_cards_spec.rb
+++ b/api/spec/requests/spree/api/v2/storefront/account/credit_cards_spec.rb
@@ -48,7 +48,7 @@ describe 'Storefront API v2 CreditCards spec', type: :request do
let!(:credit_cards) { create_list(:credit_card, 3, user_id: user.id, payment_method: payment_method) }
let(:payment_method) { create(:credit_card_payment_method, display_on: display_on, stores: stores) }
let(:stores) { [@default_store] }
- let(:display_on) { :none }
+ let(:display_on) { :back_end }
it 'does not return any' do
expect(response.status).to eq(200)
diff --git a/api/spec/serializers/spree/api/v2/platform/address_serializer_spec.rb b/api/spec/serializers/spree/api/v2/platform/address_serializer_spec.rb
index 24ae0d5260..a35e9c2410 100644
--- a/api/spec/serializers/spree/api/v2/platform/address_serializer_spec.rb
+++ b/api/spec/serializers/spree/api/v2/platform/address_serializer_spec.rb
@@ -50,6 +50,9 @@ describe Spree::Api::V2::Platform::AddressSerializer do
id: address.user.id.to_s,
type: :user
}
+ },
+ metafields: {
+ data: []
}
}
}
diff --git a/api/spec/serializers/spree/api/v2/platform/asset_serializer_spec.rb b/api/spec/serializers/spree/api/v2/platform/asset_serializer_spec.rb
index d9232f3a2c..c8ce92115a 100644
--- a/api/spec/serializers/spree/api/v2/platform/asset_serializer_spec.rb
+++ b/api/spec/serializers/spree/api/v2/platform/asset_serializer_spec.rb
@@ -34,6 +34,9 @@ describe Spree::Api::V2::Platform::AssetSerializer do
id: viewable.id.to_s,
type: :variant
}
+ },
+ metafields: {
+ data: []
}
},
type: type
diff --git a/api/spec/serializers/spree/api/v2/platform/option_type_serializer_spec.rb b/api/spec/serializers/spree/api/v2/platform/option_type_serializer_spec.rb
index 83324f5ff3..d676129ee0 100644
--- a/api/spec/serializers/spree/api/v2/platform/option_type_serializer_spec.rb
+++ b/api/spec/serializers/spree/api/v2/platform/option_type_serializer_spec.rb
@@ -33,6 +33,9 @@ describe Spree::Api::V2::Platform::OptionTypeSerializer do
type: :option_value
}
]
+ },
+ metafields: {
+ data: []
}
}
}
diff --git a/api/spec/serializers/spree/api/v2/platform/option_value_serializer_spec.rb b/api/spec/serializers/spree/api/v2/platform/option_value_serializer_spec.rb
index 86fb3ff0b9..1710215590 100644
--- a/api/spec/serializers/spree/api/v2/platform/option_value_serializer_spec.rb
+++ b/api/spec/serializers/spree/api/v2/platform/option_value_serializer_spec.rb
@@ -28,6 +28,9 @@ describe Spree::Api::V2::Platform::OptionValueSerializer do
type: :option_type
}
},
+ metafields: {
+ data: []
+ }
}
}
}
diff --git a/api/spec/serializers/spree/api/v2/platform/product_serializer_spec.rb b/api/spec/serializers/spree/api/v2/platform/product_serializer_spec.rb
index 664464034e..1b5870dcfb 100644
--- a/api/spec/serializers/spree/api/v2/platform/product_serializer_spec.rb
+++ b/api/spec/serializers/spree/api/v2/platform/product_serializer_spec.rb
@@ -131,6 +131,9 @@ describe Spree::Api::V2::Platform::ProductSerializer do
}
]
},
+ metafields: {
+ data: []
+ }
}
}
}
diff --git a/api/spec/serializers/spree/api/v2/platform/promotion_serializer_spec.rb b/api/spec/serializers/spree/api/v2/platform/promotion_serializer_spec.rb
index dc4b316059..055d90c2cc 100644
--- a/api/spec/serializers/spree/api/v2/platform/promotion_serializer_spec.rb
+++ b/api/spec/serializers/spree/api/v2/platform/promotion_serializer_spec.rb
@@ -64,6 +64,9 @@ describe Spree::Api::V2::Platform::PromotionSerializer do
type: :store
}
]
+ },
+ metafields: {
+ data: []
}
}
}
diff --git a/api/spec/serializers/spree/api/v2/platform/stock_item_serializer_spec.rb b/api/spec/serializers/spree/api/v2/platform/stock_item_serializer_spec.rb
index 9565e0c973..a341f435ff 100644
--- a/api/spec/serializers/spree/api/v2/platform/stock_item_serializer_spec.rb
+++ b/api/spec/serializers/spree/api/v2/platform/stock_item_serializer_spec.rb
@@ -35,6 +35,9 @@ describe Spree::Api::V2::Platform::StockItemSerializer do
id: resource.variant.id.to_s,
type: :variant
}
+ },
+ metafields: {
+ data: []
}
},
type: type
diff --git a/api/spec/serializers/spree/api/v2/platform/stock_transfer_serializer_spec.rb b/api/spec/serializers/spree/api/v2/platform/stock_transfer_serializer_spec.rb
index f5a2eeff85..9c4a3bb113 100644
--- a/api/spec/serializers/spree/api/v2/platform/stock_transfer_serializer_spec.rb
+++ b/api/spec/serializers/spree/api/v2/platform/stock_transfer_serializer_spec.rb
@@ -45,6 +45,9 @@ describe Spree::Api::V2::Platform::StockTransferSerializer do
id: destination_location.id.to_s,
type: :stock_location
}
+ },
+ metafields: {
+ data: []
}
},
type: type,
diff --git a/api/spec/serializers/spree/api/v2/platform/store_serializer_spec.rb b/api/spec/serializers/spree/api/v2/platform/store_serializer_spec.rb
index dcb7263569..b32f7cdf01 100644
--- a/api/spec/serializers/spree/api/v2/platform/store_serializer_spec.rb
+++ b/api/spec/serializers/spree/api/v2/platform/store_serializer_spec.rb
@@ -59,6 +59,9 @@ describe Spree::Api::V2::Platform::StoreSerializer do
id: store.default_country.id.to_s,
type: :country
}
+ },
+ metafields: {
+ data: []
}
},
}
diff --git a/api/spec/serializers/spree/api/v2/platform/taxon_serializer_spec.rb b/api/spec/serializers/spree/api/v2/platform/taxon_serializer_spec.rb
index d2c2d555fd..92c9594b6d 100644
--- a/api/spec/serializers/spree/api/v2/platform/taxon_serializer_spec.rb
+++ b/api/spec/serializers/spree/api/v2/platform/taxon_serializer_spec.rb
@@ -72,6 +72,9 @@ describe Spree::Api::V2::Platform::TaxonSerializer do
type: :taxon
}
]
+ },
+ metafields: {
+ data: []
}
}
}
@@ -158,6 +161,9 @@ describe Spree::Api::V2::Platform::TaxonSerializer do
type: :taxon
}
)
+ },
+ metafields: {
+ data: []
}
}
}
diff --git a/api/spec/serializers/spree/api/v2/platform/taxonomy_serializer_spec.rb b/api/spec/serializers/spree/api/v2/platform/taxonomy_serializer_spec.rb
index e4835a0864..ed6b903103 100644
--- a/api/spec/serializers/spree/api/v2/platform/taxonomy_serializer_spec.rb
+++ b/api/spec/serializers/spree/api/v2/platform/taxonomy_serializer_spec.rb
@@ -39,6 +39,9 @@ describe Spree::Api::V2::Platform::TaxonomySerializer, retry: 3 do
},
taxons: {
data: taxons_json
+ },
+ metafields: {
+ data: []
}
}
}
diff --git a/api/spec/serializers/spree/api/v2/platform/variant_serializer_spec.rb b/api/spec/serializers/spree/api/v2/platform/variant_serializer_spec.rb
index 5a23ad6bf0..bc2a5b0f03 100644
--- a/api/spec/serializers/spree/api/v2/platform/variant_serializer_spec.rb
+++ b/api/spec/serializers/spree/api/v2/platform/variant_serializer_spec.rb
@@ -102,6 +102,9 @@ describe Spree::Api::V2::Platform::VariantSerializer do
type: :stock_item
}
]
+ },
+ metafields: {
+ data: []
}
}
}
diff --git a/api/spec/serializers/spree/v2/storefront/taxon_serializer_spec.rb b/api/spec/serializers/spree/v2/storefront/taxon_serializer_spec.rb
index c9a92f27e5..7babfda614 100644
--- a/api/spec/serializers/spree/v2/storefront/taxon_serializer_spec.rb
+++ b/api/spec/serializers/spree/v2/storefront/taxon_serializer_spec.rb
@@ -10,6 +10,9 @@ describe Spree::V2::Storefront::TaxonSerializer do
let!(:children) { create_list(:taxon, 2, taxonomy: taxonomy, parent: taxon) }
let(:url_helpers) { Rails.application.routes.url_helpers }
+ let!(:metafield_definition) { create(:metafield_definition, :short_text_field, resource_type: 'Spree::Taxon') }
+ let!(:metafield) { create(:metafield, metafield_definition: metafield_definition, resource: taxon, value: 'Additional Info') }
+
before do
taxon.reload # Reload taxon to ensure all associations are loaded
end
@@ -73,6 +76,14 @@ describe Spree::V2::Storefront::TaxonSerializer do
id: taxon.icon.id.to_s,
type: :taxon_image
}
+ },
+ metafields: {
+ data: [
+ {
+ id: metafield.id.to_s,
+ type: :metafield
+ }
+ ]
}
}
}
@@ -156,6 +167,14 @@ describe Spree::V2::Storefront::TaxonSerializer do
id: taxon.icon.id.to_s,
type: :taxon_image
}
+ },
+ metafields: {
+ data: [
+ {
+ id: metafield.id.to_s,
+ type: :metafield
+ }
+ ]
}
}
}
diff --git a/core/.cursor/rules/core.mdc b/core/.cursor/rules/core.mdc
index 10b182ee68..00b8331e2c 100644
--- a/core/.cursor/rules/core.mdc
+++ b/core/.cursor/rules/core.mdc
@@ -13,8 +13,7 @@ alwaysApply: true
```ruby
# ✅ Core model structure
class Spree::Product < Spree.base_class
- include Spree::Metadata
- include Spree::SoftDeletable
+ include Spree::Metafields
has_many :variants, -> { order(:position) }, class_name: 'Spree::Variant',
dependent: :destroy, inverse_of: :product
@@ -115,13 +114,13 @@ class CreateSpreeMetafields < ActiveRecord::Migration[7.0]
t.text :value, null: false
t.string :kind, null: false, default: 'single_line_text_field'
t.string :visibility, null: false, default: 'private'
- t.references :owner, polymorphic: true, null: false, index: false
+ t.references :resource, polymorphic: true, null: false, index: false
t.timestamps
t.datetime :deleted_at, index: true
end
- add_index :spree_metafields, [:owner_type, :owner_id, :key, :visibility],
- name: 'index_spree_metafields_on_owner_and_key_and_visibility'
+ add_index :spree_metafields, [:resource_type, :resource_id, :key, :visibility],
+ name: 'index_spree_metafields_on_resource_and_key_and_visibility'
add_index :spree_metafields, :key
end
end
diff --git a/core/app/models/concerns/spree/display_on.rb b/core/app/models/concerns/spree/display_on.rb
index aa16562d5e..dafd64e473 100644
--- a/core/app/models/concerns/spree/display_on.rb
+++ b/core/app/models/concerns/spree/display_on.rb
@@ -2,12 +2,14 @@ module Spree
module DisplayOn
extend ActiveSupport::Concern
- DISPLAY = [:both, :front_end, :back_end].freeze
+ DISPLAY = [:both, :front_end, :back_end]
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]) }
+
+ validates :display_on, presence: true, inclusion: { in: DISPLAY.map(&:to_s) }
end
end
end
diff --git a/core/app/models/concerns/spree/metadata.rb b/core/app/models/concerns/spree/metadata.rb
index 15b9698ad4..aa4feb2027 100644
--- a/core/app/models/concerns/spree/metadata.rb
+++ b/core/app/models/concerns/spree/metadata.rb
@@ -2,6 +2,8 @@ module Spree
module Metadata
extend ActiveSupport::Concern
+ include Spree::Metafields unless included_modules.include?(Spree::Metafields)
+
included do
attribute :public_metadata, default: {}
attribute :private_metadata, default: {}
diff --git a/core/app/models/concerns/spree/metafields.rb b/core/app/models/concerns/spree/metafields.rb
new file mode 100644
index 0000000000..62f7628328
--- /dev/null
+++ b/core/app/models/concerns/spree/metafields.rb
@@ -0,0 +1,53 @@
+module Spree
+ module Metafields
+ extend ActiveSupport::Concern
+
+ included do
+ has_many :metafields, -> { includes(:metafield_definition) }, as: :resource, class_name: 'Spree::Metafield', dependent: :destroy
+ has_many :public_metafields, -> { includes(:metafield_definition).available_on_front_end }, as: :resource, class_name: 'Spree::Metafield'
+ has_many :private_metafields, -> { includes(:metafield_definition).available_on_back_end }, as: :resource, class_name: 'Spree::Metafield'
+
+ accepts_nested_attributes_for :metafields, allow_destroy: true, reject_if: lambda { |mf|
+ mf[:metafield_definition_id].blank? || (mf[:id].blank? && mf[:value].blank?)
+ }
+
+ scope :with_metafield_key, ->(namespace, key) { joins(metafields: :metafield_definition).where(spree_metafield_definitions: { namespace: namespace, key: key }) }
+ scope :with_metafield_key_value, ->(namespace, key, value) {
+ joins(metafields: :metafield_definition)
+ .where(spree_metafield_definitions: { namespace: namespace, key: key })
+ .where(spree_metafields: { value: value })
+ }
+
+ def set_metafield(key_with_namespace, value)
+ namespace = key_with_namespace.to_s.split('.').first
+ key = key_with_namespace.to_s.split('.').last
+ metafield_definition = Spree::MetafieldDefinition.find_or_create_by!(namespace: namespace, key: key, resource_type: self.class.name)
+
+ metafield = metafields.find_or_initialize_by(metafield_definition: metafield_definition)
+ metafield.value = value
+ metafield.save!
+ metafield
+ end
+
+ def get_metafield(key_with_namespace)
+ namespace = key_with_namespace.to_s.split('.').first
+ key = key_with_namespace.to_s.split('.').last
+ metafields.with_key(namespace, key).first
+ end
+
+ def has_metafield?(key_with_namespace)
+ if key_with_namespace.is_a?(Spree::MetafieldDefinition)
+ namespace = key_with_namespace.namespace
+ key = key_with_namespace.key
+ elsif key_with_namespace.is_a?(String)
+ namespace = key_with_namespace.to_s.split('.').first
+ key = key_with_namespace.to_s.split('.').last
+ else
+ raise ArgumentError, "Invalid key_with_namespace: #{key_with_namespace.inspect}"
+ end
+
+ metafields.with_key(namespace, key).exists?
+ end
+ end
+ end
+end
diff --git a/core/app/models/concerns/spree/user_methods.rb b/core/app/models/concerns/spree/user_methods.rb
index 0fa3cfac30..e14d406d0f 100644
--- a/core/app/models/concerns/spree/user_methods.rb
+++ b/core/app/models/concerns/spree/user_methods.rb
@@ -2,6 +2,7 @@ module Spree
module UserMethods
extend ActiveSupport::Concern
+ include Spree::Metafields
include Spree::UserPaymentSource
include Spree::UserReporting
include Spree::UserRoles
diff --git a/core/app/models/spree/address.rb b/core/app/models/spree/address.rb
index 22045673a3..87ba338314 100644
--- a/core/app/models/spree/address.rb
+++ b/core/app/models/spree/address.rb
@@ -2,6 +2,7 @@ module Spree
class Address < Spree.base_class
require 'validates_zipcode'
+ include Spree::Metafields
include Spree::Metadata
if defined?(Spree::Webhooks::HasWebhooks)
include Spree::Webhooks::HasWebhooks
@@ -43,7 +44,8 @@ module Spree
belongs_to :country, class_name: 'Spree::Country'
belongs_to :state, class_name: 'Spree::State', optional: true
- belongs_to :user, class_name: Spree.user_class.name, optional: true, touch: true
+ # we need a safe operator here as Address is added to metafield_enabled_resources in Engine
+ belongs_to :user, class_name: Spree.user_class&.name, optional: true, touch: true
has_many :shipments, inverse_of: :address
diff --git a/core/app/models/spree/asset.rb b/core/app/models/spree/asset.rb
index e819394629..5914ad451c 100644
--- a/core/app/models/spree/asset.rb
+++ b/core/app/models/spree/asset.rb
@@ -1,6 +1,7 @@
module Spree
class Asset < Spree.base_class
include Support::ActiveStorage
+ include Spree::Metafields
include Spree::Metadata
if defined?(Spree::Webhooks::HasWebhooks)
include Spree::Webhooks::HasWebhooks
diff --git a/core/app/models/spree/credit_card.rb b/core/app/models/spree/credit_card.rb
index d084a490d0..efd04ee8c7 100644
--- a/core/app/models/spree/credit_card.rb
+++ b/core/app/models/spree/credit_card.rb
@@ -1,6 +1,7 @@
module Spree
class CreditCard < Spree.base_class
include ActiveMerchant::Billing::CreditCardMethods
+ include Spree::Metafields
include Spree::Metadata
include Spree::PaymentSourceConcern
diff --git a/core/app/models/spree/custom_domain.rb b/core/app/models/spree/custom_domain.rb
index dd40f553cb..eba29c5644 100644
--- a/core/app/models/spree/custom_domain.rb
+++ b/core/app/models/spree/custom_domain.rb
@@ -1,6 +1,7 @@
module Spree
class CustomDomain < Spree::Base
include Spree::SingleStoreResource
+ include Spree::Metafields
include Spree::Metadata
auto_strip_attributes :url
diff --git a/core/app/models/spree/customer_return.rb b/core/app/models/spree/customer_return.rb
index e6bfc128fe..cdf45c844c 100644
--- a/core/app/models/spree/customer_return.rb
+++ b/core/app/models/spree/customer_return.rb
@@ -2,6 +2,7 @@ module Spree
class CustomerReturn < Spree.base_class
include Spree::Core::NumberGenerator.new(prefix: 'CR', length: 9)
include Spree::NumberIdentifier
+ include Spree::Metafields
include Spree::Metadata
if defined?(Spree::Webhooks::HasWebhooks)
include Spree::Webhooks::HasWebhooks
diff --git a/core/app/models/spree/gift_card.rb b/core/app/models/spree/gift_card.rb
index f34416b907..2b8fe157dc 100644
--- a/core/app/models/spree/gift_card.rb
+++ b/core/app/models/spree/gift_card.rb
@@ -2,6 +2,7 @@ module Spree
class GiftCard < Spree.base_class
extend DisplayMoney
include Spree::SingleStoreResource
+ include Spree::Metafields
include Spree::Security::GiftCards if defined?(Spree::Security::GiftCards)
#
diff --git a/core/app/models/spree/legacy_user.rb b/core/app/models/spree/legacy_user.rb
index c1dfc48234..e31108ec9d 100644
--- a/core/app/models/spree/legacy_user.rb
+++ b/core/app/models/spree/legacy_user.rb
@@ -4,7 +4,6 @@ module Spree
include Spree::UserAddress
include Spree::UserPaymentSource
include Spree::UserMethods
- include Spree::Metadata
self.table_name = 'spree_users'
diff --git a/core/app/models/spree/line_item.rb b/core/app/models/spree/line_item.rb
index 98e089f2cd..235c062be9 100644
--- a/core/app/models/spree/line_item.rb
+++ b/core/app/models/spree/line_item.rb
@@ -1,5 +1,6 @@
module Spree
class LineItem < Spree.base_class
+ include Spree::Metafields
include Spree::Metadata
if defined?(Spree::Webhooks::HasWebhooks)
include Spree::Webhooks::HasWebhooks
diff --git a/core/app/models/spree/metafield.rb b/core/app/models/spree/metafield.rb
new file mode 100644
index 0000000000..fc7dc9f8dc
--- /dev/null
+++ b/core/app/models/spree/metafield.rb
@@ -0,0 +1,49 @@
+module Spree
+ class Metafield < Spree.base_class
+ #
+ # Associations
+ #
+ belongs_to :resource, polymorphic: true, touch: true
+ belongs_to :metafield_definition, class_name: 'Spree::MetafieldDefinition'
+
+ #
+ # Delegations
+ #
+ delegate :key, :full_key, :name, :display_on, to: :metafield_definition, allow_nil: true
+
+ #
+ # Callbacks
+ #
+ before_validation :set_type_from_metafield_definition, on: :create
+
+ #
+ # Validations
+ #
+ validates :metafield_definition, :type, :resource, :value, presence: true
+ validates :metafield_definition_id, uniqueness: { scope: [:resource_type, :resource_id] }
+ validate :type_must_match_metafield_definition
+
+ #
+ # Scopes
+ #
+ scope :available_on_front_end, -> { joins(:metafield_definition).merge(Spree::MetafieldDefinition.available_on_front_end) }
+ scope :available_on_back_end, -> { joins(:metafield_definition).merge(Spree::MetafieldDefinition.available_on_back_end) }
+ scope :with_key, ->(namespace, key) { joins(:metafield_definition).where(spree_metafield_definitions: { namespace: namespace, key: key }) }
+
+ def serialize_value
+ value
+ end
+
+ private
+
+ def set_type_from_metafield_definition
+ self.type ||= metafield_definition.metafield_type
+ end
+
+ def type_must_match_metafield_definition
+ return if metafield_definition.blank?
+
+ errors.add(:type, 'must match metafield definition') unless type == metafield_definition.metafield_type
+ end
+ end
+end
diff --git a/core/app/models/spree/metafield_definition.rb b/core/app/models/spree/metafield_definition.rb
new file mode 100644
index 0000000000..bc20b1d8ad
--- /dev/null
+++ b/core/app/models/spree/metafield_definition.rb
@@ -0,0 +1,74 @@
+module Spree
+ class MetafieldDefinition < Spree.base_class
+ include Spree::DisplayOn
+
+ DISPLAY = [:both, :back_end]
+
+ #
+ # Associations
+ #
+ has_many :metafields, class_name: 'Spree::Metafield', dependent: :destroy
+
+ #
+ # Validations
+ #
+ validates :namespace, :key, :name, :resource_type, presence: true
+ validates :metafield_type, presence: true, inclusion: { in: :valid_available_types }
+ validates :resource_type, presence: true, inclusion: { in: :valid_available_resources }
+ validates :key, uniqueness: { scope: spree_base_uniqueness_scope + [:resource_type, :namespace] }
+
+ #
+ # Scopes
+ #
+ scope :for_resource_type, ->(resource_type) { where(resource_type: resource_type) }
+
+ #
+ # Callbacks
+ #
+ normalizes :key, with: ->(value) { value.to_s.parameterize.underscore.strip }
+ normalizes :namespace, with: ->(value) { value.to_s.parameterize.underscore.strip }
+ before_validation :set_default_type, if: -> { metafield_type.blank? }, on: :create
+ before_validation :set_name_from_key, if: -> { name.blank? }, on: :create
+
+ #
+ # Ransack
+ #
+ self.whitelisted_ransackable_attributes = %w[key namespace name resource_type display_on]
+
+ # Returns the full key with namespace
+ # @return [String] eg. custom.id
+ def full_key
+ "#{namespace}.#{key}"
+ end
+
+ # Returns the available types
+ # @return [Array<Class>]
+ def self.available_types
+ Rails.application.config.spree.metafield_types
+ end
+
+ # Returns the available resources
+ # @return [Array<Class>]
+ def self.available_resources
+ Rails.application.config.spree.metafield_enabled_resources
+ end
+
+ private
+
+ def valid_available_types
+ self.class.available_types.map(&:to_s)
+ end
+
+ def valid_available_resources
+ self.class.available_resources.map(&:to_s)
+ end
+
+ def set_default_type
+ self.metafield_type ||= Rails.application.config.spree.metafield_types.first.to_s
+ end
+
+ def set_name_from_key
+ self.name ||= key.titleize
+ end
+ end
+end
diff --git a/core/app/models/spree/metafields/boolean.rb b/core/app/models/spree/metafields/boolean.rb
new file mode 100644
index 0000000000..74ac6e506f
--- /dev/null
+++ b/core/app/models/spree/metafields/boolean.rb
@@ -0,0 +1,7 @@
+module Spree
+ module Metafields
+ class Boolean < Spree::Metafield
+ normalizes :value, with: lambda(&:to_b)
+ end
+ end
+end
diff --git a/core/app/models/spree/metafields/long_text.rb b/core/app/models/spree/metafields/long_text.rb
new file mode 100644
index 0000000000..a58625e9c9
--- /dev/null
+++ b/core/app/models/spree/metafields/long_text.rb
@@ -0,0 +1,7 @@
+module Spree
+ module Metafields
+ class LongText < Spree::Metafield
+ normalizes :value, with: ->(value) { value.to_s.strip }
+ end
+ end
+end
diff --git a/core/app/models/spree/metafields/number.rb b/core/app/models/spree/metafields/number.rb
new file mode 100644
index 0000000000..a460d4f7c9
--- /dev/null
+++ b/core/app/models/spree/metafields/number.rb
@@ -0,0 +1,11 @@
+module Spree
+ module Metafields
+ class Number < Spree::Metafield
+ validates :value, numericality: true
+
+ def serialize_value
+ value.to_d
+ end
+ end
+ end
+end
diff --git a/core/app/models/spree/metafields/rich_text.rb b/core/app/models/spree/metafields/rich_text.rb
new file mode 100644
index 0000000000..3fb51fada0
--- /dev/null
+++ b/core/app/models/spree/metafields/rich_text.rb
@@ -0,0 +1,14 @@
+module Spree
+ module Metafields
+ class RichText < Spree::Metafield
+ # Avoid collision with the `value` column used by other metafield types
+ self.ignored_columns = %w[value]
+
+ has_rich_text :value
+
+ def serialize_value
+ value&.body&.to_s
+ end
+ end
+ end
+end
diff --git a/core/app/models/spree/metafields/short_text.rb b/core/app/models/spree/metafields/short_text.rb
new file mode 100644
index 0000000000..4edbd2da7a
--- /dev/null
+++ b/core/app/models/spree/metafields/short_text.rb
@@ -0,0 +1,7 @@
+module Spree
+ module Metafields
+ class ShortText < Spree::Metafield
+ normalizes :value, with: ->(value) { value.to_s.strip }
+ end
+ end
+end
diff --git a/core/app/models/spree/newsletter_subscriber.rb b/core/app/models/spree/newsletter_subscriber.rb
index 8ddc1f39d2..6b29faa03a 100644
--- a/core/app/models/spree/newsletter_subscriber.rb
+++ b/core/app/models/spree/newsletter_subscriber.rb
@@ -3,13 +3,14 @@ require_dependency 'spree/newsletter_subscriber/emails'
module Spree
class NewsletterSubscriber < Spree.base_class
include Spree::NewsletterSubscriber::Emails
+ include Spree::Metafields
has_secure_token :verification_token
#
# Associations
#
- belongs_to :user, optional: true, class_name: Spree.user_class.name
+ belongs_to :user, optional: true, class_name: Spree.user_class&.name
#
# Validations
diff --git a/core/app/models/spree/option_type.rb b/core/app/models/spree/option_type.rb
index 450920668c..8647f47f73 100644
--- a/core/app/models/spree/option_type.rb
+++ b/core/app/models/spree/option_type.rb
@@ -4,6 +4,7 @@ module Spree
include Spree::ParameterizableName
include Spree::UniqueName
+ include Spree::Metafields
include Spree::Metadata
include Spree::TranslatableResource
if defined?(Spree::Webhooks::HasWebhooks)
diff --git a/core/app/models/spree/option_value.rb b/core/app/models/spree/option_value.rb
index 28f356e2c2..3a2df5d6c7 100644
--- a/core/app/models/spree/option_value.rb
+++ b/core/app/models/spree/option_value.rb
@@ -1,6 +1,7 @@
module Spree
class OptionValue < Spree.base_class
include Spree::ParameterizableName
+ include Spree::Metafields
include Spree::Metadata
include Spree::TranslatableResource
if defined?(Spree::Webhooks::HasWebhooks)
diff --git a/core/app/models/spree/order.rb b/core/app/models/spree/order.rb
index c9aa27f093..ff270ea347 100644
--- a/core/app/models/spree/order.rb
+++ b/core/app/models/spree/order.rb
@@ -29,6 +29,7 @@ module Spree
include Spree::NumberAsParam
include Spree::SingleStoreResource
include Spree::MemoizedData
+ include Spree::Metafields
include Spree::Metadata
include Spree::MultiSearchable
if defined?(Spree::Security::Orders)
diff --git a/core/app/models/spree/payment.rb b/core/app/models/spree/payment.rb
index 66c742f3b9..4f29617529 100644
--- a/core/app/models/spree/payment.rb
+++ b/core/app/models/spree/payment.rb
@@ -5,6 +5,7 @@ module Spree
include Spree::Core::NumberGenerator.new(prefix: 'P', letters: true, length: 7)
include Spree::NumberIdentifier
include Spree::NumberAsParam
+ include Spree::Metafields
include Spree::Metadata
if defined?(Spree::Security::Payments)
include Spree::Security::Payments
diff --git a/core/app/models/spree/payment_method.rb b/core/app/models/spree/payment_method.rb
index 9e66baa99c..eb94cca0c8 100644
--- a/core/app/models/spree/payment_method.rb
+++ b/core/app/models/spree/payment_method.rb
@@ -4,6 +4,7 @@ module Spree
acts_as_list
include Spree::MultiStoreResource
+ include Spree::Metafields
include Spree::Metadata
include Spree::DisplayOn
if defined?(Spree::Security::PaymentMethods)
diff --git a/core/app/models/spree/payment_source.rb b/core/app/models/spree/payment_source.rb
index a0fde84ca8..a4aa0f79fb 100644
--- a/core/app/models/spree/payment_source.rb
+++ b/core/app/models/spree/payment_source.rb
@@ -1,6 +1,7 @@
# This model is used to store payment sources for non-credit card payments, eg wallet, account, etc.
module Spree
class PaymentSource < Spree.base_class
+ include Spree::Metafields
include Spree::Metadata
include Spree::PaymentSourceConcern
diff --git a/core/app/models/spree/product.rb b/core/app/models/spree/product.rb
index 117250aac3..cb11591082 100644
--- a/core/app/models/spree/product.rb
+++ b/core/app/models/spree/product.rb
@@ -28,6 +28,7 @@ module Spree
include Spree::MultiStoreResource
include Spree::TranslatableResource
include Spree::MemoizedData
+ include Spree::Metafields
include Spree::Metadata
include Spree::Linkable
include Spree::Product::Webhooks
diff --git a/core/app/models/spree/promotion.rb b/core/app/models/spree/promotion.rb
index 8b1036af91..5e197a4e12 100644
--- a/core/app/models/spree/promotion.rb
+++ b/core/app/models/spree/promotion.rb
@@ -1,6 +1,7 @@
module Spree
class Promotion < Spree.base_class
include Spree::MultiStoreResource
+ include Spree::Metafields
include Spree::Metadata
if defined?(Spree::Webhooks::HasWebhooks)
include Spree::Webhooks::HasWebhooks
diff --git a/core/app/models/spree/refund.rb b/core/app/models/spree/refund.rb
index 7a965d0e5d..8df09f6de4 100644
--- a/core/app/models/spree/refund.rb
+++ b/core/app/models/spree/refund.rb
@@ -1,5 +1,6 @@
module Spree
class Refund < Spree.base_class
+ include Spree::Metafields
include Spree::Metadata
if defined?(Spree::Webhooks::HasWebhooks)
include Spree::Webhooks::HasWebhooks
diff --git a/core/app/models/spree/shipment.rb b/core/app/models/spree/shipment.rb
index 89858fbb3b..cf5ce7156d 100644
--- a/core/app/models/spree/shipment.rb
+++ b/core/app/models/spree/shipment.rb
@@ -5,6 +5,7 @@ module Spree
include Spree::Core::NumberGenerator.new(prefix: 'H', length: 11)
include Spree::NumberIdentifier
include Spree::NumberAsParam
+ include Spree::Metafields
include Spree::Metadata
if defined?(Spree::Security::Shipments)
include Spree::Security::Shipments
diff --git a/core/app/models/spree/shipping_method.rb b/core/app/models/spree/shipping_method.rb
index 701e9a31de..dc43e27914 100644
--- a/core/app/models/spree/shipping_method.rb
+++ b/core/app/models/spree/shipping_method.rb
@@ -2,6 +2,7 @@ module Spree
class ShippingMethod < Spree.base_class
acts_as_paranoid
include Spree::CalculatedAdjustments
+ include Spree::Metafields
include Spree::Metadata
include Spree::DisplayOn
if defined?(Spree::Webhooks::HasWebhooks)
diff --git a/core/app/models/spree/stock_item.rb b/core/app/models/spree/stock_item.rb
index d084e25bbc..c65544824a 100644
--- a/core/app/models/spree/stock_item.rb
+++ b/core/app/models/spree/stock_item.rb
@@ -2,6 +2,7 @@ module Spree
class StockItem < Spree.base_class
acts_as_paranoid
+ include Spree::Metafields
include Spree::Metadata
include Spree::StockItem::Webhooks
diff --git a/core/app/models/spree/stock_transfer.rb b/core/app/models/spree/stock_transfer.rb
index b2f1761e6c..bf83ffe5f8 100644
--- a/core/app/models/spree/stock_transfer.rb
+++ b/core/app/models/spree/stock_transfer.rb
@@ -3,6 +3,7 @@ module Spree
include Spree::Core::NumberGenerator.new(prefix: 'T')
include Spree::NumberIdentifier
include Spree::NumberAsParam
+ include Spree::Metafields
include Spree::Metadata
if defined?(Spree::Webhooks::HasWebhooks)
include Spree::Webhooks::HasWebhooks
diff --git a/core/app/models/spree/store.rb b/core/app/models/spree/store.rb
index af7feec565..229b2d3c1b 100644
--- a/core/app/models/spree/store.rb
+++ b/core/app/models/spree/store.rb
@@ -8,6 +8,7 @@ module Spree
include FriendlyId
include Spree::TranslatableResource
+ include Spree::Metafields
include Spree::Metadata
include Spree::Stores::Setup
include Spree::Stores::Socials
diff --git a/core/app/models/spree/store_credit.rb b/core/app/models/spree/store_credit.rb
index 489e72155a..4b81765af3 100644
--- a/core/app/models/spree/store_credit.rb
+++ b/core/app/models/spree/store_credit.rb
@@ -1,6 +1,7 @@
module Spree
class StoreCredit < Spree.base_class
include Spree::SingleStoreResource
+ include Spree::Metafields
include Spree::Metadata
if defined?(Spree::Webhooks::HasWebhooks)
include Spree::Webhooks::HasWebhooks
diff --git a/core/app/models/spree/tax_category.rb b/core/app/models/spree/tax_category.rb
index e61c14afd8..2fac3c7817 100644
--- a/core/app/models/spree/tax_category.rb
+++ b/core/app/models/spree/tax_category.rb
@@ -5,7 +5,7 @@ module Spree
end
acts_as_paranoid
- validates :name, presence: true, uniqueness: { case_sensitive: false, scope: spree_base_uniqueness_scope.push(:deleted_at) }
+ validates :name, presence: true, uniqueness: { case_sensitive: false, scope: spree_base_uniqueness_scope + [:deleted_at] }
has_many :tax_rates, dependent: :destroy, inverse_of: :tax_category
has_many :products, dependent: :nullify
diff --git a/core/app/models/spree/tax_rate.rb b/core/app/models/spree/tax_rate.rb
index 0855689204..6074304ddd 100644
--- a/core/app/models/spree/tax_rate.rb
+++ b/core/app/models/spree/tax_rate.rb
@@ -4,6 +4,7 @@ module Spree
include Spree::CalculatedAdjustments
include Spree::AdjustmentSource
+ include Spree::Metafields
include Spree::Metadata
if defined?(Spree::Webhooks::HasWebhooks)
include Spree::Webhooks::HasWebhooks
diff --git a/core/app/models/spree/taxon.rb b/core/app/models/spree/taxon.rb
index f97cf4409f..0f7a6d4092 100644
--- a/core/app/models/spree/taxon.rb
+++ b/core/app/models/spree/taxon.rb
@@ -16,6 +16,7 @@ module Spree
include Spree::TranslatableResource
include Spree::TranslatableResourceSlug
+ include Spree::Metafields
include Spree::Metadata
include Spree::MemoizedData
include Spree::Linkable
diff --git a/core/app/models/spree/taxonomy.rb b/core/app/models/spree/taxonomy.rb
index 6cb2fb35d1..b52ba1f6b4 100644
--- a/core/app/models/spree/taxonomy.rb
+++ b/core/app/models/spree/taxonomy.rb
@@ -1,6 +1,7 @@
module Spree
class Taxonomy < Spree.base_class
include Spree::TranslatableResource
+ include Spree::Metafields
include Spree::Metadata
include Spree::SingleStoreResource
if defined?(Spree::Webhooks::HasWebhooks)
diff --git a/core/app/models/spree/variant.rb b/core/app/models/spree/variant.rb
index 0279b52f61..ea98fb58a2 100644
--- a/core/app/models/spree/variant.rb
+++ b/core/app/models/spree/variant.rb
@@ -4,6 +4,7 @@ module Spree
acts_as_list scope: :product
include Spree::MemoizedData
+ include Spree::Metafields
include Spree::Metadata
include Spree::Variant::Webhooks
diff --git a/core/config/locales/en.yml b/core/config/locales/en.yml
index f533e77327..155d610ef6 100644
--- a/core/config/locales/en.yml
+++ b/core/config/locales/en.yml
@@ -60,6 +60,8 @@ en:
spree/line_item:
price: Price
quantity: Quantity
+ spree/metafield_definition:
+ namespace: Namespace
spree/option_type:
filterable: Filterable
name: Name
@@ -974,6 +976,7 @@ en:
duplicating: Duplicating
edit: Edit
edit_address: Edit address
+ edit_metafields: Edit Metafields
edit_refund: Edit refund
editing_resource: Editing %{resource}
editing_rma_reason: Editing RMA Reason
@@ -1220,6 +1223,7 @@ en:
items_reimbursed: Items reimbursed
items_to_be_reimbursed: Items to be reimbursed
join_slack: Join Slack
+ key: Key
kind: Kind
language: Language
last_name: Last Name
@@ -1275,6 +1279,8 @@ en:
meta_keywords: Meta Keywords
meta_title: Meta Title
metadata: Metadata
+ metafield_definitions: Metafield Definitions
+ metafields: Metafields
min: Min
minimal_amount: Minimal Amount
minimum_password_length:
@@ -1312,7 +1318,7 @@ en:
new_gift_card: New Gift Card
new_image: New Image
new_line_item: Add line item
- new_market: New market
+ new_metafield_definition: New Metafield Definition
new_nested_taxon: New nested taxon
new_option_type: New Option Type
new_order: New Order
@@ -1802,6 +1808,7 @@ en:
resellable: Resellable
resend: Resend
reset_password: Reset my password
+ resource: Resource
response_code: Response Code
restore_defaults: Restore defaults
resume: resume
diff --git a/core/db/migrate/20250728095629_create_spree_metafields.rb b/core/db/migrate/20250728095629_create_spree_metafields.rb
new file mode 100644
index 0000000000..c4109ee07d
--- /dev/null
+++ b/core/db/migrate/20250728095629_create_spree_metafields.rb
@@ -0,0 +1,27 @@
+class CreateSpreeMetafields < ActiveRecord::Migration[7.2]
+ def change
+ create_table :spree_metafield_definitions do |t|
+ t.string :namespace, null: false
+ t.string :key, null: false
+ t.string :name, null: false
+ t.string :metafield_type, null: false
+ t.string :resource_type, null: false, index: true
+ t.string :display_on, null: false, default: 'both', index: true
+ t.timestamps
+
+ t.index [:namespace, :key]
+ t.index [:resource_type, :namespace, :key], unique: true
+ end
+
+ create_table :spree_metafields do |t|
+ t.string :type, null: false, index: true
+ t.references :resource, polymorphic: true, null: false, index: true
+ t.references :metafield_definition, null: false, index: true
+ t.text :value
+
+ t.timestamps
+
+ t.index [:resource_type, :resource_id, :metafield_definition_id], name: 'index_metafields_on_resource_and_definition', unique: true
+ end
+ end
+end
diff --git a/core/lib/generators/spree/cursor_rules/templates/spree_rules.mdc b/core/lib/generators/spree/cursor_rules/templates/spree_rules.mdc
index 3828400b67..bfae180a10 100644
--- a/core/lib/generators/spree/cursor_rules/templates/spree_rules.mdc
+++ b/core/lib/generators/spree/cursor_rules/templates/spree_rules.mdc
@@ -69,12 +69,12 @@ Always inherit from `Spree.base_class` when creating models.
- Use ActiveRecord associations appropriately, always pass `class_name` and `dependent` options
- Implement concerns for shared functionality
- Use scopes for reusable query patterns
-- Include `Spree::Metadata` concern for models that need metadata support
+- Include `Spree::Metafields` concern for models that need metadata support
```ruby
# ✅ Good model structure
class Spree::Product < Spree.base_class
- include Spree::Metadata
+ include Spree::Metafields
has_many :variants, class_name: 'Spree::Variant', dependent: :destroy
has_many :product_properties, class_name: 'Spree::ProductProperty', dependent: :destroy
diff --git a/core/lib/spree/core/engine.rb b/core/lib/spree/core/engine.rb
index 22c4ead763..86c2c82487 100644
--- a/core/lib/spree/core/engine.rb
+++ b/core/lib/spree/core/engine.rb
@@ -23,6 +23,8 @@ module Spree
:page_blocks,
:reports,
:translatable_resources,
+ :metafield_types,
+ :metafield_enabled_resources,
:analytics_events,
:analytics_event_handlers,
:integrations)
@@ -252,6 +254,45 @@ module Spree
Spree::Policy
]
+ Rails.application.config.spree.metafield_types = [
+ Spree::Metafields::ShortText,
+ Spree::Metafields::LongText,
+ Spree::Metafields::RichText,
+ Spree::Metafields::Number,
+ Spree::Metafields::Boolean
+ ]
+
+ Rails.application.config.spree.metafield_enabled_resources = [
+ Spree::Address,
+ Spree::Asset,
+ Spree::CreditCard,
+ Spree::CustomDomain,
+ Spree::CustomerReturn,
+ Spree::GiftCard,
+ Spree::LineItem,
+ Spree::NewsletterSubscriber,
+ Spree::OptionType,
+ Spree::OptionValue,
+ Spree::Order,
+ Spree::Payment,
+ Spree::PaymentMethod,
+ Spree::PaymentSource,
+ Spree::Product,
+ Spree::Promotion,
+ Spree::Refund,
+ Spree::Shipment,
+ Spree::ShippingMethod,
+ Spree::StockItem,
+ Spree::StockTransfer,
+ Spree::Store,
+ Spree::StoreCredit,
+ Spree::TaxRate,
+ Spree::Taxon,
+ Spree::Taxonomy,
+ Spree::Variant,
+ Spree.user_class
+ ]
+
Rails.application.config.spree.analytics_events = {
product_viewed: 'Product Viewed',
product_list_viewed: 'Product List Viewed',
diff --git a/core/lib/spree/permitted_attributes.rb b/core/lib/spree/permitted_attributes.rb
index 0ef9b5850f..152b00b942 100644
--- a/core/lib/spree/permitted_attributes.rb
+++ b/core/lib/spree/permitted_attributes.rb
@@ -21,6 +21,8 @@ module Spree
:line_item_attributes,
:menu_attributes,
:menu_item_attributes,
+ :metafield_attributes,
+ :metafield_definition_attributes,
:option_type_attributes,
:option_value_attributes,
:page_attributes,
@@ -127,6 +129,10 @@ module Spree
@@menu_item_attributes = [:name, :subtitle, :destination, :new_window, :item_type,
:linked_resource_type, :linked_resource_id, :code, :menu_id]
+ @@metafield_attributes = [:id, :value, :type, :metafield_definition_id, :_destroy]
+
+ @@metafield_definition_attributes = [:key, :name, :namespace, :metafield_type, :resource_type, :display_on]
+
@@option_type_attributes = [:name, :presentation, :position, :filterable,
option_values_attributes: [:id, :name, :presentation, :position, :_destroy]]
diff --git a/core/lib/spree/testing_support/factories/metafield_definition_factory.rb b/core/lib/spree/testing_support/factories/metafield_definition_factory.rb
new file mode 100644
index 0000000000..a654cb9cf5
--- /dev/null
+++ b/core/lib/spree/testing_support/factories/metafield_definition_factory.rb
@@ -0,0 +1,66 @@
+FactoryBot.define do
+ factory :metafield_definition, class: 'Spree::MetafieldDefinition' do
+ namespace { 'custom' }
+ sequence(:key) { |n| "custom_field_#{n}" }
+ name { 'Custom Field' }
+ metafield_type { 'Spree::Metafields::ShortText' }
+ resource_type { 'Spree::Product' }
+ display_on { 'both' }
+
+ trait :front_end_only do
+ display_on { 'front_end' }
+ end
+
+ trait :back_end_only do
+ display_on { 'back_end' }
+ end
+
+ trait :short_text_field do
+ metafield_type { 'Spree::Metafields::ShortText' }
+ key { 'title' }
+ name { 'Title' }
+ end
+
+ trait :long_text_field do
+ metafield_type { 'Spree::Metafields::LongText' }
+ key { 'description' }
+ name { 'Description' }
+ end
+
+ trait :rich_text_field do
+ metafield_type { 'Spree::Metafields::RichText' }
+ key { 'content' }
+ name { 'Content' }
+ end
+
+ trait :number_field do
+ metafield_type { 'Spree::Metafields::Number' }
+ key { 'priority' }
+ name { 'Priority' }
+ end
+
+ trait :boolean_field do
+ metafield_type { 'Spree::Metafields::Boolean' }
+ key { 'featured' }
+ name { 'Featured' }
+ end
+
+ trait :for_variant do
+ resource_type { 'Spree::Variant' }
+ key { 'variant_custom' }
+ name { 'Variant Custom Field' }
+ end
+
+ trait :for_order do
+ resource_type { 'Spree::Order' }
+ key { 'order_notes' }
+ name { 'Order Notes' }
+ end
+
+ trait :for_user do
+ resource_type { Spree.user_class.name }
+ key { 'user_preference' }
+ name { 'User Preference' }
+ end
+ end
+end
diff --git a/core/lib/spree/testing_support/factories/metafield_factory.rb b/core/lib/spree/testing_support/factories/metafield_factory.rb
new file mode 100644
index 0000000000..8b2b0f5378
--- /dev/null
+++ b/core/lib/spree/testing_support/factories/metafield_factory.rb
@@ -0,0 +1,62 @@
+FactoryBot.define do
+ factory :metafield, class: 'Spree::Metafield' do
+ value { 'test_value' }
+ type { 'Spree::Metafields::ShortText' }
+
+ association :resource, factory: :product
+ association :metafield_definition
+
+ trait :front_end_only do
+ association :metafield_definition, :front_end_only
+ end
+
+ trait :back_end_only do
+ association :metafield_definition, :back_end_only
+ end
+
+ trait :short_text do
+ type { 'Spree::Metafields::ShortText' }
+ association :metafield_definition, :short_text_field
+ value { 'Short text value' }
+ end
+
+ trait :long_text do
+ type { 'Spree::Metafields::LongText' }
+ association :metafield_definition, :long_text_field
+ value { 'This is a longer text value with more detailed information.' }
+ end
+
+ trait :number do
+ type { 'Spree::Metafields::Number' }
+ association :metafield_definition, :number_field
+ value { 42 }
+ end
+
+ trait :rich_text do
+ type { 'Spree::Metafields::RichText' }
+ association :metafield_definition, :rich_text_field
+ value { '<p>Rich text with <strong>formatting</strong></p>' }
+ end
+
+ trait :boolean do
+ type { 'Spree::Metafields::Boolean' }
+ association :metafield_definition, :boolean_field
+ value { true }
+ end
+
+ trait :for_variant do
+ association :resource, factory: :variant
+ association :metafield_definition, :for_variant
+ end
+
+ trait :for_order do
+ association :resource, factory: :order
+ association :metafield_definition, :for_order
+ end
+
+ trait :for_user do
+ association :resource, factory: :user
+ association :metafield_definition, :for_user
+ end
+ end
+end
diff --git a/core/spec/models/concerns/spree/metafields_spec.rb b/core/spec/models/concerns/spree/metafields_spec.rb
new file mode 100644
index 0000000000..d5bbcf0812
--- /dev/null
+++ b/core/spec/models/concerns/spree/metafields_spec.rb
@@ -0,0 +1,147 @@
+require 'spec_helper'
+
+RSpec.describe Spree::Metafields, type: :concern do
+ let(:product) { create(:product) }
+
+ describe 'associations' do
+ it 'has many metafields' do
+ expect(product).to respond_to(:metafields)
+ end
+
+ it 'has many public_metafields' do
+ expect(product).to respond_to(:public_metafields)
+ end
+
+ it 'has many private_metafields' do
+ expect(product).to respond_to(:private_metafields)
+ end
+ end
+
+ describe '.with_metafield_key' do
+ let!(:definition) { create(:metafield_definition, namespace: 'custom', key: 'foo', resource_type: 'Spree::Product') }
+ let!(:metafield) { create(:metafield, resource: product, metafield_definition: definition) }
+
+ it 'returns products with the given metafield key' do
+ expect(Spree::Product.with_metafield_key('custom', 'foo')).to include(product)
+ end
+
+ it 'does not return products without the given metafield key' do
+ other_product = create(:product)
+ expect(Spree::Product.with_metafield_key('custom', 'foo')).not_to include(other_product)
+ end
+ end
+
+ describe '.with_metafield_key_value' do
+ let!(:definition) { create(:metafield_definition, namespace: 'custom', key: 'bar', resource_type: 'Spree::Product') }
+ let!(:metafield) { create(:metafield, resource: product, metafield_definition: definition, value: 'baz') }
+
+ it 'returns products with the given metafield key and value' do
+ expect(Spree::Product.with_metafield_key_value('custom', 'bar', 'baz')).to include(product)
+ end
+
+ it 'does not return products with the key but different value' do
+ expect(Spree::Product.with_metafield_key_value('custom', 'bar', 'other')).not_to include(product)
+ end
+ end
+
+ describe '#set_metafield and #get_metafield' do
+ it 'creates and retrieves a metafield by key_with_namespace' do
+ expect {
+ product.set_metafield('custom.foo', 'bar')
+ }.to change { product.metafields.count }.by(1)
+
+ metafield = product.get_metafield('custom.foo')
+ expect(metafield).to be_present
+ expect(metafield.value).to eq('bar')
+ expect(metafield.metafield_definition.namespace).to eq('custom')
+ expect(metafield.metafield_definition.key).to eq('foo')
+ end
+
+ it 'updates the value if the metafield already exists' do
+ product.set_metafield('custom.foo', 'bar')
+ expect {
+ product.set_metafield('custom.foo', 'baz')
+ }.not_to change { product.metafields.count }
+ expect(product.get_metafield('custom.foo').value).to eq('baz')
+ end
+ end
+
+ describe '#has_metafield?' do
+ let!(:definition) { create(:metafield_definition, namespace: 'custom', key: 'foo', resource_type: 'Spree::Product') }
+
+ it 'returns true if metafield exists for string key_with_namespace' do
+ product.set_metafield('custom.foo', 'bar')
+ expect(product.has_metafield?('custom.foo')).to be true
+ end
+
+ it 'returns false if metafield does not exist for string key_with_namespace' do
+ expect(product.has_metafield?('custom.foo')).to be false
+ end
+
+ it 'returns true if metafield exists for MetafieldDefinition' do
+ product.set_metafield('custom.foo', 'bar')
+ expect(product.has_metafield?(definition)).to be true
+ end
+
+ it 'returns false if metafield does not exist for MetafieldDefinition' do
+ expect(product.has_metafield?(definition)).to be false
+ end
+
+ it 'raises ArgumentError for invalid key_with_namespace' do
+ expect {
+ product.has_metafield?(123)
+ }.to raise_error(ArgumentError)
+ end
+ end
+
+ describe 'accepts_nested_attributes_for :metafields' do
+ let!(:definition) { create(:metafield_definition, namespace: 'custom', key: 'foo', resource_type: 'Spree::Product') }
+
+ it 'creates metafield via nested attributes' do
+ attrs = {
+ metafields_attributes: [
+ {
+ metafield_definition_id: definition.id,
+ value: 'nested value',
+ type: definition.metafield_type
+ }
+ ]
+ }
+ expect {
+ product.update(attrs)
+ }.to change { product.metafields.count }.by(1)
+ expect(product.metafields.last.value).to eq('nested value')
+ end
+
+ it 'rejects metafield if metafield_definition_id is blank' do
+ attrs = {
+ metafields_attributes: [
+ {
+ metafield_definition_id: nil,
+ value: 'should not be saved',
+ type: definition.metafield_type
+ }
+ ]
+ }
+ expect {
+ product.update(attrs)
+ }.not_to change { product.metafields.count }
+ end
+
+ it 'rejects metafield if id and value are blank' do
+ attrs = {
+ metafields_attributes: [
+ {
+ metafield_definition_id: definition.id,
+ value: '',
+ id: nil,
+ type: definition.metafield_type
+ }
+ ]
+ }
+ expect {
+ product.update(attrs)
+ }.not_to change { product.metafields.count }
+ end
+ end
+end
diff --git a/core/spec/models/spree/metafield_definition_spec.rb b/core/spec/models/spree/metafield_definition_spec.rb
new file mode 100644
index 0000000000..594e9c2377
--- /dev/null
+++ b/core/spec/models/spree/metafield_definition_spec.rb
@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+RSpec.describe Spree::MetafieldDefinition, type: :model do
+ let(:metafield_definition) { build(:metafield_definition) }
+
+ describe 'scopes' do
+ let!(:both_definition) { create(:metafield_definition, display_on: 'both') }
+ let!(:front_end_definition) { create(:metafield_definition, :front_end_only) }
+ let!(:back_end_definition) { create(:metafield_definition, :back_end_only) }
+ let!(:product_definition) { create(:metafield_definition, resource_type: 'Spree::Product') }
+ let!(:variant_definition) { create(:metafield_definition, :for_variant) }
+
+ describe '.available' do
+ it 'returns only both definitions (from DisplayOn concern)' do
+ expect(described_class.available).to include(both_definition)
+ expect(described_class.available).not_to include(front_end_definition)
+ expect(described_class.available).not_to include(back_end_definition)
+ end
+ end
+
+ describe '.available_on_front_end' do
+ it 'returns public definitions (front_end and both)' do
+ expect(described_class.available_on_front_end).to include(front_end_definition, both_definition)
+ expect(described_class.available_on_front_end).not_to include(back_end_definition)
+ end
+ end
+
+ describe '.available_on_back_end' do
+ it 'returns admin definitions (back_end and both)' do
+ expect(described_class.available_on_back_end).to include(back_end_definition, both_definition)
+ expect(described_class.available_on_back_end).not_to include(front_end_definition)
+ end
+ end
+
+ describe '.for_resource_type' do
+ it 'returns definitions for specific resource type' do
+ expect(described_class.for_resource_type('Spree::Product')).to include(product_definition)
+ expect(described_class.for_resource_type('Spree::Product')).not_to include(variant_definition)
+
+ expect(described_class.for_resource_type('Spree::Variant')).to include(variant_definition)
+ expect(described_class.for_resource_type('Spree::Variant')).not_to include(product_definition)
+ end
+ end
+ end
+end
diff --git a/core/spec/models/spree/metafield_spec.rb b/core/spec/models/spree/metafield_spec.rb
new file mode 100644
index 0000000000..c7a6ab6a43
--- /dev/null
+++ b/core/spec/models/spree/metafield_spec.rb
@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+RSpec.describe Spree::Metafield, type: :model do
+ context 'Callbacks' do
+ it 'sets the type from the metafield definition' do
+ metafield_definition = create(:metafield_definition, metafield_type: 'Spree::Metafields::ShortText')
+ metafield = create(:metafield, metafield_definition: metafield_definition)
+ expect(metafield.type).to eq('Spree::Metafields::ShortText')
+ end
+ end
+
+ context 'Validations' do
+ it 'validates the type must match the metafield definition' do
+ metafield_definition = create(:metafield_definition, metafield_type: 'Spree::Metafields::ShortText')
+ metafield = build(:metafield, metafield_definition: metafield_definition, type: 'Spree::Metafields::LongText')
+ expect(metafield.valid?).to be false
+ end
+ end
+
+ context 'Scopes' do
+ describe '.with_key' do
+ it 'returns the metafields with the given key' do
+ metafield_definition = create(:metafield_definition, namespace: 'custom', key: 'foo')
+ metafield = create(:metafield, metafield_definition: metafield_definition)
+ other_definition = create(:metafield_definition, namespace: 'custom', key: 'bar')
+ create(:metafield, metafield_definition: other_definition)
+ expect(described_class.with_key('custom', 'foo').ids).to contain_exactly(metafield.id)
+ end
+ end
+ end
+
+ describe '#serialize_value' do
+ it 'returns the value' do
+ metafield = build(:metafield, value: 'Test Value')
+ expect(metafield.serialize_value).to eq('Test Value')
+ end
+ end
+end
diff --git a/core/spec/models/spree/metafields/number_spec.rb b/core/spec/models/spree/metafields/number_spec.rb
new file mode 100644
index 0000000000..d8f8837837
--- /dev/null
+++ b/core/spec/models/spree/metafields/number_spec.rb
@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Spree::Metafields::Number, type: :model do
+ let(:product) { create(:product) }
+ let(:metafield_definition) { create(:metafield_definition, :number_field) }
+ let(:metafield) { described_class.new(metafield_definition: metafield_definition, value: '123', resource: product) }
+
+ describe 'Validations' do
+ it 'returns false if the value is not a number' do
+ metafield.value = 'not a number'
+ expect(metafield.valid?).to be false
+ end
+ end
+
+ describe '#serialize_value' do
+ it 'returns the number' do
+ expect(metafield.valid?).to be true
+ expect(metafield.serialize_value).to be_kind_of(BigDecimal)
+ expect(metafield.serialize_value).to eq(123)
+ end
+ end
+end
diff --git a/core/spec/models/spree/metafields/rich_text_spec.rb b/core/spec/models/spree/metafields/rich_text_spec.rb
new file mode 100644
index 0000000000..cd02cc400e
--- /dev/null
+++ b/core/spec/models/spree/metafields/rich_text_spec.rb
@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Spree::Metafields::RichText, type: :model do
+ let(:metafield_definition) { create(:metafield_definition, :rich_text_field) }
+ let(:metafield) { described_class.new(metafield_definition: metafield_definition, value: '<p>Rich text with <strong>formatting</strong></p>') }
+
+ describe '#value' do
+ it 'returns the rich text body' do
+ expect(metafield.value).to be_kind_of(ActionText::RichText)
+ end
+ end
+
+ describe '#serialize_value' do
+ it 'returns the rich text body' do
+ expect(metafield.serialize_value).to eq(metafield.value.body.to_s)
+ end
+ end
+end
diff --git a/core/spec/models/spree/payment_method_spec.rb b/core/spec/models/spree/payment_method_spec.rb
index 322a3651c1..be28fb9b13 100644
--- a/core/spec/models/spree/payment_method_spec.rb
+++ b/core/spec/models/spree/payment_method_spec.rb
@@ -13,7 +13,7 @@ describe Spree::PaymentMethod, type: :model do
context 'visibility scopes' do
before do
- [nil, '', 'both', 'front_end', 'back_end'].each do |display_on|
+ ['both', 'front_end', 'back_end'].each do |display_on|
Spree::Gateway::Test.create(
name: 'Display Both',
display_on: display_on,
@@ -25,7 +25,7 @@ describe Spree::PaymentMethod, type: :model do
end
it 'has 5 total methods' do
- expect(Spree::PaymentMethod.count).to eq(5)
+ expect(Spree::PaymentMethod.count).to eq(3)
end
describe '#available' do
@@ -63,7 +63,7 @@ describe Spree::PaymentMethod, type: :model do
)
methods = Spree::PaymentMethod.for_store(store)
expect(methods).not_to include(method_from_other_store)
- expect(methods.size).to eq(5)
+ expect(methods.size).to eq(3)
end
end
end
diff --git a/core/spec/models/spree/shipping_method_spec.rb b/core/spec/models/spree/shipping_method_spec.rb
index a8d074f4a3..c63d239fcc 100644
--- a/core/spec/models/spree/shipping_method_spec.rb
+++ b/core/spec/models/spree/shipping_method_spec.rb
@@ -82,7 +82,7 @@ describe Spree::ShippingMethod, type: :model do
it 'validates presence of display_on' do
subject.valid?
- expect(subject.errors.messages[:display_on].size).to eq(1)
+ expect(subject.errors.messages[:display_on].size).not_to be_zero
end
context 'shipping category' do
diff --git a/core/spec/models/spree/user_spec.rb b/core/spec/models/spree/user_spec.rb
index 2dc8f0011b..670309855b 100644
--- a/core/spec/models/spree/user_spec.rb
+++ b/core/spec/models/spree/user_spec.rb
@@ -18,9 +18,6 @@ describe Spree::LegacyUser, type: :model do # rubocop:disable RSpec/MultipleDesc
let(:order_1) { create(:order, created_at: 1.day.ago, user: user, created_by: user, store: store) }
let(:order_2) { create(:order, user: user, created_by: user, store: store) }
let(:order_3) { create(:order, user: user, created_by: create(:user), store: store) }
-
- it_behaves_like 'metadata', factory: :user
-
it 'returns correct order' do
Timecop.scale(3600) do
order_1