spree_core 5.4.0.rc5 → 5.4.0.rc7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5513fa58ed4667fb34788917d1fa52e803267a9a9e43a2c76d6fa318d40645b
-  data.tar.gz: 02b5467d26e71c5f111ffdd0677aa7e6b2732a5ff42ef75a25e7a782a7090737
+  metadata.gz: 07eb5e06c1dbe2e9d89b69a3768a376fcf5d23f0be28bb15bd4e9fac1ce0bcaf
+  data.tar.gz: 99e243c978fb95cfd04e4b8ee42cc42b63f3580493939b4271be7992006c2bbb
 SHA512:
-  metadata.gz: e83cdd25848537e36b5f96b113697818cacec896a58b663415d28295d2e368c1b81dbe076baa86d7858ea8357ad1fd9b1754212c5b4d13a8a54e77c0d360ee29
-  data.tar.gz: 6c6cf8922e2b2c242572723b176608b12a675e64f4982647aca28a0ce85269d23889ba44d5db7ad539a04f1765fde2afbb7c552b28a7e3e7163d263559b79bc6
+  metadata.gz: 2967ba8a3825d98180adb93f0a025370c6aa6aee76520cf5400be56bfb6328b63f121434065f2acf8b600099f53136b067becec17c0f1523078dedd95cc4ccd5
+  data.tar.gz: ca2d9d12300bd8a765b3130cf86fd857d8c8b0ad7cc413f895956a806a642d5ef44c20983b08d227de1fff80b9bcfd68995173061fc60849ebe5dab185631ffb

data/app/mailers/spree/base_mailer.rb

@@ -1,5 +1,7 @@
 module Spree
   class BaseMailer < ActionMailer::Base
+    helper Spree::ImagesHelper
+
     def current_store
       @current_store ||= @order&.store.presence || Spree::Store.current || Spree::Store.default
     end

data/app/models/concerns/spree/default_price.rb

@@ -2,24 +2,126 @@ module Spree
   module DefaultPrice
     extend ActiveSupport::Concern
 
+    DEPRECATION_MSG = 'Spree::DefaultPrice is deprecated and will be removed in Spree 6.0. ' \
+      'Use variant.set_price(currency, amount) and variant.price_in(currency) instead.'
+
     included do
       has_one :default_price,
               -> { with_deleted.where(currency: Spree::Store.default.default_currency) },
               class_name: 'Spree::Price',
               dependent: :destroy
 
-      delegate :display_price, :display_amount, :price, :currency, :price=,
-               :price_including_vat_for, :currency=, :display_compare_at_price,
-               :compare_at_price, :compare_at_price=, to: :find_or_build_default_price
+      after_save :save_default_price, if: -> { Spree::Config.enable_legacy_default_price }
+
+      def price
+        Spree::Deprecation.warn(Spree::DefaultPrice::DEPRECATION_MSG)
+        if Spree::Config.enable_legacy_default_price
+          find_or_build_default_price.price
+        else
+          price_in(Spree::Store.default.default_currency).amount
+        end
+      end
+
+      def price=(value)
+        Spree::Deprecation.warn(Spree::DefaultPrice::DEPRECATION_MSG)
+        if Spree::Config.enable_legacy_default_price
+          find_or_build_default_price.price = value
+        else
+          set_price(Spree::Store.default.default_currency, value)
+        end
+      end
+
+      def currency
+        Spree::Deprecation.warn(Spree::DefaultPrice::DEPRECATION_MSG)
+        if Spree::Config.enable_legacy_default_price
+          find_or_build_default_price.currency
+        else
+          Spree::Store.default.default_currency
+        end
+      end
+
+      def currency=(value)
+        Spree::Deprecation.warn(Spree::DefaultPrice::DEPRECATION_MSG)
+        if Spree::Config.enable_legacy_default_price
+          find_or_build_default_price.currency = value
+        end
+        # no-op when legacy is disabled — currency is determined by the store
+      end
+
+      def display_price
+        Spree::Deprecation.warn(Spree::DefaultPrice::DEPRECATION_MSG)
+        if Spree::Config.enable_legacy_default_price
+          find_or_build_default_price.display_price
+        else
+          price_in(Spree::Store.default.default_currency).display_amount
+        end
+      end
+
+      def display_amount
+        Spree::Deprecation.warn(Spree::DefaultPrice::DEPRECATION_MSG)
+        if Spree::Config.enable_legacy_default_price
+          find_or_build_default_price.display_amount
+        else
+          price_in(Spree::Store.default.default_currency).display_amount
+        end
+      end
+
+      def compare_at_price
+        Spree::Deprecation.warn(Spree::DefaultPrice::DEPRECATION_MSG)
+        if Spree::Config.enable_legacy_default_price
+          find_or_build_default_price.compare_at_price
+        else
+          price_in(Spree::Store.default.default_currency).compare_at_amount
+        end
+      end
 
