solidus_core 3.0.0 → 4.5.1

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

@@ -1,88 +1,7 @@
 # frozen_string_literal: true
 
-require 'spree/core/controller_helpers/pricing'
-
-module Spree
-  module Core
-    module ControllerHelpers
-      module Order
-        extend ActiveSupport::Concern
-        include ControllerHelpers::Pricing
-
-        included do
-          helper_method :current_order
-        end
-
-        # The current incomplete order from the guest_token for use in cart and during checkout
-        def current_order(options = {})
-          should_create = options[:create_order_if_necessary] || false
-          should_build = options[:build_order_if_necessary] || should_create
-
-          return @current_order if @current_order
-
-          @current_order = find_order_by_token_or_user(lock: options[:lock])
-
-          if should_build && (@current_order.nil? || @current_order.completed?)
-            @current_order = Spree::Order.new(new_order_params)
-            @current_order.user ||= try_spree_current_user
-            # See issue https://github.com/spree/spree/issues/3346 for reasons why this line is here
-            @current_order.created_by ||= try_spree_current_user
-            @current_order.save! if should_create
-          end
-
-          if @current_order
-            @current_order.record_ip_address(ip_address)
-            return @current_order
-          end
-        end
-
-        def associate_user
-          @order ||= current_order
-          if try_spree_current_user && @order
-            @order.associate_user!(try_spree_current_user) if @order.user.blank? || @order.email.blank?
-          end
-        end
-
-        def set_current_order
-          if try_spree_current_user && current_order
-            try_spree_current_user.orders.by_store(current_store).incomplete.where('id != ?', current_order.id).each do |order|
-              current_order.merge!(order, try_spree_current_user)
-            end
-          end
-        end
-
-        def ip_address
-          request.remote_ip
-        end
-
-        private
-
-        def last_incomplete_order
-          @last_incomplete_order ||= try_spree_current_user.last_incomplete_spree_order(store: current_store)
-        end
-
-        def current_order_params
-          { currency: current_pricing_options.currency, guest_token: cookies.signed[:guest_token], store_id: current_store.id, user_id: try_spree_current_user.try(:id) }
-        end
-
-        def new_order_params
-          current_order_params.merge(last_ip_address: ip_address)
-        end
-
-        def find_order_by_token_or_user(options = {})
-          should_lock = options[:lock] || false
-
-          # Find any incomplete orders for the guest_token
-          order = Spree::Order.incomplete.lock(should_lock).find_by(current_order_params)
-
-          # Find any incomplete orders for the current user
-          if order.nil? && try_spree_current_user
-            order = last_incomplete_order
-          end
-
-          order
-        end
-      end
-    end
-  end
-end
+Spree.deprecator.warn(
+  <<~MSG
+    The file "#{__FILE__}" does not need to be `require`d any longer, it is now autoloaded.
+  MSG
+)

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

@@ -1,167 +1,7 @@
 # frozen_string_literal: true
 
