Class: Spree::Calculator

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

Defined Under Namespace

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

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

belongs_to_required_by_default, page, spree_base_scopes

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

.calculators ⇒ Object

Returns all calculators applicable for kind of work



28
29
30
 
# File 'app/models/spree/calculator.rb', line 28

def self.calculators
  Rails.application.config.spree.calculators
end

.description ⇒ Object

overwrite to provide description for your calculators



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

def self.description
  'Base Calculator'
end

Instance Method Details

#available?(_object) ⇒ Boolean

Returns:

  • (Boolean) 


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

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 



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

def description
  self.class.description
end

#to_s ⇒ Object 



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

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