-      after_save :save_default_price
+      def compare_at_price=(value)
+        Spree::Deprecation.warn(Spree::DefaultPrice::DEPRECATION_MSG)
+        if Spree::Config.enable_legacy_default_price
+          find_or_build_default_price.compare_at_price = value
+        else
+          default_currency = Spree::Store.default.default_currency
+          price_record = price_in(default_currency)
+          price_record.compare_at_amount = value
+          price_record.save! if price_record.persisted?
+        end
+      end
+
+      def display_compare_at_price
+        Spree::Deprecation.warn(Spree::DefaultPrice::DEPRECATION_MSG)
+        if Spree::Config.enable_legacy_default_price
+          find_or_build_default_price.display_compare_at_price
+        else
+          price_in(Spree::Store.default.default_currency).display_compare_at_amount
+        end
+      end
+
+      def price_including_vat_for(price_options)
+        Spree::Deprecation.warn(Spree::DefaultPrice::DEPRECATION_MSG)
+        if Spree::Config.enable_legacy_default_price
+          find_or_build_default_price.price_including_vat_for(price_options)
+        else
+          price_in(Spree::Store.default.default_currency).price_including_vat_for(price_options)
+        end
+      end
 
       def has_default_price?
-        !default_price.nil?
+        Spree::Deprecation.warn(Spree::DefaultPrice::DEPRECATION_MSG)
+        if Spree::Config.enable_legacy_default_price
+          !default_price.nil?
+        else
+          prices.base_prices.any? { |p| p.currency == Spree::Store.default.default_currency }
+        end
       end
 
       def find_or_build_default_price
-        default_price || build_default_price
+        Spree::Deprecation.warn(Spree::DefaultPrice::DEPRECATION_MSG)
+        if Spree::Config.enable_legacy_default_price
+          default_price || build_default_price
+        else
+          prices.base_prices.find { |p| p.currency == Spree::Store.default.default_currency } ||
+            prices.build(currency: Spree::Store.default.default_currency)
+        end
       end
 
       private

data/app/models/concerns/spree/stores/markets.rb

@@ -104,12 +104,14 @@ module Spree
                                     end
       end
 
-      private
-
+      # Returns true if the store has markets, false otherwise
+      # @return [Boolean]
       def has_markets?
         @has_markets ||= persisted? && (markets.loaded? ? markets.any? : markets.exists?)
       end
 
+      private
+
       def legacy_supported_currencies_list
         ([default_currency] + read_attribute(:supported_currencies).to_s.split(',')).uniq.map(&:to_s).map do |code|
           ::Money::Currency.find(code.strip)

data/app/models/spree/exports/product_translations.rb

@@ -0,0 +1,45 @@
+module Spree
+  module Exports
+    class ProductTranslations < Spree::Export
+      def scope_includes
+        []
+      end
+
+      def multi_line_csv?
+        true
+      end
+
+      def scope
+        if search_params.nil?
+          super.where.not(status: 'archived')
+        else
+          super
+        end
+      end
+
+      def csv_headers
+        Spree::CSV::ProductTranslationPresenter::CSV_HEADERS
+      end
+
+      def generate_csv
+        locales = store.supported_locales_list - [store.default_locale]
+        return super if locales.empty?
+
+        ::CSV.open(export_tmp_file_path, 'wb', encoding: 'UTF-8', col_sep: ',', row_sep: "\r\n") do |csv|
+          csv << csv_headers
+          records_to_export.includes(scope_includes).find_in_batches do |batch|
+            batch.each do |product|
+              product.to_translation_csv(store, locales).each do |line|
+                csv << line
+              end
+            end
+          end
+        end
+      end
+
+      def model_class
+        Spree::Product
+      end
+    end
+  end
+end

