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
- #update!(*args) ⇒ Object
Methods included from DisplayMoney
Methods inherited from Base
display_includes, #initialize_preference_defaults, page, preference
Methods included from 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
#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.
140 141 142 143 144 145 146 |
# File 'app/models/spree/adjustment.rb', line 140 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).
90 91 92 |
# File 'app/models/spree/adjustment.rb', line 90 def cancellation? source_type == 'Spree::UnitCancel' end |
#currency ⇒ Object
75 76 77 |
# File 'app/models/spree/adjustment.rb', line 75 def currency adjustable ? adjustable.currency : Spree::Config[:currency] end |
#finalize ⇒ Object
67 68 69 |
# File 'app/models/spree/adjustment.rb', line 67 def finalize update_attributes(finalized: true) end |
#finalize! ⇒ Object
59 60 61 |
# File 'app/models/spree/adjustment.rb', line 59 def finalize! update_attributes!(finalized: true) end |
#promotion? ⇒ Boolean
Returns true when this is a promotion adjustment (Promotion adjustments have a PromotionAction source).
80 81 82 |
# File 'app/models/spree/adjustment.rb', line 80 def promotion? source_type == 'Spree::PromotionAction' end |
#recalculate ⇒ BigDecimal
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 |
# File 'app/models/spree/adjustment.rb', line 101 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).
85 86 87 |
# File 'app/models/spree/adjustment.rb', line 85 def tax? source_type == 'Spree::TaxRate' end |
#unfinalize ⇒ Object
71 72 73 |
# File 'app/models/spree/adjustment.rb', line 71 def unfinalize update_attributes(finalized: false) end |
#unfinalize! ⇒ Object
63 64 65 |
# File 'app/models/spree/adjustment.rb', line 63 def unfinalize! update_attributes!(finalized: false) end |
#update!(*args) ⇒ Object
127 128 129 130 131 132 133 134 |
# File 'app/models/spree/adjustment.rb', line 127 def update!(*args) if args.empty? Spree::Deprecation.warn "Calling adjustment.update! with no arguments to recalculate amounts and eligibility is deprecated, since it conflicts with AR::Base#update! Please use adjustment.recalculate instead" recalculate else super end end |