spree_core 5.2.6 → 5.3.0.rc1

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

@@ -65,7 +65,11 @@ module Spree
       #
       # @return [BigDecimal] The total amount of store credits applied to the order.
       def total_applied_store_credit
-        payments.store_credits.valid.sum(:amount)
+        if payments.loaded?
+          payments.find_all(&:store_credit?).find_all(&:valid?).sum(&:amount) || BigDecimal::ZERO
+        else
+          payments.store_credits.valid.sum(:amount)
+        end
       end
 
       # Returns true if the order is using store credit.

data/app/models/spree/order.rb

@@ -28,6 +28,8 @@ module Spree
     include Spree::NumberIdentifier
     include Spree::NumberAsParam
     include Spree::SingleStoreResource
+
+    publishes_lifecycle_events
     include Spree::MemoizedData
     include Spree::Metafields
     include Spree::Metadata
@@ -40,6 +42,7 @@ module Spree
     end
 
     has_secure_token :token, length: 35
+    has_rich_text :internal_note
 
     MEMOIZED_METHODS = %w(tax_zone)
 
@@ -202,8 +205,8 @@ module Spree
       joins(:refunds).group(:id).having("sum(#{Spree::Refund.table_name}.amount) = #{Spree::Order.table_name}.total")
     }
     scope :partially_refunded, lambda {
-                                joins(:refunds).group(:id).having("sum(#{Spree::Refund.table_name}.amount) < #{Spree::Order.table_name}.total")
-                              }
+      joins(:refunds).group(:id).having("sum(#{Spree::Refund.table_name}.amount) < #{Spree::Order.table_name}.total")
+    }
     scope :with_deleted_bill_address, -> { joins(:bill_address).where.not(Address.table_name => { deleted_at: nil }) }
     scope :with_deleted_ship_address, -> { joins(:ship_address).where.not(Address.table_name => { deleted_at: nil }) }
 
@@ -268,15 +271,26 @@ module Spree
       completed_at.present?
     end
 
+    # Checks if the order is fully refunded
+    # @return [Boolean]
     def order_refunded?
-      (payment_state.in?(%w[void failed]) && refunds.sum(:amount).positive?) ||
-        refunds.sum(:amount) == total_minus_store_credits - additional_tax_total.abs
+      return false if item_count.zero?
+
+      (payment_state.in?(%w[void failed]) && refunds_total.positive?) ||
+        refunds_total == total_minus_store_credits - additional_tax_total.abs
     end
 
+    def refunds_total
+      refunds.loaded? ? refunds.sum(&:amount) : refunds.sum(:amount)
+    end
+
+    # Checks if the order is partially refunded
+    # @return [Boolean]
     def partially_refunded?
-      return false if refunds.empty? || payment_state.in?(%w[void failed])
+      return false if item_count.zero?
+      return false if payment_state.in?(%w[void failed]) || refunds.empty?
 
-      refunds.sum(:amount) < total_minus_store_credits - additional_tax_total.abs
+      refunds_total < total_minus_store_credits - additional_tax_total.abs
     end
 
     # Indicates whether or not the user is allowed to proceed to checkout.
@@ -391,6 +405,9 @@ module Spree
       ActiveRecord::Base.connected_to(role: :writing) do
         self.class.unscoped.where(id: self).update_all(changes)
       end
+
+      # Manually publish update event since update_all bypasses callbacks
+      publish_event('order.updated') if changes.present?
     end
 
     def disassociate_user!
@@ -520,12 +537,11 @@ module Spree
 
       touch :completed_at
 
-      deliver_order_confirmation_email unless confirmation_delivered?
-      deliver_store_owner_order_notification_email if deliver_store_owner_order_notification_email?
-
       send_order_placed_webhook
 
       consider_risk
+
+      publish_order_completed_event
     end
 
     def fulfill!
@@ -540,10 +556,7 @@ module Spree
     end
 
     def available_payment_methods(store = nil)
