Module: Fiveruns::JSON

Defined in:
lib/fiveruns/json/pure.rb,
lib/fiveruns/json/common.rb,
lib/fiveruns/json/parser.rb,
lib/fiveruns/json/version.rb,
lib/fiveruns/json/generator.rb

Defined Under Namespace

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

Constant Summary collapse

NaN = 
(-1.0) ** 0.5
Infinity = 
1.0/0
MinusInfinity = 
-Infinity
UnparserError =

For backwards compatibility

GeneratorError
VERSION = 
'1.1.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]
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

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



71
72
73
 
# File 'lib/fiveruns/json/common.rb', line 71

def create_id
  @create_id
end

.generator ⇒ Object

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



63
64
65
 
# File 'lib/fiveruns/json/common.rb', line 63

def generator
  @generator
end

.parser ⇒ Object

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



19
20
21
 
# File 'lib/fiveruns/json/common.rb', line 19

def parser
  @parser
end

.state ⇒ Object

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



67
68
69
 
# File 'lib/fiveruns/json/common.rb', line 67

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



9
10
11
12
13
14
15
 
# File 'lib/fiveruns/json/common.rb', line 9

def [](object, opts = {})
  if object.respond_to? :to_str
    ::Fiveruns::JSON.parse(object.to_str, opts => {})
  else
    ::Fiveruns::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.



32
33
34
35
36
37
38
39
40
41
 
# File 'lib/fiveruns/json/common.rb', line 32

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

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

Dumps obj as a FiverunsJSON 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 FiverunsJSON 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.



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/fiveruns/json/common.rb', line 289

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 ::Fiveruns::JSON::NestingError
  raise ArgumentError, "exceed depth limit"
end

.fast_generate(obj) ⇒ Object Also known as: fast_unparse

Unparse the Ruby data structure obj into a single line FiverunsJSON 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 FiverunsJSON to go into an infinite loop.



197
198
199
 
# File 'lib/fiveruns/json/common.rb', line 197

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

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

Unparse the Ruby data structure obj into a single line FiverunsJSON string and return it. state is

  • a FiverunsJSON::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 FiverunsJSON 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 FiverunsJSON object (default: ”),

  • array_nl: a string that is put at the end of a FiverunsJSON 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 FiverunsJSON 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.



175
176
177
178
179
180
181
182
 
# File 'lib/fiveruns/json/common.rb', line 175

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

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

Load a ruby data structure from a FiverunsJSON 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.



246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/fiveruns/json/common.rb', line 246

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



119
120
121
 
# File 'lib/fiveruns/json/common.rb', line 119

def parse(source, opts = {})
  ::Fiveruns::JSON.parser.new(source, opts).parse
end

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

Parse the FiverunsJSON 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.



138
139
140
141
142
143
144
 
# File 'lib/fiveruns/json/common.rb', line 138

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

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

Unparse the Ruby data structure obj into a FiverunsJSON 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.



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/fiveruns/json/common.rb', line 212

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

.recurse_proc(result, &proc) ⇒ Object 



259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/fiveruns/json/common.rb', line 259

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.



57
58
59
60
61
62
63
 
# File 'lib/fiveruns/json/pure.rb', line 57

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 FiverunsJSON 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/fiveruns/json/generator.rb', line 42

def utf8_to_json(string) # :nodoc:
  string = 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 = ::Fiveruns::JSON::UTF8toUTF16.iconv(c).unpack('H*')[0]
    s.gsub!(/.{4}/n, '\\\\u\&')
  }
  string
rescue Iconv::Failure => e
  raise GeneratorError, "Caught #{e.class}: #{e}"
end