spree_core 5.4.0.rc2 → 5.4.0.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5de0595dccb2046acb60805390c641e66c9e87c070c25df2587d5a8eaf9bc358
-  data.tar.gz: 6cd99e1b81481dd826565d1f579ea64965dfa04a808905f830505110f330473d
+  metadata.gz: feb2c702a17f0e10532d677c7c6cdb4a4092476ce33966db067ff095e0fd3d51
+  data.tar.gz: 6cfb1613127976496083e9d11d5a073e20c7d94b139d2df2f621e4c18ae52936
 SHA512:
-  metadata.gz: 1d27ab08a797c2f5419f36bd3ad368f1cecaf6610d1ca9289e9b5dea81f62a4856b8b767b23129b1dd20e0e0fd0c02f619581e58b7b347642cc801a2808de453
-  data.tar.gz: d551a808c3d989cf88e02c18b00bd9582b7672459b59e9c0ea281b6797cf5b0b95b698e32f98adc7a180723ab98e84aae99bc163ac5ee7de7a3d6745abc97e80
+  metadata.gz: 8abff3fa43c5226f1eb1c3dd1a5d1bd84fedfd9ef62895da5df6402df1bd9e0fcb68a9fd646790d90ea5efa04292330aeab50e9269d1352a8970c2c8ff362d39
+  data.tar.gz: 2cde221d1575d9d48c633d4aacdc588d775aff1445c0bdc5c895ff82e77444e3a5341d5fc1677d6c5013accd73f182f1e2ea5bb5b9532470d13dae4a7e316061

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

@@ -3,6 +3,16 @@ module Spree
     extend ActiveSupport::Concern
 
     included do
+      cattr_accessor :search_scopes do
+        []
+      end
+
+      def self.add_search_scope(name, &block)
+        Spree::Deprecation.warn("add_search_scope is deprecated and will be removed in Spree 6.0. Use scope :#{name}, &block instead or use method instead")
+        singleton_class.send(:define_method, name.to_sym, &block)
+        search_scopes << name.to_sym
+      end
+
       scope :ascend_by_updated_at, -> { order("#{Product.quoted_table_name}.updated_at ASC") }
       scope :descend_by_updated_at, -> { order("#{Product.quoted_table_name}.updated_at DESC") }
       scope :ascend_by_name, -> { order("#{Product.quoted_table_name}.name ASC") }

data/app/models/spree/order/gift_card.rb

@@ -34,11 +34,31 @@ module Spree
         Spree.gift_card_remove_service.call(order: self)
       end
 
+      # Recalculates the gift card payment amount based on the current order total.
+      # Updates the existing payment in place instead of remove + re-apply
+      # to avoid creating unnecessary invalid payment records.
       def recalculate_gift_card
-        applied_gift_card = gift_card
+        return unless gift_card.present?
+
+        payment = payments.checkout.store_credits.where(source: gift_card.store_credits).first
+        return unless payment
+
+        # with_lock acquires a row lock and wraps in a transaction.
+        # The entire read-compute-write must be inside the lock to prevent
+        # stale amount_remaining from concurrent requests.
+        gift_card.with_lock do
+          new_amount = [gift_card.amount_remaining + payment.amount, total].min
+          next if payment.amount == new_amount
 
-        remove_gift_card
-        apply_gift_card(applied_gift_card)
+          difference = new_amount - payment.amount
+          # Uses update_column to bypass Payment#max_amount validation which
+          # can fail during recalculation due to stale in-memory order state.
+          # Bounds are enforced via min() above.
+          payment.update_column(:amount, new_amount)
+          payment.source.update_column(:amount, new_amount)
+          gift_card.amount_used += difference
+          gift_card.save!
+        end
       end
 
       def redeem_gift_card

data/app/models/spree/order.rb

@@ -49,10 +49,27 @@ module Spree
                   :included_tax_total,  :additional_tax_total, :tax_total,
                   :shipment_total,      :promo_total,          :total,
                   :cart_promo_total,    :pre_tax_item_amount,  :pre_tax_total,
