spree_core 6.0.0.beta4 → 6.0.0.rc1

data/app/models/spree/fulfillment.rb

@@ -1,5 +1,3 @@
-require 'ostruct'
-
 module Spree
   class Fulfillment < Spree.base_class
     has_prefix_id :ful
@@ -15,6 +13,9 @@ module Spree
     include Spree::Fulfillment::CustomEvents
 
     publishes_lifecycle_events
+    publishes_events :canceled, :delivered, :fulfilled
+    publishes_event 'shipment.shipped', deprecated_alias_of: 'fulfillment.fulfilled'
+    publishes_event 'shipment.canceled', deprecated_alias_of: 'fulfillment.canceled'
 
     with_options inverse_of: :fulfillments do
       belongs_to :address, class_name: 'Spree::Address', optional: true
@@ -92,6 +93,18 @@ module Spree
 
     delegate :store, :currency, to: :owner
 
+    # What a rebuild hands to {#carry_over_selection}, read before the old
+    # proposals and their rates are deleted. Grouped rather than keyed by
+    # location: one location can ship several proposals (a digital item beside
+    # a physical one, stock on hand beside a backorder), each with its own choice.
+    #
+    # @return [Hash{Integer => Array<Spree::DeliveryRate>}] the selected rates
+    #   of each stock location's proposals
+    def self.selected_rates_by_stock_location
+      includes(:selected_delivery_rate).group_by(&:stock_location_id).
+        transform_values { |proposals| proposals.filter_map(&:selected_delivery_rate) }
+    end
+
     # The exactly-one owner of this fulfillment — the cart during checkout,
     # the order after completion. New code must read +owner+, never assume
     # +order+.
@@ -221,7 +234,7 @@ module Spree
     #
     # @return [String, Spree::Money]
     def display_cost(**options)
-      return Spree.t('delivery_rates.quoted_after_review') if unpriced?
+      return I18n.t('spree.delivery_rates.quoted_after_review') if unpriced?
 
       Spree::Money.new(cost, { currency: currency }.merge(options))
     end
@@ -338,7 +351,7 @@ module Spree
     #
     # @return [String, Spree::Money]
     def display_final_price(**options)
-      return Spree.t('delivery_rates.quoted_after_review') if unpriced?
+      return I18n.t('spree.delivery_rates.quoted_after_review') if unpriced?
 
       Spree::Money.new(final_price, { currency: currency }.merge(options))
     end
@@ -543,34 +556,13 @@ module Spree
 
       # StockEstimator.new assignment below will replace the current delivery_method
       original_shipping_method_id = delivery_method.try(:id)
-      # A carrier method quotes several rates (one per service), so the
-      # method id alone no longer identifies the customer's choice — capture
-      # the selected rate's carrier service too.
       original_selection = selected_delivery_rate
-      original_carrier = original_selection&.carrier
-      original_service_level = original_selection&.service_level
 
       self.delivery_rates = Stock::Estimator.new(owner).
                             delivery_rates(to_package, audience)
 
       if delivery_method
-        # Keep the previously chosen carrier service when it is still quoted,
-        # then the previously chosen method, then the estimator's own pick
-        # (the cheapest rate, already flagged selected) rather than leaving
-        # the fulfillment unselected.
-        selected_rate =
-          if original_shipping_method_id && original_carrier
-            delivery_rates.detect do |rate|
-              rate.delivery_method_id == original_shipping_method_id &&
-                rate.carrier == original_carrier &&
-                rate.service_level == original_service_level
-            end
-          end
-        selected_rate ||=
-          if original_shipping_method_id
-            delivery_rates.detect { |rate| rate.delivery_method_id == original_shipping_method_id }
-          end
-        selected_rate ||= delivery_rates.detect(&:selected)
+        selected_rate = successor_rate(original_shipping_method_id, original_selection)
 
         save!
         self.selected_shipping_rate_id = selected_rate.id if selected_rate
@@ -755,6 +747,25 @@ module Spree
       end
     end
 
+    # Carries the customer's choice onto a freshly built, unsaved proposal:
+    # takes the first of +candidates+ whose method this proposal is quoted for,
+    # selects the rate standing for it and prices the proposal at it, so a
+    # rebuild neither resets the choice nor drops its cost. The rate taken is
+    # removed from +candidates+, leaving the rest to this proposal's siblings.
+    #
+    # @param candidates [Array<Spree::DeliveryRate>] the rates selected on the
+    #   proposals this stock location had before the rebuild
+    # @return [void]
+    def carry_over_selection(candidates)
+      quoted_method_ids = delivery_rates.map(&:delivery_method_id)
+      previous_rate = candidates.find { |rate| quoted_method_ids.include?(rate.delivery_method_id) }
+      candidates.delete(previous_rate)
+
+      choice = successor_rate(previous_rate&.delivery_method_id, previous_rate)
+      delivery_rates.each { |rate| rate.selected = rate == choice }
+      self.cost = choice&.cost || 0
+    end
+
     # @deprecated No-op since 6.0; removed in 6.1.
     #
     # This re-derived the status from the order's payment state on every order
