spree_core 5.2.6 → 5.3.0.rc1

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Spree
+  class Shipment < Spree.base_class
+    # Publishes custom shipment events beyond basic lifecycle events.
+    #
+    # Events:
+    # - shipment.shipped: Shipment was shipped
+    # - order.shipped: All order shipments are shipped
+    # - shipment.canceled: Shipment was canceled
+    # - shipment.resumed: Shipment was resumed from canceled state
+    #
+    # NOTE: These methods are called from the state machine's after_transition callbacks
+    # defined in the Shipment model, not via ActiveRecord callbacks.
+    #
+    module CustomEvents
+      extend ActiveSupport::Concern
+
+      def publish_shipment_shipped_event
+        return unless Spree::Events.enabled?
+
+        publish_event('shipment.shipped')
+        # Force reload of shipments association to see the new state
+        order.shipments.reset
+        publish_order_shipped_event if order.fully_shipped?
+      end
+
+      def publish_shipment_canceled_event
+        return unless Spree::Events.enabled?
+
+        publish_event('shipment.canceled')
+      end
+
+      def publish_shipment_resumed_event
+        return unless Spree::Events.enabled?
+
+        publish_event('shipment.resumed')
+      end
+
+      private
+
+      def publish_order_shipped_event
+        order.publish_event('order.shipped')
+      end
+    end
+  end
+end

data/app/models/spree/shipment.rb

@@ -15,6 +15,9 @@ module Spree
     end
     include Spree::Shipment::Emails
     include Spree::Shipment::Webhooks
+    include Spree::Shipment::CustomEvents
+
+    publishes_lifecycle_events
 
     with_options inverse_of: :shipments do
       belongs_to :address, class_name: 'Spree::Address'
@@ -82,12 +85,12 @@ module Spree
       event :ship do
         transition from: %i(ready canceled), to: :shipped
       end
-      after_transition to: :shipped, do: [:after_ship, :send_shipment_shipped_webhook]
+      after_transition to: :shipped, do: [:after_ship, :send_shipment_shipped_webhook, :publish_shipment_shipped_event]
 
       event :cancel do
         transition to: :canceled, from: %i(pending ready)
       end
-      after_transition to: :canceled, do: :after_cancel
+      after_transition to: :canceled, do: [:after_cancel, :publish_shipment_canceled_event]
 
       event :resume do
         transition from: :canceled, to: :ready, if: lambda { |shipment|
@@ -95,7 +98,7 @@ module Spree
         }
         transition from: :canceled, to: :pending
       end