-                  :payment_total
+                  :payment_total,       :amount_due
 
     alias display_ship_total display_shipment_total
     alias_attribute :ship_total, :shipment_total
+    def amount_due
+      outstanding_balance
+    end
+
+    # Transient warnings populated by remove_out_of_stock_items!
+    attribute :warnings, default: -> { [] }
+
+    # Removes out-of-stock/discontinued items and populates warnings.
+    # Returns self (reloaded if items were removed) with warnings set.
+    def remove_out_of_stock_items!
+      result = Spree::Cart::RemoveOutOfStockItems.call(order: self)
+      return self unless result.success?
+
+      order, _messages, warnings = result.value
+      order.warnings = warnings || []
+      order
+    end
 
     # 5.5 API naming bridges (DB columns rename in 6.0)
     alias_attribute :discount_total, :promo_total

data/app/models/spree/price.rb

@@ -13,8 +13,11 @@ module Spree
     belongs_to :variant, -> { with_deleted }, class_name: 'Spree::Variant', inverse_of: :prices, touch: true
     belongs_to :price_list, class_name: 'Spree::PriceList', optional: true
 
+    has_many :price_histories, class_name: 'Spree::PriceHistory', dependent: :delete_all
+
     before_validation :ensure_currency
     before_save :remove_compare_at_amount_if_equals_amount
