Contents

# frozen_string_literal: true

module Spree
  class Calculator < Spree::Base
    belongs_to :calculable, polymorphic: true, optional: true

    # This method calls a compute_<computable> method. must be overriden in concrete calculator.
    #
    # It should return amount computed based on #calculable and the computable parameter
    def compute(computable)
      # Spree::LineItem -> :compute_line_item
      computable_name = computable.class.name.demodulize.underscore
      method_name = "compute_#{computable_name}".to_sym
      calculator_class = self.class
      if respond_to?(method_name)
        send(method_name, computable)
      else
        raise NotImplementedError, "Please implement '#{method_name}(#{computable_name})' in your calculator: #{calculator_class.name}"
      end
    end

    # A description for this calculator in few words
    # @return [String] A description for the calculator
    def self.description
      model_name.human
    end

    ###################################################################

    # Returns all calculators applicable for kind of work
    def self.calculators
      Spree::Deprecation.warn("Calling .calculators is deprecated. Please access through Rails.application.config.spree.calculators")

      Spree::Config.environment.calculators
    end

    def to_s
      self.class.name.titleize.gsub("Calculator\/", "")
    end

    def description
      self.class.description
    end

    def available?(_object)
      true
    end
  end
end

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
solidus_core-2.11.7	app/models/spree/calculator.rb
solidus_core-2.11.6	app/models/spree/calculator.rb
solidus_core-2.11.5	app/models/spree/calculator.rb
solidus_core-2.11.4	app/models/spree/calculator.rb