adds a comment explaining why BigDecimal#as_json returns a JSON string

This commit is contained in:
Xavier Noria 2010-05-03 22:04:47 +02:00
parent 34d5725167
commit 9e085a9f33

@ -1,7 +1,7 @@
# encoding: utf-8 # encoding: utf-8
require 'bigdecimal' require 'bigdecimal'
require 'active_support/core_ext/array/wrap' require 'active_support/core_ext/array/wrap'
require 'active_support/core_ext/big_decimal/conversions' require 'active_support/core_ext/big_decimal/conversions' # for #to_s
require 'active_support/core_ext/hash/except' require 'active_support/core_ext/hash/except'
require 'active_support/core_ext/hash/slice' require 'active_support/core_ext/hash/slice'
require 'active_support/core_ext/module/delegation' require 'active_support/core_ext/module/delegation'
@ -179,6 +179,14 @@ def encode_json(encoder) to_s end #:nodoc:
end end
class BigDecimal class BigDecimal
# A BigDecimal would be naturally represented as a JSON number. Most libraries,
# however, parse non-integer JSON numbers directly as floats. Clients using
# those libraries would get in general a wrong number and no way to recover
# other than manually inspecting the string with the JSON code itself.
#
# That's why a JSON string is returned. The JSON literal is not numeric, but if
# the other end knows by contract that the data is supposed to be a BigDecimal,
# it still has the chance to post-process the string and get the real value.
def as_json(options = nil) to_s end #:nodoc: def as_json(options = nil) to_s end #:nodoc:
end end