spree_core 3.6.6 → 3.7.0.rc1

data/app/models/spree/promotion/actions/create_item_adjustments.rb

@@ -8,8 +8,9 @@ module Spree
         before_validation -> { self.calculator ||= Calculator::PercentOnLineItem.new }
 
         def perform(options = {})
-          order = options[:order]
+          order     = options[:order]
           promotion = options[:promotion]
+
           create_unique_adjustments(order, order.line_items) do |line_item|
             promotion.line_item_actionable?(order, line_item)
           end
@@ -17,7 +18,14 @@ module Spree
 
         def compute_amount(line_item)
           return 0 unless promotion.line_item_actionable?(line_item.order, line_item)
-          [line_item.amount, compute(line_item)].min * -1
+
+          amounts = [line_item.amount, compute(line_item)]
+          order   = line_item.order
+
+          # Prevent negative order totals
+          amounts << order.amount - order.adjustments.sum(:amount).abs if order.adjustments.any?
+
+          amounts.min * -1
         end
       end
     end

data/app/models/spree/promotion/actions/create_line_items.rb

@@ -43,7 +43,7 @@ module Spree
           promotion_action_line_items.each do |item|
             current_quantity = order.quantity_of(item.variant)
             if current_quantity < item.quantity && item_available?(item)
-              line_item = order.contents.add(item.variant, item.quantity - current_quantity)
+              line_item = Spree::Cart::AddItem.call(order: order, variant: item.variant, quantity: item.quantity - current_quantity).value
               action_taken = true if line_item.try(:valid?)
             end
           end
@@ -62,7 +62,8 @@ module Spree
           promotion_action_line_items.each do |item|
             line_item = order.find_line_item_by_variant(item.variant)
             next unless line_item.present?
-            order.contents.remove(item.variant, (item.quantity || 1))
+
+            Spree::Cart::RemoveItem.call(order: order, variant: item.variant, quantity: (item.quantity || 1))
             action_taken = true
           end
 

data/app/models/spree/promotion/actions/free_shipping.rb

@@ -6,6 +6,7 @@ module Spree
 
         def perform(payload = {})
           order = payload[:order]
+
           create_unique_adjustments(order, order.shipments)
         end
 

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

@@ -19,8 +19,8 @@ module Spree
         def eligible?(order, _options = {})
           item_total = order.item_total
 
-          lower_limit_condition = item_total.send(preferred_operator_min == 'gte' ? :>= : :>, BigDecimal.new(preferred_amount_min.to_s))
-          upper_limit_condition = item_total.send(preferred_operator_max == 'lte' ? :<= : :<, BigDecimal.new(preferred_amount_max.to_s))
+          lower_limit_condition = item_total.send(preferred_operator_min == 'gte' ? :>= : :>, BigDecimal(preferred_amount_min.to_s))
+          upper_limit_condition = item_total.send(preferred_operator_max == 'lte' ? :<= : :<, BigDecimal(preferred_amount_max.to_s))
 
           eligibility_errors.add(:base, ineligible_message_max) unless upper_limit_condition
           eligibility_errors.add(:base, ineligible_message_min) unless lower_limit_condition

data/app/models/spree/promotion_handler/coupon.rb

@@ -17,6 +17,8 @@ module Spree
           else
             set_error_code :coupon_code_not_found
           end
+        else
+          set_error_code :coupon_code_not_found
         end
         self
       end
@@ -39,14 +41,14 @@ module Spree
         self
       end
 
-      def set_success_code(c)
-        @status_code = c
-        @success = Spree.t(c)
+      def set_success_code(code)
+        @status_code = code
+        @success = Spree.t(code)
       end
 
-      def set_error_code(c)
-        @status_code = c
-        @error = Spree.t(c)
+      def set_error_code(code)
+        @status_code = code
+        @error = Spree.t(code)
       end
 
       def promotion
@@ -73,6 +75,7 @@ module Spree
         Spree::PromotionActionLineItem.where(promotion_action: create_line_item_actions_ids).find_each do |item|
           line_item = order.find_line_item_by_variant(item.variant)
           next if line_item.blank?
+
           order.contents.remove(item.variant, item.quantity)
         end
       end
