spree_core 5.3.4 → 5.4.0.beta

data/db/sample_data/promotions.rb

@@ -0,0 +1,8 @@
+promotion = Spree::Promotion.where(
+  name: 'Free Shipping',
+  code: 'FREESHIP'
+).first_or_create! do |promo|
+  promo.stores = Spree::Store.all
+end
+
+Spree::Promotion::Actions::FreeShipping.where(promotion: promotion).first_or_create!

data/db/sample_data/shipping_methods.rb

@@ -0,0 +1,39 @@
+begin
+  north_america = Spree::Zone.find_by!(name: 'North America')
+rescue ActiveRecord::RecordNotFound
+  puts "Couldn't find 'North America' zone. Did you run `rake db:seed` first?"
+  exit
+end
+
+europe_vat = Spree::Zone.find_by!(name: 'EU_VAT')
+shipping_category = Spree::ShippingCategory.find_or_create_by!(name: 'Default')
+
+shipping_methods = [
+  { name: 'UPS Ground (USD)', zones: [north_america], display_on: 'both', shipping_categories: [shipping_category] },
+  { name: 'UPS Two Day (USD)', zones: [north_america], display_on: 'both', shipping_categories: [shipping_category] },
+  { name: 'UPS One Day (USD)', zones: [north_america], display_on: 'both', shipping_categories: [shipping_category] },
+  { name: 'UPS Ground (EU)', zones: [europe_vat], display_on: 'both', shipping_categories: [shipping_category] },
+  { name: 'UPS Ground (EUR)', zones: [europe_vat], display_on: 'both', shipping_categories: [shipping_category] }
+]
+
+shipping_methods.each do |attributes|
+  Spree::ShippingMethod.where(name: attributes[:name]).first_or_create! do |shipping_method|
+    shipping_method.calculator = Spree::Calculator::Shipping::FlatRate.create!
+    shipping_method.zones = attributes[:zones]
+    shipping_method.display_on = attributes[:display_on]
+    shipping_method.shipping_categories = attributes[:shipping_categories]
+  end
+end
+
+{
+  'UPS Ground (USD)' => [5, 'USD'],
+  'UPS Ground (EU)' => [5, 'USD'],
+  'UPS One Day (USD)' => [15, 'USD'],
+  'UPS Two Day (USD)' => [10, 'USD'],
+  'UPS Ground (EUR)' => [8, 'EUR']
+}.each do |shipping_method_name, (price, currency)|
+  shipping_method = Spree::ShippingMethod.find_by!(name: shipping_method_name)
+  shipping_method.calculator.preferences = { amount: price, currency: currency }
+  shipping_method.calculator.save!
+  shipping_method.save!
+end

data/lib/generators/spree/authentication/devise/devise_generator.rb

@@ -55,7 +55,7 @@ module Spree
             inject_into_file admin_user_class_file, after: "class #{Spree.admin_user_class.name} < ApplicationRecord\n" do
               <<-RUBY
     # Spree modules
-    include Spree::UserMethods
+    include Spree::AdminUserMethods
               RUBY
             end
             gsub_file admin_user_class_file, "< ApplicationRecord", "< Spree.base_class"
@@ -65,7 +65,7 @@ module Spree
             say "Could not locate admin user model file at #{admin_user_class_file}. Please add these lines manually:", :red
             say <<~RUBY
               # Spree modules
-              include Spree::UserMethods
+              include Spree::AdminUserMethods
             RUBY
 
             say "Please replace < ApplicationRecord with < Spree.base_class in #{admin_user_class_file}"

data/lib/generators/spree/authentication/dummy/dummy_generator.rb

