Sha256: b683d2c1b9b5411ae332c89d5414f1731457fc99ebca0acc21215ad083d7b477

Contents?: true

Size: 1.52 KB

Versions: 9

Compression:

Stored size: 1.52 KB

Contents

module Spree
  # Base class for all types of promotion action.
  #
  # PromotionActions perform the necessary tasks when a promotion is activated
  # by an event and determined to be eligible.
  class PromotionAction < Spree::Base
    acts_as_paranoid

    belongs_to :promotion, class_name: 'Spree::Promotion', inverse_of: :promotion_actions

    scope :of_type, ->(t) { where(type: t.to_s) }

    # Updates the state of the order or performs some other action depending on
    # the subclass options will contain the payload from the event that
    # activated the promotion. This will include the key :user which allows
    # user based actions to be performed in addition to actions on the order
    #
    # @note This method should be overriden in subclassses.
    def perform(_options = {})
      raise 'perform should be implemented in a sub-class of PromotionAction'
    end

    # Removes the action from an order
    #
    # @note This method should be overriden in subclassses.
    #
    # @param order [Spree::Order] the order to remove the action from
    # @return [void]
    def remove_from(order)
      Spree::Deprecation.warn("#{self.class.name.inspect} does not define #remove_from. The default behavior may be incorrect and will be removed in a future version of Solidus.", caller)
      [order, *order.line_items, *order.shipments].each do |item|
        item.adjustments.each do |adjustment|
          if adjustment.source == self
            item.adjustments.destroy(adjustment)
          end
        end
      end
    end
  end
end

Version data entries

9 entries across 9 versions & 1 rubygems

Version Path
solidus_core-2.2.2 app/models/spree/promotion_action.rb
solidus_core-2.1.1 app/models/spree/promotion_action.rb
solidus_core-2.2.1 app/models/spree/promotion_action.rb
solidus_core-2.2.0 app/models/spree/promotion_action.rb
solidus_core-2.2.0.rc1 app/models/spree/promotion_action.rb
solidus_core-2.2.0.beta1 app/models/spree/promotion_action.rb
solidus_core-2.1.0 app/models/spree/promotion_action.rb
solidus_core-2.1.0.rc1 app/models/spree/promotion_action.rb
solidus_core-2.1.0.beta1 app/models/spree/promotion_action.rb