spree_core 5.4.0.rc6 → 5.4.0.rc7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10b8425a8850b155fa6d2a2d6d452e016fd142d62849ce757e00b4b2db1efcdc
-  data.tar.gz: 38b6187ef6b92566261d617d65e3eb59d2e760eca6d3519390189a40858a62c3
+  metadata.gz: 07eb5e06c1dbe2e9d89b69a3768a376fcf5d23f0be28bb15bd4e9fac1ce0bcaf
+  data.tar.gz: 99e243c978fb95cfd04e4b8ee42cc42b63f3580493939b4271be7992006c2bbb
 SHA512:
-  metadata.gz: 76058003b7c03e556c6f7d035fa6b1283688927ad6102cacd955932440e81054a8ace08032fc593545b897bdc321ca5d6ae2e720170468c9e64adee5b7083a53
-  data.tar.gz: 1783fc54faf9da589237ac09af8f665a2d145382eb6246911eecdfc2abdb26fce3d780e47f180fa6644a534164236232b4b30e3d8392c4fb869843405dfd2eaa
+  metadata.gz: 2967ba8a3825d98180adb93f0a025370c6aa6aee76520cf5400be56bfb6328b63f121434065f2acf8b600099f53136b067becec17c0f1523078dedd95cc4ccd5
+  data.tar.gz: ca2d9d12300bd8a765b3130cf86fd857d8c8b0ad7cc413f895956a806a642d5ef44c20983b08d227de1fff80b9bcfd68995173061fc60849ebe5dab185631ffb

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/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/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

@@ -35,7 +35,15 @@ 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

data/app/models/spree/option_value.rb

@@ -34,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

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!

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/stock_movement.rb

@@ -31,7 +31,8 @@ module Spree
     delegate :variant, :variant_id, to: :stock_item, allow_nil: true
     delegate :product, to: :variant
 
-    self.whitelisted_ransackable_attributes = ['quantity']
+    self.whitelisted_ransackable_attributes = %w[quantity action created_at stock_item_id originator_type]
+    self.whitelisted_ransackable_associations = %w[stock_item]
 
     def readonly?
       persisted?

data/app/models/spree/variant.rb

@@ -62,14 +62,13 @@ module Spree
 
     before_validation :set_cost_currency
 
-    validate :check_price
+    validate :check_price, if: -> { Spree::Config.enable_legacy_default_price }
 
     validates :option_value_variants, presence: true, unless: :is_master?
 
-    with_options numericality: { greater_than_or_equal_to: 0, allow_nil: true } do
-      validates :cost_price
-      validates :price
-    end
+    validates :cost_price, numericality: { greater_than_or_equal_to: 0, allow_nil: true }
+    validates :price, numericality: { greater_than_or_equal_to: 0, allow_nil: true },
+                      if: -> { Spree::Config.enable_legacy_default_price }
     validates :sku, uniqueness: { conditions: -> { where(deleted_at: nil) }, case_sensitive: false, scope: spree_base_uniqueness_scope },
                     allow_blank: true, unless: :disable_sku_validation?
 
@@ -447,8 +446,8 @@ module Spree
     def set_price(currency, amount, compare_at_amount = nil)
       price = prices.base_prices.find_or_initialize_by(currency: currency)
       price.amount = amount
-      price.compare_at_amount = compare_at_amount if compare_at_amount.present?
-      price.save!
+      price.compare_at_amount = compare_at_amount
+      price.save! if persisted?
     end
 
     # Returns the price for the given context or options.
@@ -607,18 +606,21 @@ module Spree
 
     # Ensures a new variant takes the product master price when price is not supplied
     def check_price
-      return if (has_default_price? && default_price.valid?) || prices.any?
+      return if prices.any?
 
       infer_price_from_default_variant_if_needed
-      self.currency = Spree::Store.default.default_currency if price.present? && currency.nil?
     end
 
     def infer_price_from_default_variant_if_needed
-      if price.nil?
+      default_currency = Spree::Store.default.default_currency
+      current_price = price_in(default_currency).amount
+
+      if current_price.nil?
         return errors.add(:base, :no_master_variant_found_to_infer_price) unless product&.master
 
         # At this point, master can have or have no price, so let's use price from the default variant
-        self.price = product.default_variant.price
+        inferred_price = product.default_variant.price_in(default_currency).amount
+        set_price(default_currency, inferred_price) if inferred_price.present?
       end
     end
 

data/app/presenters/spree/csv/product_translation_presenter.rb

@@ -0,0 +1,31 @@
+module Spree
+  module CSV
+    class ProductTranslationPresenter
+      CSV_HEADERS = %w[
+        slug
+        locale
+        name
+        description
+        meta_title
+        meta_description
+      ].freeze
+
+      TRANSLATABLE_FIELDS = %i[name description meta_title meta_description].freeze
+
+      def initialize(product, locale)
+        @product = product
+        @locale = locale.to_s
+      end
+
+      attr_reader :product, :locale
+
+      def call
+        [
+          product.slug,
+          locale,
+          *TRANSLATABLE_FIELDS.map { |field| product.get_field_with_locale(locale, field) }
+        ]
+      end
+    end
+  end
+end

data/app/presenters/spree/csv/product_variant_presenter.rb

@@ -47,18 +47,19 @@ module Spree
         'category3',
       ].freeze
 
-      def initialize(product, variant, index = 0, properties = [], taxons = [], store = nil, metafields = [])
+      def initialize(product, variant, index = 0, properties = [], taxons = [], store = nil, metafields = [], currency = nil)
         @product = product
         @variant = variant
         @index = index
         @properties = properties
         @taxons = taxons
         @store = store || product.stores.first