@@ -80,6 +83,7 @@ module Spree
       def handle_present_promotion
         return promotion_usage_limit_exceeded if promotion.usage_limit_exceeded?(order)
         return promotion_applied if promotion_exists_on_order?
+
         unless promotion.eligible?(order)
           self.error = promotion.eligibility_errors.full_messages.first unless promotion.eligibility_errors.blank?
           return (error || ineligible_for_this_order)

data/app/models/spree/promotion_handler/page.rb

@@ -9,7 +9,7 @@ module Spree
       end
 
       def activate
-        if promotion && promotion.eligible?(order)
+        if promotion&.eligible?(order)
           promotion.activate(order: order)
         end
       end

data/app/models/spree/promotion_handler/promotion_duplicator.rb

@@ -40,10 +40,10 @@ module Spree
 
           @new_promotion.promotion_actions << new_action
 
-          if action.try(:promotion_action_line_items)
-            action.promotion_action_line_items.each do |item|
-              new_action.promotion_action_line_items << item.dup
-            end
+          next unless action.try(:promotion_action_line_items)
+
+          action.promotion_action_line_items.each do |item|
+            new_action.promotion_action_line_items << item.dup
           end
         end
       end

data/app/models/spree/refund.rb

@@ -58,7 +58,7 @@ module Spree
                    payment.payment_method.credit(credit_cents, payment.source, payment.transaction_id, originator: self)
                  else
                    payment.payment_method.credit(credit_cents, payment.transaction_id, originator: self)
-      end
+                 end
 
       unless response.success?
         logger.error(Spree.t(:gateway_error) + "  #{response.to_yaml}")

data/app/models/spree/reimbursement/reimbursement_type_engine.rb

@@ -37,6 +37,7 @@ module Spree
         return valid_preferred_reimbursement_type?(return_item) ? return_item.preferred_reimbursement_type.class : nil
       end
       return expired_reimbursement_type if past_reimbursable_time_period?(return_item)
+
       default_reimbursement_type
     end
   end

data/app/models/spree/reimbursement_tax_calculator.rb

@@ -24,13 +24,13 @@ module Spree
                            0
                          else
                            return_item.pre_tax_amount / calculated_refund
-        end
+                         end
 
         additional_tax_total = percent_of_tax * return_item.inventory_unit.additional_tax_total
         included_tax_total   = percent_of_tax * return_item.inventory_unit.included_tax_total
 
         return_item.update_attributes!(additional_tax_total: additional_tax_total,
-                                       included_tax_total:   included_tax_total)
+                                       included_tax_total: included_tax_total)
       end
     end
   end

data/app/models/spree/return_item.rb

@@ -151,6 +151,7 @@ module Spree
       # ever returned. This means that the inventory unit's line_item
       # will have a different variant than the inventory unit itself
       return unless exchange_required?
+
       exchange_inventory_units.build(variant: exchange_variant, line_item: inventory_unit.line_item,
                                      order: inventory_unit.order, quantity: return_quantity)
     end
@@ -163,6 +164,10 @@ module Spree
       self.pre_tax_amount = refund_amount_calculator.new.compute(self)
     end
 
+    def currency
+      return_authorization.try(:currency) || Spree::Config[:currency]
+    end
+
     private
 
     def persist_acceptance_status_errors
@@ -176,10 +181,6 @@ module Spree
                                stock_location_id: customer_return.stock_location_id)
     end
 
-    def currency
-      return_authorization.try(:currency) || Spree::Config[:currency]
-    end
-
     def process_inventory_unit!
       inventory_unit.return!
       if should_restock?
@@ -207,6 +208,7 @@ module Spree
 
     def eligible_exchange_variant
       return unless exchange_variant && exchange_variant_id_changed?
+
       unless eligible_exchange_variants.include?(exchange_variant)
         errors.add(:base, Spree.t(:invalid_exchange_variant))
       end
@@ -225,6 +227,7 @@ module Spree
     def sufficient_quantity_for_return
       # Only perform the check if everything is good so far
       return unless errors.empty? && return_quantity > inventory_unit.quantity
+
       errors.add(:return_quantity, Spree.t(:cannot_return_more_than_bought_quantity))
     end
 

data/app/models/spree/return_item/eligibility_validator/default.rb

