quickjs 0.15.0 → 0.15.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e13c4664328e497bb8c2179807e8c110c4709b6df84a9a60f888e5a822075de2
-  data.tar.gz: c43d43f3c0b928798545ecf57bf9956df1912e3867220915dd5b13c8aeb0031f
+  metadata.gz: 8cfe5ee5e8eef08251b2d90c11763cbbfa4c0a5a64e83d201f0e15c576f1c597
+  data.tar.gz: 9a59bb09ba65423d6f09a8afb0e0aa2e5c91b89155fbf6c5b1f15065cefbdbd3
 SHA512:
-  metadata.gz: 581463e6df8d5559f9aa1f91e4512b68f745942d771b2246202d3137a378876c6662db800381abd4dc065b4a6a8acb03f247feda4b78aa9ce1fc31cdd6ed6836
-  data.tar.gz: cd4f64a7d98a75c5e388b99e1cdbd44c6ad4cfc4cd96f8e23259f12aa8cbe18f8c580ad41633cb65c9f77a6f9732fbb6e042b6805cc034a0c4c060f4ecdb3635
+  metadata.gz: 0ab5cb1e220ffcb01350c1ee43e7167710a5cda902945fee155e292352d7c10bd309959c8816a26bcb54fe0ac8291f910156c8d3ad6f64397b71c2e706a2cac0
+  data.tar.gz: acfbac2d942837185453f203debc9280f5a77529307e6ca07f222a26b9377b93fad1531a4db3ccd3e85a18cd264536f73542d92696726ff4d4ed2f3db5c12478

data/README.md

@@ -40,6 +40,13 @@ Quickjs.eval_code(code,
 )
 ```
 
+#### Filename
+
+```rb
+# Label shown in JS stack traces (default: "<code>")
+Quickjs.eval_code(code, filename: 'my_script.js')
+```
+
 #### Timeout
 
 ```rb
@@ -133,6 +140,23 @@ end
 vm.eval_code("greetingTo('Rick')") #=> 'Hello! Rick'
 ```
 
+Pass an `Array` as the name to register the function on an existing JS object (the last element is the method name; preceding elements are the object path):
+
+```rb
+vm = Quickjs::VM.new
+vm.eval_code("const myLib = {}")
+vm.define_function(["myLib", "greetingTo"]) { |name| "Hello, #{name}!" }
+
+vm.eval_code("myLib.greetingTo('Rick')") #=> 'Hello! Rick'
+
+# Deeply nested
+vm.eval_code("const a = { b: { c: {} } }")
+vm.define_function(["a", "b", "c", "double"]) { |x| x * 2 }
+vm.eval_code("a.b.c.double(21)") #=> 42
+```
+
+`define_function` returns the registered name as a `Symbol` (or an `Array` of `Symbol`s for array paths).
+
 A Ruby exception raised inside the block is catchable in JS as an `Error`, and propagates back to Ruby as the original exception type if uncaught in JS.
 
 ```rb
@@ -177,14 +201,20 @@ vm.eval_code('console.log("hello", 42)')
 | `string` | ↔ | `String` | |
 | `true` / `false` | ↔ | `true` / `false` | |
 | `null` | ↔ | `nil` | |
-| `Array` | ↔ | `Array` | via JSON |
-| `Object` | ↔ | `Hash` | via JSON |
+| `Array` | ↔ | `Array` | recursively converted |
+| `Object` | ↔ | `Hash` | recursively converted; keys are always `String` |
+| `function` | → | `Quickjs::Function` — `.source`, `.call(*args, on:)` | |
 | `undefined` | → | `Quickjs::Value::UNDEFINED` | |
 | `NaN` | → | `Quickjs::Value::NAN` | |
 | `Blob` | → | `Quickjs::Blob` — `.size`, `.type`, `.content` | requires `POLYFILL_FILE` |
 | `File` | → | `Quickjs::File` — `.name`, `.last_modified` + Blob attrs | requires `POLYFILL_FILE` |
 | `File` proxy | ← | `::File` | requires `POLYFILL_FILE`; applies to `define_function` return values |
 
