spree_core 5.2.6 → 5.3.0.rc1

data/app/models/spree/event.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Spree
+  # Represents an event in the Spree event system.
+  #
+  # Events are immutable objects that carry information about something
+  # that happened in the system. They contain:
+  # - An id (UUID)
+  # - A name (e.g., 'order.complete', 'product.create')
+  # - A store_id (the store where the event originated)
+  # - A payload (serialized data about the event)
+  # - Metadata (contextual information like spree_version)
+  #
+  # @example Creating an event
+  #   event = Spree::Event.new(
+  #     name: 'order.complete',
+  #     payload: order.serializable_hash
+  #   )
+  #
+  # @example Accessing event data
+  #   event.id         # => "550e8400-e29b-41d4-a716-446655440000"
+  #   event.name       # => 'order.complete'
+  #   event.store_id   # => 1
+  #   event.payload    # => { 'id' => 1, 'number' => 'R123456' }
+  #   event.created_at # => 2024-01-15 10:30:00 UTC
+  #
+  class Event
+    include ActiveModel::Model
+    include ActiveModel::Attributes
+    include ActiveModel::Serializers::JSON
+
+    attribute :id, :string, default: -> { SecureRandom.uuid }
+    attribute :name, :string
+    attribute :store_id, :integer, default: -> { Spree::Current.store&.id }
+    attribute :payload, default: -> { {}.freeze }
+    attribute :metadata, default: -> { { 'spree_version' => Spree.version }.freeze }
+    attribute :created_at, :datetime, default: -> { Time.current }
+
+    validates :name, presence: true
+    validates :store_id, presence: true
+
+    def name=(value)
+      super(value.to_s.freeze) if value
+    end
+
+    def payload=(value)
+      super((value || {}).deep_stringify_keys.freeze)
+    end
+
+    def metadata=(value)
+      base = { 'spree_version' => Spree.version }
+      super(base.merge((value || {}).deep_stringify_keys).freeze)
+    end
+
+    # Returns the store where the event originated
+    # @return [Spree::Store, nil]
+    def store
+      return nil if store_id.blank?
+
+      @store ||= Spree::Store.find_by(id: store_id)
+    end
+
+    # Returns the resource type from the event name
+    # @return [String] The resource type (e.g., 'order' from 'order.complete')
+    def resource_type
+      @resource_type ||= name.to_s.split('.').first
+    end
+
+    # Returns the action from the event name
+    # @return [String] The action (e.g., 'complete' from 'order.complete')
+    def action
+      @action ||= name.to_s.split('.').drop(1).join('.')
+    end
+
+    # Checks if the event matches a pattern
+    # Supports wildcards: 'order.*' matches 'order.complete', 'order.cancel'
+    # @param pattern [String] The pattern to match against
+    # @return [Boolean]
+    def matches?(pattern)
+      self.class.matches?(name, pattern)
+    end
+
+    # Class method to check if an event name matches a pattern
+    # @param event_name [String] The event name
+    # @param pattern [String] The pattern (supports * wildcard)
+    # @return [Boolean]
+    def self.matches?(event_name, pattern)
+      return true if pattern == '*'
+
+      if pattern.include?('*')
+        regex = Regexp.new("^#{Regexp.escape(pattern).gsub('\*', '.*')}$")
+        event_name.match?(regex)
+      else
+        event_name == pattern
+      end
+    end
+
+    alias_method :to_h, :attributes
+
+    def inspect
+      "#<Spree::Event id=#{id.inspect} name=#{name.inspect} store_id=#{store_id.inspect} created_at=#{created_at&.iso8601}>"
+    end
+  end
+end

data/app/models/spree/export.rb

@@ -11,6 +11,12 @@ module Spree
 
     include Spree::Core::NumberGenerator.new(prefix: 'EF')
 
+    publishes_lifecycle_events
+
+    # Set event prefix for all Export subclasses
+    # This ensures Spree::Exports::Products publishes 'export.create' not 'products.create'
+    self.event_prefix = 'export'
+
     #
     # Associations
     #