-        @currency = @store.default_currency
+        @currency = currency || @store.default_currency
+        @price_only = @currency != @store.default_currency
         @metafields = metafields
       end
 
-      attr_accessor :product, :variant, :index, :properties, :taxons, :store, :currency, :metafields
+      attr_accessor :product, :variant, :index, :properties, :taxons, :store, :currency, :price_only, :metafields
 
       ##
       # Generates an array representing a CSV row of product variant data.
@@ -72,6 +73,8 @@ module Spree
       #
       # @return [Array] An array containing the combined product and variant CSV data.
       def call
+        return price_only_row if price_only
+
         total_on_hand = variant.total_on_hand
 
         csv = [
@@ -134,6 +137,16 @@ module Spree
 
       private
 
+      def price_only_row
+        csv = Array.new(CSV_HEADERS.size)
+        csv[CSV_HEADERS.index('sku')] = variant.sku
+        csv[CSV_HEADERS.index('slug')] = product.slug
+        csv[CSV_HEADERS.index('price')] = variant.amount_in(currency)&.to_f
+        csv[CSV_HEADERS.index('compare_at_price')] = variant.compare_at_amount_in(currency)&.to_f
+        csv[CSV_HEADERS.index('currency')] = currency
+        csv
+      end
+
       def image_url_options
         { variant: :xlarge }
       end

data/app/services/spree/imports/row_processors/product_translation.rb

@@ -0,0 +1,45 @@
+module Spree
+  module Imports
+    module RowProcessors
+      class ProductTranslation < Base
+        TRANSLATABLE_FIELDS = %w[name description meta_title meta_description].freeze
+
+        def initialize(row)
+          super
+          @store = row.store
+        end
+
+        attr_reader :store
+
+        def process!
+          locale = attributes['locale'].to_s.strip
+          raise ArgumentError, 'Locale is required' if locale.blank?
+
+          slug = attributes['slug'].to_s.strip
+          raise ArgumentError, 'Slug is required' if slug.blank?
+
+          product = product_scope.find_by!(slug: slug)
+
+          translation_attrs = TRANSLATABLE_FIELDS.each_with_object({}) do |field, hash|
+            value = attributes[field]
+            hash[field.to_sym] = value.to_s.strip if value.present?
+          end
+
+          return product if translation_attrs.empty?
+
+          Mobility.with_locale(locale) do
+            product.update!(translation_attrs)
+          end
+
+          product
+        end
+
+        private
+
+        def product_scope
+          Spree::Product.accessible_by(import.current_ability, :manage)
+        end
+      end
+    end
+  end
+end

data/app/services/spree/imports/row_processors/product_variant.rb

@@ -32,7 +32,7 @@ module Spree
           variant.width = attributes['width'] if attributes['width'].present?
           variant.depth = attributes['depth'] if attributes['depth'].present?
           variant.track_inventory = attributes['track_inventory'] if attributes['track_inventory'].present?
-          variant.option_value_variants = prepare_option_value_variants
+          variant.option_value_variants = prepare_option_value_variants if options.any?
 
           if attributes['tax_category'].present?
             tax_category = prepare_tax_category
@@ -68,7 +68,7 @@ module Spree
 
             product = assign_attributes_to_product(product)
             product.save!
-            handle_metafields(product)
+            handle_metafields(product) if has_product_attributes?
             product
           else
             # For non-master variants, only look up the product
@@ -105,7 +105,11 @@ module Spree
               shipping_category = prepare_shipping_category
               product.shipping_category = shipping_category if shipping_category.present?
             end
-            product.taxons = prepare_taxons
+
+            taxons = prepare_taxons
+            # Full product rows (with name/status/description) clear taxons when categories are blank.
+            # Price-only rows (no product attributes) never touch taxons.
+            product.taxons = taxons if taxons.any? || has_product_attributes?
           end
 
           product
@@ -197,6 +201,10 @@ module Spree
           end
         end
 
+        def has_product_attributes?
+          %w[name status description category1 category2 category3].any? { |key| attributes[key].present? }
+        end
+
         def handle_metafields(product)
           return unless product.class.included_modules.include?(Spree::Metafields)
 

data/app/services/spree/products/prepare_nested_attributes.rb

@@ -33,8 +33,11 @@ module Spree
             existing_variant = variant_params[:id].presence && @product.variants.find_by(id: variant_params[:id])
             variants_to_remove.delete(variant_params[:id]) if variant_params[:id].present?
 
+            variant_params.delete(:price) # remove legacy price param
+
             if can_update_prices?
-              # If the variant price is nil then mark it for destruction
+              backfill_price_ids!(variant_params, existing_variant)
+
               variant_params[:prices_attributes]&.each do |price_key, price_params|
                 variant_params[:prices_attributes][price_key]['_destroy'] = '1' if price_params[:amount].blank?
               end
@@ -95,6 +98,20 @@ module Spree
 
       delegate :can?, :cannot?, to: :ability
 
+      # Backfill IDs for prices_attributes entries that reference existing prices
+      # so that ActiveRecord updates them instead of inserting duplicates
+      def backfill_price_ids!(variant_params, existing_variant)
+        return unless existing_variant && variant_params[:prices_attributes]
+
+        variant_params[:prices_attributes].each do |_key, price_params|
+          next if price_params[:id].present?
+          next if price_params[:currency].blank?
+
+          existing_price = existing_variant.prices.base_prices.find_by(currency: price_params[:currency])
+          price_params[:id] = existing_price.id if existing_price
+        end
+      end
+
       def product_option_types_params
         @product_option_types_params ||= {}
       end