@@ -2,12 +2,12 @@ module Spree
   class ReturnItem::EligibilityValidator::Default < Spree::ReturnItem::EligibilityValidator::BaseValidator
     class_attribute :permitted_eligibility_validators
     self.permitted_eligibility_validators = [
-                                              ReturnItem::EligibilityValidator::OrderCompleted,
-                                              ReturnItem::EligibilityValidator::TimeSincePurchase,
-                                              ReturnItem::EligibilityValidator::RMARequired,
-                                              ReturnItem::EligibilityValidator::InventoryShipped,
-                                              ReturnItem::EligibilityValidator::NoReimbursements
-                                            ]
+      ReturnItem::EligibilityValidator::OrderCompleted,
+      ReturnItem::EligibilityValidator::TimeSincePurchase,
+      ReturnItem::EligibilityValidator::RMARequired,
+      ReturnItem::EligibilityValidator::InventoryShipped,
+      ReturnItem::EligibilityValidator::NoReimbursements
+    ]
 
     def eligible_for_return?
       validators.all?(&:eligible_for_return?)

data/app/models/spree/return_item/exchange_variant_eligibility/same_product.rb

@@ -2,7 +2,7 @@ module Spree
   module ReturnItem::ExchangeVariantEligibility
     class SameProduct
       def self.eligible_variants(variant)
-        Spree::Variant.where(product_id: variant.product_id, is_master: variant.is_master?).in_stock
+        Spree::Variant.where(product_id: variant.product_id, is_master: variant.is_master?).in_stock_or_backorderable
       end
     end
   end

data/app/models/spree/shipment.rb

@@ -75,8 +75,8 @@ module Spree
       after_transition do |shipment, transition|
         shipment.state_changes.create!(
           previous_state: transition.from,
-          next_state:     transition.to,
-          name:           'shipment'
+          next_state: transition.to,
+          name: 'shipment'
         )
       end
     end
@@ -103,6 +103,7 @@ module Spree
       inventory_units.any?(&:backordered?)
     end
 
+    # TODO: delegate currency to Order, order.currency is mandatory
     def currency
       order ? order.currency : Spree::Config[:currency]
     end
@@ -117,6 +118,7 @@ module Spree
       return 'pending' unless order.can_ship?
       return 'pending' if inventory_units.any? &:backordered?
       return 'shipped' if shipped?
+
       order.paid? || Spree::Config[:auto_capture_on_dispatch] ? 'ready' : 'pending'
     end
 
@@ -133,6 +135,12 @@ module Spree
       item_cost + final_price
     end
 
+    def free?
+      return true if final_price == BigDecimal(0)
+
+      adjustments.promotion.any? { |p| p.source.type == 'Spree::Promotion::Actions::FreeShipping' }
+    end
+
     def finalize!
       inventory_units.finalize_units!
       after_resume
@@ -184,6 +192,7 @@ module Spree
 
       payments_pool = pending_payments.each_with_object([]) do |payment, pool|
         break if payments_amount >= shipment_to_pay
+
         payments_amount += payment.uncaptured_amount
         pool << payment
       end
@@ -243,6 +252,7 @@ module Spree
 
     def set_up_inventory(state, variant, order, line_item, quantity = 1)
       return if quantity <= 0