-      Spree::Deprecation.warn('`Order#available_payment_methods` is deprecated and will be removed in Spree 6. Use `collect_frontend_payment_methods` instead.')
-      if store.present?
-        Spree::Deprecation.warn('The `store` parameter is deprecated and will be removed in Spree 5. Order is already associated with Store')
-      end
+      Spree::Deprecation.warn('`Order#available_payment_methods` is deprecated and will be removed in Spree 5.5. Use `collect_frontend_payment_methods` instead.')
 
       @available_payment_methods ||= collect_payment_methods(store)
     end
@@ -691,6 +704,10 @@ module Spree
       if shipments.any? && !completed?
         shipments.destroy_all
         update_column(:shipment_total, 0)
+
+        # Manually publish update event since update_column bypasses callbacks
+        publish_event('order.updated')
+
         restart_checkout_flow
       end
     end
@@ -700,6 +717,10 @@ module Spree
         state: 'cart',
         updated_at: Time.current
       )
+
+      # Manually publish update event since update_columns bypasses callbacks
+      publish_event('order.updated')
+
       next! unless line_items.empty?
     end
 
@@ -733,24 +754,28 @@ module Spree
 
     def canceled_by(user, canceled_at = nil)
       canceled_at ||= Time.current
+      changes = { canceler_id: user.id, canceled_at: canceled_at }
 
       transaction do
-        update_columns(
-          canceler_id: user.id,
-          canceled_at: canceled_at
-        )
+        update_columns(changes)
         cancel!
       end
+
+      # Manually publish update event since update_columns bypasses callbacks
+      publish_event('order.canceled')
     end
 
     def approved_by(user)
+      approved_at = Time.current
+      changes = { approver_id: user.id, approved_at: approved_at }
+
       transaction do
         approve!
-        update_columns(
-          approver_id: user.id,
-          approved_at: Time.current
-        )
+        update_columns(changes)
       end
+
+      # Manually publish update event since update_columns bypasses callbacks
+      publish_event('order.approved')
     end
 
     def approved?
@@ -776,10 +801,16 @@ module Spree
 
     def considered_risky!
       update_column(:considered_risky, true)
+
+      # Manually publish update event since update_column bypasses callbacks
+      publish_event('order.updated')
     end
 
     def approve!
       update_column(:considered_risky, false)
+
+      # Manually publish update event since update_column bypasses callbacks
+      publish_event('order.approved')
     end
 
     def tax_total
@@ -817,14 +848,22 @@ module Spree
       Spree::CouponCode.find_by(order: self, promotion: promotions).try(:code) || promotions.pluck(:code).compact.first
     end
 
+    # Returns the valid promotions for the order
+    # @return [Array<Spree::OrderPromotion>]
     def valid_promotions
-      order_promotions.where(promotion_id: valid_promotion_ids).uniq(&:promotion_id)
+      order_promotions.includes(:promotion).where(promotion_id: valid_promotion_ids).uniq(&:promotion_id)
     end
 
+    # Returns the IDs of the valid promotions for the order
+    # @return [Array<Integer>]
     def valid_promotion_ids
-      all_adjustments.eligible.nonzero.promotion.map { |a| a.source.promotion_id }.uniq
+      all_adjustments.eligible.nonzero.promotion.promotion.eligible.nonzero.promotion.
+        joins("INNER JOIN #{Spree::PromotionAction.table_name} ON #{Spree::PromotionAction.table_name}.id = #{Spree::Adjustment.table_name}.source_id").
+        pluck("#{Spree::PromotionAction.table_name}.promotion_id").compact.uniq
     end
 
+    # Returns the valid coupon promotions for the order
+    # @return [Array<Spree::Promotion>]
     def valid_coupon_promotions
       promotions.
         where(id: valid_promotion_ids).
@@ -832,7 +871,7 @@ module Spree
     end
 
     # Returns item and whole order discount amount for Order
-    # without Shipment disccounts (eg. Free Shipping)
+    # without Shipment discounts (eg. Free Shipping)
     # @return [BigDecimal]
     def cart_promo_total
       all_adjustments.eligible.nonzero.promotion.
@@ -897,7 +936,7 @@ module Spree
           errors.add(:base, Spree.t(:items_cannot_be_shipped))
         end
 
-        return false
+        false
       end
     end
 
@@ -917,12 +956,14 @@ module Spree
       send_cancel_email
       update_with_updater!
       send_order_canceled_webhook
