spree_core 4.10.1 → 5.0.0.rc1

data/app/models/spree/line_item.rb

@@ -1,5 +1,5 @@
 module Spree
-  class LineItem < Spree::Base
+  class LineItem < Spree.base_class
     include Spree::Metadata
     if defined?(Spree::Webhooks::HasWebhooks)
       include Spree::Webhooks::HasWebhooks
@@ -19,6 +19,7 @@ module Spree
 
     has_many :adjustments, as: :adjustable, dependent: :destroy
     has_many :inventory_units, inverse_of: :line_item
+    has_many :shipments, through: :inventory_units, source: :shipment
     has_many :digital_links, dependent: :destroy
 
     before_validation :copy_price
@@ -52,6 +53,8 @@ module Spree
     delegate :tax_zone, to: :order
     delegate :digital?, to: :variant
 
+    scope :with_digital_assets, -> { joins(:variant).merge(Spree::Variant.with_digital_assets) }
+
     attr_accessor :target_shipment
 
     self.whitelisted_ransackable_associations = %w[variant order tax_category]
@@ -82,7 +85,7 @@ module Spree
     extend DisplayMoney
     money_methods :amount, :subtotal, :discounted_amount, :final_amount, :total, :price,
                   :adjustment_total, :additional_tax_total, :promo_total, :included_tax_total,
-                  :pre_tax_amount
+                  :pre_tax_amount, :shipping_cost, :tax_total
 
     alias single_money display_price
     alias single_display_amount display_price
@@ -136,6 +139,27 @@ module Spree
       inventory_units.all?(&:shipped?)
     end
 
+    # Returns the shipping cost for the line item
+    #
+    # @return [BigDecimal]
+    def shipping_cost
+      shipments.sum do |shipment|
+        # Skip cancelled shipments
+        return BigDecimal('0') if shipment.canceled?
+
+        # Get all inventory units in this shipment for this line item
+        line_item_units = shipment.inventory_units.where(line_item_id: id).count
+
+        # Get total inventory units in this shipment
+        total_units = shipment.inventory_units.count
+
+        # Calculate proportional shipping cost
+        return BigDecimal('0') if total_units.zero? || line_item_units.zero? || shipment.cost.zero?
+
+        shipment.cost * (line_item_units.to_d / total_units)
+      end
+    end
+
     def options=(options = {})
       return unless options.present?
 
@@ -147,6 +171,17 @@ module Spree
       assign_attributes opts
     end
 
+    # Returns the maximum quantity that can be added to the line item
+    #
+    # @return [Integer]
+    def maximum_quantity
+      @maximum_quantity ||= variant.backorderable? ? Spree::DatabaseTypeUtilities.maximum_value_for(:integer) : variant.total_on_hand
+    end
+
+    def with_digital_assets?
+      variant.with_digital_assets?
+    end
+
     private
 
     def ensure_valid_quantity

data/app/models/spree/log_entry.rb

@@ -1,5 +1,5 @@
 module Spree
-  class LogEntry < Spree::Base
+  class LogEntry < Spree.base_class
     if defined?(Spree::Security::LogEntries)
       include Spree::Security::LogEntries
     end

data/app/models/spree/option_type.rb

@@ -1,5 +1,8 @@
 module Spree
-  class OptionType < Spree::Base
+  class OptionType < Spree.base_class
+    COLOR_NAMES = %w[color colour].freeze
+
+    include Spree::ParameterizableName
     include Spree::UniqueName
     include Spree::Metadata
     include Spree::TranslatableResource
@@ -15,41 +18,72 @@ module Spree
       translates(*TRANSLATABLE_FIELDS, column_fallback: true)
     end
 
+    #
+    # Magic methods
+    #
+    self.whitelisted_ransackable_scopes = %w[search_by_name]
     acts_as_list
     auto_strip_attributes :name, :presentation
 
+    #
+    # Associations
     with_options dependent: :destroy, inverse_of: :option_type do
       has_many :option_values, -> { order(:position) }
       has_many :product_option_types
     end
-
     has_many :products, through: :product_option_types
-
     has_many :option_type_prototypes, class_name: 'Spree::OptionTypePrototype'
     has_many :prototypes, through: :option_type_prototypes, class_name: 'Spree::Prototype'
 
+    #
+    # Validations
+    #
     validates :presentation, presence: true
 
+    #
+    # Scopes
+    #
     default_scope { order(:position) }
-
+    scope :colors, -> { where(name: COLOR_NAMES) }
     scope :filterable, -> { where(filterable: true) }
 
+    if defined?(PgSearch)
+      # full text search
+      include PgSearch::Model
+      pg_search_scope :search_by_name, against: %i[name presentation]
+    else
+      scope :search_by_name, ->(query) { where('name LIKE ?', "%#{query}%") }
+    end
+
+    #
+    # Attributes
+    #
     accepts_nested_attributes_for :option_values, reject_if: ->(ov) { ov[:name].blank? || ov[:presentation].blank? }, allow_destroy: true
 
+    #
+    # Callbacks
+    #
     after_touch :touch_all_products
+    after_update :touch_all_products, if: -> { saved_changes.key?(:presentation) }
+    after_destroy :touch_all_products
 
+    # legacy, name itself is now parameterized before saving
     def filter_param
       name.parameterize
     end
 
     def self.color
-      find_by(name: 'color')
+      colors.first
+    end
+
+    def color?
+      name.in?(COLOR_NAMES)
     end
 
     private
 
     def touch_all_products
-      products.update_all(updated_at: Time.current)
+      products.touch_all
     end
   end
 end

data/app/models/spree/option_type_prototype.rb

@@ -1,5 +1,5 @@
 module Spree
-  class OptionTypePrototype < Spree::Base
+  class OptionTypePrototype < Spree.base_class
     belongs_to :option_type, class_name: 'Spree::OptionType'
     belongs_to :prototype, class_name: 'Spree::Prototype'
 

data/app/models/spree/option_value.rb

@@ -1,5 +1,6 @@
 module Spree
-  class OptionValue < Spree::Base
+  class OptionValue < Spree.base_class
+    include Spree::ParameterizableName
     include Spree::Metadata
     include Spree::TranslatableResource
     if defined?(Spree::Webhooks::HasWebhooks)
@@ -14,19 +15,32 @@ module Spree
       translates(*TRANSLATABLE_FIELDS, column_fallback: true)
     end
 
-    belongs_to :option_type, class_name: 'Spree::OptionType', touch: true, inverse_of: :option_values
-
+    #
+    # Magic methods
+    #
     acts_as_list scope: :option_type
     auto_strip_attributes :name, :presentation
+    self.whitelisted_ransackable_attributes = ['presentation']
 
+    #
+    # Associations
+    #
+    belongs_to :option_type, class_name: 'Spree::OptionType', touch: true, inverse_of: :option_values
     has_many :option_value_variants, class_name: 'Spree::OptionValueVariant'
     has_many :variants, through: :option_value_variants, class_name: 'Spree::Variant'
+    has_many :products, through: :variants, class_name: 'Spree::Product'
 
+    #
+    # Validations
+    #
     with_options presence: true do
       validates :name, uniqueness: { scope: :option_type_id, case_sensitive: false }
       validates :presentation
     end
 
+    #
+    # Scopes
+    #
     scope :filterable, lambda {
       joins(:option_type).
         where(OptionType.table_name => { filterable: true }).
@@ -38,16 +52,32 @@ module Spree
         where(Variant.table_name => { product_id: products.map(&:id) })
     }
 
+    #
+    # Callbacks
+    #
     after_touch :touch_all_variants
+    after_update :touch_all_products, if: -> { saved_changes.key?(:presentation) }
+    after_touch :touch_all_products
 
     delegate :name, :presentation, to: :option_type, prefix: true, allow_nil: true
 
-    self.whitelisted_ransackable_attributes = ['presentation']
+    def self.to_tom_select_json
+      all.pluck(:id, :presentation).map do |id, presentation|
+        {
+          id: id,
+          name: presentation
+        }
+      end
+    end
 
     private
 
     def touch_all_variants
-      variants.update_all(updated_at: Time.current)
+      variants.touch_all
+    end
+
+    def touch_all_products
+      products.touch_all
     end
   end
 end

data/app/models/spree/option_value_variant.rb

@@ -1,5 +1,5 @@
 module Spree
-  class OptionValueVariant < Spree::Base
+  class OptionValueVariant < Spree.base_class
     belongs_to :option_value, class_name: 'Spree::OptionValue'
     belongs_to :variant, touch: true, class_name: 'Spree::Variant'
 
@@ -7,7 +7,7 @@ module Spree
     validates :option_value_id, uniqueness: { scope: :variant_id }
 
     scope :for_option_types, lambda { |option_types|
-      joins(:option_value).merge(Spree::OptionValue.where(option_types: option_types))
+      joins(:option_value).merge(Spree::OptionValue.where(option_type: option_types))
     }
   end
 end

data/app/models/spree/order/address_book.rb

@@ -1,20 +1,15 @@
-# https://github.com/spree-contrib/spree_address_book/blob/master/app/models/spree/order_decorator.rb
 module Spree
-  class Order < Spree::Base
+  class Order < Spree.base_class
     module AddressBook
-      extend ActiveSupport::Concern # FIXME: this module is not required to be a concern
-
       def clone_shipping_address