-module Spree
-  module Core::ControllerHelpers::PaymentParameters
-    # This method handles the awkwardness of how the html forms are currently
-    # set up for frontend.
-    #
-    # This method expects a params hash in the format of:
-    #
-    #  {
-    #    payment_source: {
-    #      # The keys here are spree_payment_method.id's
-    #      '1' => {...source attributes for payment method 1...},
-    #      '2' => {...source attributes for payment method 2...},
-    #    },
-    #    order: {
-    #      # Note that only a single entry is expected/handled in this array
-    #      payments_attributes: [
-    #        {
-    #          payment_method_id: '1',
-    #        },
-    #      ],
-    #      ...other params...
-    #    },
-    #    ...other params...
-    #  }
-    #
-    # And this method modifies the params into the format of:
-    #
-    #  {
-    #    order: {
-    #      payments_attributes: [
-    #        {
-    #          payment_method_id: '1',
-    #          source_attributes: {...source attributes for payment method 1...}
-    #        },
-    #      ],
-    #      ...other params...
-    #    },
-    #    ...other params...
-    #  }
-    #
-    def move_payment_source_into_payments_attributes(params)
-      # Step 1: Gather all the information and ensure all the pieces are there.
-
-      return params if params[:payment_source].blank?
-
-      payment_params = params[:order] &&
-                       params[:order][:payments_attributes] &&
-                       params[:order][:payments_attributes].first
-      return params if payment_params.blank?
-
-      payment_method_id = payment_params[:payment_method_id]
-      return params if payment_method_id.blank?
-
-      source_params = params[:payment_source][payment_method_id]
-      return params if source_params.blank?
-
-      # Step 2: Perform the modifications.
-
-      payment_params[:source_attributes] = source_params
-      params.delete(:payment_source)
-
-      params
-    end
-
-    # This method handles the awkwardness of how the html forms are currently
-    # set up for frontend.
-    #
-    # This method expects a params hash in the format of:
-    #
-    #  {
-    #    order: {
-    #      wallet_payment_source_id: '123',
-    #      ...other params...
-    #    },
-    #    cvc_confirm: '456', # optional
-    #    ...other params...
-    #  }
-    #
-    # And this method modifies the params into the format of:
-    #
-    #  {
-    #    order: {
-    #      payments_attributes: [
-    #        {
-    #          source_attributes: {
-    #            wallet_payment_source_id: '123',
-    #            verification_value: '456',
-    #          },
-    #        },
-    #      ]
-    #      ...other params...
-    #    },
-    #    ...other params...
-    #  }
-    #
-    def move_wallet_payment_source_id_into_payments_attributes(params)
-      return params if params[:order].blank?
-
-      wallet_payment_source_id = params[:order][:wallet_payment_source_id].presence
-      cvc_confirm = params[:cvc_confirm].presence
-
-      return params if wallet_payment_source_id.nil?
-
-      params[:order][:payments_attributes] = [
-        {
-          source_attributes: {
-            wallet_payment_source_id: wallet_payment_source_id,
-            verification_value: cvc_confirm
-          }
-        }
-      ]
-
-      params[:order].delete(:wallet_payment_source_id)
-      params.delete(:cvc_confirm)
-
-      params
-    end
-
-    # This is a strange thing to do since an order can have multiple payments
-    # but we always assume that it only has a single payment and that its
-    # amount should be the current order total.  Also, this is pretty much
-    # overridden when the order transitions to confirm by the logic inside of
-    # Order#add_store_credit_payments.
-    # We should reconsider this method and its usage at some point.
-    #
-    # This method expects a params hash in the format of:
-    #
-    #  {
-    #    order: {
-    #      # Note that only a single entry is expected/handled in this array
-    #      payments_attributes: [
-    #        {
-    #          ...params...
-    #        },
-    #      ],
-    #      ...other params...
-    #    },
-    #    ...other params...
-    #  }
-    #
-    # And this method modifies the params into the format of:
-    #
-    #  {
-    #    order: {
-    #      payments_attributes: [
-    #        {
-    #          ...params...
-    #          amount: <the order total>,
-    #        },
-    #      ],
-    #      ...other params...
-    #    },
-    #    ...other params...
-    #  }
-    #
-    def set_payment_parameters_amount(params, order)
-      return params if params[:order].blank?
-      return params if params[:order][:payments_attributes].blank?
-
-      params[:order][:payments_attributes].first[:amount] = order.total
-
-      params
-    end
-  end
-end
+Spree.deprecator.warn(
+  <<~MSG
+    The file "#{__FILE__}" does not need to be `require`d any longer, it is now autoloaded.
+  MSG
+)

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

@@ -1,19 +1,7 @@
 # frozen_string_literal: true
 
-module Spree
-  module Core
-    module ControllerHelpers
-      module Pricing
-        extend ActiveSupport::Concern
-
-        included do
-          helper_method :current_pricing_options
-        end
-
-        def current_pricing_options
-          Spree::Config.pricing_options_class.from_context(self)
-        end
-      end
-    end
-  end
-end
+Spree.deprecator.warn(
+  <<~MSG
+    The file "#{__FILE__}" does not need to be `require`d any longer, it is now autoloaded.
+  MSG
+)

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

@@ -1,16 +1,7 @@
 # frozen_string_literal: true
 
-module Spree
-  module Core
-    module ControllerHelpers
-      module Search
-        def build_searcher(params)
-          Spree::Config.searcher_class.new(params).tap do |searcher|
-            searcher.current_user = try_spree_current_user
-            searcher.pricing_options = current_pricing_options
-          end
-        end
-      end
-    end
-  end
-end
+Spree.deprecator.warn(
+  <<~MSG
+    The file "#{__FILE__}" does not need to be `require`d any longer, it is now autoloaded.
+  MSG
+)

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

