Class: Spree::Calculator

Inherits:
Base
  • Object
show all
Defined in:
app/models/spree/calculator.rb

Defined Under Namespace

Modules: Returns, Shipping Classes: DefaultTax, DistributedAmount, FlatPercentItemTotal, FlatRate, FlexiRate, FreeShipping, PercentOnLineItem, PercentPerItem, PriceSack, TieredFlatRate, TieredPercent

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

display_includes, #initialize_preference_defaults, page, preference

Methods included from Preferences::Preferable

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

Class Method Details

.calculators ⇒ Object

Returns all calculators applicable for kind of work



31
32
33
34
35
 
# File 'app/models/spree/calculator.rb', line 31

def self.calculators
  Spree::Deprecation.warn("Calling .calculators is deprecated. Please access through Rails.application.config.spree.calculators")

  Spree::Config.environment.calculators
end

.description ⇒ String

A description for this calculator in few words

Returns:

  • (String) —

    A description for the calculator



24
25
26
 
# File 'app/models/spree/calculator.rb', line 24

def self.description
  model_name.human
end

Instance Method Details

#available?(_object) ⇒ Boolean

Returns:

  • (Boolean) 


45
46
47
 
# File 'app/models/spree/calculator.rb', line 45

def available?(_object)
  true
end

#compute(computable) ⇒ Object

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



10
11
12
13
14
15
16
17
18
19
20
 
# File 'app/models/spree/calculator.rb', line 10

def compute(computable)
  # Spree::LineItem -> :compute_line_item
  computable_name = computable.class.name.demodulize.underscore
  method = "compute_#{computable_name}".to_sym
  calculator_class = self.class
  if respond_to?(method)
    send(method, computable)
  else
    raise NotImplementedError, "Please implement '#{method}(#{computable_name})' in your calculator: #{calculator_class.name}"
  end
end

#description ⇒ Object 



41
42
43
 
# File 'app/models/spree/calculator.rb', line 41

def description
  self.class.description
end

#to_s ⇒ Object 



37
38
39
 
# File 'app/models/spree/calculator.rb', line 37

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