spree_core 4.10.1 → 5.0.0.rc1

data/db/migrate/20250312202705_add_unique_index_on_promotion_rules_associations.rb

@@ -0,0 +1,75 @@
+class AddUniqueIndexOnPromotionRulesAssociations < ActiveRecord::Migration[7.2]
+  def change
+    if ActiveRecord::Base.connection.adapter_name == 'Mysql2'
+      # Remove duplicate product promotion rules
+      execute <<-SQL
+        DELETE FROM spree_product_promotion_rules
+        WHERE id NOT IN (
+          SELECT mid FROM (
+            SELECT MIN(id) AS mid
+            FROM spree_product_promotion_rules
+            GROUP BY product_id, promotion_rule_id
+          ) AS min_ids
+        );
+      SQL
+
+      # Remove duplicate taxon promotion rules
+      execute <<-SQL
+        DELETE FROM spree_promotion_rule_taxons
+        WHERE id NOT IN (
+          SELECT mid FROM (
+            SELECT MIN(id) AS mid
+            FROM spree_promotion_rule_taxons
+            GROUP BY taxon_id, promotion_rule_id
+          ) AS min_ids
+        );
+      SQL
+
+      # Remove duplicate user promotion rules
+      execute <<-SQL
+        DELETE FROM spree_promotion_rule_users
+        WHERE id NOT IN (
+          SELECT mid FROM (
+            SELECT MIN(id) AS mid
+            FROM spree_promotion_rule_users
+            GROUP BY user_id, promotion_rule_id
+          ) AS min_ids
+        );
+      SQL
+    else
+      # Remove duplicate product promotion rules
+      execute <<-SQL
+        DELETE FROM spree_product_promotion_rules
+        WHERE id NOT IN (
+          SELECT MIN(id)
+          FROM spree_product_promotion_rules
+          GROUP BY product_id, promotion_rule_id
+        );
+      SQL
+
+      # Remove duplicate taxon promotion rules
+      execute <<-SQL
+        DELETE FROM spree_promotion_rule_taxons
+        WHERE id NOT IN (
+          SELECT MIN(id)
+          FROM spree_promotion_rule_taxons
+          GROUP BY taxon_id, promotion_rule_id
+        );
+      SQL
+
+      # Remove duplicate user promotion rules
+      execute <<-SQL
+        DELETE FROM spree_promotion_rule_users
+        WHERE id NOT IN (
+          SELECT MIN(id)
+          FROM spree_promotion_rule_users
+          GROUP BY user_id, promotion_rule_id
+        );
+      SQL
+    end
+
+    add_index :spree_product_promotion_rules, [:product_id, :promotion_rule_id], unique: true
+    add_index :spree_promotion_rule_taxons, [:taxon_id, :promotion_rule_id], unique: true
+    add_index :spree_promotion_rule_users, [:user_id, :promotion_rule_id], unique: true
+  end
+end

data/db/migrate/20250313104226_add_user_type_to_spree_role_users.rb

@@ -0,0 +1,18 @@
+class AddUserTypeToSpreeRoleUsers < ActiveRecord::Migration[6.1]
+  def up
+    unless column_exists?(:spree_role_users, :user_type)
+      add_column :spree_role_users, :user_type, :string
+      add_index :spree_role_users, :user_type
+
+      user_class_name = Spree.admin_user_class.to_s
+      Spree::RoleUser.where(user_type: nil).update_all(user_type: user_class_name)
+
+      change_column_null :spree_role_users, :user_type, false
+    end
+  end
+
+  def down
+    remove_index :spree_role_users, :user_type, if_exists: true
+    remove_column :spree_role_users, :user_type, if_exists: true
+  end
+end

data/db/migrate/20250313175830_add_unique_index_on_promotion_action_line_items.rb

@@ -0,0 +1,29 @@
+class AddUniqueIndexOnPromotionActionLineItems < ActiveRecord::Migration[7.2]
+  def change
+    if ActiveRecord::Base.connection.adapter_name == 'Mysql2'
+      # Remove duplicate promotion action line items
+      execute <<-SQL
+        DELETE FROM spree_promotion_action_line_items
+        WHERE id NOT IN (
+          SELECT mid FROM (
+            SELECT MIN(id) AS mid
+            FROM spree_promotion_action_line_items
+            GROUP BY promotion_action_id, variant_id
+          ) AS min_ids
+        );
+      SQL
+    else
+      # Remove duplicate promotion action line items
+      execute <<-SQL
+        DELETE FROM spree_promotion_action_line_items
+        WHERE id NOT IN (
+          SELECT MIN(id)
+          FROM spree_promotion_action_line_items
+          GROUP BY promotion_action_id, variant_id
+        );
+      SQL
+    end
+
+    add_index :spree_promotion_action_line_items, [:promotion_action_id, :variant_id], unique: true
+  end
+end

