quickjs 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6466e18ce71a5c30009887601f27eea994bb53b055f023de2052fe1dfac5e4f0
-  data.tar.gz: 80868dca91c750a6686569550f9fed2e053949443aa9805e032d740cbeb6a914
+  metadata.gz: 16b9d276d5d05c5f7cf5ff981573283fa990064d55e60b02dc86f773c892c9a0
+  data.tar.gz: bf3e2ebee03197fdead070a974d40485c77bab90a7ab5153274a3cfb48a7ea4b
 SHA512:
-  metadata.gz: 977dd9ff96e91f4bb340ac3799d65464ab257635a064a56210bacb8f8e0de04010546fde2bd6207455b073c9e88557fc43aa871fd7d8056b9d3fdecb936f445e
-  data.tar.gz: 7060cbd9b83e6968d39761398ae7a7137efc77f8c662e10e41b77f5f1edaa2bd281e6f90a3ff32ba4f94001ff0d10371e2414c26ffd2e9d6490de725c90c21ec
+  metadata.gz: 4f9431993a243c908c905c25a13c8679f17d3404699a87868c6a195f2eeb0b0e2f1c76716bf4564e076a189f20302ef1d6ade01a763e7827fdc5a4229f23be2c
+  data.tar.gz: 85505319f063a8f1e5c8c42dc4de7d483f9a3e3deb4599203d2d55d2c79d206d26385f8a139a67a87f753cab67fa74f2a74b0ed6f2a864fd5bd37c2588762881

data/CHANGELOG.md

@@ -1,4 +1,4 @@
-## [0.1.3] - 2024-06-14
+## [0.1.4] - 2024-06-14
 
 - Initial release
   - See `test/quickjs_test.rb` for supported features

data/README.md

