Module JSON
In: lib/json.rb
lib/json/ext.rb
lib/json/common.rb
lib/json/version.rb
lib/json/pure/generator.rb
lib/json/pure/parser.rb
lib/json/pure.rb
lib/json/editor.rb
JSONError GeneratorError ParserError MissingUnicodeSupport CircularDatastructure NestingError StandardError Gtk StringScanner Parser State lib/json/common.rb Ext Editor lib/json/pure/parser.rb lib/json/pure/generator.rb Object Integer FalseClass Array Hash Float NilClass TrueClass Extend String GeneratorMethods Generator Pure JSON dot/m_9_3.png

Methods

[]   dump   fast_generate   generate   load   parse   parse!   pretty_generate   recurse_proc   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

JSON_LOADED = true
NaN = (-1.0) ** 0.5
Infinity = 1.0/0
MinusInfinity = -Infinity
UnparserError = GeneratorError   For backwards compatibility
VERSION = '1.1.6'   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

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]

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

Public Instance methods

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]

     # File lib/json/common.rb, line 291
291:   def dump(obj, anIO = nil, limit = nil)
292:     if anIO and limit.nil?
293:       anIO = anIO.to_io if anIO.respond_to?(:to_io)
294:       unless anIO.respond_to?(:write)
295:         limit = anIO
296:         anIO = nil
297:       end
298:     end
299:     limit ||= 0
300:     result = generate(obj, :allow_nan => true, :max_nesting => limit)
301:     if anIO
302:       anIO.write result
303:       anIO
304:     else
305:       result
306:     end
307:   rescue JSON::NestingError
308:     raise ArgumentError, "exceed depth limit"
309:   end

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.

[Source]

     # File lib/json/common.rb, line 199
199:   def fast_generate(obj)
200:     obj.to_json(nil)
201:   end

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.

[Source]

     # File lib/json/common.rb, line 177
177:   def generate(obj, state = nil)
178:     if state
179:       state = State.from_state(state)
180:     else
181:       state = State.new
182:     end
183:     obj.to_json(state)
184:   end

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.

[Source]

     # File lib/json/common.rb, line 248
248:   def load(source, proc = nil)
249:     if source.respond_to? :to_str
250:       source = source.to_str
251:     elsif source.respond_to? :to_io
252:       source = source.to_io.read
253:     else
254:       source = source.read
255:     end
256:     result = parse(source, :max_nesting => false, :allow_nan => true)
257:     recurse_proc(result, &proc) if proc
258:     result
259:   end

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.

[Source]

     # File lib/json/common.rb, line 121
121:   def parse(source, opts = {})
122:     JSON.parser.new(source, opts).parse
123:   end

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.

[Source]

     # File lib/json/common.rb, line 140
140:   def parse!(source, opts = {})
141:     opts = {
142:       :max_nesting => false,
143:       :allow_nan => true
144:     }.update(opts)
145:     JSON.parser.new(source, opts).parse
146:   end

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.

[Source]

     # File lib/json/common.rb, line 214
214:   def pretty_generate(obj, opts = nil)
215:     state = JSON.state.new(
216:       :indent     => '  ',
217:       :space      => ' ',
218:       :object_nl  => "\n",
219:       :array_nl   => "\n",
220:       :check_circular => true
221:     )
222:     if opts
223:       if opts.respond_to? :to_hash
224:         opts = opts.to_hash
225:       elsif opts.respond_to? :to_h
226:         opts = opts.to_h
227:       else
228:         raise TypeError, "can't convert #{opts.class} into Hash"
229:       end
230:       state.configure(opts)
231:     end
232:     obj.to_json(state)
233:   end
restore(source, proc = nil)

Alias for load

Private Instance methods

[Source]

     # File lib/json/common.rb, line 261
261:   def recurse_proc(result, &proc)
262:     case result
263:     when Array
264:       result.each { |x| recurse_proc x, &proc }
265:       proc.call result
266:     when Hash
267:       result.each { |x, y| recurse_proc x, &proc; recurse_proc y, &proc }
268:       proc.call result
269:     else
270:       proc.call result
271:     end
272:   end

[Validate]