data/db/migrate/20250314144210_create_spree_taggings_and_spree_tags.rb

@@ -0,0 +1,38 @@
+class CreateSpreeTaggingsAndSpreeTags < ActiveRecord::Migration[7.2]
+  def change
+    create_table :spree_taggings do |t|
+      t.bigint "tag_id"
+      t.string "taggable_type"
+      t.bigint "taggable_id"
+      t.string "tagger_type"
+      t.bigint "tagger_id"
+      t.string "context", limit: 128
+      t.datetime "created_at", precision: nil
+      t.string "tenant", limit: 128
+      t.index ["context"], name: "index_spree_taggings_on_context"
+      t.index ["tag_id", "taggable_id", "taggable_type", "context", "tagger_id", "tagger_type"], name: "spree_taggings_idx", unique: true
+      t.index ["tag_id"], name: "index_spree_taggings_on_tag_id"
+      t.index ["taggable_id", "taggable_type", "context"], name: "spree_taggings_taggable_context_idx"
+      t.index ["taggable_id", "taggable_type", "tagger_id", "context"], name: "spree_taggings_idy"
+      t.index ["taggable_id"], name: "index_spree_taggings_on_taggable_id"
+      t.index ["taggable_type", "taggable_id"], name: "index_spree_taggings_on_taggable_type_and_taggable_id"
+      t.index ["taggable_type"], name: "index_spree_taggings_on_taggable_type"
+      t.index ["tagger_id", "tagger_type"], name: "index_spree_taggings_on_tagger_id_and_tagger_type"
+      t.index ["tagger_id"], name: "index_spree_taggings_on_tagger_id"
+      t.index ["tagger_type", "tagger_id"], name: "index_spree_taggings_on_tagger_type_and_tagger_id"
+      t.index ["tenant"], name: "index_spree_taggings_on_tenant"
+    end
+
+    create_table :spree_tags do |t|
+      t.string "name"
+      t.datetime "created_at", null: false
+      t.datetime "updated_at", null: false
+      t.integer "taggings_count", default: 0
+      t.index ["name"], name: "index_spree_tags_on_name", unique: true
+    end
+
+    if ActiveRecord::Base.connection.adapter_name == 'PostgreSQL'
+      add_index :spree_tags, 'lower(name) varchar_pattern_ops', name: 'index_spree_tags_on_lower_name'
+    end
+  end
+end

data/lib/generators/spree/authentication/custom/custom_generator.rb

@@ -0,0 +1,49 @@
+require 'rails/generators'
+
+module Spree
+  module Authentication
+    class CustomGenerator < Rails::Generators::Base
+      desc 'Set up a Spree installation with custom authentication'
+
+      def self.source_paths
+        paths = superclass.source_paths
+        paths << File.expand_path('templates', __dir__)
+        paths.flatten
+      end
+
+      def generate
+        template 'authentication_helpers.rb.tt', 'lib/spree/authentication_helpers.rb'
+
+        file_action = File.exist?('config/initializers/spree.rb') ? :append_file : :create_file
+        send(file_action, 'config/initializers/spree.rb') do
+          %Q{
+            Rails.application.config.to_prepare do
+              require_dependency 'spree/authentication_helpers'
+            end\n}
+        end
+
+        user_class_file = Rails.root.join('app', 'models', "#{Spree.user_class.name.underscore}.rb")
+
+        if File.exist?(user_class_file)
+          inject_into_file user_class_file, after: "class #{Spree.user_class.name} < ApplicationRecord\n" do
+            <<-RUBY
+    # Spree modules
+    include Spree::UserAddress
+    include Spree::UserMethods
+    include Spree::UserPaymentSource
+            RUBY
+          end
+          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
+          say <<~RUBY
+            # Spree modules
+            include Spree::UserAddress
+            include Spree::UserMethods
+            include Spree::UserPaymentSource
+          RUBY
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+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
+      current_user
+    end
+
+    def spree_login_path(opts = {})
+      main_app.login_path(opts)
+    end
+
+    def spree_signup_path(opts = {})
+      main_app.signup_path(opts = {})
+    end
+
+    def spree_logout_path(opts = {})
+      main_app.logout_path(opts = {})
+    end
+
+    def spree_forgot_password_path(opts = {})
+      main_app.forgot_password_path(opts)
+    end
+
+    def spree_edit_password_path(opts = {})
+      main_app.spree_edit_password_path(opts)
+    end
+
+    def spree_admin_login_path(opts = {})
+      spree_login_path(opts)
+    end
+
+    def spree_admin_logout_path(opts = {})
+      spree_logout_path(opts)
+    end
+  end
+end
+
+ApplicationController.include Spree::AuthenticationHelpers if defined?(ApplicationController)

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

