Module: JSON

Module | JSON
In: | ext/json/ext/generator/generator.c ext/json/ext/parser/parser.c ext/json/ext/generator/generator.c ext/json/ext/parser/parser.c lib/json.rb lib/json/common.rb lib/json/pure/generator.rb lib/json/pure/parser.rb lib/json/pure.rb lib/json/version.rb lib/json/ext.rb lib/json/editor.rb

call-seq: source()

Returns a copy of the current source string, that was used to construct this Parser.

### Methods

[] dump fast_generate generate load parse parse! pretty_generate restore

### Classes and Modules

Module JSON::Editor
Module JSON::Ext
Module JSON::Pure
Class JSON::CircularDatastructure
Class JSON::GeneratorError
Class JSON::JSONError
Class JSON::MissingUnicodeSupport
Class JSON::NestingError
Class JSON::ParserError

### Constants

NaN | = | (-1.0) ** 0.5
Infinity | = | 1.0/0
MinusInfinity | = | -Infinity
UnparserError | = | GeneratorError |  | For backwards compatibility
JSON_LOADED | = | true
VERSION | = | '1.1.7' |  | JSON version
JSON_LOADED | = | true

### Attributes

create_id | [RW] | This is create identifier, that is used to decide, if the json_create hook of a class should be called. It defaults to ‘json_class’.
generator | [R] | Returns the JSON generator modul, that is used by JSON. This might be either JSON::Ext::Generator or JSON::Pure::Generator.
parser | [R] | Returns the JSON parser class, that is used by JSON. This might be either JSON::Ext::Parser or JSON::Pure::Parser.
state | [RW] | Returns the JSON generator state class, that is used by JSON. This might be either JSON::Ext::Generator::State or JSON::Pure::Generator::State.

### Public Class methods

[](object, opts = {})

If object is string-like parse the string and return the parsed result as a Ruby data structure. Otherwise generate a JSON text from the Ruby data structure object and return it.

The opts argument is passed through to generate/parse respectively, see generate and parse for their documentation.

### Public Instance methods

dump(obj, anIO = nil, limit = nil)

Dumps obj as a JSON string, i.e. calls generate on the object and returns the result.

If anIO (an IO like object or an object that responds to the write method) was given, the resulting JSON is written to it.

If the number of nested arrays or objects exceeds limit an ArgumentError exception is raised. This argument is similar (but not exactly the same!) to the limit argument in Marshal.dump.

This method is part of the implementation of the load/dump interface of Marshal and YAML.

fast_generate(obj)

Unparse the Ruby data structure obj into a single line JSON string and return it. This method disables the checks for circles in Ruby objects, and also generates NaN, Infinity, and, -Infinity float values.

WARNING: Be careful not to pass any Ruby data structures with circles as obj argument, because this will cause JSON to go into an infinite loop.

generate(obj, state = nil)

Unparse the Ruby data structure obj into a single line JSON string and return it. state is

- a JSON::State object,
- or a Hash like object (responding to to_hash),
- an object convertible into a hash by a to_h method,

that is used as or to configure a State object.

It defaults to a state object, that creates the shortest possible JSON text in one line, checks for circular data structures and doesn‘t allow NaN, Infinity, and -Infinity.

A state hash can have the following keys:

- indent: a string used to indent levels (default: ’’),
- space: a string that is put after, a : or , delimiter (default: ’’),
- space_before: a string that is put before a : pair delimiter (default: ’’),
- object_nl: a string that is put at the end of a JSON object (default: ’’),
- array_nl: a string that is put at the end of a JSON array (default: ’’),
- check_circular: true if checking for circular data structures should be done (the default), false otherwise.
- allow_nan: true if NaN, Infinity, and -Infinity should be generated, otherwise an exception is thrown, if these values are encountered. This options defaults to false.
- max_nesting: The maximum depth of nesting allowed in the data structures from which JSON is to be generated. Disable depth checking with :max_nesting => false, it defaults to 19.

See also the fast_generate for the fastest creation method with the least amount of sanity checks, and the pretty_generate method for some defaults for a pretty output.

load(source, proc = nil)

Load a ruby data structure from a JSON source and return it. A source can either be a string-like object, an IO like object, or an object responding to the read method. If proc was given, it will be called with any nested Ruby object as an argument recursively in depth first order.

This method is part of the implementation of the load/dump interface of Marshal and YAML.

parse(source, opts = {})

Parse the JSON string source into a Ruby data structure and return it.

opts can have the following keys:

- max_nesting: The maximum depth of nesting allowed in the parsed data structures. Disable depth checking with :max_nesting => false, it defaults to 19.
- allow_nan: If set to true, allow NaN, Infinity and -Infinity in defiance of RFC 4627 to be parsed by the Parser. This option defaults to false.
- create_additions: If set to false, the Parser doesn‘t create additions even if a matchin class and create_id was found. This option defaults to true.

parse!(source, opts = {})

Parse the JSON string source into a Ruby data structure and return it. The bang version of the parse method, defaults to the more dangerous values for the opts hash, so be sure only to parse trusted source strings.

opts can have the following keys:

- max_nesting: The maximum depth of nesting allowed in the parsed data structures. Enable depth checking with :max_nesting => anInteger. The parse! methods defaults to not doing max depth checking: This can be dangerous, if someone wants to fill up your stack.
- allow_nan: If set to true, allow NaN, Infinity, and -Infinity in defiance of RFC 4627 to be parsed by the Parser. This option defaults to true.
- create_additions: If set to false, the Parser doesn‘t create additions even if a matchin class and create_id was found. This option defaults to true.

pretty_generate(obj, opts = nil)

Unparse the Ruby data structure obj into a JSON string and return it. The returned string is a prettier form of the string returned by unparse.

The opts argument can be used to configure the generator, see the generate method for a more detailed explanation.

restore(source, proc = nil)

Alias for load

[Validate]