Class: Spree::TaxRate

Inherits:
Object
  • Object
show all
Includes:
AdjustmentSource, CalculatedAdjustments, Metadata, Metafields, Webhooks::HasWebhooks
Defined in:
app/models/spree/tax_rate.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.adjust(order, items) ⇒ Object

Deletes all tax adjustments, then applies all applicable rates to relevant items.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'app/models/spree/tax_rate.rb', line 74

def self.adjust(order, items)
  return if items.none?

  rates = match(order.tax_zone)
  tax_category_ids = rates.map(&:tax_category_id)

  # using destroy_all to ensure adjustment destroy callback fires.
  Spree::Adjustment.where(adjustable: items).tax.destroy_all

  relevant_items = if tax_category_ids.any?
                      items.select do |item|
                        tax_category_ids.include?(item.tax_category_id)
                      end
                    else
                      []
                    end

  relevant_items.each do |item|
    relevant_rates = rates.select do |rate|
      rate.tax_category_id == item.tax_category_id
    end
    store_pre_tax_amount(item, relevant_rates)
    relevant_rates.each do |rate|
      rate.adjust(order, item)
    end
  end

  # updates pre_tax for items without any tax rates
  remaining_items = items - relevant_items
  remaining_items.each do |item|
    store_pre_tax_amount(item, [])
  end
end

.included_tax_amount_for(options) ⇒ Object 



108
109
110
111
112
113
114
115
 
# File 'app/models/spree/tax_rate.rb', line 108

def self.included_tax_amount_for(options)
  return 0 unless options[:tax_zone] && options[:tax_category]

  potential_rates_for_zone(options[:tax_zone]).
    included_in_price.
    for_tax_category(options[:tax_category]).
    sum(:amount)
end

.match(order_tax_zone) ⇒ Object

Gets the array of TaxRates appropriate for the specified tax zone



49
50
51
52
53
 
# File 'app/models/spree/tax_rate.rb', line 49

def self.match(order_tax_zone)
  return [] unless order_tax_zone

  potential_rates_for_zone(order_tax_zone)
end

.store_pre_tax_amount(item, rates) ⇒ Object

Pre-tax amounts must be stored so that we can calculate correct rate amounts in the future. For example: github.com/spree/spree/issues/4318#issuecomment-34723428



58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'app/models/spree/tax_rate.rb', line 58

def self.store_pre_tax_amount(item, rates)
  pre_tax_amount = case item.class.to_s
                   when 'Spree::LineItem' then item.discounted_amount
                   when 'Spree::Shipment' then item.discounted_cost
                   end

  included_rates = rates.select(&:included_in_price)
  if included_rates.any?
    pre_tax_amount /= (1 + included_rates.sum(&:amount))
  end

  item.update_column(:pre_tax_amount, pre_tax_amount)
end

Instance Method Details

#additional? ⇒ Boolean

Returns:



129
130
131
 
# File 'app/models/spree/tax_rate.rb', line 129

def additional?
  !included_in_price
end

#adjust(order, item) ⇒ Object 



117
118
119
 
# File 'app/models/spree/tax_rate.rb', line 117

def adjust(order, item)
  create_adjustment(order, item, included_in_price)
end

#amount_percentage ⇒ Object

Virtual attribute for percentage display in admin forms



38
39
40
41
42
 
# File 'app/models/spree/tax_rate.rb', line 38

def amount_percentage
  return nil if amount.nil?

  (amount * 100).round(2)
end

#amount_percentage=(value) ⇒ Object 



44
45
46
 
# File 'app/models/spree/tax_rate.rb', line 44

def amount_percentage=(value)
  self.amount = value.present? ? (value.to_f / 100) : nil
end

#compute_amount(item) ⇒ Object 



121
122
123
 
# File 'app/models/spree/tax_rate.rb', line 121

def compute_amount(item)
  compute(item)
end

#included? ⇒ Boolean

Returns:



125
126
127
 
# File 'app/models/spree/tax_rate.rb', line 125

def included?
  included_in_price
end