@@ -0,0 +1,57 @@
+require 'rails/generators'
+
+module Spree
+  module Authentication
+    class DeviseGenerator < Rails::Generators::Base
+      desc 'Set up a Spree installation with Devise as authentication'
+
+      def self.source_paths
+        paths = superclass.source_paths
+        paths << File.expand_path('templates', __dir__)
+        paths.flatten
+      end
+
+      def generate
+        template 'authentication_helpers.rb.tt', 'lib/spree/authentication_helpers.rb'
+
+        file_action = File.exist?('config/initializers/spree.rb') ? :append_file : :create_file
+        send(file_action, 'config/initializers/spree.rb') do
+          %Q{
+            Rails.application.config.to_prepare do
+              require_dependency 'spree/authentication_helpers'
+            end\n}
+        end
+
+        user_class_file = Rails.root.join('app', 'models', "#{Spree.user_class.name.underscore}.rb")
+
+        if File.exist?(user_class_file)
+          inject_into_file user_class_file, after: "class #{Spree.user_class.name} < ApplicationRecord\n" do
+            <<-RUBY
+    # Spree modules
+    include Spree::UserAddress
+    include Spree::UserMethods
+    include Spree::UserPaymentSource
+            RUBY
+          end
+          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
+          say <<~RUBY
+            # Spree modules
+            include Spree::UserAddress
+            include Spree::UserMethods
+            include Spree::UserPaymentSource
+          RUBY
+        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"
+            end\n}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+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
+      send("current_#{Spree.user_class.model_name.singular_route_key}")
+    end
+
+    def spree_login_path(opts = {})
+      new_session_path(Spree.user_class.model_name.singular_route_key, opts)
+    end
+
+    def spree_signup_path(opts = {})
+      new_registration_path(Spree.user_class.model_name.singular_route_key, opts)
+    end
+
+    def spree_logout_path(opts = {})
+      destroy_session_path(Spree.user_class.model_name.singular_route_key, opts)
+    end
+
+    def spree_forgot_password_path(opts = {})
+      new_password_path(Spree.user_class.model_name.singular_route_key, opts)
+    end
+
+    def spree_edit_password_path(opts = {})
+      edit_registration_path(Spree.user_class.model_name.singular_route_key, opts)
+    end
+
+    def spree_admin_login_path(opts = {})
+      spree_login_path(opts)
+    end
+
+    def spree_admin_logout_path(opts = {})
+      spree_logout_path(opts)
+    end
+  end
+end
+
+ApplicationController.include Spree::AuthenticationHelpers if defined?(ApplicationController)

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_backend spree_frontend spree_api spree_emails).freeze
+    SPREE_GEMS = %w(spree_admin spree_storefront spree_api spree_emails).freeze
 
     desc 'Creates blank Rails application, installs Spree and all sample data'
 

data/lib/generators/spree/dummy/templates/rails/database.yml

@@ -57,6 +57,7 @@ postgres: &postgres
   host: <%= db_host %>
   <% end %>
   min_messages: warning
+  pool: <%= ENV["DB_POOL"] || 50 %>
 
 development:
   <<: *postgres

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

@@ -36,7 +36,7 @@ Dummy::Application.configure do
 
   config.active_job.queue_adapter = :test
 
-  config.cache_store = :memory_store # we need to use memory store for Spree preferences
+  config.cache_store = :null_store
 
   routes.default_url_options = { host: 'localhost', port: 3000 }
 end

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

@@ -19,6 +19,7 @@ module Spree
     class_option :admin_password, type: :string
     class_option :lib_name, type: :string, default: 'spree'
     class_option :enforce_available_locales, type: :boolean, default: nil
+    class_option :authentication, type: :string, default: 'devise'
 
     def self.source_paths
       paths = superclass.source_paths
@@ -35,6 +36,7 @@ module Spree
       @install_storefront = options[:install_storefront]
       @install_admin = options[:install_admin]
       @copy_storefront = options[:copy_storefront]