@@ -792,6 +803,21 @@ module Spree
 
     private
 
+    # The previously chosen carrier service when it is still quoted, then the
+    # previously chosen method, then the estimator's own pick - a carrier
+    # method quotes one rate per service, so the method alone does not
+    # identify the choice.
+    def successor_rate(delivery_method_id, previous_rate)
+      same_method = delivery_method_id ? delivery_rates.select { |rate| rate.delivery_method_id == delivery_method_id } : []
+      same_service = if previous_rate&.carrier
+                       same_method.detect do |rate|
+                         rate.carrier == previous_rate.carrier && rate.service_level == previous_rate.service_level
+                       end
+                     end
+
+      same_service || same_method.first || delivery_rates.detect(&:selected)
+    end
+
     # @return [Boolean] whether this parcel's order shares its payment with
     #   others placed in the same checkout
     # Draws one parcel's worth from a payment and reports what it took.
@@ -957,7 +983,7 @@ module Spree
     end
 
     def exactly_one_owner
-      errors.add(:base, :exactly_one_of_cart_or_order, message: Spree.t('errors.messages.exactly_one_of_cart_or_order')) unless [order, cart].compact.one?
+      errors.add(:base, :exactly_one_of_cart_or_order, message: I18n.t('spree.errors.messages.exactly_one_of_cart_or_order')) unless [order, cart].compact.one?
     end
 
     def update_adjustments

data/app/models/spree/fulfillment_changer.rb

@@ -106,8 +106,8 @@ module Spree
     end
 
     def get_desired_shipment_inventory_unit(state)
-      desired_shipment.fulfillment_items.find_or_create_by(status: state, variant: variant) do |unit|
-        current_shipment_unit = current_shipment_units.first
+      current_shipment_unit = current_shipment_units.first
+      desired_shipment.fulfillment_items.find_or_create_by(status: state, variant: variant, replacement: current_shipment_unit&.replacement || false) do |unit|
         unit.variant_id = current_shipment_unit.variant_id
         unit.order_id = current_shipment_unit.order_id
         unit.line_item_id = current_shipment_unit.line_item_id

data/app/models/spree/fulfillment_item.rb

@@ -15,11 +15,7 @@ module Spree
       belongs_to :line_item, class_name: 'Spree::LineItem'
     end
 
-    scope :backordered, -> { where status: 'backordered' }
-    scope :on_hand, -> { where status: 'on_hand' }
     scope :on_hand_or_backordered, -> { where status: ['backordered', 'on_hand'] }
-    scope :shipped, -> { where status: 'shipped' }
-    scope :returned, -> { where status: 'returned' }
     scope :backordered_per_variant, ->(stock_level) do
       includes(:fulfillment, :order).
         where.not(Spree::Fulfillment.table_name => { status: 'canceled' }).

data/app/models/spree/fulfillment_provider/base.rb

@@ -6,6 +6,7 @@ module Spree
     # ShipmentHandler name-constantize mechanism.
     class Base
       include Spree::IntegrationBackedProvider
+      extend Spree::ApiTyped
 
       class << self
         # Behavior predicates — the class hierarchy IS the vocabulary.

data/app/models/spree/gateway/bogus.rb

@@ -117,6 +117,10 @@ module Spree
       payment_session.complete
     end
 
+    def cancel_payment_session(payment_session:)
+      payment_session.cancel
+    end
+
     def setup_session_supported?
       true
     end

data/app/models/spree/gateway/custom_payment_source_method.rb

@@ -1,5 +1,10 @@
 module Spree
   class Gateway::CustomPaymentSourceMethod < Gateway
+    # Sources recorded by the merchant, not charged through a provider.
+    def self.third_party?
+      false
+    end
+
     def provider_class
       self.class
     end

data/app/models/spree/gateway.rb

@@ -31,6 +31,10 @@ module Spree
       outer ? outer.underscore : leaf
     end
 
+    def self.third_party?
+      true
+    end
+
     def payment_source_class
       CreditCard
     end
@@ -49,7 +53,7 @@ module Spree
     end
 
     def options
