oj 2.9.6 → 2.9.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa935c82f850cb8bacad4b1dfdbeebdfd0af777f
-  data.tar.gz: 1bf95c9767bb1ee814871a859fd2312fbe00dd28
+  metadata.gz: 46cf0f951fe71b68f7df69debe2b80be4fa37539
+  data.tar.gz: 3988bbf389028c52969cdd2702671b37d78a7f9f
 SHA512:
-  metadata.gz: 10e76efb7219459edcc77fec2518dc1c9e036cfa7a2f7c3d49942b3b26085d3b45a25fae451c934eadc087656abc7d2678813de3be7496e5665bb9f7c6278d05
-  data.tar.gz: 4643da9813d1664bbbf06bd6ca7a29e3a9c5fac54d0750ac0fc05e25ea6c72cbab825eaf5901cd029eccff9f00eeb7e3d6fcc3c761a37793452f85b81685540e
+  metadata.gz: 0a2e47552a218ebe9d1c0e58e134fa1a5eb36ad0754e72c638d15a528ff12093b5cc1a7587ab61c4491ea046a4c5186562f2f0916f936485a6b31296ba37de0a
+  data.tar.gz: d996faa5d574f3e5146e872bb4e863f2a286d6b9017d2679db7d570154341f4d0813bd06db5bf672e704d73a184c14769e653280a032e6286286035e71acd76d

data/README.md

@@ -26,7 +26,26 @@ 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.9.6
+### Current Release 2.9.7
+
+ - Changed dump to use raw / and raw \n in output instead of escaping.
+
+ - Changed the writer to always put a new line at the end of a top level JSON
+   object. It makes output easier to view and edit with minimal impact on size.
+
+ - TBD Worked around the file.gets look ahead caching as long as it is not
+   called while parsing (of course).
+
+ - Thanks to lautis for a new parse option. quirks_mode allows Oj to behave
+   quirky like the JSON gem. Actually the JSON gem has it backwards with quirky
+   mode supporting the JSON spec and non-quirky limiting parsing to objects and
+   arrays. Oj stays consistent with the JSON gem to avoid confusion.
+
+ - Fixed problem with sc_parse not terminating the string when loaded from a file.
+
+ - Thanks go to dchelimsky for expanding the code sample for the ScHandler.
+
+### Release 2.9.6
 
  - Fixed bug using StringIO with SCParser.
 

data/ext/oj/dump.c

@@ -112,8 +112,8 @@ static void	dump_leaf_hash(Leaf leaf, int depth, Out out);
 static const char	hex_chars[17] = "0123456789abcdef";
 
 static char	hibit_friendly_chars[256] = "\
-66666666222622666666666666666666\
-11211111111111121111111111111111\
+66666666221622666666666666666666\
+11211111111111111111111111111111\
 11111111111111111111111111112111\
 11111111111111111111111111111111\
 11111111111111111111111111111111\
@@ -2313,7 +2313,7 @@ oj_str_writer_pop(StrWriter sw) {
 	*sw->out.cur++ = ']';
 	break;
     }
-    if (0 == sw->depth && 0 < sw->out.indent) {
+    if (0 == sw->depth) {
 	*sw->out.cur++ = '\n';
     }
 }

data/ext/oj/oj.c

@@ -67,6 +67,7 @@ ID	oj_instance_variables_id;
 ID	oj_json_create_id;
 ID	oj_length_id;
 ID	oj_new_id;
+ID	oj_pos_id;
 ID	oj_read_id;
 ID	oj_readpartial_id;
 ID	oj_replace_id;
@@ -116,6 +117,7 @@ static VALUE	mode_sym;
 static VALUE	nilnil_sym;
 static VALUE	null_sym;
 static VALUE	object_sym;
+static VALUE	quirks_mode_sym;
 static VALUE	ruby_sym;
 static VALUE	sec_prec_sym;
 static VALUE	strict_sym;
@@ -165,6 +167,7 @@ struct _Options	oj_default_options = {
     10,			// create_id_len
     9,			// sec_prec
     Yes,		// allow_gc
+    Yes,		// quirks_mode
     0,			// dump_opts
 };
 
@@ -188,6 +191,7 @@ static VALUE	define_mimic_json(int argc, VALUE *argv, VALUE self);
  * - 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)
+ * - quirks_mode: [true,|false|nil] Allow single JSON values instead of documents, default is true (allow)
  * @return [Hash] all current option settings.
  */
 static VALUE
@@ -204,6 +208,7 @@ get_def_opts(VALUE self) {
     rb_hash_aset(opts, use_to_json_sym, (Yes == oj_default_options.to_json) ? Qtrue : ((No == oj_default_options.to_json) ? Qfalse : Qnil));
     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));
     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;
