Class: Spree::Adjustment
- Extended by:
- DisplayMoney
- Defined in:
- app/models/spree/adjustment.rb
Overview
Adjustments represent a change to the item_total
of an Order. Each adjustment has an amount
that can be either positive or negative.
Adjustments can be “opened” or “closed”. Once an adjustment is closed, it will not be automatically updated.
Boolean attributes
-
eligible?
This boolean attributes stores whether this adjustment is currently eligible for its order. Only eligible adjustments count towards the order’s adjustment total. This allows an adjustment to be preserved if it becomes ineligible so it might be reinstated.
Instance Method Summary collapse
-
#calculate_eligibility ⇒ true, false
private
Calculates based on attached promotion (if this is a promotion adjustment) whether this promotion is still eligible.
-
#cancellation? ⇒ Boolean
True when this is a cancellation adjustment (Cancellation adjustments have a UnitCancel source).
- #currency ⇒ Object
- #finalize ⇒ Object
- #finalize! ⇒ Object
-
#promotion? ⇒ Boolean
True when this is a promotion adjustment (Promotion adjustments have a PromotionAction source).
- #recalculate ⇒ BigDecimal
-
#tax? ⇒ Boolean
True when this is a tax adjustment (Tax adjustments have a TaxRate source).
- #unfinalize ⇒ Object
- #unfinalize! ⇒ Object
Methods included from DisplayMoney
Methods inherited from Base
Methods included from Core::Permalinks
#generate_permalink, #save_permalink
Instance Method Details
#calculate_eligibility ⇒ true, false
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Calculates based on attached promotion (if this is a promotion adjustment) whether this promotion is still eligible.
126 127 128 129 130 131 132 |
# File 'app/models/spree/adjustment.rb', line 126 def calculate_eligibility if !finalized? && source && promotion? source.promotion.eligible?(adjustable, promotion_code: promotion_code) else eligible? end end |
#cancellation? ⇒ Boolean
Returns true when this is a cancellation adjustment (Cancellation adjustments have a UnitCancel source).
85 86 87 |
# File 'app/models/spree/adjustment.rb', line 85 def cancellation? source_type == 'Spree::UnitCancel' end |
#currency ⇒ Object
70 71 72 |
# File 'app/models/spree/adjustment.rb', line 70 def currency adjustable ? adjustable.currency : Spree::Config[:currency] end |
#finalize ⇒ Object
62 63 64 |
# File 'app/models/spree/adjustment.rb', line 62 def finalize update(finalized: true) end |
#finalize! ⇒ Object
54 55 56 |
# File 'app/models/spree/adjustment.rb', line 54 def finalize! update!(finalized: true) end |
#promotion? ⇒ Boolean
Returns true when this is a promotion adjustment (Promotion adjustments have a PromotionAction source).
75 76 77 |
# File 'app/models/spree/adjustment.rb', line 75 def promotion? source_type == 'Spree::PromotionAction' end |
#recalculate ⇒ BigDecimal
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/adjustment.rb', line 96 def recalculate if finalized? && !tax? return amount end # If the adjustment has no source, do not attempt to re-calculate the # amount. # Some scenarios where this happens: # - Adjustments that are manually created via the admin backend # - PromotionAction adjustments where the PromotionAction was deleted # after the order was completed. if source.present? self.amount = source.compute_amount(adjustable) if promotion? self.eligible = calculate_eligibility end # Persist only if changed # This is only not a save! to avoid the extra queries to load the order # (for validations) and to touch the adjustment. update_columns(eligible: eligible, amount: amount, updated_at: Time.current) if changed? end amount end |
#tax? ⇒ Boolean
Returns true when this is a tax adjustment (Tax adjustments have a TaxRate source).
80 81 82 |
# File 'app/models/spree/adjustment.rb', line 80 def tax? source_type == 'Spree::TaxRate' end |
#unfinalize ⇒ Object
66 67 68 |
# File 'app/models/spree/adjustment.rb', line 66 def unfinalize update(finalized: false) end |
#unfinalize! ⇒ Object
58 59 60 |
# File 'app/models/spree/adjustment.rb', line 58 def unfinalize! update!(finalized: false) end |