spree_core 5.0.4 → 5.1.0.beta2

data/db/migrate/20250508060800_add_selected_locale_to_spree_admin_users.rb

@@ -0,0 +1,8 @@
+class AddSelectedLocaleToSpreeAdminUsers < ActiveRecord::Migration[7.2]
+  def change
+    if Spree.admin_user_class.present?
+      users_table_name = Spree.admin_user_class.table_name
+      add_column users_table_name, :selected_locale, :string unless column_exists?(users_table_name, :selected_locale)
+    end
+  end
+end

data/db/migrate/20250509143831_add_session_id_to_spree_assets.rb

@@ -0,0 +1,5 @@
+class AddSessionIdToSpreeAssets < ActiveRecord::Migration[7.2]
+  def change
+    add_column :spree_assets, :session_id, :string
+  end
+end

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

@@ -33,6 +33,8 @@ module Spree
     include Spree::UserPaymentSource
             RUBY
           end
+          gsub_file user_class_file, "< ApplicationRecord", "< Spree.base_class"
+
           say "Successfully added Spree user modules into #{user_class_file}"
         else
           say "Could not locate user model file at #{user_class_file}. Please add these lines manually:", :red
@@ -42,13 +44,14 @@ module Spree
             include Spree::UserMethods
             include Spree::UserPaymentSource
           RUBY
+
+          say "Please replace < ApplicationRecord with < Spree.base_class in #{user_class_file}"
         end
 
         append_file 'config/initializers/spree.rb' do
           %Q{
             if defined?(Devise) && Devise.respond_to?(:parent_controller)
-              Devise.parent_controller = "Spree::StoreController"
-              Devise.parent_mailer = "Spree::BaseMailer"
+              Devise.parent_controller = "Spree::BaseController"
             end\n}
         end
       end

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

@@ -38,13 +38,13 @@ module Spree
     end
 
     def spree_admin_login_path(opts = {})
-      spree_login_path(opts)
+      new_session_path(Spree.admin_user_class.model_name.singular_route_key, opts)
     end
 
     def spree_admin_logout_path(opts = {})
-      spree_logout_path(opts)
+      destroy_session_path(Spree.admin_user_class.model_name.singular_route_key, opts)
     end
   end
 end
 
-ApplicationController.include Spree::AuthenticationHelpers if defined?(ApplicationController)
+ApplicationController.include Spree::AuthenticationHelpers if defined?(ApplicationController)

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

@@ -54,8 +54,8 @@ module Spree
       template 'rails/application.rb', "#{dummy_path}/config/application.rb", force: true
       template 'rails/routes.rb', "#{dummy_path}/config/routes.rb", force: true
       template 'rails/test.rb', "#{dummy_path}/config/environments/test.rb", force: true
-      template 'rails/script/rails', "#{dummy_path}/spec/dummy/script/rails", force: true
       template 'initializers/devise.rb', "#{dummy_path}/config/initializers/devise.rb", force: true
+      template "app/assets/config/manifest.js", "#{dummy_path}/app/assets/config/manifest.js", force: true
     end
 
     def test_dummy_inject_extension_requirements

data/lib/generators/spree/dummy/templates/rails/application.rb

@@ -2,9 +2,8 @@ require File.expand_path('../boot', __FILE__)
 
 require 'rails/all'
 
-Bundler.require(*Rails.groups(assets: %w(development test)))
+Bundler.require(*Rails.groups)
 
 require '<%= lib_name %>'
 
 <%= application_definition %>
-

data/lib/generators/spree/install/install_generator.rb

@@ -78,6 +78,11 @@ module Spree
     def install_storefront
       if @install_storefront && Spree::Core::Engine.frontend_available?
         generate 'spree:storefront:install'
+
+        # generate devise controllers if authentication is devise
+        if @authentication == 'devise'
+          generate 'spree:storefront:devise'
+        end
       end
     end
 

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

@@ -17,12 +17,12 @@ module Spree
 
         # Needs to be overridden so that we use Spree's Ability rather than anyone else's.
         def current_ability
-          @current_ability ||= Spree::Dependencies.ability_class.constantize.new(try_spree_current_user)
+          @current_ability ||= Spree::Dependencies.ability_class.constantize.new(try_spree_current_user, { store: current_store })
         end
 
         def redirect_back_or_default(default)
-          redirect_to(session['spree_user_return_to'] || request.env['HTTP_REFERER'] || default)
-          session['spree_user_return_to'] = nil
+          Spree::Deprecation.warn('redirect_back_or_default is deprecated and will be removed in Spree 5.2. Please use redirect_back(fallback_location: default) instead.')
+          redirect_back(fallback_location: default)
         end
 
         def set_token
@@ -44,18 +44,19 @@ module Spree
           @current_oauth_token ||= get_last_access_token.call(user) || create_access_token.call(user)
         end
 
-        def store_location
-          # disallow return to login, logout, signup pages
-          authentication_routes = [:spree_signup_path, :spree_login_path, :spree_logout_path]
-          disallowed_urls = []
-          authentication_routes.each do |route|
-            disallowed_urls << send(route) if respond_to?(route)
-          end
+        # this will work for devise out of the box
+        # for other auth systems you will need to override this method
+        def store_location(location = nil)
+          return if try_spree_current_user
 