@@ -265,6 +270,7 @@ get_def_opts(VALUE self) {
  * @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)
+ * @param [true|false|nil] :quirks_mode allow single JSON values instead of documents, default is true (allow)
  * @return [nil]
  */
 static VALUE
@@ -278,6 +284,7 @@ set_def_opts(VALUE self, VALUE opts) {
 	{ use_to_json_sym, &oj_default_options.to_json },
 	{ nilnil_sym, &oj_default_options.nilnil },
 	{ allow_gc_sym, &oj_default_options.allow_gc },
+	{ quirks_mode_sym, &oj_default_options.quirks_mode },
 	{ Qnil, 0 }
     };
     YesNoOpt	o;
@@ -410,6 +417,7 @@ oj_parse_options(VALUE ropts, Options copts) {
 	{ use_to_json_sym, &copts->to_json },
 	{ nilnil_sym, &copts->nilnil },
 	{ allow_gc_sym, &copts->allow_gc },
+	{ quirks_mode_sym, &copts->quirks_mode },
 	{ Qnil, 0 }
     };
     YesNoOpt	o;
@@ -1225,9 +1233,10 @@ stream_writer_new(int argc, VALUE *argv, VALUE self) {
     }
     sw = ALLOC(struct _StreamWriter);
     str_writer_init(&sw->sw);
