Bug #4700 ยป 0002-Adds-some-basic-documentation-to-JSON-module.patch
| ext/json/generator/generator.c | ||
|---|---|---|
|
/*
|
||
|
* call-seq: to_json(*)
|
||
|
*
|
||
|
* Returns a JSON string for nil: 'null'.
|
||
|
*/
|
||
|
static VALUE mNilClass_to_json(int argc, VALUE *argv, VALUE self)
|
||
|
{
|
||
| ext/json/lib/json.rb | ||
|---|---|---|
|
##
|
||
|
# = JavaScript Object Notation (JSON)
|
||
|
#
|
||
|
# JSON is a lightweight data-interchange format. It is easy for us
|
||
|
# humans to read and write. Plus, equally simple for machines to generate or parse.
|
||
|
# JSON is completely language agnostic, making it the ideal interchange format.
|
||
|
#
|
||
|
# Built on two universally available structures:
|
||
|
# 1. A collection of name/value pairs. Often referred to as an _object_, hash table, record, struct, keyed list, or associative array.
|
||
|
# 2. An orderd list of values. More commonly named as an _array_, vector, sequence, or list.
|
||
|
#
|
||
|
# To read more about JSON visit: http://json.org
|
||
|
#
|
||
|
# == Parsing JSON
|
||
|
#
|
||
|
# To parse a JSON string received by another application, or generated within
|
||
|
# your existing application:
|
||
|
#
|
||
|
# require 'json'
|
||
|
#
|
||
|
# my_hash = JSON.parse('{"hello": "goodbye"}')
|
||
|
# puts my_hash["hello"] => "goodbye"
|
||
|
#
|
||
|
# Notice the extra quotes <tt>''</tt> around the hash notation. Ruby expects
|
||
|
# the argument to be a string and can't convert objects like a hash or array.
|
||
|
#
|
||
|
# Ruby converts your string into a hash
|
||
|
#
|
||
|
# == Generating JSON
|
||
|
#
|
||
|
# Creating a JSON string for communication or serialization is
|
||
|
# just as simple.
|
||
|
#
|
||
|
# require 'json'
|
||
|
#
|
||
|
# my_hash = {:hello => "goodbye"}
|
||
|
# puts JSON.generate(my_hash) => "{\"hello\":\"goodbye\"}"
|
||
|
#
|
||
|
# Or an alternative way:
|
||
|
#
|
||
|
# require 'json'
|
||
|
# puts {:hello => "goodbye"}.to_json => "{\"hello\":\"goodbye\"}"
|
||
|
#
|
||
|
# <tt>JSON.generate</tt> only allows objects or arrays to be converted
|
||
|
# to JSON syntax. While <tt>to_json</tt> accepts many Ruby classes
|
||
|
# even though it only acts a method for serialization:
|
||
|
#
|
||
|
# require 'json'
|
||
|
#
|
||
|
# 1.to_json => "1"
|
||
|
#
|
||
|
require 'json/common'
|
||
|
module JSON
|
||
|
require 'json/version'
|
||
| ext/json/lib/json/add/core.rb | ||
|---|---|---|
|
end
|
||
|
require 'date'
|
||
|
# Symbol serialization/deserialization
|
||
|
class Symbol
|
||
|
# Stores class name (Symbol) with String representation of Symbol as a JSON string.
|
||
|
def to_json(*a)
|
||
|
{
|
||
|
JSON.create_id => self.class.name,
|
||
|
's' => to_s,
|
||
|
}.to_json(*a)
|
||
|
end
|
||
|
|
||
|
# Deserializes JSON string by converting the <tt>string</tt> value stored in the object to a Symbol
|
||
|
def self.json_create(o)
|
||
|
o['s'].to_sym
|
||
|
end
|
||
|
end
|
||
|
# Time serialization/deserialization
|
||
|
class Time
|
||
|
# Deserializes JSON string by converting time since epoch to Time
|
||
|
def self.json_create(object)
|
||
|
if usec = object.delete('u') # used to be tv_usec -> tv_nsec
|
||
|
object['n'] = usec * 1000
|
||
| ... | ... | |
|
at(object['s'], object['n'] / 1000)
|
||
|
end
|
||
|
end
|
||
|
|
||
|
# Stores class name (Time) with number of seconds since epoch and number of microseconds for Time as JSON string
|
||
|
def to_json(*args)
|
||
|
{
|
||
|
JSON.create_id => self.class.name,
|
||
| ... | ... | |
|
end
|
||
|
end
|
||
|
# Date serialization/deserialization
|
||
|
class Date
|
||
|
|
||
|
# Deserializes JSON string by converting Julian year <tt>y</tt>, month <tt>m</tt>, day <tt>d</tt> and Day of Calendar Reform <tt>sg</tt> to Date.
|
||
|
def self.json_create(object)
|
||
|
civil(*object.values_at('y', 'm', 'd', 'sg'))
|
||
|
end
|
||
|
alias start sg unless method_defined?(:start)
|
||
|
|
||
|
# Stores class name (Date) with Julian year <tt>y</tt>, month <tt>m</tt>, day <tt>d</tt> and Day of Calendar Reform <tt>sg</tt> as JSON string
|
||
|
def to_json(*args)
|
||
|
{
|
||
|
JSON.create_id => self.class.name,
|
||
| ... | ... | |
|
end
|
||
|
end
|
||
|
# DateTime serialization/deserialization
|
||
|
class DateTime
|
||
|
# Deserializes JSON string by converting year <tt>y</tt>, month <tt>m</tt>, day <tt>d</tt>, hour <tt>H</tt>, minute <tt>M</tt>, second <tt>S</tt>, offset <tt>of</tt> and Day of Calendar Reform <tt>sg</tt> to DateTime.
|
||
|
def self.json_create(object)
|
||
|
args = object.values_at('y', 'm', 'd', 'H', 'M', 'S')
|
||
|
of_a, of_b = object['of'].split('/')
|
||
| ... | ... | |
|
end
|
||
|
alias start sg unless method_defined?(:start)
|
||
|
|
||
|
# Stores class name (DateTime) with Julian year <tt>y</tt>, month <tt>m</tt>, day <tt>d</tt>, hour <tt>H</tt>, minute <tt>M</tt>, second <tt>S</tt>, offset <tt>of</tt> and Day of Calendar Reform <tt>sg</tt> as JSON string
|
||
|
def to_json(*args)
|
||
|
{
|
||
|
JSON.create_id => self.class.name,
|
||
| ... | ... | |
|
end
|
||
|
end
|
||
|
# Range serialization/deserialization
|
||
|
class Range
|
||
|
|
||
|
# Deserializes JSON string by constructing new Range object with arguments <tt>a</tt> serialized by <tt>to_json</tt>.
|
||
|
def self.json_create(object)
|
||
|
new(*object['a'])
|
||
|
end
|
||
|
# Stores class name (Range) with JSON array of arguments <tt>a</tt> which include <tt>first</tt> (integer), <tt>last</tt> (integer), and <tt>exclude_end?</tt> (boolean) as JSON string.
|
||
|
def to_json(*args)
|
||
|
{
|
||
|
JSON.create_id => self.class.name,
|
||
| ... | ... | |
|
end
|
||
|
end
|
||
|
# Struct serialization/deserialization
|
||
|
class Struct
|
||
|
|
||
|
# Deserializes JSON string by constructing new Struct object with values <tt>v</tt> serialized by <tt>to_json</tt>.
|
||
|
def self.json_create(object)
|
||
|
new(*object['v'])
|
||
|
end
|
||
|
# Stores class name (Struct) with Struct values <tt>v</tt> as a JSON string. Only named structs are supported.
|
||
|
def to_json(*args)
|
||
|
klass = self.class.name
|
||
|
klass.to_s.empty? and raise JSON::JSONError, "Only named structs are supported!"
|
||
| ... | ... | |
|
end
|
||
|
end
|
||
|
# Exception serialization/deserialization
|
||
|
class Exception
|
||
|
# Deserializes JSON string by constructing new Exception object with message <tt>m</tt> and backtrace <tt>b</tt> serialized with <tt>to_json</tt>
|
||
|
def self.json_create(object)
|
||
|
result = new(object['m'])
|
||
|
result.set_backtrace object['b']
|
||
|
result
|
||
|
end
|
||
|
# Stores class name (Exception) with message <tt>m</tt> and backtrace array <tt>b</tt> as JSON string
|
||
|
def to_json(*args)
|
||
|
{
|
||
|
JSON.create_id => self.class.name,
|
||
| ... | ... | |
|
end
|
||
|
end
|
||
|
# Regexp serialization/deserialization
|
||
|
class Regexp
|
||
|
# Deserializes JSON string by constructing new Regexp object with source <tt>s</tt> (Regexp or String) and options <tt>o</tt> serialized by <tt>to_json</tt>
|
||
|
def self.json_create(object)
|
||
|
new(object['s'], object['o'])
|
||
|
end
|
||
|
# Stores class name (Regexp) with options <tt>o</tt> and source <tt>s</tt> (Regexp or String) as JSON string
|
||
|
def to_json(*)
|
||
|
{
|
||
|
JSON.create_id => self.class.name,
|
||
| ext/json/lib/json/common.rb | ||
|---|---|---|
|
recurse_proc(result, &proc) if proc
|
||
|
result
|
||
|
end
|
||
|
|
||
|
# Recursively calls passed _Proc_ if the parsed data structure is an _Array_ or _Hash_
|
||
|
def recurse_proc(result, &proc)
|
||
|
case result
|
||
|
when Array
|
||
| ... | ... | |
|
# Shortuct for iconv.
|
||
|
if String.method_defined?(:encode)
|
||
|
# Encodes string using Ruby's _String.encode_
|
||
|
def self.iconv(to, from, string)
|
||
|
string.encode(to, from)
|
||
|
end
|
||
|
else
|
||
|
require 'iconv'
|
||
|
# Encodes string using _iconv_ library
|
||
|
def self.iconv(to, from, string)
|
||
|
Iconv.conv(to, from, string)
|
||
|
end
|
||
| ... | ... | |
|
end
|
||
|
end
|
||
|
# Extends any Class to include _json_creatable?_ method.
|
||
|
class ::Class
|
||
|
# Returns true, if this class can be used to create an instance
|
||
|
# from a serialised JSON string. The class has to implement a class
|
||