Files

JSON

Constants

JSON_LOADED
JSON_LOADED
NaN
Infinity
MinusInfinity
UnparserError

For backwards compatibility

VERSION

JSON version

Attributes

parser[R]

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

generator[R]

Returns the JSON generator modul, that is used by JSON. This might be either JSON::Ext::Generator or JSON::Pure::Generator.

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.

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’.

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
iconv(to, from, string) click to toggle source

Shortuct for iconv.

     # File lib/json/common.rb, line 342
342:   def self.iconv(to, from, string)
343:     Iconv.iconv(to, from, string).first
344:   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.

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

     # File lib/json/common.rb, line 321
321:   def dump(obj, anIO = nil, limit = nil)
322:     if anIO and limit.nil?
323:       anIO = anIO.to_io if anIO.respond_to?(:to_io)
324:       unless anIO.respond_to?(:write)
325:         limit = anIO
326:         anIO = nil
327:       end
328:     end
329:     limit ||= 0
330:     result = generate(obj, :allow_nan => true, :max_nesting => limit)
331:     if anIO
332:       anIO.write result
333:       anIO
334:     else
335:       result
336:     end
337:   rescue JSON::NestingError
338:     raise ArgumentError, "exceed depth limit"
339:   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 225
225:   def fast_generate(obj, opts = nil)
226:     state = FAST_STATE_PROTOTYPE.dup
227:     if opts
228:       if opts.respond_to? :to_hash
229:         opts = opts.to_hash
230:       elsif opts.respond_to? :to_h
231:         opts = opts.to_h
232:       else
233:         raise TypeError, "can't convert #{opts.class} into Hash"
234:       end
235:       state.configure(opts)
236:     end
237:     state.generate(obj)
238:   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 a pretty output.

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

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

     # File lib/json/common.rb, line 280
280:   def load(source, proc = nil)
281:     if source.respond_to? :to_str
282:       source = source.to_str
283:     elsif source.respond_to? :to_io
284:       source = source.to_io.read
285:     else
286:       source = source.read
287:     end
288:     result = parse(source, :max_nesting => false, :allow_nan => true)
289:     recurse_proc(result, &proc) if proc
290:     result
291:   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, 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

     # File lib/json/common.rb, line 145
145:   def parse(source, opts = {})
146:     Parser.new(source, opts).parse
147:   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 matchin class and create_id was found. This option defaults to true.

     # 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) 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 252
252:   def pretty_generate(obj, opts = nil)
253:     state = PRETTY_STATE_PROTOTYPE.dup
254:     if opts
255:       if opts.respond_to? :to_hash
256:         opts = opts.to_hash
257:       elsif opts.respond_to? :to_h
258:         opts = opts.to_h
259:       else
260:         raise TypeError, "can't convert #{opts.class} into Hash"
261:       end
262:       state.configure(opts)
263:     end
264:     state.generate(obj)
265:   end
recurse_proc(result, &proc) click to toggle source
     # File lib/json/common.rb, line 293
293:   def recurse_proc(result, &proc)
294:     case result
295:     when Array
296:       result.each { |x| recurse_proc x, &proc }
297:       proc.call result
298:     when Hash
299:       result.each { |x, y| recurse_proc x, &proc; recurse_proc y, &proc }
300:       proc.call result
301:     else
302:       proc.call result
303:     end
304:   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.