-      preferences.each_with_object({}) { |(key, value), memo| memo[key.to_sym] = value; }
+      preference_values.symbolize_keys
     end
 
     def method_missing(method, *args)

data/app/models/spree/gift_card.rb

@@ -8,6 +8,7 @@ module Spree
     include Spree::Security::GiftCards if defined?(Spree::Security::GiftCards)
 
     publishes_lifecycle_events
+    publishes_events :canceled, :partially_redeemed, :redeemed
 
     #
     # Status
@@ -35,7 +36,6 @@ module Spree
     #
     # Associations
     #
-    belongs_to :store, class_name: 'Spree::Store'
     belongs_to :customer, class_name: Spree.customer_class.to_s, optional: true
     include Spree::DeprecatedCustomerAlias
     belongs_to :created_by, class_name: Spree.admin_user_class.to_s, optional: true
@@ -94,6 +94,17 @@ module Spree
       amount - amount_used - amount_authorized
     end
 
+    # What the card can still give towards an order: nothing once it has
+    # expired, been redeemed or been cancelled, and never less than zero,
+    # since an admin can lower the amount below what is already in use.
+    #
+    # @return [BigDecimal]
+    def spendable_amount
+      return BigDecimal('0') if expired? || redeemed? || canceled?
+
+      [amount_remaining, 0].max
+    end
+
     delegate :email, to: :customer, prefix: true, allow_nil: true
 
     def self.json_api_columns

data/app/models/spree/gift_card_batch.rb

@@ -10,7 +10,6 @@ module Spree
     #
     # Associations
     #
-    belongs_to :store, class_name: 'Spree::Store'
     belongs_to :created_by, class_name: Spree.admin_user_class.to_s, optional: true
     has_many :gift_cards, class_name: 'Spree::GiftCard', inverse_of: :batch, dependent: :destroy
 

data/app/models/spree/import.rb

@@ -17,6 +17,7 @@ module Spree
       'https://raw.githubusercontent.com/spree/spree/refs/tags/v%<version>s/spree/core/db/sample_data'.freeze
 
     publishes_lifecycle_events
+    publishes_events :completed, :progress
 
     # Set event prefix for all Import subclasses
     # This ensures Spree::Imports::Products publishes 'import.create' not 'products.create'
@@ -191,12 +192,6 @@ module Spree
       Spree.import_retry_failed_rows_workflow.call(import: self).success?
     end
 
-    # Returns true if the import is in mapping state
-    # @return [Boolean]
-    def mapping?
-      status == 'mapping'
-    end
-
     # Returns true if the import is processing or completed mapping
     # @return [Boolean]
     def processing?
@@ -331,7 +326,7 @@ module Spree
     # Returns the display name for the import
     # @return [String]
     def display_name
-      "#{Spree.t(type.demodulize.pluralize.downcase)} #{number}"
+      "#{self.class.model_name.human(count: 2)} #{number}"
     end
 
     # Returns the headers of the csv file

data/app/models/spree/import_mapping.rb

@@ -5,7 +5,7 @@ module Spree
     #
     # Associations
     #
-    belongs_to :import, class_name: 'Spree::Import', inverse_of: :mappings, required: true
+    belongs_to :import, class_name: 'Spree::Import', inverse_of: :mappings
 
     #
     # Validations
@@ -17,7 +17,6 @@ module Spree
     #
     # Scopes
     #
-    scope :required, -> { where(schema_field: import.required_fields) }
     scope :mapped, -> { where.not(file_column: [nil, '']) }
 
     # Returns true if the mapping is required

data/app/models/spree/import_row.rb

@@ -1,5 +1,7 @@
 module Spree
   class ImportRow < Spree.base_class
+    publishes_events :completed, :failed
+
     has_prefix_id :imrow
 
     # Set event prefix for ImportRow
@@ -41,8 +43,6 @@ module Spree
     # Scopes
     #
     scope :pending_and_failed, -> { where(status: %i[pending failed]) }
-    scope :completed, -> { where(status: :completed) }
-    scope :failed, -> { where(status: :failed) }
     scope :processed, -> { where(status: %i[completed failed]) }
     # Rows still legitimately blocking import completion: `pending` (not started) or
     # `processing` with a recent updated_at (worker still alive). Orphaned `processing`

data/app/models/spree/import_schemas/products.rb

@@ -25,6 +25,7 @@ module Spree
         { name: 'track_inventory', label: 'Track Inventory' },
         { name: 'inventory_count', label: 'Inventory Count' },
         { name: 'inventory_backorderable', label: 'Inventory Backorderable' },
