Module: JSON

Included in:
Generator2BenchmarkCommon, GeneratorBenchmarkCommon, Parser2BenchmarkCommon, ParserBenchmarkCommon, TC_JSON, TC_JSONAddition, TC_JSONEncoding, TC_JSONGenerate, TC_JSONRails, TC_JSONUnicode
Defined in:
lib/vendor/json_pure/lib/json.rb,
lib/vendor/json_pure/lib/json/ext.rb,
lib/vendor/json_pure/lib/json/pure.rb,
lib/vendor/json_pure/lib/json/common.rb,
lib/vendor/json_pure/lib/json/editor.rb,
lib/vendor/json_pure/lib/json/version.rb,
lib/vendor/json_pure/lib/json/pure/parser.rb,
lib/vendor/json_pure/lib/json/pure/generator.rb,
lib/vendor/json_pure/benchmarks/generator_benchmark.rb,
lib/vendor/json_pure/benchmarks/generator2_benchmark.rb

Defined Under Namespace

Modules: Editor, Ext, Pure Classes: CircularDatastructure, GeneratorError, JSONError, MissingUnicodeSupport, NestingError, ParserError

Constant Summary collapse

JSON_LOADED = 
true
NaN = 
0.0/0
Infinity = 
1.0/0
MinusInfinity = 
-Infinity
UnparserError =

For backwards compatibility

GeneratorError
VERSION =

JSON version

'1.4.3'
VERSION_ARRAY =

:nodoc:

VERSION.split(/\./).map { |x| x.to_i }
VERSION_MAJOR =

:nodoc:

VERSION_ARRAY[0]
VERSION_MINOR =

:nodoc:

VERSION_ARRAY[1]
VERSION_BUILD =

:nodoc:

VERSION_ARRAY[2]
MAP = 
{
  "\x0" => '\u0000',
  "\x1" => '\u0001',
  "\x2" => '\u0002',
  "\x3" => '\u0003',
  "\x4" => '\u0004',
  "\x5" => '\u0005',
  "\x6" => '\u0006',
  "\x7" => '\u0007',
  "\b"  =>  '\b',
  "\t"  =>  '\t',
  "\n"  =>  '\n',
  "\xb" => '\u000b',
  "\f"  =>  '\f',
  "\r"  =>  '\r',
  "\xe" => '\u000e',
  "\xf" => '\u000f',
  "\x10" => '\u0010',
  "\x11" => '\u0011',
  "\x12" => '\u0012',
  "\x13" => '\u0013',
  "\x14" => '\u0014',
  "\x15" => '\u0015',
  "\x16" => '\u0016',
  "\x17" => '\u0017',
  "\x18" => '\u0018',
  "\x19" => '\u0019',
  "\x1a" => '\u001a',
  "\x1b" => '\u001b',
  "\x1c" => '\u001c',
  "\x1d" => '\u001d',
  "\x1e" => '\u001e',
  "\x1f" => '\u001f',
  '"'   =>  '\"',
  '\\'  =>  '\\\\',
}

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.create_id ⇒ Object

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



92
93
94
 
# File 'lib/vendor/json_pure/lib/json/common.rb', line 92

def create_id
  @create_id
end

.generator ⇒ Object

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



84
85
86
 
# File 'lib/vendor/json_pure/lib/json/common.rb', line 84

def generator
  @generator
end

.parser ⇒ Object

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



22
23
24
 
# File 'lib/vendor/json_pure/lib/json/common.rb', line 22

def parser
  @parser
end

.state ⇒ Object

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



88
89
90
 
# File 'lib/vendor/json_pure/lib/json/common.rb', line 88

def state
  @state
end

Class Method Details

.[] ⇒ Object

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.



12
13
14
15
16
17
18
 
# File 'lib/vendor/json_pure/lib/json/common.rb', line 12

def [](object, opts = {})
  if object.respond_to? :to_str
    JSON.parse(object.to_str, opts => {})
  else
    JSON.generate(object, opts => {})
  end
end

.deep_const_get(path) ⇒ Object

Return the constant located at path. The format of path has to be either ::A::B::C or A::B::C. In any case A has to be located at the top level (absolute namespace path?). If there doesn’t exist a constant at the given path, an ArgumentError is raised.



35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/vendor/json_pure/lib/json/common.rb', line 35

def deep_const_get(path) # :nodoc:
  path.to_s.split(/::/).inject(Object) do |p, c|
    case
    when c.empty?             then p
    when p.const_defined?(c)  then p.const_get(c)
    else
      begin
        p.const_missing(c)
      rescue NameError
        raise ArgumentError, "can't find const #{path}"
      end
    end
  end
end

.dump(obj, anIO = nil, limit = nil) ⇒ Object

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.



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/vendor/json_pure/lib/json/common.rb', line 327

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) ⇒ Object Also known as: fast_unparse

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.



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/vendor/json_pure/lib/json/common.rb', line 227

def fast_generate(obj, opts = nil)
  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 = FAST_STATE_PROTOTYPE.dup
    state.configure(opts)
  else
    state = FAST_STATE_PROTOTYPE
  end
  state.generate(obj)
end

.generate(obj, opts = nil) ⇒ Object Also known as: unparse

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.



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/vendor/json_pure/lib/json/common.rb', line 198

def generate(obj, opts = nil)
  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 = SAFE_STATE_PROTOTYPE.dup
    state = state.configure(opts)
  else
    state = SAFE_STATE_PROTOTYPE
  end
  state.generate(obj)
end

.iconv(to, from, string) ⇒ Object

Shortuct for iconv.



348
349
350
 
# File 'lib/vendor/json_pure/lib/json/common.rb', line 348

def self.iconv(to, from, string)
  Iconv.iconv(to, from, string).first
end

.load(source, proc = nil) ⇒ Object Also known as: restore

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.



286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/vendor/json_pure/lib/json/common.rb', line 286

def load(source, proc = nil)
  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, :max_nesting => false, :allow_nan => true)
  recurse_proc(result, &proc) if proc
  result
end

.parse(source, opts = {}) ⇒ Object

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



145
146
147
 
# File 'lib/vendor/json_pure/lib/json/common.rb', line 145

def parse(source, opts = {})
  Parser.new(source, opts).parse
end

.parse!(source, opts = {}) ⇒ Object

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.



164
165
166
167
168
169
170
 
# File 'lib/vendor/json_pure/lib/json/common.rb', line 164

def parse!(source, opts = {})
  opts = {
    :max_nesting  => false,
    :allow_nan    => true
  }.update(opts)
  Parser.new(source, opts).parse
end

.pretty_generate(obj, opts = nil) ⇒ Object Also known as: pretty_unparse

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 #unparse.

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



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/vendor/json_pure/lib/json/common.rb', line 256

def pretty_generate(obj, opts = nil)
  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 = PRETTY_STATE_PROTOTYPE.dup
    state.configure(opts)
  else
    state = PRETTY_STATE_PROTOTYPE
  end
  state.generate(obj)
end

.recurse_proc(result, &proc) ⇒ Object 



299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/vendor/json_pure/lib/json/common.rb', line 299

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

.swap!(string) ⇒ Object

Swap consecutive bytes of string in place.



60
61
62
63
64
65
66
 
# File 'lib/vendor/json_pure/lib/json/pure.rb', line 60

def self.swap!(string) # :nodoc:
  0.upto(string.size / 2) do |i|
    break unless string[2 * i + 1]
    string[2 * i], string[2 * i + 1] = string[2 * i + 1], string[2 * i]
  end
  string
end

.utf8_to_json(string) ⇒ Object

:nodoc:



42
43
44
45
46
47
48
49
 
# File 'lib/vendor/json_pure/lib/json/pure/generator.rb', line 42

def utf8_to_json(string) # :nodoc:
  string = string.dup
  string << '' # XXX workaround: avoid buffer sharing
  string.force_encoding(::Encoding::ASCII_8BIT)
  string.gsub!(/["\\\x0-\x1f]/) { MAP[$&] }
  string.force_encoding(::Encoding::UTF_8)
  string
end

.utf8_to_json_ascii(string) ⇒ Object

:nodoc:



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/vendor/json_pure/lib/json/pure/generator.rb', line 51

def utf8_to_json_ascii(string) # :nodoc:
  string = string.dup
  string << '' # XXX workaround: avoid buffer sharing
  string.force_encoding(::Encoding::ASCII_8BIT)
  string.gsub!(/["\\\x0-\x1f]/) { MAP[$&] }
  string.gsub!(/(
                  (?:
                    [\xc2-\xdf][\x80-\xbf]    |
                    [\xe0-\xef][\x80-\xbf]{2} |
                    [\xf0-\xf4][\x80-\xbf]{3}
                  )+ |
                  [\x80-\xc1\xf5-\xff]       # invalid
                )/nx) { |c|
                  c.size == 1 and raise GeneratorError, "invalid utf8 byte: '#{c}'"
                  s = JSON::UTF8toUTF16.iconv(c).unpack('H*')[0]
                  s.gsub!(/.{4}/n, '\\\\u\&')
                }
  string.force_encoding(::Encoding::UTF_8)
  string
rescue Iconv::Failure => e
  raise GeneratorError, "Caught #{e.class}: #{e}"
end