oj 2.0.4 → 2.0.5

data/README.md

@@ -32,15 +32,14 @@ A fast JSON parser and Object marshaller as a Ruby gem.
 
 ## <a name="release">Release Notes</a>
 
-### Release 2.0.4
+### Release 2.0.5
 
- - Fixed bug related to long class names.
+ - DateTimes are now output the same in compat mode for both 1.8.7 and 1.9.3 even though they are implemented differently in each Ruby.
 
- - Change the default for the auto_define option.
+ - Objects implemented as data structs can now change the encoding by implemented either to_json(), as_json(), or to_hash().
 
- - Added Oj.strict_load() method that sets the options to public safe options. This should be safe for loading JSON
-   documents from a public unverified source. It does not eleviate to need for reasonable programming practices of
-   course. See the section on the <a href="#proper_use">proper use of Oj</a> in a public exposure.
+ - Added an option to allow BigDecimals to be dumped as either a string or as a number. There was no agreement on which
+   was the best or correct so both are possible with the correct option setting.
 
 ## <a name="description">Description</a>
 

data/ext/oj/dump.c

@@ -93,7 +93,7 @@ static void	dump_ruby_time(VALUE obj, Out out);
 static void	dump_xml_time(VALUE obj, Out out);
 static void	dump_data_strict(VALUE obj, Out out);
 static void	dump_data_null(VALUE obj, Out out);
-static void	dump_data_comp(VALUE obj, Out out);
+static void	dump_data_comp(VALUE obj, int depth, Out out);
 static void	dump_data_obj(VALUE obj, int depth, Out out);
 static void	dump_obj_comp(VALUE obj, int depth, Out out);
 static void	dump_obj_obj(VALUE obj, int depth, Out out);
@@ -1116,21 +1116,51 @@ dump_data_null(VALUE obj, Out out) {
 }
 
 static void
