Namespace
Methods
#
C
D
F
G
I
L
P
R
Constants
NaN = 0.0/0
 
Infinity = 1.0/0
 
MinusInfinity = -Infinity
 
UnparserError = GeneratorError
 

For backwards compatibility

JSON_LOADED = true unless defined?(::JSON::JSON_LOADED)
 
VERSION = '1.5.5'
 

JSON version

VERSION_ARRAY = VERSION.split(/\./).map { |x| x.to_i }
 
VERSION_MAJOR = VERSION_ARRAY[0]
 
VERSION_MINOR = VERSION_ARRAY[1]
 
VERSION_BUILD = VERSION_ARRAY[2]
 
Attributes
[RW] create_id

This is create identifier, which is used to decide if the json_createhook of a class should be called. It defaults to 'json_class'.

[R] generator

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

[R] parser

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

[RW] state

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

Class Public methods
[](object, opts = {})

If objectis 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 optsargument is passed through to generate/parse respectively. See generate and parse for their documentation.

# File ext/json/lib/json/common.rb, line 11
def [](object, opts = {})
  if object.respond_to? :to_str
    JSON.parse(object.to_str, opts)
  else
    JSON.generate(object, opts)
  end
end
const_defined_in?(modul, constant)
# File ext/json/lib/json/common.rb, line 387
def self.const_defined_in?(modul, constant)
  modul.const_defined?(constant)
end
iconv(to, from, string)

Encodes string using Ruby's String#encode

# File ext/json/lib/json/common.rb, line 375
def self.iconv(to, from, string)
  string.encode(to, from)
end
restore(source, proc = nil, options = {})
Instance Public methods
dump(obj, anIO = nil, limit = nil)

Dumps objas 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 ext/json/lib/json/common.rb, line 343
def dump(obj, anIO = nil, limit = nil)
  if anIO and limit.nil?
    anIO = anIO.to_io if anIO.respond_to?(:to_io)
    unless anIO.respond_to?(:write)
      limit = anIO
      anIO = nil
    end
  end
  limit ||= 0
  result = generate(obj, :allow_nan => true, :max_nesting => limit)
  if anIO
    anIO.write result
    anIO
  else
    result
  end
rescue JSON::NestingError
  raise ArgumentError, "exceed depth limit"
end
fast_generate(obj, opts = nil)

Generate a JSON document from the Ruby data structure objand 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 objargument because this will cause JSON to go into an infinite loop.

# File ext/json/lib/json/common.rb, line 231
def fast_generate(obj, opts = nil)
  if State === opts
    state, opts = opts, nil
  else
    state = FAST_STATE_PROTOTYPE.dup
  end
  if opts
    if opts.respond_to? :to_hash
      opts = opts.to_hash
    elsif opts.respond_to? :to_h
      opts = opts.to_h
    else
      raise TypeError, "can't convert #{opts.class} into Hash"
    end
    state.configure(opts)
  end
  state.generate(obj)
end
generate(obj, opts = nil)

Generate a JSON document from the Ruby data structure objand return it. stateis * 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 statehash 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 ext/json/lib/json/common.rb, line 200
def generate(obj, opts = nil)
  if State === opts
    state, opts = opts, nil
  else
    state = SAFE_STATE_PROTOTYPE.dup
  end
  if opts
    if opts.respond_to? :to_hash
      opts = opts.to_hash
    elsif opts.respond_to? :to_h
      opts = opts.to_h
    else
      raise TypeError, "can't convert #{opts.class} into Hash"
    end
    state = state.configure(opts)
  end
  state.generate(obj)
end
load(source, proc = nil, options = {})

Load a ruby data structure from a JSON sourceand return it. A source can either be a string-like object, an IO-like object, or an object responding to the read method. If procwas given, it will be called with any nested Ruby object as an argument recursively in depth first order. To modify the default options pass in the optional optionsargument as well.

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

Also aliased as: restore
# File ext/json/lib/json/common.rb, line 295
def load(source, proc = nil, options = {})
  load_default_options = {
    :max_nesting      => false,
    :allow_nan        => true,
    :create_additions => false
  }
  opts = load_default_options.merge options
  if source.respond_to? :to_str
    source = source.to_str
  elsif source.respond_to? :to_io
    source = source.to_io.read
  else
    source = source.read
  end
  result = parse(source, opts)
  recurse_proc(result, &proc) if proc
  result
end
parse(source, opts = {})

Parse the JSON document sourceinto a Ruby data structure and return it.

optscan 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 false.

  • object_class: Defaults to Hash

  • array_class: Defaults to Array

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

Parse the JSON document sourceinto a Ruby data structure and return it. The bang version of the parse method defaults to the more dangerous values for the optshash, so be sure only to parse trusted sourcedocuments.

optscan 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 false.

# File ext/json/lib/json/common.rb, line 166
def parse!(source, opts = {})
  opts = {
    :max_nesting  => false,
    :allow_nan    => true
  }.update(opts)
  Parser.new(source, opts).parse
end
pretty_generate(obj, opts = nil)

Generate a JSON document from the Ruby data structure objand return it. The returned document is a prettier form of the document returned by unparse.

The optsargument can be used to configure the generator. See the generate method for a more detailed explanation.

# File ext/json/lib/json/common.rb, line 262
def pretty_generate(obj, opts = nil)
  if State === opts
    state, opts = opts, nil
  else
    state = PRETTY_STATE_PROTOTYPE.dup
  end
  if opts
    if opts.respond_to? :to_hash
      opts = opts.to_hash
    elsif opts.respond_to? :to_h
      opts = opts.to_h
    else
      raise TypeError, "can't convert #{opts.class} into Hash"
    end
    state.configure(opts)
  end
  state.generate(obj)
end
recurse_proc(result, &proc)

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

# File ext/json/lib/json/common.rb, line 315
def recurse_proc(result, &proc)
  case result
  when Array
    result.each { |x| recurse_proc x, &proc }
    proc.call result
  when Hash
    result.each { |x, y| recurse_proc x, &proc; recurse_proc y, &proc }
    proc.call result
  else
    proc.call result
  end
end