data/app/models/spree/import_schemas/product_translations.rb

@@ -0,0 +1,14 @@
+module Spree
+  module ImportSchemas
+    class ProductTranslations < Spree::ImportSchema
+      FIELDS = [
+        { name: 'slug', label: 'Slug', required: true },
+        { name: 'locale', label: 'Locale', required: true },
+        { name: 'name', label: 'Name' },
+        { name: 'description', label: 'Description' },
+        { name: 'meta_title', label: 'Meta Title' },
+        { name: 'meta_description', label: 'Meta Description' }
+      ].freeze
+    end
+  end
+end

data/app/models/spree/imports/product_translations.rb

@@ -0,0 +1,17 @@
+module Spree
+  module Imports
+    class ProductTranslations < Spree::Import
+      def row_processor_class
+        Spree::Imports::RowProcessors::ProductTranslation
+      end
+
+      def model_class
+        Spree::Product
+      end
+
+      def self.model_class
+        Spree::Product
+      end
+    end
+  end
+end

data/app/models/spree/market.rb

@@ -13,6 +13,7 @@ module Spree
     belongs_to :store, class_name: 'Spree::Store', touch: true
     has_many :market_countries, class_name: 'Spree::MarketCountry', dependent: :destroy
     has_many :countries, through: :market_countries, class_name: 'Spree::Country'
+    has_many :orders, class_name: 'Spree::Order', dependent: :nullify
 
     #
     # Validations

data/app/models/spree/metafield.rb

@@ -11,7 +11,7 @@ module Spree
     #
     # Delegations
     #
-    delegate :key, :full_key, :name, :display_on, to: :metafield_definition, allow_nil: true
+    delegate :key, :full_key, :name, :label, :display_on, to: :metafield_definition, allow_nil: true
 
     #
     # Callbacks

data/app/models/spree/metafield_definition.rb

@@ -51,6 +51,16 @@ module Spree
     self.whitelisted_ransackable_attributes = %w[key namespace name resource_type display_on]
     self.whitelisted_ransackable_scopes = %w[search multi_search]
 
+    # 5.5 API naming bridge (DB column rename in 6.0)
+    # Aligns with OptionType/OptionValue which also expose `label` for the display name.
+    def label
+      name
+    end
+
+    def label=(value)
+      self.name = value
+    end
+
     # Returns the full key with namespace
     # @return [String] eg. custom.id
     def full_key

data/app/models/spree/option_type.rb

@@ -3,6 +3,7 @@ module Spree
     has_prefix_id :opt  # Spree-specific: option type
 
     COLOR_NAMES = %w[color colour].freeze
+    KINDS = %w[dropdown color_swatch buttons].freeze
 
     include Spree::ParameterizableName
     include Spree::UniqueName
@@ -34,18 +35,28 @@ module Spree
     has_many :prototypes, through: :option_type_prototypes, class_name: 'Spree::Prototype'
 
     # 5.5 API naming bridge (DB column rename in 6.0)
-    alias_attribute :label, :presentation
+    # NOTE: alias_attribute bypasses Mobility's locale-aware reader/writer,
+    # so we define explicit delegating methods instead.
+    def label(*args)
+      presentation(*args)
+    end
+
+    def label=(value)
+      self.presentation = value
+    end
 
     #
     # Validations
     #
     validates :presentation, presence: true
+    validates :kind, presence: true, inclusion: { in: KINDS }
 
     #
     # Scopes
     #
     default_scope { order(:position) }
     scope :colors, -> { where(name: COLOR_NAMES) }
+    scope :color_swatches, -> { where(kind: 'color_swatch') }
     scope :filterable, -> { where(filterable: true) }
 
     #
@@ -72,8 +83,15 @@ module Spree
       colors.first
     end
 
+    def color_swatch?
+      kind == 'color_swatch'
+    end
+
     def color?
-      name.in?(COLOR_NAMES)
+      Spree::Deprecation.warn(
+        'Spree::OptionType#color? is deprecated. Use #color_swatch? instead. Will be removed in Spree 6.0.'
+      )
+      color_swatch?
     end
 
     private