-        if ship_address
-          self.bill_address = ship_address
-        end
+        self.bill_address = ship_address if ship_address
+        user.bill_address = ship_address if should_assign_user_default_address?(ship_address)
         true
       end
 
       def clone_billing_address
-        if bill_address
-          self.ship_address = bill_address
-        end
+        self.ship_address = bill_address if bill_address
+        user.ship_address = bill_address if should_assign_user_default_address?(bill_address)
         true
       end
 
@@ -30,7 +25,7 @@ module Spree
 
       def bill_address_attributes=(attributes)
         self.bill_address = update_or_create_address(attributes)
-        user.bill_address = bill_address if user && user.bill_address.nil?
+        user.bill_address = bill_address if should_assign_user_default_address?(bill_address)
       end
 
       def ship_address_id=(id)
@@ -45,7 +40,8 @@ module Spree
 
       def ship_address_attributes=(attributes)
         self.ship_address = update_or_create_address(attributes)
-        user.ship_address = ship_address if user && user.ship_address.nil?
+        user.ship_address = ship_address if should_assign_user_default_address?(ship_address)
+        self.ship_address = nil if quick_checkout_address?(attributes[:quick_checkout]) && !ship_address.persisted?
       end
 
       private
@@ -53,10 +49,10 @@ module Spree
       def update_or_create_address(attributes = {})
         return if attributes.blank?
 
-        attributes.transform_values! { |v| v == '' ? nil : v }
+        attributes.transform_values!(&:presence)
         attributes = attributes.to_h.symbolize_keys
 
-        default_address_scope = user ? user.addresses : ::Spree::Address
+        default_address_scope = user ? user.addresses : ::Spree::Address.where(user_id: nil)
         default_address = default_address_scope.find_by(id: attributes[:id])
 
         if default_address&.editable?
@@ -65,7 +61,30 @@ module Spree
           return default_address
         end
 
-        ::Spree::Address.find_or_create_by(attributes.except(:id, :updated_at, :created_at))
+        attributes = attributes.except(:id, :updated_at, :created_at)
+        attributes[:user_id] = user&.id
+
+        existing_address = find_existing_address(attributes)
+        return existing_address if existing_address
+
+        ::Spree::Address.create(attributes)
+      end
+
+      def find_existing_address(attributes)
+        address_attributes = attributes.except(:state_name)
+        state_name = attributes[:state_name]
+
+        scope = Spree::Address.not_deleted.where(address_attributes)
+        scope = scope.by_state_name_or_abbr(state_name) if state_name.present?
+        scope.first
+      end
+
+      def quick_checkout_address?(quick_checkout_param)
+        quick_checkout_param.present? ? quick_checkout_param.to_b : false
+      end
+
+      def should_assign_user_default_address?(address)
+        user.present? && address.present? && address.valid? && address.user == user && !address.quick_checkout?
       end
     end
   end

data/app/models/spree/order/checkout.rb

@@ -1,5 +1,5 @@
 module Spree
-  class Order < Spree::Base
+  class Order < Spree.base_class
     module Checkout
       def self.included(klass)
         klass.class_eval do
@@ -85,9 +85,10 @@ module Spree
                 end
 
                 before_transition to: :complete do |order|
-                  order.create_digital_links if order.some_digital?
+                  order.create_digital_links if order.with_digital_assets?
                 end
 
+                after_transition to: :complete, do: :create_user_record
                 after_transition to: :complete, do: :persist_user_credit_card
                 before_transition to: :payment, do: :set_shipments_cost
                 before_transition to: :payment, do: :create_tax_charge!
@@ -108,6 +109,7 @@ module Spree
                 before_transition to: :delivery, do: :create_shipment_tax_charge!
                 before_transition from: :delivery, do: :apply_free_shipping_promotions
                 before_transition to: :delivery, do: :apply_unassigned_promotions
+                after_transition to: :delivery, do: :go_to_payment_if_fully_digital!
               end
 
               before_transition to: :resumed, do: :ensure_line_item_variants_are_not_discontinued
@@ -115,6 +117,7 @@ module Spree
               before_transition to: :resumed, do: proc { |order| order.state_machine_resumed = true }
 
               after_transition to: :complete, do: :finalize!
+              after_transition to: :complete, do: :use_all_coupon_codes
               after_transition to: :resumed, do: :after_resume
               after_transition to: :canceled, do: :after_cancel
 
@@ -269,6 +272,13 @@ module Spree
             end
           end
 
+          def create_user_record
+            return if user.present?
+            return unless signup_for_an_account?
+
+            Spree::Orders::CreateUserAccount.call(order: self, accepts_email_marketing: accept_marketing?)
+          end
+
           def persist_user_credit_card
             return unless !temporary_credit_card && user_id && valid_credit_cards.present?
 

data/app/models/spree/order/currency_updater.rb

