Class: Spree::Promotion::Rules::Product

Inherits:
Spree::PromotionRule show all
Defined in:
app/models/spree/promotion/rules/product.rb

Overview

A rule to limit a promotion based on products in the order. Can require all or any of the products to be present. Valid products either come from assigned product group or are assingned directly to the rule.

Constant Summary collapse

MATCH_POLICIES = 
%w(any all none)

Instance Method Summary collapse

Methods inherited from Spree::PromotionRule

#eligibility_errors, for

Methods inherited from Base

page

Methods included from Spree::Preferences::Preferable

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

Instance Method Details

#actionable?(line_item) ⇒ Boolean

Returns:

  • (Boolean) 


45
46
47
48
49
50
51
52
53
54
 
# File 'app/models/spree/promotion/rules/product.rb', line 45

def actionable?(line_item)
  case preferred_match_policy
  when 'any', 'all'
    product_ids.include? line_item.variant.product_id
  when 'none'
    product_ids.exclude? line_item.variant.product_id
  else
    raise "unexpected match policy: #{preferred_match_policy.inspect}"
  end
end

#applicable?(promotable) ⇒ Boolean

Returns:

  • (Boolean) 


21
22
23
 
# File 'app/models/spree/promotion/rules/product.rb', line 21

def applicable?(promotable)
  promotable.is_a?(Spree::Order)
end

#eligible?(order, options = {}) ⇒ Boolean

Returns:

  • (Boolean) 


25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'app/models/spree/promotion/rules/product.rb', line 25

def eligible?(order, options = {})
  return true if eligible_products.empty?

  if preferred_match_policy == 'all'
    unless eligible_products.all? {|p| order.products.include?(p) }
      eligibility_errors.add(:base, eligibility_error_message(:missing_product))
    end
  elsif preferred_match_policy == 'any'
    unless order.products.any? {|p| eligible_products.include?(p) }
      eligibility_errors.add(:base, eligibility_error_message(:no_applicable_products))
    end
  else
    unless order.products.none? {|p| eligible_products.include?(p) }
      eligibility_errors.add(:base, eligibility_error_message(:has_excluded_product))
    end
  end

  eligibility_errors.empty?
end

#eligible_products ⇒ Object

scope/association that is used to test eligibility



17
18
19
 
# File 'app/models/spree/promotion/rules/product.rb', line 17

def eligible_products
  products
end

#product_ids_string ⇒ Object 



56
57
58
 
# File 'app/models/spree/promotion/rules/product.rb', line 56

def product_ids_string
  product_ids.join(',')
end

#product_ids_string=(s) ⇒ Object 



60
61
62
 
# File 'app/models/spree/promotion/rules/product.rb', line 60

def product_ids_string=(s)
  self.product_ids = s.to_s.split(',').map(&:strip)
end