-      after_transition from: :canceled, to: %i(pending ready shipped), do: :after_resume
+      after_transition from: :canceled, to: %i(pending ready shipped), do: [:after_resume, :publish_shipment_resumed_event]
 
       after_transition do |shipment, transition|
         shipment.state_changes.create!(
@@ -112,7 +115,7 @@ module Spree
     money_methods :cost, :discounted_cost, :final_price, :item_cost, :additional_tax_total, :included_tax_total, :tax_total
     alias display_amount display_cost
 
-    auto_strip_attributes :tracking
+    normalizes :tracking, with: ->(value) { value&.to_s&.squish&.presence }
 
     # Returns the shipment number and shipping method name
     #
@@ -209,7 +212,8 @@ module Spree
     #
     # @return [Boolean]
     def with_free_shipping_promotion?
-      adjustments.promotion.includes(:source).any? { |p| p.source.respond_to?(:free_shipping?) && p.source.free_shipping? }
+      adjustments.promotion.joins("INNER JOIN #{Spree::PromotionAction.table_name} ON #{Spree::PromotionAction.table_name}.id = #{Spree::Adjustment.table_name}.source_id").
+        where("#{Spree::PromotionAction.table_name}.type = 'Spree::Promotion::Actions::FreeShipping'").exists?
     end
 
     def finalize!
@@ -454,6 +458,9 @@ module Spree
       ShipmentHandler.factory(self).perform
     end
 
+    # publish_shipment_shipped_event, publish_shipment_canceled_event, and
+    # publish_shipment_resumed_event are defined in Spree::Shipment::CustomEvents
+
     def can_get_rates?
       return true unless order.requires_ship_address?
 

data/app/models/spree/shipping_category.rb

@@ -3,9 +3,6 @@ module Spree
     DIGITAL_NAME = 'Digital'
 
     include Spree::UniqueName
-    if defined?(Spree::Webhooks::HasWebhooks)
-      include Spree::Webhooks::HasWebhooks
-    end
 
     with_options inverse_of: :shipping_category do
       has_many :products

data/app/models/spree/shipping_method.rb

@@ -5,9 +5,6 @@ module Spree
     include Spree::Metafields
     include Spree::Metadata
     include Spree::DisplayOn
-    if defined?(Spree::Webhooks::HasWebhooks)
-      include Spree::Webhooks::HasWebhooks
-    end
     if defined?(Spree::VendorConcern)
       include Spree::VendorConcern
     end

data/app/models/spree/stock/quantifier.rb

@@ -35,7 +35,7 @@ module Spree
       private
 
       def association_loaded?
-        variant.association(:stock_items).loaded? && variant.association(:stock_locations).loaded?
+        variant.association(:stock_items).loaded?
       end
 
       def scope_to_location(collection)

data/app/models/spree/stock_item.rb

@@ -6,6 +6,8 @@ module Spree
     include Spree::Metadata
     include Spree::StockItem::Webhooks
 
+    publishes_lifecycle_events
+
     with_options inverse_of: :stock_items do
       belongs_to :stock_location, class_name: 'Spree::StockLocation'
       belongs_to :variant, -> { with_deleted }, class_name: 'Spree::Variant'

data/app/models/spree/stock_location.rb

@@ -1,9 +1,6 @@
 module Spree
   class StockLocation < Spree.base_class
     include Spree::UniqueName
-    if defined?(Spree::Webhooks::HasWebhooks)
-      include Spree::Webhooks::HasWebhooks
-    end
     if defined?(Spree::Security::StockLocations)
       include Spree::Security::StockLocations
     end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Spree
+  class StockMovement < Spree.base_class
+    # Publishes custom stock events when stock levels change.
+    #
+    # Events:
+    # - product.out_of_stock: Product has no stock left for any variant
+    # - product.back_in_stock: Product was out of stock and now has stock again
+    #
+    module CustomEvents
+      extend ActiveSupport::Concern
+
+      included do
+        around_save :track_stock_changes_for_events
+      end
+
+      private
+
+      def track_stock_changes_for_events
+        return yield unless Spree::Events.enabled?
+
+        the_product = product
+        product_was_in_stock = the_product.any_variant_in_stock_or_backorderable?
+
+        yield
+
+        # Reload to get fresh stock data
+        the_product.reload
+        product_now_in_stock = the_product.any_variant_in_stock_or_backorderable?
+
+        if product_was_in_stock && !product_now_in_stock
+          the_product.publish_event('product.out_of_stock')
+        elsif !product_was_in_stock && product_now_in_stock
+          the_product.publish_event('product.back_in_stock')
+        end
+      end
+
+      def product
+        stock_item.variant.product
+      end
+    end
+  end
+end

data/app/models/spree/stock_movement.rb

@@ -6,6 +6,9 @@ module Spree
     }.freeze
 
     include Spree::StockMovement::Webhooks
+    include Spree::StockMovement::CustomEvents
+
+    publishes_lifecycle_events
 
     belongs_to :stock_item, class_name: 'Spree::StockItem', inverse_of: :stock_movements
     belongs_to :originator, polymorphic: true

data/app/models/spree/stock_transfer.rb

@@ -5,9 +5,8 @@ module Spree
     include Spree::NumberAsParam
     include Spree::Metafields
     include Spree::Metadata
