Class: Spree::PromotionAction

Inherits:

Base

• Object
• ActiveRecord::Base
• Base
• Spree::PromotionAction

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.

Direct Known Subclasses

Spree::Promotion::Actions::CreateAdjustment, Spree::Promotion::Actions::CreateItemAdjustments, Spree::Promotion::Actions::FreeShipping

Instance Method Summary

• #perform(_options = {}) ⇒ Object

  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.

• #remove_from(_order) ⇒ void

  Removes the action from an order.

• #to_partial_path ⇒ Object

Methods inherited from Base

display_includes

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

# 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

# File 'app/models/spree/promotion_action.rb', line 35

def remove_from(_order)
  raise 'remove_from should be implemented in a sub-class of PromotionAction'
end

#to_partial_path ⇒ Object

# File 'app/models/spree/promotion_action.rb', line 39

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