Module: JSON

Defined in:
lib/framework/autocomplete/JSON.rb,
lib/extensions/json/json.rb,
lib/extensions/json/json/pure.rb,
lib/extensions/json/json/common.rb,
lib/extensions/json/json/version.rb,
lib/extensions/json/json/pure/generator.rb

Overview

It is auto-generated content. Do not do required for this file in your application.

Defined Under Namespace

Modules: Pure Classes: CircularDatastructure, GeneratorError, JSONError, MissingUnicodeSupport, NestingError, ParserError, State, UnparserError

Constant Summary collapse

JSON_LOADED = 
true
NaN = 
1
Infinity = 
Infinity
MinusInfinity = 
-Infinity
VERSION =

JSON version

'1.1.4'
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]
VARIANT_BINARY = 
false
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

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



74
75
76
 
# File 'lib/extensions/json/json/common.rb', line 74

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.



66
67
68
 
# File 'lib/extensions/json/json/common.rb', line 66

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.



21
22
23
 
# File 'lib/extensions/json/json/common.rb', line 21

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.



70
71
72
 
# File 'lib/extensions/json/json/common.rb', line 70

def state
  @state
end

Class Method Details

.[](object, opts) ⇒ 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.



11
12
13
14
15
16
17
 
# File 'lib/extensions/json/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

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



34
35
36
37
38
39
40
41
42
 
# File 'lib/extensions/json/json/common.rb', line 34

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

.fast_unparse(obj) ⇒ Object

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. :stopdoc: I want to deprecate these later, so I’ll first be silent about them, and later delete them.



209
210
211
 
# File 'lib/extensions/json/json/common.rb', line 209

def fast_generate(obj)
  obj.to_json(nil)
end

.generate(obj, state) ⇒ Object

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



180
181
182
183
184
185
186
187
 
# File 'lib/extensions/json/json/common.rb', line 180

def generate(obj, state = nil)
  if state
    state = State.from_state(state)
  else
    state = State.new
  end
  obj.to_json(state)
end

.pretty_unparse(obj, opts) ⇒ Object

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. :stopdoc: I want to deprecate these later, so I’ll first be silent about them, and later delete them.



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/extensions/json/json/common.rb', line 241

def pretty_generate(obj, opts = nil)
  state = JSON.state.new(
    :indent     => '  ',
    :space      => ' ',
    :object_nl  => "\n",
    :array_nl   => "\n",
    :check_circular => false #true
  )
  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
  obj.to_json(state)
end

.recurse_proc(result, proc) ⇒ Object 



265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/extensions/json/json/common.rb', line 265

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

.restore(source, proc) ⇒ Object

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.



280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/extensions/json/json/common.rb', line 280

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

.swap!(string) ⇒ Object

Swap consecutive bytes of string in place.



60
61
62
63
64
65
66
 
# File 'lib/extensions/json/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

Convert a UTF8 encoded Ruby string string to a JSON string, encoded with UTF16 big endian characters as u????, and return it.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/extensions/json/json/pure/generator.rb', line 42

def utf8_to_json(string) # :nodoc:
  string = string.dup.force_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}'"
    c.unpack("U*").map{|c|
      c>0xFFFF ? ('\ud%03x\ud%03x'%[0x7C0+c/1024,0xC00+c%1024]) : ('\u%04x'%c)
    }.join("")
  }
  string
end

Instance Method Details

#dump(obj, anIO, limit) ⇒ 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.



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/extensions/json/json/common.rb', line 295

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) ⇒ Object

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.



203
204
205
 
# File 'lib/extensions/json/json/common.rb', line 203

def fast_generate(obj)
  obj.to_json(nil)
end

#load(source, proc) ⇒ Object

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.



252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/extensions/json/json/common.rb', line 252

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

#pretty_generate(obj, opts) ⇒ Object

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.



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/extensions/json/json/common.rb', line 218

def pretty_generate(obj, opts = nil)
  state = JSON.state.new(
    :indent     => '  ',
    :space      => ' ',
    :object_nl  => "\n",
    :array_nl   => "\n",
    :check_circular => false #true
  )
  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
  obj.to_json(state)
end