solidus_core 3.4.2 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27a6dc7426532656dc872561abdbd2d10b0f6695e5020024302ce9c8a720ef8c
-  data.tar.gz: c9352bdf10b7a7131fe5a1e9535a9a6dc585d4bd60084b8ca116cac2925faec7
+  metadata.gz: c3e2c6952c5346f716b691621d06c35fa50cdd42a1071b449495be31f2358c15
+  data.tar.gz: cf282e7b402f07c2a33f300fbe61aef661fbb31f5b1a6889887149d2bfcadca1
 SHA512:
-  metadata.gz: 0ad38fa6806399e63992c8e0455f9baa443a85fef435c71fe07e2b2da1f7269254c0e6403d5a009a61cfa550c9c8702ec7ef155d8dc7e9f88cdb0c1f5ac5cd20
-  data.tar.gz: 0ebe32086e2e138edd27721b3fa5536db1de7255bb6d30d8cdc223eebb7e795b369bd26fae4c96b8de7269bf03f2afdb09ddfef8a797470d41b42e3016956a89
+  metadata.gz: 8240824eb568d985249690d9a49382a6b25d2d4f7f5c6d8d17d30bfa2fd0cb9af579e5ee01b16828cbacdadad3b9b4524d804ce42aaab08e94b211ce08f8d439
+  data.tar.gz: 20b8afa05c9068af3635aadb658302f0ecee745a50bbb0b6230db6fbec758de6cb594a22ddc147e8c655e9cd1ac8babb827701979bc912836b091273f7d2e1af

data/README.md

@@ -5,7 +5,7 @@ Solidus system depends.
 
 Core models
 -----------
