spree_core 4.10.1 → 5.0.0.rc1

data/lib/spree/core/configuration.rb

@@ -16,20 +16,24 @@
 # a.preferred_color
 #
 require 'spree/core/search/base'
-require 'spree/core/preferences/configuration'
+require 'spree/core/preferences/configuration' # for compatibility reasons
+require 'spree/core/preferences/runtime_configuration'
+require 'spree/core/preferences/preferable'
 
 module Spree
   module Core
-    class Configuration < Preferences::Configuration
+    class Configuration < Preferences::RuntimeConfiguration
       # Alphabetized to more easily lookup particular preferences
       preference :address_requires_state, :boolean, default: true, deprecated: true # should state/state_name be required
-      preference :address_requires_phone, :boolean, default: true # Determines whether we require phone in address
+      preference :address_requires_phone, :boolean, default: false # Determines whether we require phone in address
       preference :allow_checkout_on_gateway_error, :boolean, default: false
-      preference :allow_guest_checkout, :boolean, default: true # this is only used in the rails frontend, and is not implemented in API
+      preference :allow_empty_price_amount, :boolean, default: false
+      preference :allow_guest_checkout, :boolean, default: true, deprecated: true # this is only used in the rails frontend, and is not implemented in API
       preference :alternative_shipping_phone, :boolean, default: false # Request extra phone for ship addr
       preference :always_include_confirm_step, :boolean, default: false # Ensures confirmation step is always in checkout_progress bar, but does not force a confirm step if your payment methods do not support it.
       preference :always_put_site_name_in_title, :boolean, deprecated: true
-      preference :auto_capture, :boolean, default: false # automatically capture the credit card (as opposed to just authorize and capture later)
+      preference :always_use_translations, :boolean, default: false
+      preference :auto_capture, :boolean, default: true # automatically capture the credit card (as opposed to just authorize and capture later)
       preference :auto_capture_on_dispatch, :boolean, default: false # Captures payment for each shipment in Shipment#after_ship callback, and makes Shipment.ready when payment authorized.
       preference :binary_inventory_cache, :boolean, default: false, deprecated: true # only invalidate product cache when a stock item changes whether it is in_stock
       preference :checkout_zone, :string, default: nil, deprecated: true # replace with the name of a zone if you would like to limit the countries
@@ -40,13 +44,14 @@ module Spree
       preference :disable_store_presence_validation, :boolean, default: false # when turned off disables Store presence validation for Products and Payment Methods
       preference :expedited_exchanges, :boolean, default: false # NOTE this requires payment profiles to be supported on your gateway of choice as well as a delayed job handler to be configured with activejob. kicks off an exchange shipment upon return authorization save. charge customer if they do not return items within timely manner.
       preference :expedited_exchanges_days_window, :integer, default: 14 # the amount of days the customer has to return their item after the expedited exchange is shipped in order to avoid being charged
+      preference :geocode_addresses, :boolean, default: true
       preference :layout, :string, deprecated: 'Please use Spree::Frontend::Config[:layout] instead'
       preference :logo, :string, deprecated: true
       preference :mailer_logo, :string, deprecated: true
       preference :max_level_in_taxons_menu, :integer, deprecated: true
       preference :non_expiring_credit_types, :array, default: []
       preference :products_per_page, :integer, default: 12
-      preference :require_master_price, :boolean, default: true
+      preference :require_master_price, :boolean, default: false
       preference :restock_inventory, :boolean, default: true # Determines if a return item is restocked automatically once it has been received
       preference :return_eligibility_number_of_days, :integer, default: 365
       preference :send_core_emails, :boolean, default: true # Default mail headers settings
@@ -65,11 +70,9 @@ module Spree
       preference :storefront_taxons_path, :string, default: 't'
       preference :storefront_pages_path, :string, default: 'pages'
 
-      # searcher_class allows spree extension writers to provide their own Search class
-      def searcher_class
-        Spree::Deprecation.warn('`Spree::Config.searcher_class` is deprecated and will be removed in Spree v5, please use `Spree.searcher_class` instead.')
-        @searcher_class ||= Spree.searcher_class
-      end
+      # coupon codes
+      preference :coupon_codes_web_limit, :integer, default: 500 # number of coupon codes to be generated in the web process, more than this will be generated in a background job
+      preference :coupon_codes_total_limit, :integer, default: 5000 # the maximum number of coupon codes to be generated
 
       attr_writer :searcher_class
     end

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

@@ -6,7 +6,6 @@ module Spree
         include Spree::Core::TokenGenerator
 
         included do
-          before_action :set_token
           if defined?(helper_method)
             helper_method :try_spree_current_user
           end
@@ -70,31 +69,6 @@ module Spree
             current_spree_user
           end
         end
-
-        # Redirect as appropriate when an access request fails.  The default action is to redirect to the login screen.
-        # Override this method in your controllers if you want to have special behavior in case the user is not authorized
-        # to access the requested action.  For example, a popup window might simply close itself.
-        def redirect_unauthorized_access
-          Spree::Deprecation.warn(<<-DEPRECATION, caller)
-            Core::ControllerHelpers#redirect_unauthorized_access is deprecated and will be removed in Spree 5.0.
-            This method is implemented differently for Storefront and Admin
-          DEPRECATION
-          if try_spree_current_user
-            flash[:error] = Spree.t(:authorization_failure)
-            redirect_to spree.forbidden_path
-          else
-            store_location
-            if Spree.respond_to?(:admin_path) && request.fullpath.match(Spree.admin_path) && defined?(spree.admin_login_path)
-              redirect_to spree.admin_login_path
-            elsif respond_to?(:spree_login_path)
-              redirect_to spree_login_path
-            elsif spree.respond_to?(:root_path)
-              redirect_to spree.root_path
-            else
-              redirect_to main_app.respond_to?(:root_path) ? main_app.root_path : '/'
-            end
-          end
-        end
       end
     end
   end

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

@@ -11,6 +11,10 @@ module Spree
           end
         end
 
+        def order_token
+          @order_token ||= cookies.signed[:token] || params[:order_token]
+        end
+
         # Used in the link_to_cart helper.
         def simple_current_order
           return @simple_current_order if @simple_current_order
@@ -28,21 +32,29 @@ module Spree
         # The current incomplete order from the token for use in cart and during checkout
         def current_order(options = {})
           options[:create_order_if_necessary] ||= false
-          options[:includes] ||= true
+          options[:includes] ||= false
 
           if @current_order
             @current_order.last_ip_address = ip_address
             return @current_order
           end
 
-          @current_order = find_order_by_token_or_user(options, true)
+          @current_order = find_order_by_token_or_user(options, false)
 
           if options[:create_order_if_necessary] && (@current_order.nil? || @current_order.completed?)
-            @current_order = current_store.orders.create!(current_order_params)
+            @current_order = current_store.orders.create!(current_order_params.except(:token))
             @current_order.associate_user! try_spree_current_user if try_spree_current_user
             @current_order.last_ip_address = ip_address
+
+            create_token_cookie(@current_order.token)
           end
 
+          # There is some edge case where the order doesn't have a token.
+          # but can't reproduce it. So let's generate one on the fly in that case.
+          @current_order.regenerate_token if @current_order && @current_order.token.blank?
+
+          create_token_cookie(@current_order&.token || current_order_params[:token] || params[:token]) if create_cookie_from_token?
+
           @current_order
         end
 
@@ -56,14 +68,26 @@ module Spree
         def set_current_order
           return unless try_spree_current_user && current_order
 
-          orders_scope = try_spree_current_user.orders.
-                         incomplete.
-                         where.not(id: current_order.id).
-                         where(store_id: current_store.id)
+          orders_scope = user_orders_scope
 
-          orders_scope.each do |order|
-            current_order.merge!(order, try_spree_current_user)
+          orders_to_merge = orders_scope.limit(10)
+          order_ids_to_delete = orders_scope.ids - orders_to_merge.ids
+
+          orders_scope_exists = orders_scope.exists?
+
+          if orders_scope.exists?
+            ActiveRecord::Base.connected_to(role: :writing) do
+              orders_to_merge.find_each do |order|
+                current_order.merge!(order, try_spree_current_user)
+              end
+
+              Spree::Order.where(id: order_ids_to_delete).find_each do |order|
+                Rails.logger.error("Failed to destroy order #{order.id} while merging") unless order.destroy
+              end
+            end
           end