@@ -44,7 +50,7 @@ module Spree
     before_validation :set_default_format, on: :create
     before_validation :normalize_search_params, on: :create, if: -> { search_params.present? }
     before_create :clear_search_params, if: -> { record_selection == 'all' }
-    after_commit :generate_async, on: :create
+    # NOTE: generate_async is now handled by Spree::ExportSubscriber listening to 'export.create' event
 
     #
     # Virtual attributes

data/app/models/spree/gift_card.rb

@@ -5,6 +5,8 @@ module Spree
     include Spree::Metafields
     include Spree::Security::GiftCards if defined?(Spree::Security::GiftCards)
 
+    publishes_lifecycle_events
+
     #
     # State machine
     #
@@ -18,11 +20,13 @@ module Spree
         transition partially_redeemed: :redeemed
       end
       after_transition to: :redeemed, do: :after_redeem
+      after_transition to: :redeemed, do: :publish_gift_card_redeemed_event
 
       event :partial_redeem do
         transition active: :partially_redeemed
         transition partially_redeemed: :partially_redeemed
       end
+      after_transition to: :partially_redeemed, do: :publish_gift_card_partially_redeemed_event
     end
 
     #
@@ -60,7 +64,7 @@ module Spree
     self.whitelisted_ransackable_associations = %w[users orders batch]
     self.whitelisted_ransackable_scopes = %w[active expired redeemed partially_redeemed]
 
-    auto_strip_attributes :code
+    normalizes :code, with: ->(value) { value&.to_s&.squish&.presence }
 
     #
     # Callbacks
@@ -156,6 +160,14 @@ module Spree
       update!(redeemed_at: Time.current)
     end
 
+    def publish_gift_card_redeemed_event
+      publish_event('gift_card.redeemed')
+    end
+
+    def publish_gift_card_partially_redeemed_event
+      publish_event('gift_card.partially_redeemed')
+    end
+
     def ensure_can_be_deleted
       return if can_be_deleted?
 

data/app/models/spree/gift_card_batch.rb

@@ -3,6 +3,8 @@ module Spree
     extend DisplayMoney
     include Spree::SingleStoreResource
 
+    publishes_lifecycle_events
+
     #
     # Associations
     #
@@ -24,7 +26,7 @@ module Spree
     before_validation :set_currency
     after_create :generate_gift_cards
 
-    auto_strip_attributes :prefix
+    normalizes :prefix, with: ->(value) { value&.to_s&.squish&.presence }
 
     money_methods :amount
 

data/app/models/spree/image.rb

@@ -6,6 +6,9 @@ module Spree
 
     after_commit :touch_product_variants, if: :should_touch_product_variants?, on: :update
 
+    after_create :increment_viewable_image_count
+    after_destroy :decrement_viewable_image_count
+
     # In Rails 5.x class constants are being undefined/redefined during the code reloading process
     # in a rails development environment, after which the actual ruby objects stored in those class constants
     # are no longer equal (subclass == self) what causes error ActiveRecord::SubclassNotFound
@@ -62,12 +65,24 @@ module Spree
     end
 
     def should_touch_product_variants?
-      return false unless viewable.is_a?(Spree::Variant)
-      return false unless viewable.is_master?
-      return false unless viewable.product.has_variants?
-      return false unless saved_change_to_position?
+      viewable.is_a?(Spree::Variant) &&
+        viewable.is_master? &&
+        viewable.product.has_variants? &&
+        saved_change_to_position?
+    end
+
+    def increment_viewable_image_count
+      return unless viewable.is_a?(Spree::Variant)
+
+      Spree::Variant.increment_counter(:image_count, viewable_id)
+      Spree::Product.increment_counter(:total_image_count, viewable.product_id)
+    end
+
+    def decrement_viewable_image_count
+      return unless viewable.is_a?(Spree::Variant)
 
-      true
+      Spree::Variant.decrement_counter(:image_count, viewable_id)
+      Spree::Product.decrement_counter(:total_image_count, viewable.product_id)
     end
   end
 end