-          disallowed_urls.map! { |url| url[/\/\w+$/] }
-          unless disallowed_urls.include?(request.fullpath)
-            session['spree_user_return_to'] = request.fullpath.gsub('//', '/')
-          end
+          location ||= request.fullpath
+          session_key = store_location_session_key
+
+          session[session_key] = location
+        end
+
+        def store_location_session_key
+          "#{Spree.user_class.model_name.singular_route_key.to_sym}_return_to"
         end
 
         # proxy method to *possible* spree_current_user method

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

@@ -2,77 +2,6 @@ module Spree
   module Core
     module ControllerHelpers
       module Common
-        extend ActiveSupport::Concern
-        included do
-          helper_method :title
-          helper_method :title=
-          helper_method :accurate_title
-
-          layout :get_layout
-
-          protected
-
-          # can be used in views as well as controllers.
-          # e.g. <% self.title = 'This is a custom title for this view' %>
-          attr_writer :title
-
-          def title
-            Spree::Deprecation.warn(<<-DEPRECATION, caller)
-              ControllerHelpers::Common is deprecated and will be removed in Spree 5.0.
-            DEPRECATION
-            title_string = @title.present? ? @title : accurate_title
-            if title_string.present?
-              if Spree::Config[:always_put_site_name_in_title] && !title_string.include?(default_title)
-                [title_string, default_title].join(" #{Spree::Config[:title_site_name_separator]} ")
-              else
-                title_string
-              end
-            else
-              default_title
-            end
-          end
-
-          def default_title
-            Spree::Deprecation.warn(<<-DEPRECATION, caller)
-              ControllerHelpers::Common is deprecated and will be removed in Spree 5.0.
-            DEPRECATION
-            current_store.name
-          end
-
-          # this is a hook for subclasses to provide title
-          def accurate_title
-            Spree::Deprecation.warn(<<-DEPRECATION, caller)
-              ControllerHelpers::Common is deprecated and will be removed in Spree 5.0.
-            DEPRECATION
-            current_store.seo_title
-          end
-
-          private
-
-          def set_user_language
-            Spree::Deprecation.warn(<<-DEPRECATION, caller)
-              ControllerHelpers::Common#set_user_language is deprecated and will be removed in Spree 5.0.
-              Please use `before_action :set_locale` instead
-            DEPRECATION
-
-            set_locale
-          end
-
-          # Returns which layout to render.
-          #
-          # You can set the layout you want to render inside your Spree configuration with the +:layout+ option.
-          #
-          # Default layout is: +app/views/spree/layouts/spree_application+
-          #
-          def get_layout
-            Spree::Deprecation.warn(<<-DEPRECATION, caller)
-              ControllerHelpers::Common is deprecated and will be removed in Spree 5.0.
-            DEPRECATION
-            return unless defined?(Spree::Frontend)
-
-            layout ||= Spree::Frontend::Config[:layout]
-          end
-        end
       end
     end
   end

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

@@ -14,6 +14,8 @@ module Spree
           end
         end
 
+        # Returns the currently selected currency.
+        # @return [String] the currently selected currency, eg. `USD`
         def current_currency
           @current_currency ||= if defined?(session) && session.key?(:currency) && supported_currency?(session[:currency])
                                   session[:currency]
@@ -26,10 +28,14 @@ module Spree
                                 end&.upcase
         end
 
+        # Returns the list of supported currencies for the current store.
+        # @return [Array<Money::Currency>] the list of supported currencies
         def supported_currencies
           @supported_currencies ||= current_store&.supported_currencies_list
         end
 
+        # Returns the list of supported currencies for all stores.
+        # @return [Array<String>] the list of supported currencies, eg. `["USD", "EUR"]`
         def supported_currencies_for_all_stores
           @supported_currencies_for_all_stores ||= begin
             (
@@ -39,12 +45,17 @@ module Spree
           end
         end
 
+        # Checks if the given currency is supported.
+        # @param currency_iso_code [String] the ISO code of the currency, eg. `USD`
+        # @return [Boolean] `true` if the currency is supported, `false` otherwise
         def supported_currency?(currency_iso_code)
           return false if supported_currencies.nil?
 
           supported_currencies.map(&:iso_code).include?(currency_iso_code.upcase)
         end
 
+        # Returns the currency parameter from the request.
+        # @return [String] the currency parameter, eg. `USD`
         def currency_param
           return if current_currency == current_store.default_currency
 

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

@@ -33,8 +33,9 @@ module Spree
 
         def permitted_product_attributes
           permitted_attributes.product_attributes + [
-            :store_id,
-            product_properties_attributes: permitted_product_properties_attributes
+            variants_attributes: permitted_variant_attributes + ['id', :_destroy],
+            master_attributes: permitted_variant_attributes + ['id'],
+            product_properties_attributes: permitted_product_properties_attributes + ['id', :_destroy]
           ]
         end
 

data/lib/spree/core/engine.rb

@@ -21,8 +21,10 @@ module Spree
                                :page_sections,
                                :page_blocks,
                                :reports,
+                               :translatable_resources,
                                :analytics_events,
-                               :analytics_event_handlers)
+                               :analytics_event_handlers,
+                               :integrations)
       SpreeCalculators = Struct.new(:shipping_methods, :tax_rates, :promotion_actions_create_adjustments, :promotion_actions_create_item_adjustments)
       PromoEnvironment = Struct.new(:rules, :actions)
       isolate_namespace Spree