+      publish_order_canceled_event
     end
 
     def after_resume
       shipments.each(&:resume!)
       consider_risk
       send_order_resumed_webhook
+      publish_order_resumed_event
     end
 
     def use_billing?
@@ -937,12 +978,8 @@ module Spree
       self.currency ||= store&.default_currency
     end
 
-    def collect_payment_methods(store = nil)
-      Spree::Deprecation.warn('`Order#collect_payment_methods` is deprecated and will be removed in Spree 6. Use `collect_frontend_payment_methods` instead.')
-      if store.present?
-        Spree::Deprecation.warn('The `store` parameter is deprecated and will be removed in Spree 5. Order is already associated with Store')
-      end
-      store ||= self.store
+    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.')
 
       store.payment_methods.available_on_front_end.select { |pm| pm.available_for_order?(self) }
     end
@@ -960,5 +997,17 @@ module Spree
         Spree.checkout_add_store_credit_service.call(order: self)
       end
     end
+
+    def publish_order_completed_event
+      publish_event('order.completed')
+    end
+
+    def publish_order_canceled_event
+      publish_event('order.canceled')
+    end
+
+    def publish_order_resumed_event
+      publish_event('order.resumed')
+    end
   end
 end

data/app/models/spree/order_updater.rb

@@ -79,15 +79,34 @@ module Spree
 
     def update_adjustment_total
       recalculate_adjustments
-      order.adjustment_total = line_items.sum(:adjustment_total) +
-        shipments.sum(:adjustment_total) +
-        adjustments.eligible.sum(:amount)
-      order.included_tax_total = line_items.sum(:included_tax_total) + shipments.sum(:included_tax_total)
-      order.additional_tax_total = line_items.sum(:additional_tax_total) + shipments.sum(:additional_tax_total)
-
-      order.promo_total = line_items.sum(:promo_total) +
-        shipments.sum(:promo_total) +
-        adjustments.promotion.eligible.sum(:amount)
+
+      # Fetch all line item totals in a single query
+      # Use reorder(nil) to remove default ordering which conflicts with aggregates in PostgreSQL
+      line_item_totals = line_items.reorder(nil).pick(
+        Arel.sql('COALESCE(SUM(adjustment_total), 0)'),
+        Arel.sql('COALESCE(SUM(included_tax_total), 0)'),
+        Arel.sql('COALESCE(SUM(additional_tax_total), 0)'),
+        Arel.sql('COALESCE(SUM(promo_total), 0)')
+      ) || [0, 0, 0, 0]
+
+      # Fetch all shipment totals in a single query
+      shipment_totals = shipments.reorder(nil).pick(
+        Arel.sql('COALESCE(SUM(adjustment_total), 0)'),
+        Arel.sql('COALESCE(SUM(included_tax_total), 0)'),
+        Arel.sql('COALESCE(SUM(additional_tax_total), 0)'),
+        Arel.sql('COALESCE(SUM(promo_total), 0)')
+      ) || [0, 0, 0, 0]
+
+      # Fetch order-level adjustment totals in a single query
+      order_adjustment_totals = adjustments.eligible.reorder(nil).pick(
+        Arel.sql('COALESCE(SUM(amount), 0)'),
+        Arel.sql("COALESCE(SUM(CASE WHEN source_type = 'Spree::PromotionAction' THEN amount ELSE 0 END), 0)")
+      ) || [0, 0]
+
+      order.adjustment_total = line_item_totals[0] + shipment_totals[0] + order_adjustment_totals[0]
+      order.included_tax_total = line_item_totals[1] + shipment_totals[1]
+      order.additional_tax_total = line_item_totals[2] + shipment_totals[2]
+      order.promo_total = line_item_totals[3] + shipment_totals[3] + order_adjustment_totals[1]
 
       update_order_total
     end