+
       inventory_units.create(
         state: state,
         variant_id: variant.id,
@@ -254,6 +264,7 @@ module Spree
 
     def shipped=(value)
       return unless value == '1' && shipped_at.nil?
+
       self.shipped_at = Time.current
     end
 
@@ -338,40 +349,22 @@ module Spree
     end
 
     def transfer_to_location(variant, quantity, stock_location)
-      raise ArgumentError if quantity <= 0
-
-      transaction do
-        new_shipment = order.shipments.create!(stock_location: stock_location)
-
-        order.contents.remove(variant, quantity, shipment: self)
-        order.contents.add(variant, quantity, shipment: new_shipment)
-        order.create_tax_charge!
-        order.update_with_updater!
-
-        refresh_rates
-        save! if persisted?
-        new_shipment.save!
-      end
+      transfer_to_shipment(
+        variant,
+        quantity,
+        order.shipments.build(stock_location: stock_location)
+      )
     end
 
     def transfer_to_shipment(variant, quantity, shipment_to_transfer_to)
-      quantity_already_shipment_to_transfer_to = shipment_to_transfer_to.manifest.find do |mi|
-        mi.line_item.variant == variant
-      end.try(:quantity) || 0
-      final_quantity = quantity + quantity_already_shipment_to_transfer_to
-
-      raise ArgumentError if quantity <= 0 || self == shipment_to_transfer_to
-
-      transaction do
-        order.contents.remove(variant, final_quantity, shipment: self)
-        order.contents.add(variant, final_quantity, shipment: shipment_to_transfer_to)
-        order.update_with_updater!
-
-        refresh_rates
-        save! if persisted?
-        shipment_to_transfer_to.refresh_rates
-        shipment_to_transfer_to.save!
-      end
+      Spree::FulfilmentChanger.new(
+        current_stock_location: stock_location,
+        desired_stock_location: shipment_to_transfer_to.stock_location,
+        current_shipment: self,
+        desired_shipment: shipment_to_transfer_to,
+        variant: variant,
+        quantity: quantity
+      ).run!
     end
 
     private
@@ -381,7 +374,7 @@ module Spree
     end
 
     def can_get_rates?
-      order.ship_address && order.ship_address.valid?
+      order.ship_address&.valid?
     end
 
     def manifest_restock(item)

data/app/models/spree/shipping_method.rb

@@ -27,6 +27,7 @@ module Spree
 
     def include?(address)
       return false unless address
+
       zones.includes(:zone_members).any? do |zone|
         zone.include?(address)
       end
@@ -34,6 +35,7 @@ module Spree
 
     def build_tracking_url(tracking)
       return if tracking.blank? || tracking_url.blank?
+
       tracking_url.gsub(/:tracking/, ERB::Util.url_encode(tracking)) # :url_encode exists in 1.8.7 through 2.1.0
     end
 

data/app/models/spree/shipping_rate.rb

@@ -1,36 +1,35 @@
 module Spree
   class ShippingRate < Spree::Base
     belongs_to :shipment, class_name: 'Spree::Shipment'
-    belongs_to :shipping_method, class_name: 'Spree::ShippingMethod', inverse_of: :shipping_rates
     belongs_to :tax_rate, class_name: 'Spree::TaxRate'
-
-    delegate :order, :currency, to: :shipment
-    delegate :name, to: :shipping_method
-    delegate :code, to: :shipping_method, prefix: true
+    belongs_to :shipping_method, class_name: 'Spree::ShippingMethod', inverse_of: :shipping_rates
 
     extend Spree::DisplayMoney
 
-    money_methods :base_price, :tax_amount
+    money_methods :base_price, :final_price, :tax_amount
 
-    def base_price
-      cost
-    end
+    delegate :order, :currency, :free?, to: :shipment
+    delegate :name,             to: :shipping_method
+    delegate :code,             to: :shipping_method, prefix: true
 
     def display_price
       price = display_base_price.to_s
 
-      return price if tax_rate.nil? || tax_amount == 0
+      return price if tax_rate.nil? || tax_amount.zero?
 
-      Spree.t tax_rate.included_in_price? ? :including_tax : :excluding_tax,
-              scope: 'shipping_rates.display_price',
-              price: price,
-              tax_amount: display_tax_amount,
-              tax_rate_name: tax_rate.name
+      Spree.t(
+        tax_rate.included_in_price? ? :including_tax : :excluding_tax,
+        scope: 'shipping_rates.display_price',
+        price: price,
+        tax_amount: display_tax_amount,
+        tax_rate_name: tax_rate.name
+      )
     end
     alias display_cost display_price
+    alias_attribute :base_price, :cost
 
     def tax_amount
-      @_tax_amount ||= tax_rate.calculator.compute_shipping_rate(self)
+      @tax_amount ||= tax_rate&.calculator&.compute_shipping_rate(self) || BigDecimal(0)
     end
 
     def shipping_method
@@ -40,5 +39,21 @@ module Spree
     def tax_rate
       Spree::TaxRate.unscoped { super }
     end
+
+    # returns base price - any available discounts for this Shipment
+    # useful when you want to present a list of available shipping rates
+    def final_price
+      if free? || cost < -discount_amount
+        BigDecimal(0)
+      else
+        cost + discount_amount
+      end
+    end
+
+    private
+
+    def discount_amount
+      shipment.adjustments.promotion.sum(:amount)
+    end
   end
 end