+        { name: 'stock_location', label: 'Stock Location' },
         { name: 'tax_category', label: 'Tax Category' },
         { name: 'product_type', label: 'Product Type' },
         { name: 'hs_code', label: 'HS Code' },

data/app/models/spree/integration.rb

@@ -10,6 +10,9 @@ module Spree
 
     include Spree::SingleStoreResource
     include Spree::PreferenceSchema
+    include Spree::SecretPreferences
+    include Spree::ProviderListing
+
 
     # Spree::Current.integrations snapshots the active set for the request;
     # connecting or deactivating one mid-request (the activate-and-verify
@@ -58,25 +61,12 @@ module Spree
     attr_accessor :connection_error_message
 
     # Associates the integration to a group.
-    # The name here will be used as Spree.t key to display the group name.
+    # The name is read as a translation key under +spree.+ to display the group name.
     # Leave blank to leave the integration ungrouped.
     def self.integration_group
       nil
     end
 
-    # Logo shown on the gallery card: an absolute URL to publicly hosted
-    # brand assets, or a `data:` URI for gems that want to be self-contained
-    # (works air-gapped, no CSP domain to allowlist). Anything an `<img src>`
-    # accepts. Deliberately not an asset-pipeline path — integration gems
-    # must not force an asset pipeline onto headless API hosts. Hosted logos
-    # are a courtesy, not a guarantee: the dashboard falls back to a letter
-    # avatar when unset or unreachable.
-    #
-    # @return [String, nil]
-    def self.logo_url
-      nil
-    end
-
     # One-line marketing description shown on the integration's gallery card.
     # Localize by shipping a Rails translation instead (or additionally):
     # `spree.integrations.<api_type>.description` wins over this fallback.
@@ -92,7 +82,7 @@ module Spree
     #
     # @return [String, nil]
     def self.human_description
-      Spree.t("integrations.#{api_type}.description", default: description)
+      I18n.t("spree.integrations.#{api_type}.description", default: description)
     end
 
     # Wire entries for the admin types-discovery endpoint — every registered
@@ -107,7 +97,7 @@ module Spree
           name: klass.integration_name,
           group: klass.integration_group,
           description: klass.human_description,
-          logo_url: klass.logo_url,
+          **klass.provider_listing,
           preference_schema: klass.serialized_preference_schema
         }
       end.sort_by { |entry| entry[:name] }
@@ -172,7 +162,7 @@ module Spree
       return if Spree.integrations.empty?
       return if Spree.integrations.map(&:to_s).include?(type)
 
-      errors.add(:type, :integration_type_not_registered, message: Spree.t('errors.messages.integration_type_not_registered'))
+      errors.add(:type, :integration_type_not_registered, message: I18n.t('spree.errors.messages.integration_type_not_registered'))
     end
 
     # On :base, not :active — the seller's message ("This api key is no
@@ -182,7 +172,7 @@ module Spree
     def must_connect_when_activating
       return if can_connect?
 
-      errors.add(:base, connection_error_message.presence || Spree.t('errors.messages.integration_connection_failed'))
+      errors.add(:base, connection_error_message.presence || I18n.t('spree.errors.messages.integration_connection_failed'))
     end
   end
 end

data/app/models/spree/invitation.rb

@@ -1,5 +1,7 @@
 module Spree
   class Invitation < Spree.base_class
+    publishes_events :accepted, :created, :resent
+
     has_prefix_id :inv
 
     has_secure_token
@@ -32,8 +34,6 @@ module Spree
     #
     # Scopes
     #
-    scope :pending, -> { where(status: 'pending') }
-    scope :accepted, -> { where(status: 'accepted') }
     scope :not_expired, -> { where('expires_at > ?', Time.current) }
 
     #
@@ -144,7 +144,7 @@ module Spree
 
     def invitee_is_not_inviter
       if invitee == inviter
-        errors.add(:invitee, :same_as_inviter, message: Spree.t('errors.messages.same_as_inviter'))
+        errors.add(:invitee, :same_as_inviter, message: I18n.t('spree.errors.messages.same_as_inviter'))
       end
     end
 
@@ -154,7 +154,7 @@ module Spree
       return if role.blank? || resource.blank?
       return if role.resource == resource
 
-      errors.add(:role, :invitation_role_resource_mismatch, message: Spree.t(:invitation_role_resource_mismatch))
+      errors.add(:role, :invitation_role_resource_mismatch, message: I18n.t('spree.invitation_role_resource_mismatch'))
     end
 
     def invitee_already_exists
@@ -165,7 +165,7 @@ module Spree
       return if user_to_check.blank?
 
       if resource.role_users.exists?(user: user_to_check)