-Solidus implements over 200 [models](https://github.com/solidusio/solidus/tree/master/core/app/models/spree),
+Solidus implements over 200 [models](https://github.com/solidusio/solidus/tree/main/core/app/models/spree),
 and thus a deep inspection of each in this README would be overkill. Instead,
 let's take a quick look at the fundamental models upon which all else depend.
 Currently, these models remain in the Spree namespace as part of the legacy of

data/app/controllers/spree/base_controller.rb

@@ -11,6 +11,4 @@ class Spree::BaseController < ApplicationController
   include Spree::Core::ControllerHelpers::Search
   include Spree::Core::ControllerHelpers::Store
   include Spree::Core::ControllerHelpers::StrongParameters
-
-  respond_to :html
 end

data/app/helpers/spree/products_helper.rb

@@ -68,7 +68,7 @@ module Spree
     # @return [String] a cache invalidation key for products
     def cache_key_for_products
       count = @products.count
-      max_updated_at = Spree::RailsCompatibility.to_fs((@products.maximum(:updated_at) || Date.today), :number)
+      max_updated_at = (@products.maximum(:updated_at) || Date.today).to_fs(:number)
       "#{I18n.locale}/#{current_pricing_options.cache_key}/spree/products/all-#{params[:page]}-#{max_updated_at}-#{count}"
     end
   end

data/app/models/concerns/spree/active_storage_adapter.rb

@@ -7,23 +7,6 @@ module Spree
     extend ActiveSupport::Concern
     include Spree::ActiveStorageAdapter::Normalization
 
-    included do
-      next if Rails.gem_version >= Gem::Version.new('6.1.0.alpha')
-
-      raise <<~MESSAGE
-        Configuration Error: Solidus ActiveStorage attachment adpater requires Rails >= 6.1.0.
-
-        Spree::Config.image_attachment_module preference is set to #{Spree::Config.image_attachment_module}
-        Spree::Config.taxon_attachment_module preference is set to #{Spree::Config.taxon_attachment_module}
-        Rails version is #{Rails.gem_version}
-
-        To solve the problem you can upgrade to a Rails version greater than or equal to 6.1.0
-        or use legacy Paperclip attachment adapter by editing `config/initialiers/spree/rb`:
-        config.image_attachment_module = 'Spree::Image::PaperclipAttachment'
-        config.taxon_attachment_module = 'Spree::Taxon::PaperclipAttachment'
-      MESSAGE
-    end
-
     class_methods do
       attr_reader :attachment_name
       attr_reader :attachment_definition

data/app/models/concerns/spree/default_price.rb

@@ -14,15 +14,6 @@ module Spree
       end
     end
 
-    # Returns `#prices` prioritized for being considered as default price
-    #
-    # @deprecated
-    # @return [ActiveRecord::Relation<Spree::Price>]
-    def currently_valid_prices
-      prices.currently_valid
-    end
-    deprecate :currently_valid_prices, deprecator: Spree::Deprecation
-
     # Returns {#default_price} or builds it from {Spree::Variant.default_price_attributes}
     #
     # @return [Spree::Price, nil]
@@ -32,12 +23,6 @@ module Spree
         prices.build(self.class.default_price_attributes)
     end
 
-    # @deprecated Use {#default_price_or_build} instead.
-    def find_or_build_default_price
-      default_price_or_build
-    end
-    deprecate find_or_build_default_price: :default_price_or_build, deprecator: Spree::Deprecation
-
     # Select from {#prices} the one to be considered as the default
     #
     # This method works with the in-memory association, so non-persisted prices

data/app/models/concerns/spree/ransackable_attributes.rb

@@ -6,27 +6,6 @@ module Spree::RansackableAttributes
     class_attribute :allowed_ransackable_associations, default: []
     class_attribute :allowed_ransackable_attributes, default: []
     class_attribute :allowed_ransackable_scopes, default: []
-
-    def self.whitelisted_ransackable_associations
-      Spree::Deprecation.deprecation_warning(:whitelisted_ransackable_associations, 'use allowed_ransackable_associations instead')
-      allowed_ransackable_associations
-    end
-
-    def self.whitelisted_ransackable_associations=(new_value)
-      Spree::Deprecation.deprecation_warning(:whitelisted_ransackable_associations=, 'use allowed_ransackable_associations= instead')
-      self.allowed_ransackable_associations = new_value
-    end
-
-    def self.whitelisted_ransackable_attributes
-      Spree::Deprecation.deprecation_warning(:whitelisted_ransackable_attributes, 'use allowed_ransackable_attributes instead')
-      allowed_ransackable_attributes
-    end
-
-    def self.whitelisted_ransackable_attributes=(new_value)
-      Spree::Deprecation.deprecation_warning(:whitelisted_ransackable_attributes=, 'use allowed_ransackable_attributes= instead')
-      self.allowed_ransackable_attributes = new_value
-    end
-
     class_attribute :default_ransackable_attributes
     self.default_ransackable_attributes = %w[id]
   end

data/app/models/spree/adjustment.rb

@@ -51,19 +51,6 @@ module Spree
     extend DisplayMoney
     money_methods :amount
 
-    # Returns Adjustments of completed Orders.
-    #
-    # @param excluded_orders [Array<Spree::Order>] Orders to exclude from query
-    # @return [ActiveRecord::Relation] Scoped Adjustments
-    def self.in_completed_orders(excluded_orders: [], exclude_canceled: false)
-      result = joins(:order)
-               .merge(Spree::Order.complete)
-               .where.not(spree_orders: { id: excluded_orders })
-               .distinct
-      exclude_canceled ? result.merge(Spree::Order.not_canceled) : result
-    end
-    deprecate :in_completed_orders, "Please don't use this and rather go through Spree::Promotion#discounted_orders"
-
     def finalize!
       update!(finalized: true)
     end

data/app/models/spree/carton.rb

@@ -42,7 +42,7 @@ class Spree::Carton < Spree::Base
   end
 
   def display_shipped_at
-    Spree::RailsCompatibility.to_fs(shipped_at, :rfc822)
+    shipped_at.to_fs(:rfc822)
   end
 
   def manifest

data/app/models/spree/fulfilment_changer.rb

@@ -17,31 +17,19 @@ module Spree
   # @attr [Integer] quantity How many units we want to move
   #
   class FulfilmentChanger
-    # @note This private constant is only used to deprecate not passing the `track_inventory` argument
-    #   on initialization. It will be removed in Solidus 4.0, please do not use it.
-    TRACK_INVENTORY_NOT_PROVIDED = Object.new.freeze
-    private_constant :TRACK_INVENTORY_NOT_PROVIDED
-
     include ActiveModel::Validations
 
     attr_accessor :current_shipment, :desired_shipment
     attr_reader :variant, :quantity, :current_stock_location, :desired_stock_location, :track_inventory
 
-    def initialize(current_shipment:, desired_shipment:, variant:, quantity:, track_inventory: TRACK_INVENTORY_NOT_PROVIDED)
+    def initialize(current_shipment:, desired_shipment:, variant:, quantity:, track_inventory:)
       @current_shipment = current_shipment
       @desired_shipment = desired_shipment
       @current_stock_location = current_shipment.stock_location
       @desired_stock_location = desired_shipment.stock_location
       @variant = variant
       @quantity = quantity
-      @track_inventory = if track_inventory == TRACK_INVENTORY_NOT_PROVIDED
-        Spree::Deprecation.warn(
-          "Not passing `track_inventory` to `Spree::FulfilmentChanger` is deprecated." \
-        )
-        true
-      else
-        track_inventory
-      end
+      @track_inventory = track_inventory
     end
 
     validates :quantity, numericality: { greater_than: 0 }

data/app/models/spree/option_value.rb

@@ -2,9 +2,7 @@
 
 module Spree
   class OptionValue < Spree::Base
-    # TODO: Remove optional on Solidus v4.0. Don't forget adding a migration to
-    # enforce at the database layer
-    belongs_to :option_type, class_name: 'Spree::OptionType', inverse_of: :option_values, optional: true
+    belongs_to :option_type, class_name: 'Spree::OptionType', inverse_of: :option_values
     acts_as_list scope: :option_type
 
     has_many :option_values_variants, dependent: :destroy
@@ -15,15 +13,8 @@ module Spree
 
     after_save :touch, if: :saved_changes?
     after_touch :touch_all_variants
-    after_save do
-      Spree::Deprecation.warn <<~MSG if option_type.nil?
-        Having an option_value with no associated option_type will be deprecated
-        on Solidus v4.0
-      MSG
-    end
 
-    # TODO: Remove allow_nil once option_type is required on Solidus v4.0
-    delegate :name, :presentation, to: :option_type, prefix: :option_type, allow_nil: true
+    delegate :name, :presentation, to: :option_type, prefix: :option_type
 
     self.allowed_ransackable_attributes = %w[name presentation]
 

data/app/models/spree/order.rb

@@ -154,6 +154,8 @@ module Spree
       find_by! number: value
     end
 
+    delegate :recalculate, to: :recalculator
+
     delegate :name, to: :bill_address, prefix: true, allow_nil: true
     alias_method :billing_name, :bill_address_name
 
@@ -258,13 +260,11 @@ module Spree
       end || store&.default_cart_tax_location
     end
 
-    def updater
-      @updater ||= Spree::OrderUpdater.new(self)
-    end
-
-    def recalculate
-      updater.update
+    def recalculator
+      @recalculator ||= Spree::Config.order_recalculator_class.new(self)
     end
+    alias_method :updater, :recalculator
+    deprecate updater: :recalculator, deprecator: Spree::Deprecation
 
     def assign_billing_to_shipping_address
       self.ship_address = bill_address if bill_address
@@ -395,21 +395,9 @@ module Spree
       Spree::CreditCard.where(id: credit_card_ids)
     end
 
-    # TODO: Remove on Solidus 4.0
-    # @api private
-    def finalize!
-      Spree::Deprecation.warn <<~MSG
-        Calling `Spree::Order#finalize!` is discouraged. Instead, use
-        `Spree::Order#complete!`, which goes through all the needed safety
-        checks before finalizing an order. This method will be removed
-        altogether on Solidus 4.0.
-      MSG
-      finalize
-    end
-
     def fulfill!
       shipments.each { |shipment| shipment.update_state if shipment.persisted? }
-      updater.update_shipment_state
+      recalculator.update_shipment_state
       save!
     end
 
@@ -514,12 +502,9 @@ module Spree
       recalculate
     end
 
-    # Clean shipments and make order back to address state
-    #
-    # At some point the might need to force the order to transition from address
-    # to delivery again so that proper updated shipments are created.
-    # e.g. customer goes back from payment step and changes order items
-    def ensure_updated_shipments
+    # Clean shipments and make order back to address state (or to whatever state
+    # is set by restart_checkout_flow in case of state machine modifications)
+    def check_shipments_and_restart_checkout
       if !completed? && shipments.all?(&:pending?)
         shipments.destroy_all
         update_column(:shipment_total, 0)
@@ -527,6 +512,9 @@ module Spree
       end
     end
 
+    alias_method :ensure_updated_shipments, :check_shipments_and_restart_checkout
+    deprecate ensure_updated_shipments: :check_shipments_and_restart_checkout, deprecator: Spree::Deprecation
+
     def restart_checkout_flow
       return if state == 'cart'
 
@@ -552,9 +540,7 @@ module Spree
     def canceled_by(user)
       transaction do
         cancel!
-        # rubocop:disable Rails/SkipsModelValidations
         update_column(:canceler_id, user.id)
-        # rubocop:enable Rails/SkipsModelValidations
       end
     end
 
@@ -571,8 +557,7 @@ module Spree
     end
 
     def has_non_reimbursement_related_refunds?
-      refunds.non_reimbursement.exists? ||
-        payments.where("source_type = 'Spree::Payment' AND amount < 0 AND state = 'completed'").exists? # how old versions of spree stored refunds
+      refunds.non_reimbursement.exists?
     end
 
     def tax_total
@@ -757,13 +742,13 @@ module Spree
       all_adjustments.each(&:finalize!)
 
       # update payment and shipment(s) states, and save
-      updater.update_payment_state
+      recalculator.update_payment_state
       shipments.each do |shipment|
         shipment.update_state
         shipment.finalize!
       end
 
-      updater.update_shipment_state
+      recalculator.update_shipment_state
       save!
 
       touch :completed_at
@@ -779,16 +764,17 @@ module Spree
       self.email = user.email if user
     end
 
-    # Determine if email is required (we don't want validation errors before we hit the checkout)
+    # Determine if the email is required for this order
+    #
+    # We don't require email for orders in the cart state or address state because those states
+    # precede the entry of an email address.
+    #
+    # @return [Boolean] true if the email is required
+    # @note This method was called require_email before.
     def email_required?
       true unless new_record? || ['cart', 'address'].include?(state)
     end
 
-    def require_email
-      Spree::Deprecation.warn "Use email_required? instead", caller(1)
-      email_required?
-    end
-
     def ensure_inventory_units
       if has_checkout_step?("delivery")
         inventory_validator = Spree::Config.stock.inventory_validator_class.new
@@ -845,9 +831,7 @@ module Spree
       cancel_payments!
 
       send_cancel_email
-      # rubocop:disable Rails/SkipsModelValidations
       update_column(:canceled_at, Time.current)
-      # rubocop:enable Rails/SkipsModelValidations
       recalculate
     end
 

data/app/models/spree/order_contents.rb

@@ -42,7 +42,7 @@ module Spree
           # If we do not update first, then the item total will be wrong and ItemTotal
           # promotion rules would not be triggered.
           reload_totals
-          order.ensure_updated_shipments
+          order.check_shipments_and_restart_checkout
           PromotionHandler::Cart.new(order).activate
         end
         reload_totals
@@ -73,7 +73,7 @@ module Spree
     def after_add_or_remove(line_item, options = {})
       reload_totals
       shipment = options[:shipment]
-      shipment.present? ? shipment.update_amounts : order.ensure_updated_shipments
+      shipment.present? ? shipment.update_amounts : order.check_shipments_and_restart_checkout
       PromotionHandler::Cart.new(order, line_item).activate
       reload_totals
       line_item

data/app/models/spree/order_merger.rb

@@ -13,8 +13,6 @@ module Spree
     #   @return [Spree::Order] The order which items wll be merged into.
     attr_accessor :order
 
-    delegate :updater, to: :order
-
     # Create the OrderMerger
     #
     # @api public
@@ -133,13 +131,13 @@ module Spree
 
     # Save the order totals after merge
     #
-    # It triggers the order updater to ensure that item counts and totals are
+    # It triggers the order recalculator to ensure that item counts and totals are
     # up to date.
     #
     # @api private
     # @return [void]
     def persist_merge
-      updater.update
+      order.recalculate
     end
   end
 end

data/app/models/spree/order_updater.rb

@@ -16,7 +16,7 @@ module Spree
     # This method should never do anything to the Order that results in a save call on the
     # object with callbacks (otherwise you will end up in an infinite recursion as the
     # associations try to save and then in turn try to call +update!+ again.)
-    def update
+    def recalculate
       order.transaction do
         update_item_count
         update_shipment_amounts
@@ -30,6 +30,8 @@ module Spree
         persist_totals
       end
     end
+    alias_method :update, :recalculate
+    deprecate update: :recalculate, deprecator: Spree::Deprecation
 
     # Updates the +shipment_state+ attribute according to the following logic:
     #
@@ -162,9 +164,6 @@ module Spree
       order.included_tax_total = all_items.sum(&:included_tax_total) + order_tax_adjustments.select(&:included?).sum(&:amount)
       order.additional_tax_total = all_items.sum(&:additional_tax_total) + order_tax_adjustments.reject(&:included?).sum(&:amount)
 
-      # TODO: Delete this line in Solidus 4.0, when it is run in `update_promotions`.
-      order.promo_total = all_items.sum(&:promo_total) + adjustments.select(&:eligible?).select(&:promotion?).sum(&:amount)
-
       update_order_total
     end
 
@@ -200,32 +199,6 @@ module Spree
       Spree::Config.promotion_adjuster_class.new(order).call
     end
 
-    # DEPRECATED; this functionality is handled in #update_promotions
-    def update_item_promotions
-      [*line_items, *shipments].each do |item|
-        promotion_adjustments = item.adjustments.select(&:promotion?)
-
-        promotion_adjustments.each(&:recalculate)
-        Spree::Config.promotion_chooser_class.new(promotion_adjustments).update
-
-        item.promo_total = promotion_adjustments.select(&:eligible?).sum(&:amount)
-      end
-    end
-    deprecate update_item_promotions: :update_promotions, deprecator: Spree::Deprecation
-
-    # Update and select the best promotion adjustment for the order.
-    # We don't update the order.promo_total yet. Order totals are updated later
-    # in #update_adjustment_total since they include the totals from the order's
-    # line items and/or shipments.
-    #
-    # DEPRECATED; this functionality is handled in #update_promotions
-    def update_order_promotions
-      promotion_adjustments = order.adjustments.select(&:promotion?)
-      promotion_adjustments.each(&:recalculate)
-      Spree::Config.promotion_chooser_class.new(promotion_adjustments).update
-    end
-    deprecate update_order_promotions: :update_promotions, deprecator: Spree::Deprecation
-
     def update_taxes
       Spree::Config.tax_adjuster_class.new(order).adjust!
 

data/app/models/spree/payment.rb

@@ -16,7 +16,6 @@ module Spree
     belongs_to :source, polymorphic: true, optional: true
     belongs_to :payment_method, -> { with_discarded }, class_name: 'Spree::PaymentMethod', inverse_of: :payments, optional: true
 
-    has_many :offsets, -> { offset_payment }, class_name: "Spree::Payment", foreign_key: :source_id
     has_many :log_entries, as: :source
     has_many :state_changes, as: :stateful
     has_many :capture_events, class_name: 'Spree::PaymentCaptureEvent'
@@ -45,19 +44,6 @@ module Spree
 
     scope :from_credit_card, -> { where(source_type: 'Spree::CreditCard') }
     scope :with_state, ->(state) { where(state: state.to_s) }
-    # "offset" is reserved by activerecord
-    # TODO: When removing the method we can also:
-    #   - Remove the `.offsets` association
-    #   - Remove the `#offsets_total` method
-    #   - Remove offsets count from the `#credit_allowed` method
-    #   - Remove offsets check from `Spree::Order#has_non_reimbursement_related_refunds?
-    def self.offset_payment
-      Spree::Deprecation.warn <<~MSG
-        `Spree::Payment offsets` are deprecated. Use the refund system (`Spree::Refund`) instead.
-      MSG
-
-      where("source_type = 'Spree::Payment' AND amount < 0 AND state = 'completed'")
-    end
 
     scope :checkout, -> { with_state('checkout') }
     scope :completed, -> { with_state('completed') }
@@ -100,22 +86,11 @@ module Spree
         end || amount
     end
 
-    # The total amount of the offsets (for old-style refunds) for this payment.
-    #
-    # @return [BigDecimal] the total amount of this payment's offsets
-    def offsets_total
-      offsets.pluck(:amount).sum
-    end
-
     # The total amount this payment can be credited.
     #
-    # @return [BigDecimal] the amount of this payment minus the offsets
-    #   (old-style refunds) and refunds
+    # @return [BigDecimal] the amount of this payment minus refunds
     def credit_allowed
-      amount - (
-        (self.class.where("source_type = 'Spree::Payment' AND amount < 0 AND state = 'completed' AND source_id = ?", id).sum(:amount)).abs +
-        refunds.sum(:amount)
-      )
+      amount - refunds.sum(:amount)
     end
 
     # @return [Boolean] true when this payment can be credited
@@ -183,16 +158,9 @@ module Spree
 
     def validate_source
       if source && !source.valid?
-        if Gem::Requirement.new(">= 6.1").satisfied_by?(Rails.gem_version)
-          source.errors.each do |error|
-            field_name = I18n.t("activerecord.attributes.#{source.class.to_s.underscore}.#{error.attribute}")
-            errors.add(I18n.t(source.class.to_s.demodulize.underscore, scope: 'spree'), "#{field_name} #{error.message}")
-          end
-        else
-          source.errors.each do |field, error|
-            field_name = I18n.t("activerecord.attributes.#{source.class.to_s.underscore}.#{field}")
-            errors.add(I18n.t(source.class.to_s.demodulize.underscore, scope: 'spree'), "#{field_name} #{error}")
-          end
+        source.errors.each do |error|
+          field_name = I18n.t("activerecord.attributes.#{source.class.to_s.underscore}.#{error.attribute}")
+          errors.add(I18n.t(source.class.to_s.demodulize.underscore, scope: 'spree'), "#{field_name} #{error.message}")
         end
       end
       if errors.any?

data/app/models/spree/product/scopes.rb

@@ -214,11 +214,6 @@ module Spree
             where(subquery.arel.exists)
           end
 
-          def self.with_variant_sku_cont(sku)
-            Spree::Deprecation.warn("use .with_kept_variant_sku_cont instead")
-            with_kept_variant_sku_cont(sku)
-          end
-
           class << self
             private
 

data/app/models/spree/product.rb

@@ -96,7 +96,6 @@ module Spree
              :display_price,
              :has_default_price?,
              :images,
-             :price_for,
              :price_for_options,
              :rebuild_vat_prices=,
              to: :find_or_build_master
@@ -134,7 +133,7 @@ module Spree
 
     self.allowed_ransackable_associations = %w[stores variants_including_master master variants]
     self.allowed_ransackable_attributes = %w[name slug]
-    self.allowed_ransackable_scopes = %i[available with_discarded with_variant_sku_cont with_all_variant_sku_cont with_kept_variant_sku_cont]
+    self.allowed_ransackable_scopes = %i[available with_discarded with_all_variant_sku_cont with_kept_variant_sku_cont]
 
     # @return [Boolean] true if there are any variants
     def has_variants?
@@ -337,14 +336,8 @@ module Spree
     # If the master is invalid, the Product object will be assigned its errors
     def validate_master
       unless master.valid?
-        if Gem::Requirement.new(">= 6.1").satisfied_by?(Rails.gem_version)
-          master.errors.each do |error|
-            errors.add(error.attribute, error.message)
-          end
-        else
-          master.errors.each do |att, error|
-            errors.add(att, error)
-          end
+        master.errors.each do |error|
+          errors.add(error.attribute, error.message)
         end
       end
     end

data/app/models/spree/promotion/rules/item_total.rb

@@ -9,8 +9,6 @@ module Spree
       # To add extra operators please override `self.operators_map` or any other helper method.
       # To customize the error message you can also override `ineligible_message`.
       class ItemTotal < PromotionRule
-        include ActiveSupport::Deprecation::DeprecatedConstantAccessor
-
         preference :amount, :decimal, default: 100.00
         preference :currency, :string, default: ->{ Spree::Config[:currency] }
         preference :operator, :string, default: 'gt'
@@ -29,15 +27,6 @@ module Spree
           end
         end
 
-        # @deprecated
-        OPERATORS = operators_map.keys.map(&:to_s)
-        deprecate_constant(
-          :OPERATORS,
-          :operators_map,
-          message: "OPERATORS is deprecated! Use `operators_map.keys.map(&:to_s)` instead.",
-          deprecator: Spree::Deprecation,
-        )
-
         def applicable?(promotable)
           promotable.is_a?(Spree::Order)
         end