spree_core 5.3.4 → 5.4.0.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b1ea480e8607e801d3c45d8decf522c829003eb3fa6c1f8f92b9185a4bfefec
-  data.tar.gz: 552fb0686b6da4a560dd47144d52079d1ab73c270a9e4c9093e62b9e556ef74f
+  metadata.gz: 6991203c2954ac7663c4dfadd8362bee850faf1a1888166cd9c7ed0100167398
+  data.tar.gz: ec6feab9591d268f2a6f3efd7d5a1557e383e600fb32088c3e09e03abd937ba1
 SHA512:
-  metadata.gz: 1ed2cab50fb7c122df6565b931324ea7ba307c8580a98ac8f9e2e400140df75092ed417db47311a6d3ec01985a6696cfbce1d3e3fa7917c329646b13ef51b095
-  data.tar.gz: 34bd9929ed9e4a962696b2be41a5bb0da2c330fd12d1cbff89e34fa78cdceaa84d6b58cb7ae321d1868864c2888eccd752cd0bef7dbd9cd473aa68490619c2f6
+  metadata.gz: 2a58de3390d7466d547af3ff46f6d661776e6b4c9790d02da9d7d90c0b96883647dcea51fb27f75110e1083c8e9dc7075b6bbee49499bfd189ce39bb7235362d
+  data.tar.gz: 37fcc6d23c1e9ebf36314be3b85aea5c612eb7eb75a5fa0c2bd10f4c18ff1877298554f45fa80f8d6b841670e5004c1d953df068bebc2a45b59c4495edc10c2e

data/app/finders/spree/orders/find_complete.rb

@@ -3,11 +3,13 @@ module Spree
     class FindComplete
       include Spree::Orders::FinderHelper
 
-      attr_reader :user, :number, :token, :store, :email
+      attr_reader :user, :number, :prefix_id, :param, :token, :store, :email
 
-      def initialize(user: nil, number: nil, token: nil, store: nil, email: nil)
+      def initialize(user: nil, number: nil, prefix_id: nil, param: nil, token: nil, store: nil, email: nil)
         @user = user
         @number = number
+        @prefix_id = prefix_id
+        @param = param
         @token = token
         @store = store
         @email = email
@@ -16,6 +18,8 @@ module Spree
       def execute
         orders = by_user(scope)
         orders = by_number(orders)
+        orders = by_prefix_id(orders)
+        orders = by_param(orders)
         orders = by_token(orders)
         orders = by_store(orders)
         orders = by_email(orders)
@@ -37,6 +41,14 @@ module Spree
         number.present?
       end
 
+      def prefix_id?
+        prefix_id.present?
+      end
+
+      def param?
+        param.present?
+      end
+
       def token?
         token.present?
       end
@@ -61,6 +73,25 @@ module Spree
         orders.where(number: number)
       end
 
+      def by_prefix_id(orders)
+        return orders unless prefix_id?
+
+        decoded = Spree::Order.decode_prefixed_id(prefix_id)
+        orders.where(id: decoded)
+      end
+
+      # Find by param - tries prefixed ID first, then number for backwards compatibility
+      def by_param(orders)
+        return orders unless param?
+
+        decoded = Spree::Order.decode_prefixed_id(param)
+        if decoded
+          orders.where(id: decoded)
+        else
+          orders.where(number: param)
+        end
+      end
+
       def by_token(orders)
         return orders unless token?
 

data/app/finders/spree/stores/find_default.rb

@@ -0,0 +1,17 @@
+module Spree
+  module Stores
+    class FindDefault
+      def initialize(scope: nil, url: nil)
+        @scope = scope || Spree::Store
+      end
+
+      def execute
+        store = @scope.where(default: true).first || @scope.first
+        return if store.nil?
+
+        Spree::Current.store = store
+        store
+      end
+    end
+  end
+end

data/app/finders/spree/variants/visible_finder.rb

@@ -2,6 +2,7 @@ module Spree
   module Variants
     class VisibleFinder
       def initialize(scope:, current_currency:)
+        Spree::Deprecation.warn('Spree::Variants::VisibleFinder is deprecated and will be removed in Spree 5.5.')
         @scope = scope
         @current_currency = current_currency
       end

data/app/helpers/spree/addresses_helper.rb

