nodo 1.6.4 → 1.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4870340520e40bf14cf0e9261711983d5332eaf04419ff1281626ed5b4716e1
-  data.tar.gz: 162b5e4f6739728c91f64422acb579db9c004429f92402db5f393cfb76ffa675
+  metadata.gz: 0c0c3cef7af9cd8352a7470125eda15d01a56f795a5ce3fd2b1474b47f77f171
+  data.tar.gz: 759f66869c24cc8511fae1adf0a633fc73dd45d340ff9f16186570c5aefccbab
 SHA512:
-  metadata.gz: dbe6fb8dce3f39968b26800a28f50b7d2c1ac49ffc60537a50950af598bc329b6ae59fae2db8285b16167238448ef370502d7b6f736c4dc4e66563ae0050ccfd
-  data.tar.gz: 37dd504e71489566a9b57df0e217c2f25d09ce3d511dab2ac6daf849829b90f1293ed07dd4e320eb70ef573da7b466263c704bb99cf46cb555449a8253909089
+  metadata.gz: 010242af2332f9eb6ac1b136ae13ab570ae63212f61fb4b056a20407cc4209d52774dec9bcb87c44c9b9f87d13f3145bc468b0e96bd4b3fd7635815035381288
+  data.tar.gz: 0363c67c93b8015f45028625d3c3e76a5be084f087f5f34286a47fa9bbd5227d27267cbbbfaf133fe46bc325a4e46de4178946cdfe84c9d401950e30e2bc6897

data/README.md

@@ -1,4 +1,4 @@
-[![Gem Version](https://badge.fury.io/rb/nodo.svg)](http://badge.fury.io/rb/nodo)
+[![Gem Version](https://badge.fury.io/rb/nodo.svg)](https://badge.fury.io/rb/nodo)
 [![build](https://github.com/mtgrosser/nodo/actions/workflows/build.yml/badge.svg)](https://github.com/mtgrosser/nodo/actions/workflows/build.yml)
 
 # Nōdo – call Node.js from Ruby
@@ -54,6 +54,26 @@ foo.say_hi('Nodo')
 => "Hello Nodo!"
 ```
 
+JS code can also be supplied using the `code:` keyword argument:
+
+```ruby
+function :hello, code: "() => 'world'"
+```
+
+### Async functions
+
+`Nodo` supports calling `async` functions from Ruby.
+The Ruby call will happen synchronously, i.e. it will block until the JS
+function resolves:
+
+```ruby
+class SyncFoo < Nodo::Core
+  function :do_something, <<~JS
+    async () => { return await asyncFunc(); }
+  JS
+end
+```
+
 ### Using npm modules
 
 Install your modules to `node_modules`:
@@ -79,7 +99,6 @@ bar = Bar.new
 bar.v4 => "b305f5c4-db9a-4504-b0c3-4e097a5ec8b9"
 ```
 
-
 ### Aliasing requires
 
 If the library name cannot be used as name of the constant, the `const` name
@@ -108,25 +127,6 @@ end
 
 Note that the availability of dynamic imports depends on your Node version.
 
-### Alternate function definition syntax
-
-JS code can also be supplied using the `code:` keyword argument:
-
-```ruby
-function :hello, code: "() => 'world'"
-```
-
-### Setting NODE_PATH
-
-By default, `./node_modules` is used as the `NODE_PATH`.
-
-To set a custom path:
-```ruby
-Nodo.modules_root = 'path/to/node_modules'
-```
-
-Also see: [Clean your Rails root](#Clean-your-Rails-root)
-
 ### Defining JS constants
 
 ```ruby
@@ -188,20 +188,6 @@ SubFoo.new.bar => "callingsuperclass"
 SubSubFoo.new.bar => "callingsubsubclass"
 ```
 
-### Async functions
-
-`Nodo` supports calling `async` functions from Ruby. 
-The Ruby call will happen synchronously, i.e. it will block until the JS
-function resolves:
-
-```ruby
-class SyncFoo < Nodo::Core
-  function :do_something, <<~JS
-    async () => { return await asyncFunc(); }
-  JS
-end
-```
-
 ### Deferred function definition
 
 By default, the function code string literal is created when the class
@@ -258,6 +244,17 @@ Foo.new.sleep(2)
 =>  Nodo::TimeoutError raised
 ```
 
+### Setting NODE_PATH
+
+By default, `./node_modules` is used as the `NODE_PATH`.
+
+To set a custom path:
+```ruby
+Nodo.modules_root = 'path/to/node_modules'
+```
+
+Also see: [Clean your Rails root](#Clean-your-Rails-root)
+
 ### Logging
 
 By default, JS errors will be logged to `STDOUT`.
@@ -270,7 +267,6 @@ Nodo.logger = Logger.new('nodo.log')
 
 In Rails applications, `Rails.logger` will automatically be set.
 
-
 ### Debugging
 
 To get verbose debug output, set
@@ -356,3 +352,15 @@ With this new default, all `yarn` operations should be done after `cd`ing to `ve
 
 This repo provides an [adapted version](https://github.com/mtgrosser/nodo/blob/master/install/yarn.rake)
 of the `yarn:install` rake task which will automatically take care of the vendored module location.
+
+
+## Working with web mocking frameworks like WebMock
+
+Nodo uses HTTP via UNIX sockets to connect to its Node process. This may lead to
+conflicts during tests when using `WebMock` or other tools which interfere with
+`Net::HTTP`. In order to work with WebMock, you need to enable its `allow_localhost`
+option:
+
+```ruby
+WebMock.disable_net_connect!(allow_localhost: true)
+```

data/lib/nodo/core.rb

@@ -9,48 +9,48 @@ module Nodo
     ARRAY_CLASS_ATTRIBUTES = %i[dependencies constants scripts].freeze
     HASH_CLASS_ATTRIBUTES = %i[functions].freeze
     CLASS_ATTRIBUTES = (ARRAY_CLASS_ATTRIBUTES + HASH_CLASS_ATTRIBUTES).freeze
-    
+
     @@node_pid = nil
     @@tmpdir = nil
     @@mutex = Mutex.new
     @@exiting = nil
-    
+
     class << self
       extend Forwardable
-      
+
       attr_accessor :class_defined
-      
+
       def inherited(subclass)
         CLASS_ATTRIBUTES.each do |attr|
           subclass.send "#{attr}=", send(attr).dup
         end
       end
-      
+
       def instance
         @instance ||= new
       end
-      
+
       def class_defined?
         !!class_defined
       end
-      
+
       def clsid
         name || "Class:0x#{object_id.to_s(0x10)}"
       end
-      
+
       CLASS_ATTRIBUTES.each do |attr|
         define_method "#{attr}=" do |value|
           instance_variable_set :"@#{attr}", value
         end
         protected "#{attr}="
       end
-      
+
       ARRAY_CLASS_ATTRIBUTES.each do |attr|
         define_method "#{attr}" do
           instance_variable_get(:"@#{attr}") || instance_variable_set(:"@#{attr}", [])
         end
       end
-      
+
       HASH_CLASS_ATTRIBUTES.each do |attr|
         define_method "#{attr}" do
           instance_variable_get(:"@#{attr}") || instance_variable_set(:"@#{attr}", {})
@@ -60,15 +60,15 @@ module Nodo
       def generate_core_code
         <<~JS
           global.nodo = require(#{nodo_js});
-          
+
           const socket = process.argv[1];
           if (!socket) {
             process.stderr.write('Socket path is required\\n');
             process.exit(1);
           }
-          
+
           process.title = `nodo-core ${socket}`;
-          
+
           const shutdown = () => {
             nodo.core.close(() => { process.exit(0) });
           };
@@ -92,19 +92,20 @@ module Nodo
           })()
         JS
       end
-      
+
       protected
-      
+
       def finalize_context(context_id)
         proc do
-          if not @@exiting and core = Nodo::Core.instance
+          if not @@exiting and core = @instance
+            puts "finalize_context #{context_id}"
             core.send(:call_js_method, GC_METHOD, context_id)
           end
         end
       end
-      
+
       private
-      
+
       def require(*mods)
         deps = mods.last.is_a?(Hash) ? mods.pop : {}
         mods = mods.map { |m| [m, m] }.to_h
@@ -118,7 +119,7 @@ module Nodo
         self.functions = functions.merge(name => Function.new(name, _code || code, source_location, timeout, &block))
         define_method(name) { |*args| call_js_method(name, args) }
       end
-      
+
       def class_function(*methods)
         singleton_class.def_delegators(:instance, *methods)
       end
@@ -126,20 +127,20 @@ module Nodo
       def const(name, value)
         self.constants = constants + [Constant.new(name, value)]
       end
-      
+
       def script(code = nil, &block)
         self.scripts = scripts + [Script.new(code, &block)]
       end
-      
+
       def nodo_js
-        Pathname.new(__FILE__).dirname.join('nodo.js').to_s.to_json
+        Pathname.new(__FILE__).dirname.join('nodo.cjs').to_s.to_json
       end
-      
+
       def reserved_method_name?(name)
         Nodo::Core.method_defined?(name, false) || Nodo::Core.private_method_defined?(name, false) || name.to_s == DEFINE_METHOD
       end
     end
-    
+
     def initialize
       raise ClassError, :new if self.class == Nodo::Core
       @@mutex.synchronize do
@@ -148,18 +149,18 @@ module Nodo
         ensure_class_is_defined
       end
     end
-    
+
     def evaluate(code)
       ensure_context_is_defined
       call_js_method(EVALUATE_METHOD, code)
     end
-    
+
     private
-    
+
     def node_pid
       @@node_pid
     end
-    
+
     def tmpdir
       @@tmpdir
     end
@@ -167,33 +168,33 @@ module Nodo
     def socket_path
       tmpdir && tmpdir.join(SOCKET_NAME)
     end
-    
+
     def clsid
       self.class.clsid
     end
-    
+
     def context_defined?
       @context_defined
     end
-    
+
     def log_exception(e)
       return unless logger = Nodo.logger
       message = "\n#{e.class} (#{e.message})"
       message << ":\n\n#{e.backtrace.join("\n")}" if e.backtrace
       logger.error message
     end
-    
+
     def ensure_process_is_spawned
       return if node_pid
       spawn_process
     end
-    
+
     def ensure_class_is_defined
       return if self.class.class_defined?
       call_js_method(DEFINE_METHOD, self.class.generate_class_code)
       self.class.class_defined = true
     end
-    
+
     def ensure_context_is_defined
       return if context_defined?
       @@mutex.synchronize do
@@ -202,7 +203,7 @@ module Nodo
         @context_defined = true
       end
     end
-    
+
     def spawn_process
       @@tmpdir = Pathname.new(Dir.mktmpdir('nodo'))
       env = Nodo.env.merge('NODE_PATH' => Nodo.modules_root.to_s)
@@ -215,13 +216,13 @@ module Nodo
         FileUtils.remove_entry(tmpdir) if File.directory?(tmpdir)
       end
     end
-    
+
     def wait_for_socket
       start = Time.now
       socket = nil
       while Time.now - start < LAUNCH_TIMEOUT
         begin
-          break if socket = UNIXSocket.new(socket_path)
+          break if socket = UNIXSocket.new(socket_path.to_s)
         rescue Errno::ENOENT, Errno::ECONNREFUSED, Errno::ENOTDIR
           Kernel.sleep(0.2)
         end
@@ -237,7 +238,7 @@ module Nodo
       raise NameError, "undefined function `#{method}' for #{self.class}" unless function || INTERNAL_METHODS.include?(method)
       context_id = case method
         when DEFINE_METHOD then 0
-        when GC_METHOD then args.first
+        when GC_METHOD then args
       else
         object_id
       end
@@ -257,7 +258,7 @@ module Nodo
       # TODO: restart or something? If this happens the process is completely broken
       raise Error, 'Node process failed'
     end
-    
+
     def handle_error(response, function)
       if response.body
         result = parse_response(response)
@@ -270,12 +271,12 @@ module Nodo
       log_exception(error)
       raise error
     end
-    
+
     def parse_response(response)
       data = response.body.force_encoding('UTF-8')
       JSON.parse(data) unless data == ''
     end
-    
+
     def with_tempfile(name)
       ext = File.extname(name)
       result = nil
@@ -284,6 +285,6 @@ module Nodo
       end
       result
     end
-    
+
   end
 end

data/lib/nodo/{nodo.js → nodo.cjs}

@@ -13,7 +13,7 @@ module.exports = (function() {
   let server, closing;
   const classes = {};
   const contexts = {};
-  
+
   function render_error(e) {
     let errInfo = {};
     if (e instanceof Error) {
@@ -31,7 +31,7 @@ module.exports = (function() {
     debug(`Error ${code} ${rendered}`);
     res.end(rendered, 'utf8');
   }
-  
+
   function respond_with_data(res, data, start) {
     let timing;
     res.statusCode = 200;
@@ -58,18 +58,18 @@ module.exports = (function() {
       debug('Starting up...');
       server = http.createServer((req, res) => {
         const start = performance.now();
-        
+
         res.setHeader('Content-Type', 'application/json');
         debug(`${req.method} ${req.url}`);
 
         if (req.method !== 'POST' || !req.url.startsWith('/')) {
           return respond_with_error(res, 405, 'Method Not Allowed');
         }
-        
+
         const url = req.url.substring(1);
         const [class_name, object_id, method] = url.split('/');
         let klass, context;
-        
+
         if (classes.hasOwnProperty(class_name)) {
           klass = classes[class_name];
           if (EVALUATE_METHOD == method) {
@@ -83,9 +83,9 @@ module.exports = (function() {
         } else if (DEFINE_METHOD != method) {
           return respond_with_error(res, 404, `Class ${class_name} not defined`);
         }
-        
+
         let body = '';
-        
+
         req.on('data', (data) => { body += data; });
 
         req.on('end', () => {
@@ -120,7 +120,7 @@ module.exports = (function() {
           } catch(error) {
             return respond_with_error(res, 500, error);
           }
-    
+
         });
       });
 
@@ -129,7 +129,7 @@ module.exports = (function() {
         debug(`server ready, listening on ${socket} (max connections: ${server.maxConnections})`);
       });
     },
-    
+
     close: (finalizer) => {
       debug("Shutting down");
       if (!closing) {
@@ -138,6 +138,6 @@ module.exports = (function() {
       }
     }
   };
-  
+
   return { core: core, debug: debug, import: import_module };
 })();

data/lib/nodo/version.rb

@@ -1,3 +1,3 @@
 module Nodo
-  VERSION = '1.6.4'
+  VERSION = '1.7.1'
 end

metadata

@@ -1,71 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: nodo
 version: !ruby/object:Gem::Version
-  version: 1.6.4
+  version: 1.7.1
 platform: ruby
 authors:
 - Matthias Grosser
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-12 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+date: 2024-10-02 00:00:00.000000000 Z
+dependencies: []
 description: Fast Ruby bridge to run JavaScript inside a Node process
 email:
 - mtgrosser@gmx.net
@@ -82,7 +26,7 @@ files:
 - lib/nodo/dependency.rb
 - lib/nodo/errors.rb
 - lib/nodo/function.rb
-- lib/nodo/nodo.js
+- lib/nodo/nodo.cjs
 - lib/nodo/railtie.rb
 - lib/nodo/script.rb
 - lib/nodo/version.rb
@@ -98,14 +42,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Call Node.js from Ruby