data/app/models/spree/option_value.rb

@@ -20,6 +20,11 @@ module Spree
     acts_as_list scope: :option_type
     self.whitelisted_ransackable_attributes = ['presentation']
 
+    #
+    # Attachments
+    #
+    has_one_attached :image
+
     #
     # Associations
     #
@@ -29,7 +34,15 @@ module Spree
     has_many :products, through: :variants, class_name: 'Spree::Product'
 
     # 5.5 API naming bridge (DB column rename in 6.0)
-    alias_attribute :label, :presentation
+    # NOTE: alias_attribute bypasses Mobility's locale-aware reader/writer,
+    # so we define explicit delegating methods instead.
+    def label(*args)
+      presentation(*args)
+    end
+
+    def label=(value)
+      self.presentation = value
+    end
 
     #
     # Validations
@@ -39,6 +52,9 @@ module Spree
       validates :presentation
     end
 
+    validates :color_code, format: { with: /\A#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?\z/, message: 'must be a valid hex color (e.g. #FF0000)' },
+                           allow_blank: true
+
     #
     # Scopes
     #

data/app/models/spree/order.rb

@@ -54,7 +54,7 @@ module Spree
     alias display_ship_total display_shipment_total
     alias_attribute :ship_total, :shipment_total
     def amount_due
-      outstanding_balance
+      [outstanding_balance - total_applied_store_credit, 0].max
     end
 
     # Transient warnings populated by remove_out_of_stock_items!
@@ -140,6 +140,7 @@ module Spree
     alias_attribute :shipping_address_id, :ship_address_id
 
     belongs_to :store, class_name: 'Spree::Store'
+    belongs_to :market, class_name: 'Spree::Market', optional: true
 
     with_options dependent: :destroy do
       has_many :state_changes, as: :stateful, class_name: 'Spree::StateChange'
@@ -181,6 +182,8 @@ module Spree
     alias_attribute :fulfillment_status, :shipment_state
     alias_attribute :payment_status, :payment_state
 
+    delegate :has_markets?, to: :store, prefix: true
+
     accepts_nested_attributes_for :line_items
     accepts_nested_attributes_for :bill_address
     accepts_nested_attributes_for :ship_address
@@ -191,12 +194,14 @@ module Spree
 
     # Needs to happen before save_permalink is called
     before_validation :ensure_store_presence
+    before_validation :ensure_market_presence
     before_validation :ensure_currency_presence
     before_validation :ensure_locale_presence
+    before_validation :resolve_market_from_currency, if: -> { persisted? && currency_changed? && !skip_market_resolution }
 
     before_validation :clone_billing_address, if: :use_billing?
     before_validation :clone_shipping_address, if: :use_shipping?
-    attr_accessor :use_billing, :use_shipping
+    attr_accessor :use_billing, :use_shipping, :skip_market_resolution
 
     before_create :link_by_email
     before_update :ensure_updated_shipments, :homogenize_line_item_currencies, if: :currency_changed?
@@ -220,6 +225,7 @@ module Spree
     validates :shipment_total,       MONEY_VALIDATION
     validates :promo_total,          NEGATIVE_MONEY_VALIDATION
     validates :total,                MONEY_VALIDATION
+    validates :market, presence: true, if: :store_has_markets?
     validate :currency_must_be_supported_by_store
     validate :locale_must_be_supported_by_store
 
@@ -450,6 +456,10 @@ module Spree
       self.store ||= Spree::Store.default
     end
 
+    def ensure_market_presence
+      self.market ||= Spree::Current.market || store&.default_market
+    end
+
     def allow_cancel?
       return false if !completed? || canceled?
 
@@ -1050,6 +1060,16 @@ module Spree
       end
     end
 
+    # When currency changes, auto-resolve the matching market.
+    # Only applies when the store has markets configured.
+    def resolve_market_from_currency
+      return unless store_has_markets?
+      return if market&.currency == currency
+
+      resolved = store.markets.find_by(currency: currency)
+      self.market = resolved if resolved
+    end
+
     def collect_payment_methods
       Spree::Deprecation.warn('`Order#collect_payment_methods` is deprecated and will be removed in Spree 5.5. Use `collect_frontend_payment_methods` instead.')
 

data/app/models/spree/price.rb

@@ -135,7 +135,7 @@ module Spree
     #
     # @return [Boolean]
     def discounted?
-      compare_at_amount.to_i.positive? && compare_at_amount > amount
+      compare_at_amount.to_i.positive? && amount.present? && compare_at_amount > amount
     end
 
     # returns true if the price was discounted

data/app/models/spree/product.rb

@@ -604,19 +604,40 @@ module Spree
       taxons_for_csv.fill(nil, taxons_for_csv.size...3)
 
       csv_lines = []
+      all_variants = has_variants? ? variants_including_master.to_a : [master]
+      default_currency = store.default_currency
+      additional_currencies = store.supported_currencies_list.map(&:iso_code) - [default_currency]
+
+      # Primary rows in the store's default currency
+      all_variants.each_with_index do |variant, index|
+        csv_lines << Spree::CSV::ProductVariantPresenter.new(self, variant, index, properties_for_csv, taxons_for_csv, store,
+                                                             metafields_for_csv).call
+      end
 
-      if has_variants?
-        variants_including_master.each_with_index do |variant, index|
-          csv_lines << Spree::CSV::ProductVariantPresenter.new(self, variant, index, properties_for_csv, taxons_for_csv, store,
-                                                               metafields_for_csv).call
+      # Price-only rows for each additional currency
+      additional_currencies.each do |currency|
+        all_variants.each do |variant|
+          next unless variant.amount_in(currency)
+
+          csv_lines << Spree::CSV::ProductVariantPresenter.new(self, variant, 0, [], [], store,
+                                                               [], currency).call
         end
-      else
-        csv_lines << Spree::CSV::ProductVariantPresenter.new(self, master, 0, properties_for_csv, taxons_for_csv, store, metafields_for_csv).call
       end
 
       csv_lines
     end
 
+    def to_translation_csv(store = nil, locales = [])
+      locales.filter_map do |locale|
+        # Only export if at least one field has a translation for this locale
+        has_translation = Spree::CSV::ProductTranslationPresenter::TRANSLATABLE_FIELDS.any? do |field|
+          get_field_with_locale(locale, field).present?
+        end
+
+        Spree::CSV::ProductTranslationPresenter.new(self, locale).call if has_translation
+      end
+    end
+
     private
 
     # Determines which variant should be used for displaying media.
@@ -652,11 +673,12 @@ module Spree
       values = option_values_hash.values
       values = values.inject(values.shift) { |memo, value| memo.product(value).map(&:flatten) }
 
+      default_currency = stores.first&.default_currency || Spree::Store.default.default_currency
+      master_price = master.price_in(default_currency).amount
+
       values.each do |ids|
-        variants.create(
-          option_value_ids: ids,
-          price: master.price
-        )
+        variant = variants.create!(option_value_ids: ids)
+        variant.set_price(default_currency, master_price) if master_price.present?
       end
       save
     end
@@ -690,6 +712,7 @@ module Spree
         master.new_record? ||
         master.changed? ||
         (
+          Spree::Config.enable_legacy_default_price &&
           master.default_price &&
           (
             master.default_price.new_record? ||
@@ -712,9 +735,13 @@ module Spree
     # If the master cannot be saved, the Product object will get its errors
     # and will be destroyed
     def validate_master
-      # We call master.default_price here to ensure price is initialized.
-      # Required to avoid Variant#check_price validation failing on create.
-      unless master.default_price && master.valid?
+      if Spree::Config.enable_legacy_default_price
+        # We call master.default_price here to ensure price is initialized.
+        # Required to avoid Variant#check_price validation failing on create.
+        master.default_price
+      end
+
+      unless master.valid?
         master.errors.map { |error| { field: error.attribute, message: error&.message } }.each do |err|
           next if err[:field].blank? || err[:message].blank?
 

data/app/models/spree/search_provider/meilisearch.rb

@@ -103,9 +103,10 @@ module Spree
         product_prefixed_ids = ms_result['hits'].map { |h| h['product_id'] }.uniq
         raw_ids = product_prefixed_ids.filter_map { |pid| Spree::Product.decode_prefixed_id(pid) }
 
-        # Intersect with AR scope for security/visibility.
+        # Intersect with AR scope for security/visibility, preserving Meilisearch sort order.
         products = if raw_ids.any?
-                     scope.where(id: raw_ids).reorder(nil)
+                     records = scope.where(id: raw_ids).reorder(nil).index_by(&:id)
+                     raw_ids.filter_map { |id| records[id] }
                    else
                      scope.none
                    end
@@ -123,8 +124,9 @@ module Spree
       end
 
       def index(product)
+        ensure_index_settings_once!
         documents = presenter_class.new(product, store).call
-        client.index(index_name).add_documents(documents, 'prefixed_id')
+        client.index(index_name).add_documents(documents, 'id')
       end
 
       def remove(product)
@@ -132,7 +134,9 @@ module Spree
       end
 
       def index_batch(documents)
-        client.index(index_name).add_documents(documents, 'prefixed_id')
+        return if documents.empty?
+
+        client.index(index_name).add_documents(documents, 'id')
       end
 
       # Remove all documents for a product by its prefixed_id (e.g. 'prod_abc')
@@ -147,21 +151,44 @@ module Spree
         scope ||= store.products
         ensure_index_settings!
 
+        indexed = 0
         scope.reorder(id: :asc)
              .preload_associations_lazily
              .find_in_batches(batch_size: 500) do |batch|
           documents = batch.flat_map { |product| presenter_class.new(product, store).call }
+          next if documents.empty?
+
           index_batch(documents)
+          indexed += documents.size
+
+          Rails.logger.info { "[Meilisearch] Enqueued #{documents.size} documents (#{indexed} total) for #{index_name}" }
         end
+
+        Rails.logger.info { "[Meilisearch] Reindex complete: #{indexed} documents enqueued for #{index_name}" }
+        indexed
       end
 
       # Configure index settings for filtering, sorting, and faceting.
       # Called automatically by reindex, but can be called separately.
+      # Waits for all settings tasks to complete before returning so that
+      # subsequent add_documents calls use the correct filterable/sortable attributes.
       def ensure_index_settings!
         index = client.index(index_name)
-        index.update_filterable_attributes(filterable_attributes)
-        index.update_sortable_attributes(sortable_attributes)
-        index.update_searchable_attributes(searchable_attributes)
+        tasks = []
+        tasks << index.update_filterable_attributes(filterable_attributes)
+        tasks << index.update_sortable_attributes(sortable_attributes)
+        tasks << index.update_searchable_attributes(searchable_attributes)
+        tasks.each { |task| task&.await }
+        @index_settings_configured = true
+      end
+
+      # Lightweight guard — configures index settings once per provider instance.
+      # Meilisearch settings updates are idempotent, so repeated calls are safe
+      # but we avoid the overhead by memoizing.
+      def ensure_index_settings_once!
+        return if @index_settings_configured
+
+        ensure_index_settings!
       end
 
       private
@@ -359,7 +386,12 @@ module Spree
 
           ot = ov.option_type
           by_option_type[ot] ||= []
-          by_option_type[ot] << { id: ov.prefixed_id, name: ov.name, label: ov.label, position: ov.position, count: count }
+          by_option_type[ot] << {
+            id: ov.prefixed_id, name: ov.name, label: ov.label, position: ov.position,
+            color_code: ov.color_code,
+            image_url: ov.image.attached? ? Rails.application.routes.url_helpers.cdn_image_url(ov.image) : nil,
+            count: count
+          }
         end
 
         by_option_type.map do |option_type, values|
@@ -368,6 +400,7 @@ module Spree
             type: 'option',
             name: option_type.name,
             label: option_type.label,
+            kind: option_type.kind,
             options: values.sort_by { |o| o[:position] }
           }
         end

data/app/models/spree/stock_location.rb

@@ -27,7 +27,7 @@ module Spree
     after_save :ensure_one_default
     after_update :conditional_touch_records
 
-    delegate :name, :iso3, :iso, :iso_name, to: :country, prefix: true
+    delegate :name, :iso3, :iso, :iso_name, to: :country, prefix: true, allow_nil: true
 
     def state_text
       state.try(:abbr) || state.try(:name) || state_name