@@ -0,0 +1,98 @@
+# quickjs.rb
+
+A Ruby wrapper for [QuickJS](https://bellard.org/quickjs) to run JavaScript codes via Ruby with a smaller footprint.
+
+[![Gem Version](https://img.shields.io/gem/v/quickjs?style=for-the-badge)](https://rubygems.org/gems/quickjs) [![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/hmsk/quickjs.rb/main.yml?style=for-the-badge)](https://github.com/hmsk/quickjs.rb/actions/workflows/main.yml)
+
+
+## Installation
+
+```
+gem install quickjs
+```
+
+```rb
+gem 'quickjs'
+```
+
+## Usage
+
+### `Quickjs.eval_code`: Evaluate JavaScript code instantly
+
+```rb
+require 'quickjs'
+
+Quickjs.eval_code('const fn = (n, pow) => n ** pow; fn(2,8);') # => 256
+Quickjs.eval_code('const fn = (name) => `Hi, ${name}!`; fn("Itadori");') # => "Hi, Itadori!
+Quickjs.eval_code("const isOne = (n) => 1 === n; func(1);") #=> true (TrueClass)
+Quickjs.eval_code("const isOne = (n) => 1 === n; func(3);") #=> false (FalseClass)
+
+# When code returns 'object' for `typeof`, the result is converted via JSON.stringify (JS) -> JSON.parse (Ruby)
+Quickjs.eval_code("[1,2,3]") #=> [1, 2, 3] (Array)
+Quickjs.eval_code("({ a: '1', b: 1 })") #=> { 'a' => '1', 'b' => 1 } (Hash)
+
+Quickjs.eval_code("null") #=> nil
+Quickjs.eval_code('const obj = {}; obj.missingKey;') # => :undefined (Quickjs::Value::Undefined)
+Quickjs.eval_code("Number('whatever')") #=> :NaN (Quickjs::Value::NAN)
+```
+
+#### Limit resources
+
+```rb
+# 1GB memory limit
+Quickjs.eval_code(code, { memoryLimit: 1024 ** 3 })
+
+# 1MB max stack size
+Quickjs.eval_code(code, { memoryLimit: 1024 ** 2 })
+```
+
+#### Enable built-in modules
+
+```rb
+# enable std module
+# https://bellard.org/quickjs/quickjs.html#std-module
+Quickjs.eval_code(code, { features: [Quickjs::MODULE_STD] })
+
+# enable os module
+# https://bellard.org/quickjs/quickjs.html#os-module
+Quickjs.eval_code(code, { features: [Quickjs::MODULE_OS] })
+```
+
+### Maintain a consistent VM/runtime
+
+```rb
+vm = Quickjs::VM.new
+vm.eval_code('const a = { b: "c" };')
+vm.eval_code('a.b;') #=> "c"
+vm.eval_code('a.b = "d";')
+vm.eval_code('a.b;') #=> "d"
+```
+
+#### Config VM
+
+```rb
+vm = Quickjs::VM.new(
+  memory_limit: 1024 * 1024,
+  max_stack_size: 1024 * 1024,
+)
+```
+
+```rb
+vm = Quickjs::VM.new(
+  features: [::Quickjs::MODULE_STD],
+)
+vm = Quickjs::VM.new(
+  features: [::Quickjs::MODULE_OS],
+)
+```
+
+#### Dispose VM explicitly
+
+```rb
+vm.dispose!
+```
+
+## License
+
+Every file in `ext/quickjsrb/quickjs` is licensed under [the MIT License Copyright 2017-2021 by Fabrice Bellard and Charlie Goron](/ext/quickjsrb/quickjs/LICENSE).
+For otherwise, [the MIT License, Copyright 2024 by Kengo Hamasaki](/LICENSE).

data/ext/quickjsrb/quickjsrb.c

@@ -1,107 +1,205 @@
 #include "quickjsrb.h"
 
 VALUE rb_mQuickjs;
-VALUE rb_mQuickjsValue;
 const char *undefinedId = "undefined";
 const char *nanId = "NaN";
 
-VALUE rb_module_eval_js_code(
-  VALUE klass,
-  VALUE r_code,
-  VALUE r_memoryLimit,
-  VALUE r_maxStackSize,
-  VALUE r_enableStd,
-  VALUE r_enableOs
-) {
-  JSRuntime *rt = JS_NewRuntime();
-  JSContext *ctx = JS_NewContext(rt);
-
-  JS_SetMemoryLimit(rt, NUM2UINT(r_memoryLimit));
-  JS_SetMaxStackSize(rt, NUM2UINT(r_maxStackSize));
-
-  JS_AddIntrinsicBigFloat(ctx);
-  JS_AddIntrinsicBigDecimal(ctx);
-  JS_AddIntrinsicOperators(ctx);
-  JS_EnableBignumExt(ctx, TRUE);
-
-  JS_SetModuleLoaderFunc(rt, NULL, js_module_loader, NULL);
-  js_std_add_helpers(ctx, 0, NULL);
-
-  js_std_init_handlers(rt);
-  if (r_enableStd == Qtrue) {
-    js_init_module_std(ctx, "std");
-    const char *enableStd = "import * as std from 'std';\n"
-        "globalThis.std = std;\n";
-    JSValue stdEval = JS_Eval(ctx, enableStd, strlen(enableStd), "<code>", JS_EVAL_TYPE_MODULE);
-    JS_FreeValue(ctx, stdEval);
-  }
-
-  if (r_enableOs == Qtrue) {
-    js_init_module_os(ctx, "os");
+const char *featureStdId = "feature_std";
+const char *featureOsId = "feature_os";
 
-    const char *enableOs = "import * as os from 'os';\n"
-        "globalThis.os = os;\n";
-    JSValue osEval = JS_Eval(ctx, enableOs, strlen(enableOs), "<code>", JS_EVAL_TYPE_MODULE);
-    JS_FreeValue(ctx, osEval);
+VALUE to_rb_value (JSValue jsv, JSContext *ctx) {
+  switch(JS_VALUE_GET_NORM_TAG(jsv)) {
+  case JS_TAG_INT: {
+    int int_res = 0;
+    JS_ToInt32(ctx, &int_res, jsv);
+    return INT2NUM(int_res);
   }
-
-  char *code = StringValueCStr(r_code);
-  JSValue res = JS_Eval(ctx, code, strlen(code), "<code>", JS_EVAL_TYPE_GLOBAL);
-
-  VALUE result;
-  int r = 0;
-  if (JS_IsException(res)) {
-    rb_raise(rb_eRuntimeError, "Something happened by evaluating as JavaScript code");
-    result = Qnil;
-  } else if (JS_IsObject(res)) {
+  case JS_TAG_FLOAT64: {
+    if (JS_VALUE_IS_NAN(jsv)) {
+      return ID2SYM(rb_intern(nanId));
+    }
+    double double_res;
+    JS_ToFloat64(ctx, &double_res, jsv);
+    return DBL2NUM(double_res);
+  }
+  case JS_TAG_BOOL: {
+    return JS_ToBool(ctx, jsv) > 0 ? Qtrue : Qfalse;
+  }
+  case JS_TAG_STRING: {
+    JSValue maybeString = JS_ToString(ctx, jsv);
+    const char *msg = JS_ToCString(ctx, maybeString);
+    return rb_str_new2(msg);
+  }
+  case JS_TAG_OBJECT: {
     JSValue global = JS_GetGlobalObject(ctx);
     JSValue jsonClass = JS_GetPropertyStr(ctx, global, "JSON");
     JSValue stringifyFunc = JS_GetPropertyStr(ctx, jsonClass, "stringify");
-    JSValue strigified = JS_Call(ctx, stringifyFunc, jsonClass, 1, &res);
+    JSValue strigified = JS_Call(ctx, stringifyFunc, jsonClass, 1, &jsv);
 
     const char *msg = JS_ToCString(ctx, strigified);
     VALUE rbString = rb_str_new2(msg);
-    VALUE rb_cJson = rb_const_get(rb_cClass, rb_intern("JSON"));
-    result = rb_funcall(rb_cJson, rb_intern("parse"), 1, rbString);
 
     JS_FreeValue(ctx, global);
     JS_FreeValue(ctx, strigified);
     JS_FreeValue(ctx, stringifyFunc);
     JS_FreeValue(ctx, jsonClass);
-  } else if (JS_VALUE_IS_NAN(res)) {
-    result = ID2SYM(rb_intern(nanId));
-  } else if (JS_IsNumber(res)) {
-    JS_ToInt32(ctx, &r, res);
-    result = INT2NUM(r);
-  } else if (JS_IsString(res)) {
-    JSValue maybeString = JS_ToString(ctx, res);
-    const char *msg = JS_ToCString(ctx, maybeString);
-    result = rb_str_new2(msg);
-  } else if (JS_IsBool(res)) {
-    result = JS_ToBool(ctx, res) > 0 ? Qtrue : Qfalse;
-  } else if (JS_IsUndefined(res)) {
-    result = ID2SYM(rb_intern(undefinedId));
-  } else if (JS_IsNull(res)) {
-    result = Qnil;
-  } else {
-    result = Qnil;
+
+    return rb_funcall(rb_const_get(rb_cClass, rb_intern("JSON")), rb_intern("parse"), 1, rbString);
+  }
+  case JS_TAG_NULL:
+    return Qnil;
+  case JS_TAG_UNDEFINED:
+    return ID2SYM(rb_intern(undefinedId));
+  case JS_TAG_EXCEPTION:
+    rb_raise(rb_eRuntimeError, "Something happened by evaluating as JavaScript code");
+    return Qnil;
+  case JS_TAG_BIG_INT: {
+    JSValue toStringFunc = JS_GetPropertyStr(ctx, jsv, "toString");
+    JSValue strigified = JS_Call(ctx, toStringFunc, jsv, 0, NULL);
+
+    const char *msg = JS_ToCString(ctx, strigified);
+    VALUE rbString = rb_str_new2(msg);
+    JS_FreeValue(ctx, strigified);
+    JS_FreeValue(ctx, toStringFunc);
+
+    return rb_funcall(rbString, rb_intern("to_i"), 0, NULL);
+  }
+  case JS_TAG_BIG_FLOAT:
+  case JS_TAG_BIG_DECIMAL:
+  case JS_TAG_SYMBOL:
+  default:
+    return Qnil;
   }
-  JS_FreeValue(ctx, res);
+}
 
-  js_std_free_handlers(rt);
-  JS_FreeContext(ctx);
-  JS_FreeRuntime(rt);
+struct qvmdata {
+  struct JSContext *context;
+  char alive;
+};
 
+void qvm_free(void* data)
+{
+  free(data);
+}
+
+size_t qvm_size(const void* data)
+{
+  return sizeof(data);
+}
+
+static const rb_data_type_t qvm_type = {
+  .wrap_struct_name = "qvm",
+  .function = {
+    .dmark = NULL,
+    .dfree = qvm_free,
+    .dsize = qvm_size,
+  },
+  .data = NULL,
+  .flags = RUBY_TYPED_FREE_IMMEDIATELY,
+};
+
+VALUE qvm_alloc(VALUE self)
+{
+  struct qvmdata *data;
+
+  return TypedData_Make_Struct(self, struct qvmdata, &qvm_type, data);
+}
+
+VALUE qvm_m_initialize(int argc, VALUE* argv, VALUE self)
+{
+  VALUE r_opts;
+  rb_scan_args(argc, argv, ":", &r_opts);
+  if (NIL_P(r_opts)) r_opts = rb_hash_new();
+
+  VALUE r_memoryLimit = rb_hash_aref(r_opts, ID2SYM(rb_intern("memory_limit")));
+  if (NIL_P(r_memoryLimit)) r_memoryLimit = UINT2NUM(1024 * 1024 * 128);
+  VALUE r_maxStackSize = rb_hash_aref(r_opts, ID2SYM(rb_intern("max_stack_size")));
+  if (NIL_P(r_maxStackSize)) r_maxStackSize = UINT2NUM(1024 * 1024 * 4);
+  VALUE r_features = rb_hash_aref(r_opts, ID2SYM(rb_intern("features")));
+  if (NIL_P(r_features)) r_features = rb_ary_new();
+
+  struct qvmdata *data;
+  TypedData_Get_Struct(self, struct qvmdata, &qvm_type, data);
+  JSRuntime *runtime = JS_NewRuntime();
+  data->context = JS_NewContext(runtime);
+  data->alive = 1;
+
+  JS_SetMemoryLimit(runtime, NUM2UINT(r_memoryLimit));
+  JS_SetMaxStackSize(runtime, NUM2UINT(r_maxStackSize));
+
+  JS_AddIntrinsicBigFloat(data->context);
+  JS_AddIntrinsicBigDecimal(data->context);
+  JS_AddIntrinsicOperators(data->context);
+  JS_EnableBignumExt(data->context, TRUE);
+  js_std_add_helpers(data->context, 0, NULL);
+
+  JS_SetModuleLoaderFunc(runtime, NULL, js_module_loader, NULL);
+  js_std_init_handlers(runtime);
+
+  if (RTEST(rb_funcall(r_features, rb_intern("include?"), 1, ID2SYM(rb_intern(featureStdId))))) {
+    js_init_module_std(data->context, "std");
+    const char *enableStd = "import * as std from 'std';\n"
+        "globalThis.std = std;\n";
+    JSValue stdEval = JS_Eval(data->context, enableStd, strlen(enableStd), "<vm>", JS_EVAL_TYPE_MODULE);
+    JS_FreeValue(data->context, stdEval);
+  }
+
+  if (RTEST(rb_funcall(r_features, rb_intern("include?"), 1, ID2SYM(rb_intern(featureOsId))))) {
+    js_init_module_os(data->context, "os");
+    const char *enableOs = "import * as os from 'os';\n"
+        "globalThis.os = os;\n";
+    JSValue osEval = JS_Eval(data->context, enableOs, strlen(enableOs), "<vm>", JS_EVAL_TYPE_MODULE);
+    JS_FreeValue(data->context, osEval);
+  }
+
+  return self;
+}
+
+VALUE qvm_m_evalCode(VALUE self, VALUE r_code)
+{
+  struct qvmdata *data;
+  TypedData_Get_Struct(self, struct qvmdata, &qvm_type, data);
+
+  if (data->alive < 1) {
+    rb_raise(rb_eRuntimeError, "Quickjs::VM was disposed");
+    return Qnil;
+  }
+  char *code = StringValueCStr(r_code);
+  JSValue codeResult = JS_Eval(data->context, code, strlen(code), "<code>", JS_EVAL_TYPE_GLOBAL);
+  VALUE result = to_rb_value(codeResult, data->context);
+
+  JS_FreeValue(data->context, codeResult);
   return result;
 }
 
+VALUE qvm_m_dispose(VALUE self)
+{
+  struct qvmdata *data;
+  TypedData_Get_Struct(self, struct qvmdata, &qvm_type, data);
+
+  JSRuntime *runtime = JS_GetRuntime(data->context);
+  js_std_free_handlers(runtime);
+  JS_FreeContext(data->context);
+  JS_FreeRuntime(runtime);
+  data->alive = 0;
+
+  return Qnil;
+}
+
 RUBY_FUNC_EXPORTED void
 Init_quickjsrb(void)
 {
   rb_mQuickjs = rb_define_module("Quickjs");
-  rb_define_module_function(rb_mQuickjs, "_evalCode", rb_module_eval_js_code, 5);
+  rb_define_const(rb_mQuickjs, "MODULE_STD", ID2SYM(rb_intern(featureStdId)));
+  rb_define_const(rb_mQuickjs, "MODULE_OS", ID2SYM(rb_intern(featureOsId)));
 
   VALUE valueClass = rb_define_class_under(rb_mQuickjs, "Value", rb_cObject);
   rb_define_const(valueClass, "UNDEFINED", ID2SYM(rb_intern(undefinedId)));
   rb_define_const(valueClass, "NAN", ID2SYM(rb_intern(nanId)));
+
+  VALUE vmClass = rb_define_class_under(rb_mQuickjs, "VM", rb_cObject);
+  rb_define_alloc_func(vmClass, qvm_alloc);
+  rb_define_method(vmClass, "initialize", qvm_m_initialize, -1);
+  rb_define_method(vmClass, "eval_code", qvm_m_evalCode, 1);
+  rb_define_method(vmClass, "dispose!", qvm_m_dispose, 0);
 }

data/lib/quickjs/version.rb

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

data/lib/quickjs.rb

@@ -5,25 +5,8 @@ require_relative "quickjs/version"
 require_relative "quickjs/quickjsrb"
 
 module Quickjs
-  FEATURE_STD = :std
-  FEATURE_OS = :os
-
-  def evalCode(
-    code,
-    opts = {
-      memoryLimit: nil,
-      maxStackSize: nil,
-      features: []
-    }
-  )
-
-    _evalCode(
-      code,
-      opts[:memoryLimit] || 1024 * 1024 * 128,
-      opts[:maxStackSize] || 1024 * 1024 * 4,
-      opts[:features].include?(Quickjs::FEATURE_STD),
-      opts[:features].include?(Quickjs::FEATURE_OS),
-    )
+  def eval_code(code, overwrite_opts = {})
+    Quickjs::VM.new(**overwrite_opts).eval_code(code)
   end
-  module_function :evalCode
+  module_function :eval_code
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quickjs
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - hmsk
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-15 00:00:00.000000000 Z
+date: 2024-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -34,6 +34,7 @@ extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - LICENSE
+- README.md
 - Rakefile
 - ext/quickjsrb/extconf.rb
 - ext/quickjsrb/quickjs/LICENSE