solidus_core 2.5.2 → 2.6.0.rc1

data/app/models/spree/order_mutex.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   class OrderMutex < Spree::Base
     class LockFailed < StandardError; end
@@ -25,7 +27,6 @@ module Spree
         end
 
         yield
-
       ensure
         order_mutex.destroy if order_mutex
       end

data/app/models/spree/order_promotion.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   # Spree::OrderPromotion represents the relationship between:
   #

data/app/models/spree/order_shipping.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # A service layer that handles generating Carton objects when inventory units
 # are actually shipped.  It also takes care of things like updating order and
 # shipment states and delivering shipment emails as needed.

data/app/models/spree/order_taxation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   # Relatively simple class used to apply a {Spree::Tax::OrderTax} to a
   # {Spree::Order}.

data/app/models/spree/order_update_attributes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   class OrderUpdateAttributes
     # @param order [Order] existing (persisted) order

data/app/models/spree/order_updater.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   class OrderUpdater
     attr_reader :order
@@ -57,6 +59,7 @@ module Spree
     # balance_due   when +payment_total+ is less than +total+
     # credit_owed   when +payment_total+ is greater than +total+
     # failed        when most recent payment is in the failed state
+    # void          when the order has been canceled and the payment total is 0
     #
     # The +payment_state+ value helps with reporting, etc. since it provides a quick and easy way to locate Orders needing attention.
     def update_payment_state

data/app/models/spree/payment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   # Manage and process a payment for an order, from a specific
   # source (e.g. `Spree::CreditCard`) using a specific payment method (e.g

data/app/models/spree/payment/cancellation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   class Payment
     # Payment cancellation handler

data/app/models/spree/payment/processing.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   class Payment < Spree::Base
     module Processing

data/app/models/spree/payment_capture_event.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   class PaymentCaptureEvent < Spree::Base
     belongs_to :payment, class_name: 'Spree::Payment'

data/app/models/spree/payment_create.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   # Service object for creating new payments on an Order
   class PaymentCreate

data/app/models/spree/payment_method.rb

@@ -1,12 +1,11 @@
+# frozen_string_literal: true
+
 require 'discard'
 require 'spree/preferences/statically_configurable'
 
 module Spree
   # A base class which is used for implementing payment methods.
   #
-  # See https://github.com/solidusio/solidus_gateway/ for
-  # offically supported payment method implementations.
-  #
   # Uses STI (single table inheritance) to store all implemented payment methods
   # in one table (+spree_payment_methods+).
   #
@@ -23,7 +22,15 @@ module Spree
     self.discard_column = :deleted_at
 
     acts_as_list
-    DISPLAY = [:both, :front_end, :back_end]
+
+    # @private
+    def self.const_missing(name)
+      if name == :DISPLAY
+        const_set(:DISPLAY, [:both, :front_end, :back_end])
+      else
+        super
+      end
+    end
 
     validates :name, :type, presence: true
 
@@ -61,12 +68,14 @@ module Spree
     end
 
     class << self
+      # @deprecated Use Spree::Config.environment.payment_methods instead
       def providers
         Spree::Deprecation.warn 'Spree::PaymentMethod.providers is deprecated and will be deleted in Solidus 3.0. ' \
           'Please use Rails.application.config.spree.payment_methods instead'
         Spree::Config.environment.payment_methods
       end
 
+      # @deprecated Use {.active}, {.available_to_users}, and {.available_to_admin} scopes instead.
       def available(display_on = nil, store: nil)
         Spree::Deprecation.warn "Spree::PaymentMethod.available is deprecated."\
           "Please use .active, .available_to_users, and .available_to_admin scopes instead."\
@@ -93,11 +102,15 @@ module Spree
         ModelName.new(self, Spree)
       end
 
+      # @deprecated Use .active.any? instead
       def active?
+        Spree::Deprecation.warn "#{self}.active? is deprecated. Use #{self}.active.any? instead"
         where(type: to_s, active: true).count > 0
       end
 
+      # @deprecated Use .with_deleted.find instead
       def find_with_destroyed(*args)
+        Spree::Deprecation.warn "#{self}.find_with_destroyed is deprecated. Use #{self}.with_deleted.find instead"
         unscoped { find(*args) }
       end
     end
@@ -143,7 +156,7 @@ module Spree
       raise ::NotImplementedError, "You must implement payment_source_class method for #{self.class}."
     end
 
