oj 2.10.4 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30d74e96259d1e3ef85ebc6c587f0f0b1f2d155a
-  data.tar.gz: 0471ab90473ecbd13760d4942edf3461fdf9403d
+  metadata.gz: b4acaa9204b28018f0acc3ba755aa319759807b0
+  data.tar.gz: 50e58cf7d4ac2265a74f234a6d8d9bff6b45b00d
 SHA512:
-  metadata.gz: 04e8cae819f240f2449e19d5673c040f84e1bfb6ea6820126a862f0b1e930437542400c7af5ec4cc0472cd17ed1b5904565c8dd20eee8f69762b05407fb6e6ef
-  data.tar.gz: 7666bec8a2682042e317dc4d8ca36200a06800e59a667f71ce1b1eb34eb855481f863d0f867111290d655a5c41ae68d93e626afcadcb95dc29a736708c1f8d20
+  metadata.gz: b81caf19b41d35592c690f9e1c8411681a9ff0236eed9db198fdcc93e6a3b5463f5ef437849944b99808742f3ce91339d748a38bb687083e22f71bc1a658f788
+  data.tar.gz: ba0df930d57755e5bbe0524ed88ff43542ef4a0177454fd139aa38cfcdf1801e63f73358e8f94d4e69ef6a55f972b3f162714c97212da734557afcec2080e914

data/README.md

