json 1.1.0 → 1.1.1

data/ext/json/ext/parser/parser.rl

@@ -8,8 +8,12 @@
 #define EVIL 0x666
 
 static VALUE mJSON, mExt, cParser, eParserError, eNestingError;
+static VALUE CNaN, CInfinity, CMinusInfinity;
 
-static ID i_json_creatable_p, i_json_create, i_create_id, i_chr, i_max_nesting; 
+static ID i_json_creatable_p, i_json_create, i_create_id, i_chr, i_max_nesting,
+          i_allow_nan; 
+
+#define MinusInfinity "-Infinity"
 
 typedef struct JSON_ParserStruct {
     VALUE Vsource;
@@ -19,6 +23,7 @@ typedef struct JSON_ParserStruct {
     VALUE create_id;
     int max_nesting;
     int current_nesting;
+    int allow_nan;
 } JSON_Parser;
 
 static char *JSON_parse_object(JSON_Parser *json, char *p, char *pe, VALUE *result);
@@ -47,7 +52,10 @@ static char *JSON_parse_float(JSON_Parser *json, char *p, char *pe, VALUE *resul
     Vnull               = 'null';
     Vfalse              = 'false';
     Vtrue               = 'true';
-    begin_value         = [nft"\-[{] | digit;
+    VNaN                = 'NaN';
+    VInfinity           = 'Infinity';
+    VMinusInfinity      = '-Infinity';
+    begin_value         = [nft"\-[{NI] | digit;
     begin_object        = '{';
     end_object          = '}';
     begin_array         = '[';
@@ -133,6 +141,20 @@ static char *JSON_parse_object(JSON_Parser *json, char *p, char *pe, VALUE *resu
     action parse_true {
         *result = Qtrue;
     }
+    action parse_nan {
+        if (json->allow_nan) {
+            *result = CNaN;
+        } else {
+            rb_raise(eParserError, "unexpected token at '%s'", p - 2);
+        }
+    }
+    action parse_infinity {
+        if (json->allow_nan) {
+            *result = CInfinity;
+        } else {
+            rb_raise(eParserError, "unexpected token at '%s'", p - 8);
+        }
+    }
     action parse_string {
         char *np = JSON_parse_string(json, fpc, pe, result);
         if (np == NULL) fbreak; else fexec np;
@@ -140,6 +162,15 @@ static char *JSON_parse_object(JSON_Parser *json, char *p, char *pe, VALUE *resu
 
     action parse_number {
         char *np;
+        if(pe > fpc + 9 && !strncmp(MinusInfinity, fpc, 9)) {
+            if (json->allow_nan) {
+                *result = CMinusInfinity;
+                fexec p + 10;
+                fbreak;
+            } else {
+                rb_raise(eParserError, "unexpected token at '%s'", p);
+            }
+        }
         np = JSON_parse_float(json, fpc, pe, result);
         if (np != NULL) fexec np;
         np = JSON_parse_integer(json, fpc, pe, result);
@@ -169,6 +200,8 @@ main := (
               Vnull @parse_null |
               Vfalse @parse_false |
               Vtrue @parse_true |
+              VNaN @parse_nan |
+              VInfinity @parse_infinity |
               begin_number >parse_number |
               begin_string >parse_string |
               begin_array >parse_array |
@@ -435,7 +468,11 @@ static char *JSON_parse_string(JSON_Parser *json, char *p, char *pe, VALUE *resu
  *
  * _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.
+ *   structures. Disable depth checking with :max_nesting => false|nil|0, 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.
  */
 static VALUE cParser_initialize(int argc, VALUE *argv, VALUE self)
 {
@@ -451,14 +488,15 @@ static VALUE cParser_initialize(int argc, VALUE *argv, VALUE self)
         rb_raise(eParserError, "A JSON text must at least contain two octets!");
     }
     json->max_nesting = 19;
+    json->allow_nan = 0;
     if (!NIL_P(opts)) {
         opts = rb_convert_type(opts, T_HASH, "Hash", "to_hash");
         if (NIL_P(opts)) {
             rb_raise(rb_eArgError, "opts needs to be like a hash");
         } else {
-            VALUE s_max_nesting = ID2SYM(i_max_nesting);
-            if (st_lookup(RHASH(opts)->tbl, s_max_nesting, 0)) {
-                VALUE max_nesting = rb_hash_aref(opts, s_max_nesting);
+            VALUE tmp = ID2SYM(i_max_nesting);
+            if (st_lookup(RHASH(opts)->tbl, tmp, 0)) {
+                VALUE max_nesting = rb_hash_aref(opts, tmp);
                 if (RTEST(max_nesting)) {
                     Check_Type(max_nesting, T_FIXNUM);
                     json->max_nesting = FIX2INT(max_nesting);
@@ -466,6 +504,11 @@ static VALUE cParser_initialize(int argc, VALUE *argv, VALUE self)
                     json->max_nesting = 0;
                 }
             }
+            tmp = ID2SYM(i_allow_nan);
+            if (st_lookup(RHASH(opts)->tbl, tmp, 0)) {
+                VALUE allow_nan = rb_hash_aref(opts, tmp);
+                if (RTEST(allow_nan)) json->allow_nan = 1;
+            }
         }
     }
     json->current_nesting = 0;
@@ -561,9 +604,14 @@ void Init_parser()
     rb_define_method(cParser, "parse", cParser_parse, 0);
     rb_define_method(cParser, "source", cParser_source, 0);
 
+    CNaN = rb_const_get(mJSON, rb_intern("NaN"));
+    CInfinity = rb_const_get(mJSON, rb_intern("Infinity"));
+    CMinusInfinity = rb_const_get(mJSON, rb_intern("MinusInfinity"));
+
     i_json_creatable_p = rb_intern("json_creatable?");
     i_json_create = rb_intern("json_create");
     i_create_id = rb_intern("create_id");
     i_chr = rb_intern("chr");
     i_max_nesting = rb_intern("max_nesting");
+    i_allow_nan = rb_intern("allow_nan");
 }

data/lib/json.rb

@@ -47,6 +47,27 @@ require 'json/common'
 #
 # * http://json.rubyforge.org
 #
+# == Usage
+# 
+# To use JSON you can
+#   require 'json'
+# to load the installed variant (either the extension 'json' or the pure
+# variant 'json_pure'). If you have installed the extension variant, you can
+# pick either the extension variant or the pure variant by typing
+#   require 'json/ext'
+# or
+#   require 'json/pure'
+#
+# You can choose to load a set of common additions to ruby core's objects if
+# you
+#   require 'json/add/core'
+#
+# To get the best compatibility to rails' JSON implementation, you can
+#   require 'json/add/rails'
+#
+# Both of the additions attempt to require 'json' (like above) first, if it has
+# not been required yet.
+#
 # == Speed Comparisons
 #
 # I have created some benchmark results (see the benchmarks subdir of the
@@ -207,4 +228,6 @@ module JSON
       require 'json/pure'
     end
   end
+
+  JSON_LOADED = true
 end

data/lib/json/add/core.rb

@@ -0,0 +1,119 @@
+# This file contains implementations of ruby core's custom objects for
+# serialisation/deserialisation.
+
+unless Object.const_defined?(:JSON) and ::JSON.const_defined?(:JSON_LOADED) and
+  ::JSON::JSON_LOADED
+  require 'json'
+end
+
+class Time
+  def self.json_create(object)
+    at(*object.values_at('s', 'u'))
+  end
+
+  def to_json(*args)
+    {
+      'json_class' => self.class.name,
+      's' => tv_sec,
+      'u' => tv_usec,
+    }.to_json(*args)
+  end
+end
+
+class Date
+  def self.json_create(object)
+    civil(*object.values_at('y', 'm', 'd', 'sg'))
+  end
+
+  def to_json(*args)
+    {
+      'json_class' => self.class.name,
+      'y' => year,
+      'm' => month,
+      'd' => day,
+      'sg' => sg,
+    }.to_json(*args)
+  end
+end
+
+class DateTime
+  def self.json_create(object)
+    args = object.values_at('y', 'm', 'd', 'H', 'M', 'S')
+    of_a, of_b = object['of'].split('/')
+    args << Rational(of_a.to_i, of_b.to_i)
+    args << object['sg']
+    civil(*args)
+  end
+
+  def to_json(*args)
+    {
+      'json_class' => self.class.name,
+      'y' => year,
+      'm' => month,
+      'd' => day,
+      'H' => hour,
+      'M' => min,
+      'S' => sec,
+      'of' => offset,
+      'sg' => sg,
+    }.to_json(*args)
+  end
+end
+
+class Range
+  def self.json_create(object)
+    new(*object['a'])
+  end
+
+  def to_json(*args)
+    {
+      'json_class'   => self.class.name,
+      'a'         => [ first, last, exclude_end? ]
+    }.to_json(*args)
+  end
+end
+
+class Struct
+  def self.json_create(object)
+    new(*object['v'])
+  end
+
+  def to_json(*args)
+    klass = self.class.name
+    klass.empty? and raise JSON::JSONError, "Only named structs are supported!"
+    {
+      'json_class' => klass,
+      'v'     => values,
+    }.to_json(*args)
+  end
+end
+
+class Exception
+  def self.json_create(object)
+    result = new(object['m'])
+    result.set_backtrace object['b']
+    result
+  end
+
+  def to_json(*args)
+    {
+      'json_class' => self.class.name,
+      'm'   => message,
+      'b' => backtrace,
+    }.to_json(*args)
+  end
+end
+
+class Regexp
+  def self.json_create(object)
+    new(object['s'], object['o'])
+  end
+
+  def to_json(*)
+    {
+      'json_class' => self.class.name,
+      'o' => options,
+      's' => source,
+    }.to_json
+  end
+end

data/lib/json/add/rails.rb

@@ -0,0 +1,52 @@
+# This file contains implementations of rails custom objects for
+# serialisation/deserialisation.
+
+unless Object.const_defined?(:JSON) and ::JSON.const_defined?(:JSON_LOADED) and
+  ::JSON::JSON_LOADED
+  require 'json'
+end
+
+class Object
+  def self.json_create(object)
+    obj = new
+    for key, value in object
+      next if key == 'json_class'
+      instance_variable_set "@#{key}", value
+    end
+    obj
+  end
+
+  def to_json(*a)
+    result = {
+      'json_class' => self.class.name
+    }
+    instance_variables.inject(result) do |r, name|
+      r[name[1..-1]] = instance_variable_get name
+      r
+    end
+    result.to_json(*a)
+  end
+end
+
+module Enumerable
+  def to_json(*a)
+    to_a.to_json(*a)
+  end
+end
+
+# class Regexp
+#   def to_json(*)
+#     inspect
+#   end
+# end
+#
+# The above rails definition has some problems:
+#
+# 1. { 'foo' => /bar/ }.to_json # => "{foo: /bar/}"
+#    This isn't valid JSON, because the regular expression syntax is not
+#    defined in RFC 4627. (And unquoted strings are disallowed there, too.)
+#    Though it is valid Javascript.
+#
+# 2. { 'foo' => /bar/mix }.to_json # => "{foo: /bar/mix}"
+#    This isn't even valid Javascript.
+

data/lib/json/common.rb

@@ -2,14 +2,17 @@ require 'json/version'
 
 module JSON
   class << self
-    # 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.
-    def [](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.
+    def [](object, opts = {})
       if object.respond_to? :to_str
-        JSON.parse(object.to_str)
+        JSON.parse(object.to_str, opts => {})
       else
-        JSON.generate(object)
+        JSON.generate(object, opts => {})
       end
     end
 
@@ -71,6 +74,12 @@ module JSON
   end
   self.create_id = 'json_class'
 
+  NaN           = (-1.0) ** 0.5
+
+  Infinity      = 1.0/0
+
+  MinusInfinity = -Infinity
+
   # The base exception for JSON errors.
   class JSONError < StandardError; end
 
@@ -101,29 +110,79 @@ module JSON
   # _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.
+  #   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.
   def parse(source, opts = {})
     JSON.parser.new(source, opts).parse
   end
 
+  # Parse the JSON 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.
+  def parse!(source, opts = {})
+    opts = {
+      :max_nesting => false,
+      :allow_nan => true
+    }.update(opts)
+    JSON.parser.new(source, opts).parse
+  end
+
   # Unparse the Ruby data structure _obj_ into a single line JSON string and
-  # return it. _state_ is a JSON::State object, that can be used to configure
-  # the output further.
+  # 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 and only checks for circular data structures. If you are sure,
-  # that the objects don't contain any circles, you can set _state_ to nil, to
-  # disable these checks in order to create the JSON text faster. See also
-  # fast_generate.
-  def generate(obj, state = JSON.state.new)
+  # 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.
+  #
+  # 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.
+  def generate(obj, state = nil)
+    if state
+      state = State.from_state(state)
+    else
+      state = State.new
+    end
     obj.to_json(state)
   end
 
+  # :stopdoc:
+  # I want to deprecate these later, so I'll first be silent about them, and later delete them.
   alias unparse generate
   module_function :unparse
+  # :startdoc:
 
   # 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.
+  # 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.
@@ -131,12 +190,18 @@ module JSON
     obj.to_json(nil)
   end
 
+  # :stopdoc:
+  # I want to deprecate these later, so I'll first be silent about them, and later delete them.
   alias fast_unparse fast_generate
   module_function :fast_unparse
+  # :startdoc:
 
   # 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.
-  def pretty_generate(obj)
+  #
+  # The _opts_ argument can be used to configure the generator, see the
+  # generate method for a more detailed explanation.
+  def pretty_generate(obj, opts = nil)
     state = JSON.state.new(
       :indent     => '  ',
       :space      => ' ',
@@ -144,11 +209,94 @@ module JSON
       :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_json(state)
   end
 
+  # :stopdoc:
+  # I want to deprecate these later, so I'll first be silent about them, and later delete them.
   alias pretty_unparse pretty_generate
   module_function :pretty_unparse
+  # :startdoc:
+
+  # 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.
+  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
+
+  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
+  private :recurse_proc
+  module_function :recurse_proc
+
+  alias restore load
+  module_function :restore
+
+  # 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.
+  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
 end
 
 module ::Kernel
@@ -156,7 +304,7 @@ module ::Kernel
   # one line.
   def j(*objs)
     objs.each do |obj|
-      puts JSON::generate(obj)
+      puts JSON::generate(obj, :allow_nan => true, :max_nesting => false)
     end
     nil
   end
@@ -165,19 +313,22 @@ module ::Kernel
   # indentation and over many lines.
   def jj(*objs)
     objs.each do |obj|
-      puts JSON::pretty_generate(obj)
+      puts JSON::pretty_generate(obj, :allow_nan => true, :max_nesting => false)
     end
     nil
   end
 
-  # 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
+  # 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.
-  def JSON(object)
+  #
+  # The _opts_ argument is passed through to generate/parse respectively, see
+  # generate and parse for their documentation.
+  def JSON(object, opts = {})
     if object.respond_to? :to_str
-      JSON.parse(object.to_str)
+      JSON.parse(object.to_str, opts)
     else
-      JSON.generate(object)
+      JSON.generate(object, opts)
     end
   end
 end