+    after_save :record_price_history, if: :should_record_price_history?
 
     # legacy behavior
     validates :amount, allow_nil: true, numericality: {
@@ -156,8 +159,34 @@ module Spree
       !zero?
     end
 
+    # Returns the price history record with the lowest amount in the last 30 days
+    # Used for EU Omnibus Directive compliance
+    #
+    # @return [Spree::PriceHistory, nil]
+    def prior_price
+      price_histories.where(recorded_at: 30.days.ago..).order(:amount).first
+    end
+
     private
 
+    def should_record_price_history?
+      price_list_id.nil? &&
+        amount.present? &&
+        saved_change_to_amount? &&
+        Spree::Config[:track_price_history]
+    end
+
+    def record_price_history
+      Spree::PriceHistory.create!(
+        price: self,
+        variant_id: variant_id,
+        amount: amount,
+        compare_at_amount: compare_at_amount,
+        currency: currency,
+        recorded_at: Time.current
+      )
+    end
+
     def ensure_currency
       self.currency ||= Spree::Store.default.default_currency
     end

data/app/models/spree/price_history.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Spree
+  class PriceHistory < Spree.base_class
+    belongs_to :price, class_name: 'Spree::Price'
+    belongs_to :variant, class_name: 'Spree::Variant'
+
+    validates :amount, presence: true, numericality: { greater_than_or_equal_to: 0 }
+    validates :currency, presence: true
+    validates :recorded_at, presence: true
+
+    scope :for_variant, ->(variant_id) { where(variant_id: variant_id) }
+    scope :for_currency, ->(currency) { where(currency: currency) }
+    scope :in_period, ->(from, to = Time.current) { where(recorded_at: from..to) }
+    scope :recent, ->(days = 30) { in_period(days.days.ago) }
+
+    def money
+      Spree::Money.new(amount || 0, currency: currency)
+    end
+
+    def display_amount
+      money.to_s
+    end
+
+    def amount_in_cents
+      money.amount_in_cents
+    end
+  end
+end

data/app/models/spree/promotion_handler/coupon.rb

@@ -11,7 +11,7 @@ module Spree
       end
 
       def apply
-        if load_gift_card_code
+        if gift_cards_enabled? && load_gift_card_code
 
           if @gift_card.expired?
             set_error_code :gift_card_expired
@@ -47,7 +47,7 @@ module Spree
       end
 
       def remove(coupon_code)
-        if order.gift_card
+        if gift_cards_enabled? && order.gift_card
           result = order.remove_gift_card
 
           if result.success?
@@ -212,6 +212,13 @@ module Spree
         Spree::CouponCode.unused.find_by(promotion_id: discount.source.promotion_id, code: coupon_code)&.apply_order!(order)
       end
 
+      # Whether the coupon handler should also handle gift card codes.
+      # Defaults to true for backwards compatibility. Pass enable_gift_cards: false
+      # when using the dedicated gift card endpoint.
+      def gift_cards_enabled?
+        options.fetch(:enable_gift_cards, true)
+      end
+
       def load_gift_card_code
         return unless order.coupon_code.present?
 

data/app/services/spree/cart/remove_out_of_stock_items.rb

@@ -5,8 +5,9 @@ module Spree
 
       def call(order:)
         @messages = []
+        @warnings = []
 
-        return success([order, @messages]) if order.item_count.zero? || order.line_items.none?
+        return success([order, @messages, @warnings]) if order.item_count.zero? || order.line_items.none?
 
         line_items = order.line_items.includes(variant: [:product, :stock_items, :stock_locations, { stock_items: :stock_location }])
 
@@ -17,9 +18,9 @@ module Spree
         end
 
         if @messages.any? # If any line item was removed, reload the order
-          success([order.reload, @messages])
+          success([order.reload, @messages, @warnings])
         else
-          success([order, @messages])
+          success([order, @messages, @warnings])
         end
       end
 
@@ -28,7 +29,14 @@ module Spree
       def valid_status?(line_item)
         product = line_item.product
         if !product.active? || product.deleted? || product.discontinued? || line_item.variant.discontinued?
-          @messages << Spree.t('cart_line_item.discontinued', li_name: line_item.name)
+          message = Spree.t('cart_line_item.discontinued', li_name: line_item.name)
+          @messages << message
+          @warnings << {
+            code: 'line_item_removed',
+            message: message,
+            line_item_id: line_item.prefixed_id,
+            variant_id: line_item.variant.prefixed_id
+          }
           return false
         end
         true
@@ -36,7 +44,14 @@ module Spree
 
       def stock_available?(line_item)
         if line_item.insufficient_stock?
-          @messages << Spree.t('cart_line_item.out_of_stock', li_name: line_item.name)
+          message = Spree.t('cart_line_item.out_of_stock', li_name: line_item.name)
+          @messages << message
+          @warnings << {
+            code: 'line_item_removed',
+            message: message,
+            line_item_id: line_item.prefixed_id,
+            variant_id: line_item.variant.prefixed_id
+          }
           return false
         end
         true

data/app/services/spree/carts/update.rb

@@ -89,18 +89,20 @@ module Spree
         cart.state = 'address'
       end
 
-      # Auto-advance as far as the checkout state machine allows.
-      # Loops cart.next until the cart can't progress further (e.g. missing
-      # payment) or reaches confirm/complete. Stops at the first step whose
-      # before_transition guard fails — the `requirements` array in the
-      # serialized response tells the frontend what's still missing.
-      # Failure is swallowed — the update itself already succeeded.
+      # Auto-advance as far as the checkout state machine allows, but never
+      # to complete. The complete transition must always be explicit via
+      # the /carts/:id/complete endpoint — otherwise gift cards or store
+      # credits that fully cover the order total would auto-complete the
+      # cart during address/delivery updates.
       def try_advance
         return if cart.complete? || cart.canceled?
 
+        steps = cart.checkout_steps
         loop do
+          current_index = steps.index(cart.state).to_i
+          next_step = steps[current_index + 1]
+          break if next_step.nil? || next_step == 'complete'
           break unless cart.next
-          break if cart.confirm? || cart.complete?
         end
       rescue StandardError => e
         Rails.error.report(e, context: { order_id: cart.id, state: cart.state }, source: 'spree.checkout')

data/app/services/spree/checkout/add_store_credit.rb

@@ -12,9 +12,13 @@ module Spree
         return failure(nil, Spree.t(:error_user_does_not_have_any_store_credits)) unless @order.user&.store_credits&.any?
 
         ApplicationRecord.transaction do
-          @order.payments.store_credits.where(state: :checkout).map(&:invalidate!)
+          existing = @order.payments.store_credits.where(state: :checkout)
 
-          apply_store_credits(remaining_total)
+          if existing.any?
+            update_existing_payments(existing, remaining_total)
+          else
+            apply_store_credits(remaining_total)
+          end
         end
 
         if @order.reload.payments.store_credits.valid.any?
@@ -27,6 +31,26 @@ module Spree
 
       private
 
+      # Update existing checkout store credit payments in place to avoid
+      # creating unnecessary invalid payment records on every recalculation.
+      def update_existing_payments(payments, remaining_total)
+        payments.each do |payment|
+          credit = payment.source
+          available = credit.amount_remaining + payment.amount
+          new_amount = [available, remaining_total].min
+
+          if new_amount.positive?
+            payment.update_column(:amount, new_amount)
+            remaining_total -= new_amount
+          else
+            payment.invalidate!
+          end
+        end
+
+        # If there's still remaining total, apply from additional store credits
+        apply_store_credits(remaining_total) if remaining_total.positive?
+      end
+
       def apply_store_credits(remaining_total)
         payment_method = Spree::PaymentMethod::StoreCredit.available.first
         raise 'Store credit payment method could not be found' unless payment_method

data/config/locales/en.yml

@@ -1222,6 +1222,7 @@ en:
     gift_card_expired: The Gift Card has expired.
     gift_card_mismatched_currency: Gift Card cannot be applied with current currency.
     gift_card_mismatched_customer: This gift card is associated with another user.
+    gift_card_not_found: The Gift Card was not found.
     gift_card_removed: The Gift Card was successfully removed from your order
     gift_card_using_store_credit_error: You can't apply the Gift Card after you applied the store credit.
     gift_cards: Gift Cards

data/db/migrate/20260323000000_create_spree_price_histories.rb

@@ -0,0 +1,20 @@
+class CreateSpreePriceHistories < ActiveRecord::Migration[7.2]
+  def change
+    create_table :spree_price_histories do |t|
+      t.references :price, null: false, index: false
+      t.references :variant, null: false, index: false
+      t.decimal :amount, precision: 10, scale: 2, null: false
+      t.decimal :compare_at_amount, precision: 10, scale: 2
+      t.string :currency, null: false
+      t.datetime :recorded_at, null: false
+      t.datetime :created_at, null: false
+    end
+
+    add_index :spree_price_histories, [:variant_id, :currency, :recorded_at],
+              name: 'idx_price_histories_variant_currency_recorded'
+    add_index :spree_price_histories, [:price_id, :recorded_at],
+              name: 'idx_price_histories_price_recorded'
+    add_index :spree_price_histories, :recorded_at,
+              name: 'idx_price_histories_recorded_at'
+  end
+end

data/lib/spree/core/configuration.rb

@@ -96,6 +96,8 @@ module Spree
       preference :tax_using_ship_address, :boolean, default: true
       preference :title_site_name_separator, :string, deprecated: true
       preference :track_inventory_levels, :boolean, default: true # Determines whether to track on_hand values for variants / products.
+      preference :track_price_history, :boolean, default: true # Records price changes for Omnibus Directive compliance. Disable for non-EU stores.
+      preference :price_history_retention_days, :integer, default: 30 # Days to retain price history records. Used by spree:price_history:prune rake task.
       preference :use_user_locale, :boolean, default: true
 
       # Sets the path used for products, taxons and pages.

data/lib/spree/core/version.rb

@@ -1,5 +1,5 @@
 module Spree
-  VERSION = '5.4.0.rc2'.freeze
+  VERSION = '5.4.0.rc3'.freeze
 
   def self.version
     VERSION

data/lib/spree/testing_support/factories/price_history_factory.rb

@@ -0,0 +1,9 @@
+FactoryBot.define do
+  factory :price_history, class: Spree::PriceHistory do
+    price
+    variant { price.variant }
+    amount { price.amount }
+    currency { price.currency }
+    recorded_at { Time.current }
+  end
+end

data/lib/tasks/price_history.rake

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+namespace :spree do
+  namespace :price_history do
+    desc 'Seed price history from existing base prices (run once after migration)'
+    task seed: :environment do
+      count = 0
+      Spree::Price.where(deleted_at: nil, price_list_id: nil).find_each do |price|
+        next if price.amount.nil?
+        next if Spree::PriceHistory.exists?(price_id: price.id)
+
+        Spree::PriceHistory.create!(
+          price: price,
+          variant_id: price.variant_id,
+          amount: price.amount,
+          compare_at_amount: price.compare_at_amount,
+          currency: price.currency,
+          recorded_at: price.updated_at || Time.current
+        )
+        count += 1
+      end
+
+      puts "Seeded #{count} price history records"
+    end
+
+    desc 'Prune price history older than retention period'
+    task prune: :environment do
+      retention_days = Spree::Config[:price_history_retention_days] || 30
+      deleted = Spree::PriceHistory
+                .where('recorded_at < ?', retention_days.days.ago)
+                .delete_all
+
+      puts "Pruned #{deleted} price history records older than #{retention_days} days"
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spree_core
 version: !ruby/object:Gem::Version
-  version: 5.4.0.rc2
+  version: 5.4.0.rc3
 platform: ruby
 authors:
 - Sean Schofield
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-23 00:00:00.000000000 Z
+date: 2026-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n-tasks
@@ -1052,6 +1052,7 @@ files:
 - app/models/spree/policy.rb
 - app/models/spree/preference.rb
 - app/models/spree/price.rb
+- app/models/spree/price_history.rb
 - app/models/spree/price_list.rb
 - app/models/spree/price_rule.rb
 - app/models/spree/price_rules/customer_group_rule.rb
@@ -1472,6 +1473,7 @@ files:
 - db/migrate/20260315000000_create_spree_allowed_origins.rb
 - db/migrate/20260315100000_add_product_media_support.rb
 - db/migrate/20260317000000_create_spree_refresh_tokens.rb
+- db/migrate/20260323000000_create_spree_price_histories.rb
 - db/sample_data/customers.csv
 - db/sample_data/metafield_definitions.rb
 - db/sample_data/orders.rb
@@ -1599,6 +1601,7 @@ files:
 - lib/spree/testing_support/factories/payment_source_factory.rb
 - lib/spree/testing_support/factories/policy_factory.rb
 - lib/spree/testing_support/factories/price_factory.rb
+- lib/spree/testing_support/factories/price_history_factory.rb
 - lib/spree/testing_support/factories/price_list_factory.rb
 - lib/spree/testing_support/factories/price_rule_factory.rb
 - lib/spree/testing_support/factories/product_factory.rb
@@ -1670,6 +1673,7 @@ files:
 - lib/tasks/dependencies.rake
 - lib/tasks/images.rake
 - lib/tasks/markets.rake
+- lib/tasks/price_history.rake
 - lib/tasks/products.rake
 - lib/tasks/sample_data.rake
 - lib/tasks/search.rake
@@ -1695,9 +1699,9 @@ licenses:
 - BSD-3-Clause
 metadata:
   bug_tracker_uri: https://github.com/spree/spree/issues
-  changelog_uri: https://github.com/spree/spree/releases/tag/v5.4.0.rc2
+  changelog_uri: https://github.com/spree/spree/releases/tag/v5.4.0.rc3
   documentation_uri: https://docs.spreecommerce.org/
-  source_code_uri: https://github.com/spree/spree/tree/v5.4.0.rc2
+  source_code_uri: https://github.com/spree/spree/tree/v5.4.0.rc3
 post_install_message:
 rdoc_options: []
 require_paths: