spree_core 4.1.13 → 4.2.0.rc4

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

@@ -9,7 +9,7 @@ module Spree
       end
 
       def payment_sources
-        credit_cards.with_payment_profile
+        credit_cards.with_payment_profile.not_expired
       end
 
       def drop_payment_source(source)

data/app/models/spree/ability.rb

@@ -23,59 +23,70 @@ module Spree
     end
 
     def initialize(user)
-      # add cancancan aliasing
-      alias_action :delete, to: :destroy
-      alias_action :create, :update, :destroy, to: :modify
+      alias_cancan_delete_action
 
       user ||= Spree.user_class.new
 
       if user.respond_to?(:has_spree_role?) && user.has_spree_role?('admin')
-        can :manage, :all
+        apply_admin_permissions(user)
       else
-        can :read, Country
-        can :read, OptionType
-        can :read, OptionValue
-        can :create, Order
-        can :show, Order do |order, token|
-          order.user == user || order.token && token == order.token
-        end
-        can :update, Order do |order, token|
-          !order.completed? && (order.user == user || order.token && token == order.token)
-        end
-        can :manage, Spree::Address do |address|
-          address.user == user
-        end
-        can :create, Spree::Address do |_address|
-          user.id.present?
-        end
-        can :read, CreditCard, user_id: user.id
-        can :read, Product
-        can :read, ProductProperty
-        can :read, Property
-        can :create, Spree.user_class
-        can [:show, :update, :destroy], Spree.user_class, id: user.id
-        can :read, State
-        can :read, Taxon
-        can :read, Taxonomy
-        can :read, Variant
-        can :read, Zone
+        apply_user_permissions(user)
       end
 
       # Include any abilities registered by extensions, etc.
+      # this is legacy behaviour and should be removed in Spree 5.0
       Ability.abilities.merge(abilities_to_register).each do |clazz|
         merge clazz.new(user)
       end
 
-      # Protect admin role
-      cannot [:update, :destroy], Role, name: ['admin']
+      protect_admin_role
     end
 
-    private
+    protected
 
     # you can override this method to register your abilities
     # this method has to return array of classes
     def abilities_to_register
       []
     end
+
+    def alias_cancan_delete_action
+      alias_action :delete, to: :destroy
+      alias_action :create, :update, :destroy, to: :modify
+    end
+
+    def apply_admin_permissions(user)
+      can :manage, :all
+    end
+
+    def apply_user_permissions(user)
+      can :read, ::Spree::Country
+      can :read, ::Spree::OptionType
+      can :read, ::Spree::OptionValue
+      can :create, ::Spree::Order
+      can :show, ::Spree::Order do |order, token|
+        order.user == user || order.token && token == order.token
+      end
+      can :update, ::Spree::Order do |order, token|
+        !order.completed? && (order.user == user || order.token && token == order.token)
+      end
+      can :manage, ::Spree::Address, user_id: user.id
+      can :read, ::Spree::CreditCard, user_id: user.id
+      can :read, ::Spree::Product
+      can :read, ::Spree::ProductProperty
+      can :read, ::Spree::Property
+      can :create, ::Spree.user_class
+      can [:show, :update, :destroy], ::Spree.user_class, id: user.id
+      can :read, ::Spree::State
+      can :read, ::Spree::Store
+      can :read, ::Spree::Taxon
+      can :read, ::Spree::Taxonomy
+      can :read, ::Spree::Variant
+      can :read, ::Spree::Zone
+    end
+
+    def protect_admin_role
+      cannot [:update, :destroy], ::Spree::Role, name: ['admin']
+    end
   end
 end

data/app/models/spree/address.rb

@@ -2,6 +2,10 @@ module Spree
   class Address < Spree::Base
     require 'twitter_cldr'
 