data/app/models/spree/import.rb

@@ -7,6 +7,12 @@ module Spree
 
     include Spree::Core::NumberGenerator.new(prefix: 'IM')
 
+    publishes_lifecycle_events
+
+    # Set event prefix for all Import subclasses
+    # This ensures Spree::Imports::Products publishes 'import.create' not 'products.create'
+    self.event_prefix = 'import'
+
     #
     # Associations
     #
@@ -56,8 +62,9 @@ module Spree
       event :complete do
         transition from: :processing, to: :completed
       end
-      after_transition to: :completed, do: :send_import_completed_email
-      after_transition to: :completed, do: :update_loader_in_import_view
+      after_transition to: :completed, do: :publish_import_completed_event
+      # NOTE: send_import_completed_email and update_loader_in_import_view
+      # are now handled by Spree::Admin::ImportSubscriber listening to 'import.completed' event
 
       event :fail do
         transition to: :failed
@@ -159,8 +166,8 @@ module Spree
       "#{Spree.t(type.demodulize.pluralize.downcase)} #{number}"
     end
 
-    def send_import_completed_email
-      # Spree::ImportMailer.import_done(self).deliver_later
+    def publish_import_completed_event
+      publish_event('import.completed')
     end
 
     # Returns the headers of the csv file
@@ -205,13 +212,11 @@ module Spree
     # Returns the store for the import
     # @return [Spree::Store]
     def store
-      owner.is_a?(Spree::Store) ? owner : owner.respond_to?(:store) ? owner.store : Spree::Store.default
-    end
-
-    def update_loader_in_import_view
-      return unless defined?(broadcast_update_to)
-
-      broadcast_update_to "import_#{id}_loader", target: 'loader', partial: 'spree/admin/imports/loader', locals: { import: self }
+      if owner.is_a?(Spree::Store)
+        owner
+      else
+        owner.respond_to?(:store) ? owner.store : Spree::Store.default
+      end
     end
 
     # Returns the current ability for the import
@@ -243,7 +248,7 @@ module Spree
       def model_class
         klass = "Spree::#{to_s.demodulize.singularize}".safe_constantize
 
-        raise NameError, "Missing model class for #{to_s}" unless klass
+        raise NameError, "Missing model class for #{self}" unless klass
 
         klass
       end

data/app/models/spree/import_row.rb

@@ -1,5 +1,8 @@
 module Spree
   class ImportRow < Spree.base_class
+    # Set event prefix for ImportRow
+    self.event_prefix = 'import_row'
+
     #
     # Associations
     #
@@ -24,15 +27,16 @@ module Spree
       event :fail do
         transition to: :failed
       end
-      after_transition to: :failed, do: :add_row_to_import_view
-      after_transition to: :failed, do: :update_footer_in_import_view
+      after_transition to: :failed, do: :publish_import_row_failed_event
+      # NOTE: add_row_to_import_view and update_footer_in_import_view
+      # are now handled by Spree::Admin::ImportRowSubscriber
 
       event :complete do
         transition to: :completed
       end
-
-      after_transition to: :completed, do: :add_row_to_import_view
-      after_transition to: :completed, do: :update_footer_in_import_view
+      after_transition to: :completed, do: :publish_import_row_completed_event
+      # NOTE: add_row_to_import_view and update_footer_in_import_view
+      # are now handled by Spree::Admin::ImportRowSubscriber
     end
 
     #
@@ -81,29 +85,12 @@ module Spree
       fail!
     end
 
-    def add_row_to_import_view
-      return unless defined?(broadcast_append_to)
-
-      # we need to render this partial with store context to properly generate image URLs
-      with_store_context do
-        broadcast_append_to "import_#{import.id}_rows", target: 'rows', partial: 'spree/admin/imports/row', locals: { row: self, import: import }
-      end
-    end
-
-    def update_footer_in_import_view
-      return unless defined?(broadcast_replace_to)
-
-      broadcast_replace_to "import_#{import_id}_footer", target: 'footer', partial: 'spree/admin/imports/footer', locals: { import: import }
+    def publish_import_row_completed_event
+      publish_event('import_row.completed')
     end
 