data/app/models/spree/payment/custom_events.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Spree
+  class Payment < Spree.base_class
+    # Publishes custom payment events beyond basic lifecycle events.
+    #
+    # Events:
+    # - payment.paid: Payment was completed
+    # - order.paid: Order is fully paid (no outstanding balance)
+    #
+    module CustomEvents
+      extend ActiveSupport::Concern
+
+      included do
+        after_commit :publish_payment_paid_event, on: :update, if: :should_publish_paid_event?
+      end
+
+      private
+
+      def should_publish_paid_event?
+        return false unless Spree::Events.enabled?
+        return false unless state_previously_changed?
+
+        state_previous_change&.last == 'completed'
+      end
+
+      def publish_payment_paid_event
+        publish_event('payment.paid')
+        publish_order_paid_event if order.paid?
+      end
+
+      def publish_order_paid_event
+        order.publish_event('order.paid')
+      end
+    end
+  end
+end

data/app/models/spree/payment.rb

@@ -15,6 +15,9 @@ module Spree
 
     include Spree::Payment::Processing
     include Spree::Payment::Webhooks
+    include Spree::Payment::CustomEvents
+
+    publishes_lifecycle_events
 
     NON_RISKY_AVS_CODES = ['B', 'D', 'H', 'J', 'M', 'Q', 'T', 'V', 'X', 'Y'].freeze
     RISKY_AVS_CODES     = ['A', 'C', 'E', 'F', 'G', 'I', 'K', 'L', 'N', 'O', 'P', 'R', 'S', 'U', 'W', 'Z'].freeze
@@ -114,11 +117,11 @@ module Spree
       event :complete do
         transition from: [:processing, :pending, :checkout], to: :completed
       end
-      after_transition to: :completed, do: [:after_completed, :send_payment_completed_webhook]
+      after_transition to: :completed, do: [:after_completed, :send_payment_completed_webhook, :publish_payment_completed_event]
       event :void do
         transition from: [:pending, :processing, :completed, :checkout], to: :void
       end
-      after_transition to: :void, do: [:after_void, :send_payment_voided_webhook]
+      after_transition to: :void, do: [:after_void, :send_payment_voided_webhook, :publish_payment_voided_event]
       # when the card brand isn't supported
       event :invalidate do
         transition from: [:checkout], to: :invalid
@@ -286,11 +289,17 @@ module Spree
     end
 
     def after_void
-      # Implement your logic here
     end
 
     def after_completed
-      # Implement your logic here
+    end
+
+    def publish_payment_completed_event
+      publish_event('payment.completed')
+    end
+
+    def publish_payment_voided_event
+      publish_event('payment.voided')
     end
 
     def has_invalid_state?

data/app/models/spree/payment_capture_event.rb

@@ -1,9 +1,5 @@
 module Spree
   class PaymentCaptureEvent < Spree.base_class
-    if defined?(Spree::Webhooks::HasWebhooks)
-      include Spree::Webhooks::HasWebhooks
-    end
-
     belongs_to :payment, class_name: 'Spree::Payment'
 
     def display_amount

data/app/models/spree/payment_method.rb

@@ -18,7 +18,7 @@ module Spree
     after_initialize :set_name, if: :new_record?
 
     validates :name, presence: true
-    auto_strip_attributes :name
+    normalizes :name, with: ->(value) { value&.to_s&.squish&.presence }
 
     has_many :store_payment_methods, class_name: 'Spree::StorePaymentMethod'
     has_many :stores, class_name: 'Spree::Store', through: :store_payment_methods

data/app/models/spree/permission_sets/default_customer.rb

@@ -26,9 +26,9 @@ module Spree
 
         # Content pages
         can :read, Spree::Policy
-        can :read, Spree::Page
-        can :read, Spree::Post
-        can :read, Spree::PostCategory
+        can :read, Spree::Page if defined?(Spree::Page)
+        can :read, Spree::Post if defined?(Spree::Post)
+        can :read, Spree::PostCategory if defined?(Spree::PostCategory)
 
         # Order management for the user's own orders
         can :create, Spree::Order

data/app/models/spree/policy.rb

@@ -2,7 +2,6 @@ module Spree
   class Policy < Spree.base_class
     extend FriendlyId
     include Spree::TranslatableResource
-    include Spree::Linkable
 
     UNIQUENESS_SCOPE = %i[owner_id owner_type].freeze
 
@@ -37,7 +36,7 @@ module Spree
     #
     # Scopes
     #