@@ -1,19 +1,7 @@
 # frozen_string_literal: true
 
-module Spree
-  module Core
-    module ControllerHelpers
-      module Store
-        extend ActiveSupport::Concern
-
-        included do
-          helper_method :current_store
-        end
-
-        def current_store
-          @current_store ||= Spree::Config.current_store_selector_class.new(request).store
-        end
-      end
-    end
-  end
-end
+Spree.deprecator.warn(
+  <<~MSG
+    The file "#{__FILE__}" does not need to be `require`d any longer, it is now autoloaded.
+  MSG
+)

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

@@ -1,73 +1,7 @@
 # frozen_string_literal: true
 
-module Spree
-  module Core
-    module ControllerHelpers
-      module StrongParameters
-        def permitted_attributes
-          Spree::PermittedAttributes
-        end
-
-        delegate(*Spree::PermittedAttributes::ATTRIBUTES,
-                 to: :permitted_attributes,
-                 prefix: :permitted)
-
-        def permitted_credit_card_update_attributes
-          permitted_attributes.credit_card_update_attributes + [
-            address_attributes: permitted_address_attributes
-          ]
-        end
-
-        def permitted_payment_attributes
-          permitted_attributes.payment_attributes + [
-            source_attributes: permitted_source_attributes
-          ]
-        end
-
-        def permitted_source_attributes
-          permitted_attributes.source_attributes + [
-            address_attributes: permitted_address_attributes
-          ]
-        end
-
-        def permitted_checkout_address_attributes
-          permitted_attributes.checkout_address_attributes
-        end
-
-        def permitted_checkout_delivery_attributes
-          permitted_attributes.checkout_delivery_attributes
-        end
-
-        def permitted_checkout_payment_attributes
-          permitted_attributes.checkout_payment_attributes
-        end
-
-        def permitted_checkout_confirm_attributes
-          permitted_attributes.checkout_confirm_attributes
-        end
-
-        def permitted_order_attributes
-          permitted_checkout_address_attributes +
-          permitted_checkout_delivery_attributes +
-          permitted_checkout_payment_attributes +
-          permitted_checkout_confirm_attributes + [
-            line_items_attributes: permitted_line_item_attributes
-          ]
-        end
-
-        def permitted_product_attributes
-          permitted_attributes.product_attributes + [
-            product_properties_attributes: permitted_product_properties_attributes
-          ]
-        end
-
-        def permitted_user_attributes
-          permitted_attributes.user_attributes + [
-            bill_address_attributes: permitted_address_attributes,
-            ship_address_attributes: permitted_address_attributes
-          ]
-        end
-      end
-    end
-  end
-end
+Spree.deprecator.warn(
+  <<~MSG
+    The file "#{__FILE__}" does not need to be `require`d any longer, it is now autoloaded.
+  MSG
+)

data/lib/spree/core/engine.rb

@@ -15,6 +15,17 @@ module Spree
         generator.test_framework :rspec
       end
 
+      if ActiveRecord.respond_to?(:yaml_column_permitted_classes) || ActiveRecord::Base.respond_to?(:yaml_column_permitted_classes)
+        config.active_record.yaml_column_permitted_classes ||= []
+        config.active_record.yaml_column_permitted_classes |=
+          [Symbol, BigDecimal, ActiveSupport::HashWithIndifferentAccess]
+      end
+
+      initializer "spree.zeitwerk_ignores" do
+        old_helpers = Engine.root.join("lib", "spree", "core", "controller_helpers", "*", "*.rb")
+        Rails.application.autoloaders.main.ignore(old_helpers)
+      end
+
       initializer "spree.environment", before: :load_config_initializers do |app|
         app.config.spree = Spree::Config.environment
       end
@@ -40,32 +51,54 @@ module Spree
         ]
       end
 
-      initializer "spree.core.checking_migrations", before: :load_config_initializers do |_app|
+      initializer "spree.core.checking_migrations", after: :load_config_initializers do |_app|
         Migrations.new(config, engine_name).check
       end
 
-      # Setup Event Subscribers
-      initializer 'spree.core.initialize_subscribers' do |app|
+      # Setup pub/sub
+      initializer 'spree.core.pub_sub' do |app|
         app.reloader.to_prepare do