-    if (1 == argc) {
-	oj_parse_options(argv[0], &sw->sw.opts);
+    if (2 == argc) {
+	oj_parse_options(argv[1], &sw->sw.opts);
     }
+    sw->sw.out.indent = sw->sw.opts.indent;
     sw->stream = stream;
     sw->type = type;
     sw->fd = fd;
@@ -1614,7 +1623,6 @@ static VALUE
 mimic_parse(int argc, VALUE *argv, VALUE self) {
     struct _ParseInfo	pi;
     VALUE		args[1];
-    VALUE		result;
 
     if (argc < 1) {
 	rb_raise(rb_eArgError, "Wrong number of arguments to parse.");
@@ -1622,6 +1630,8 @@ mimic_parse(int argc, VALUE *argv, VALUE self) {
     oj_set_compat_callbacks(&pi);
     pi.options = oj_default_options;
     pi.options.auto_define = No;
+    pi.options.quirks_mode = No;
+
     if (2 <= argc) {
 	VALUE	ropts = argv[1];
 	VALUE	v;
@@ -1632,6 +1642,11 @@ mimic_parse(int argc, VALUE *argv, VALUE self) {
 	if (Qnil != (v = rb_hash_lookup(ropts, symbolize_names_sym))) {
 	    pi.options.sym_key = (Qtrue == v) ? Yes : No;
 	}
+
+	if (Qnil != (v = rb_hash_lookup(ropts, quirks_mode_sym))) {
+	    pi.options.quirks_mode = (Qtrue == v) ? Yes : No;
+	}
+
 	if (Qnil != (v = rb_hash_lookup(ropts, create_additions_sym))) {
 	    if (Qfalse == v) {
 		oj_set_strict_callbacks(&pi);
@@ -1644,22 +1659,7 @@ mimic_parse(int argc, VALUE *argv, VALUE self) {
     }
     *args = *argv;
 
-    result = oj_pi_parse(1, args, &pi, 0, 0, 0);
-    switch (rb_type(result)) {
-    case T_NIL:
-    case T_TRUE:
-    case T_FALSE:
-    case T_FIXNUM:
-    case T_FLOAT:
-    case T_CLASS:
-    case T_SYMBOL:
-	rb_raise(oj_parse_error_class, "parse is only allowed to return data structure.");
-	break;
-    default:
-	// okay
-	break;
-    }
-    return result;
+    return oj_pi_parse(1, args, &pi, 0, 0, 0);
 }
 
 static VALUE
@@ -1713,6 +1713,7 @@ static struct _Options	mimic_object_to_json_options = {
     10,			// create_id_len
     9,			// sec_prec
     Yes,		// allow_gc
+    Yes,		// quirks_mode
     0,			// dump_opts
 };
 
@@ -1952,6 +1953,7 @@ void Init_oj() {
     oj_json_create_id = rb_intern("json_create");
     oj_length_id = rb_intern("length");
     oj_new_id = rb_intern("new");
+    oj_pos_id = rb_intern("pos");
     oj_read_id = rb_intern("read");
     oj_readpartial_id = rb_intern("readpartial");
     oj_replace_id = rb_intern("replace");
@@ -2002,6 +2004,7 @@ void Init_oj() {
     mode_sym = ID2SYM(rb_intern("mode"));		rb_gc_register_address(&mode_sym);
     null_sym = ID2SYM(rb_intern("null"));		rb_gc_register_address(&null_sym);
     object_sym = ID2SYM(rb_intern("object"));		rb_gc_register_address(&object_sym);
+    quirks_mode_sym = ID2SYM(rb_intern("quirks_mode"));	rb_gc_register_address(&quirks_mode_sym);
     ruby_sym = ID2SYM(rb_intern("ruby"));		rb_gc_register_address(&ruby_sym);
     sec_prec_sym = ID2SYM(rb_intern("second_precision"));rb_gc_register_address(&sec_prec_sym);
     strict_sym = ID2SYM(rb_intern("strict"));		rb_gc_register_address(&strict_sym);

data/ext/oj/oj.h

@@ -141,6 +141,7 @@ typedef struct _Options {
     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;
 } *Options;
 
@@ -262,6 +263,7 @@ extern ID	oj_instance_variables_id;
 extern ID	oj_json_create_id;
 extern ID	oj_length_id;
 extern ID	oj_new_id;
+extern ID	oj_pos_id;
 extern ID	oj_read_id;
 extern ID	oj_readpartial_id;
 extern ID	oj_replace_id;

data/ext/oj/parse.c

@@ -873,5 +873,23 @@ oj_pi_parse(int argc, VALUE *argv, ParseInfo pi, char *json, size_t len, int yie
     if (err_has(&pi->err)) {
 	oj_err_raise(&pi->err);
     }
+
+    if (pi->options.quirks_mode == No) {
+	switch (rb_type(result)) {
+            case T_NIL:
+	    case T_TRUE:
+	    case T_FALSE:
+	    case T_FIXNUM:
+	    case T_FLOAT:
+	    case T_CLASS:
+	    case T_SYMBOL:
+		rb_raise(oj_parse_error_class, "unexpected non-document value");
+		break;
+	    default:
+		// okay
+		break;
+	}
+    }
+
     return result;
 }

data/ext/oj/reader.c

@@ -86,7 +86,9 @@ oj_reader_init(Reader reader, VALUE io, int fd) {
     } else if (rb_respond_to(io, oj_readpartial_id)) {
 	VALUE	rfd;
 
-	if (rb_respond_to(io, oj_fileno_id) && Qnil != (rfd = rb_funcall(io, oj_fileno_id, 0))) {
+	if (rb_respond_to(io, oj_fileno_id) && Qnil != (rfd = rb_funcall(io, oj_fileno_id, 0)) &&
+	    rb_respond_to(io, oj_pos_id) && 0 == FIX2INT(rb_funcall(io, oj_pos_id, 0))) {
+
 	    reader->read_func = read_from_fd;
 	    reader->fd = FIX2INT(rfd);
 	} else {
@@ -96,7 +98,9 @@ oj_reader_init(Reader reader, VALUE io, int fd) {
     } else if (rb_respond_to(io, oj_read_id)) {
 	VALUE	rfd;
 
-	if (rb_respond_to(io, oj_fileno_id) && Qnil != (rfd = rb_funcall(io, oj_fileno_id, 0))) {
+	if (rb_respond_to(io, oj_fileno_id) && Qnil != (rfd = rb_funcall(io, oj_fileno_id, 0)) &&
+	    rb_respond_to(io, oj_pos_id) && 0 == FIX2INT(rb_funcall(io, oj_pos_id, 0))) {
+
 	    reader->read_func = read_from_fd;
 	    reader->fd = FIX2INT(rfd);
 	} else {

data/ext/oj/scp.c

@@ -275,7 +275,8 @@ oj_sc_parse(int argc, VALUE *argv, VALUE self) {
 	    size_t	len = lseek(fd, 0, SEEK_END);
 
 	    lseek(fd, 0, SEEK_SET);
-	    buf = ALLOC_N(char, len);
+	    buf = ALLOC_N(char, len + 1);
+	    buf[len] = '\0';
 	    pi.json = buf;
 	    pi.end = buf + len;
 	    if (0 >= (cnt = read(fd, (char*)pi.json, len)) || cnt != (ssize_t)len) {

data/lib/oj/schandler.rb

@@ -6,22 +6,37 @@ module Oj
   # methods.
   #
   # @example
-  # 
+  #
   #  require 'oj'
   #
   #  class MyHandler < ::Oj::ScHandler
-  #    def initialize()
-  #      @hash_cnt = 0
+  #    def hash_start
+  #      {}
+  #    end
+  #
+  #    def hash_set(h,k,v)
+  #      h[k] = v
+  #    end
+  #
+  #    def array_start
+  #      []
+  #    end
+  #
+  #    def array_append(a,v)
+  #      a << v
+  #    end
+  #
+  #    def add_value(v)
+  #      p v
   #    end
   #
-  #    def hash_start()
-  #      @hash_cnt += 1
+  #    def error(message, line, column)
+  #      p "ERROR: #{message}"
   #    end
   #  end
   #
-  #  cnt = MyHandler.new()
   #  File.open('any.json', 'r') do |f|
-  #    Oj.sc_parse(cnt, f)
+  #    Oj.sc_parse(MyHandler.new, f)
   #  end
   #
   # To make the desired methods active while parsing the desired method should
@@ -45,37 +60,37 @@ module Oj
   # When a JSON object element starts the hash_start() callback is called if
   # public. It should return what ever Ruby Object is to be used as the element
   # that will later be included in the hash_set() callback.
-  # 
+  #
   #    hash_end
-  # 
+  #
   # At the end of a JSON object element the hash_end() callback is called if public.
-  # 
+  #
   #    hash_set
-  # 
+  #
   # When a key value pair is encountered during parsing the hash_set() callback
   # is called if public. The first element will be the object returned from the
   # enclosing hash_start() callback. The second argument is the key and the last
   # is the value.
-  # 
+  #
   #    array_start
-  # 
+  #
   # When a JSON array element is started the array_start() callback is called if
   # public. It should return what ever Ruby Object is to be used as the element
   # that will later be included in the array_append() callback.
-  # 
+  #
   #    array_end
-  # 
+  #
   # At the end of a JSON array element the array_end() callback is called if public.
-  # 
+  #
   #    array_append
-  # 
+  #
   # When a element is encountered that is an element of an array the
   # array_append() callback is called if public. The first argument to the
   # callback is the Ruby object returned from the enclosing array_start()
   # callback.
-  # 
+  #
   #    add_value
-  # 
+  #
   # The handler is expected to handle multiple JSON elements in one stream,
   # file, or string. When a top level JSON has been read completely the
   # add_value() callback is called. Even if only one element was ready this
@@ -99,7 +114,7 @@ module Oj
 
     def hash_set(h, key, value)
     end
-    
+
     def array_start()
     end
 
@@ -108,7 +123,7 @@ module Oj
 
     def add_value(value)
     end
-    
+
     def array_append(a, value)
     end
 

data/lib/oj/version.rb

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

data/test/bug.rb

@@ -7,10 +7,47 @@ $: << File.dirname(__FILE__)
 
 require 'helper'
 
-File.open('tst', 'r') do |file|
-  puts file.gets
-  puts file.read(1)
-  Oj.load(file) do |val|
-    puts "*** inside: #{val}"
+class Handler
+  def initialize
+    @state = []
+  end
+
+  def hash_start
+    @state << {}
+    @state.last
   end
+
+  def hash_end
+    @state.pop
+  end
+
+  def hash_set(h,k,v)
+    h.store(k,v)
+  end
+
+  def array_start
+    @state << []
+    @state.last
+  end
+
+
+  def array_end
+    @state.pop
+  end
+
+  def array_append(a,v)
+    a << v
+  end
+
+  def add_value(v)
+    p v
+  end
+
+  def error(message, line, column); p "ERROR: #{message}" end
+end
+
+$handler = Handler.new
+
+File.open('tst', 'r') do |file|
+  Oj.sc_parse($handler, file)
 end

data/test/isolated/shared.rb

@@ -98,6 +98,13 @@ class SharedMimicTest < Minitest::Test
            "children don't match")
   end
 
+  def test_parse_with_quirks_mode
+    json = %{null}
+    assert_equal(nil, JSON.parse(json, :quirks_mode => true))
+    assert_raises(JSON::ParserError) { JSON.parse(json, :quirks_mode => false) }
+    assert_raises(JSON::ParserError) { JSON.parse(json) }
+  end
+
 # []
   def test_bracket_load
     json = %{{"a":1,"b":[true,false]}}

data/test/test_various.rb

@@ -1116,6 +1116,11 @@ class Juice < Minitest::Test
     assert_equal(nil, obj)
   end
 
+  def test_quirks_mode
+    assert_raises(Oj::ParseError) { Oj.load("null", :quirks_mode => false) }
+    assert_equal nil, Oj.load("null", :quirks_mode => true)
+  end
+
   def dump_and_load(obj, trace=false)
     json = Oj.dump(obj, :indent => 2)
     puts json if trace

data/test/test_writer.rb

@@ -19,7 +19,7 @@ class OjWriter < Minitest::Test
     w = Oj::StringWriter.new(:indent => 0)
     w.push_array()
     w.pop()
-    assert_equal('[]', w.to_s)
+    assert_equal("[]\n", w.to_s)
   end
 
   def test_string_writer_nested_array
@@ -34,14 +34,14 @@ class OjWriter < Minitest::Test
     w.push_array()
     w.pop()
     w.pop()
-    assert_equal('[[],[[]],[]]', w.to_s)
+    assert_equal("[[],[[]],[]]\n", w.to_s)
   end
 
   def test_string_writer_empty_object
     w = Oj::StringWriter.new(:indent => 0)
     w.push_object()
     w.pop()
-    assert_equal('{}', w.to_s)
+    assert_equal("{}\n", w.to_s)
   end
 
   def test_string_writer_nested_object
@@ -56,7 +56,7 @@ class OjWriter < Minitest::Test
     w.push_object("a3")
     w.pop()
     w.pop()
-    assert_equal('{"a1":{},"a2":{"b":{}},"a3":{}}', w.to_s)
+    assert_equal(%|{"a1":{},"a2":{"b":{}},"a3":{}}\n|, w.to_s)
   end
 
   def test_string_writer_nested_key
@@ -76,7 +76,7 @@ class OjWriter < Minitest::Test
     w.push_value(37)
     w.pop()
     w.pop()
-    assert_equal('{"a1":{},"a2":{"b":{}},"a3":{"a4":37}}', w.to_s)
+    assert_equal(%|{"a1":{},"a2":{"b":{}},"a3":{"a4":37}}\n|, w.to_s)
   end
 
   def test_string_writer_value_array
@@ -118,7 +118,7 @@ class OjWriter < Minitest::Test
         w.push_value(3)
       }
     }
-    assert_equal('{"a1":{"a7":7},"a2":["x",3]}', w.to_s)
+    assert_equal(%|{"a1":{"a7":7},"a2":["x",3]}\n|, w.to_s)
   end
 
   def test_string_writer_json
@@ -131,7 +131,7 @@ class OjWriter < Minitest::Test
     w.push_json('{"a":65}', 'x')
     w.pop()
     w.pop()
-    assert_equal('[7,true,"a string",{"x":{"a":65}}]', w.to_s)
+    assert_equal(%|[7,true,"a string",{"x":{"a":65}}]\n|, w.to_s)
   end
 
   def test_string_writer_pop_excess
@@ -206,7 +206,7 @@ class OjWriter < Minitest::Test
     w.push_value(3)
     w.push_array()
     w.pop_all()
-    assert_equal('{"a1":{},"a2":[3,[]]}', w.to_s)
+    assert_equal(%|{"a1":{},"a2":[3,[]]}\n|, w.to_s)
   end
 
   def test_string_writer_reset
@@ -224,7 +224,7 @@ class OjWriter < Minitest::Test
     w = Oj::StreamWriter.new(output, :indent => 0)
     w.push_array()
     w.pop()
-    assert_equal('[]', output.string())
+    assert_equal("[]\n", output.string())
   end
 
   def test_stream_writer_mixed_stringio
@@ -243,7 +243,7 @@ class OjWriter < Minitest::Test
     w.push_object("a3")
     w.pop()
     w.pop()
-    assert_equal('{"a1":{},"a2":{"b":[7,true,"string"]},"a3":{}}', output.string())
+    assert_equal(%|{"a1":{},"a2":{"b":[7,true,"string"]},"a3":{}}\n|, output.string())
   end
 
   def test_stream_writer_mixed_file
@@ -265,7 +265,7 @@ class OjWriter < Minitest::Test
       w.pop()
     end
     content = File.read(filename)
-    assert_equal('{"a1":{},"a2":{"b":[7,true,"string"]},"a3":{}}', content)
+    assert_equal(%|{"a1":{},"a2":{"b":[7,true,"string"]},"a3":{}}\n|, content)
   end
 
   def test_stream_writer_nested_key_object
@@ -286,7 +286,7 @@ class OjWriter < Minitest::Test
     w.push_value(37)
     w.pop()
     w.pop()
-    assert_equal('{"a1":{},"a2":{"b":{}},"a3":{"a4":37}}', output.string())
+    assert_equal(%|{"a1":{},"a2":{"b":{}},"a3":{"a4":37}}\n|, output.string())
   end
 
 end # OjWriter

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oj
 version: !ruby/object:Gem::Version
-  version: 2.9.6
+  version: 2.9.7
 platform: ruby
 authors:
 - Peter Ohler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-15 00:00:00.000000000 Z
+date: 2014-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler