JSON

Methods

#

[]

D

dump

F

fast_generate

G

generate

I

iconv

L

load

P

parse,
parse!,
pretty_generate

R

recurse_proc,
restore

Classes and Modules

Constants

NaN	=	0.0/0
Infinity	=	1.0/0
MinusInfinity	=	-Infinity
UnparserError	=	GeneratorError
	For backwards compatibility
JSON_LOADED	=	true
VERSION	=	'1.4.4'
	JSON version
JSON_LOADED	=	true

Attributes

[R]	parser	Returns the JSON parser class, that is used by JSON. This might be either JSON::Ext::Parser or JSON::Pure::Parser.
[R]	generator	Returns the JSON generator modul, that is used by JSON. This might be either JSON::Ext::Generator or JSON::Pure::Generator.
[RW]	state	Returns the JSON generator state class, that is used by JSON. This might be either JSON::Ext::Generator::State or JSON::Pure::Generator::State.
[RW]	create_id	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’.

Class Public 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.

Source: show

    # File lib/json/common.rb, line 12
12:     def [](object, opts = {})
13:       if object.respond_to? :to_str
14:         JSON.parse(object.to_str, opts => {})
15:       else
16:         JSON.generate(object, opts => {})
17:       end
18:     end

iconv(to, from, string)

Shortuct for iconv.

Source: show

     # File lib/json/common.rb, line 348
348:   def self.iconv(to, from, string)
349:     Iconv.iconv(to, from, string).first
350:   end

restore(source, proc = nil)

Instance Public 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.

Source: show

     # File lib/json/common.rb, line 327
327:   def dump(obj, anIO = nil, limit = nil)
328:     if anIO and limit.nil?
329:       anIO = anIO.to_io if anIO.respond_to?(:to_io)
330:       unless anIO.respond_to?(:write)
331:         limit = anIO
332:         anIO = nil
333:       end
334:     end
335:     limit ||= 0
336:     result = generate(obj, :allow_nan => true, :max_nesting => limit)
337:     if anIO
338:       anIO.write result
339:       anIO
340:     else
341:       result
342:     end
343:   rescue JSON::NestingError
344:     raise ArgumentError, "exceed depth limit"
345:   end

fast_generate(obj, opts = nil)

Generate a JSON document from the Ruby data structure obj and return it. This method disables the checks for circles in Ruby objects.

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.

Source: show

     # File lib/json/common.rb, line 227
227:   def fast_generate(obj, opts = nil)
228:     if opts
229:       if opts.respond_to? :to_hash
230:         opts = opts.to_hash
231:       elsif opts.respond_to? :to_h
232:         opts = opts.to_h
233:       else
234:         raise TypeError, "can't convert #{opts.class} into Hash"
235:       end
236:       state = FAST_STATE_PROTOTYPE.dup
237:       state.configure(opts)
238:     else
239:       state = FAST_STATE_PROTOTYPE
240:     end
241:     state.generate(obj)
242:   end

generate(obj, opts = nil)

Generate a JSON document from the Ruby data structure obj 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: ’’),
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.

Source: show

     # File lib/json/common.rb, line 198
198:   def generate(obj, opts = nil)
199:     if opts
200:       if opts.respond_to? :to_hash
201:         opts = opts.to_hash
202:       elsif opts.respond_to? :to_h
203:         opts = opts.to_h
204:       else
205:         raise TypeError, "can't convert #{opts.class} into Hash"
206:       end
207:       state = SAFE_STATE_PROTOTYPE.dup
208:       state = state.configure(opts)
209:     else
210:       state = SAFE_STATE_PROTOTYPE
211:     end
212:     state.generate(obj)
213:   end

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.

This method is also aliased as restore

Source: show

     # File lib/json/common.rb, line 286
286:   def load(source, proc = nil)
287:     if source.respond_to? :to_str
288:       source = source.to_str
289:     elsif source.respond_to? :to_io
290:       source = source.to_io.read
291:     else
292:       source = source.read
293:     end
294:     result = parse(source, :max_nesting => false, :allow_nan => true)
295:     recurse_proc(result, &proc) if proc
296:     result
297:   end

parse(source, opts = {})

Parse the JSON document 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.
symbolize_names: If set to true, returns symbols for the names (keys) in a JSON object. Otherwise strings are returned, which is also the default.
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.
object_class: Defaults to Hash
array_class: Defaults to Array

Source: show

     # File lib/json/common.rb, line 145
145:   def parse(source, opts = {})
146:     Parser.new(source, opts).parse
147:   end

parse!(source, opts = {})

Parse the JSON document 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 documents.

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.

Source: show

     # File lib/json/common.rb, line 164
164:   def parse!(source, opts = {})
165:     opts = {
166:       :max_nesting  => false,
167:       :allow_nan    => true
168:     }.update(opts)
169:     Parser.new(source, opts).parse
170:   end

pretty_generate(obj, opts = nil)

Generate a JSON document from the Ruby data structure obj and return it. The returned document is a prettier form of the document returned by #.

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

Source: show

     # File lib/json/common.rb, line 256
256:   def pretty_generate(obj, opts = nil)
257:     if opts
258:       if opts.respond_to? :to_hash
259:         opts = opts.to_hash
260:       elsif opts.respond_to? :to_h
261:         opts = opts.to_h
262:       else
263:         raise TypeError, "can't convert #{opts.class} into Hash"
264:       end
265:       state = PRETTY_STATE_PROTOTYPE.dup
266:       state.configure(opts)
267:     else
268:       state = PRETTY_STATE_PROTOTYPE
269:     end
270:     state.generate(obj)
271:   end

recurse_proc(result, &proc)

Source: show

     # File lib/json/common.rb, line 299
299:   def recurse_proc(result, &proc)
300:     case result
301:     when Array
302:       result.each { |x| recurse_proc x, &proc }
303:       proc.call result
304:     when Hash
305:       result.each { |x, y| recurse_proc x, &proc; recurse_proc y, &proc }
306:       proc.call result
307:     else
308:       proc.call result
309:     end
310:   end

Module JSON