-    if defined?(Spree::Webhooks::HasWebhooks)
-      include Spree::Webhooks::HasWebhooks
-    end
+
+    publishes_lifecycle_events
 
     has_many :stock_movements, as: :originator
     accepts_nested_attributes_for :stock_movements, reject_if: proc { |attributes|

data/app/models/spree/store.rb

@@ -12,10 +12,8 @@ module Spree
     include Spree::Metadata
     include Spree::Stores::Setup
     include Spree::Stores::Socials
-    include Spree::Webhooks::HasWebhooks if defined?(Spree::Webhooks::HasWebhooks)
     include Spree::Security::Stores if defined?(Spree::Security::Stores)
     include Spree::UserManagement
-    include Spree::HasPageLinks
 
     #
     # Magic methods
@@ -115,23 +113,10 @@ module Spree
 
     has_many :policies, class_name: 'Spree::Policy', dependent: :destroy, as: :owner
 
-    #
-    # Page Builder associations
-    #
-    has_many :themes, -> { without_previews }, class_name: 'Spree::Theme', dependent: :destroy, inverse_of: :store
-    has_many :theme_previews,
-             -> { only_previews },
-             class_name: 'Spree::Theme',
-             through: :themes,
-             source: :previews,
-             inverse_of: :store,
-             dependent: :destroy
-    has_one :default_theme, -> { without_previews.where(default: true) }, class_name: 'Spree::Theme', inverse_of: :store
-    alias theme default_theme
-    has_many :theme_pages, class_name: 'Spree::Page', through: :themes, source: :pages
-    has_many :theme_page_previews, class_name: 'Spree::Page', through: :theme_pages, source: :previews
-    has_many :pages, -> { without_previews.custom }, class_name: 'Spree::Pages::Custom', dependent: :destroy, as: :pageable
-    has_many :page_previews, class_name: 'Spree::Pages::Custom', through: :pages, as: :pageable, source: :previews
+    has_many :webhook_endpoints, class_name: 'Spree::WebhookEndpoint', dependent: :destroy, inverse_of: :store
+    has_many :webhook_deliveries, through: :webhook_endpoints, class_name: 'Spree::WebhookDelivery'
+
+    has_many :customer_groups, class_name: 'Spree::CustomerGroup', dependent: :destroy, inverse_of: :store
 
     #
     # ActionText
@@ -189,7 +174,6 @@ module Spree
     after_create :ensure_default_post_categories_are_created
     after_create :import_products_from_store, if: -> { import_products_from_store_id.present? }
     after_create :import_payment_methods_from_store, if: -> { import_payment_methods_from_store_id.present? }
-    after_create :create_default_theme
     after_create :create_default_policies
     before_destroy :validate_not_last, unless: :skip_validate_not_last
     before_destroy :pass_default_flag_to_other_store
@@ -347,12 +331,6 @@ module Spree
       end
     end
 
-    def checkout_zone_or_default
-      Spree::Deprecation.warn('Store#checkout_zone_or_default is deprecated and will be removed in Spree 5')
-
-      @checkout_zone_or_default ||= checkout_zone || Spree::Zone.default_checkout_zone
-    end
-
     def supported_shipping_zones
       @supported_shipping_zones ||= if checkout_zone.present?
                                       [checkout_zone]
@@ -373,7 +351,7 @@ module Spree
     end
 
     def admin_users
-      Spree::Deprecation.warn('Store#admin_users is deprecated and will be removed in Spree 6.0. Please use Store#users instead.')
+      Spree::Deprecation.warn('Store#admin_users is deprecated and will be removed in Spree 5.5. Please use Store#users instead.')
 
       users
     end
@@ -420,19 +398,12 @@ module Spree
 
     %w[customer_terms_of_service customer_privacy_policy customer_returns_policy customer_shipping_policy].each do |policy_method|
       define_method policy_method do
-        Spree::Deprecation.warn("Store##{policy_method} is deprecated and will be removed in Spree 6.0. Please use Store#policies instead.")
+        Spree::Deprecation.warn("Store##{policy_method} is deprecated and will be removed in Spree 5.5. Please use Store#policies instead.")
 
         ActionText::RichText.find_by(name: policy_method, record: self)
       end
     end
 
-    # Returns all active webhooks subscribers for the store
-    #
-    # @return [Array<Spree::Webhooks::Subscriber>]
-    def active_webhooks_subscribers
-      @active_webhooks_subscribers ||= Spree::Webhooks::Subscriber.active
-    end
-
     private
 
     def countries_available_for_checkout_cache_key
@@ -496,69 +467,77 @@ module Spree
     end
 
     def ensure_default_taxonomies_are_created
-      [
-        translate_with_store_locale_fallback('spree.taxonomy_categories_name'),
-        translate_with_store_locale_fallback('spree.taxonomy_brands_name'),
-        translate_with_store_locale_fallback('spree.taxonomy_collections_name')
-      ].each do |taxonomy_name|
-        # Manual exists?/create to work around Mobility bug with find_or_create_by
-        next if taxonomies.with_matching_name(taxonomy_name).exists?
-
-        taxonomies.create(name: taxonomy_name)
+      Spree::Events.disable do
+        [
+          translate_with_store_locale_fallback('spree.taxonomy_categories_name'),
+          translate_with_store_locale_fallback('spree.taxonomy_brands_name'),
+          translate_with_store_locale_fallback('spree.taxonomy_collections_name')
+        ].each do |taxonomy_name|
+          # Manual exists?/create to work around Mobility bug with find_or_create_by
+          next if taxonomies.with_matching_name(taxonomy_name).exists?
+
+          taxonomies.create(name: taxonomy_name)
+        end
       end
     end
 
     def ensure_default_automatic_taxons
-      # Use Mobility-safe lookup for taxonomy
-      collections_taxonomy = taxonomies.with_matching_name(translate_with_store_locale_fallback('spree.taxonomy_collections_name')).first
-      return unless collections_taxonomy.present?
-
-      automatic_taxons_config = [
-        { name: translate_with_store_locale_fallback('spree.automatic_taxon_names.on_sale'), rule_type: 'Spree::TaxonRules::Sale', rule_value: 'true' },
-        { name: translate_with_store_locale_fallback('spree.automatic_taxon_names.new_arrivals'), rule_type: 'Spree::TaxonRules::AvailableOn', rule_value: 30 }
-      ]
-
-      automatic_taxons_config.map do |config|
-        # Manual exists?/create to work around Mobility bug with first_or_create
-        taxon_scope = collections_taxonomy.taxons.automatic.with_matching_name(config[:name])
-
-        if taxon_scope.exists?
-          taxon_scope.first
-        else
-          collections_taxonomy.taxons.create!(
-            name: config[:name],
-            automatic: true,
-            parent: collections_taxonomy.root,
-            taxon_rules: [TaxonRule.new(type: config[:rule_type], value: config[:rule_value])]
-          )
+      Spree::Events.disable do
+        # Use Mobility-safe lookup for taxonomy
+        collections_taxonomy = taxonomies.with_matching_name(translate_with_store_locale_fallback('spree.taxonomy_collections_name')).first
+        return unless collections_taxonomy.present?
+
+        automatic_taxons_config = [
+          { name: translate_with_store_locale_fallback('spree.automatic_taxon_names.on_sale'), rule_type: 'Spree::TaxonRules::Sale', rule_value: 'true' },
+          { name: translate_with_store_locale_fallback('spree.automatic_taxon_names.new_arrivals'), rule_type: 'Spree::TaxonRules::AvailableOn', rule_value: 30 }
+        ]
+
+        automatic_taxons_config.map do |config|
+          # Manual exists?/create to work around Mobility bug with first_or_create
+          taxon_scope = collections_taxonomy.taxons.automatic.with_matching_name(config[:name])
+
+          if taxon_scope.exists?
+            taxon_scope.first
+          else
+            collections_taxonomy.taxons.create!(
+              name: config[:name],
+              automatic: true,
+              parent: collections_taxonomy.root,
+              taxon_rules: [TaxonRule.new(type: config[:rule_type], value: config[:rule_value])]
+            )
+          end
         end
       end
     end
 
     def ensure_default_post_categories_are_created
-      [
-        translate_with_store_locale_fallback('spree.default_post_categories.resources'),
-        translate_with_store_locale_fallback('spree.default_post_categories.articles'),
-        translate_with_store_locale_fallback('spree.default_post_categories.news')
-      ].each do |category_title|
-        # Use exists?/create pattern for safety
-        next if post_categories.where(title: category_title).exists?
-
-        post_categories.create(title: category_title)
+      Spree::Events.disable do
+        [
+          translate_with_store_locale_fallback('spree.default_post_categories.resources'),
+          translate_with_store_locale_fallback('spree.default_post_categories.articles'),
+          translate_with_store_locale_fallback('spree.default_post_categories.news')
+        ].each do |category_title|
+          # Use exists?/create pattern for safety
+          next if post_categories.where(title: category_title).exists?
+
+          post_categories.create(title: category_title)
+        end
       end
     end
 
     def create_default_policies
-      [
-        translate_with_store_locale_fallback('spree.terms_of_service'),
-        translate_with_store_locale_fallback('spree.privacy_policy'),
-        translate_with_store_locale_fallback('spree.returns_policy'),
-        translate_with_store_locale_fallback('spree.shipping_policy')
-      ].each do |policy_name|
-        # Manual exists?/create to work around Mobility bug with find_or_create_by
-        next if policies.with_matching_name(policy_name).exists?
-
-        policies.create(name: policy_name)
+      Spree::Events.disable do
+        [
+          translate_with_store_locale_fallback('spree.terms_of_service'),
+          translate_with_store_locale_fallback('spree.privacy_policy'),
+          translate_with_store_locale_fallback('spree.returns_policy'),
+          translate_with_store_locale_fallback('spree.shipping_policy')
+        ].each do |policy_name|
+          # Manual exists?/create to work around Mobility bug with find_or_create_by
+          next if policies.with_matching_name(policy_name).exists?
+
+          policies.create(name: policy_name)
+        end
       end
     end
 
@@ -605,12 +584,5 @@ module Spree
 
       self.url = [code, Spree.root_domain].join('.')
     end
-
-    def create_default_theme
-      themes.find_or_initialize_by(default: true) do |theme|
-        theme.name = Spree.t(:default_theme_name)
-        theme.save!
-      end
-    end
   end
 end

data/app/models/spree/store_credit.rb

@@ -3,9 +3,8 @@ module Spree
     include Spree::SingleStoreResource
     include Spree::Metafields
     include Spree::Metadata
-    if defined?(Spree::Webhooks::HasWebhooks)
-      include Spree::Webhooks::HasWebhooks
-    end
+
+    publishes_lifecycle_events
 
     acts_as_paranoid
 
@@ -186,7 +185,7 @@ module Spree
 
     class << self
       def default_created_by
-        Spree::Deprecation.warn('StoreCredit#default_created_by is deprecated and will be removed in Spree 6.0. Please use store.users.first instead.')
+        Spree::Deprecation.warn('StoreCredit#default_created_by is deprecated and will be removed in Spree 5.5. Please use store.users.first instead.')
 
         Spree::Store.current.users.first
       end

data/app/models/spree/store_product.rb

@@ -7,5 +7,19 @@ module Spree
 
     validates :store, :product, presence: true
     validates :store_id, uniqueness: { scope: :product_id }
+
+    def refresh_metrics!
+      completed_order_ids = product.completed_orders.where(store_id: store_id).select(:id)
+      variant_ids = product.variants_including_master.ids
+
+      line_items = Spree::LineItem.joins(:order)
+        .where(spree_orders: { id: completed_order_ids })
+        .where(variant_id: variant_ids)
+
+      update!(
+        units_sold_count: line_items.sum(:quantity),
+        revenue: line_items.sum(:pre_tax_amount)
+      )
+    end
   end
 end