+    if Rails::VERSION::STRING >= '6.1'
+      serialize :preferences, Hash, default: {}
+    end
+
     NO_ZIPCODE_ISO_CODES ||= [
       'AO', 'AG', 'AW', 'BS', 'BZ', 'BJ', 'BM', 'BO', 'BW', 'BF', 'BI', 'CM', 'CF', 'KM', 'CG',
       'CD', 'CK', 'CUW', 'CI', 'DJ', 'DM', 'GQ', 'ER', 'FJ', 'TF', 'GAB', 'GM', 'GH', 'GD', 'GN',
@@ -10,10 +14,16 @@ module Spree
       'TO', 'TV', 'UG', 'AE', 'VU', 'YE', 'ZW'
     ].freeze
 
+    # The required states listed below match those used by PayPal and Shopify.
+    STATES_REQUIRED = [
+      'AU', 'AE', 'BR', 'CA', 'CN', 'ES', 'HK', 'IE', 'IN',
+      'IT', 'MY', 'MX', 'NZ', 'PT', 'RO', 'TH', 'US', 'ZA'
+    ].freeze
+
     # we're not freezing this on purpose so developers can extend and manage
     # those attributes depending of the logic of their applications
     ADDRESS_FIELDS = %w(firstname lastname company address1 address2 city state zipcode country phone)
-    EXCLUDED_KEYS_FOR_COMPARISION = %w(id updated_at created_at deleted_at user_id)
+    EXCLUDED_KEYS_FOR_COMPARISION = %w(id updated_at created_at deleted_at label user_id)
 
     belongs_to :country, class_name: 'Spree::Country'
     belongs_to :state, class_name: 'Spree::State', optional: true
@@ -31,6 +41,12 @@ module Spree
 
     validate :state_validate, :postal_code_validate
 
+    validates :label, uniqueness: { conditions: -> { where(deleted_at: nil) },
+                                    scope: :user_id,
+                                    case_sensitive: false,
+                                    allow_blank: true,
+                                    allow_nil: true }
+
     delegate :name, :iso3, :iso, :iso_name, to: :country, prefix: true
     delegate :abbr, to: :state, prefix: true, allow_nil: true
 

data/app/models/spree/adjustment.rb

@@ -27,6 +27,7 @@ module Spree
       belongs_to :source
     end
     belongs_to :order, class_name: 'Spree::Order', inverse_of: :all_adjustments
+    belongs_to :promotion_action, class_name: 'Spree::PromotionAction', foreign_key: :source_id, optional: true # created only for has_free_shipping?
 
     validates :adjustable, :order, :label, presence: true
     validates :amount, numericality: true

data/app/models/spree/app_configuration.rb

@@ -49,6 +49,7 @@ module Spree
     preference :expedited_exchanges_days_window, :integer, default: 14 # the amount of days the customer has to return their item after the expedited exchange is shipped in order to avoid being charged
     preference :layout, :string, default: 'spree/layouts/spree_application'
     preference :logo, :string, default: 'logo/spree_50.png'
+    preference :mailer_logo, :string, default: 'logo/spree_50.png'
     preference :max_level_in_taxons_menu, :integer, default: 1 # maximum nesting level in taxons menu
     preference :products_per_page, :integer, default: 12
     preference :require_master_price, :boolean, default: true
@@ -67,6 +68,9 @@ module Spree
     preference :non_expiring_credit_types, :array, default: []
     preference :credit_to_new_allocation, :boolean, default: false
 
+    # Multi store configurations
+    preference :show_store_selector, :boolean, default: false
+
     # searcher_class allows spree extension writers to provide their own Search class
     def searcher_class
       @searcher_class ||= Spree::Core::Search::Base

data/app/models/spree/app_dependencies.rb

@@ -12,7 +12,8 @@ module Spree
       :coupon_handler, :country_finder, :current_order_finder, :credit_card_finder,
       :completed_order_finder, :order_sorter, :cart_compare_line_items_service, :collection_paginator, :products_sorter,
       :products_finder, :taxon_finder, :line_item_by_variant_finder, :cart_estimate_shipping_rates_service,
-      :account_create_address_service, :account_update_address_service, :address_finder
+      :account_create_address_service, :account_update_address_service, :address_finder,
+      :collection_sorter
     ].freeze
 
     attr_accessor *INJECTION_POINTS
@@ -51,7 +52,8 @@ module Spree
       @checkout_get_shipping_rates_service = 'Spree::Checkout::GetShippingRates'
 
       # sorter
-      @order_sorter = 'Spree::Orders::Sort'
+      @collection_sorter = 'Spree::BaseSorter'
+      @order_sorter = 'Spree::BaseSorter'
       @products_sorter = 'Spree::Products::Sort'
 
       # paginator

data/app/models/spree/base.rb

@@ -25,4 +25,9 @@ class Spree::Base < ApplicationRecord
   def self.spree_base_scopes
     where(nil)
   end
+
+  # FIXME: https://github.com/rails/rails/issues/40943
+  def self.has_many_inversing
+    false
+  end
 end

data/app/models/spree/credit_card.rb

@@ -37,6 +37,11 @@ module Spree
 
     scope :with_payment_profile, -> { where.not(gateway_customer_profile_id: nil) }
     scope :default, -> { where(default: true) }
+    scope :not_expired, lambda {
+      where('CAST(spree_credit_cards.year AS DECIMAL) > ?', Time.current.year).
+        or(where('CAST(spree_credit_cards.year AS DECIMAL) = ?', Time.current.year).
+           where('CAST(spree_credit_cards.month AS DECIMAL) >= ?', Time.current.month))
+    }
 
     # needed for some of the ActiveMerchant gateways (eg. SagePay)
     alias_attribute :brand, :cc_type

data/app/models/spree/fulfilment_changer.rb

@@ -36,7 +36,7 @@ module Spree
     private
 
     attr_reader :variant, :quantity, :current_stock_location, :desired_stock_location,
-      :current_shipment, :desired_shipment, :available_quantity
+                :current_shipment, :desired_shipment, :available_quantity
 
     def handle_stock
       ActiveRecord::Base.transaction do
@@ -45,13 +45,64 @@ module Spree
           desired_stock_location.unstock(variant, unstock_quantity, desired_shipment)
         end
 
-        update_current_shipment_inventory_units(new_on_hand_quantity, :on_hand)
-        update_current_shipment_inventory_units(quantity - new_on_hand_quantity, :backordered)
+        move_inventory_units_between_shipments
+      end
+    end
+
+    def move_inventory_units_between_shipments
+      update_desired_shipment_inventory_units
+      update_current_shipment_inventory_units
+    end
+
+    def current_shipment_units
+      @current_shipment_units ||= current_shipment.inventory_units.on_hand_or_backordered.where(variant_id: variant.id)
+    end
+
+    def update_desired_shipment_inventory_units
+      on_hand_unit = get_desired_shipment_inventory_unit(:on_hand)
+      on_hand_unit.update(quantity: on_hand_unit.quantity + new_on_hand_quantity)
+
+      new_backorder_quantity = current_on_hand_quantity - new_on_hand_quantity
+      if new_backorder_quantity > 0
+        backordered_unit = get_desired_shipment_inventory_unit(:backordered)
+        backordered_unit.update(quantity: backordered_unit.quantity + new_backorder_quantity)
+      end
+    end
+
+    def update_current_shipment_inventory_units
+      reduced_quantity = current_on_hand_quantity
+
+      # Reduce quantities from all backordered units first in case there is more than one.
+      backorder_units = current_shipment_units.backordered
+      reduced_quantity = reduce_units_quantities(reduced_quantity, backorder_units) if backorder_units.any?
+
+      # Reduce quantities from all on_hand units in case there is more than one.
+      if reduced_quantity > 0
+        on_hand_units = current_shipment_units.on_hand
+        reduce_units_quantities(reduced_quantity, on_hand_units) if on_hand_units.any?
+      end
+    end
+
+    def reduce_units_quantities(reduced_quantity, units)
+      units.each do |unit|
+        unit.quantity > reduced_quantity ? unit.update(quantity: unit.quantity - reduced_quantity) : unit.destroy!
+        reduced_quantity -= unit.quantity
+      end
+      reduced_quantity
+    end
+
+    def get_desired_shipment_inventory_unit(state)
+      desired_shipment.inventory_units.find_or_create_by(state: state) do |unit|
+        current_shipment_unit = current_shipment_units.first
+        unit.variant_id = current_shipment_unit.variant_id
+        unit.order_id = current_shipment_unit.order_id
+        unit.line_item_id = current_shipment_unit.line_item_id
+        unit.quantity = 0
       end
     end
 
     def after_process_shipments
-      if current_shipment.inventory_units.length.zero?
+      if current_shipment.inventory_units.sum(:quantity).zero?
         current_shipment.destroy!
       else
         current_shipment.refresh_rates
@@ -64,7 +115,7 @@ module Spree
     end
 
     def new_on_hand_quantity
-      [available_quantity, quantity].min
+      [available_quantity, current_on_hand_quantity].min
     end
 
     def unstock_quantity
@@ -72,16 +123,7 @@ module Spree
     end
 
     def current_on_hand_quantity
-      [current_shipment.inventory_units.on_hand_or_backordered.size, quantity].min
-    end
-
-    def update_current_shipment_inventory_units(quantity, state)
-      current_shipment.
-        inventory_units.
-        where(variant: variant).
-        order(state: :asc).
-        limit(quantity).
-        update_all(shipment_id: desired_shipment.id, state: state)
+      [current_shipment.inventory_units.on_hand_or_backordered.sum(:quantity), quantity].min
     end
 
     def reload_shipment_inventory_units
@@ -105,7 +147,7 @@ module Spree
     def enough_stock_at_desired_location
       return if Spree::Stock::Quantifier.new(variant, desired_stock_location).can_supply?(quantity)
 
-      errors.add(:desired_shipment, :not_enough_stock_at_desired_location)
+      errors.add(:desired_shipment, :has_not_enough_stock_at_desired_location)
     end
 
     def desired_shipment_different_from_current

data/app/models/spree/inventory_unit.rb

@@ -1,10 +1,10 @@
 module Spree
   class InventoryUnit < Spree::Base
     with_options inverse_of: :inventory_units do
-      belongs_to :variant, class_name: 'Spree::Variant'
+      belongs_to :variant, -> { with_deleted }, class_name: 'Spree::Variant'
       belongs_to :order, class_name: 'Spree::Order'
       belongs_to :shipment, class_name: 'Spree::Shipment', touch: true, optional: true
-      has_many :return_items
+      has_many :return_items, inverse_of: :inventory_unit
       has_many :return_authorizations, class_name: 'Spree::ReturnAuthorization', through: :return_items
       belongs_to :line_item, class_name: 'Spree::LineItem'
     end
@@ -84,11 +84,6 @@ module Spree
       split_inventory!(1)
     end
 
-    # Remove variant default_scope `deleted_at: nil`
-    def variant
-      Spree::Variant.unscoped { super }
-    end
-
     def current_or_new_return_item
       Spree::ReturnItem.from_inventory_unit(self)
     end

data/app/models/spree/line_item.rb

@@ -4,7 +4,7 @@ module Spree
 
     with_options inverse_of: :line_items do
       belongs_to :order, class_name: 'Spree::Order', touch: true
-      belongs_to :variant, class_name: 'Spree::Variant'
+      belongs_to :variant, -> { with_deleted }, class_name: 'Spree::Variant'
     end
     belongs_to :tax_category, class_name: 'Spree::TaxCategory'
 
@@ -57,7 +57,13 @@ module Spree
     end
 
     def update_price
-      self.price = variant.price_including_vat_for(tax_zone: tax_zone)
+      currency_price = variant.price_in(order.currency)
+
+      self.price = if currency_price.amount.present?
+                     currency_price.price_including_vat_for(tax_zone: tax_zone)
+                   else
+                     0
+                   end
     end
 
     def copy_tax_category
@@ -111,11 +117,6 @@ module Spree
       assign_attributes opts
     end
 
-    # Remove variant default_scope `deleted_at: nil`
-    def variant
-      Spree::Variant.unscoped { super }
-    end
-
     private
 
     def ensure_valid_quantity

data/app/models/spree/log_entry.rb

@@ -11,7 +11,7 @@ module Spree
     end
 
     def parsed_details
-      @details ||= YAML.load(details)
+      @details ||= YAML.safe_load(details, [ActiveMerchant::Billing::Response])
     end
   end
 end

data/app/models/spree/option_type.rb

@@ -19,12 +19,18 @@ module Spree
 
     default_scope { order(:position) }
 
+    scope :filterable, -> { where(filterable: true) }
+
     accepts_nested_attributes_for :option_values, reject_if: ->(ov) { ov[:name].blank? || ov[:presentation].blank? }, allow_destroy: true
 
     after_touch :touch_all_products
 
     def filter_param
-      presentation.titleize.delete(' ').downcase
+      name.titleize.delete(' ').downcase
+    end
+
+    def self.color
+      find_by(name: 'color')
     end
 
     private

data/app/models/spree/order.rb

@@ -157,6 +157,7 @@ module Spree
     scope :completed_between, ->(start_date, end_date) { where(completed_at: start_date..end_date) }
     scope :complete, -> { where.not(completed_at: nil) }
     scope :incomplete, -> { where(completed_at: nil) }
+    scope :not_canceled, -> { where.not(state: 'canceled') }
 
     # shows completed orders first, by their completed_at date, then uncompleted orders by their created_at
     scope :reverse_chronological, -> { order(Arel.sql('spree_orders.completed_at IS NULL'), completed_at: :desc, created_at: :desc) }
@@ -302,15 +303,15 @@ module Spree
     def outstanding_balance
       if canceled?
         -1 * payment_total
-      elsif refunds.exists?
-        # If refund has happened add it back to total to prevent balance_due payment state
-        # See: https://github.com/spree/spree/issues/6229 & https://github.com/spree/spree/issues/8136
-        total - (payment_total + refunds.sum(:amount))
       else
-        total - payment_total
+        total - (payment_total + reimbursement_paid_total)
       end
     end
 
+    def reimbursement_paid_total
+      reimbursements.sum(&:paid_amount)
+    end
+
     def outstanding_balance?
       outstanding_balance != 0
     end
@@ -356,6 +357,8 @@ module Spree
 
       deliver_order_confirmation_email unless confirmation_delivered?
 
+      deliver_store_owner_order_notification_email if deliver_store_owner_order_notification_email?
+
       consider_risk
     end
 
@@ -646,6 +649,13 @@ module Spree
         sum(:amount)
     end
 
+    def has_free_shipping?
+      shipment_adjustments.
+        joins(:promotion_action).
+        where(spree_adjustments: { eligible: true, source_type: 'Spree::PromotionAction' },
+              spree_promotion_actions: { type: 'Spree::Promotion::Actions::FreeShipping' }).exists?
+    end
+
     private
 
     def link_by_email
@@ -711,5 +721,17 @@ module Spree
     def credit_card_nil_payment?(attributes)
       payments.store_credits.present? && attributes[:amount].to_f.zero?
     end
+
+    # Returns true if:
+    #   1. an email address is set for new order notifications AND
+    #   2. no notification for this order has been sent yet.
+    def deliver_store_owner_order_notification_email?
+      store.new_order_notifications_email.present? && !store_owner_notification_delivered?
+    end
+
+    def deliver_store_owner_order_notification_email
+      OrderMailer.store_owner_notification_email(id).deliver_later
+      update_column(:store_owner_notification_delivered, true)
+    end
   end
 end