Files

JSON

Constants

NaN
Infinity
MinusInfinity
UnparserError

For backwards compatibility

JSON_LOADED
JSON_LOADED
VERSION

JSON version

Attributes

parser[R]

Returns the JSON parser class that is used by JSON. This is either JSON::Ext::Parser or JSON::Pure::Parser.

generator[R]

Returns the JSON generator module that is used by JSON. This is either JSON::Ext::Generator or JSON::Pure::Generator.

state[RW]

Returns the JSON generator state class that is used by JSON. This is either JSON::Ext::Generator::State or JSON::Pure::Generator::State.

create_id[RW]

This is create identifier, which is used to decide if the json_create hook of a class should be called. It defaults to ‘json_class’.

load_default_options[RW]

The global default options for the JSON.load method:

 :max_nesting: false
 :allow_nan: true
 :quirks_mode: true
dump_default_options[RW]

The global default options for the JSON.dump method:

 :max_nesting: false
 :allow_nan: true
 :quirks_mode: true

Public Class Methods

[](object, opts = {}) click to toggle source

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.

    # 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
const_defined_in?(modul, constant) click to toggle source
     # File lib/json/common.rb, line 425
425:     def self.const_defined_in?(modul, constant)
426:       modul.const_defined?(constant)
427:     end
const_defined_in?(modul, constant) click to toggle source
     # File lib/json/common.rb, line 429
429:     def self.const_defined_in?(modul, constant)
430:       modul.const_defined?(constant, false)
431:     end
iconv(to, from, string) click to toggle source

Encodes string using iconv library

     # File lib/json/common.rb, line 419
419:     def self.iconv(to, from, string)
420:       Iconv.conv(to, from, string)
421:     end
iconv(to, from, string) click to toggle source

Encodes string using Ruby’s String.encode

     # File lib/json/common.rb, line 413
413:     def self.iconv(to, from, string)
414:       string.encode(to, from)
415:     end
restore(source, proc = nil) click to toggle source
Alias for: load

Public Instance Methods

dump(obj, anIO = nil, limit = nil) click to toggle source

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.

The default options for the generator can be changed via the dump_default_options method.

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

     # File lib/json/common.rb, line 377
377:   def dump(obj, anIO = nil, limit = nil)
378:     if anIO and limit.nil?
379:       anIO = anIO.to_io if anIO.respond_to?(:to_io)
380:       unless anIO.respond_to?(:write)
381:         limit = anIO
382:         anIO = nil
383:       end
384:     end
385:     opts = JSON.dump_default_options
386:     limit and opts.update(:max_nesting => limit)
387:     result = generate(obj, opts)
388:     if anIO
389:       anIO.write result
390:       anIO
391:     else
392:       result
393:     end
394:   rescue JSON::NestingError
395:     raise ArgumentError, "exceed depth limit"
396:   end
fast_generate(obj, opts = nil) click to toggle source

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.

     # File lib/json/common.rb, line 238
238:   def fast_generate(obj, opts = nil)
239:     if State === opts
240:       state, opts = opts, nil
241:     else
242:       state = FAST_STATE_PROTOTYPE.dup
243:     end
244:     if opts
245:       if opts.respond_to? :to_hash
246:         opts = opts.to_hash
247:       elsif opts.respond_to? :to_h
248:         opts = opts.to_h
249:       else
250:         raise TypeError, "can't convert #{opts.class} into Hash"
251:       end
252:       state.configure(opts)
253:     end
254:     state.generate(obj)
255:   end
generate(obj, opts = nil) click to toggle source

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 pretty output.

     # File lib/json/common.rb, line 207
207:   def generate(obj, opts = nil)
208:     if State === opts
209:       state, opts = opts, nil
210:     else
211:       state = SAFE_STATE_PROTOTYPE.dup
212:     end
213:     if opts
214:       if opts.respond_to? :to_hash
215:         opts = opts.to_hash
216:       elsif opts.respond_to? :to_h
217:         opts = opts.to_h
218:       else
219:         raise TypeError, "can't convert #{opts.class} into Hash"
220:       end
221:       state = state.configure(opts)
222:     end
223:     state.generate(obj)
224:   end
load(source, proc = nil) click to toggle source

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. The default options for the parser can be changed via the load_default_options method.

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

     # File lib/json/common.rb, line 315
315:   def load(source, proc = nil)
316:     opts = load_default_options
317:     if source.respond_to? :to_str
318:       source = source.to_str
319:     elsif source.respond_to? :to_io
320:       source = source.to_io.read
321:     elsif source.respond_to?(:read)
322:       source = source.read
323:     end
324:     if opts[:quirks_mode] && (source.nil? || source.empty?)
325:       source = 'null'
326:     end
327:     result = parse(source, opts)
328:     recurse_proc(result, &proc) if proc
329:     result
330:   end
Also aliased as: restore
parse(source, opts = {}) click to toggle source

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. Strings are the default.

  • create_additions: If set to false, the Parser doesn’t create additions even if a matching class and create_id was found. This option defaults to true.

  • object_class: Defaults to Hash

  • array_class: Defaults to Array

     # File lib/json/common.rb, line 154
154:   def parse(source, opts = {})
155:     Parser.new(source, opts).parse
156:   end
parse!(source, opts = {}) click to toggle source

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 matching class and create_id was found. This option defaults to true.

     # File lib/json/common.rb, line 173
173:   def parse!(source, opts = {})
174:     opts = {
175:       :max_nesting  => false,
176:       :allow_nan    => true
177:     }.update(opts)
178:     Parser.new(source, opts).parse
179:   end
pretty_generate(obj, opts = nil) click to toggle source

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.

     # File lib/json/common.rb, line 269
269:   def pretty_generate(obj, opts = nil)
270:     if State === opts
271:       state, opts = opts, nil
272:     else
273:       state = PRETTY_STATE_PROTOTYPE.dup
274:     end
275:     if opts
276:       if opts.respond_to? :to_hash
277:         opts = opts.to_hash
278:       elsif opts.respond_to? :to_h
279:         opts = opts.to_h
280:       else
281:         raise TypeError, "can't convert #{opts.class} into Hash"
282:       end
283:       state.configure(opts)
284:     end
285:     state.generate(obj)
286:   end
recurse_proc(result, &proc) click to toggle source

Recursively calls passed Proc if the parsed data structure is an Array or Hash

     # File lib/json/common.rb, line 333
333:   def recurse_proc(result, &proc)
334:     case result
335:     when Array
336:       result.each { |x| recurse_proc x, &proc }
337:       proc.call result
338:     when Hash
339:       result.each { |x, y| recurse_proc x, &proc; recurse_proc y, &proc }
340:       proc.call result
341:     else
342:       proc.call result
343:     end
344:   end

Private Instance Methods

restore(source, proc = nil) click to toggle source
Alias for: load

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.