-        errors.add(:email, :already_a_member, message: Spree.t('errors.messages.already_a_member'))
+        errors.add(:email, :already_a_member, message: I18n.t('spree.errors.messages.already_a_member'))
       end
     end
 

data/app/models/spree/line_item.rb

@@ -63,7 +63,7 @@ module Spree
     #   https://github.com/spree/spree/issues/2695#issuecomment-143314161
     validates :quantity, numericality: {
       in: 0..DB_INTEGER_MAX,
-      only_integer: true, message: Spree.t('validation.must_be_int')
+      only_integer: true, message: I18n.t('spree.validation.must_be_int')
     }
 
     validates :price, numericality: true
@@ -260,6 +260,17 @@ module Spree
     alias discounted_money display_discounted_amount
     alias discounted_amount taxable_amount
 
+    # What +units+ of this line cost the customer after discounts. Multiplied
+    # before dividing, so all of a line's units together come to the whole line.
+    #
+    # @param units [Integer]
+    # @return [BigDecimal] rounded to the currency, never negative
+    def discounted_amount_for(units)
+      return BigDecimal(0) if quantity.to_i.zero?
+
+      Spree::Money::Rounding.to_currency([discounted_amount, 0].max * units.to_i / quantity, currency)
+    end
+
     # Returns the amount this line item is taxed on. Whole-order promotions
     # are distributed to line-item Discount rows at application time, so the
     # discounted amount already carries the line's share. Never negative.
@@ -485,7 +496,7 @@ module Spree
     end
 
     def exactly_one_owner
-      errors.add(:base, :exactly_one_of_cart_or_order, message: Spree.t('errors.messages.exactly_one_of_cart_or_order')) unless [order, cart].compact.one?
+      errors.add(:base, :exactly_one_of_cart_or_order, message: I18n.t('spree.errors.messages.exactly_one_of_cart_or_order')) unless [order, cart].compact.one?
     end
   end
 end

data/app/models/spree/locale.rb

@@ -1,3 +1,5 @@
+require 'csv'
+
 module Spree
   # Virtual model for a supported locale. Wraps a locale +code+ and exposes its
   # display name, layout direction, and whether it is a store's default — the
@@ -21,16 +23,17 @@ module Spree
       code = self.code.to_s
 
       if I18n.exists?('spree.i18n.this_file_language', locale: code, fallback: false)
-        return normalize_name(Spree.t('i18n.this_file_language', locale: code))
-      end
-
-      if defined?(SpreeI18n::Locale) && (name = SpreeI18n::Locale.local_language_name(code))
-        return normalize_name(name)
+        return normalize_name(I18n.t('spree.i18n.this_file_language', locale: code))
       end
 
-      return 'English' if code == 'en'
+      name = self.class.language_names[code.downcase] || self.class.language_names[language_code]
+      name ? normalize_name(name) : code
+    end
 
-      code
+    # Each language's name in that language ("Deutsch", "日本語"), keyed by code.
+    # @return [Hash{String => String}]
+    def self.language_names
+      @language_names ||= ::CSV.read(File.expand_path('../../../config/language_names.csv', __dir__)).to_h { |row| [row[0], row[2]] }
     end
 
     # Select label, e.g. "EN — English".
@@ -88,7 +91,7 @@ module Spree
 
     private
 
-    # Strip a trailing " (CODE)" suffix from Spree I18n locale labels. Uses
+    # Strip a trailing " (CODE)" suffix from a locale file's own name. Uses
     # plain string ops rather than a regex to avoid polynomial backtracking on
     # adversarial input (ReDoS).
     def normalize_name(name)

data/app/models/spree/market.rb

@@ -69,6 +69,7 @@ module Spree
     # An unregistered class name would only fail at checkout, when a customer is
     # waiting on a total. The list is read at validation time so a provider gem
     # loaded after boot still counts.
+    normalizes :tax_provider, with: ->(value) { Spree::ApiTyped.class_name_for(Spree.tax_providers, value) }
     validates :tax_provider,
               inclusion: { in: ->(_market) { Spree.tax_providers.map(&:to_s) } },
               allow_blank: true

data/app/models/spree/newsletter_subscriber.rb

@@ -6,6 +6,9 @@ module Spree
     include Spree::SingleStoreResource
 
     publishes_lifecycle_events
+    publishes_event :verified
+    publishes_events :subscription_requested, :unsubscribe_requested,
+                     serializer: 'Spree::Api::V3::NewsletterSubscriberRequestEventSerializer'
 
     has_secure_token :verification_token