Module: ActiveSupport::JSON

Defined in:
lib/active_support/json/decoding.rb,
lib/active_support/json/encoding.rb more...

Defined Under Namespace

Modules: Encoding

Constant Summary collapse

DATE_REGEX =

matches YAML-formatted dates

/\A\d{4}-\d{2}-\d{2}\z/
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/

Class Method Summary collapse

Class Method Details

.decode(json) ⇒ Object Also known 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"}
[View source]

22
23
24
25
26
27
28
29
30
 
# File 'lib/active_support/json/decoding.rb', line 22

def decode(json)
  data = ::JSON.parse(json, quirks_mode: true)

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

.encode(value, options = nil) ⇒ Object Also known 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\":\"<>&\"}"
[View source]

40
41
42
 
# File 'lib/active_support/json/encoding.rb', line 40

def encode(value, options = nil)
  Encoding.json_encoder.new(options).encode(value)
end

.parse_error ⇒ Object

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
[View source]

43
44
45
 
# File 'lib/active_support/json/decoding.rb', line 43

def parse_error
  ::JSON::ParserError
end