-          Spree::Event.activate_autoloadable_subscribers
+          Spree::Bus.clear
+
+          %i[
+            order_emptied
+            order_finalized
+            order_recalculated
+            reimbursement_reimbursed
+            reimbursement_errored
+          ].each { |event_name| Spree::Bus.register(event_name) }
+
+          Spree::OrderMailerSubscriber.new.subscribe_to(Spree::Bus)
+        end
+      end
+
+      # Load in mailer previews for apps to use in development.
+      initializer "spree.core.action_mailer.set_preview_path", after: "action_mailer.set_autoload_paths" do
+        solidus_preview_path = Spree::Core::Engine.root.join("lib/spree/mailer_previews")
+
+        if ActionMailer::Base.respond_to? :preview_paths # Rails 7.1+
+          ActionMailer::Base.preview_paths << solidus_preview_path.to_s
+        else
+          ActionMailer::Base.preview_path = "{#{ActionMailer::Base.preview_path},#{solidus_preview_path}}"
         end
+      end
 
-        app.reloader.before_class_unload do
-          Spree::Event.deactivate_all_subscribers
+      initializer "spree.deprecator" do |app|
+        if app.respond_to?(:deprecators)
+          app.deprecators[:spree] = Spree.deprecator
         end
       end
 
       config.after_initialize do
-        # Load in mailer previews for apps to use in development.
-        # We need to make sure we call `Preview.all` before requiring our
-        # previews, otherwise any previews the app attempts to add need to be
-        # manually required.
-        if Rails.env.development? || Rails.env.test?
-          ActionMailer::Preview.all
-
-          Dir[root.join("lib/spree/mailer_previews/**/*_preview.rb")].each do |file|
-            require_dependency file
-          end
+        Spree::Config.check_load_defaults_called('Spree::Config')
+        Spree::Config.static_model_preferences.validate!
+      end
+
+      config.after_initialize do
+        if defined?(Spree::Auth::Engine) &&
+            Gem::Version.new(Spree::Auth::VERSION) < Gem::Version.new('2.5.4') &&
+            defined?(Spree::UsersController)
+          Spree::UsersController.protect_from_forgery with: :exception
         end
       end
     end

data/lib/spree/core/environment/calculators.rb

@@ -9,9 +9,41 @@ module Spree
         add_class_set :shipping_methods
         add_class_set :tax_rates
 
-        add_class_set :promotion_actions_create_adjustments
-        add_class_set :promotion_actions_create_item_adjustments
-        add_class_set :promotion_actions_create_quantity_adjustments
+        def promotion_actions_create_adjustments
+          promotion_config.calculators["Spree::Promotion::Actions::CreateAdjustment"]
+        end
+        deprecate :promotion_actions_create_adjustments, deprecator: Spree.deprecator
+
+        def promotion_actions_create_adjustments=(value)
+          promotion_config.calculators["Spree::Promotion::Actions::CreateAdjustment"] = value
+        end
+        deprecate :promotion_actions_create_adjustments=, deprecator: Spree.deprecator
+
+        def promotion_actions_create_item_adjustments
+          promotion_config.calculators["Spree::Promotion::Actions::CreateItemAdjustments"]
+        end
+        deprecate :promotion_actions_create_item_adjustments, deprecator: Spree.deprecator
+
+        def promotion_actions_create_item_adjustments=(value)
+          promotion_config.calculators["Spree::Promotion::Actions::CreateItemAdjustments"] = value
+        end
+        deprecate :promotion_actions_create_item_adjustments=, deprecator: Spree.deprecator
+
+        def promotion_actions_create_quantity_adjustments
+          promotion_config.calculators["Spree::Promotion::Actions::CreateQuantityAdjustments"]
+        end
+        deprecate :promotion_actions_create_quantity_adjustments, deprecator: Spree.deprecator
+
+        def promotion_actions_create_quantity_adjustments=(value)
+          promotion_config.calculators["Spree::Promotion::Actions::CreateQuantityAdjustments"] = value
+        end
+        deprecate :promotion_actions_create_quantity_adjustments=, deprecator: Spree.deprecator
+
+        private
+
+        def promotion_config
+          Spree::Config.promotions
+        end
       end
     end
   end

data/lib/spree/core/environment/promotions.rb

@@ -4,11 +4,32 @@ module Spree
   module Core
     class Environment
       class Promotions
-        include EnvironmentExtension
+        class << self
+          private
 