+## Acknowledgements
+
+- [@ursm](https://github.com/ursm) — for continuous contributions improving performance and developer experience
+- [@persona-id](https://github.com/persona-id) — for providing real-world use cases that shape the direction of this project
+
 ## License
 
 - `ext/quickjsrb/quickjs`

data/ext/quickjsrb/quickjsrb.c

@@ -57,8 +57,21 @@ typedef struct
 static int rb_hash_entry_to_js(VALUE r_key, VALUE r_val, VALUE extra)
 {
   RbHashToJsArg *arg = (RbHashToJsArg *)extra;
-  VALUE r_key_str = rb_funcall(r_key, rb_intern("to_s"), 0);
-  JS_SetPropertyStr(arg->ctx, arg->j_obj, StringValueCStr(r_key_str), to_js_value(arg->ctx, r_val));
+  const char *key_cstr;
+  if (SYMBOL_P(r_key))
+  {
+    key_cstr = rb_id2name(SYM2ID(r_key));
+  }
+  else if (RB_TYPE_P(r_key, T_STRING))
+  {
+    key_cstr = StringValueCStr(r_key);
+  }
+  else
+  {
+    VALUE r_key_str = rb_funcall(r_key, rb_intern("to_s"), 0);
+    key_cstr = StringValueCStr(r_key_str);
+  }
+  JS_SetPropertyStr(arg->ctx, arg->j_obj, key_cstr, to_js_value(arg->ctx, r_val));
   return ST_CONTINUE;
 }
 
@@ -69,26 +82,23 @@ JSValue to_js_value(JSContext *ctx, VALUE r_value)
   case T_NIL:
     return JS_NULL;
   case T_FIXNUM:
+    return JS_NewInt64(ctx, NUM2LL(r_value));
   case T_FLOAT:
+    return JS_NewFloat64(ctx, NUM2DBL(r_value));
+  case T_BIGNUM:
   {
     VALUE r_str = rb_funcall(r_value, rb_intern("to_s"), 0);
-    char *str = StringValueCStr(r_str);
+    JSValue j_str = JS_NewStringLen(ctx, RSTRING_PTR(r_str), RSTRING_LEN(r_str));
     JSValue j_global = JS_GetGlobalObject(ctx);
     JSValue j_numberClass = JS_GetPropertyStr(ctx, j_global, "Number");
-    JSValue j_str = JS_NewString(ctx, str);
-    JSValue j_stringified = JS_Call(ctx, j_numberClass, JS_UNDEFINED, 1, (JSValueConst *)&j_str);
-    JS_FreeValue(ctx, j_global);
-    JS_FreeValue(ctx, j_numberClass);
+    JSValue j_num = JS_Call(ctx, j_numberClass, JS_UNDEFINED, 1, (JSValueConst *)&j_str);
     JS_FreeValue(ctx, j_str);
-
-    return j_stringified;
+    JS_FreeValue(ctx, j_numberClass);
+    JS_FreeValue(ctx, j_global);
+    return j_num;
   }
   case T_STRING:
-  {
-    char *str = StringValueCStr(r_value);
-
-    return JS_NewString(ctx, str);
-  }
+    return JS_NewStringLen(ctx, RSTRING_PTR(r_value), RSTRING_LEN(r_value));
   case T_SYMBOL:
   {
     if (r_value == QUICKJSRB_SYM(undefinedId))
@@ -100,10 +110,8 @@ JSValue to_js_value(JSContext *ctx, VALUE r_value)
       JS_FreeValue(ctx, j_global);
       return j_nan;
     }
-    VALUE r_str = rb_funcall(r_value, rb_intern("to_s"), 0);
-    char *str = StringValueCStr(r_str);
-
-    return JS_NewString(ctx, str);
+    const char *name = rb_id2name(SYM2ID(r_value));
+    return JS_NewString(ctx, name);
   }
   case T_TRUE:
     return JS_TRUE;
@@ -134,10 +142,7 @@ JSValue to_js_value(JSContext *ctx, VALUE r_value)
       if (!JS_IsUndefined(data->j_file_proxy_creator))
         return quickjsrb_file_to_js(ctx, r_value);
     }
-    if (TYPE(r_value) == T_OBJECT && RTEST(rb_funcall(
-                                         r_value,
-                                         rb_intern("is_a?"),
-                                         1, rb_const_get(rb_cClass, rb_intern("Exception")))))
+    if (rb_obj_is_kind_of(r_value, rb_eException))
     {
       return j_error_from_ruby_error(ctx, r_value);
     }