+
+          orders_scope_exists
         end
 
         def ip_address
@@ -72,21 +96,49 @@ module Spree
 
         private
 
+        def user_orders_scope
+          try_spree_current_user.orders.
+            incomplete.
+            not_canceled.
+            where.not(id: current_order.id).
+            where(store_id: current_store.id)
+        end
+
+        def create_cookie_from_token?
+          cookies.signed[:token].blank? &&
+            (current_order_params[:token].present? || params[:token].present?)
+        end
+
+        def checkout_complete_path?
+          request.path == spree.checkout_complete_path(current_order_params[:token] || params[:token])
+        end
+
+        def create_token_cookie(token)
+          cookies.signed[:token] = {
+            value: token,
+            expires: 90.days.from_now,
+            secure: Rails.configuration.force_ssl || Rails.application.config.ssl_options[:secure_cookies],
+            domain: current_store.url_or_custom_domain
+          }
+        end
+
         def last_incomplete_order(includes = {})
           @last_incomplete_order ||= try_spree_current_user.last_incomplete_spree_order(current_store, includes: includes)
         end
 
         def current_order_params
-          { currency: current_currency, token: cookies.signed[:token], user_id: try_spree_current_user.try(:id) }
+          @current_order_params ||= { currency: current_currency, token: order_token, user_id: try_spree_current_user.try(:id) }
         end
 
         def find_order_by_token_or_user(options = {}, with_adjustments = false)
+          return nil if try_spree_current_user.nil? && order_token.blank?
+
           options[:lock] ||= false
 
           includes = options[:includes] ? order_includes : {}
 
           # Find any incomplete orders for the token
-          incomplete_orders = current_store.orders.incomplete.includes(includes)
+          incomplete_orders = current_store.orders.incomplete.not_canceled.includes(includes)
 
           token_order_params = current_order_params.except(:user_id)
           order = if with_adjustments
@@ -102,7 +154,20 @@ module Spree
         end
 
         def order_includes
-          { line_items: [variant: [:images, :option_values, :product]] }
+          {
+            line_items: {
+              variant: [
+                :images,
+                :prices,
+                :default_price,
+                :stock_items,
+                :stock_locations,
+                { option_values: :option_type },
+                { stock_items: :stock_location },
+                { product: :master }
+              ]
+            }
+          }
         end
       end
     end

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

@@ -3,6 +3,8 @@ module Spree
     module ControllerHelpers
       module Search
         def build_searcher(params)
+          Spree::Deprecation.warn("Spree::Core::ControllerHelpers::Search is deprecated and will be removed in Spree 6.")
+
           Spree.searcher_class.new(params).tap do |searcher|
             searcher.current_user = try_spree_current_user
             searcher.current_currency = current_currency&.upcase

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

@@ -8,7 +8,6 @@ module Spree
           if defined?(helper_method)
             helper_method :current_store
             helper_method :current_price_options
-            helper_method :available_menus
           end
         end
 
@@ -16,10 +15,6 @@ module Spree
           @current_store ||= current_store_finder.new(url: request.env['SERVER_NAME']).execute
         end
 
-        def available_menus
-          @available_menus ||= current_store.menus
-        end
-
         def store_locale
           current_store.default_locale
         end

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

@@ -37,6 +37,10 @@ module Spree
             product_properties_attributes: permitted_product_properties_attributes
           ]
         end
+
+        def permitted_store_attributes
+          permitted_attributes.store_attributes + Spree::Store::SUPPORTED_SOCIAL_NETWORKS.map { |social| "store_#{social}" }
+        end
       end
     end
   end

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

@@ -0,0 +1,19 @@
+module Spree
+  module Core
+    module ControllerHelpers
+      module Turbo
+        extend ActiveSupport::Concern
+
+        included do
+          if defined?(helper_method)
+            helper_method :turbo_frame_request?, :turbo_stream_request?
+          end
+        end
+
+        def turbo_stream_request?
+          request.format.turbo_stream?
+        end
+      end
+    end
+  end
+end

data/lib/spree/core/dependencies.rb

@@ -21,6 +21,7 @@ module Spree
         cart_destroy_service: 'Spree::Cart::Destroy',
         cart_associate_service: 'Spree::Cart::Associate',
         cart_change_currency_service: 'Spree::Cart::ChangeCurrency',
