Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
SD-1352 As a System I can store MetaData for Spree Resources (#11400)
Konrad Gorazdf4903648b091
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.rbindex 9366d0451c..5b96e05134 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@@ -28,6 +28,8 @@ describe Spree::Api::V2::Platform::AddressSerializer doupdated_at: address.updated_at,deleted_at: address.deleted_at,label: address.label,+ public_metadata: {},+ private_metadata: {}},relationships: {country: {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.rbindex 174a333ba6..c9f1f23348 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@@ -24,7 +24,9 @@ describe Spree::Api::V2::Platform::AssetSerializer doattachment_updated_at: resource.attachment_updated_at,alt: resource.alt,created_at: resource.created_at,- updated_at: resource.updated_at+ updated_at: resource.updated_at,+ public_metadata: resource.public_metadata,+ private_metadata: resource.private_metadata},relationships: {viewable: {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.rbindex 1f42ec7751..980d990de1 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@@ -19,7 +19,9 @@ describe Spree::Api::V2::Platform::OptionTypeSerializer doposition: option_type.position,created_at: option_type.created_at,updated_at: option_type.updated_at,- filterable: option_type.filterable+ filterable: option_type.filterable,+ public_metadata: {},+ private_metadata: {}},relationships: {option_values: {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.rbindex 278396ba25..c66169d1eb 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@@ -18,7 +18,9 @@ describe Spree::Api::V2::Platform::OptionValueSerializer doname: option_value.name,presentation: option_value.presentation,created_at: option_value.created_at,- updated_at: option_value.updated_at+ updated_at: option_value.updated_at,+ public_metadata: {},+ private_metadata: {}},relationships: {option_type: {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.rbindex 6c5e451e45..8621db825a 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@@ -43,7 +43,9 @@ describe Spree::Api::V2::Platform::ProductSerializer doprice: BigDecimal(10),display_price: '$10.00',compare_at_price: BigDecimal(15),- display_compare_at_price: '$15.00'+ display_compare_at_price: '$15.00',+ public_metadata: {},+ private_metadata: {}},relationships: {tax_category: {diff --git a/api/spec/serializers/spree/api/v2/platform/property_serializer_spec.rb b/api/spec/serializers/spree/api/v2/platform/property_serializer_spec.rbindex 2672c55568..c2c92b7ed8 100644--- a/api/spec/serializers/spree/api/v2/platform/property_serializer_spec.rb+++ b/api/spec/serializers/spree/api/v2/platform/property_serializer_spec.rb@@ -19,7 +19,9 @@ describe Spree::Api::V2::Platform::PropertySerializer docreated_at: resource.created_at,updated_at: resource.updated_at,filterable: resource.filterable,- filter_param: resource.filter_param+ filter_param: resource.filter_param,+ public_metadata: resource.public_metadata,+ private_metadata: resource.private_metadata}})diff --git a/api/spec/serializers/spree/api/v2/platform/prototype_serializer_spec.rb b/api/spec/serializers/spree/api/v2/platform/prototype_serializer_spec.rbindex 1626171849..9b1994ada7 100644--- a/api/spec/serializers/spree/api/v2/platform/prototype_serializer_spec.rb+++ b/api/spec/serializers/spree/api/v2/platform/prototype_serializer_spec.rb@@ -18,7 +18,9 @@ describe Spree::Api::V2::Platform::PrototypeSerializer doattributes: {name: resource.name,created_at: resource.created_at,- updated_at: resource.updated_at+ updated_at: resource.updated_at,+ public_metadata: resource.public_metadata,+ private_metadata: resource.private_metadata},relationships: {properties: {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.rbindex 745a88370e..57dd095ed2 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@@ -23,7 +23,9 @@ describe Spree::Api::V2::Platform::StockTransferSerializer doreference: resource.reference,created_at: resource.created_at,updated_at: resource.updated_at,- number: resource.number+ number: resource.number,+ public_metadata: resource.public_metadata,+ private_metadata: resource.private_metadata},relationships: {stock_movements: {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.rbindex 5258e04c62..96ab090d46 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@@ -35,7 +35,9 @@ describe Spree::Api::V2::Platform::TaxonSerializer doseo_title: taxon.seo_title,is_root: taxon.root?,is_child: taxon.child?,- is_leaf: taxon.leaf?+ is_leaf: taxon.leaf?,+ public_metadata: {},+ private_metadata: {}},relationships: {parent: {@@ -103,7 +105,9 @@ describe Spree::Api::V2::Platform::TaxonSerializer doseo_title: taxon.seo_title,is_root: taxon.root?,is_child: taxon.child?,- is_leaf: taxon.leaf?+ is_leaf: taxon.leaf?,+ public_metadata: {},+ private_metadata: {}},relationships: {parent: {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.rbindex 5198bbb1e0..6d9919a4ec 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@@ -25,7 +25,9 @@ describe Spree::Api::V2::Platform::TaxonomySerializer, retry: 3 doname: taxonomy.name,created_at: taxonomy.created_at,updated_at: taxonomy.updated_at,- position: taxonomy.position+ position: taxonomy.position,+ public_metadata: {},+ private_metadata: {}},relationships: {root: {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.rbindex 74b440e6b0..c4f760f18e 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@@ -41,7 +41,9 @@ describe Spree::Api::V2::Platform::VariantSerializer doprice: BigDecimal(10),display_price: '$10.00',compare_at_price: BigDecimal(15),- display_compare_at_price: '$15.00'+ display_compare_at_price: '$15.00',+ public_metadata: {},+ private_metadata: {}},relationships: {product: {diff --git a/core/app/models/concerns/spree/metadata.rb b/core/app/models/concerns/spree/metadata.rbnew file mode 100644index 0000000000..6bc5111a22--- /dev/null+++ b/core/app/models/concerns/spree/metadata.rb@@ -0,0 +1,10 @@+module Spree+ module Metadata+ extend ActiveSupport::Concern++ included do+ store :public_metadata, coder: JSON+ store :private_metadata, coder: JSON+ end+ end+enddiff --git a/core/app/models/spree/address.rb b/core/app/models/spree/address.rbindex a63d935953..2d07bf6ce9 100644--- a/core/app/models/spree/address.rb+++ b/core/app/models/spree/address.rb@@ -2,6 +2,8 @@ module Spreeclass Address < Spree::Baserequire 'validates_zipcode'+ include Metadata+if Rails::VERSION::STRING >= '6.1'serialize :preferences, Hash, default: {}enddiff --git a/core/app/models/spree/asset.rb b/core/app/models/spree/asset.rbindex 096c578909..10a14b818d 100644--- a/core/app/models/spree/asset.rb+++ b/core/app/models/spree/asset.rb@@ -1,6 +1,7 @@module Spreeclass Asset < Spree::Baseinclude Support::ActiveStorage+ include Metadatabelongs_to :viewable, polymorphic: true, touch: trueacts_as_list scope: [:viewable_id, :viewable_type]diff --git a/core/app/models/spree/credit_card.rb b/core/app/models/spree/credit_card.rbindex 687a7081ae..b54de50da2 100644--- a/core/app/models/spree/credit_card.rb+++ b/core/app/models/spree/credit_card.rb@@ -1,6 +1,7 @@module Spreeclass CreditCard < Spree::Baseinclude ActiveMerchant::Billing::CreditCardMethods+ include Metadataacts_as_paranoiddiff --git a/core/app/models/spree/customer_return.rb b/core/app/models/spree/customer_return.rbindex c106c9edea..6e52ab8c27 100644--- a/core/app/models/spree/customer_return.rb+++ b/core/app/models/spree/customer_return.rb@@ -2,6 +2,7 @@ module Spreeclass CustomerReturn < Spree::Baseinclude Spree::Core::NumberGenerator.new(prefix: 'CR', length: 9)include NumberIdentifier+ include Metadatabelongs_to :stock_locationbelongs_to :store, class_name: 'Spree::Store', inverse_of: :customer_returnsdiff --git a/core/app/models/spree/legacy_user.rb b/core/app/models/spree/legacy_user.rbindex 7c1f8246fe..95c7c56764 100644--- a/core/app/models/spree/legacy_user.rb+++ b/core/app/models/spree/legacy_user.rb@@ -4,6 +4,7 @@ module Spreeinclude UserAddressinclude UserPaymentSourceinclude UserMethods+ include Spree::Metadataself.table_name = 'spree_users'diff --git a/core/app/models/spree/line_item.rb b/core/app/models/spree/line_item.rbindex b5c369b04e..49af7ccb01 100644--- a/core/app/models/spree/line_item.rb+++ b/core/app/models/spree/line_item.rb@@ -1,5 +1,7 @@module Spreeclass LineItem < Spree::Base+ include Metadata+before_validation :ensure_valid_quantitywith_options inverse_of: :line_items dodiff --git a/core/app/models/spree/option_type.rb b/core/app/models/spree/option_type.rbindex 199240fb15..0c7296581b 100644--- a/core/app/models/spree/option_type.rb+++ b/core/app/models/spree/option_type.rb@@ -1,6 +1,7 @@module Spreeclass OptionType < Spree::Baseinclude UniqueName+ include Metadataacts_as_listdiff --git a/core/app/models/spree/option_value.rb b/core/app/models/spree/option_value.rbindex 12dd1fb3af..520eb3b512 100644--- a/core/app/models/spree/option_value.rb+++ b/core/app/models/spree/option_value.rb@@ -1,5 +1,7 @@module Spreeclass OptionValue < Spree::Base+ include Metadata+belongs_to :option_type, class_name: 'Spree::OptionType', touch: true, inverse_of: :option_valuesacts_as_list scope: :option_typediff --git a/core/app/models/spree/order.rb b/core/app/models/spree/order.rbindex 4bf1eb33fa..16802a174b 100644--- a/core/app/models/spree/order.rb+++ b/core/app/models/spree/order.rb@@ -24,6 +24,7 @@ module Spreeinclude NumberAsParaminclude SingleStoreResourceinclude MemoizedData+ include MetadataMEMOIZED_METHODS = %w(tax_zone)diff --git a/core/app/models/spree/payment.rb b/core/app/models/spree/payment.rbindex 9fb1044bac..f3d6a81190 100644--- a/core/app/models/spree/payment.rb+++ b/core/app/models/spree/payment.rb@@ -5,6 +5,7 @@ module Spreeinclude Spree::Core::NumberGenerator.new(prefix: 'P', letters: true, length: 7)include NumberIdentifierinclude NumberAsParam+ include Metadatainclude Spree::Payment::Processingdiff --git a/core/app/models/spree/payment_method.rb b/core/app/models/spree/payment_method.rbindex 4ab85eaefa..f6a7f08a05 100644--- a/core/app/models/spree/payment_method.rb+++ b/core/app/models/spree/payment_method.rb@@ -4,6 +4,7 @@ module Spreeacts_as_listinclude MultiStoreResource+ include Spree::MetadataDISPLAY = [:both, :front_end, :back_end].freezediff --git a/core/app/models/spree/product.rb b/core/app/models/spree/product.rbindex f7c6d3f332..d3a9112130 100644--- a/core/app/models/spree/product.rb+++ b/core/app/models/spree/product.rb@@ -24,6 +24,7 @@ module Spreeinclude ProductScopesinclude MultiStoreResourceinclude MemoizedData+ include MetadataMEMOIZED_METHODS = %w(total_on_hand taxonomy_ids taxon_and_ancestors categorydefault_variant_id tax_category default_variantdiff --git a/core/app/models/spree/promotion.rb b/core/app/models/spree/promotion.rbindex 745df37a51..4c75ff0408 100644--- a/core/app/models/spree/promotion.rb+++ b/core/app/models/spree/promotion.rb@@ -1,6 +1,7 @@module Spreeclass Promotion < Spree::Baseinclude MultiStoreResource+ include MetadataMATCH_POLICIES = %w(all any)UNACTIVATABLE_ORDER_STATES = ['complete', 'awaiting_return', 'returned']diff --git a/core/app/models/spree/property.rb b/core/app/models/spree/property.rbindex e66101bd30..8c2fd56dee 100644--- a/core/app/models/spree/property.rb+++ b/core/app/models/spree/property.rb@@ -1,6 +1,7 @@module Spreeclass Property < Spree::Baseinclude Spree::FilterParam+ include Metadataauto_strip_attributes :name, :presentationdiff --git a/core/app/models/spree/prototype.rb b/core/app/models/spree/prototype.rbindex b8c504a2dc..b6a5f4fecd 100644--- a/core/app/models/spree/prototype.rb+++ b/core/app/models/spree/prototype.rb@@ -1,5 +1,7 @@module Spreeclass Prototype < Spree::Base+ include Metadata+has_many :property_prototypes, class_name: 'Spree::PropertyPrototype'has_many :properties, through: :property_prototypes, class_name: 'Spree::Property'diff --git a/core/app/models/spree/refund.rb b/core/app/models/spree/refund.rbindex 71d6e0dea3..b8f73f9344 100644--- a/core/app/models/spree/refund.rb+++ b/core/app/models/spree/refund.rb@@ -1,5 +1,7 @@module Spreeclass Refund < Spree::Base+ include Metadata+with_options inverse_of: :refunds dobelongs_to :paymentbelongs_to :reimbursement, optional: truediff --git a/core/app/models/spree/shipment.rb b/core/app/models/spree/shipment.rbindex b9d7d9fca6..10aa814f64 100644--- a/core/app/models/spree/shipment.rb+++ b/core/app/models/spree/shipment.rb@@ -5,6 +5,7 @@ module Spreeinclude Spree::Core::NumberGenerator.new(prefix: 'H', length: 11)include NumberIdentifierinclude NumberAsParam+ include Metadatawith_options inverse_of: :shipments dobelongs_to :address, class_name: 'Spree::Address'diff --git a/core/app/models/spree/shipping_method.rb b/core/app/models/spree/shipping_method.rbindex c0d0dbde73..2c8b697931 100644--- a/core/app/models/spree/shipping_method.rb+++ b/core/app/models/spree/shipping_method.rb@@ -2,6 +2,8 @@ module Spreeclass ShippingMethod < Spree::Baseacts_as_paranoidinclude Spree::CalculatedAdjustments+ include Metadata+DISPLAY = [:both, :front_end, :back_end]# Used for #refresh_ratesdiff --git a/core/app/models/spree/stock_transfer.rb b/core/app/models/spree/stock_transfer.rbindex 393ff093d7..deb45b7d5c 100644--- a/core/app/models/spree/stock_transfer.rb+++ b/core/app/models/spree/stock_transfer.rb@@ -3,6 +3,7 @@ module Spreeinclude Spree::Core::NumberGenerator.new(prefix: 'T')include NumberIdentifierinclude NumberAsParam+ include Metadatahas_many :stock_movements, as: :originatordiff --git a/core/app/models/spree/store_credit.rb b/core/app/models/spree/store_credit.rbindex 80eb84ee55..1024fae9cc 100644--- a/core/app/models/spree/store_credit.rb+++ b/core/app/models/spree/store_credit.rb@@ -1,6 +1,7 @@module Spreeclass StoreCredit < Spree::Baseinclude SingleStoreResource+ include Metadataacts_as_paranoiddiff --git a/core/app/models/spree/taxon.rb b/core/app/models/spree/taxon.rbindex 8bbc0cc69b..88150f4bfc 100644--- a/core/app/models/spree/taxon.rb+++ b/core/app/models/spree/taxon.rb@@ -3,6 +3,8 @@ require 'stringex'module Spreeclass Taxon < Spree::Base+ include Metadata+extend FriendlyIdfriendly_id :permalink, slug_column: :permalink, use: :historybefore_validation :set_permalink, on: :create, if: :namediff --git a/core/app/models/spree/taxonomy.rb b/core/app/models/spree/taxonomy.rbindex f69b7fb0b7..6c9f197e14 100644--- a/core/app/models/spree/taxonomy.rb+++ b/core/app/models/spree/taxonomy.rb@@ -1,5 +1,7 @@module Spreeclass Taxonomy < Spree::Base+ include Metadata+acts_as_listvalidates :name, presence: true, uniqueness: { case_sensitive: false, allow_blank: true, scope: :store_id }diff --git a/core/app/models/spree/variant.rb b/core/app/models/spree/variant.rbindex 6c9877b0af..a9c96b1a49 100644--- a/core/app/models/spree/variant.rb+++ b/core/app/models/spree/variant.rb@@ -4,6 +4,7 @@ module Spreeacts_as_list scope: :productinclude MemoizedData+ include MetadataMEMOIZED_METHODS = %w(purchasable in_stock backorderable tax_category options_text compare_at_price)diff --git a/core/db/migrate/20210915064321_add_metadata_to_spree_orders.rb b/core/db/migrate/20210915064321_add_metadata_to_spree_orders.rbnew file mode 100644index 0000000000..383f79beaa--- /dev/null+++ b/core/db/migrate/20210915064321_add_metadata_to_spree_orders.rb@@ -0,0 +1,13 @@+class AddMetadataToSpreeOrders < ActiveRecord::Migration[5.2]+ def change+ change_table :spree_orders do |t|+ if t.respond_to? :jsonb+ add_column :spree_orders, :public_metadata, :jsonb+ add_column :spree_orders, :private_metadata, :jsonb+ else+ add_column :spree_orders, :public_metadata, :json+ add_column :spree_orders, :private_metadata, :json+ end+ end+ end+enddiff --git a/core/db/migrate/20210915064322_add_metadata_to_spree_products.rb b/core/db/migrate/20210915064322_add_metadata_to_spree_products.rbnew file mode 100644index 0000000000..55efdf59a3--- /dev/null+++ b/core/db/migrate/20210915064322_add_metadata_to_spree_products.rb@@ -0,0 +1,13 @@+class AddMetadataToSpreeProducts < ActiveRecord::Migration[5.2]+ def change+ change_table :spree_products do |t|+ if t.respond_to? :jsonb+ add_column :spree_products, :public_metadata, :jsonb+ add_column :spree_products, :private_metadata, :jsonb+ else+ add_column :spree_products, :public_metadata, :json+ add_column :spree_products, :private_metadata, :json+ end+ end+ end+enddiff --git a/core/db/migrate/20210915064323_add_metadata_to_spree_variants.rb b/core/db/migrate/20210915064323_add_metadata_to_spree_variants.rbnew file mode 100644index 0000000000..6fd2d5c790--- /dev/null+++ b/core/db/migrate/20210915064323_add_metadata_to_spree_variants.rb@@ -0,0 +1,13 @@+class AddMetadataToSpreeVariants < ActiveRecord::Migration[5.2]+ def change+ change_table :spree_variants do |t|+ if t.respond_to? :jsonb+ add_column :spree_variants, :public_metadata, :jsonb+ add_column :spree_variants, :private_metadata, :jsonb+ else+ add_column :spree_variants, :public_metadata, :json+ add_column :spree_variants, :private_metadata, :json+ end+ end+ end+enddiff --git a/core/db/migrate/20210915064324_add_metadata_to_spree_line_items.rb b/core/db/migrate/20210915064324_add_metadata_to_spree_line_items.rbnew file mode 100644index 0000000000..a21f3261d2--- /dev/null+++ b/core/db/migrate/20210915064324_add_metadata_to_spree_line_items.rb@@ -0,0 +1,13 @@+class AddMetadataToSpreeLineItems < ActiveRecord::Migration[5.2]+ def change+ change_table :spree_line_items do |t|+ if t.respond_to? :jsonb+ add_column :spree_line_items, :public_metadata, :jsonb+ add_column :spree_line_items, :private_metadata, :jsonb+ else+ add_column :spree_line_items, :public_metadata, :json+ add_column :spree_line_items, :private_metadata, :json+ end+ end+ end+enddiff --git a/core/db/migrate/20210915064325_add_metadata_to_spree_shipments.rb b/core/db/migrate/20210915064325_add_metadata_to_spree_shipments.rbnew file mode 100644index 0000000000..85acedbb7a--- /dev/null+++ b/core/db/migrate/20210915064325_add_metadata_to_spree_shipments.rb@@ -0,0 +1,13 @@+class AddMetadataToSpreeShipments < ActiveRecord::Migration[5.2]+ def change+ change_table :spree_shipments do |t|+ if t.respond_to? :jsonb+ add_column :spree_shipments, :public_metadata, :jsonb+ add_column :spree_shipments, :private_metadata, :jsonb+ else+ add_column :spree_shipments, :public_metadata, :json+ add_column :spree_shipments, :private_metadata, :json+ end+ end+ end+enddiff --git a/core/db/migrate/20210915064326_add_metadata_to_spree_payments.rb b/core/db/migrate/20210915064326_add_metadata_to_spree_payments.rbnew file mode 100644index 0000000000..0d889e2d3b--- /dev/null+++ b/core/db/migrate/20210915064326_add_metadata_to_spree_payments.rb@@ -0,0 +1,13 @@+class AddMetadataToSpreePayments < ActiveRecord::Migration[5.2]+ def change+ change_table :spree_payments do |t|+ if t.respond_to? :jsonb+ add_column :spree_payments, :public_metadata, :jsonb+ add_column :spree_payments, :private_metadata, :jsonb+ else+ add_column :spree_payments, :public_metadata, :json+ add_column :spree_payments, :private_metadata, :json+ end+ end+ end+enddiff --git a/core/db/migrate/20210915064327_add_metadata_to_spree_taxons_and_taxonomies.rb b/core/db/migrate/20210915064327_add_metadata_to_spree_taxons_and_taxonomies.rbnew file mode 100644index 0000000000..3732e7558e--- /dev/null+++ b/core/db/migrate/20210915064327_add_metadata_to_spree_taxons_and_taxonomies.rb@@ -0,0 +1,18 @@+class AddMetadataToSpreeTaxonsAndTaxonomies < ActiveRecord::Migration[5.2]+ def change+ %i[+ spree_taxons+ spree_taxonomies+ ].each do |table_name|+ change_table table_name do |t|+ if t.respond_to? :jsonb+ add_column table_name, :public_metadata, :jsonb+ add_column table_name, :private_metadata, :jsonb+ else+ add_column table_name, :public_metadata, :json+ add_column table_name, :private_metadata, :json+ end+ end+ end+ end+enddiff --git a/core/db/migrate/20210915064328_add_metadata_to_spree_stock_transfers.rb b/core/db/migrate/20210915064328_add_metadata_to_spree_stock_transfers.rbnew file mode 100644index 0000000000..2c7a11b613--- /dev/null+++ b/core/db/migrate/20210915064328_add_metadata_to_spree_stock_transfers.rb@@ -0,0 +1,13 @@+class AddMetadataToSpreeStockTransfers < ActiveRecord::Migration[5.2]+ def change+ change_table :spree_stock_transfers do |t|+ if t.respond_to? :jsonb+ add_column :spree_stock_transfers, :public_metadata, :jsonb+ add_column :spree_stock_transfers, :private_metadata, :jsonb+ else+ add_column :spree_stock_transfers, :public_metadata, :json+ add_column :spree_stock_transfers, :private_metadata, :json+ end+ end+ end+enddiff --git a/core/db/migrate/20210915064329_add_metadata_to_spree_multiple_tables.rb b/core/db/migrate/20210915064329_add_metadata_to_spree_multiple_tables.rbnew file mode 100644index 0000000000..56ca9ae768--- /dev/null+++ b/core/db/migrate/20210915064329_add_metadata_to_spree_multiple_tables.rb@@ -0,0 +1,30 @@+class AddMetadataToSpreeMultipleTables < ActiveRecord::Migration[5.2]+ def change+ %i[+ spree_assets+ spree_option_types+ spree_option_values+ spree_properties+ spree_promotions+ spree_payment_methods+ spree_shipping_methods+ spree_prototypes+ spree_refunds+ spree_customer_returns+ spree_users+ spree_addresses+ spree_credit_cards+ spree_store_credits+ ].each do |table_name|+ change_table table_name do |t|+ if t.respond_to? :jsonb+ add_column table_name, :public_metadata, :jsonb+ add_column table_name, :private_metadata, :jsonb+ else+ add_column table_name, :public_metadata, :json+ add_column table_name, :private_metadata, :json+ end+ end+ end+ end+enddiff --git a/core/lib/spree/testing_support/factories/stock_item_factory.rb b/core/lib/spree/testing_support/factories/stock_item_factory.rbindex 1494aa319d..f114758fcb 100644--- a/core/lib/spree/testing_support/factories/stock_item_factory.rb+++ b/core/lib/spree/testing_support/factories/stock_item_factory.rb@@ -4,6 +4,13 @@ FactoryBot.define dostock_locationvariant+ before(:create) do |stock_item|+ Spree::StockItem.find_by(+ variant: stock_item.variant,+ stock_location: stock_item.stock_location+ )&.destroy+ end+after(:create) { |object| object.adjust_count_on_hand(10) }endenddiff --git a/core/spec/models/spree/address_spec.rb b/core/spec/models/spree/address_spec.rbindex 6a44be5211..6071d6a19f 100644--- a/core/spec/models/spree/address_spec.rb+++ b/core/spec/models/spree/address_spec.rb@@ -1,6 +1,8 @@require 'spec_helper'describe Spree::Address, type: :model do+ it_behaves_like 'metadata'+describe 'clone' doit 'creates a copy of the address with the exception of the id, label, user_id, updated_at and created_at attributes' dostate = create(:state)diff --git a/core/spec/models/spree/asset_spec.rb b/core/spec/models/spree/asset_spec.rbnew file mode 100644index 0000000000..1c966777bf--- /dev/null+++ b/core/spec/models/spree/asset_spec.rb@@ -0,0 +1,5 @@+require 'spec_helper'++describe Spree::Asset, type: :model do+ it_behaves_like 'metadata'+enddiff --git a/core/spec/models/spree/base_spec.rb b/core/spec/models/spree/base_spec.rbindex 3573da54a6..86ee6abe7d 100644--- a/core/spec/models/spree/base_spec.rb+++ b/core/spec/models/spree/base_spec.rb@@ -57,11 +57,11 @@ describe Spree::Base doexpect(Spree::LegacyUser.json_api_columns).to include('email')end- it { expect(Spree::Address.json_api_columns).to contain_exactly('address1', 'address2', 'alternative_phone', 'city', 'company', 'created_at', 'deleted_at', 'firstname', 'label', 'lastname', 'phone', 'state_name', 'updated_at', 'zipcode') }+ it { expect(Spree::Address.json_api_columns).to contain_exactly('address1', 'address2', 'alternative_phone', 'city', 'company', 'created_at', 'deleted_at', 'firstname', 'label', 'lastname', 'phone', 'state_name', 'updated_at', 'zipcode', 'public_metadata', 'private_metadata') }it { expect(Spree::Address.json_api_columns).not_to include('country_id') }enddescribe '.json_api_permitted_attributes' do- it { expect(Spree::Address.json_api_permitted_attributes).to contain_exactly('firstname', 'lastname', 'address1', 'address2', 'city', 'zipcode', 'phone', 'state_name', 'alternative_phone', 'company', 'state_id', 'country_id', 'created_at', 'updated_at', 'user_id', 'deleted_at', 'label') }+ it { expect(Spree::Address.json_api_permitted_attributes).to contain_exactly('firstname', 'lastname', 'address1', 'address2', 'city', 'zipcode', 'phone', 'state_name', 'alternative_phone', 'company', 'state_id', 'country_id', 'created_at', 'updated_at', 'user_id', 'deleted_at', 'label', 'public_metadata', 'private_metadata') }endenddiff --git a/core/spec/models/spree/credit_card_spec.rb b/core/spec/models/spree/credit_card_spec.rbindex a67e5b5063..b25953fa5c 100644--- a/core/spec/models/spree/credit_card_spec.rb+++ b/core/spec/models/spree/credit_card_spec.rb@@ -1,6 +1,8 @@require 'spec_helper'describe Spree::CreditCard, type: :model do+ it_behaves_like 'metadata'+let(:credit_card) { Spree::CreditCard.new }let(:valid_credit_card_attributes) do{diff --git a/core/spec/models/spree/customer_return_spec.rb b/core/spec/models/spree/customer_return_spec.rbindex b84a284108..a5d786a10a 100644--- a/core/spec/models/spree/customer_return_spec.rb+++ b/core/spec/models/spree/customer_return_spec.rb@@ -5,6 +5,8 @@ describe Spree::CustomerReturn, type: :model doallow_any_instance_of(Spree::Order).to receive_messages(return!: true)end+ it_behaves_like 'metadata'+describe '.validation' dodescribe '#must_have_return_authorization' dosubject { customer_return.valid? }diff --git a/core/spec/models/spree/line_item_spec.rb b/core/spec/models/spree/line_item_spec.rbindex a8b76340b2..7d0db99ebe 100644--- a/core/spec/models/spree/line_item_spec.rb+++ b/core/spec/models/spree/line_item_spec.rb@@ -5,6 +5,8 @@ describe Spree::LineItem, type: :model dolet(:order) { create :order_with_line_items, line_items_count: 1, store: store }let(:line_item) { order.line_items.first }+ it_behaves_like 'metadata'+describe 'Validations' dodescribe 'ensure_proper_currency' docontext 'order is present' dodiff --git a/core/spec/models/spree/option_type_spec.rb b/core/spec/models/spree/option_type_spec.rbindex cff2a25ef5..e9cba06e9e 100644--- a/core/spec/models/spree/option_type_spec.rb+++ b/core/spec/models/spree/option_type_spec.rb@@ -1,6 +1,8 @@require 'spec_helper'describe Spree::OptionType, type: :model do+ it_behaves_like 'metadata'+context 'touching' doit 'touches a product' doproduct_option_type = create(:product_option_type)diff --git a/core/spec/models/spree/option_value_spec.rb b/core/spec/models/spree/option_value_spec.rbindex b02ba31c90..47f084027b 100644--- a/core/spec/models/spree/option_value_spec.rb+++ b/core/spec/models/spree/option_value_spec.rb@@ -1,6 +1,8 @@require 'spec_helper'describe Spree::OptionValue, type: :model do+ it_behaves_like 'metadata'+context 'touching' doit 'touches a variant' dovariant = create(:variant)diff --git a/core/spec/models/spree/order_spec.rb b/core/spec/models/spree/order_spec.rbindex b959471ef0..d339d4166a 100644--- a/core/spec/models/spree/order_spec.rb+++ b/core/spec/models/spree/order_spec.rb@@ -13,6 +13,8 @@ describe Spree::Order, type: :model dobefore { allow(Spree::LegacyUser).to receive_messages(current: create(:user)) }+ it_behaves_like 'metadata'+describe '.scopes' dolet!(:user) { create(:user) }let!(:completed_order) { create(:order, user: user, completed_at: Time.current) }diff --git a/core/spec/models/spree/payment_method_spec.rb b/core/spec/models/spree/payment_method_spec.rbindex 8c1cbe46e9..861c3fbc09 100644--- a/core/spec/models/spree/payment_method_spec.rb+++ b/core/spec/models/spree/payment_method_spec.rb@@ -1,6 +1,8 @@require 'spec_helper'describe Spree::PaymentMethod, type: :model do+ it_behaves_like 'metadata'+let(:store) { create(:store) }context 'visibility scopes' dodiff --git a/core/spec/models/spree/payment_spec.rb b/core/spec/models/spree/payment_spec.rbindex abc9aa531b..9c2ce7b22f 100644--- a/core/spec/models/spree/payment_spec.rb+++ b/core/spec/models/spree/payment_spec.rb@@ -47,6 +47,8 @@ describe Spree::Payment, type: :model doallow(payment).to receive(:payment_method_available_for_order).and_return(nil)end+ it_behaves_like 'metadata'+describe 'Constants' doit { expect(Spree::Payment::INVALID_STATES).to eq(%w(failed invalid)) }enddiff --git a/core/spec/models/spree/product_spec.rb b/core/spec/models/spree/product_spec.rbindex 6f8fe6acda..a41711ee25 100644--- a/core/spec/models/spree/product_spec.rb+++ b/core/spec/models/spree/product_spec.rb@@ -8,6 +8,8 @@ module ThirdPartyenddescribe Spree::Product, type: :model do+ it_behaves_like 'metadata'+let!(:store) { create(:store) }context 'product instance' dodiff --git a/core/spec/models/spree/promotion_spec.rb b/core/spec/models/spree/promotion_spec.rbindex 51a0d805d4..e41fba918d 100644--- a/core/spec/models/spree/promotion_spec.rb+++ b/core/spec/models/spree/promotion_spec.rb@@ -1,6 +1,8 @@require 'spec_helper'describe Spree::Promotion, type: :model do+ it_behaves_like 'metadata'+let(:store) { create(:store) }let(:promotion) { create(:promotion) }diff --git a/core/spec/models/spree/property_spec.rb b/core/spec/models/spree/property_spec.rbindex 5849c1b983..f88c712f3a 100644--- a/core/spec/models/spree/property_spec.rb+++ b/core/spec/models/spree/property_spec.rb@@ -3,6 +3,8 @@ require 'spec_helper'describe Spree::Property, type: :model dolet(:store) { create(:store) }+ it_behaves_like 'metadata'+context 'setting filter param' dosubject { build(:property, name: 'Brand Name') }diff --git a/core/spec/models/spree/prototype_spec.rb b/core/spec/models/spree/prototype_spec.rbnew file mode 100644index 0000000000..9db5713cc0--- /dev/null+++ b/core/spec/models/spree/prototype_spec.rb@@ -0,0 +1,5 @@+require 'spec_helper'++describe Spree::Prototype, type: :model do+ it_behaves_like 'metadata'+enddiff --git a/core/spec/models/spree/refund_spec.rb b/core/spec/models/spree/refund_spec.rbindex dcd9dddabf..5041c528df 100644--- a/core/spec/models/spree/refund_spec.rb+++ b/core/spec/models/spree/refund_spec.rb@@ -1,6 +1,14 @@require 'spec_helper'describe Spree::Refund, type: :model do+ describe 'metadata' do+ before do+ allow_any_instance_of(Spree::Refund).to receive(:amount_is_less_than_or_equal_to_allowed_amount)+ end++ it_behaves_like 'metadata'+ end+describe 'create' dosubject { create(:refund, payment: payment, amount: amount, reason: refund_reason, transaction_id: nil) }diff --git a/core/spec/models/spree/shipment_spec.rb b/core/spec/models/spree/shipment_spec.rbindex e74e4a1a37..9e2f21a2ff 100644--- a/core/spec/models/spree/shipment_spec.rb+++ b/core/spec/models/spree/shipment_spec.rb@@ -1,6 +1,8 @@require 'spec_helper'describe Spree::Shipment, type: :model do+ it_behaves_like 'metadata'+let!(:order) { create(:order, number: 'S12345') }let(:shipping_method) { create(:shipping_method, name: 'UPS') }let(:shipment) dodiff --git a/core/spec/models/spree/shipping_method_spec.rb b/core/spec/models/spree/shipping_method_spec.rbindex 800d918cdf..8dc1044dcd 100644--- a/core/spec/models/spree/shipping_method_spec.rb+++ b/core/spec/models/spree/shipping_method_spec.rb@@ -9,6 +9,8 @@ describe Spree::ShippingMethod, type: :model dolet(:backend_shipping_method) { create :shipping_method, display_on: 'back_end' }let(:front_and_back_end_shipping_method) { create :shipping_method, display_on: 'both' }+ it_behaves_like 'metadata'+context 'calculators' doit "rejects calculators that don't inherit from Spree::ShippingCalculator" doallow(Spree::ShippingMethod).to receive_message_chain(:spree_calculators, :shipping_methods).and_return([diff --git a/core/spec/models/spree/stock_transfer_spec.rb b/core/spec/models/spree/stock_transfer_spec.rbindex 46b5d136bb..5cad2108fb 100644--- a/core/spec/models/spree/stock_transfer_spec.rb+++ b/core/spec/models/spree/stock_transfer_spec.rb@@ -9,6 +9,8 @@ module Spreelet(:stock_item) { source_location.stock_items.order(:id).first }let(:variant) { stock_item.variant }+ it_behaves_like 'metadata'+describe '#reference' dosubject { super().reference }diff --git a/core/spec/models/spree/store_credit_spec.rb b/core/spec/models/spree/store_credit_spec.rbindex b59db436ed..c8116fa377 100644--- a/core/spec/models/spree/store_credit_spec.rb+++ b/core/spec/models/spree/store_credit_spec.rb@@ -1,10 +1,12 @@require 'spec_helper'-describe 'StoreCredit' do+describe Spree::StoreCredit, type: :model dolet(:currency) { 'TEST' }let(:store_credit) { build(:store_credit, store_credit_attrs) }let(:store_credit_attrs) { {} }+ it_behaves_like 'metadata'+describe 'callbacks' dosubject { store_credit.save }diff --git a/core/spec/models/spree/taxon_spec.rb b/core/spec/models/spree/taxon_spec.rbindex f69ae8c000..3bb383983e 100644--- a/core/spec/models/spree/taxon_spec.rb+++ b/core/spec/models/spree/taxon_spec.rb@@ -4,6 +4,8 @@ describe Spree::Taxon, type: :model dolet(:taxonomy) { create(:taxonomy) }let(:taxon) { build(:taxon, name: 'Ruby on Rails', parent: nil) }+ it_behaves_like 'metadata'+describe '#to_param' dosubject { super().to_param }diff --git a/core/spec/models/spree/taxonomy_spec.rb b/core/spec/models/spree/taxonomy_spec.rbindex 3290da3b79..dbd1d2d773 100644--- a/core/spec/models/spree/taxonomy_spec.rb+++ b/core/spec/models/spree/taxonomy_spec.rb@@ -1,6 +1,8 @@require 'spec_helper'describe Spree::Taxonomy, type: :model do+ it_behaves_like 'metadata'+context '#destroy' dobefore do@taxonomy = create(:taxonomy)diff --git a/core/spec/models/spree/user_spec.rb b/core/spec/models/spree/user_spec.rbindex 5502628f3d..3c5608facd 100644--- a/core/spec/models/spree/user_spec.rb+++ b/core/spec/models/spree/user_spec.rb@@ -11,6 +11,8 @@ describe Spree::LegacyUser, type: :model do # rubocop:disable RSpec/MultipleDesclet(: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' doTimecop.scale(3600) doorder_1diff --git a/core/spec/models/spree/variant_spec.rb b/core/spec/models/spree/variant_spec.rbindex a16272761c..dbb8077a17 100644--- a/core/spec/models/spree/variant_spec.rb+++ b/core/spec/models/spree/variant_spec.rb@@ -6,6 +6,7 @@ describe Spree::Variant, type: :model dolet(:master_variant) { create(:master_variant) }it_behaves_like 'default_price'+ it_behaves_like 'metadata'context 'sorting' doit 'responds to set_list_position' dodiff --git a/core/spec/support/concerns/metadata.rb b/core/spec/support/concerns/metadata.rbnew file mode 100644index 0000000000..fcc4dc0d03--- /dev/null+++ b/core/spec/support/concerns/metadata.rb@@ -0,0 +1,23 @@+shared_examples_for 'metadata' do |factory: described_class.name.demodulize.underscore.to_sym|+ subject { FactoryBot.create(factory) }++ it { expect(subject.has_attribute?(:public_metadata)).to be_truthy }+ it { expect(subject.has_attribute?(:private_metadata)).to be_truthy }++ it { expect(subject.public_metadata.class).to eq(HashWithIndifferentAccess) }+ it { expect(subject.private_metadata.class).to eq(HashWithIndifferentAccess) }++ it do+ string = subject.public_metadata[:color] = 'red'+ number = subject.public_metadata[:priority] = 1+ array = subject.public_metadata[:keywords] = ['k1', 'k2']+ hash = subject.public_metadata[:additional_data] = { size: 'big', material: 'wool' }++ subject.save!++ expect(subject.public_metadata[:color]).to eq(string)+ expect(subject.public_metadata[:priority]).to eq(number)+ expect(subject.public_metadata[:keywords]).to eq(array)+ expect(subject.public_metadata[:additional_data]).to eq(hash.stringify_keys)+ end+end