-    private
-
-    def with_store_context
-      Spree::Current.store = store
-      Rails.application.routes.default_url_options[:host] = store.url_or_custom_domain
-      yield
-    ensure
-      Spree::Current.reset if defined?(Spree::Current)
+    def publish_import_row_failed_event
+      publish_event('import_row.failed')
     end
   end
 end

data/app/models/spree/inventory_unit.rb

@@ -1,9 +1,6 @@
 module Spree
   class InventoryUnit < Spree.base_class
     extend Spree::DisplayMoney
-    if defined?(Spree::Webhooks::HasWebhooks)
-      include Spree::Webhooks::HasWebhooks
-    end
 
     with_options inverse_of: :inventory_units do
       belongs_to :variant, -> { with_deleted }, class_name: 'Spree::Variant'

data/app/models/spree/invitation.rb

@@ -46,6 +46,7 @@ module Spree
         transition pending: :accepted
       end
       after_transition to: :accepted, do: :after_accept
+      after_transition to: :accepted, do: :publish_invitation_accepted_event
     end
 
     #
@@ -53,7 +54,7 @@ module Spree
     #
     after_initialize :set_defaults, if: :new_record?
     before_validation :set_invitee_from_email, on: :create
-    after_create :send_invitation_email, unless: :skip_email
+    after_create :publish_invitation_created_event, unless: :skip_email
 
     # returns the store for the invitation
     # if the resource is a store, return the resource
@@ -80,7 +81,7 @@ module Spree
     def resend!
       return if expired? || deleted? || accepted?
 
-      send_invitation_email
+      publish_event('invitation.resent')
     end
 
     private
@@ -89,15 +90,20 @@ module Spree
     def after_accept
       create_role_user
       set_accepted_at
-      send_acceptance_notification
     end
 
-    def send_invitation_email
-      Spree::InvitationMailer.invitation_email(self).deliver_later
+    def publish_invitation_accepted_event
+      publish_event('invitation.accepted')
     end
 
+    def publish_invitation_created_event
+      publish_event('invitation.created')
+    end
+
+    # This method is kept for backwards compatibility.
+    # Email sending is now handled by the InvitationEmailSubscriber via the 'invitation.accept' event.
     def send_acceptance_notification
-      Spree::InvitationMailer.invitation_accepted(self).deliver_later
+      # no-op - email is sent via event subscriber
     end
 
     def set_defaults

data/app/models/spree/line_item.rb

@@ -2,9 +2,8 @@ module Spree
   class LineItem < Spree.base_class
     include Spree::Metafields
     include Spree::Metadata
-    if defined?(Spree::Webhooks::HasWebhooks)
-      include Spree::Webhooks::HasWebhooks
-    end
+
+    publishes_lifecycle_events
 
     attribute :quantity, :integer, default: 1
 
@@ -15,6 +14,7 @@ module Spree
       belongs_to :variant, -> { with_deleted }, class_name: 'Spree::Variant'
     end
     belongs_to :tax_category, -> { with_deleted }, class_name: 'Spree::TaxCategory'
+    belongs_to :price_list, class_name: 'Spree::PriceList', optional: true
 
     has_one :product, -> { with_deleted }, class_name: 'Spree::Product', through: :variant
 
@@ -72,9 +72,11 @@ module Spree
     end
 
     def update_price
-      currency_price = variant.price_in(order.currency)
+      context = Spree::Pricing::Context.from_order(variant, order, quantity: quantity)
+      currency_price = variant.price_for(context)
 
       self.price = currency_price.price_including_vat_for(tax_zone: tax_zone) if currency_price.present?
+      self.price_list_id = currency_price.price_list_id if currency_price.present?
     end
 
     def copy_tax_category
@@ -95,16 +97,25 @@ module Spree
       price - (promo_total.abs / quantity)
     end
 