@@ -0,0 +1,54 @@
+require 'rails/generators'
+
+module Spree
+  module Authentication
+    class DummyGenerator < Rails::Generators::Base
+      desc 'Set up a Spree installation with dummy authentication for testing. Creates a separate spree_admin_users table.'
+
+      def self.source_paths
+        paths = superclass.source_paths
+        paths << File.expand_path('templates', __dir__)
+        paths.flatten
+      end
+
+      def create_authentication_helpers
+        template 'authentication_helpers.rb.tt', 'lib/spree/authentication_helpers.rb'
+      end
+
+      def configure_authentication_helpers
+        file_action = File.exist?('config/initializers/spree.rb') ? :append_file : :create_file
+        send(file_action, 'config/initializers/spree.rb') do
+          <<~RUBY
+
+            Rails.application.config.to_prepare do
+              require_dependency 'spree/authentication_helpers'
+            end
+          RUBY
+        end
+      end
+
+      def create_admin_users_migration
+        # Use a fixed early timestamp (20210913) to ensure this migration runs BEFORE
+        # any Spree core migrations that reference spree_admin_users table.
+        # The earliest such migration is 20250122113708_add_first_and_last_name_to_spree_admin_class.rb
+        # We use a timestamp before the main Spree migration (20210914000000_spree_four_three.rb)
+        migration_file = File.join('db', 'migrate', '20210913000000_create_spree_admin_users.rb')
+
+        # Skip if migration already exists
+        return if File.exist?(migration_file) || migration_exists?('create_spree_admin_users')
+
+        template 'create_spree_admin_users.rb.tt', migration_file
+      end
+
+      private
+
+      def migration_exists?(name)
+        Dir.glob(File.join('db', 'migrate', "*_#{name}.rb")).any?
+      end
+
+      def migration_version
+        "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+      end
+    end
+  end
+end

data/lib/generators/spree/authentication/dummy/templates/authentication_helpers.rb.tt

@@ -0,0 +1,52 @@
+# Dummy authentication helpers for testing purposes.
+# These provide stub implementations that don't require actual routes.
+module Spree
+  module AuthenticationHelpers
+    def self.included(receiver)
+      receiver.helper_method(
+        :spree_current_user,
+        :spree_login_path,
+        :spree_signup_path,
+        :spree_logout_path,
+        :spree_forgot_password_path,
+        :spree_edit_password_path,
+        :spree_admin_login_path,
+        :spree_admin_logout_path
+      )
+    end
+
+    def spree_current_user
+      @spree_current_user
+    end
+
+    def spree_login_path(_opts = {})
+      '/login'
+    end
+
+    def spree_signup_path(_opts = {})
+      '/signup'
+    end
+
+    def spree_logout_path(_opts = {})
+      '/logout'
+    end
+
+    def spree_forgot_password_path(_opts = {})
+      '/forgot_password'
+    end
+
+    def spree_edit_password_path(_opts = {})
+      '/edit_password'
+    end
+
+    def spree_admin_login_path(_opts = {})
+      '/admin/login'
+    end
+
+    def spree_admin_logout_path(_opts = {})
+      '/admin/logout'
+    end
+  end
+end
+
+ApplicationController.include Spree::AuthenticationHelpers if defined?(ApplicationController)

data/lib/generators/spree/authentication/dummy/templates/create_spree_admin_users.rb.tt

@@ -0,0 +1,33 @@
+class CreateSpreeAdminUsers < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :spree_admin_users do |t|
+      t.string :encrypted_password, limit: 128
+      t.string :password_salt, limit: 128
+      t.string :email
+      t.string :remember_token
+      t.string :persistence_token
+      t.string :reset_password_token
+      t.string :perishable_token
+      t.integer :sign_in_count, default: 0, null: false
+      t.integer :failed_attempts, default: 0, null: false
+      t.datetime :last_request_at
+      t.datetime :current_sign_in_at
+      t.datetime :last_sign_in_at
+      t.string :current_sign_in_ip
+      t.string :last_sign_in_ip
+      t.string :login
+      t.string :authentication_token
+      t.string :unlock_token
+      t.datetime :locked_at
+      t.datetime :remember_created_at
+      t.datetime :reset_password_sent_at
+      t.string :first_name
+      t.string :last_name
+      t.string :selected_locale
+
+      t.timestamps
+    end
+
+    add_index :spree_admin_users, :email, unique: true
+  end
+end

data/lib/generators/spree/dummy/dummy_generator.rb

@@ -4,7 +4,7 @@ require 'spree/core/version'
 
 module Spree
   class DummyGenerator < Rails::Generators::Base