@@ -4,8 +4,7 @@ module Spree
     def address_form_countries_states_cache_key
       @address_form_countries_states_cache_key ||= [
         I18n.locale,
-        current_store.cache_key_with_version,
-        current_store.checkout_zone&.cache_key_with_version
+        current_store.cache_key_with_version
       ].compact
     end
 

data/app/helpers/spree/base_helper.rb

@@ -134,10 +134,10 @@ module Spree
 
       base_url = if options[:relative]
                    ''
-                 elsif store.formatted_custom_domain.blank?
-                   store.formatted_url
-                 else
+                 elsif store.respond_to?(:formatted_custom_domain) && store.formatted_custom_domain.present?
                    store.formatted_custom_domain
+                 else
+                   store.formatted_url
                  end
 
       localize = if options[:locale].present?
@@ -204,7 +204,8 @@ module Spree
     end
 
     def maximum_quantity
-      Spree::DatabaseTypeUtilities.maximum_value_for(:integer)
+      Spree::Deprecation.warn('BaseHelper#maximum_quantity is deprecated and will be removed in Spree 5.5')
+      Spree::DatabaseTypeUtilities::INTEGER_MAX
     end
 
     def payment_method_icon_tag(payment_method, opts = {})

data/app/jobs/spree/api_key_touch_job.rb

@@ -0,0 +1,9 @@
+module Spree
+  class ApiKeyTouchJob < Spree::BaseJob
+    queue_as Spree.queues.api_keys
+
+    def perform(api_key_id)
+      Spree::ApiKey.find_by(id: api_key_id)&.touch(:last_used_at)
+    end
+  end
+end

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

@@ -2,8 +2,19 @@ module Spree
   module AdminUserMethods
     extend ActiveSupport::Concern
 
+    include Spree::PrefixedId
+    include Spree::UserRoles
+    include Spree::RansackableAttributes
+
     included do
+      has_prefix_id :admin
+
+      has_person_name
+
+      normalizes :email, :first_name, :last_name, with: ->(value) { value&.to_s&.squish&.presence }
+
       # Associations
+      has_many :identities, class_name: 'Spree::UserIdentity', as: :user, dependent: :destroy
       has_many :canceled_orders, class_name: 'Spree::Order', foreign_key: :canceler_id
       has_many :created_orders, class_name: 'Spree::Order', foreign_key: :created_by_id
       has_many :approved_orders, class_name: 'Spree::Order', foreign_key: :approver_id
@@ -19,6 +30,27 @@ module Spree
       # Callbacks
       after_destroy :nullify_approver_id_in_approved_orders
       after_destroy :cleanup_admin_user_resources
+
+      # Attachments
+      has_one_attached :avatar, service: Spree.public_storage_service_name
+
+      #
+      # Attributes
+      #
+      attr_accessor :confirm_email
+
+      self.whitelisted_ransackable_associations = %w[spree_roles]
+      self.whitelisted_ransackable_attributes = %w[id email first_name last_name]
+    end
+
+    def can_be_deleted?
+      Spree::Store.current.users.where.not(id: id).exists?
+    end
+
+    # Returns the full name of the user
+    # @return [String]
+    def full_name
+      name&.full
     end
 
     private

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

@@ -3,9 +3,11 @@ module Spree
     extend ActiveSupport::Concern
 
     included do