-    # @deprecated Use {#available_to_users=} and {#available_to_admin=} instead
+    # @deprecated Use {Spree::PaymentMethod#available_to_users=} and {Spree::PaymentMethod#available_to_admin=} instead
     def display_on=(value)
       Spree::Deprecation.warn "Spree::PaymentMethod#display_on= is deprecated."\
         "Please use #available_to_users= and #available_to_admin= instead."
@@ -151,7 +164,7 @@ module Spree
       self.available_to_admin = value.blank? || value == 'back_end'
     end
 
-    # @deprecated Use {#available_to_users} and {#available_to_admin} instead
+    # @deprecated Use {Spree::PaymentMethod#available_to_users} and {Spree::PaymentMethod#available_to_admin} instead
     def display_on
       Spree::Deprecation.warn "Spree::PaymentMethod#display_on is deprecated."\
         "Please use #available_to_users and #available_to_admin instead."
@@ -208,8 +221,8 @@ module Spree
       true
     end
 
-    # Custom gateways should redefine this method. See Gateway implementation
-    # as an example
+    # Custom gateways can redefine this method to return reusable sources for an order.
+    # See {Spree::PaymentMethod::CreditCard#reusable_sources} as an example
     def reusable_sources(_order)
       []
     end

data/app/models/spree/payment_method/bogus_credit_card.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   class PaymentMethod::BogusCreditCard < PaymentMethod::CreditCard
     TEST_VISA = ['4111111111111111', '4012888888881881', '4222222222222']

data/app/models/spree/payment_method/check.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   class PaymentMethod::Check < PaymentMethod
     def actions

data/app/models/spree/payment_method/credit_card.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   # An implementation of a `Spree::PaymentMethod` for credit card payments.
   #

data/app/models/spree/payment_method/simple_bogus_credit_card.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   # Bogus Gateway that doesn't support payment profiles.
   class PaymentMethod::SimpleBogusCreditCard < PaymentMethod::BogusCreditCard

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   class PaymentMethod::StoreCredit < PaymentMethod
     def payment_source_class

data/app/models/spree/payment_source.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   class PaymentSource < Spree::Base
     self.abstract_class = true

data/app/models/spree/preference.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Spree::Preference < Spree::Base
   serialize :value
 

data/app/models/spree/price.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'discard'
 
 module Spree
@@ -34,7 +36,7 @@ module Spree
     money_methods :amount, :price
     alias_method :money, :display_amount
 
-    self.whitelisted_ransackable_attributes = %w( amount variant_id currency country_iso )
+    self.whitelisted_ransackable_attributes = %w(amount variant_id currency country_iso)
 
     # An alias for #amount
     def price

data/app/models/spree/product.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'discard'
 
 module Spree
@@ -300,7 +302,7 @@ module Spree
 
     # Finds the variant property rule that matches the provided option value ids.
     #
-    # @param [Array<Integer>] list of option value ids
+    # @param option_value_ids [Array<Integer>] list of option value ids
     # @return [Spree::VariantPropertyRule] the matching variant property rule
     def find_variant_property_rule(option_value_ids)
       variant_property_rules.find do |rule|

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   class Product < Spree::Base
     cattr_accessor :search_scopes do

data/app/models/spree/product_option_type.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   class ProductOptionType < Spree::Base
     belongs_to :product, class_name: 'Spree::Product', inverse_of: :product_option_types, touch: true

data/app/models/spree/product_promotion_rule.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   class ProductPromotionRule < Spree::Base
     belongs_to :product

data/app/models/spree/product_property.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   class ProductProperty < Spree::Base
     include Spree::OrderedPropertyValueList

data/app/models/spree/promotion.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spree
   class Promotion < Spree::Base
     MATCH_POLICIES = %w(all any)

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

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Spree
-  class Promotion
+  class Promotion < Spree::Base
     module Actions
       class CreateAdjustment < PromotionAction
         include Spree::CalculatedAdjustments

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

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Spree
-  class Promotion
+  class Promotion < Spree::Base
     module Actions
       class CreateItemAdjustments < PromotionAction
         include Spree::CalculatedAdjustments

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

