Class: Spree::Promotion Private

Inherits:
Base
  • Object
show all
Defined in:
app/models/spree/promotion.rb,
app/models/spree/promotion/rules/user.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

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Defined Under Namespace

Modules: Actions, Rules

Constant Summary

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

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

Instance Attribute Details

#eligibility_errorsObject (readonly)

Returns the value of attribute eligibility_errors



6
7
8
# File 'app/models/spree/promotion.rb', line 6

def eligibility_errors
  @eligibility_errors
end

Class Method Details

.order_activatable?(order) ⇒ Boolean

Returns:

  • (Boolean)


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

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

.with_coupon_code(val) ⇒ Object



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

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



87
88
89
90
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
# File 'app/models/spree/promotion.rb', line 87

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)


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

def active?
  (starts_at.nil? || starts_at < Time.current) &&
    (expires_at.nil? || expires_at > Time.current)
end

#as_json(options = {}) ⇒ Object



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

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

#codeObject



59
60
61
# File 'app/models/spree/promotion.rb', line 59

def code
  raise "Attempted to call code on a Spree::Promotion. Promotions are now tied to multiple code records"
end

#code=(_val) ⇒ Object



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

def code=(_val)
  raise "Attempted to call code= on a Spree::Promotion. Promotions are now tied to multiple code records"
end

#columnsObject

temporary code. remove after the column is dropped from the db.



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

def columns
  super.reject { |column| column.name == "code" }
end

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

called anytime order.update! happens

Returns:

  • (Boolean)


123
124
125
126
127
128
129
# File 'app/models/spree/promotion.rb', line 123

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)



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
# File 'app/models/spree/promotion.rb', line 134

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

#inactive?Boolean

Returns:

  • (Boolean)


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

def inactive?
  !active?
end

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

Returns:

  • (Boolean)


184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
# File 'app/models/spree/promotion.rb', line 184

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

#productsObject



158
159
160
# File 'app/models/spree/promotion.rb', line 158

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.



223
224
225
226
227
228
229
230
231
# File 'app/models/spree/promotion.rb', line 223

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

#usage_countInteger

Number of times the code has been used overall

Returns:

  • (Integer)

    usage count



174
175
176
177
178
179
180
181
182
# File 'app/models/spree/promotion.rb', line 174

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



165
166
167
168
169
# File 'app/models/spree/promotion.rb', line 165

def usage_limit_exceeded?
  if usage_limit
    usage_count >= usage_limit
  end
end

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

Returns:

  • (Boolean)


201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
# File 'app/models/spree/promotion.rb', line 201

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