+        cart_remove_out_of_stock_items_service: 'Spree::Cart::RemoveOutOfStockItems',
 
         # checkout
         checkout_next_service: 'Spree::Checkout::Next',
@@ -79,9 +80,6 @@ module Spree
 
         payment_create_service: 'Spree::Payments::Create',
 
-        # errors
-        error_handler: 'Spree::ErrorReporter',
-
         # data feeds
         data_feeds_google_rss_service: 'Spree::DataFeeds::Google::Rss',
         data_feeds_google_optional_attributes_service: 'Spree::DataFeeds::Google::OptionalAttributes',
@@ -92,8 +90,8 @@ module Spree
         # finders
         address_finder: 'Spree::Addresses::Find',
         country_finder: 'Spree::Countries::Find',
-        cms_page_finder: 'Spree::CmsPages::Find',
-        menu_finder: 'Spree::Menus::Find',
+        cms_page_finder: 'Spree::CmsPages::Find', # LEGACY
+        menu_finder: 'Spree::Menus::Find', # LEGACY
         current_order_finder: 'Spree::Orders::FindCurrent',
         current_store_finder: 'Spree::Stores::FindCurrent',
         completed_order_finder: 'Spree::Orders::FindComplete',

data/lib/spree/core/engine.rb

@@ -1,20 +1,28 @@
 require_relative 'dependencies'
 require_relative 'configuration'
-require_relative 'runtime_configuration'
 
 module Spree
   module Core
     class Engine < ::Rails::Engine
       Environment = Struct.new(:calculators,
                                :preferences,
-                               :runtime_preferences,
                                :dependencies,
                                :payment_methods,
                                :adjusters,
                                :stock_splitters,
                                :promotions,
                                :line_item_comparison_hooks,
-                               :data_feed_types)
+                               :data_feed_types,
+                               :export_types,
+                               :taxon_rules,
+                               :themes,
+                               :theme_layout_sections,
+                               :pages,
+                               :page_sections,
+                               :page_blocks,
+                               :reports,
+                               :analytics_events,
+                               :analytics_event_handlers)
       SpreeCalculators = Struct.new(:shipping_methods, :tax_rates, :promotion_actions_create_adjustments, :promotion_actions_create_item_adjustments)
       PromoEnvironment = Struct.new(:rules, :actions)
       isolate_namespace Spree
@@ -25,11 +33,12 @@ module Spree
       end
 
       initializer 'spree.environment', before: :load_config_initializers do |app|
-        app.config.spree = Environment.new(SpreeCalculators.new, Spree::Core::Configuration.new, Spree::Core::RuntimeConfiguration.new, Spree::Core::Dependencies.new)
+        app.config.spree = Environment.new(SpreeCalculators.new, Spree::Core::Configuration.new, Spree::Core::Dependencies.new)
+
         app.config.active_record.yaml_column_permitted_classes ||= []
-        app.config.active_record.yaml_column_permitted_classes << [Symbol, BigDecimal, ActiveSupport::HashWithIndifferentAccess]
+        app.config.active_record.yaml_column_permitted_classes.concat([Symbol, BigDecimal, ActiveSupport::HashWithIndifferentAccess])
         Spree::Config = app.config.spree.preferences
-        Spree::RuntimeConfig = app.config.spree.runtime_preferences
+        Spree::RuntimeConfig = app.config.spree.preferences # for compatibility
         Spree::Dependencies = app.config.spree.dependencies
         Spree::Deprecation = ActiveSupport::Deprecation.new
       end