-      extend FriendlyId
-
-      friendly_id :number
+      Spree::Deprecation.warn(
+        'Spree::NumberAsParam is deprecated and will be removed in Spree 6.0. ' \
+        'Models now use Spree::PrefixedId with Sqids-based prefixed_id method instead. ' \
+        'This concern no longer provides any functionality and can be safely removed.'
+      )
     end
   end
 end

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

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'sqids'
+
+module Spree
+  # Adds Stripe-style prefixed IDs to Spree models using Sqids encoding.
+  # IDs are computed on the fly from integer primary keys -- no database column needed.
+  #
+  # e.g., Product with id=12345 -> "prod_86Rf07xd4z"
+  #
+  #   class Product < Spree.base_class
+  #     has_prefix_id :prod
+  #   end
+  module PrefixedId
+    extend ActiveSupport::Concern
+
+    SQIDS = Sqids.new(min_length: 10)
+
+    included do
+      class_attribute :_prefix_id_prefix, instance_writer: false
+    end
+
+    # Returns the Stripe-style prefixed ID, or nil for unsaved records.
+    def prefixed_id
+      return nil unless id.present?
+
+      "#{self.class._prefix_id_prefix}_#{Spree::PrefixedId::SQIDS.encode([id])}"
+    end
+
+    # Use prefixed_id for URL params when available.
+    # Skip if FriendlyId is used (it has its own to_param using slug).
+    def to_param
+      return super if self.class.respond_to?(:friendly_id_config)
+      return super unless self.class._prefix_id_prefix.present?
+
+      prefixed_id.presence || super
+    end
+
+    class_methods do
+      def has_prefix_id(prefix)
+        self._prefix_id_prefix = prefix.to_s
+      end
+
+      def find_by_prefix_id!(prefixed_id)
+        decoded = decode_prefixed_id(prefixed_id)
+        raise ActiveRecord::RecordNotFound.new("Couldn't find #{name} with prefixed id=#{prefixed_id}", name) unless decoded
+
+        find(decoded)
+      end
+
+      def find_by_prefix_id(prefixed_id)
+        decoded = decode_prefixed_id(prefixed_id)
+        return nil unless decoded
+
+        find_by(id: decoded)
+      end
+
+      # Decode a prefixed ID string (e.g., "prod_86Rf07xd4z") to the integer primary key.
+      def decode_prefixed_id(prefixed_id_string)
+        return nil if prefixed_id_string.blank?
+
+        parts = prefixed_id_string.to_s.split('_', 2)
+        return nil if parts.length != 2
+
+        _prefix, encoded = parts
+        ids = Spree::PrefixedId::SQIDS.decode(encoded)
+        ids.first
+      end
+
+      # Find by prefixed ID first, falling back to integer id for backwards compatibility.
+      def find_by_param(param)
+        return nil if param.blank?
+
+        find_by_prefix_id(param) || (find_by(id: param) if param.to_s.match?(/\A\d+\z/))
+      end
+
+      def find_by_param!(param)
+        find_by_param(param) || raise(ActiveRecord::RecordNotFound.new("Couldn't find #{name} with param=#{param}", name))
+      end
+    end
+  end
+end

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

@@ -126,9 +126,8 @@ module Spree
       #
       #   SELECT COUNT(*) ...
       add_search_scope :in_taxon do |taxon|
-        includes(:classifications).
-          where('spree_products_taxons.taxon_id' => taxon.cached_self_and_descendants_ids).
-          order('spree_products_taxons.position ASC')
+        joins(:classifications).
+          where("#{Classification.table_name}.taxon_id" => taxon.cached_self_and_descendants_ids).distinct
       end
 
       # This scope selects products in all taxons AND all its descendants
@@ -205,15 +204,33 @@ module Spree
         return Product.group("#{Spree::Product.table_name}.id").none if option_type_id.blank?
 
         group("#{Spree::Product.table_name}.id").
-          joins(variants_including_master: :option_values).
+          joins(variants: :option_values).
           where(Spree::OptionValue.table_name => { name: value, option_type_id: option_type_id })
       end
 
+      # Filters products by option value IDs (prefix IDs like 'optval_xxx')
+      # Accepts an array of option value IDs
+      add_search_scope :with_option_value_ids do |*ids|
+        ids = ids.flatten.compact
+        return none if ids.empty?
+
+        # Handle prefixed IDs (optval_xxx) by decoding to actual IDs
+        actual_ids = ids.map do |id|
+          id.to_s.include?('_') ? OptionValue.decode_prefixed_id(id) : id
+        end.compact
+
+        return none if actual_ids.empty?
+
+        group("#{Spree::Product.table_name}.id").
+          joins(variants: :option_values).
+          where(Spree::OptionValue.table_name => { id: actual_ids })
+      end
+
       # Finds all products which have either:
       # 1) have an option value with the name matching the one given
       # 2) have a product property with a value matching the one given
       add_search_scope :with do |value|
-        includes(variants_including_master: :option_values).
+        includes(variants: :option_values).
           includes(:product_properties).
           where("#{OptionValue.table_name}.name = ? OR #{ProductProperty.table_name}.value = ?", value, value)
       end