-    scope :with_body,    -> { joins(:rich_text_body).distinct }
+    scope :with_body, -> { joins(:rich_text_body).distinct }
     scope :without_body, -> { where.missing(:rich_text_body) }
     scope :with_matching_name, ->(name_to_match) do
       value = name_to_match.to_s.strip.downcase
@@ -62,12 +61,6 @@ module Spree
       store.policies.or(where.not(owner_type: 'Spree::Store'))
     end
 
-    def page_builder_url
-      return unless Spree::Core::Engine.routes.url_helpers.respond_to?(:policy_path)
-
-      Spree::Core::Engine.routes.url_helpers.policy_path(self)
-    end
-
     def with_body?
       body.present?
     end

data/app/models/spree/post.rb

@@ -1,10 +1,11 @@
 module Spree
   class Post < Spree.base_class
     include Spree::SingleStoreResource
-    include Spree::Linkable
     include Spree::Metafields
     extend FriendlyId
 
+    publishes_lifecycle_events
+
     friendly_id :slug_candidates, use: %i[slugged scoped history], scope: %i[store_id deleted?]
     acts_as_paranoid
     acts_as_taggable_on :tags
@@ -76,12 +77,6 @@ module Spree
       published_at.present?
     end
 
-    def page_builder_url
-      return unless Spree::Core::Engine.routes.url_helpers.respond_to?(:post_path)
-
-      Spree::Core::Engine.routes.url_helpers.post_path(self)
-    end
-
     def publish(date = nil)
       update(published_at: date || Time.current)
     end

data/app/models/spree/post_category.rb

@@ -4,6 +4,8 @@ module Spree
     include Spree::Metafields
     extend FriendlyId
 
+    publishes_lifecycle_events
+
     friendly_id :slug_candidates, use: %i[slugged scoped history], scope: %i[store_id]
 
     #

data/app/models/spree/price.rb

@@ -1,15 +1,15 @@
 module Spree
   class Price < Spree.base_class
     include Spree::VatPriceCalculation
-    if defined?(Spree::Webhooks::HasWebhooks)
-      include Spree::Webhooks::HasWebhooks
-    end
+
+    publishes_lifecycle_events
 
     acts_as_paranoid
 
     MAXIMUM_AMOUNT = BigDecimal('99_999_999.99')
 
     belongs_to :variant, -> { with_deleted }, class_name: 'Spree::Variant', inverse_of: :prices, touch: true
+    belongs_to :price_list, class_name: 'Spree::PriceList', optional: true
 
     before_validation :ensure_currency
     before_save :remove_compare_at_amount_if_equals_amount
@@ -20,11 +20,11 @@ module Spree
       less_than_or_equal_to: MAXIMUM_AMOUNT
     }, if: -> { Spree::Config.allow_empty_price_amount }
 
-    # new behavior
+    # new behavior - prices on a price_list can have nil amounts (placeholder prices)
     validates :amount, allow_nil: false, numericality: {
       greater_than_or_equal_to: 0,
       less_than_or_equal_to: MAXIMUM_AMOUNT
-    }, unless: -> { Spree::Config.allow_empty_price_amount }
+    }, unless: -> { Spree::Config.allow_empty_price_amount || price_list_id.present? }
 
     validates :compare_at_amount, allow_nil: true, numericality: {
       greater_than_or_equal_to: 0,
@@ -36,6 +36,8 @@ module Spree
     scope :with_currency, ->(currency) { where(currency: currency) }
     scope :non_zero, -> { where.not(amount: [nil, 0]) }
     scope :discounted, -> { where('compare_at_amount > amount') }
+    scope :base_prices, -> { where(price_list_id: nil) }
+    scope :for_price_list, ->(price_list) { where(price_list_id: price_list) }
     scope :for_products, ->(products, currency = nil) do
       currency ||= Spree::Store.default.default_currency
 
@@ -59,7 +61,7 @@ module Spree
     end
 
     def amount=(amount)
-      self[:amount] = Spree::LocalizedNumber.parse(amount)
+      self[:amount] = amount.blank? ? nil : Spree::LocalizedNumber.parse(amount)
     end
 
     def compare_at_money