Class: Spree::PromotionRule

Inherits:

Base

• Object
• ActiveRecord::Base
• Base
• Spree::PromotionRule

Defined in:

app/models/spree/promotion_rule.rb

Overview

Base class for all promotion rules

Direct Known Subclasses

Spree::Promotion::Rules::FirstOrder, Spree::Promotion::Rules::FirstRepeatPurchaseSince, Spree::Promotion::Rules::ItemTotal, Spree::Promotion::Rules::NthOrder, Spree::Promotion::Rules::OneUsePerUser, Spree::Promotion::Rules::OptionValue, Spree::Promotion::Rules::Product, Spree::Promotion::Rules::Store, Spree::Promotion::Rules::Taxon, Spree::Promotion::Rules::User, Spree::Promotion::Rules::UserLoggedIn, Spree::Promotion::Rules::UserRole

Class Method Summary

• .for(promotable) ⇒ Object

Instance Method Summary

• #actionable?(_line_item) ⇒ Boolean

  This states if a promotion can be applied to the specified line item It is true by default, but can be overridden by promotion rules to provide conditions.

• #applicable?(_promotable) ⇒ Boolean
• #eligibility_errors ⇒ Object
• #eligible?(_promotable, _options = {}) ⇒ Boolean
• #to_partial_path ⇒ Object

Methods inherited from Base

display_includes, #initialize_preference_defaults, page, preference

Methods included from Spree::Preferences::Preferable

#admin_form_preference_names, #default_preferences, #defined_preferences, #get_preference, #has_preference!, #has_preference?, #preference_default, #preference_type, #set_preference

Class Method Details

.for(promotable) ⇒ Object

# File 'app/models/spree/promotion_rule.rb', line 13

def self.for(promotable)
  all.select { |rule| rule.applicable?(promotable) }
end

Instance Method Details

#actionable?(_line_item) ⇒ Boolean

This states if a promotion can be applied to the specified line item It is true by default, but can be overridden by promotion rules to provide conditions

Returns:

• (Boolean)

# File 'app/models/spree/promotion_rule.rb', line 27

def actionable?(_line_item)
  true
end

#applicable?(_promotable) ⇒ Boolean

Returns:

• (Boolean)

Raises:

• (NotImplementedError)

# File 'app/models/spree/promotion_rule.rb', line 17

def applicable?(_promotable)
  raise NotImplementedError, "applicable? should be implemented in a sub-class of Spree::PromotionRule"
end

#eligibility_errors ⇒ Object

# File 'app/models/spree/promotion_rule.rb', line 31

def eligibility_errors
  @eligibility_errors ||= ActiveModel::Errors.new(self)
end

#eligible?(_promotable, _options = {}) ⇒ Boolean

Returns:

• (Boolean)

Raises:

• (NotImplementedError)

# File 'app/models/spree/promotion_rule.rb', line 21

def eligible?(_promotable, _options = {})
  raise NotImplementedError, "eligible? should be implemented in a sub-class of Spree::PromotionRule"
end

#to_partial_path ⇒ Object

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

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