+    # Returns the amount (price * quantity) of the line item
+    #
+    # @return [BigDecimal]
     def amount
       price * quantity
     end
 
+    # Returns the compare at amount (compare at price * quantity) of the line item
+    #
+    # @return [BigDecimal]
     def compare_at_amount
       (variant.compare_at_amount_in(currency) || 0) * quantity
     end
 
     alias subtotal amount
 
+    # Returns the taxable amount (amount + taxable adjustment total) of the line item
+    #
+    # @return [BigDecimal]
     def taxable_amount
       amount + taxable_adjustment_total
     end
@@ -119,6 +130,9 @@ module Spree
     alias discounted_money display_discounted_amount
     alias discounted_amount taxable_amount
 
+    # Returns the final amount of the line item
+    #
+    # @return [BigDecimal]
     def final_amount
       amount + adjustment_total
     end
@@ -133,10 +147,16 @@ module Spree
     alias total final_amount
     alias money display_total
 
+    # Returns true if the line item has sufficient stock
+    #
+    # @return [Boolean]
     def sufficient_stock?
       can_supply? quantity
     end
 
+    # Returns true if the line item has insufficient stock
+    #
+    # @return [Boolean]
     def insufficient_stock?
       !sufficient_stock?
     end
@@ -200,10 +220,34 @@ module Spree
       @maximum_quantity ||= variant.backorderable? ? Spree::DatabaseTypeUtilities.maximum_value_for(:integer) : variant.total_on_hand
     end
 
+    # Returns true if the line item variant has digital assets
+    #
+    # @return [Boolean]
     def with_digital_assets?
       variant.with_digital_assets?
     end
 
+    # Recalculates and persists the price based on the current quantity and pricing context
+    # This is used for volume-based pricing and other price list rules
+    # @return [void]
+    def recalculate_price
+      context = Spree::Pricing::Context.from_order(variant, order, quantity: quantity)
+      currency_price = variant.price_for(context)
+
+      return unless currency_price.present?
+
+      new_price = currency_price.price_including_vat_for(tax_zone: tax_zone)
+
+      return unless new_price.present?
+
+      new_price_list_id = currency_price.price_list_id
+
+      # Only update if price or price list changed
+      if new_price != price || new_price_list_id != price_list_id
+        update_columns(price: new_price, price_list_id: new_price_list_id, updated_at: Time.current)
+      end
+    end
+
     private
 
     def ensure_valid_quantity
@@ -239,11 +283,20 @@ module Spree
 
     def update_adjustments
       if saved_change_to_quantity?
+        recalculate_price if should_update_price? && !previously_new_record?
         recalculate_adjustments
         update_tax_charge # Called to ensure pre_tax_amount is updated.
       end
     end
 
+    # Returns true if the price should be updated when quantity changes
+    # Override this method to customize when prices should be recalculated
+    # By default, prices are not updated after an order is completed
+    # @return [Boolean]
+    def should_update_price?
+      !order.completed?
+    end
+
     def recalculate_adjustments
       Spree::Adjustable::AdjustmentsUpdater.update(self)
     end

data/app/models/spree/newsletter_subscriber.rb

@@ -5,6 +5,8 @@ module Spree
     include Spree::NewsletterSubscriber::Emails
     include Spree::Metafields
 
+    publishes_lifecycle_events
+
     has_secure_token :verification_token
 
     #

data/app/models/spree/option_type.rb

@@ -7,15 +7,12 @@ module Spree
     include Spree::Metafields
     include Spree::Metadata
     include Spree::TranslatableResource
-    if defined?(Spree::Webhooks::HasWebhooks)
-      include Spree::Webhooks::HasWebhooks
-    end
 
     TRANSLATABLE_FIELDS = %i[presentation].freeze
     translates(*TRANSLATABLE_FIELDS, column_fallback: !Spree.always_use_translations?)
 
     self::Translation.class_eval do
-      auto_strip_attributes :presentation
+      normalizes :presentation, with: ->(value) { value&.to_s&.squish&.presence }
     end
 
     #