+      @authentication = options[:authentication]
 
       unless @run_migrations
         @load_seed_data = false
@@ -64,25 +66,30 @@ module Spree
       ROBOTS
     end
 
-    def create_overrides_directory
-      empty_directory 'app/overrides'
+    # Currently we only support devise, in the future we will also add support for default Rails authentication
+    def install_authentication
+      if @authentication == 'devise'
+        generate 'spree:authentication:devise'
+      elsif @authentication == 'dummy'
+        # this is for dummy / test app
+      end
     end
 
     def install_storefront
       if @install_storefront && Spree::Core::Engine.frontend_available?
-        generate 'spree:frontend:install'
+        generate 'spree:storefront:install'
       end
     end
 
     def install_admin
-      if @install_admin && Spree::Core::Engine.backend_available?
-        generate 'spree:backend:install'
+      if @install_admin && Spree::Core::Engine.admin_available?
+        generate 'spree:admin:install'
       end
     end
 
     def copy_storefront
       if @copy_storefront && Spree::Core::Engine.frontend_available?
-        generate 'spree:frontend:copy_storefront'
+        generate 'spree:storefront:copy_storefront'
       end
     end
 
@@ -94,11 +101,6 @@ module Spree
           Dir.glob(File.join(File.dirname(__FILE__), "../app/**/*_decorator*.rb")) do |c|
             Rails.configuration.cache_classes ? require(c) : load(c)
           end
-
-          # Load application's view overrides
-          Dir.glob(File.join(File.dirname(__FILE__), "../app/overrides/*.rb")) do |c|
-            Rails.configuration.cache_classes ? require(c) : load(c)
-          end
         end
       APP
 
@@ -121,27 +123,18 @@ module Spree
     def install_migrations
       say_status :copying, 'migrations'
       silence_stream(STDOUT) do
-        silence_warnings { rake 'railties:install:migrations' }
-      end
-    end
-
-    def create_database
-      say_status :creating, 'database'
-      silence_stream(STDOUT) do
-        silence_stream(STDERR) do
-          silence_warnings { rake 'db:create' }
-        end
+        silence_warnings { rake 'active_storage:install:migrations' }
+        silence_warnings { rake 'action_mailbox:install:migrations' }
+        silence_warnings { rake 'action_text:install:migrations' }
+        silence_warnings { rake 'spree:install:migrations' }
+        silence_warnings { rake 'spree_api:install:migrations' }
       end
     end
 
     def run_migrations
       if @run_migrations
         say_status :running, 'migrations'
-        silence_stream(STDOUT) do
-          silence_stream(STDERR) do
-            silence_warnings { rake 'db:migrate' }
-          end
-        end
+        rake 'db:migrate'
       else
         say_status :skipping, "migrations (don't forget to run rake db:migrate)"
       end
@@ -157,11 +150,7 @@ module Spree
 
         cmd = -> { rake("db:seed #{rake_options.join(' ')}") }
         if options[:auto_accept] || (options[:admin_email] && options[:admin_password])
-          silence_stream(STDOUT) do
-            silence_stream(STDERR) do
-              silence_warnings &cmd
-            end
-          end
+          silence_warnings &cmd
         else
           cmd.call
         end
@@ -175,11 +164,7 @@ module Spree
 
       if @load_sample_data
         say_status :loading, 'sample data'
-        silence_stream(STDOUT) do
-          silence_stream(STDERR) do
-            silence_warnings { rake 'spree_sample:load' }
-          end
-        end
+        rake 'spree_sample:load'
       else
         say_status :skipping, 'sample data (you can always run rake spree_sample:load)'
       end

data/lib/generators/spree/install/templates/config/initializers/spree.rb

@@ -18,6 +18,12 @@ Spree.config do |config|
   # config.track_inventory_levels = false
 end
 
+# Background job queue names
+# Spree.queues.default = :default
+# Spree.queues.variants = :default
+# Spree.queues.stock_location_stock_items = :default
+# Spree.queues.coupon_codes = :default
+
 # Use a CDN host for images, eg. Cloudfront
 # This is used in the frontend to generate absolute URLs to images
 # Default is nil and your application host will be used
@@ -29,12 +35,8 @@ end
 #   Spree.public_storage_service_name = :amazon_private # private assets, such as invoices, etc
 # end
 
