Class: Spree::Promotion::Rules::Taxon

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

Constant Summary

MATCH_POLICIES =
%w(any all none)

Instance Method Summary collapse

Methods inherited from Spree::PromotionRule

#eligibility_errors, for, #to_partial_path

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

Instance Method Details

#actionable?(line_item) ⇒ Boolean

TODO: Fix bug - well described by jhawthorn in #1409: `eligible?` checks the configured taxons and all descendants, `actionable?` only seems to check against the taxons themselves (not children)

Returns:

  • (Boolean)


52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
# File 'app/models/spree/promotion/rules/taxon.rb', line 52

def actionable?(line_item)
  found = Spree::Classification.where(
    product_id: line_item.variant.product_id,
    taxon_id: taxon_ids
  ).exists?

  case preferred_match_policy
  when 'any', 'all'
    found
  when 'none'
    !found
  else
    # Change this to an exception in a future version of Solidus
    warn_invalid_match_policy(assume: 'any')
    found
  end
end

#applicable?(promotable) ⇒ Boolean

Returns:

  • (Boolean)


14
15
16
# File 'app/models/spree/promotion/rules/taxon.rb', line 14

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

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

Returns:

  • (Boolean)


18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# File 'app/models/spree/promotion/rules/taxon.rb', line 18

def eligible?(order, _options = {})
  order_taxons = taxons_in_order(order)

  case preferred_match_policy
  when 'all'
    matches_all = taxons.all? do |rule_taxon|
      order_taxons.where(id: rule_taxon.self_and_descendants.ids).exists?
    end

    unless matches_all
      eligibility_errors.add(:base, eligibility_error_message(:missing_taxon))
    end
  when 'any'
    unless order_taxons.where(id: rule_taxon_ids_with_children).exists?
      eligibility_errors.add(:base, eligibility_error_message(:no_matching_taxons))
    end
  when 'none'
    if order_taxons.where(id: rule_taxon_ids_with_children).exists?
      eligibility_errors.add(:base, eligibility_error_message(:has_excluded_taxon))
    end
  else
    # Change this to an exception in a future version of Solidus
    warn_invalid_match_policy(assume: 'any')
    unless order_taxons.where(id: rule_taxon_ids_with_children).exists?
      eligibility_errors.add(:base, eligibility_error_message(:no_matching_taxons))
    end
  end

  eligibility_errors.empty?
end

#taxon_ids_stringObject



70
71
72
# File 'app/models/spree/promotion/rules/taxon.rb', line 70

def taxon_ids_string
  taxons.pluck(:id).join(',')
end

#taxon_ids_string=(s) ⇒ Object



74
75
76
77
# File 'app/models/spree/promotion/rules/taxon.rb', line 74

def taxon_ids_string=(s)
  ids = s.to_s.split(',').map(&:strip)
  self.taxons = Spree::Taxon.find(ids)
end