node-runner 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ead50dfa95fa818eb046575996e0047ee234dedf0f0813c5cf6ee4f684677b47
-  data.tar.gz: fcd76591a0acd31bb3930e2fa73c743c71290c075046c297417c75382e2efe1b
+  metadata.gz: 3c6222ef23c1975d9325fbf60b6bbbd63a6ffad0c13c5249e8c1b4734f09dab9
+  data.tar.gz: abbd491dd0894a0a2a13d8d56138ddca1c8f168b969c3dea8e31ec96bce6ab5a
 SHA512:
-  metadata.gz: aa16d705dc422f545ee607c91cc2868d2c2cb5a301a722c2a9964cea5cca80d6051d4b72726af45a04d0c16c6b91e855ff25b01c4b68c84a06740eaa2050ce61
-  data.tar.gz: bee406b3703184445d677359429a8d68f75ba382cff78eb94484575d82a0f83d96d99a96d05c57d98becbfff73f1d43a72d3ba32a2735592897f43c720e48121
+  metadata.gz: 8c4932b21e6a843e53abb1943de4062e685f8e45b12c2bcdda63765235262f2a83c31179961fd0a59ba53031393a307b0711cd39eae122e6618b4399a096a258
+  data.tar.gz: de4c98cdd6b6be6b07e6c8c8a0e18fc8a2555a505d5dc102be72bf88830a8877c39b71be3faea208cc20b1e1e3bff79155ec6854ce1d6f5bbb68410f59cd1d41

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# master
+
+# 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

@@ -2,7 +2,7 @@
 
 A simple way to execute Javascript in a Ruby context via Node. (Loosely based on the Node Runtime module from [ExecJS](https://github.com/rails/execjs).)
 
-[![Gem Version](https://badge.fury.io/rb/node-runner)](https://badge.fury.io/rb/node-runner)
+[![Gem Version](https://badge.fury.io/rb/node-runner.svg)](https://badge.fury.io/rb/node-runner)
 
 ## Installation
 
@@ -18,6 +18,8 @@ Simply create a new `NodeRunner` object and pass in the Javascript code you wish
 execute:
 
 ```ruby
+require "node-runner"
+
 runner = NodeRunner.new(
   <<~NODE
     const hello = (response) => {
@@ -73,6 +75,14 @@ NodeRunner.new "…", executor: NodeRunner::Executor.new(command: "/path/to/cust
 
 `command` can be an array as well, if you want to attempt multiple paths until one is found. Inspect the `node-runner.rb` source code for more information on the available options.
 
+## Caveats
+
+A single run of a script is quite fast, nearly as fast as running a script directly with the
+`node` CLI…because that's essentially what is happening here. However, the performance characteristics using
+this in a high-traffic request/response cycle (say, from a Rails app) is unknown. Likely the best context to use
+Node Runner would be via a background job, or during a build process like when using a static site generator.
+(Like our parent project [Bridgetown](https://github.com/bridgetownrb/bridgetown)!)
+
 ## Testing
 
 * Run `bundle exec rake` to run the test suite.

data/lib/node-runner.rb

@@ -84,10 +84,11 @@ class NodeRunner::Executor
   attr_reader :name
 
   def initialize(options = {})
-    @command     = options[:command] || ['node']
-    @runner_path = options[:runner_path] || File.join(File.expand_path(__dir__), '/node_runner.js')
-    @encoding    = options[:encoding] || "UTF-8"
-    @binary      = nil
+    @command      = options[:command] || ['node']
+    @modules_path = options[:modules_path] || File.join(Dir.pwd, "node_modules")
+    @runner_path  = options[:runner_path] || File.join(File.expand_path(__dir__), '/node_runner.js')
+    @encoding     = options[:encoding] || "UTF-8"
+    @binary       = nil
 
     @popen_options = {}
     @popen_options[:external_encoding] = @encoding if @encoding
@@ -99,6 +100,7 @@ class NodeRunner::Executor
   end
 
   def exec(filename)
+    ENV["NODE_PATH"] = @modules_path
     stdout, stderr, status = Open3.capture3("#{binary} #{filename}")
     if status.success?
       stdout

data/lib/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: node-runner
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-30 00:00:00.000000000 Z
+date: 2020-05-10 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: maintainers@bridgetownrb.com
@@ -17,6 +17,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md