-# Use a different search engine for products
-# You can check the default search class at:
-# https://github.com/spree/spree/blob/main/core/lib/spree/core/search/base.rb
-# and use it as base class for your custom searcher
-# eg. MySearcher < Spree::Core::Search::Base
-# Spree.searcher_class = 'MySearcher'
+# Enable theme preview screenshots in admin dashboard
+# Spree.screenshot_api_token = <Your Screenshot API token obtained from https://screenshotapi.net/>
 
 # Configure Spree Dependencies
 #
@@ -51,6 +53,38 @@ end
 
 # Spree::Api::Dependencies.storefront_cart_serializer = 'MyRailsApp::CartSerializer'
 
+# uncomment lines below to add your own custom business logic
+# such as promotions, shipping methods, etc
+Rails.application.config.after_initialize do
+  # Rails.application.config.spree.shipping_methods << Spree::ShippingMethods::SuperExpensiveNotVeryFastShipping
+  # Rails.application.config.spree.payment_methods << Spree::PaymentMethods::VerySafeAndReliablePaymentMethod
+
+  # Rails.application.config.spree.calculators.tax_rates << Spree::TaxRates::FinanceTeamForcedMeToCodeThis
+
+  # Rails.application.config.spree.stock_splitters << Spree::Stock::Splitters::SecretLogicSplitter
+
+  # Rails.application.config.spree.adjusters << Spree::Adjustable::Adjuster::TaxTheRich
+
+  # Custom promotions
+  # Rails.application.config.spree.calculators.promotion_actions_create_adjustments << Spree::Calculators::PromotionActions::CreateAdjustments::AddDiscountForFriends
+  # Rails.application.config.spree.calculators.promotion_actions_create_item_adjustments << Spree::Calculators::PromotionActions::CreateItemAdjustments::FinanceTeamForcedMeToCodeThis
+  # Rails.application.config.spree.promotions.rules << Spree::Promotions::Rules::OnlyForVIPCustomers
+  # Rails.application.config.spree.promotions.actions << Spree::Promotions::Actions::GiftWithPurchase
+
+  # Rails.application.config.spree.taxon_rules << Spree::TaxonRules::ProductsWithColor
+
+  # Rails.application.config.spree.exports << Spree::Exports::Payments
+  # Rails.application.config.spree.reports << Spree::Reports::MassivelyOvercomplexReportForCfo
+
+  # Themes and page builder
+  # Rails.application.config.spree.themes << Spree::Themes::NewShinyTheme
+  # Rails.application.config.spree.theme_layout_sections << Spree::PageSections::SuperImportantCeoBio
+  # Rails.application.config.spree.page_sections << Spree::PageSections::ContactFormToGetInTouch
+  # Rails.application.config.spree.page_blocks << Spree::PageBlocks::BigRedButtonToCallSales
+
+  # Rails.application.config.spree_storefront.head_partials << 'spree/shared/that_js_snippet_that_marketing_forced_me_to_include'
+end
+
 Spree.user_class = <%= (options[:user_class].blank? ? 'Spree::LegacyUser' : options[:user_class]).inspect %>
 # Use a different class for admin users
 # Spree.admin_user_class = 'AdminUser'

data/lib/normalize_string.rb

@@ -0,0 +1,18 @@
+require 'any_ascii'
+
+module NormalizeString
+  def self.normalize(string)
+    return unless string.present?
+
+    AnyAscii.transliterate(string)
+  end
+
+  def self.remove_emoji_and_normalize(string, keep_emoji_when_empty: false)
+    return unless string.present?
+
+    result = AnyAscii.transliterate(string.gsub(/\p{So}/, ''))
+    return result if result.present? || !keep_emoji_when_empty
+
+    normalize(string)
+  end
+end

data/lib/spree/analytics.rb

@@ -0,0 +1,11 @@
+module Spree
+  module Analytics
+    def self.events
+      @@supported_events ||= Rails.application.config.spree.analytics_events
+    end
+
+    def self.event_handlers
+      @@event_handlers ||= Rails.application.config.spree.analytics_event_handlers
+    end
+  end
+end

data/lib/spree/core/components.rb

@@ -16,7 +16,7 @@ module Spree
       end
 
       def self.frontend_available?
-        @@frontend_available ||= ::Rails::Engine.subclasses.map(&:instance).map { |e| e.class.to_s }.include?('Spree::Frontend::Engine')
+        @@frontend_available ||= ::Rails::Engine.subclasses.map(&:instance).map { |e| e.class.to_s }.include?('Spree::Storefront::Engine')
       end
 
       def self.emails_available?