node-runner 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c6222ef23c1975d9325fbf60b6bbbd63a6ffad0c13c5249e8c1b4734f09dab9
-  data.tar.gz: abbd491dd0894a0a2a13d8d56138ddca1c8f168b969c3dea8e31ec96bce6ab5a
+  metadata.gz: a733bf42b17f92ee1c91bf8a7c4ca2eff92cfbc597616194484eeacff633a3e8
+  data.tar.gz: '0839ed6d6df8a18edd76bffb58d91f895037dbd6919320c2385013fbcf1231fd'
 SHA512:
-  metadata.gz: 8c4932b21e6a843e53abb1943de4062e685f8e45b12c2bcdda63765235262f2a83c31179961fd0a59ba53031393a307b0711cd39eae122e6618b4399a096a258
-  data.tar.gz: de4c98cdd6b6be6b07e6c8c8a0e18fc8a2555a505d5dc102be72bf88830a8877c39b71be3faea208cc20b1e1e3bff79155ec6854ce1d6f5bbb68410f59cd1d41
+  metadata.gz: 92f31ae689bc4f5d8404e4a756a13428ec099f4a8ae0abd9e2cd43a1070192c5a5abbaa5739ee2ef1d8fe137f99cba8f14edb8d55c87bafcaef854ec85c8b43d
+  data.tar.gz: 31a2e69aebf9983b44bdf23e66905fbc471d0abd955035c57cc36f4079becfc07b3c77d6ad167ccbe60efc4662783f2939bd207a8c88cd16914f3ae84de2f417

data/CHANGELOG.md

@@ -1,9 +1,21 @@
-# master
+# Changelog
 
-# 1.0.1 / 2020-05-09
+## Unreleased
 
-Set the NODE_ENV so local modules can be found.
+...
 
-# 1.0.0 / 2020-04-29
+## 1.2.0 / 2024-04-05
 
-Initial release of NodeRunner.
+- Add support for functions returning promises
+
+## 1.1.0 / 2021-10-17
+
+- fix: windows support for extensions [#1](https://github.com/bridgetownrb/node-runner/pull/1) ([bglw](https://github.com/bglw))
+
+## 1.0.1 / 2020-05-09
+
+- Set the NODE_ENV so local modules can be found.
+
+## 1.0.0 / 2020-04-29
+
+- Initial release of NodeRunner.

data/README.md

@@ -12,6 +12,12 @@ Run this command to add this plugin to your project's Gemfile:
 $ bundle add node-runner
 ```
 
+For [Bridgetown](https://www.bridgetownrb.com) websites, you can run an automation to install NodeRunner and set up a builder plugin for further customization.
+
+```shell
+bin/bridgetown apply https://github.com/bridgetownrb/node-runner
+```
+
 ## Usage
 
 Simply create a new `NodeRunner` object and pass in the Javascript code you wish to
@@ -21,11 +27,11 @@ execute:
 require "node-runner"
 
 runner = NodeRunner.new(
-  <<~NODE
+  <<~JAVASCRIPT
     const hello = (response) => {
-      return `Hello? ${response}!`
+      return `Hello? ${response}`
     }
-  NODE
+  JAVASCRIPT
 )
 ```
 
@@ -44,12 +50,12 @@ You can also use Node require statements in your Javascript:
 
 ```ruby
 runner = NodeRunner.new(
-  <<~NODE
+  <<~JAVASCRIPT
     const path = require("path")
     const extname = (filename) => {
       return path.extname(filename);
     }
-  NODE
+  JAVASCRIPT
 )
   
 extname = runner.extname("README.md")
@@ -85,7 +91,7 @@ Node Runner would be via a background job, or during a build process like when u
 
 ## Testing
 
-* Run `bundle exec rake` to run the test suite.
+* Run `bin/rake` to run the test suite.
 
 ## Contributing
 

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bridgetown.automation.rb

@@ -0,0 +1,29 @@
+run "bundle add node-runner", abort_on_failure: false
+
+builder_file = "node_script_builder.rb"
+create_builder builder_file do
+  <<~RUBY
+    require "node-runner"
+
+    class Builders::NodeScriptBuilder < SiteBuilder
+      def build
+        # access output in Liquid with {{ site.data.node_script.hello }}
+        add_data "node_script" do
+          runner = NodeRunner.new(
+            <<~JAVASCRIPT
+              const hello = (response) => {
+                return `Hello? ${response}`
+              }
+            JAVASCRIPT
+          )
+          
+          {
+            hello: runner.hello("Goodbye!")
+          }
+        end
+      end
+    end
+  RUBY
+end
+
+say_status "node-runner", "Installed! Check out plugins/builders/#{builder_file} to customize your Node script"

data/lib/node-runner.rb

@@ -117,16 +117,20 @@ class NodeRunner::Executor
 
   def locate_executable(command)
     commands = Array(command)
+    exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+    exts << ''
 
     commands.find { |cmd|
       if File.executable? cmd
         cmd
       else
-        path = ENV['PATH'].split(File::PATH_SEPARATOR).find { |p|
-          full_path = File.join(p, cmd)
-          File.executable?(full_path) && File.file?(full_path)
+        path = ENV['PATH'].split(File::PATH_SEPARATOR).flat_map { |p|
+          exts.map { |e| File.join(p, "#{cmd}#{e}") }
+        }.find { |p|
+          File.executable?(p) && File.file?(p)
         }
-        path && File.expand_path(cmd, path)
+
+        path && File.expand_path(path)
       end
     }
   end

data/lib/node_runner.js

@@ -2,8 +2,10 @@
 
 try {
   const args = #{args}
-  const output = JSON.stringify(['ok', #{func}(...args), []])
-  process.stdout.write(output)
+  Promise.resolve(#{func}(...args)).then(result => {
+    const output = JSON.stringify(['ok', result, []])
+    process.stdout.write(output)
+  })
 } catch (err) {
   process.stdout.write(JSON.stringify(['err', '' + err, err.stack]))
 }

data/lib/version.rb

@@ -1,4 +1,4 @@
 class NodeRunner
-  VERSION = "1.0.1"
+  VERSION = "1.2.0"
 end
 

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: node-runner
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Bridgetown Team
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-10 00:00:00.000000000 Z
+date: 2024-04-05 00:00:00.000000000 Z
 dependencies: []
-description: 
+description:
 email: maintainers@bridgetownrb.com
 executables: []
 extensions: []
@@ -22,6 +22,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/rake
+- bridgetown.automation.rb
 - lib/node-runner.rb
 - lib/node_runner.js
 - lib/version.rb
@@ -30,7 +32,7 @@ homepage: https://github.com/bridgetownrb/node-runner
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -45,8 +47,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key: 
+rubygems_version: 3.5.3
+signing_key:
 specification_version: 4
 summary: A simple way to execute Javascript in a Ruby context via Node
 test_files: []