-        add_class_set :rules
-        add_class_set :actions
-        add_class_set :shipping_actions
+          def promotions_deprecation_message(method)
+            "The `Rails.application.config.spree.promotions.#{method}` preference is deprecated and will be removed in Solidus 5.0. " \
+            "Use `Spree::Config.promotions.#{method}` instead."
+          end
+        end
+
+        delegate :rules, :rules=, to: :promotion_config
+        deprecate rules: promotions_deprecation_message("rules"), deprecator: Spree.deprecator
+        deprecate "rules=": promotions_deprecation_message("rules="), deprecator: Spree.deprecator
+
+        delegate :actions, :actions=, to: :promotion_config
+        deprecate actions: promotions_deprecation_message("actions"), deprecator: Spree.deprecator
+        deprecate "actions=": promotions_deprecation_message("actions="), deprecator: Spree.deprecator
+
+        delegate :shipping_actions, :shipping_actions=, to: :promotion_config
+        deprecate shipping_actions: promotions_deprecation_message("shipping_actions"), deprecator: Spree.deprecator
+        deprecate "shipping_actions=": promotions_deprecation_message("shipping_actions="), deprecator: Spree.deprecator
+
+        private
+
+        def promotion_config
+          Spree::Config.promotions
+        end
       end
     end
   end

data/lib/spree/core/environment_extension.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'spree/core/class_constantizer'
+require 'spree/core/nested_class_set'
 
 module Spree
   module Core
@@ -8,10 +9,10 @@ module Spree
       extend ActiveSupport::Concern
 
       class_methods do
-        def add_class_set(name)
+        def add_class_set(name, default: [])
           define_method(name) do
             set = instance_variable_get("@#{name}")
-            set ||= send("#{name}=", [])
+            set ||= send("#{name}=", default)
             set
           end
 
@@ -21,6 +22,19 @@ module Spree
             instance_variable_set("@#{name}", set)
           end
         end
+
+        def add_nested_class_set(name, default: {})
+          define_method(name) do
+            set = instance_variable_get(:"@#{name}")
+            set ||= send(:"#{name}=", default)
+            set
+          end
+
+          define_method(:"#{name}=") do |hash|
+            set = Spree::Core::NestedClassSet.new(hash)
+            instance_variable_set(:"@#{name}", set)
+          end
+        end
       end
     end
   end

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

@@ -40,7 +40,7 @@ module Spree
             end
 
             # Really ensure that the order totals & states are correct
-            order.updater.update
+            order.recalculate
             if shipments_attrs.present?
               order.shipments.each_with_index do |shipment, index|
                 shipment.update_columns(cost: shipments_attrs[index][:cost].to_f) if shipments_attrs[index][:cost].present?
@@ -74,7 +74,7 @@ module Spree
               # able to find the line item if line_item.variant_id |= iu.variant_id
               shipment.inventory_units.new(
                 variant_id: inventory_unit[:variant_id],
-                line_item: line_item
+                line_item:
               )
             end
 
@@ -91,7 +91,7 @@ module Spree
             shipment.save!
 
             shipping_method = Spree::ShippingMethod.find_by(name: target[:shipping_method]) || Spree::ShippingMethod.find_by!(admin_name: target[:shipping_method])
-            rate = shipment.shipping_rates.create!(shipping_method: shipping_method,
+            rate = shipment.shipping_rates.create!(shipping_method:,
                                                    cost: target[:cost])
             shipment.selected_shipping_rate_id = rate.id
             shipment.update_amounts
@@ -129,7 +129,7 @@ module Spree
           return [] unless adjustments
           adjustments.each do |target|
             adjustment = order.adjustments.build(
-              order:  order,
+              order:,
               amount: target[:amount].to_d,
               label:  target[:label]
             )
@@ -141,7 +141,7 @@ module Spree
         def self.create_payments_from_params(payments_hash, order)
           return [] unless payments_hash
           payments_hash.each do |target|
-            payment = order.payments.build order: order
+            payment = order.payments.build(order:)
             payment.amount = target[:amount].to_f
             # Order API should be using state as that's the normal payment field.
             # spree_wombat serializes payment state as status so imported orders should fall back to status field.
@@ -170,7 +170,7 @@ module Spree
         def self.ensure_variant_id_from_params(hash)
           sku = hash.delete(:sku)
           unless hash[:variant_id].present?
-            hash[:variant_id] = Spree::Variant.with_prices.find_by!(sku: sku).id
+            hash[:variant_id] = Spree::Variant.with_prices.find_by!(sku:).id
           end
           hash
         end