-    SPREE_GEMS = %w(spree_admin spree_storefront spree_api spree_emails).freeze
+    SPREE_GEMS = %w(spree_admin spree_api spree_emails).freeze
 
     desc 'Creates blank Rails application, installs Spree and all sample data'
 

data/lib/spree/core/configuration.rb

@@ -40,6 +40,7 @@ module Spree
       preference :company, :boolean, default: false, deprecated: 'Use the company_field_enabled preference in the Spree::Store model' # Request company field for billing and shipping addr
       preference :currency, :string, default: 'USD', deprecated: true
       preference :credit_to_new_allocation, :boolean, default: false
+      preference :disable_migration_check, :boolean, default: false # when turned on disables the startup warning about missing engine migrations
       preference :disable_sku_validation, :boolean, default: false # when turned off disables the built-in SKU uniqueness validation
       preference :disable_store_presence_validation, :boolean, default: false # when turned off disables Store presence validation for Products and Payment Methods
       preference :events_log_enabled, :boolean, default: true # Log all Spree events to Rails logger

data/lib/spree/core/controller_helpers/common.rb

@@ -1,7 +1,13 @@
 module Spree
   module Core
     module ControllerHelpers
+      # @deprecated This module is deprecated and will be removed in Spree 5.5.
       module Common
+        def self.included(base)
+          Spree::Deprecation.warn(
+            'Spree::Core::ControllerHelpers::Common is deprecated and will be removed in Spree 5.5.'
+          )
+        end
       end
     end
   end

data/lib/spree/core/controller_helpers/currency.rb

@@ -39,8 +39,13 @@ module Spree
         end
 
         # Returns the list of supported currencies for all stores.
+        # @deprecated This method will be removed in Spree 5.5.
         # @return [Array<String>] the list of supported currencies, eg. `["USD", "EUR"]`
         def supported_currencies_for_all_stores
+          Spree::Deprecation.warn(
+            'supported_currencies_for_all_stores is deprecated and will be removed in Spree 5.5.'
+          )
+
           @supported_currencies_for_all_stores ||= begin
             (
               Spree::Store.pluck(:supported_currencies).map { |c| c&.split(',') }.flatten + Spree::Store.pluck(:default_currency)

data/lib/spree/core/controller_helpers/order.rb

@@ -15,8 +15,12 @@ module Spree
           @order_token ||= cookies.signed[:token] || params[:order_token]
         end
 
-        # Used in the link_to_cart helper.
+        # @deprecated Use `current_order` instead. This method will be removed in Spree 5.5.
         def simple_current_order
+          Spree::Deprecation.warn(
+            'simple_current_order is deprecated and will be removed in Spree 5.5. Use current_order instead.'
+          )
+
           return @simple_current_order if @simple_current_order
 
           @simple_current_order = find_order_by_token_or_user

data/lib/spree/core/controller_helpers/store.rb

@@ -61,7 +61,7 @@ module Spree
 
         def current_tax_zone
           @current_tax_zone ||= begin
-            zone = @current_order&.tax_zone || Spree::Zone.default_tax || current_store.checkout_zone
+            zone = @current_order&.tax_zone || Spree::Zone.default_tax
             Spree::Current.zone = zone
             zone
           end

data/lib/spree/core/dependencies.rb

@@ -100,7 +100,7 @@ module Spree
         cms_page_finder: nil, # LEGACY
         menu_finder: nil, # LEGACY
         current_order_finder: 'Spree::Orders::FindCurrent',
-        current_store_finder: 'Spree::Stores::FindCurrent',
+        current_store_finder: 'Spree::Stores::FindDefault',
         completed_order_finder: 'Spree::Orders::FindComplete',
         credit_card_finder: 'Spree::CreditCards::Find',
         products_finder: 'Spree::Products::Find',

data/lib/spree/core/engine.rb

@@ -29,7 +29,9 @@ module Spree
                                :analytics_events,
                                :analytics_event_handlers,
                                :integrations,
-                               :subscribers)
+                               :subscribers,
+                               :store_authentication_strategies,
+                               :admin_authentication_strategies)
       SpreeCalculators = Struct.new(:shipping_methods, :tax_rates, :promotion_actions_create_adjustments, :promotion_actions_create_item_adjustments)
       PromoEnvironment = Struct.new(:rules, :actions)
       PricingEnvironment = Struct.new(:rules)
