Class: Spree::PromotionAction

Inherits:
Base
  • Object
show all
Includes:
Spree::Preferences::Persistable, SoftDeletable
Defined in:
app/models/spree/promotion_action.rb

Overview

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.

Instance Method Summary collapse

Methods inherited from Base

display_includes, page, preference, #preferences

Methods included from Core::Permalinks

#generate_permalink, #save_permalink

Instance Method Details

#perform(_options = {}) ⇒ Object

Note:

This method should be overriden in subclassses.

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



25
26
27
 
# File 'app/models/spree/promotion_action.rb', line 25

def perform(_options = {})
  raise 'perform should be implemented in a sub-class of PromotionAction'
end

#remove_from(order) ⇒ void

Note:

This method should be overriden in subclassses.

This method returns an undefined value.

Removes the action from an order

Parameters:

  • order (Spree::Order) —

    the order to remove the action from



35
36
37
38
39
40
41
42
43
44
 
# File 'app/models/spree/promotion_action.rb', line 35

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

#to_partial_path ⇒ Object 



46
47
48
 
# File 'app/models/spree/promotion_action.rb', line 46

def to_partial_path
  "spree/admin/promotions/actions/#{model_name.element}"
end