Class: Spree::Promotion

Inherits:
Activator
  • Object
show all
Defined in:
app/models/spree/promotion.rb,
app/models/spree/promotion/rules/user.rb,
app/models/spree/promotion/rules/product.rb,
app/models/spree/promotion/rules/item_total.rb,
app/models/spree/promotion/rules/first_order.rb,
app/models/spree/promotion/rules/user_logged_in.rb,
app/models/spree/promotion/actions/create_adjustment.rb,
app/models/spree/promotion/actions/create_line_items.rb

Defined Under Namespace

Modules: Actions, Rules

Constant Summary collapse

MATCH_POLICIES = 
%w(all any)
UNACTIVATABLE_ORDER_STATES = 
["complete", "awaiting_return", "returned"]

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Activator

active, #expired?, register_event_name

Class Method Details

.advertised ⇒ Object 



24
25
26
 
# File 'app/models/spree/promotion.rb', line 24

def self.advertised
  where(advertise: true)
end

.with_code ⇒ Object 



28
29
30
 
# File 'app/models/spree/promotion.rb', line 28

def self.with_code
  where(event_name: 'spree.checkout.coupon_code_added')
end

Instance Method Details

#activate(payload) ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'app/models/spree/promotion.rb', line 32

def activate(payload)
  if order_activatable?(payload[:order]) && eligible?(payload[:order])
    # make sure code is always downcased (old databases might have mixed case codes)
    if code.present?
      event_code = payload[:coupon_code]
      return unless event_code == self.code.downcase.strip
    end

    if path.present?
      return unless path == payload[:path]
    end

    actions.each do |action|
      action.perform(payload)
    end

    return true
  end
  false
end

#adjusted_credits_count(order) ⇒ Object 



84
85
86
87
 
# File 'app/models/spree/promotion.rb', line 84

def adjusted_credits_count(order)
  return credits_count if order.nil?
  credits_count - (exists_on_order?(order) ? 1 : 0)
end

#code=(coupon_code) ⇒ Object 



97
98
99
 
# File 'app/models/spree/promotion.rb', line 97

def code=(coupon_code)
  write_attribute(:code, (coupon_code.downcase.strip rescue nil))
end

#credits ⇒ Object 



89
90
91
 
# File 'app/models/spree/promotion.rb', line 89

def credits
  Adjustment.eligible.promotion.where(originator_id: actions.map(&:id))
end

#credits_count ⇒ Object 



93
94
95
 
# File 'app/models/spree/promotion.rb', line 93

def credits_count
  credits.count
end

#eligible?(order) ⇒ Boolean

called anytime order.update! happens

Returns:

  • (Boolean) 


54
55
56
57
 
# File 'app/models/spree/promotion.rb', line 54

def eligible?(order)
  return false if expired? || usage_limit_exceeded?(order)
  rules_are_eligible?(order, {})
end

#exists_on_order?(order) ⇒ Boolean

Returns:

  • (Boolean) 


101
102
103
 
# File 'app/models/spree/promotion.rb', line 101

def exists_on_order?(order)
  actions.any? { |a| a.credit_exists_on_order?(order) }
end

#order_activatable?(order) ⇒ Boolean

Returns:

  • (Boolean) 


69
70
71
 
# File 'app/models/spree/promotion.rb', line 69

def order_activatable?(order)
  order && !UNACTIVATABLE_ORDER_STATES.include?(order.state)
end

#products ⇒ Object

Products assigned to all product rules



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

def products
  @products ||= self.rules.to_a.inject([]) do |products, rule|
    rule.respond_to?(:products) ? products << rule.products : products
  end.flatten.uniq
end

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

Returns:

  • (Boolean) 


59
60
61
62
63
64
65
66
67
 
# File 'app/models/spree/promotion.rb', line 59

def rules_are_eligible?(order, options = {})
  return true if rules.none?
  eligible = lambda { |r| r.eligible?(order, options) }
  if match_policy == 'all'
    rules.all?(&eligible)
  else
    rules.any?(&eligible)
  end
end

#usage_limit_exceeded?(order = nil) ⇒ Boolean

Returns:

  • (Boolean) 


80
81
82
 
# File 'app/models/spree/promotion.rb', line 80

def usage_limit_exceeded?(order = nil)
  usage_limit.present? && usage_limit > 0 && adjusted_credits_count(order) >= usage_limit
end