@@ -288,11 +305,8 @@ module Spree
 
       # Can't use add_search_scope for this as it needs a default argument
       def self.available(available_on = nil, currency = nil)
-        scope = if available_on
-                  not_discontinued.where("#{Product.quoted_table_name}.available_on <= ?", available_on)
-                else
-                  not_discontinued.where(status: 'active')
-                end
+        scope = not_discontinued.where(status: 'active')
+        scope = scope.where("#{Product.quoted_table_name}.available_on <= ?", available_on) if available_on
 
         unless Spree::Config.show_products_without_price
           currency ||= Spree::Store.default.default_currency
@@ -336,16 +350,17 @@ module Spree
       # @param order_direction [Symbol] :desc (default) or :asc
       # @return [ActiveRecord::Relation]
       add_search_scope :by_best_selling do |order_direction = :desc|
-        order_dir = order_direction == :desc ? 'DESC' : 'ASC'
         store_id = Spree::Current.store&.id
+        sp_table = StoreProduct.arel_table
+        products_table = Product.arel_table
+
+        conditions = sp_table[:product_id].eq(products_table[:id]).and(sp_table[:store_id].eq(store_id))
+
+        units_sold = Arel::Nodes::NamedFunction.new('COALESCE', [sp_table.project(sp_table[:units_sold_count]).where(conditions), 0])
+        revenue = Arel::Nodes::NamedFunction.new('COALESCE', [sp_table.project(sp_table[:revenue]).where(conditions), 0])
 
-        joins(:store_products)
-          .where(StoreProduct.table_name => { store_id: store_id })
-          .select("#{Product.table_name}.*",
-                  "#{StoreProduct.table_name}.units_sold_count",
-                  "#{StoreProduct.table_name}.revenue")
-          .order(Arel.sql("#{StoreProduct.table_name}.units_sold_count #{order_dir}"))
-          .order(Arel.sql("#{StoreProduct.table_name}.revenue #{order_dir}"))
+        order_dir = order_direction == :desc ? :desc : :asc
+        order(units_sold.send(order_dir)).order(revenue.send(order_dir))
       end
 
       # .search_by_name

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

@@ -4,8 +4,14 @@ module Spree
   # Concern for models that publish events.
   #
   # This concern is included in Spree::Base, so all Spree models
-  # can emit events. Event payloads are generated using dedicated
-  # serializers from the Spree::Events namespace.
+  # can emit events. Event payloads are generated using V3 API serializers
+  # resolved by convention: Spree::Order → Spree::Api::V3::OrderSerializer.
+  #
+  # Models without a V3 serializer get a minimal fallback payload:
+  #   { id: prefixed_id, created_at: ..., updated_at: ... }
+  #
+  # STI models (e.g., Spree::Exports::Products) can override
+  # event_serializer_class to point to the parent serializer.
   #
   # @example Disabling events for a specific model
   #   class Spree::LogEntry < Spree.base_class
@@ -20,46 +26,16 @@ module Spree
   #     end
   #   end
   #
-  # @example Creating an event serializer (required for each model that publishes events)
-  #   # app/serializers/spree/events/order_serializer.rb
-  #   class Spree::Events::OrderSerializer < Spree::Events::BaseSerializer
-  #     protected
-  #
-  #     def attributes
-  #       {
-  #         id: resource.id,
-  #         number: resource.number,
-  #         state: resource.state.to_s,
-  #         # ... other attributes
-  #       }
+  # @example Overriding the serializer for STI models
+  #   class Spree::Export < Spree.base_class
+  #     def event_serializer_class
+  #       Spree::Api::V3::ExportSerializer
   #     end
   #   end
   #
   module Publishable
     extend ActiveSupport::Concern
 
-    # Error raised when a model tries to publish an event but has no serializer defined
-    class MissingSerializerError < StandardError
-      def initialize(model_class)
-        serializer_name = "Spree::Events::#{model_class.name.demodulize}Serializer"
-        super(
-          "Missing event serializer for #{model_class.name}. " \
-          "Please create #{serializer_name} that inherits from Spree::Events::BaseSerializer. " \
-          "Example:\n\n" \
-          "  class #{serializer_name} < Spree::Events::BaseSerializer\n" \
-          "    protected\n\n" \
-          "    def attributes\n" \
-          "      {\n" \
-          "        id: resource.id,\n" \
-          "        # add other attributes here\n" \
-          "        updated_at: timestamp(resource.updated_at)\n" \
-          "      }\n" \
-          "    end\n" \
-          "  end"
-        )
-      end
-    end
-
     included do
       class_attribute :publish_events, default: true
       class_attribute :lifecycle_events_enabled, default: false
