oj-introspect 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8275f7a7bc4675418e94fb048888662e5b9e9292eb0e8a7d3f5bd1cb2c4d6cc
-  data.tar.gz: b8aa813939f082f384d4300cfe56fb41e660c366b18709a0dc8efe97336baa44
+  metadata.gz: 718229e62c9fde37495f36cb674b79025c626a934d188698a0e2c87937566809
+  data.tar.gz: 490a556129f5d13bc29c1b422e0af6cded6d97c88ead6b953ada4abf06ada594
 SHA512:
-  metadata.gz: 965b4a25bd1fa1549dcb20162b0f80a6963d29352a5b2333ddc6590b3b32fa0b25e6627470aa94c327cd103472f62669f47e5c823050d4a5038ba8c6b66b10c8
-  data.tar.gz: 688d27daf26686b8b5dfd71d926d35e3f91adcdb430d21b388dd077fd05f9e2974b296e8eb520543ab7a2f4e1e5587b2152a3437026e8a3d74591e2a436197e4
+  metadata.gz: 92ddcdc95170deef8d6854a879c5c910181ab6a16bbdb175e8d92ab67169ca80ee36d7ddfdcbf3aa45c036955c60d6642c53e45d9bbed3f3584aac61335c83cf
+  data.tar.gz: a45c33ee35937db46ee01819b25264b9d7e9336a014a93edaba0cf878b5ad5d3a4a3303f8357b9848253d2953a50c2679469cc52e62ceabeb462da2616f43338

data/.gitignore

@@ -13,3 +13,4 @@
 *.bundle
 Makefile
 *.o
+*.so

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    oj-introspect (0.4.0)
-      oj (>= 3.13.22)
+    oj-introspect (0.6.0)
+      oj (>= 3.13.23)
 
 GEM
   remote: https://rubygems.org/
@@ -11,7 +11,7 @@ GEM
     coderay (1.1.3)
     diff-lcs (1.5.0)
     method_source (1.0.0)
-    oj (3.13.22)
+    oj (3.13.23)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)

data/bin/benchmark

@@ -5,16 +5,21 @@ require "oj/introspect"
 require "json"
 require "benchmark/ips"
 
-TEST_JSON = '{ "foo": "bar" }'
+TEST_JSON = File.read("./spec/fixtures/vulnerabilities.json")
 
 INTROSPECT_PARSER = Oj::Parser.introspect
+FILTERED_INTROSPECT_PARSER = Oj::Introspect.new(filter: "remediations")
 USUAL_PARSER = Oj::Parser.usual
 
 Benchmark.ips do |b|
-  b.report("Introspected") do
+  b.report("Introspect") do
     INTROSPECT_PARSER.parse(TEST_JSON)
   end
 
+  b.report("Filtered introspect") do
+    FILTERED_INTROSPECT_PARSER.parse(TEST_JSON)
+  end
+
   b.report("Oj usual") do
     USUAL_PARSER.parse(TEST_JSON)
   end

data/ext/oj-introspect/introspect.c

@@ -16,16 +16,24 @@ typedef struct _introspect_S {
   struct _usual usual; // inherit all the attributes from `_usual` struct
   struct _byte_offsets byte_offsets; // I think it's better to encapsulate common fields under a namespace
 
+  char *filter;
+  bool introspect;
+
   void (*delegated_start_func)(struct _ojParser *p);
   void (*delegated_free_func)(struct _ojParser *p);
+  VALUE (*delegated_option_func)(struct _ojParser *p, const char *key, VALUE value);
   void (*delegated_open_object_func)(struct _ojParser *p);
   void (*delegated_open_object_key_func)(struct _ojParser *p);
+  void (*delegated_open_array_key_func)(struct _ojParser *p);
   void (*delegated_close_object_func)(struct _ojParser *p);
-} *IntrospectDelegate;
+  void (*delegated_close_object_key_func)(struct _ojParser *p);
+  void (*delegated_close_array_key_func)(struct _ojParser *p);
+} * IntrospectDelegate;
 
 static void dfree(ojParser p) {
   IntrospectDelegate d = (IntrospectDelegate)p->ctx;
 
+  if(d->filter != NULL) xfree(d->filter);
   xfree(d->byte_offsets.stack);
   d->delegated_free_func(p);
 }
