Class: Spree::TaxRate

Inherits:
Base
  • Object
show all
Includes:
AdjustmentSource, CalculatedAdjustments
Defined in:
app/models/spree/tax_rate.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

page

Methods included from Preferences::Preferable

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

Class Method Details

.adjust(order_tax_zone, items) ⇒ Object

This method is best described by the documentation on #potentially_applicable?



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
# File 'app/models/spree/tax_rate.rb', line 78

def self.adjust(order_tax_zone, items)
  rates = self.match(order_tax_zone)
  tax_categories = rates.map(&:tax_category)
  relevant_items, non_relevant_items = items.partition { |item| tax_categories.include?(item.tax_category) }
  Spree::Adjustment.where(adjustable: relevant_items).tax.destroy_all # using destroy_all to ensure adjustment destroy callback fires.
  relevant_items.each do |item|
    relevant_rates = rates.select { |rate| rate.tax_category == item.tax_category }
    store_pre_tax_amount(item, relevant_rates)
    relevant_rates.each do |rate|
      rate.adjust(order_tax_zone, item)
    end
  end
  non_relevant_items.each do |item|
    if item.adjustments.tax.present?
      item.adjustments.tax.destroy_all # using destroy_all to ensure adjustment destroy callback fires.
      item.update_columns pre_tax_amount: 0
    end
  end
end

.match(order_tax_zone) ⇒ Object

Gets the array of TaxRates appropriate for the specified order



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
# File 'app/models/spree/tax_rate.rb', line 33

def self.match(order_tax_zone)
  return [] unless order_tax_zone
  rates = includes(zone: { zone_members: :zoneable }).load.select do |rate|
    # Why "potentially"?
    # Go see the documentation for that method.
    rate.potentially_applicable?(order_tax_zone)
  end

  # Imagine with me this scenario:
  # You are living in Spain and you have a store which ships to France.
  # Spain is therefore your default tax rate.
  # When you ship to Spain, you want the Spanish rate to apply.
  # When you ship to France, you want the French rate to apply.
  #
  # Normally, Spree would notice that you have two potentially applicable
  # tax rates for one particular item.
  # When you ship to Spain, only the Spanish one will apply.
  # When you ship to France, you'll see a Spanish refund AND a French tax.
  # This little bit of code at the end stops the Spanish refund from appearing.
  #
  # For further discussion, see #4397 and #4327.
  rates.delete_if do |rate|
    rate.included_in_price? &&
    (rates - [rate]).map(&:tax_category).include?(rate.tax_category)
  end
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



63
64
65
66
67
68
69
70
71
72
73
74
75
# File 'app/models/spree/tax_rate.rb', line 63

def self.store_pre_tax_amount(item, rates)
  pre_tax_amount = case item
    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.map(&:amount).sum)
  end

  item.update_column(:pre_tax_amount, pre_tax_amount)
end

Instance Method Details

#adjust(order_tax_zone, item) ⇒ Object

Creates necessary tax adjustments for the order.



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
# File 'app/models/spree/tax_rate.rb', line 148

def adjust(order_tax_zone, item)
  amount = compute_amount(item)
  return if amount == 0

  included = included_in_price && default_zone_or_zone_match?(order_tax_zone)

  if amount < 0
    label = Spree.t(:refund) + ' ' + create_label
  end

  self.adjustments.create!({
    :adjustable => item,
    :amount => amount,
    :order_id => item.order_id,
    :label => label || create_label,
    :included => included
  })
end

#compute_amount(item) ⇒ Object

This method is used by Adjustment#update to recalculate the cost.



168
169
170
171
172
173
174
175
176
177
178
179
# File 'app/models/spree/tax_rate.rb', line 168

def compute_amount(item)
  if included_in_price
    if default_zone_or_zone_match?(item.order.tax_zone)
      calculator.compute(item)
    else
      # In this case, it's a refund.
      calculator.compute(item) * - 1
    end
  else
    calculator.compute(item)
  end
end

#default_zone_or_zone_match?(order_tax_zone) ⇒ Boolean

Returns:

  • (Boolean)


181
182
183
184
# File 'app/models/spree/tax_rate.rb', line 181

def default_zone_or_zone_match?(order_tax_zone)
  default_tax = Zone.default_tax
  (default_tax && default_tax.contains?(order_tax_zone)) || order_tax_zone == self.zone
end

#potentially_applicable?(order_tax_zone) ⇒ Boolean

Tax rates can potentially be applicable to an order. We do not know if they are/aren't until we attempt to apply these rates to the items contained within the Order itself. For instance, if a rate passes the criteria outlined in this method, but then has a tax category that doesn't match against any of the line items inside of the order, then that tax rate will not be applicable to anything. For instance:

Zones:

- Spain (default tax zone)
- France

Tax rates: (note: amounts below do not actually reflect real VAT rates)

21% inclusive - "Clothing" - Spain
18% inclusive - "Clothing" - France
10% inclusive - "Food" - Spain
8% inclusive - "Food" - France
5% inclusive - "Hotels" - Spain
2% inclusive - "Hotels" - France

Order has:

Line Item #1 - Tax Category: Clothing
Line Item #2 - Tax Category: Food

Tax rates that should be selected:

21% inclusive - "Clothing" - Spain
10% inclusive - "Food" - Spain

If the order's address changes to one in France, then the tax will be recalculated:

18% inclusive - "Clothing" - France
8% inclusive - "Food" - France

Note here that the “Hotels” tax rates will not be used at all. This is because there are no items which have the tax category of “Hotels”.

Under no circumstances should negative adjustments be applied for the Spanish tax rates.

Those rates should never come into play at all and only the French rates should apply.

Returns:

  • (Boolean)


138
139
140
141
142
143
144
145
# File 'app/models/spree/tax_rate.rb', line 138

def potentially_applicable?(order_tax_zone)
  # If the rate's zone matches the order's tax zone, then it's applicable.
  self.zone == order_tax_zone ||
  # If the rate's zone *contains* the order's tax zone, then it's applicable.
  self.zone.contains?(order_tax_zone) ||
  # 1) The rate's zone is the default zone, then it's always applicable.
  (self.included_in_price? && self.zone.default_tax)
end