Sha256: fad33f9c657479d281ec2b6098237422238b68d29ceebdce20ed7c7dc9c4d545

Contents?: true

Size: 1.8 KB

Versions: 6

Compression:

Stored size: 1.8 KB

Contents

module Spree
  module TaxCalculator
    # Default implementation for tax calculations on shipping rates.
    #
    # The class used for shipping rate tax calculation is configurable, so that
    # the calculation can easily be pushed to third-party services. Users
    # looking to provide their own calculator should adhere to the API of this
    # class.
    #
    # @see Spree::Tax::ShippingRateTaxer
    # @api experimental
    # @note This API is currently in development and likely to change.
    #   Specifically, the input format is not yet finalized.
    class ShippingRate
      include Spree::Tax::TaxHelpers

      attr_reader :shipping_rate

      # Create a new tax calculator.
      #
      # @param [Spree::ShippingRate] shipping_rate the shipping rate to
      #   calculate taxes on
      # @return [Spree::TaxCalculator::ShippingRate]
      def initialize(order)
        if order.is_a?(::Spree::ShippingRate)
          Spree::Deprecation.warn "passing a single shipping rate to Spree::TaxCalculator::ShippingRate is DEPRECATED. It now expects an order"
          shipping_rate = order
          @order = shipping_rate.order
          @shipping_rate = shipping_rate
        else
          @order = order
          @shipping_rate = nil
        end
      end

      # Calculate taxes for a shipping rate.
      #
      # @return [Array<Spree::Tax::ItemTax>] the calculated taxes for the
      #   shipping rate
      def calculate(shipping_rate)
        shipping_rate ||= @shipping_rate
        rates_for_item(shipping_rate).map do |rate|
          amount = rate.compute_amount(shipping_rate)

          Spree::Tax::ItemTax.new(
            item_id: shipping_rate.id,
            label: rate.adjustment_label(amount),
            tax_rate: rate,
            amount: amount
          )
        end
      end
    end
  end
end

Version data entries

6 entries across 6 versions & 1 rubygems

Version Path
solidus_core-2.5.2 app/models/spree/tax_calculator/shipping_rate.rb
solidus_core-2.5.1 app/models/spree/tax_calculator/shipping_rate.rb
solidus_core-2.5.0 app/models/spree/tax_calculator/shipping_rate.rb
solidus_core-2.5.0.rc1 app/models/spree/tax_calculator/shipping_rate.rb
solidus_core-2.5.0.beta2 app/models/spree/tax_calculator/shipping_rate.rb
solidus_core-2.5.0.beta1 app/models/spree/tax_calculator/shipping_rate.rb