@@ -36,6 +44,32 @@ static void start(ojParser p) {
     d->delegated_start_func(p);
     // Reset to zero so the parser and delegate can be reused.
     d->byte_offsets.current = 0;
+
+    /*
+    * If the `filter` is provided we will start introspecting later
+    * once we encounter with the key provided.
+    */
+    d->introspect = (d->filter == NULL);
+}
+
+static void copy_ruby_str(char **target, VALUE source) {
+  size_t len = RSTRING_LEN(source);
+  *target = ALLOC_N(char, len + 1);
+  memcpy(*target, RSTRING_PTR(source), len);
+  (*target)[len] = '\0'; // Parantheses are important as it means => (*target + sizeof(char) * len)
+}
+
+static VALUE option(ojParser p, const char *key, VALUE value) {
+  IntrospectDelegate d = (IntrospectDelegate)p->ctx;
+
+  if(strcmp(key, "filter=") == 0) {
+    Check_Type(value, T_STRING);
+    copy_ruby_str(&d->filter, value); // We need to copy the value as GC can free it later.
+
+    return Qtrue;
+  }
+
+  return d->delegated_option_func(p, key, value);
 }
 
 static void ensure_byte_offsets_stack(IntrospectDelegate d) {
@@ -65,16 +99,54 @@ static void open_object_introspected(ojParser p) {
   d->delegated_open_object_func(p);
 }
 
+static char * previously_inserted_key(IntrospectDelegate d) {
+  Key key = (d->usual.ktail - 1);
+
+  return ((size_t)key->len < sizeof(key->buf)) ? key->buf : key->key;
+}
+
+static bool should_switch_introspection(IntrospectDelegate d) {
+  return strcmp(d->filter, previously_inserted_key(d)) == 0;
+}
+
+/*
+* WHEN there is a filter
+* AND
+*     WHEN the introspection is disabled
+*     AND the last inserted key matches the filter
+*     THEN enable introspection
+*   OR
+*     WHEN the introspection is enabled
+*     AND the last inserted key matches the filter
+*     THEN disable introspection
+*/
+static void switch_introspection(IntrospectDelegate d) {
+  if(d->filter == NULL) return;
+
+  d->introspect = should_switch_introspection(d) != d->introspect; // a XOR b
+}
+
 static void open_object_key_introspected(ojParser p) {
   push(p);
 
   IntrospectDelegate d = (IntrospectDelegate)p->ctx;
   d->delegated_open_object_key_func(p);
+
+  if(!d->introspect) switch_introspection(d);
+}
+
+static void open_array_key_introspected(ojParser p) {
+  IntrospectDelegate d = (IntrospectDelegate)p->ctx;
+  d->delegated_open_array_key_func(p);
+
+  if(!d->introspect) switch_introspection(d);
 }
 
 static void set_introspection_values(ojParser p) {
     IntrospectDelegate d = (IntrospectDelegate)p->ctx;
 
+    if(!d->introspect) return;
+
     volatile VALUE obj = rb_hash_new();
     rb_hash_aset(obj, ID2SYM(rb_intern("start_byte")), INT2FIX(pop(p)));
     rb_hash_aset(obj, ID2SYM(rb_intern("end_byte")), INT2FIX(p->cur));
@@ -88,6 +160,24 @@ static void close_object_introspected(ojParser p) {
   set_introspection_values(p);
 }
 
+// We switch introspection off only for object and array keys.
+static void close_object_key_introspected(ojParser p) {
+  IntrospectDelegate d = (IntrospectDelegate)p->ctx;
+  d->delegated_close_object_func(p);
+
+  if(d->introspect) {
+    set_introspection_values(p);
+    switch_introspection(d);
+  }
+}
+
+static void close_array_key_introspected(ojParser p) {
+  IntrospectDelegate d = (IntrospectDelegate)p->ctx;
+  d->delegated_close_array_key_func(p);
+
+  if(d->introspect) switch_introspection(d);
+}
+
 static void init_introspect_parser(ojParser p, VALUE ropts) {
   IntrospectDelegate d = ALLOC(struct _introspect_S);
 
@@ -100,12 +190,10 @@ static void init_introspect_parser(ojParser p, VALUE ropts) {
   d->delegated_start_func = p->start;
   p->start = start;
 
-  // We are cheating with the mark, free, and options functions. Since struct
-  // _usual is the first member of struct _introspect the cast to Usual in the
-  // usual.c mark() function should still work just fine.
+  d->delegated_option_func = p->option;
+  p->option = option;
 
-  // PCO - do you need the location of sub-objects and arrays or just top
-  // level objects?
+  // Wrap original functions to collect byte offsets
   Funcs f = &p->funcs[TOP_FUN];
   d->delegated_open_object_func = f->open_object;
   d->delegated_close_object_func = f->close_object;
@@ -117,31 +205,26 @@ static void init_introspect_parser(ojParser p, VALUE ropts) {
   f->close_object = close_object_introspected;
 
   f = &p->funcs[OBJECT_FUN];
+  d->delegated_open_array_key_func = f->open_array;
   d->delegated_open_object_key_func = f->open_object;
+  d->delegated_close_array_key_func = f->close_array;
+  d->delegated_close_object_key_func = f->close_object;
+  f->open_array = open_array_key_introspected;
   f->open_object  = open_object_key_introspected;
-  f->close_object = close_object_introspected;
+  f->close_array = close_array_key_introspected;
+  f->close_object = close_object_key_introspected;
 
   // Init stack
   d->byte_offsets.current = 0;
   d->byte_offsets.stack   = ALLOC_N(long, BYTE_OFFSETS_STACK_INC_SIZE);
   d->byte_offsets.length  = BYTE_OFFSETS_STACK_INC_SIZE;
 
+  d->filter = NULL;
+
   // Process options.
   oj_parser_set_option(p, ropts);
 }
 
-VALUE oj_get_parser_introspect() {
-  VALUE oj_parser = oj_parser_new();
-  struct _ojParser *p;
-  Data_Get_Struct(oj_parser, struct _ojParser, p);
-
-  init_introspect_parser(p, Qnil);
-
-  rb_gc_register_address(&oj_parser);
-
-  return oj_parser;
-}
-
 static VALUE rb_new_introspect_parser(int argc, VALUE *argv, VALUE self) {
   rb_check_arity(argc, 0, 1);
 

data/lib/oj/introspect/version.rb

@@ -1,5 +1,5 @@
 module Oj
   class Introspect
-    VERSION = "0.4.0"
+    VERSION = "0.6.0"
   end
 end

data/oj-introspect.gemspec

@@ -24,5 +24,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.extensions    = ["ext/oj-introspect/extconf.rb"]
 
-  spec.add_dependency "oj", ">=3.13.22"
+  spec.add_dependency "oj", ">=3.13.23"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oj-introspect
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Mehmet Emin INAC
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-02 00:00:00.000000000 Z
+date: 2022-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.13.22
+        version: 3.13.23
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.13.22
+        version: 3.13.23
 description: Embeds start and end byte offsets of JSON objects into generated Ruby
   hashes.
 email: