ref params, impl verbose_error flag

Author: uvlad7

Rakefile

@@ -19,6 +19,7 @@ GEMSPEC = Gem::Specification.load("json_scanner.gemspec")
 
 Rake::ExtensionTask.new("json_scanner", GEMSPEC) do |ext|
   ext.lib_dir = "lib/json_scanner"
+  # https://karottenreibe.github.io/2009/10/30/ruby-c-extension-7/
 end
 
 task default: %i[clobber compile spec rubocop]

ext/json_scanner/json_scanner.c

@@ -3,6 +3,7 @@
 VALUE rb_mJsonScanner;
 VALUE rb_mJsonScannerOptions;
 VALUE rb_eJsonScannerParseError;
+ID scan_kwargs_table[2];
 
 VALUE null_sym;
 VALUE boolean_sym;
@@ -84,7 +85,7 @@ typedef struct
 } scan_ctx;
 
 // FIXME: This will cause memory leak if ruby_xmalloc raises
-scan_ctx *scan_ctx_init(VALUE path_ary, VALUE with_path)
+scan_ctx *scan_ctx_init(VALUE path_ary, int with_path)
 {
   int path_ary_len;
   scan_ctx *ctx;
@@ -134,7 +135,7 @@ scan_ctx *scan_ctx_init(VALUE path_ary, VALUE with_path)
 
   ctx = ruby_xmalloc(sizeof(scan_ctx));
 
-  ctx->with_path = RTEST(with_path);
+  ctx->with_path = with_path;
   ctx->max_path_len = 0;
 
   paths = ruby_xmalloc(sizeof(paths_t) * path_ary_len);
@@ -459,9 +460,12 @@ static yajl_callbacks scan_callbacks = {
     scan_on_start_array,
     scan_on_end_array};
 
-// TODO: make with_path optional kw: `with_path: false`
-VALUE scan(VALUE self, VALUE json_str, VALUE path_ary, VALUE with_path)
+// def scan(json_str, path_arr, with_path: false, verbose_error: false)
+VALUE scan(int argc, VALUE * argv, VALUE self)
 {
+  VALUE json_str, path_ary, kwargs;
+  VALUE kwargs_values[2];
+  int with_path = false, verbose_error = false;
   char *json_text;
   size_t json_text_len;
   yajl_handle handle;
@@ -470,8 +474,12 @@ VALUE scan(VALUE self, VALUE json_str, VALUE path_ary, VALUE with_path)
   VALUE err = Qnil, result;
   // Turned out callbacks can't raise exceptions
   // VALUE callback_err;
-  // TODO
-  int opt_verbose_error = 0;
+  rb_scan_args(argc, argv, "2:", &json_str, &path_ary, &kwargs);
+  if (kwargs != Qnil) {
+    rb_get_kwargs(kwargs, scan_kwargs_table, 0, 2, kwargs_values);
+    if (kwargs_values[0] != Qundef) with_path = RTEST(kwargs_values[0]);
+    if (kwargs_values[1] != Qundef) verbose_error = RTEST(kwargs_values[1]);
+  }
   rb_check_type(json_str, T_STRING);
   json_text = RSTRING_PTR(json_str);
 #if LONG_MAX > SIZE_MAX
@@ -492,7 +500,7 @@ VALUE scan(VALUE self, VALUE json_str, VALUE path_ary, VALUE with_path)
 
   if (stat != yajl_status_ok)
   {
-    char *str = (char *)yajl_get_error(handle, opt_verbose_error, (unsigned char *)json_text, json_text_len);
+    char *str = (char *)yajl_get_error(handle, verbose_error, (unsigned char *)json_text, json_text_len);
     err = rb_str_new_cstr(str);
     yajl_free_error(handle, (unsigned char *)str);
   }
@@ -520,11 +528,13 @@ Init_json_scanner(void)
   rb_define_const(rb_mJsonScannerOptions, "ALLOW_TRAILING_GARBAGE", INT2FIX(yajl_allow_trailing_garbage));
   rb_define_const(rb_mJsonScannerOptions, "ALLOW_MULTIPLE_VALUES", INT2FIX(yajl_allow_multiple_values));
   rb_define_const(rb_mJsonScannerOptions, "ALLOW_PARTIAL_VALUES", INT2FIX(yajl_allow_partial_values));
-  rb_define_module_function(rb_mJsonScanner, "scan", scan, 3);
+  rb_define_module_function(rb_mJsonScanner, "scan", scan, -1);
   null_sym = rb_id2sym(rb_intern("null"));
   boolean_sym = rb_id2sym(rb_intern("boolean"));
   number_sym = rb_id2sym(rb_intern("number"));
   string_sym = rb_id2sym(rb_intern("string"));
   object_sym = rb_id2sym(rb_intern("object"));
   array_sym = rb_id2sym(rb_intern("array"));
+  scan_kwargs_table[0] = rb_intern("with_path");
+  scan_kwargs_table[1] = rb_intern("verbose_error");
 }

spec/json_scanner_spec.rb

@@ -8,15 +8,15 @@
   end
 
   it "scans json" do
-    result = described_class.scan('["1", {"a": 2}]', [[0], [1, "a"], []], false)
+    result = described_class.scan('["1", {"a": 2}]', [[0], [1, "a"], []])
     expect(result).to eq([[[1, 4, :string]], [[12, 13, :number]], [[0, 15, :array]]])
-    expect(described_class.scan('"2"', [[]], false)).to eq([[[0, 3, :string]]])
+    expect(described_class.scan('"2"', [[]])).to eq([[[0, 3, :string]]])
     expect(
-      described_class.scan("[0,1,2,3,4,5,6,7]", [[(0..2)], [(4...6)]], false)
+      described_class.scan("[0,1,2,3,4,5,6,7]", [[(0..2)], [(4...6)]])
     ).to eq(
       [[[1, 2, :number], [3, 4, :number], [5, 6, :number]], [[9, 10, :number], [11, 12, :number]]]
     )
-    expect(described_class.scan('{"a": 1}', [["a"], []], false)).to eq(
+    expect(described_class.scan('{"a": 1}', [["a"], []])).to eq(
       [[[6, 7, :number]], [[0, 8, :object]]]
     )
   end
@@ -28,10 +28,10 @@
         # TODO: investigate
         # got "munmap_chunk(): invalid pointer" in in console once after
         # JsonScanner.scan '[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[]]]]]]]]]]]]]]]]]]]]]]', [[0,0,0,0,0,0,0]], true + Ctrl+D
-        # (last arg wasn't handled at the time)
+        # (last arg wasn't handled at the time and was intended for with_path kwarg)
         # but I don't think it's a problem of tht extension or libyajl, it happened at exit and I free everything before
         # `JsonScanner.scan` returns
-        described_class.scan "[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[]]]]]]]]]]]]]]]]]]]]]]", [[0, 0, 0, 0, 0, 0, 0]], false
+        described_class.scan "[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[[]]]]]]]]]]]]]]]]]]]]]]", [[0, 0, 0, 0, 0, 0, 0]]
       ensure
         GC.stress = false
       end
@@ -40,26 +40,38 @@
 
   it "allows to select ranges" do
     expect(
-      described_class.scan("[[1,2],[3,4]]", [[described_class::ANY_INDEX, described_class::ANY_INDEX]], false)
+      described_class.scan("[[1,2],[3,4]]", [[described_class::ANY_INDEX, described_class::ANY_INDEX]])
     ).to eq(
       [[[2, 3, :number], [4, 5, :number], [8, 9, :number], [10, 11, :number]]]
     )
     expect(
-      described_class.scan("[[1,2],[3,4]]", [[described_class::ANY_INDEX, (0...1)]], false)
+      described_class.scan("[[1,2],[3,4]]", [[described_class::ANY_INDEX, (0...1)]])
     ).to eq(
       [[[2, 3, :number], [8, 9, :number]]]
     )
   end
 
   it "allows only positive or -1 values" do
     expect do
-      described_class.scan("[[1,2],[3,4]]", [[(0...-1)]], false)
+      described_class.scan("[[1,2],[3,4]]", [[(0...-1)]])
     end.to raise_error ArgumentError
     expect do
-      described_class.scan("[[1,2],[3,4]]", [[(0..-2)]], false)
+      described_class.scan("[[1,2],[3,4]]", [[(0..-2)]])
     end.to raise_error ArgumentError
     expect do
-      described_class.scan("[[1,2],[3,4]]", [[(-42..1)]], false)
+      described_class.scan("[[1,2],[3,4]]", [[(-42..1)]])
     end.to raise_error ArgumentError
   end
+
+  it "allows to configure error messages" do
+    expect do
+      described_class.scan "{1}", []
+    end.to raise_error described_class::ParseError, /invalid object key(?!.*\(right here\))/m
+    expect do
+      described_class.scan "{1}", [], verbose_error: false
+    end.to raise_error described_class::ParseError, /invalid object key(?!.*\(right here\))/m
+    expect do
+      described_class.scan "{1}", [], verbose_error: true
+    end.to raise_error described_class::ParseError, /invalid object key(?=.*\(right here\))/m
+  end
 end