quickjs 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ac1abd90f15750c0ed0da7c82804862906def1d584baa5fefb4889682513d35
-  data.tar.gz: 59ee4e54ccc5743286f38a4b4e325486108399e432f92f12b430de9c68accd28
+  metadata.gz: 3e230674190897ed1edcd6b9918deb3f9f073746f28410bdbe3e20e7622baea0
+  data.tar.gz: 8aeddfc2188ab5c1c34216a9f0e853339d784d2476967a2309171a654e633cc0
 SHA512:
-  metadata.gz: 3c5ba0d56904c52f426440429c3243285572591c4803bcd21649cacef8e40168f9b289867531b8f5ad2f15a533cca31714a931ac6f04062dc7a22a53e22fae95
-  data.tar.gz: 8fb7571445aedcac86a0cf897fbbf2e6390b40190838a7bbdbd91742ababc893399704afbeeacd599c8ddbd74429c61038889e47e50dc55fc4b35e65630c889a
+  metadata.gz: dd1069fadcd70b58c8fe25d88f091304be1956cc43d62f64a389671ef0ed7ee79b53023852bdfe4be321f2aee53d3c00784ef7d3d2d1a329bad370087f388e74
+  data.tar.gz: cc4b076a5cfa578805c4108377ab148d4a5c4ec78b65fb6247dd0e906fbf083e0762173926bf4f6cbd37e469ad58f474a276df38a11e834d2207c6ad688b73cb

data/CHANGELOG.md

@@ -1,4 +1,4 @@
-## [0.1.1] - 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,64 @@
+# 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?style=for-the-badge)](https://github.com/hmsk/quickjs.rb/actions/workflows/main.yml)
+
+
+## Installation
+
+```
+gem install quickjs
+```
+
+```rb
+gem 'quickjs'
+```
+
+## Usage
+
+### `Quickjs.evalCode`: Evaluate JavaScript code
+
+```rb
+require 'quickjs'
+
+Quickjs.evalCode('const fn = (n, pow) => n ** pow; fn(2,8);') # => 256
+Quickjs.evalCode('const fn = (name) => `Hi, ${name}!`; fn("Itadori");') # => "Hi, Itadori!
+Quickjs.evalCode("const isOne = (n) => 1 === n; func(1);") #=> true (TrueClass)
+Quickjs.evalCode("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.evalCode("[1,2,3]") #=> [1, 2, 3] (Array)
+Quickjs.evalCode("({ a: '1', b: 1 })") #=> { 'a' => '1', 'b' => 1 } (Hash)
+
+Quickjs.evalCode("null") #=> nil
+Quickjs.evalCode('const obj = {}; obj.missingKey;') # => :undefined (Quickjs::Value::Undefined)
+Quickjs.evalCode("Number('whatever')") #=> :NaN (Quickjs::Value::NAN)
+```
+
+#### Limit resources
+
+```rb
+# 1GB memory limit
+Quickjs.evalCode(code, { memoryLimit: 1024 ** 3 })
+
+# 1MB max stack size
+Quickjs.evalCode(code, { memoryLimit: 1024 ** 2 })
+```
+
+#### Enable built-in modules
+
+```rb
+# enable std module
+# https://bellard.org/quickjs/quickjs.html#std-module
+Quickjs.evalCode(code, { features: [Quickjs::MODULE_STD] })
+
+# enable os module
+# https://bellard.org/quickjs/quickjs.html#os-module
+Quickjs.evalCode(code, { features: [Quickjs::MODULE_OS] })
+```
+
+## 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

@@ -49,7 +49,6 @@ VALUE rb_module_eval_js_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;
@@ -60,7 +59,9 @@ VALUE rb_module_eval_js_code(
     JSValue strigified = JS_Call(ctx, stringifyFunc, jsonClass, 1, &res);
 
     const char *msg = JS_ToCString(ctx, strigified);
-    result = rb_str_new2(msg);
+    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);
@@ -69,8 +70,16 @@ VALUE rb_module_eval_js_code(
   } 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);
+    int tag = JS_VALUE_GET_TAG(res);
+    if (JS_TAG_IS_FLOAT64(tag)) {
+      double double_res;
+      JS_ToFloat64(ctx, &double_res, res);
+      result = DBL2NUM(double_res);
+    } else {
+      int int_res;
+      JS_ToInt32(ctx, &int_res, res);
+      result = INT2NUM(int_res);
+    }
   } else if (JS_IsString(res)) {
     JSValue maybeString = JS_ToString(ctx, res);
     const char *msg = JS_ToCString(ctx, maybeString);

data/lib/quickjs/version.rb

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

data/lib/quickjs.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
+require "json"
 require_relative "quickjs/version"
 require_relative "quickjs/quickjsrb"
 
 module Quickjs
-  FEATURE_STD = :std
-  FEATURE_OS = :os
+  MODULE_STD = :std
+  MODULE_OS = :os
 
   def evalCode(
     code,
@@ -20,8 +21,8 @@ module Quickjs
       code,
       opts[:memoryLimit] || 1024 * 1024 * 128,
       opts[:maxStackSize] || 1024 * 1024 * 4,
-      opts[:features].include?(Quickjs::FEATURE_STD),
-      opts[:features].include?(Quickjs::FEATURE_OS),
+      opts[:features].include?(Quickjs::MODULE_STD),
+      opts[:features].include?(Quickjs::MODULE_OS),
     )
   end
   module_function :evalCode

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: quickjs
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - hmsk
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-14 00:00:00.000000000 Z
-dependencies: []
+date: 2024-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A native wrapper to run QuickJS in Ruby
 email:
 - k.hamasaki@gmail.com
@@ -20,6 +34,7 @@ extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - LICENSE
+- README.md
 - Rakefile
 - ext/quickjsrb/extconf.rb
 - ext/quickjsrb/quickjs/LICENSE