@@ -1,135 +1,141 @@
-module Spree::Promotion::Actions
-  class CreateQuantityAdjustments < CreateItemAdjustments
-    preference :group_size, :integer, default: 1
-
-    has_many :line_item_actions, foreign_key: :action_id, dependent: :destroy
-    has_many :line_items, through: :line_item_actions
-
-    ##
-    # Computes the amount for the adjustment based on the line item and any
-    # other applicable items in the order. The rules for this specific
-    # adjustment are as follows:
-    #
-    # = Setup
-    #
-    # We have a quantity group promotion on t-shirts. If a user orders 3
-    # t-shirts, they get $5 off of each. The shirts come in one size and three
-    # colours: red, blue, and white.
-    #
-    # == Scenario 1
-    #
-    # User has 2 red shirts, 1 white shirt, and 1 blue shirt in their
-    # order. We want to compute the adjustment amount for the white shirt.
-    #
-    # *Result:* -$5
-    #
-    # *Reasoning:* There are a total of 4 items that are eligible for the
-    # promotion. Since that is greater than 3, we can discount the items. The
-    # white shirt has a quantity of 1, therefore it will get discounted by
-    # +adjustment_amount * 1+ or $5.
-    #
-    # === Scenario 1-1
-    #
-    # What about the blue shirt? How much does it get discounted?
-    #
-    # *Result:* $0
-    #
-    # *Reasoning:* We have a total quantity of 4. However, we only apply the
-    # adjustment to groups of 3. Assuming the white and red shirts have already
-    # had their adjustment calculated, that means 3 units have been discounted.
-    # Leaving us with a lonely blue shirt that isn't part of a group of 3.
-    # Therefore, it does not receive the discount.
-    #
-    # == Scenario 2
-    #
-    # User has 4 red shirts in their order. What is the amount?
-    #
-    # *Result:* -$15
-    #
-    # *Reasoning:* The total quantity of eligible items is 4, so we the
-    # adjustment will be non-zero. However, we only apply it to groups of 3,
-    # therefore there is one extra item that is not eligible for the
-    # adjustment. +adjustment_amount * 3+ or $15.
-    #
-    def compute_amount(line_item)
-      adjustment_amount = calculator.compute(PartialLineItem.new(line_item))
-      if !adjustment_amount.is_a?(BigDecimal)
-        Spree::Deprecation.warn "#{calculator.class.name}#compute returned #{adjustment_amount.inspect}, it should return a BigDecimal"
-      end
-      adjustment_amount ||= BigDecimal(0)
-      adjustment_amount = adjustment_amount.abs
-
-      order = line_item.order
-      line_items = actionable_line_items(order)
-
-      actioned_line_items = order.line_item_adjustments.reload.
-        select { |a| a.source == self && a.amount < 0 }.
-        map(&:adjustable)
-      other_line_items = actioned_line_items - [line_item]
-
-      applicable_quantity = total_applicable_quantity(line_items)
-      used_quantity = total_used_quantity(other_line_items)
-      usable_quantity = [
-        applicable_quantity - used_quantity,
-        line_item.quantity
-      ].min
-
-      persist_quantity(usable_quantity, line_item)
-
-      amount = adjustment_amount * usable_quantity
-      [line_item.amount, amount].min * -1
-    end
-
-    private
-
-    def actionable_line_items(order)
-      order.line_items.select do |item|
-        promotion.line_item_actionable? order, item
-      end
-    end
-
-    def total_applicable_quantity(line_items)
-      total_quantity = line_items.sum(&:quantity)
-      extra_quantity = total_quantity % preferred_group_size
-
-      total_quantity - extra_quantity
-    end
-
-    def total_used_quantity(line_items)
-      line_item_actions.where(
-        line_item_id: line_items.map(&:id)
-      ).sum(:quantity)
-    end
-
-    def persist_quantity(quantity, line_item)
-      line_item_action = line_item_actions.where(
-        line_item_id: line_item.id
-      ).first_or_initialize
-      line_item_action.quantity = quantity
-      line_item_action.save!
-    end
-
-    ##
-    # Used specifically for PercentOnLineItem calculator. That calculator uses
-    # `line_item.amount`, however we might not necessarily want to discount the
-    # entire amount. This class allows us to determine the discount per
-    # quantity and then calculate the adjustment amount the way we normally do
-    # for flat rate adjustments.
-    class PartialLineItem
-      def initialize(line_item)
-        @line_item = line_item
-      end
-
-      def amount
-        @line_item.price
-      end
-
-      def order
-        @line_item.order
-      end
-
-      def currency
-        @line_item.currency
+# frozen_string_literal: true
+
+module Spree
+  class Promotion < Spree::Base
+    module Actions
+      class CreateQuantityAdjustments < CreateItemAdjustments
+        preference :group_size, :integer, default: 1
+
+        has_many :line_item_actions, foreign_key: :action_id, dependent: :destroy
+        has_many :line_items, through: :line_item_actions
+
+        ##
+        # Computes the amount for the adjustment based on the line item and any
+        # other applicable items in the order. The rules for this specific
+        # adjustment are as follows:
+        #
+        # = Setup
+        #
+        # We have a quantity group promotion on t-shirts. If a user orders 3
+        # t-shirts, they get $5 off of each. The shirts come in one size and three
+        # colours: red, blue, and white.
+        #
+        # == Scenario 1
+        #
+        # User has 2 red shirts, 1 white shirt, and 1 blue shirt in their
+        # order. We want to compute the adjustment amount for the white shirt.
+        #
+        # *Result:* -$5
+        #
+        # *Reasoning:* There are a total of 4 items that are eligible for the
+        # promotion. Since that is greater than 3, we can discount the items. The
+        # white shirt has a quantity of 1, therefore it will get discounted by
+        # +adjustment_amount * 1+ or $5.
+        #
+        # === Scenario 1-1
+        #
+        # What about the blue shirt? How much does it get discounted?
+        #
+        # *Result:* $0
+        #
+        # *Reasoning:* We have a total quantity of 4. However, we only apply the
+        # adjustment to groups of 3. Assuming the white and red shirts have already
+        # had their adjustment calculated, that means 3 units have been discounted.
+        # Leaving us with a lonely blue shirt that isn't part of a group of 3.
+        # Therefore, it does not receive the discount.
+        #
+        # == Scenario 2
+        #
+        # User has 4 red shirts in their order. What is the amount?
+        #
+        # *Result:* -$15
+        #
+        # *Reasoning:* The total quantity of eligible items is 4, so we the
+        # adjustment will be non-zero. However, we only apply it to groups of 3,
+        # therefore there is one extra item that is not eligible for the
+        # adjustment. +adjustment_amount * 3+ or $15.
+        #
+        def compute_amount(line_item)
+          adjustment_amount = calculator.compute(PartialLineItem.new(line_item))
+          if !adjustment_amount.is_a?(BigDecimal)
+            Spree::Deprecation.warn "#{calculator.class.name}#compute returned #{adjustment_amount.inspect}, it should return a BigDecimal"
+          end
+          adjustment_amount ||= BigDecimal(0)
+          adjustment_amount = adjustment_amount.abs
+
+          order = line_item.order
+          line_items = actionable_line_items(order)
+
+          actioned_line_items = order.line_item_adjustments.reload.
+            select { |a| a.source == self && a.amount < 0 }.
+            map(&:adjustable)
+          other_line_items = actioned_line_items - [line_item]
+
+          applicable_quantity = total_applicable_quantity(line_items)
+          used_quantity = total_used_quantity(other_line_items)
+          usable_quantity = [
+            applicable_quantity - used_quantity,
+            line_item.quantity
+          ].min
+
+          persist_quantity(usable_quantity, line_item)
+
+          amount = adjustment_amount * usable_quantity
+          [line_item.amount, amount].min * -1
+        end
+
+        private
+
+        def actionable_line_items(order)
+          order.line_items.select do |item|
+            promotion.line_item_actionable? order, item
+          end
+        end
+
+        def total_applicable_quantity(line_items)
+          total_quantity = line_items.sum(&:quantity)
+          extra_quantity = total_quantity % preferred_group_size
+
+          total_quantity - extra_quantity
+        end
+
+        def total_used_quantity(line_items)
+          line_item_actions.where(
+            line_item_id: line_items.map(&:id)
+          ).sum(:quantity)
+        end
+
+        def persist_quantity(quantity, line_item)
+          line_item_action = line_item_actions.where(
+            line_item_id: line_item.id
+          ).first_or_initialize
+          line_item_action.quantity = quantity
+          line_item_action.save!
+        end
+
+        ##
+        # Used specifically for PercentOnLineItem calculator. That calculator uses
+        # `line_item.amount`, however we might not necessarily want to discount the
+        # entire amount. This class allows us to determine the discount per
+        # quantity and then calculate the adjustment amount the way we normally do
+        # for flat rate adjustments.
+        class PartialLineItem
+          def initialize(line_item)
+            @line_item = line_item
+          end
+
+          def amount
+            @line_item.price
+          end
+
+          def order
+            @line_item.order
+          end
+
+          def currency
+            @line_item.currency
+          end
+        end
       end
     end
   end