@@ -1,5 +1,5 @@
 module Spree
-  class Order < Spree::Base
+  class Order < Spree.base_class
     module CurrencyUpdater
       extend ActiveSupport::Concern # FIXME: this module is not required to be a concern
 

data/app/models/spree/order/digital.rb

@@ -1,5 +1,5 @@
 module Spree
-  class Order < Spree::Base
+  class Order < Spree.base_class
     module Digital
       def digital?
         if line_items.empty?
@@ -13,8 +13,12 @@ module Spree
         line_items.any?(&:digital?)
       end
 
+      def with_digital_assets?
+        line_items.any?(&:with_digital_assets?)
+      end
+
       def digital_line_items
-        line_items.select(&:digital?)
+        line_items.with_digital_assets.distinct
       end
 
       def digital_links
@@ -22,12 +26,19 @@ module Spree
       end
 
       def create_digital_links
-        digital_line_items.each do |line_item|
+        digital_line_items.includes(variant: :digitals).each do |line_item|
           line_item.variant.digitals.each do |digital|
             line_item.digital_links.create!(digital: digital)
           end
         end
       end
+
+      def go_to_payment_if_fully_digital!
+        return unless digital?
+        return unless delivery?
+
+        next!
+      end
     end
   end
 end

data/app/models/spree/order/emails.rb

@@ -1,5 +1,5 @@
 module Spree
-  class Order < Spree::Base
+  class Order < Spree.base_class
     module Emails
       extend ActiveSupport::Concern
 

data/app/models/spree/order/payments.rb

@@ -1,5 +1,5 @@
 module Spree
-  class Order < Spree::Base
+  class Order < Spree.base_class
     module Payments
       extend ActiveSupport::Concern # FIXME: this module is not required to be a concern
       included do
@@ -51,23 +51,11 @@ module Spree
             break if payment_total >= total
 
             payment.public_send(method)
-
-            if payment.completed? && payment_total != total_without_pending_store_credits
-              self.payment_total += payment.amount
-            end
           end
         rescue Core::GatewayError => e
           result = !!Spree::Config[:allow_checkout_on_gateway_error]
           errors.add(:base, e.message) && (return result)
         end
-
-        # Pending store credits are not added to `self.payment_total`.
-        # It can cause a situation where the amount of the credit card payment reduced with store credits
-        # may be added twice to `self.payment_total` causing wrong `order.outstanding_balance`
-        # calculations and thus an incorrect payment state.
-        def total_without_pending_store_credits
-          total - payments.map { |p| p.amount if p.source.is_a?(Spree::StoreCredit) && p.pending? }.sum(&:to_f)
-        end
       end
     end
   end

data/app/models/spree/order/store_credit.rb

@@ -1,5 +1,5 @@
 module Spree
-  class Order < Spree::Base
+  class Order < Spree.base_class
     module StoreCredit
       def add_store_credit_payments(amount = nil)
         Spree::Dependencies.checkout_add_store_credit_service.constantize.call(order: self, amount: amount)
@@ -10,9 +10,7 @@ module Spree
       end
 
       def covered_by_store_credit?
-        return false unless user
-
-        user.total_available_store_credit >= total
+        user.present? && total_applied_store_credit.positive? && total_applied_store_credit >= total
       end
       alias covered_by_store_credit covered_by_store_credit?
 
@@ -22,6 +20,12 @@ module Spree
         user.total_available_store_credit(currency, store)
       end
 
+      def available_store_credits
+        return Spree::StoreCredit.none if user.nil?
+
+        user.store_credits.for_store(store).where(currency: currency).available.sort_by(&:amount_remaining).reverse
+      end
+
       def could_use_store_credit?
         return false if Spree::PaymentMethod::StoreCredit.available.empty?
 
@@ -32,11 +36,15 @@ module Spree
         total - total_applicable_store_credit
       end
 
+      def total_minus_store_credits
+        total - total_applied_store_credit
+      end
+
       def total_applicable_store_credit
         if payment? || confirm? || complete?
           total_applied_store_credit
         else
-          [total, (user.try(:total_available_store_credit) || 0.0)].min
+          [total, user.try(:total_available_store_credit) || 0.0].min
         end
       end
 
@@ -67,6 +75,10 @@ module Spree
       def display_store_credit_remaining_after_capture
         Spree::Money.new(total_available_store_credit - total_applicable_store_credit, currency: currency)
       end
+
+      def display_total_minus_store_credits
+        Spree::Money.new(total_minus_store_credits, currency: currency)
+      end
     end
   end
 end

data/app/models/spree/order/webhooks.rb

@@ -1,5 +1,5 @@
 module Spree
-  class Order < Spree::Base
+  class Order < Spree.base_class
     module Webhooks
       extend ActiveSupport::Concern