Skip to Content Skip to Search

module ActiveSupport::JSON

Constants

DATETIME_REGEX

/\A(?:\d{4}-\d{2}-\d{2}|\d{4}-\d{1,2}-\d{1,2}[T \t]+\d{1,2}:\d{2}:\d{2}(\.[0-9]*)?(([ \t]*)Z|[-+]\d{2}?(:\d{2})?)?)\z/

DATE_REGEX

matches YAML-formatted dates

/\A\d{4}-\d{2}-\d{2}\z/

Attributes

[RW] escape_html_entities_in_json

If true, encode >, <, & as escaped unicode sequences (e.g. > as u003e) as a safety measure.
[R] json_encoder

Sets the encoder used by Rails to encode Ruby objects into JSON strings in +Object#to_json+ and ActiveSupport::JSON.encode.
[RW] time_precision

Sets the precision of encoded time values. Defaults to 3 (equivalent to millisecond precision)
[RW] use_standard_json_time_format

If true, use ISO 8601 format for dates and times. Otherwise, fall back to the Active Support legacy format.

Public class methods

decode(json, options = {})

Also aliased as: load.

Parses a JSON string (JavaScript Object Notation) into a hash. See www.json.org for more info.

ActiveSupport::JSON.decode("{\"team\":\"rails\",\"players\":\"36\"}")
=> {"team" => "rails", "players" => "36"}
Source code GitHub 
# File activesupport/lib/active_support/json/decoding.rb, line 22
def decode(json, options = {})
  data = ::JSON.parse(json, options)

  if ActiveSupport.parse_json_times
    convert_dates_from(data)
  else
    data
  end
end

dump(value, options = nil)

Alias for: encode.

encode(value, options = nil)

Also aliased as: dump.

Dumps objects in JSON (JavaScript Object Notation). See www.json.org for more info.

ActiveSupport::JSON.encode({ team: 'rails', players: '36' })
# => "{\"team\":\"rails\",\"players\":\"36\"}"

Generates JSON that is safe to include in JavaScript as it escapes U+2028 (Line Separator) and U+2029 (Paragraph Separator):

ActiveSupport::JSON.encode({ key: "\u2028" })
# => "{\"key\":\"\\u2028\"}"

By default, it also generates JSON that is safe to include in HTML, as it escapes <, >, and &:

ActiveSupport::JSON.encode({ key: "<>&" })
# => "{\"key\":\"\\u003c\\u003e\\u0026\"}"

This can be changed with the escape_html_entities option, or the global escape_html_entities_in_json configuration option.

ActiveSupport::JSON.encode({ key: "<>&" }, escape_html_entities: false)
# => "{\"key\":\"<>&\"}"
Source code GitHub 
# File activesupport/lib/active_support/json/encoding.rb, line 40
def encode(value, options = nil)
  if options.nil?
    Encoding.encode_without_options(value)
  else
    Encoding.json_encoder.new(options).encode(value)
  end
end

json_encoder=(encoder)

Source code GitHub 
# File activesupport/lib/active_support/json/encoding.rb, line 196
def json_encoder=(encoder)
  @json_encoder = encoder
  @encoder_without_options = encoder.new
end

load(json, options = {})

Alias for: decode.

parse_error()

Returns the class of the error that will be raised when there is an error in decoding JSON. Using this method means you won’t directly depend on the ActiveSupport’s JSON implementation, in case it changes in the future.

begin
  obj = ActiveSupport::JSON.decode(some_string)
rescue ActiveSupport::JSON.parse_error
  Rails.logger.warn("Attempted to decode invalid JSON: #{some_string}")
end
Source code GitHub 
# File activesupport/lib/active_support/json/decoding.rb, line 43
def parse_error
  ::JSON::ParserError
end

Definition files