Class: Spree::Promotion

Inherits:
Base
  • Object
show all
Defined in:
app/models/spree/promotion.rb,
app/models/spree/promotion/rules/user.rb,
app/models/spree/promotion/rules/store.rb,
app/models/spree/promotion/rules/taxon.rb,
app/models/spree/promotion/rules/product.rb,
app/models/spree/promotion/rules/nth_order.rb,
app/models/spree/promotion/rules/user_role.rb,
app/models/spree/promotion/rules/item_total.rb,
app/models/spree/promotion/rules/first_order.rb,
app/models/spree/promotion/rules/option_value.rb,
app/models/spree/promotion/rules/user_logged_in.rb,
app/models/spree/promotion/actions/free_shipping.rb,
app/models/spree/promotion/rules/one_use_per_user.rb,
app/models/spree/promotion/actions/create_adjustment.rb,
app/models/spree/promotion/actions/create_item_adjustments.rb,
app/models/spree/promotion/rules/first_repeat_purchase_since.rb,
app/models/spree/promotion/actions/create_quantity_adjustments.rb

Defined Under Namespace

Modules: Actions, Rules

Constant Summary collapse

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

Instance Attribute Summary collapse

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

Instance Attribute Details

#eligibility_errors ⇒ Object (readonly)

Returns the value of attribute eligibility_errors.



8
9
10
 
# File 'app/models/spree/promotion.rb', line 8

def eligibility_errors
  @eligibility_errors
end

Class Method Details

.order_activatable?(order) ⇒ Boolean

Returns:

  • (Boolean) 


52
53
54
 
# File 'app/models/spree/promotion.rb', line 52

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

.with_coupon_code(val) ⇒ Object 



56
57
58
59
60
 
# File 'app/models/spree/promotion.rb', line 56

def self.with_coupon_code(val)
  joins(:codes).where(
    PromotionCode.arel_table[:value].eq(val.downcase)
  ).first
end

Instance Method Details

#activate(order:, line_item: nil, user: nil, path: nil, promotion_code: nil) ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'app/models/spree/promotion.rb', line 91

def activate(order:, line_item: nil, user: nil, path: nil, promotion_code: nil)
  return unless self.class.order_activatable?(order)

  payload = {
    order: order,
    promotion: self,
    line_item: line_item,
    user: user,
    path: path,
    promotion_code: promotion_code
  }

  # Track results from actions to see if any action has been taken.
  # Actions should return nil/false if no action has been taken.
  # If an action returns true, then an action has been taken.
  results = actions.map do |action|
    action.perform(payload)
  end
  # If an action has been taken, report back to whatever activated this promotion.
  action_taken = results.include?(true)

  if action_taken
    # connect to the order
    order.order_promotions.find_or_create_by!(
      promotion: self,
      promotion_code: promotion_code,
    )
    order.promotions.reset
    order_promotions.reset
    orders.reset
  end

  action_taken
end

#active? ⇒ Boolean

Returns:

  • (Boolean) 


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

def active?
  started? && not_expired?
end

#as_json(options = {}) ⇒ Object 



62
63
64
65
 
# File 'app/models/spree/promotion.rb', line 62

def as_json(options = {})
  options[:except] ||= :code
  super
end

#eligible?(promotable, promotion_code: nil) ⇒ Boolean

called anytime order.recalculate happens

Returns:

  • (Boolean) 


127
128
129
130
131
132
133
 
# File 'app/models/spree/promotion.rb', line 127

def eligible?(promotable, promotion_code: nil)
  return false if inactive?
  return false if usage_limit_exceeded?
  return false if promotion_code && promotion_code.usage_limit_exceeded?
  return false if blacklisted?(promotable)
  !!eligible_rules(promotable, {})
end

#eligible_rules(promotable, options = {}) ⇒ Object

eligible_rules returns an array of promotion rules where eligible? is true for the promotable if there are no such rules, an empty array is returned if the rules make this promotable ineligible, then nil is returned (i.e. this promotable is not eligible)



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'app/models/spree/promotion.rb', line 138

def eligible_rules(promotable, options = {})
  # Promotions without rules are eligible by default.
  return [] if rules.none?
  eligible = lambda { |r| r.eligible?(promotable, options) }
  specific_rules = rules.for(promotable)
  return [] if specific_rules.none?

  if match_all?
    # If there are rules for this promotion, but no rules for this
    # particular promotable, then the promotion is ineligible by default.
    unless specific_rules.all?(&eligible)
      @eligibility_errors = specific_rules.map(&:eligibility_errors).detect(&:present?)
      return nil
    end
    specific_rules
  else
    unless specific_rules.any?(&eligible)
      @eligibility_errors = specific_rules.map(&:eligibility_errors).detect(&:present?)
      return nil
    end
    specific_rules.select(&eligible)
  end
end

#expired? ⇒ Boolean

Returns:

  • (Boolean) 


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

def expired?
  expires_at.present? && expires_at < Time.current
end

#inactive? ⇒ Boolean

Returns:

  • (Boolean) 


87
88
89
 
# File 'app/models/spree/promotion.rb', line 87

def inactive?
  !active?
end

#line_item_actionable?(order, line_item, promotion_code: nil) ⇒ Boolean

Returns:

  • (Boolean) 


188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'app/models/spree/promotion.rb', line 188

def line_item_actionable?(order, line_item, promotion_code: nil)
  return false if blacklisted?(line_item)

  if eligible?(order, promotion_code: promotion_code)
    rules = eligible_rules(order)
    if rules.blank?
      true
    else
      rules.send(match_all? ? :all? : :any?) do |rule|
        rule.actionable? line_item
      end
    end
  else
    false
  end
end

#not_expired? ⇒ Boolean

Returns:

  • (Boolean) 


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

def not_expired?
  !expired?
end

#not_started? ⇒ Boolean

Returns:

  • (Boolean) 


67
68
69
 
# File 'app/models/spree/promotion.rb', line 67

def not_started?
  !started?
end

#products ⇒ Object 



162
163
164
 
# File 'app/models/spree/promotion.rb', line 162

def products
  rules.where(type: "Spree::Promotion::Rules::Product").map(&:products).flatten.uniq
end

#remove_from(order) ⇒ void

This method returns an undefined value.

Removes a promotion and any adjustments or other side effects from an order.

Parameters:

  • order (Spree::Order) —

    the order to remove the promotion from.



227
228
229
230
231
232
233
234
235
 
# File 'app/models/spree/promotion.rb', line 227

def remove_from(order)
  actions.each do |action|
    action.remove_from(order)
  end
  # note: this destroys the join table entry, not the promotion itself
  order.promotions.destroy(self)
  order.order_promotions.reset
  order_promotions.reset
end

#started? ⇒ Boolean

Returns:

  • (Boolean) 


71
72
73
 
# File 'app/models/spree/promotion.rb', line 71

def started?
  starts_at.nil? || starts_at < Time.current
end

#usage_count ⇒ Integer

Number of times the code has been used overall

Returns:

  • (Integer) —

    usage count



178
179
180
181
182
183
184
185
186
 
# File 'app/models/spree/promotion.rb', line 178

def usage_count
  Spree::Adjustment.eligible.
    promotion.
    where(source_id: actions.map(&:id)).
    joins(:order).
    merge(Spree::Order.complete).
    distinct.
    count(:order_id)
end

#usage_limit_exceeded? ⇒ Boolean

Whether the promotion has exceeded it’s usage restrictions.

Returns:

  • (Boolean) —

    true or false



169
170
171
172
173
 
# File 'app/models/spree/promotion.rb', line 169

def usage_limit_exceeded?
  if usage_limit
    usage_count >= usage_limit
  end
end

#used_by?(user, excluded_orders = []) ⇒ Boolean

Returns:

  • (Boolean) 


205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'app/models/spree/promotion.rb', line 205

def used_by?(user, excluded_orders = [])
  [
    :adjustments,
    :line_item_adjustments,
    :shipment_adjustments
  ].any? do |adjustment_type|
    user.orders.complete.joins(adjustment_type).where(
      spree_adjustments: {
        source_type: "Spree::PromotionAction",
        source_id: actions.map(&:id),
        eligible: true
      }
    ).where.not(
      id: excluded_orders.map(&:id)
    ).any?
  end
end