-dump_data_comp(VALUE obj, Out out) {
-    VALUE	clas = rb_obj_class(obj);
+dump_data_comp(VALUE obj, int depth, Out out) {
+    if (rb_respond_to(obj, oj_to_hash_id)) {
+	VALUE	h = rb_funcall(obj, oj_to_hash_id, 0);
+ 
+	if (T_HASH != rb_type(h)) {
+	    rb_raise(rb_eTypeError, "%s.to_hash() did not return a Hash.\n", rb_class2name(rb_obj_class(obj)));
+	}
+	dump_hash(h, depth, out->opts->mode, out);
+    } else if (rb_respond_to(obj, oj_as_json_id)) {
+	dump_val(rb_funcall(obj, oj_as_json_id, 0), depth, out);
+    } else if (rb_respond_to(obj, oj_to_json_id)) {
+	VALUE		rs = rb_funcall(obj, oj_to_json_id, 0);
+	const char	*s = StringValuePtr(rs);
+	int		len = (int)RSTRING_LEN(rs);
 
-    if (rb_cTime == clas) {
-	switch (out->opts->time_format) {
-	case RubyTime:	dump_ruby_time(obj, out);	break;
-	case XmlTime:	dump_xml_time(obj, out);	break;
-	case UnixTime:
-	default:	dump_time(obj, out);		break;
+	if (out->end - out->cur <= len + 1) {
+	    grow(out, len);
 	}
+	memcpy(out->cur, s, len);
+	out->cur += len;
+	*out->cur = '\0';
     } else {
-	VALUE	rstr;
+	VALUE	clas = rb_obj_class(obj);
 
-	rstr = rb_funcall(obj, oj_to_s_id, 0);
-	dump_cstr(StringValuePtr(rstr), RSTRING_LEN(rstr), 0, 0, out);
+	if (rb_cTime == clas) {
+	    switch (out->opts->time_format) {
+	    case RubyTime:	dump_ruby_time(obj, out);	break;
+	    case XmlTime:	dump_xml_time(obj, out);	break;
+	    case UnixTime:
+	    default:	dump_time(obj, out);		break;
+	    }
+	} else if (oj_bigdecimal_class == clas) {
+	    VALUE	rstr = rb_funcall(obj, oj_to_s_id, 0);
+
+	    if (Yes == out->opts->bigdec_as_num) {
+		dump_raw(StringValuePtr(rstr), RSTRING_LEN(rstr), out);
+	    } else {
+		dump_cstr(StringValuePtr(rstr), RSTRING_LEN(rstr), 0, 0, out);
+	    }
+	} else {
+	    VALUE	rstr;
+
+	    rstr = rb_funcall(obj, oj_to_s_id, 0);
+	    dump_cstr(StringValuePtr(rstr), RSTRING_LEN(rstr), 0, 0, out);
+	}
     }
 }
 
@@ -1157,8 +1187,12 @@ dump_data_obj(VALUE obj, int depth, Out out) {
 	if (0 == odd) {
 	    if (oj_bigdecimal_class == clas) {
 		VALUE	rstr = rb_funcall(obj, oj_to_s_id, 0);
-
-		dump_raw(StringValuePtr(rstr), RSTRING_LEN(rstr), out);
+		
+		if (Yes == out->opts->bigdec_as_num) {
+		    dump_raw(StringValuePtr(rstr), RSTRING_LEN(rstr), out);
+		} else {
+		    dump_cstr(StringValuePtr(rstr), RSTRING_LEN(rstr), 0, 0, out);
+		}
 	    } else {
 		dump_nil(out);
 	    }
@@ -1184,18 +1218,26 @@ dump_obj_comp(VALUE obj, int depth, Out out) {
 	const char	*s = StringValuePtr(rs);
 	int		len = (int)RSTRING_LEN(rs);
 
-	if (out->end - out->cur <= len) {
+	if (out->end - out->cur <= len + 1) {
 	    grow(out, len);
 	}
 	memcpy(out->cur, s, len);
 	out->cur += len;
+	*out->cur = '\0';
     } else {
 	VALUE	clas = rb_obj_class(obj);
 
 	if (oj_bigdecimal_class == clas) {
 	    VALUE	rstr = rb_funcall(obj, oj_to_s_id, 0);
 
-	    //dump_raw(StringValuePtr(rstr), RSTRING_LEN(rstr), out);
+	    if (Yes == out->opts->bigdec_as_num) {
+		dump_raw(StringValuePtr(rstr), RSTRING_LEN(rstr), out);
+	    } else {
+		dump_cstr(StringValuePtr(rstr), RSTRING_LEN(rstr), 0, 0, out);
+	    }
+	} else if (oj_datetime_class == clas || oj_date_class == clas) {
+	    VALUE	rstr = rb_funcall(obj, oj_to_s_id, 0);
+
 	    dump_cstr(StringValuePtr(rstr), RSTRING_LEN(rstr), 0, 0, out);
 	} else {
 	    Odd	odd = oj_get_odd(clas);
@@ -1572,7 +1614,7 @@ dump_val(VALUE obj, int depth, Out out) {
 	switch (out->opts->mode) {
 	case StrictMode:	dump_data_strict(obj, out);	break;
 	case NullMode:		dump_data_null(obj, out);	break;
-	case CompatMode:	dump_data_comp(obj, out);	break;
+	case CompatMode:	dump_data_comp(obj, depth, out);break;
 	case ObjectMode:
 	default:		dump_data_obj(obj, depth, out);	break;
 	}

data/ext/oj/oj.c

@@ -72,8 +72,10 @@ ID	oj_utc_offset_id;
 ID	oj_write_id;
 
 VALUE	oj_bag_class;
-VALUE	oj_parse_error_class;
 VALUE	oj_bigdecimal_class;
+VALUE	oj_date_class;
+VALUE	oj_datetime_class;
+VALUE	oj_parse_error_class;
 VALUE	oj_stringio_class;
 VALUE	oj_struct_class;
 VALUE	oj_time_class;
@@ -82,6 +84,7 @@ VALUE	oj_slash_string;
 
 static VALUE	ascii_only_sym;
 static VALUE	auto_define_sym;
+static VALUE	bigdecimal_as_decimal_sym;
 static VALUE	circular_sym;
 static VALUE	compat_sym;
 static VALUE	create_id_sym;
@@ -127,6 +130,7 @@ struct _Options	oj_default_options = {
     No,			// ascii_only
     ObjectMode,		// mode
     UnixTime,		// time_format
+    Yes,		// bigdec_as_num
     json_class,		// create_id
     65536,		// max_stack
     9,			// sec_prec
@@ -157,6 +161,7 @@ oj_get_odd(VALUE clas) {
  * - symbol_keys: [true|false|nil] use symbols instead of strings for hash keys
  * - mode: [:object|:strict|:compat|:null] load and dump modes to use for JSON
  * - time_format: [:unix|:xmlschema|:ruby] time format when dumping in :compat mode
+ * - bigdecimal_as_decimal: [true|false|nil] dump BigDecimal as a decimal number or as a String
  * - create_id: [String|nil] create id for json compatible object encoding, default is 'json_create'
  * - max_stack: [Fixnum|nil] maximum json size to allocate on the stack, default is 65536
  * - second_precision: [Fixnum|nil] number of digits after the decimal when dumping the seconds portion of time
@@ -173,6 +178,7 @@ get_def_opts(VALUE self) {
     rb_hash_aset(opts, auto_define_sym, (Yes == oj_default_options.auto_define) ? Qtrue : ((No == oj_default_options.auto_define) ? Qfalse : Qnil));
     rb_hash_aset(opts, ascii_only_sym, (Yes == oj_default_options.ascii_only) ? Qtrue : ((No == oj_default_options.ascii_only) ? Qfalse : Qnil));
     rb_hash_aset(opts, symbol_keys_sym, (Yes == oj_default_options.sym_key) ? Qtrue : ((No == oj_default_options.sym_key) ? Qfalse : Qnil));
+    rb_hash_aset(opts, bigdecimal_as_decimal_sym, (Yes == oj_default_options.bigdec_as_num) ? Qtrue : ((No == oj_default_options.bigdec_as_num) ? Qfalse : Qnil));
     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;
@@ -200,6 +206,7 @@ get_def_opts(VALUE self) {
  * @param [true|false|nil] :auto_define automatically define classes if they do not exist
  * @param [true|false|nil] :symbol_keys convert hash keys to symbols
  * @param [true|false|nil] :ascii_only encode all high-bit characters as escaped sequences if true
+ * @param [true|false|nil] :bigdecimal_as_decimal dump BigDecimal as a decimal number or as a String
  * @param [:object|:strict|:compat|:null] load and dump mode to use for JSON
  *	  :strict raises an exception when a non-supported Object is
  *	  encountered. :compat attempts to extract variable values from an
@@ -224,6 +231,7 @@ set_def_opts(VALUE self, VALUE opts) {
 	{ auto_define_sym, &oj_default_options.auto_define },
 	{ symbol_keys_sym, &oj_default_options.sym_key },
 	{ ascii_only_sym, &oj_default_options.ascii_only },
+	{ bigdecimal_as_decimal_sym, &oj_default_options.bigdec_as_num },
 	{ Qnil, 0 }
     };
     YesNoOpt	o;
@@ -328,6 +336,7 @@ parse_options(VALUE ropts, Options copts) {
 	{ auto_define_sym, &copts->auto_define },
 	{ symbol_keys_sym, &copts->sym_key },
 	{ ascii_only_sym, &copts->ascii_only },
+	{ bigdecimal_as_decimal_sym, &copts->bigdec_as_num },
 	{ Qnil, 0 }
     };
     YesNoOpt	o;
@@ -1043,14 +1052,17 @@ void Init_oj() {
     oj_write_id = rb_intern("write");
 
     oj_bag_class = rb_const_get_at(Oj, rb_intern("Bag"));
+    oj_bigdecimal_class = rb_const_get(rb_cObject, rb_intern("BigDecimal"));
+    oj_date_class = rb_const_get(rb_cObject, rb_intern("Date"));
+    oj_datetime_class = rb_const_get(rb_cObject, rb_intern("DateTime"));
     oj_parse_error_class = rb_const_get_at(Oj, rb_intern("ParseError"));
+    oj_stringio_class = rb_const_get(rb_cObject, rb_intern("StringIO"));
     oj_struct_class = rb_const_get(rb_cObject, rb_intern("Struct"));
     oj_time_class = rb_const_get(rb_cObject, rb_intern("Time"));
-    oj_bigdecimal_class = rb_const_get(rb_cObject, rb_intern("BigDecimal"));
-    oj_stringio_class = rb_const_get(rb_cObject, rb_intern("StringIO"));
 
     ascii_only_sym = ID2SYM(rb_intern("ascii_only"));	rb_gc_register_address(&ascii_only_sym);
     auto_define_sym = ID2SYM(rb_intern("auto_define"));	rb_gc_register_address(&auto_define_sym);
+    bigdecimal_as_decimal_sym = ID2SYM(rb_intern("bigdecimal_as_decimal"));rb_gc_register_address(&bigdecimal_as_decimal_sym);
     circular_sym = ID2SYM(rb_intern("circular"));	rb_gc_register_address(&circular_sym);
     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);
@@ -1090,7 +1102,7 @@ void Init_oj() {
     // Date
     odd++;
     idp = odd->attrs;
-    odd->clas = rb_const_get(rb_cObject, rb_intern("Date"));
+    odd->clas = oj_date_class;
     odd->create_obj = odd->clas;
     odd->create_op = oj_new_id;
     odd->attr_cnt = 4;
@@ -1102,7 +1114,7 @@ void Init_oj() {
     // DateTime
     odd++;
     idp = odd->attrs;
-    odd->clas = rb_const_get(rb_cObject, rb_intern("DateTime"));
+    odd->clas = oj_datetime_class;
     odd->create_obj = odd->clas;
     odd->create_op = oj_new_id;
     odd->attr_cnt = 8;

data/ext/oj/oj.h

@@ -108,6 +108,7 @@ typedef struct _Options {
     char	ascii_only;	// YesNo
     char	mode;		// Mode
     char	time_format;	// TimeFormat
+    char	bigdec_as_num;	// YesNo
     const char	*create_id;	// 0 or string
     size_t	max_stack;	// max size to allocate on the stack
     int		sec_prec;	// second precision when dumping time
@@ -166,6 +167,8 @@ extern rb_encoding	*oj_utf8_encoding;
 
 extern VALUE	oj_bag_class;
 extern VALUE	oj_bigdecimal_class;
+extern VALUE	oj_date_class;
+extern VALUE	oj_datetime_class;
 extern VALUE	oj_doc_class;
 extern VALUE	oj_parse_error_class;
 extern VALUE	oj_stringio_class;

data/lib/oj/version.rb

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

data/test/tests.rb

@@ -117,6 +117,7 @@ class Juice < ::Test::Unit::TestCase
                    :ascii_only=>false,
                    :mode=>:object,
                    :time_format=>:unix,
+                   :bigdecimal_as_decimal=>true,
                    :max_stack=>65536,
                    :create_id=>'json_class'}, opts)
   end
@@ -131,6 +132,7 @@ class Juice < ::Test::Unit::TestCase
       :ascii_only=>false,
       :mode=>:object,
       :time_format=>:unix,
+      :bigdecimal_as_decimal=>true,
       :max_stack=>65536,
       :create_id=>'json_class'}
     o2 = {
@@ -142,6 +144,7 @@ class Juice < ::Test::Unit::TestCase
       :ascii_only=>true,
       :mode=>:compat,
       :time_format=>:ruby,
+      :bigdecimal_as_decimal=>false,
       :max_stack=>4000,
       :create_id=>nil}
     o3 = { :indent => 4 }
@@ -732,14 +735,24 @@ class Juice < ::Test::Unit::TestCase
   end
   def test_bigdecimal_compat
     orig = BigDecimal.new('80.51')
-    json = Oj.dump(orig, :mode => :compat)
+    json = Oj.dump(orig, :mode => :compat, :bigdecimal_as_decimal => false)
     bg = Oj.load(json, :mode => :compat)
     assert_equal(orig.to_s, bg)
     orig = BigDecimal.new('3.14159265358979323846')
-    json = Oj.dump(orig, :mode => :compat)
+    json = Oj.dump(orig, :mode => :compat, :bigdecimal_as_decimal => false)
     bg = Oj.load(json, :mode => :compat)
     assert_equal(orig.to_s, bg)
   end
+  def test_bigdecimal_compat_to_json
+    orig = BigDecimal.new('80.51')
+    BigDecimal.send(:define_method, :to_json) do
+      %{"this is big"}
+    end
+    json = Oj.dump(orig, :mode => :compat)
+    bg = Oj.load(json, :mode => :compat)
+    assert_equal("this is big", bg)
+    BigDecimal.send(:remove_method, :to_json) # cleanup
+  end
   def test_bigdecimal_object
     mode = Oj.default_options[:mode]
     Oj.default_options = {:mode => :object}
@@ -800,13 +813,7 @@ class Juice < ::Test::Unit::TestCase
     x = Oj.load(json, :mode => :compat)
     # Some Rubies implement Date as data and some as a real Object. Either are
     # okay for the test.
-    if x.is_a?(String)
-      assert_equal(orig.to_s, x)
-    else # better be a Hash
-      assert_equal({ "year" => orig.year, "month" => orig.month, "day" => orig.day,
-                     "hour" => orig.hour, "min" => orig.min, "sec" => orig.sec,
-                     "offset" => orig.offset, "start" => orig.start}, x)
-    end
+    assert_equal(orig.to_s, x)
   end
   def test_datetime_object
     dump_and_load(DateTime.new(2012, 6, 19), false)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oj
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-11 00:00:00.000000000 Z
+date: 2013-02-16 00:00:00.000000000 Z
 dependencies: []
 description: ! 'The fastest JSON parser and object serializer. '
 email: peter@ohler.com