Sha256: f756a9c63868498f0c6816af4a9974d25611e1ba9fc610c3154b1d04af156992

Contents?: true

Size: 1.42 KB

Versions: 11

Compression:

Stored size: 1.42 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(shipping_rate)
        @shipping_rate = shipping_rate
      end

      # Calculate taxes for a shipping rate.
      #
      # @return [Array<Spree::Tax::ItemTax>] the calculated taxes for the
      #   shipping rate
      def calculate
        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

11 entries across 11 versions & 1 rubygems

Version Path
solidus_core-2.4.2 app/models/spree/tax_calculator/shipping_rate.rb
solidus_core-2.3.1 app/models/spree/tax_calculator/shipping_rate.rb
solidus_core-2.4.1 app/models/spree/tax_calculator/shipping_rate.rb
solidus_core-2.4.0 app/models/spree/tax_calculator/shipping_rate.rb
solidus_core-2.4.0.rc1 app/models/spree/tax_calculator/shipping_rate.rb
solidus_core-2.4.0.beta1 app/models/spree/tax_calculator/shipping_rate.rb
solidus_core-2.3.0 app/models/spree/tax_calculator/shipping_rate.rb
solidus_core-2.3.0.rc3 app/models/spree/tax_calculator/shipping_rate.rb
solidus_core-2.3.0.rc2 app/models/spree/tax_calculator/shipping_rate.rb
solidus_core-2.3.0.rc1 app/models/spree/tax_calculator/shipping_rate.rb
solidus_core-2.3.0.beta1 app/models/spree/tax_calculator/shipping_rate.rb