Class: Spree::PromotionRule

Inherits:
Base
  • Object
show all
Defined in:
app/models/spree/promotion_rule.rb

Overview

Base class for all promotion rules

Class Method Summary collapse

Instance Method Summary collapse

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



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

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)


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

def actionable?(_line_item)
  true
end

#applicable?(_promotable) ⇒ Boolean

Returns:

  • (Boolean)

Raises:

  • (NotImplementedError)


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

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

#eligibility_errorsObject



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

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

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

Returns:

  • (Boolean)

Raises:

  • (NotImplementedError)


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

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

#to_partial_pathObject



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

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