@@ -166,6 +168,7 @@ module Spree
 
         Rails.application.config.spree.pricing.rules.concat [
           Spree::PriceRules::ZoneRule,
+          Spree::PriceRules::MarketRule,
           Spree::PriceRules::UserRule,
           Spree::PriceRules::CustomerGroupRule,
           Spree::PriceRules::VolumeRule
@@ -192,6 +195,7 @@ module Spree
 
         Rails.application.config.spree.import_types = [
           Spree::Imports::Products,
+          Spree::Imports::Customers,
         ]
 
         Rails.application.config.spree.taxon_rules = [
@@ -228,7 +232,6 @@ module Spree
           Spree::Address,
           Spree::Asset,
           Spree::CreditCard,
-          Spree::CustomDomain,
           Spree::CustomerReturn,
           Spree::GiftCard,
           Spree::Image,
@@ -304,6 +307,14 @@ module Spree
           Spree::InvitationEmailSubscriber,
           Spree::ProductMetricsSubscriber
         ]
+
+        # Pre-load authentication strategy classes to avoid reflection at request time
+        Rails.application.config.spree.store_authentication_strategies = {
+          email: Spree::Authentication::Strategies::EmailPasswordStrategy
+        }
+        Rails.application.config.spree.admin_authentication_strategies = {
+          email: Spree::Authentication::Strategies::EmailPasswordStrategy
+        }
       end
 
       initializer 'spree.promo.register.promotions.actions' do |app|
@@ -322,8 +333,10 @@ module Spree
         ]
       end
 
-      initializer 'spree.core.checking_migrations' do
-        Migrations.new(config, engine_name).check unless Rails.env.test?
+      initializer 'spree.core.checking_migrations' do |app|
+        app.config.after_initialize do
+          Migrations.new(config, engine_name).check unless Rails.env.test? || Spree::Config.disable_migration_check
+        end
       end
 
       initializer 'spree.core.assets' do |app|

data/lib/spree/core/pricing/context.rb

@@ -1,22 +1,24 @@
 module Spree
   module Pricing
     class Context
-      attr_reader :variant, :currency, :store, :zone, :user, :quantity, :date, :order
+      attr_reader :variant, :currency, :store, :zone, :market, :user, :quantity, :date, :order
 
       # Initializes the context
       # @param variant [Spree::Variant]
       # @param currency [String]
       # @param store [Spree::Store]
       # @param zone [Spree::Zone]
+      # @param market [Spree::Market]
       # @param user [Spree::User]
       # @param quantity [Integer]
       # @param date [Time]
       # @param order [Spree::Order]
-      def initialize(variant: nil, currency:, store: nil, zone: nil, user: nil, quantity: nil, date: nil, order: nil)
+      def initialize(variant: nil, currency:, store: nil, zone: nil, market: nil, user: nil, quantity: nil, date: nil, order: nil)
         @variant = variant
         @currency = currency
         @store = store || Spree::Current.store
         @zone = zone || Spree::Current.zone
+        @market = market || Spree::Current.market
         @user = user
         @quantity = quantity
         @date = date || Time.current
@@ -36,7 +38,7 @@ module Spree
           variant: variant,
           currency: order.currency,
           store: order.store,
-          zone: order.tax_zone || order.store.checkout_zone,
+          zone: order.tax_zone || Spree::Zone.default_tax,
           user: order.user,
           quantity: quantity || order.line_items.find_by(variant: variant)&.quantity,
           order: order
@@ -53,6 +55,7 @@ module Spree
           currency,
           store&.id,
           zone&.id,
+          market&.id,
           user&.id,
           quantity,
           date&.to_i

data/lib/spree/core/product_filters.rb

@@ -42,7 +42,16 @@ module Spree
     # or taxons), eg see the taxon model/controller.
 
     # See specific filters below for concrete examples.
+    # @deprecated This module is deprecated and will be removed in Spree 5.5.
+    #   Use Spree::Api::V3::FiltersAggregator instead.
     module ProductFilters