@@ -111,6 +120,8 @@ module Spree
         ]
 
         Rails.application.config.spree.promotions.rules.concat [
+          Spree::Promotion::Rules::Currency,
+          Spree::Promotion::Rules::Country,
           Spree::Promotion::Rules::ItemTotal,
           Spree::Promotion::Rules::Product,
           Spree::Promotion::Rules::User,
@@ -119,7 +130,6 @@ module Spree
           Spree::Promotion::Rules::OneUsePerUser,
           Spree::Promotion::Rules::Taxon,
           Spree::Promotion::Rules::OptionValue,
-          Spree::Promotion::Rules::Country
         ]
 
         Rails.application.config.spree.promotions.actions = [
@@ -132,6 +142,131 @@ module Spree
         Rails.application.config.spree.data_feed_types = [
           Spree::DataFeed::Google
         ]
+
+        Rails.application.config.spree.export_types = [
+          Spree::Exports::Products,
+          Spree::Exports::Orders
+        ]
+
+        Rails.application.config.spree.taxon_rules = [
+          Spree::TaxonRules::Tag,
+          Spree::TaxonRules::AvailableOn,
+          Spree::TaxonRules::Sale,
+        ]
+
+        Rails.application.config.spree.themes = [
+          Spree::Themes::Default
+        ]
+
+        Rails.application.config.spree.theme_layout_sections = [
+          Spree::PageSections::AnnouncementBar,
+          Spree::PageSections::Header,
+          Spree::PageSections::Newsletter,
+          Spree::PageSections::Footer
+        ]
+
+        Rails.application.config.spree.pages = [
+          Spree::Pages::Cart,
+          Spree::Pages::Post,
+          Spree::Pages::TaxonList,
+          Spree::Pages::Custom,
+          Spree::Pages::ProductDetails,
+          Spree::Pages::ShopAll,
+          Spree::Pages::Taxon,
+          Spree::Pages::Wishlist,
+          Spree::Pages::SearchResults,
+          Spree::Pages::Checkout,
+          Spree::Pages::Password,
+          Spree::Pages::Homepage,
+          Spree::Pages::Login,
+          Spree::Pages::PostList,
+          Spree::Pages::Account
+        ]
+
+        Rails.application.config.spree.page_sections = [
+          Spree::PageSections::FeaturedPosts,
+          Spree::PageSections::TaxonGrid,
+          Spree::PageSections::ImageWithText,
+          Spree::PageSections::FeaturedTaxon,
+          Spree::PageSections::CollectionBanner,
+          Spree::PageSections::ProductDetails,
+          Spree::PageSections::MainPasswordFooter,
+          Spree::PageSections::RelatedProducts,
+          Spree::PageSections::CustomCode,
+          Spree::PageSections::TaxonBanner,
+          Spree::PageSections::FeaturedProduct,
+          Spree::PageSections::ProductGrid,
+          Spree::PageSections::ImageBanner,
+          Spree::PageSections::PageTitle,
+          Spree::PageSections::MainPasswordHeader,
+          Spree::PageSections::PostDetails,
+          Spree::PageSections::PostGrid,
+          Spree::PageSections::FeaturedTaxons,
+          Spree::PageSections::RichText,
+          Spree::PageSections::Video,
+          Spree::PageSections::Footer,
+          Spree::PageSections::Newsletter,
+          Spree::PageSections::Header,
+          Spree::PageSections::AnnouncementBar
+        ]
+
+        Rails.application.config.spree.page_blocks = [
+          Spree::PageBlocks::Link,
+          Spree::PageBlocks::MegaNav,
+          Spree::PageBlocks::MegaNavWithSubcategories,
+          Spree::PageBlocks::Subheading,
+          Spree::PageBlocks::Heading,
+          Spree::PageBlocks::Nav,
+          Spree::PageBlocks::Buttons,
+          Spree::PageBlocks::Text,
+          Spree::PageBlocks::NewsletterForm,
+          Spree::PageBlocks::Image,
+          Spree::PageBlocks::Products::Title,
+          Spree::PageBlocks::Products::Share,
+          Spree::PageBlocks::Products::Price,
+          Spree::PageBlocks::Products::QuantitySelector,
+          Spree::PageBlocks::Products::VariantPicker,
+          Spree::PageBlocks::Products::BuyButtons
+        ]
+
+        Rails.application.config.spree.reports = [
+          Spree::Reports::ProductsPerformance,
+          Spree::Reports::SalesTotal
+        ]
+
+        Rails.application.config.spree.analytics_events = {
+          product_viewed: 'Product Viewed',
+          product_list_viewed: 'Product List Viewed',
+          product_searched: 'Product Searched',
+          product_added: 'Product Added',
+          product_removed: 'Product Removed',
+
+          product_added_to_wishlist: 'Product Added to Wishlist',
+          product_removed_from_wishlist: 'Product Removed from Wishlist',
+
+          subscribed_to_newsletter: 'Subscribed to Newsletter',
+          unsubscribed_from_newsletter: 'Unsubscribed from Newsletter',
+
+          payment_info_entered: 'Payment Info Entered',
+          coupon_entered: 'Coupon Entered',
+          coupon_removed: 'Coupon Removed',
+          coupon_applied: 'Coupon Applied',
+          coupon_denied: 'Coupon Denied',
+
+          checkout_started: 'Checkout Started',
+          checkout_email_entered: 'Checkout Email Entered',
+          checkout_step_viewed: 'Checkout Step Viewed',
+          checkout_step_completed: 'Checkout Step Completed',
+
+          order_completed: 'Order Completed',
+          order_cancelled: 'Order Cancelled',
+          order_refunded: 'Order Refunded',
+          package_shipped: 'Package Shipped',
+          order_fulfilled: 'Order Fulfilled',
+
+          gift_card_issued: 'Gift Card Issued'
+        }
+        Rails.application.config.spree.analytics_event_handlers = []
       end
 
       initializer 'spree.promo.register.promotions.actions' do |app|
@@ -154,6 +289,22 @@ module Spree
         Migrations.new(config, engine_name).check
       end
 
+      initializer 'spree.core.assets' do |app|
+        if app.config.respond_to?(:assets)
+          app.config.assets.paths << root.join('app/javascript')
+          app.config.assets.paths << root.join('vendor/javascript')
+          app.config.assets.precompile += %w[spree_core_manifest]
+        end
+      end
+
+      initializer 'spree.core.importmap', before: 'importmap' do |app|
+        if app.config.respond_to?(:importmap)
+          app.config.importmap.paths << root.join('config/importmap.rb')
+          # https://github.com/rails/importmap-rails?tab=readme-ov-file#sweeping-the-cache-in-development-and-test
+          app.config.importmap.cache_sweepers << root.join('app/javascript')
+        end
+      end
+
       config.to_prepare do
         # Ensure spree locale paths are present before decorators
         I18n.load_path.unshift(*(Dir.glob(

data/lib/spree/core/preferences/configuration.rb

@@ -21,51 +21,9 @@
 #
 #
 
-require 'spree/core/preferences/preferable'
+require_relative 'runtime_configuration'
 
 module Spree::Preferences
-  class Configuration
-    include Spree::Preferences::Preferable
-
-    def configure
-      yield(self) if block_given?
-    end
-
-    def preferences
-      ::Spree::Preferences::ScopedStore.new(self.class.name.underscore)
-    end
-
-    def reset
-      preferences.each do |name, _value|
-        set_preference name, preference_default(name)
-      end
-    end
-
-    alias [] get_preference
-    alias []= set_preference
-
-    alias get get_preference
-
-    def set(*args)
-      options = args.extract_options!
-      options.each do |name, value|
-        set_preference name, value
-      end
-
-      set_preference args[0], args[1] if args.size == 2
-    end
-
-    def method_missing(method, *args)
-      name = method.to_s.delete('=')
-      if has_preference? name
-        if method.to_s =~ /=$/
-          set_preference(name, args.first)
-        else
-          get_preference name
-        end
-      else
-        super
-      end
-    end
+  class Configuration < Spree::Preferences::RuntimeConfiguration
   end
 end

data/lib/spree/core/preferences/preferable.rb

@@ -38,6 +38,7 @@ module Spree::Preferences::Preferable
   extend ActiveSupport::Concern
 
   included do
+    serialize :preferences, type: Hash, coder: YAML if defined?(serialize)
     extend Spree::Preferences::PreferableClassMethods
   end
 
@@ -95,10 +96,18 @@ module Spree::Preferences::Preferable
     ]
   end
 
+  def preferences_of_type(type)
+    defined_preferences.find_all { |preference| preference_type(preference) == type.to_sym }
+  end
+
   def clear_preferences
     preferences.keys.each { |pref| preferences.delete pref }
   end
 
+  def restore_preferences_for(preference_keys)
+    preference_keys.each { |pref| preferences[pref] = preference_default(pref) }
+  end
+
   private
 
   def convert_preference_value(value, type, nullable: false)