Class: Spree::Money

Inherits:
Object
  • Object
show all
Includes:
Comparable
Defined in:
lib/spree/money.rb

Overview

Spree::Money is a relatively thin wrapper around Monetize which handles formatting via Spree::Config.

Constant Summary collapse

DifferentCurrencyError = 
Class.new(StandardError)
RUBY_NUMERIC_STRING = 
/\A-?\d+(\.\d+)?\z/

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(amount, options = {}) ⇒ Money

Returns a new instance of Money.

Parameters:

  • amount (Money, #to_s) —

    the value of the money object

  • options (Hash) (defaults to: {}) —

    the default options for formatting the money object See #format



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/spree/money.rb', line 35

def initialize(amount, options = {})
  if amount.is_a?(::Money)
    @money = amount
  else
    currency = (options[:currency] || Spree::Config[:currency])
    if amount.to_s =~ RUBY_NUMERIC_STRING
      @money = Monetize.from_string(amount, currency)
    else
      @money = Spree::Money.parse_to_money(amount, currency)
      Spree::Deprecation.warn <<-WARN.squish, caller
        Spree::Money was initialized with #{amount.inspect}, which will not be supported in the future.
        Instead use Spree::Money.new(#{@money.to_s.inspect}, options) or Spree::Money.parse(#{amount.inspect})
      WARN
    end
  end
  @options = Spree::Money.default_formatting_rules.merge(options)
end

Class Attribute Details

.default_formatting_rules ⇒ Object

Returns the value of attribute default_formatting_rules.



12
13
14
 
# File 'lib/spree/money.rb', line 12

def default_formatting_rules
  @default_formatting_rules
end

Instance Attribute Details

#money ⇒ Object (readonly)

Returns the value of attribute money.



29
30
31
 
# File 'lib/spree/money.rb', line 29

def money
  @money
end

Class Method Details

.parse(amount, currency = Spree::Config[:currency]) ⇒ Object 



14
15
16
 
# File 'lib/spree/money.rb', line 14

def parse(amount, currency = Spree::Config[:currency])
  new(parse_to_money(amount, currency))
end

.parse_to_money(amount, currency) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



19
20
21
 
# File 'lib/spree/money.rb', line 19

def parse_to_money(amount, currency)
  ::Monetize.parse(amount, currency)
end

Instance Method Details

#+(other) ⇒ Object

Raises:

  • (TypeError) 


130
131
132
133
 
# File 'lib/spree/money.rb', line 130

def +(other)
  raise TypeError, "Can't add #{other.class} to Spree::Money" if !other.respond_to?(:money)
  self.class.new(@money + other.money)
end

#-(other) ⇒ Object

Raises:

  • (TypeError) 


125
126
127
128
 
# File 'lib/spree/money.rb', line 125

def -(other)
  raise TypeError, "Can't subtract #{other.class} to Spree::Money" if !other.respond_to?(:money)
  self.class.new(@money - other.money)
end

#<=>(other) ⇒ Object 



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/spree/money.rb', line 101

def <=>(other)
  if !other.respond_to?(:money)
    raise TypeError, "Can't compare #{other.class} to Spree::Money"
  end
  if currency != other.currency
    # By default, ::Money will try to run a conversion on `other.money` and
    # try a comparison on that. We do not want any currency conversion to
    # take place so we'll catch this here and raise an error.
    raise(
      DifferentCurrencyError,
      "Can't compare #{currency} with #{other.currency}"
    )
  end
  @money <=> other.money
end

#==(other) ⇒ Object

Delegates comparison to the internal ruby money instance.

Raises:

  • (TypeError)

See Also:



120
121
122
123
 
# File 'lib/spree/money.rb', line 120

def ==(other)
  raise TypeError, "Can't compare #{other.class} to Spree::Money" if !other.respond_to?(:money)
  @money == other.money
end

#as_json ⇒ String

Returns the value of this money object formatted according to its options.

Returns:

  • (String) —

    the value of this money object formatted according to its options



97
98
99
 
# File 'lib/spree/money.rb', line 97

def as_json(*)
  to_s
end

#format(options = {}) ⇒ String

Returns the value of this money object formatted according to its options.

Parameters:

  • options (Hash, String) (defaults to: {}) —

    the options for formatting the money object

Options Hash (options):

  • with_currency (Boolean) —

    when true, show the currency

  • no_cents (Boolean) —

    when true, round to the closest dollar

  • decimal_mark (String) —

    the mark for delimiting the decimals

  • thousands_separator (String, false, nil) —

    the character to delimit powers of 1000, if one is desired, otherwise false or nil

  • sign_before_symbol (Boolean) —

    when true the sign of the value comes before the currency symbol

  • symbol_position (:before, :after) —

    the position of the currency symbol

Returns:

  • (String) —

    the value of this money object formatted according to its options



72
73
74
 
# File 'lib/spree/money.rb', line 72

def format(options = {})
  @money.format(@options.merge(options))
end

#to_html(options = { html_wrap: true }) ⇒ String

Note:

If you pass in options, ensure you pass in the { html_wrap: true } as well.

Returns the value of this money object formatted according to its options and any additional options, by default with html_wrap.

Parameters:

  • options (Hash) (defaults to: { html_wrap: true }) —

    additional formatting options

Returns:

  • (String) —

    the value of this money object formatted according to its options and any additional options, by default with html_wrap.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/spree/money.rb', line 80

def to_html(options = { html_wrap: true })
  output = format(options)
  # Maintain compatibility by checking html option renamed to html_wrap.
  if options[:html] || options[:html] == false
    Spree::Deprecation.warn <<-WARN.squish, caller
      Spree::Money#to_html called with Spree::Money#to_html(html: #{options[:html].inspect}),
      which will not be supported in the future.
      Instead use :html_wrap e.g. Spree::Money#to_html(html_wrap: #{options[:html].inspect})
    WARN
  end
  if options[:html_wrap] || options[:html]
    output = output.html_safe
  end
  output
end

#to_s ⇒ String

Returns the value of this money object formatted according to its options.

Returns:

  • (String) —

    the value of this money object formatted according to its options



55
56
57
 
# File 'lib/spree/money.rb', line 55

def to_s
  format
end