@@ -265,17 +270,18 @@ VALUE to_rb_value(JSContext *ctx, JSValue j_val)
     return JS_ToBool(ctx, j_val) > 0 ? Qtrue : Qfalse;
   }
   case JS_TAG_STRING:
+  case JS_TAG_STRING_ROPE:
   {
-    int couldntParse;
-    VALUE r_result = rb_protect(r_try_json_parse, to_r_json(ctx, j_val), &couldntParse);
-    if (couldntParse)
-    {
+    // QuickJS keeps long `s += chunk` chains as a rope (JS_TAG_STRING_ROPE)
+    // until something materialises them. JS_ToCStringLen flattens ropes
+    // transparently, so both tags share the same conversion path.
+    size_t len;
+    const char *str = JS_ToCStringLen(ctx, &len, j_val);
+    if (str == NULL)
       return Qnil;
-    }
-    else
-    {
-      return r_result;
-    }
+    VALUE r_str = rb_utf8_str_new(str, (long)len);
+    JS_FreeCString(ctx, str);
+    return r_str;
   }
   case JS_TAG_OBJECT:
   {
@@ -482,16 +488,19 @@ static VALUE r_try_call_proc(VALUE r_try_args)
 
 static JSValue js_quickjsrb_call_global(JSContext *ctx, JSValueConst _this, int argc, JSValueConst *argv, int _magic, JSValue *func_data)
 {
-  const char *funcName = JS_ToCString(ctx, func_data[0]);
+  // func_data[0] holds the Ruby Symbol ID for the defined function (stored by
+  // vm_m_defineGlobalFunction). Looking up by ID avoids a JS_ToCString +
+  // rb_intern round-trip on every call.
+  int64_t key_id;
+  JS_ToInt64(ctx, &key_id, func_data[0]);
 
   VMData *data = JS_GetContextOpaque(ctx);
-  VALUE r_proc = rb_hash_aref(data->defined_functions, ID2SYM(rb_intern(funcName)));
+  VALUE r_proc = rb_hash_aref(data->defined_functions, ID2SYM((ID)key_id));
   // Shouldn't happen
   if (r_proc == Qnil)
   {
-    return JS_ThrowReferenceError(ctx, "Proc `%s` is not defined", funcName); // TODO: Free funcnName
+    return JS_ThrowReferenceError(ctx, "Proc is not defined");
   }
-  JS_FreeCString(ctx, funcName);
 
   VALUE r_call_args = rb_ary_new();
   rb_ary_push(r_call_args, r_proc);
@@ -842,22 +851,36 @@ static VALUE to_rb_return_value(JSContext *ctx, JSValue j_val)
   return result;
 }
 
-static VALUE vm_m_evalCode(VALUE r_self, VALUE r_code)
+static VALUE vm_m_evalCode(int argc, VALUE *argv, VALUE r_self)
 {
   VMData *data;
   TypedData_Get_Struct(r_self, VMData, &vm_type, data);
 
+  VALUE r_code, r_opts;
+  rb_scan_args(argc, argv, "1:", &r_code, &r_opts);
+
   if (!RB_TYPE_P(r_code, T_STRING))
   {
     VALUE r_code_class = rb_class_name(CLASS_OF(r_code));
     rb_raise(rb_eTypeError, "JavaScript code must be a String, got %s", StringValueCStr(r_code_class));
   }
 
+  const char *filename = "<code>";
+  if (!NIL_P(r_opts))
+  {
+    VALUE r_filename = rb_hash_aref(r_opts, ID2SYM(rb_intern("filename")));
+    if (!NIL_P(r_filename))
+    {
+      Check_Type(r_filename, T_STRING);
+      filename = StringValueCStr(r_filename);
+    }
+  }
+
   clock_gettime(CLOCK_MONOTONIC, &data->eval_time->started_at);
   JS_SetInterruptHandler(JS_GetRuntime(data->context), interrupt_handler, data->eval_time);
 
-  char *code = StringValueCStr(r_code);
-  JSValue j_codeResult = JS_Eval(data->context, code, strlen(code), "<code>", JS_EVAL_TYPE_GLOBAL | JS_EVAL_FLAG_ASYNC);
+  StringValue(r_code);
+  JSValue j_codeResult = JS_Eval(data->context, RSTRING_PTR(r_code), RSTRING_LEN(r_code), filename, JS_EVAL_TYPE_GLOBAL | JS_EVAL_FLAG_ASYNC);
   JSValue j_awaitedResult = js_std_await(data->context, j_codeResult); // This frees j_codeResult
   // JS_EVAL_FLAG_ASYNC wraps the result in {value, done} — extract the actual value
   // Free j_awaitedResult before to_rb_return_value because it may raise (longjmp), which would skip cleanup
@@ -904,7 +927,7 @@ static VALUE vm_m_defineGlobalFunction(int argc, VALUE *argv, VALUE r_self)
     char *funcName = StringValueCStr(r_func_seg_str);
 
     JSValueConst ruby_data[2];
-    ruby_data[0] = JS_NewString(data->context, StringValueCStr(r_key_str));
+    ruby_data[0] = JS_NewInt64(data->context, (int64_t)SYM2ID(r_key_sym));
     ruby_data[1] = JS_NewBool(data->context, RTEST(rb_funcall(r_flags, rb_intern("include?"), 1, ID2SYM(rb_intern("async")))));
 
     // Resolve the parent object to attach the function to.
@@ -969,7 +992,7 @@ static VALUE vm_m_defineGlobalFunction(int argc, VALUE *argv, VALUE r_self)
     char *funcName = StringValueCStr(r_name_str);
 
     JSValueConst ruby_data[2];
-    ruby_data[0] = JS_NewString(data->context, funcName);
+    ruby_data[0] = JS_NewInt64(data->context, (int64_t)SYM2ID(r_name_sym));
     ruby_data[1] = JS_NewBool(data->context, RTEST(rb_funcall(r_flags, rb_intern("include?"), 1, ID2SYM(rb_intern("async")))));
 
     JSValue j_global = JS_GetGlobalObject(data->context);
@@ -1196,7 +1219,7 @@ RUBY_FUNC_EXPORTED void Init_quickjsrb(void)
   VALUE r_class_vm = rb_define_class_under(r_module_quickjs, "VM", rb_cObject);
   rb_define_alloc_func(r_class_vm, vm_alloc);
   rb_define_method(r_class_vm, "initialize", vm_m_initialize, -1);
-  rb_define_method(r_class_vm, "eval_code", vm_m_evalCode, 1);
+  rb_define_method(r_class_vm, "eval_code", vm_m_evalCode, -1);
   rb_define_method(r_class_vm, "call", vm_m_callGlobalFunction, -1);
   rb_define_method(r_class_vm, "define_function", vm_m_defineGlobalFunction, -1);
   rb_define_method(r_class_vm, "import", vm_m_import, -1);

data/lib/quickjs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Quickjs
-  VERSION = "0.15.0"
+  VERSION = "0.15.2"
 end

data/lib/quickjs.rb

@@ -18,8 +18,10 @@ module Quickjs
   end
 
   def eval_code(code, overwrite_opts = {})
+    eval_opts = {}
+    eval_opts[:filename] = overwrite_opts.delete(:filename) if overwrite_opts.key?(:filename)
     vm = Quickjs::VM.new(**overwrite_opts)
-    res = vm.eval_code(code)
+    res = vm.eval_code(code, **eval_opts)
     vm = nil
     res
   end

data/polyfills/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "quickjs-rb-polyfills",
-  "version": "0.15.0",
+  "version": "0.15.1",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "quickjs-rb-polyfills",
-      "version": "0.15.0",
+      "version": "0.15.1",
       "dependencies": {
         "@formatjs/intl-datetimeformat": "^7.3.1",
         "@formatjs/intl-getcanonicallocales": "^3.2.2",

data/polyfills/package.json

@@ -1,6 +1,6 @@
 {
   "name": "quickjs-rb-polyfills",
-  "version": "0.15.0",
+  "version": "0.15.2",
   "private": true,
   "scripts": {
     "build": "rolldown -c rolldown.config.mjs",

data/sig/quickjs.rbs

@@ -21,7 +21,7 @@ module Quickjs
   class VM
     def initialize: (?features: Array[Symbol], ?memory_limit: Integer, ?max_stack_size: Integer, ?timeout_msec: Integer) -> void
 
-    def eval_code: (String code) -> untyped
+    def eval_code: (String code, ?filename: String) -> untyped
 
     def call: (String | Symbol name, *untyped args) -> untyped
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quickjs
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.15.2
 platform: ruby
 authors:
 - hmsk