@@ -26,23 +26,30 @@ Follow [@peterohler on Twitter](http://twitter.com/#!/peterohler) for announceme
 
 [![Build Status](https://secure.travis-ci.org/ohler55/oj.png?branch=master)](http://travis-ci.org/ohler55/oj)
 
-### Current Release 2.10.4
+### Current Release 2.11.0
 
- - Fixed Range encoding in compat mode to not use the object mode encoding.
+ - Restricted strict dump to not dump NaN nor Infinity but instead raise an exception.
 
- - Fixed serialization problem with timestamps.
+ - Changed compat mode so that the :bigdecimal_as_decimal option over-rides the
+   to_json method if the option is true. The default for mimic_JSON is to leave
+   the option off.
 
- - Fixed compat parser to accept NaN and Infinity.
- 
-### Release 2.10.3
+ - Added support for Module encoding in compat mode.
+
+ - Added ActiveSupportHelper so that require 'active_support_helper' will added
+   a helper for serializing ActiveSupport::TimeWithZone.
 
- - Using the xmlschema option with :object mode now saves time as a string and
-   preserves the timezone.
+ - Added float_precision option to control the number of digits used for floats
+   when dumping.
+ 
+### Release 2.10.4
 
- - Rational recursive loop caused by active support fixed.
+ - Fixed Range encoding in compat mode to not use the object mode encoding.
 
- - Time in mimic_JSON mode are now the ruby string representation of a date.
+ - Fixed serialization problem with timestamps.
 
+ - Fixed compat parser to accept NaN and Infinity.
+ 
 [Older release notes](http://www.ohler.com/dev/oj_misc/release_notes.html).
 
 ## Description
@@ -102,7 +109,7 @@ gem 'oj_mimic_json'
 
 ## Proper Use
 
-Two settings in Oj are useful for parsing but do expose a vunerability if used from an untrusted source. Symbolized
+Two settings in Oj are useful for parsing but do expose a vulnerability if used from an untrusted source. Symbolized
 keys can cause memory to be filled since Ruby does not garbage collect Symbols. The same is true for auto
 defining classes; memory will also be exhausted if too many classes are automatically defined. Auto defining is a useful
 feature during development and from trusted sources but it allows too many classes to be created in the object load

data/ext/oj/dump.c

@@ -457,18 +457,36 @@ dump_float(VALUE obj, Out out) {
 	*b++ = '\0';
 	cnt = 3;
     } else if (OJ_INFINITY == d) {
+	if (StrictMode == out->opts->mode) {
+	    raise_strict(obj);
+	}
 	strcpy(buf, "Infinity");
 	cnt = 8;
     } else if (-OJ_INFINITY == d) {
+	if (StrictMode == out->opts->mode) {
+	    raise_strict(obj);
+	}
 	strcpy(buf, "-Infinity");
 	cnt = 9;
     } else if (isnan(d)) {
+	if (StrictMode == out->opts->mode) {
+	    raise_strict(obj);
+	}
 	strcpy(buf, "NaN");
 	cnt = 3;
     } else if (d == (double)(long long int)d) {
-	cnt = sprintf(buf, "%.1f", d); // used sprintf due to bug in snprintf
+	cnt = snprintf(buf, sizeof(buf), "%.1f", d);
+    } else if (0 == out->opts->float_prec) {
+	volatile VALUE	rstr = rb_funcall(obj, oj_to_s_id, 0);
+
+	cnt = RSTRING_LEN(rstr);
+	if (sizeof(buf) <= cnt) {
+	    cnt = sizeof(buf) - 1;
+	}
+	strncpy(buf, rb_string_value_ptr((VALUE*)&rstr), cnt);
+	buf[cnt] = '\0';
     } else {
-	cnt = sprintf(buf, "%0.16g", d); // used sprintf due to bug in snprintf
+	cnt = snprintf(buf, sizeof(buf), out->opts->float_fmt, d);
     }
     if (out->end - out->cur <= (long)cnt) {
 	grow(out, cnt);
@@ -1169,6 +1187,8 @@ dump_data_null(VALUE obj, Out out) {
 
 static void
 dump_data_comp(VALUE obj, int depth, Out out) {
+    VALUE	clas = rb_obj_class(obj);
+
     if (rb_respond_to(obj, oj_to_hash_id)) {
 	volatile VALUE	h = rb_funcall(obj, oj_to_hash_id, 0);
  
@@ -1176,6 +1196,11 @@ dump_data_comp(VALUE obj, int depth, Out out) {
 	    rb_raise(rb_eTypeError, "%s.to_hash() did not return a Hash.\n", rb_class2name(rb_obj_class(obj)));
 	}
 	dump_hash(h, Qundef, depth, out->opts->mode, out);
+
+    } else if (Yes == out->opts->bigdec_as_num && oj_bigdecimal_class == clas) {
+	volatile VALUE	rstr = rb_funcall(obj, oj_to_s_id, 0);
+
+	dump_raw(rb_string_value_ptr((VALUE*)&rstr), RSTRING_LEN(rstr), out);
     } else if (Yes == out->opts->to_json && rb_respond_to(obj, oj_as_json_id)) {
 	volatile VALUE	aj = rb_funcall(obj, oj_as_json_id, 0);
 
@@ -1204,8 +1229,6 @@ dump_data_comp(VALUE obj, int depth, Out out) {
 	out->cur += len;
 	*out->cur = '\0';
     } else {
-	VALUE	clas = rb_obj_class(obj);
-
 	if (rb_cTime == clas) {
 	    switch (out->opts->time_format) {
 	    case RubyTime:	dump_ruby_time(obj, out);	break;
@@ -1216,11 +1239,7 @@ dump_data_comp(VALUE obj, int depth, Out out) {
 	} else if (oj_bigdecimal_class == clas) {
 	    volatile VALUE	rstr = rb_funcall(obj, oj_to_s_id, 0);
 
-	    if (Yes == out->opts->bigdec_as_num) {
-		dump_raw(rb_string_value_ptr((VALUE*)&rstr), RSTRING_LEN(rstr), out);
-	    } else {
-		dump_cstr(rb_string_value_ptr((VALUE*)&rstr), RSTRING_LEN(rstr), 0, 0, out);
-	    }
+	    dump_cstr(rb_string_value_ptr((VALUE*)&rstr), RSTRING_LEN(rstr), 0, 0, out);
 	} else {
 	    volatile VALUE	rstr = rb_funcall(obj, oj_to_s_id, 0);
 
@@ -1722,13 +1741,41 @@ dump_odd(VALUE obj, Odd odd, VALUE clas, int depth, Out out) {
     }
     size = d2 * out->indent + 1;
     for (idp = odd->attrs; 0 != *idp; idp++) {
+	size_t	nlen;
+
 	if (out->end - out->cur <= (long)size) {
 	    grow(out, size);
 	}
 	name = rb_id2name(*idp);
-	v = rb_funcall(obj, *idp, 0);
+	nlen = strlen(name);
+	if (0 == strchr(name, '.')) {
+	    v = rb_funcall(obj, *idp, 0);
+	} else {
+	    char	nbuf[256];
+	    char	*n2 = nbuf;
+	    char	*n;
+	    char	*end;
+	    ID		i;
+	    
+	    if (sizeof(nbuf) <= nlen) {
+		n2 = strdup(name);
+	    }
+	    n = n2;
+	    v = obj;
+	    while (0 != (end = strchr(n, '.'))) {
+		*end = '\0';
+		i = rb_intern(n);
+		v = rb_funcall(v, i, 0);
+		n = end + 1;
+	    }
+	    i = rb_intern(n);
+	    v = rb_funcall(v, i, 0);
+	    if (nbuf != n2) {
+		free(n2);
+	    }
+	}
 	fill_indent(out, d2);
-	dump_cstr(name, strlen(name), 0, 0, out);
+	dump_cstr(name, nlen, 0, 0, out);
 	*out->cur++ = ':';
 	dump_val(v, d2, out);
 	if (out->end - out->cur <= 2) {
@@ -1759,6 +1806,7 @@ dump_val(VALUE obj, int depth, Out out) {
     case T_FALSE:	dump_false(out);			break;
     case T_FIXNUM:	dump_fixnum(obj, out);			break;
     case T_FLOAT:	dump_float(obj, out);			break;
+    case T_MODULE:
     case T_CLASS:
 	switch (out->opts->mode) {
 	case StrictMode:	raise_strict(obj);		break;

data/ext/oj/odd.c

@@ -34,7 +34,7 @@
 
 static struct _Odd	_odds[4]; // bump up if new initial Odd classes are added
 static struct _Odd	*odds = _odds;
-static int		odd_cnt = 0;
+static long		odd_cnt = 0;
 
 static void
 set_class(Odd odd, const char *classname) {

data/ext/oj/oj.c

@@ -114,6 +114,7 @@ static VALUE	class_cache_sym;
 static VALUE	compat_sym;
 static VALUE	create_id_sym;
 static VALUE	escape_mode_sym;
+static VALUE	float_prec_sym;
 static VALUE	float_sym;
 static VALUE	indent_sym;
 static VALUE	json_sym;
@@ -168,12 +169,14 @@ struct _Options	oj_default_options = {
     AutoDec,		// bigdec_load
     Yes,		// to_json
     No,			// nilnil
+    Yes,		// allow_gc
+    Yes,		// quirks_mode
     json_class,		// create_id
     10,			// create_id_len
     9,			// sec_prec
-    Yes,		// allow_gc
-    Yes,		// quirks_mode
     0,			// dump_opts
+    15,			// float_prec
+    "%0.15g",		// float_fmt
 };
 
 static VALUE	define_mimic_json(int argc, VALUE *argv, VALUE self);
@@ -193,6 +196,7 @@ static VALUE	define_mimic_json(int argc, VALUE *argv, VALUE self);
  * - bigdecimal_load: [:bigdecimal|:float|:auto] load decimals as BigDecimal instead of as a Float. :auto pick the most precise for the number of digits.
  * - create_id: [String|nil] create id for json compatible object encoding, default is 'json_create'
  * - second_precision: [Fixnum|nil] number of digits after the decimal when dumping the seconds portion of time
+ * - float_precision: [Fixnum|nil] number of digits of precision when dumping floats, 0 indicates use Ruby
  * - use_to_json: [true|false|nil] call to_json() methods on dump, default is false
  * - nilnil: [true|false|nil] if true a nil input to load will return nil and not raise an Exception
  * - allow_gc: [true|false|nil] allow or prohibit GC during parsing, default is true (allow)
@@ -214,6 +218,7 @@ get_def_opts(VALUE self) {
     rb_hash_aset(opts, nilnil_sym, (Yes == oj_default_options.nilnil) ? Qtrue : ((No == oj_default_options.nilnil) ? Qfalse : Qnil));
     rb_hash_aset(opts, allow_gc_sym, (Yes == oj_default_options.allow_gc) ? Qtrue : ((No == oj_default_options.allow_gc) ? Qfalse : Qnil));
     rb_hash_aset(opts, quirks_mode_sym, (Yes == oj_default_options.quirks_mode) ? Qtrue : ((No == oj_default_options.quirks_mode) ? Qfalse : Qnil));
+    rb_hash_aset(opts, float_prec_sym, INT2FIX(oj_default_options.float_prec));
     switch (oj_default_options.mode) {
     case StrictMode:	rb_hash_aset(opts, mode_sym, strict_sym);	break;
     case CompatMode:	rb_hash_aset(opts, mode_sym, compat_sym);	break;
@@ -235,7 +240,7 @@ get_def_opts(VALUE self) {
     default:		rb_hash_aset(opts, time_format_sym, unix_sym);		break;
     }
     switch (oj_default_options.bigdec_load) {
-    case BigDec:	rb_hash_aset(opts, bigdecimal_load_sym, bigdecimal_sym);	break;
+    case BigDec:	rb_hash_aset(opts, bigdecimal_load_sym, bigdecimal_sym);break;
     case FloatDec:	rb_hash_aset(opts, bigdecimal_load_sym, float_sym);	break;
     case AutoDec:
     default:		rb_hash_aset(opts, bigdecimal_load_sym, auto_sym);	break;
@@ -274,6 +279,7 @@ get_def_opts(VALUE self) {
  *        :ruby Time.to_s formatted String
  * @param [String|nil] :create_id create id for json compatible object encoding
  * @param [Fixnum|nil] :second_precision number of digits after the decimal when dumping the seconds portion of time
+ * @param [Fixnum|nil] :float_precision number of digits of precision when dumping floats, 0 indicates use Ruby
  * @param [true|false|nil] :use_to_json call to_json() methods on dump, default is false
  * @param [true|false|nil] :nilnil if true a nil input to load will return nil and not raise an Exception
  * @param [true|false|nil] :allow_gc allow or prohibit GC during parsing, default is true (allow)
@@ -303,6 +309,23 @@ set_def_opts(VALUE self, VALUE opts) {
 	Check_Type(v, T_FIXNUM);
 	oj_default_options.indent = FIX2INT(v);
     }
+    v = rb_hash_aref(opts, float_prec_sym);
+    if (Qnil != v) {
+	int	n;
+
+	Check_Type(v, T_FIXNUM);
+	n = FIX2INT(v);
+	if (0 >= n) {
+	    *oj_default_options.float_fmt = '\0';
+	    oj_default_options.float_prec = 0;
+	} else {
+	    if (20 < n) {
+		n = 20;
+	    }
+	    sprintf(oj_default_options.float_fmt, "%%0.%dg", n);
+	    oj_default_options.float_prec = n;
+	}
+    }
     v = rb_hash_aref(opts, sec_prec_sym);
     if (Qnil != v) {
 	int	n;
@@ -440,6 +463,25 @@ oj_parse_options(VALUE ropts, Options copts) {
 	    }
 	    copts->indent = NUM2INT(v);
 	}
+	if (Qnil != (v = rb_hash_lookup(ropts, float_prec_sym))) {
+	    int	n;
+
+	    if (rb_cFixnum != rb_obj_class(v)) {
+		rb_raise(rb_eArgError, ":float_precision must be a Fixnum.");
+	    }
+	    Check_Type(v, T_FIXNUM);
+	    n = FIX2INT(v);
+	    if (0 >= n) {
+		*copts->float_fmt = '\0';
+		copts->float_prec = 0;
+	    } else {
+		if (20 < n) {
+		    n = 20;
+		}
+		sprintf(copts->float_fmt, "%%0.%dg", n);
+		copts->float_prec = n;
+	    }
+	}
 	if (Qnil != (v = rb_hash_lookup(ropts, sec_prec_sym))) {
 	    int	n;
 
@@ -890,7 +932,7 @@ to_stream(int argc, VALUE *argv, VALUE self) {
  * normal way. It is not intended as a hook for changing the output of all
  * classes as it is not optimized for large numbers of classes.
  *
- * @param [Class] clas Class to me made special
+ * @param [Class] clas Class to be made special
  * @param [Object] create_object object to call the create method on
  * @param [Symbol] create_method method on the clas that will create a new
  *                 instance of the clas when given all the member values in the
@@ -1717,16 +1759,18 @@ static struct _Options	mimic_object_to_json_options = {
     CompatMode,		// mode
     No,			// class_cache
     RubyTime,		// time_format
-    Yes,		// bigdec_as_num
+    No,			// bigdec_as_num
     AutoDec,		// bigdec_load
     No,			// to_json
     Yes,		// nilnil
+    Yes,		// allow_gc
+    Yes,		// quirks_mode
     json_class,		// create_id
     10,			// create_id_len
     9,			// sec_prec
-    Yes,		// allow_gc
-    Yes,		// quirks_mode
     0,			// dump_opts
+    15,			// float_prec
+    "%0.15g",		// float_fmt
 };
 
 static VALUE
@@ -2019,6 +2063,7 @@ void Init_oj() {
     compat_sym = ID2SYM(rb_intern("compat"));		rb_gc_register_address(&compat_sym);
     create_id_sym = ID2SYM(rb_intern("create_id"));	rb_gc_register_address(&create_id_sym);
     escape_mode_sym = ID2SYM(rb_intern("escape_mode"));	rb_gc_register_address(&escape_mode_sym);
+    float_prec_sym = ID2SYM(rb_intern("float_precision"));rb_gc_register_address(&float_prec_sym);
     float_sym = ID2SYM(rb_intern("float"));		rb_gc_register_address(&float_sym);
     indent_sym = ID2SYM(rb_intern("indent"));		rb_gc_register_address(&indent_sym);
     json_sym = ID2SYM(rb_intern("json"));		rb_gc_register_address(&json_sym);

data/ext/oj/oj.h

@@ -138,12 +138,14 @@ typedef struct _Options {
     char	bigdec_load;	// BigLoad
     char	to_json;	// YesNo
     char	nilnil;		// YesNo
+    char	allow_gc;	// allow GC during parse
+    char	quirks_mode;	// allow single JSON values instead of documents
     const char	*create_id;	// 0 or string
     size_t	create_id_len;	// length of create_id
     int		sec_prec;	// second precision when dumping time
-    char	allow_gc;	// allow GC during parse
-    char	quirks_mode;	// allow single JSON values instead of documents
     DumpOpts	dump_opts;
+    char	float_prec;	// float precision, linked to float_fmt
+    char	float_fmt[7];	// float format for dumping, if empty use Ruby
 } *Options;
 
 typedef struct _Out {

data/lib/oj/active_support_helper.rb

@@ -0,0 +1,17 @@
+
+require 'active_support/time'
+
+module Oj
+
+  # 
+  class ActiveSupportHelper
+
+    def self.createTimeWithZone(utc, zone)
+      ActiveSupport::TimeWithZone.new(utc - utc.gmt_offset, ActiveSupport::TimeZone[zone])
+    end
+  end
+
+end
+
+Oj.register_odd(ActiveSupport::TimeWithZone, Oj::ActiveSupportHelper, :createTimeWithZone, :utc, 'time_zone.name')
+

data/lib/oj/version.rb

@@ -1,5 +1,5 @@
 
 module Oj
   # Current version of the module. 
-  VERSION = '2.10.4'
+  VERSION = '2.11.0'
 end

data/test/_test_mimic_rails.rb

@@ -10,6 +10,11 @@ require 'rails/all'
 require 'active_model'
 require 'active_model_serializers'
 require 'active_support/json'
+require 'active_support/time'
+
+require 'oj/active_support_helper'
+
+#Oj.mimic_JSON
 
 class Category
   include ActiveModel::Model
@@ -41,7 +46,7 @@ class MimicRails < Minitest::Test
   end
 
   def test_dump_string
-    Oj.default_options= {:indent => 2} # JSON this will not change anything
+    Oj.default_options= {:indent => 2}
     json = ActiveSupport::JSON.encode([1, true, nil])
     assert_equal(%{[
   1,
@@ -52,7 +57,7 @@ class MimicRails < Minitest::Test
   end
 
   def test_dump_rational
-    Oj.default_options= {:indent => 2} # JSON this will not change anything
+    Oj.default_options= {:indent => 2}
     json = ActiveSupport::JSON.encode([1, true, Rational(1)])
     assert_equal(%{[
   1,
@@ -63,7 +68,7 @@ class MimicRails < Minitest::Test
   end
 
   def test_dump_range
-    Oj.default_options= {:indent => 2} # JSON this will not change anything
+    Oj.default_options= {:indent => 2}
     json = ActiveSupport::JSON.encode([1, true, '01'..'12'])
     assert_equal(%{[
   1,
@@ -79,9 +84,22 @@ class MimicRails < Minitest::Test
     serializer = CategorySerializer.new(category)
 
     json = serializer.to_json()
+    puts "*** serializer.to_json() #{serializer.to_json()}"
     json = serializer.as_json()
+    puts "*** serializer.as_json() #{serializer.as_json()}"
     json = JSON.dump(serializer)
+    puts "*** JSON.dump(serializer) #{JSON.dump(serializer)}"
   end
 
+  def test_dump_time
+    Oj.default_options= {:indent => 2}
+    now = ActiveSupport::TimeZone['America/Chicago'].parse("2014-11-01 13:20:47")
+    json = Oj.dump(now, mode: :object, time_format: :xmlschema)
+    #puts "*** json: #{json}"
+
+    oj_dump = Oj.load(json, mode: :object, time_format: :xmlschema)
+    #puts "Now: #{now}\n Oj: #{oj_dump}"
+    assert_equal("2014-11-01T13:20:47-05:00", oj_dump.xmlschema)
+  end
 
 end # MimicRails