@@ -168,36 +144,44 @@ module Spree
 
     # Get the payload for events
     #
-    # Uses dedicated event serializer (Spree::Events::ModelSerializer).
-    # Raises MissingSerializerError if no serializer is defined.
+    # Uses the V3 serializer resolved by convention.
+    # Falls back to a minimal payload if no serializer is found.
     #
     # @return [Hash]
-    # @raise [MissingSerializerError] if no serializer is defined for this model
     def event_payload
       serializer = event_serializer_class
 
-      raise MissingSerializerError, self.class unless serializer
+      unless serializer
+        return {
+          id: respond_to?(:prefixed_id) ? prefixed_id : id,
+          created_at: created_at&.iso8601,
+          updated_at: updated_at&.iso8601
+        }
+      end
 
-      serializer.serialize(self, event_context)
+      # Use as_json to ensure all values are JSON-safe primitives.
+      # Alba's to_h can return raw Ruby objects (e.g., Spree::Money) which
+      # ActiveJob cannot serialize for async event subscribers.
+      serializer.new(self, params: event_serializer_params).to_h.as_json
     end
 
     # Find the event serializer class for this model
     #
-    # Looks for Spree::Events::ModelNameSerializer (e.g., Spree::Events::OrderSerializer)
-    # Also walks up the class hierarchy to find a serializer for parent classes.
-    # This allows subclasses like Spree::Exports::Products to use ExportSerializer.
+    # Looks for Spree::Api::V3::ModelNameSerializer by convention.
+    # Walks up the class hierarchy to support STI models.
+    #
+    # Models can override this method to specify a custom serializer,
+    # which is useful for STI models like Export, Import, Report.
     #
     # @return [Class, nil] The serializer class or nil if not found
     def event_serializer_class
       return nil unless self.class.name
 
-      # Try this class and walk up the hierarchy
       klass = self.class
       while klass && klass != Object && klass != BasicObject
         class_name = klass.name&.demodulize
-        # Skip looking for BaseSerializer - that's the parent class for all serializers
         if class_name.present? && class_name != 'Base'
-          serializer = "Spree::Events::#{class_name}Serializer".safe_constantize
+          serializer = "Spree::Api::V3::#{class_name}Serializer".safe_constantize
           return serializer if serializer
         end
 
@@ -227,6 +211,22 @@ module Spree
 
     private
 
+    # Build params for V3 serializers
+    #
+    # @return [Hash]
+    def event_serializer_params
+      store = respond_to?(:store) ? self.store : nil
+      store ||= Spree::Current.store
+
+      {
+        store: store,
+        currency: Spree::Current.currency,
+        user: nil,
+        locale: nil,
+        includes: []
+      }
+    end
+
     def should_publish_events?
       self.class.publish_events && Spree::Events.enabled?
     end

data/app/models/concerns/spree/{multi_store_resource.rb → store_scoped_resource.rb}

@@ -1,23 +1,15 @@
 module Spree
-  module MultiStoreResource
+  module StoreScopedResource
     extend ActiveSupport::Concern
 
     included do
       scope :for_store, ->(store) { joins(:stores).where(Store.table_name => { id: store.id }) }
 
       before_validation :set_default_store, if: :new_record?
-
-      validate :must_have_one_store, unless: :disable_store_presence_validation?
     end
 
     protected
 
-    def must_have_one_store
-      return if stores.any?
-
-      errors.add(:stores, Spree.t(:must_have_one_store))
-    end
-
     def set_default_store
       return if disable_store_presence_validation?
       return if stores.any?
@@ -25,7 +17,6 @@ module Spree
       stores << Spree::Store.default
     end
 
-    # this can be overridden on model basis
     def disable_store_presence_validation?
       Spree::Config[:disable_store_presence_validation]
     end