@@ -40,7 +42,7 @@ module Spree
         Spree::Config = app.config.spree.preferences
         Spree::RuntimeConfig = app.config.spree.preferences # for compatibility
         Spree::Dependencies = app.config.spree.dependencies
-        Spree::Deprecation = ActiveSupport::Deprecation.new
+        Spree::Deprecation = ActiveSupport::Deprecation.new('6.0', 'Spree')
       end
 
       initializer 'spree.register.calculators', before: :after_initialize do |app|
@@ -234,6 +236,13 @@ module Spree
           Spree::Reports::SalesTotal
         ]
 
+        Rails.application.config.spree.translatable_resources = [
+          Spree::Product,
+          Spree::Taxon,
+          Spree::Taxonomy,
+          Spree::Store
+        ]
+
         Rails.application.config.spree.analytics_events = {
           product_viewed: 'Product Viewed',
           product_list_viewed: 'Product List Viewed',
@@ -257,9 +266,11 @@ module Spree
           checkout_email_entered: 'Checkout Email Entered',
           checkout_step_viewed: 'Checkout Step Viewed',
           checkout_step_completed: 'Checkout Step Completed',
-          order_completed: 'Order Completed'
+          order_completed: 'Order Completed',
         }
         Rails.application.config.spree.analytics_event_handlers = []
+
+        Rails.application.config.spree.integrations = []
       end
 
       initializer 'spree.promo.register.promotions.actions' do |app|

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

@@ -108,6 +108,16 @@ module Spree::Preferences::Preferable
     preference_keys.each { |pref| preferences[pref] = preference_default(pref) }
   end
 
+  def preference_change(name, changes_or_previous_changes)
+    preference_changes = changes_or_previous_changes.with_indifferent_access.fetch('preferences', [{}, {}])
+    before_preferences = preference_changes[0] || {}
+    after_preferences = preference_changes[1] || {}
+
+    return if before_preferences[name] == after_preferences[name]
+
+    [before_preferences[name], after_preferences[name]]
+  end
+
   private
 
   def convert_preference_value(value, type, nullable: false)

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

@@ -43,6 +43,34 @@ module Spree::Preferences
       define_method prefers_query_method(name) do
         preferences.fetch(name).to_b
       end
+
+      define_method preference_change_method(name) do
+        preference_change(name, changes) if respond_to?(:changes)
+      end
+
+      define_method preference_was_method(name) do
+        return unless respond_to?(:changes)
+
+        preference_change(name, changes)&.first || get_preference(name)
+      end
+
+      define_method preference_changed_method(name) do
+        respond_to?(:changes) && preference_change(name, changes).present?
+      end
+
+      define_method preference_previous_change_method(name) do
+        preference_change(name, previous_changes) if respond_to?(:previous_changes)
+      end
+
+      define_method preference_previous_was_method(name) do
+        return unless respond_to?(:previous_changes)
+
+        preference_change(name, previous_changes)&.first
+      end
+
+      define_method preference_previous_changed_method(name) do
+        respond_to?(:previous_changes) && preference_change(name, previous_changes).present?
+      end
     end
 
     def preference_getter_method(name)
@@ -68,5 +96,29 @@ module Spree::Preferences
     def prefers_query_method(name)
       "prefers_#{name}?".to_sym
     end
+
+    def preference_change_method(name)
+      "preferred_#{name}_change".to_sym
+    end
+
+    def preference_was_method(name)
+      "preferred_#{name}_was".to_sym
+    end
+
+    def preference_changed_method(name)
+      "preferred_#{name}_changed?".to_sym
+    end
+
+    def preference_previous_change_method(name)
+      "preferred_#{name}_previous_change".to_sym
+    end
+
+    def preference_previous_was_method(name)
+      "preferred_#{name}_previously_was".to_sym
+    end
+
+    def preference_previous_changed_method(name)
+      "preferred_#{name}_previously_changed?".to_sym
+    end
   end
 end

data/lib/spree/core/version.rb

@@ -1,5 +1,5 @@
 module Spree
-  VERSION = '5.0.4'.freeze
+  VERSION = '5.1.0.beta2'.freeze
 
   def self.version
     VERSION

data/lib/spree/core.rb

@@ -31,6 +31,7 @@ require 'request_store'
 require 'wannabe_bool'
 require 'geocoder'
 require 'oembed'
+require 'safely_block'
 
 # This is required because ActiveModel::Validations#invalid? conflicts with the
 # invalid state of a Payment. In the future this should be removed.