+      def self.deprecated_warning
+        Spree::Deprecation.warn(
+          'Spree::Core::ProductFilters is deprecated and will be removed in Spree 5.5. ' \
+          'Please use Spree::Api::V3::FiltersAggregator instead.'
+        )
+      end
+
       # Example: filtering by price
       #   The named scope just maps incoming labels onto their conditions, and builds the conjunction
       #   'price' is in the base scope's context (ie, "select foo from products where ...") so
@@ -66,6 +75,7 @@ module Spree
       end
 
       def self.price_filter
+        deprecated_warning
         v = Spree::Price.arel_table
         conds = [[Spree.t(:under_price, price: format_price(10)), v[:amount].lteq(10)],
                  ["#{format_price(10)} - #{format_price(15)}", v[:amount].between(10..15)],
@@ -107,6 +117,7 @@ module Spree
       end
 
       def self.brand_filter
+        deprecated_warning
         brand_property = Spree::Property.find_by(name: 'brand')
         brands = brand_property ? Spree::ProductProperty.where(property_id: brand_property.id).pluck(:value).uniq.map(&:to_s) : []
 
@@ -148,6 +159,7 @@ module Spree
       end
 
       def self.selective_brand_filter(taxon = nil)
+        deprecated_warning
         taxon ||= Spree::Taxonomy.first.root
         brand_property = Spree::Property.find_by(name: 'brand')
         scope = Spree::ProductProperty.where(property: brand_property).
@@ -174,6 +186,7 @@ module Spree
       # This scope selects products in any of the active taxons or their children.
       #
       def self.taxons_below(taxon)
+        deprecated_warning
         return Spree::Core::ProductFilters.all_taxons if taxon.nil?
 
         {
@@ -191,6 +204,7 @@ module Spree
       #
       # idea: expand the format to allow nesting of labels?
       def self.all_taxons
+        deprecated_warning
         taxons = Spree::Taxonomy.all.map { |t| [t.root] + t.root.descendants }.flatten
         {
           name: 'All taxons',

data/lib/spree/core/query_filters/comparable.rb

@@ -1,8 +1,12 @@
 module Spree
   module Core
     module QueryFilters
+      # @deprecated This class is deprecated and will be removed in Spree 5.5.
       class Comparable
         def initialize(attribute:)
+          Spree::Deprecation.warn(
+            "#{self.class.name} is deprecated and will be removed in Spree 5.5."
+          )
           @attribute = attribute
         end
 

data/lib/spree/core/query_filters/text.rb

@@ -1,8 +1,12 @@
 module Spree
   module Core
     module QueryFilters
+      # @deprecated This class is deprecated and will be removed in Spree 5.5.
       class Text
         def initialize(attribute:)
+          Spree::Deprecation.warn(
+            'Spree::Core::QueryFilters::Text is deprecated and will be removed in Spree 5.5.'
+          )
           @attribute = attribute
         end
 

data/lib/spree/core/version.rb

@@ -1,5 +1,5 @@
 module Spree
-  VERSION = '5.3.4'.freeze
+  VERSION = '5.4.0.beta'.freeze
 
   def self.version
     VERSION

data/lib/spree/core.rb

@@ -18,6 +18,7 @@ require 'awesome_nested_set'
 require 'cancan'
 require 'countries/global'
 require 'friendly_id'
+require 'jwt'
 require 'monetize'
 require 'mobility'
 require 'name_of_person'
@@ -25,12 +26,12 @@ require 'paranoia'
 require 'ransack'
 require 'state_machines-activerecord'
 require 'active_storage_validations'
-require 'request_store'
 require 'wannabe_bool'
 require 'geocoder'
 require 'oembed'
 require 'safely_block'
 require 'ar_lazy_preload'
+require 'sqids'
 
 # This is required because ActiveModel::Validations#invalid? conflicts with the
 # invalid state of a Payment. In the future this should be removed.
@@ -60,8 +61,6 @@ module Spree
   end
 
   def self.admin_user_class(constantize: true)
-    @@admin_user_class ||= @@user_class
-
     if @@admin_user_class.is_a?(Class)
       raise 'Spree.admin_user_class MUST be a String or Symbol object, not a Class object.'
     elsif @@admin_user_class.is_a?(String) || @@admin_user_class.is_a?(Symbol)
@@ -109,7 +108,8 @@ module Spree
       themes: :default,
       addresses: :default,
       gift_cards: :default,
-      webhooks: :default
+      webhooks: :default,
+      api_keys: :default
     )
   end
 

data/lib/spree/database_type_utilities.rb

@@ -1,9 +1,16 @@
 module Spree
+  # @deprecated Use the integer constant directly instead, eg. `2_147_483_647` for 4-byte signed integer max.
+  #   This module will be removed in Spree 5.5.
   module DatabaseTypeUtilities
     # Maximum value for a 4-byte signed integer (default database integer type)
     INTEGER_MAX = (2**31) - 1
 
     def self.maximum_value_for(data_type)
+      Spree::Deprecation.warn(
+        'Spree::DatabaseTypeUtilities.maximum_value_for is deprecated and will be removed in Spree 5.5. ' \
+        'Use the integer constant directly instead, eg. 2_147_483_647 for 4-byte signed integer max.'
+      )
+
       case data_type
       when :integer
         INTEGER_MAX

data/lib/spree/events.rb

@@ -177,10 +177,11 @@ module Spree
       # Check if events are enabled
       #
       # Events can be temporarily disabled using Spree::Events.disable { ... }
+      # or globally with Spree::Events.disable!
       #
       # @return [Boolean]
       def enabled?
-        !RequestStore.store[:spree_events_disabled]
+        !@globally_disabled && !Thread.current[:spree_events_disabled]
       end
 
       # Temporarily disable events within a block
@@ -195,18 +196,21 @@ module Spree
       #   end
       #
       def disable
-        previous = RequestStore.store[:spree_events_disabled]
-        RequestStore.store[:spree_events_disabled] = true
+        previous = Thread.current[:spree_events_disabled]
+        Thread.current[:spree_events_disabled] = true
         yield
       ensure
-        RequestStore.store[:spree_events_disabled] = previous
+        Thread.current[:spree_events_disabled] = previous
       end
 
       # Globally disable events
-      # Useful for testing to disable events for the entire test suite
+      #
+      # Uses a class-level flag that is not affected by per-request cleanup.
+      # Useful for disabling events for the entire test suite.
+      #
       # @return [void]
       def disable!
-        RequestStore.store[:spree_events_disabled] = true
+        @globally_disabled = true
       end
 
       # Temporarily enable events within a block
@@ -222,18 +226,21 @@ module Spree
       #   end
       #
       def enable
-        previous = RequestStore.store[:spree_events_disabled]
-        RequestStore.store[:spree_events_disabled] = false
+        previous_global = @globally_disabled
+        previous_thread = Thread.current[:spree_events_disabled]
+        @globally_disabled = false
+        Thread.current[:spree_events_disabled] = false
         yield
       ensure
-        RequestStore.store[:spree_events_disabled] = previous
+        @globally_disabled = previous_global
+        Thread.current[:spree_events_disabled] = previous_thread
       end
 
       # Globally enable events
       # Useful for testing
       # @return [void]
       def enable!
-        RequestStore.store[:spree_events_disabled] = false
+        @globally_disabled = false
       end
     end
   end

data/lib/spree/money.rb

@@ -51,17 +51,10 @@ module Spree
     # 1) prevent blank, breaking spaces
     # 2) prevent escaping of HTML character entities
     def to_html(opts = { html: true })
-      # html option is deprecated and we need to fallback to html_wrap
-      opts[:html_wrap] = opts[:html]
       opts.delete(:html)
 
-      output = money.format(options.merge(opts))
-      if opts[:html_wrap]
-        output.gsub!(/<\/?[^>]*>/, '') # we don't want wrap every element in span
-        output = output.sub(' ', '&nbsp;').html_safe
-      end
-
-      output
+      output = money.format(options.merge(opts).merge(html_wrap: false))
+      output.sub(' ', '&nbsp;').html_safe
     end
 
     def as_json(*)