@@ -62,7 +59,7 @@ module Spree
 
     # legacy, name itself is now parameterized before saving
     def filter_param
-      Spree::Deprecation.warn('Spree::OptionType#filter_param is deprecated and will be removed in Spree 6. Please use Spree::OptionType#name instead.')
+      Spree::Deprecation.warn('Spree::OptionType#filter_param is deprecated and will be removed in Spree 5.5. Please use Spree::OptionType#name instead.')
       name.parameterize
     end
 

data/app/models/spree/option_value.rb

@@ -4,15 +4,12 @@ module Spree
     include Spree::Metafields
     include Spree::Metadata
     include Spree::TranslatableResource
-    if defined?(Spree::Webhooks::HasWebhooks)
-      include Spree::Webhooks::HasWebhooks
-    end
 
     TRANSLATABLE_FIELDS = %i[presentation].freeze
     translates(*TRANSLATABLE_FIELDS, column_fallback: !Spree.always_use_translations?)
 
     self::Translation.class_eval do
-      auto_strip_attributes :presentation
+      normalizes :presentation, with: ->(value) { value&.to_s&.squish&.presence }
     end
 
     #

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

@@ -118,11 +118,12 @@ module Spree
               before_transition to: :resumed, do: proc { |order| order.state_machine_resumed = true }
 
               after_transition to: :complete, do: :finalize!
-              after_transition to: :complete, do: :use_all_coupon_codes
-              after_transition to: :complete, do: :redeem_gift_card
               after_transition to: :resumed, do: :after_resume
               after_transition to: :canceled, do: :after_cancel
+              after_transition to: :complete, do: :use_all_coupon_codes
+              after_transition to: :complete, do: :redeem_gift_card
               after_transition to: :complete, do: :subscribe_to_newsletter
+              after_transition to: :complete, do: :publish_order_completed_event
 
               after_transition from: any - :cart, to: any - [:confirm, :complete] do |order|
                 order.update_totals
@@ -133,6 +134,10 @@ module Spree
             alias_method :save_state, :save
           end
 
+          def publish_order_completed_event
+            publish_event('order.completed')
+          end
+
           def subscribe_to_newsletter
             return unless accept_marketing?
 

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

@@ -4,10 +4,7 @@ module Spree
       extend ActiveSupport::Concern
 
       def deliver_order_confirmation_email
-        # you can overwrite this method in your application / extension to send out the confirmation email
-        # or use `spree_emails` gem
-        # YourEmailVendor.deliver_order_confirmation_email(id) # `id` = ID of the Order being sent, you can also pass the entire Order object using `self`
-        # update_column(:confirmation_delivered, true) # if you would like to mark that the email was sent
+        Spree::Deprecation.warn('Spree::Order#deliver_order_confirmation_email is deprecated and will be removed in Spree 5.5. Please create a Subscriber for order.completed event.')
       end
 
       # If you would like to also send confirmation email to store owner(s)
@@ -16,16 +13,11 @@ module Spree
       end
 
       def deliver_store_owner_order_notification_email
-        # you can overwrite this method in your application / extension to send out the confirmation email
-        # or use `spree_emails` gem
-        # YourEmailVendor.deliver_store_owner_notification_email(id) # `id` = ID of the Order being sent, you can also pass the entire Order object using `self`
-        # update_column(:store_owner_notification_delivered, true) # if you would like to mark that the email was sent
+        Spree::Deprecation.warn('Spree::Order#deliver_store_owner_order_notification_email is deprecated and will be removed in Spree 5.5. Please create a Subscriber for order.completed event.')
       end
 
       def send_cancel_email
-        # you can overwrite this method in your application / extension to send out the confirmation email
-        # or use `spree_emails` gem
-        # YourEmailVendor.deliver_cancel_email(id) # `id` = ID of the Order being sent, you can also pass the entire Order object using `self`
+        Spree::Deprecation.warn('Spree::Order#send_cancel_email is deprecated and will be removed in Spree 5.5. Please create a Subscriber for order.canceled event.')
       end
     end
   end