node-runner 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ead50dfa95fa818eb046575996e0047ee234dedf0f0813c5cf6ee4f684677b47
+  data.tar.gz: fcd76591a0acd31bb3930e2fa73c743c71290c075046c297417c75382e2efe1b
+SHA512:
+  metadata.gz: aa16d705dc422f545ee607c91cc2868d2c2cb5a301a722c2a9964cea5cca80d6051d4b72726af45a04d0c16c6b91e855ff25b01c4b68c84a06740eaa2050ce61
+  data.tar.gz: bee406b3703184445d677359429a8d68f75ba382cff78eb94484575d82a0f83d96d99a96d05c57d98becbfff73f1d43a72d3ba32a2735592897f43c720e48121

data/.gitignore

@@ -0,0 +1,19 @@
+/vendor
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem
+Gemfile.lock
+.bundle
+.ruby-version
+test_threads.rb

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "rake", "~> 13.0"
+gem "minitest"
+

data/LICENSE.txt

@@ -0,0 +1,23 @@
+The MIT License (MIT)
+
+Copyright (c) 2020-present Jared White and Bridgetown contributors
+Portions copyright (c) 2015-2016 Sam Stephenson
+Portions copyright (c) 2015-2016 Josh Peek
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+# NodeRunner for Ruby
+
+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)
+
+## Installation
+
+Run this command to add this plugin to your project's Gemfile:
+
+```shell
+$ bundle add node-runner
+```
+
+## Usage
+
+Simply create a new `NodeRunner` object and pass in the Javascript code you wish to
+execute:
+
+```ruby
+runner = NodeRunner.new(
+  <<~NODE
+    const hello = (response) => {
+      return `Hello? ${response}!`
+    }
+  NODE
+)
+```
+
+Then call the function as if it were a genuine Ruby method:
+
+```ruby
+runner.hello "Goodbye!"
+
+# output: "Hello? Goodbye!"
+```
+
+Under the hood, the data flowing in and out of the Javascript function is translated via JSON, so you'll need to stick to standard JSON-friendly data
+values (strings, integers, arrays, hashes, etc.)
+
+You can also use Node require statements in your Javascript:
+
+```ruby
+runner = NodeRunner.new(
+  <<~NODE
+    const path = require("path")
+    const extname = (filename) => {
+      return path.extname(filename);
+    }
+  NODE
+)
+  
+extname = runner.extname("README.md")
+
+extname == ".md"
+
+# output: true
+```
+
+Multiple arguments for a function work, as do multiple function calls (aka
+if you define `function_one` and `function_two` in your Javascript, you can call
+`runner.function_one` or `runner.function_two` in Ruby).
+
+## Node Executor Options
+
+If you need to customize which `node` binary is executed, or wish to use your
+own wrapper JS to bootstrap the `node` runtime, you can pass a custom instance
+of `NodeRunner::Executor` to `NodeRunner`:
+
+```ruby
+NodeRunner.new "…", executor: NodeRunner::Executor.new(command: "/path/to/custom/node")
+```
+
+`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.
+
+## Testing
+
+* Run `bundle exec rake` to run the test suite.
+
+## Contributing
+
+1. Fork it (https://github.com/bridgetownrb/node-runner/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+task :default => :test

data/lib/node-runner.rb

@@ -0,0 +1,172 @@
+require "tmpdir"
+require "open3"
+require "json"
+
+class NodeRunnerError < StandardError; end
+
+class NodeRunner
+  def initialize(source = "", options = {})
+    @source  = encode(source.strip)
+    @args = options[:args] || {}
+    @executor = options[:executor] || NodeRunner::Executor.new
+    @function_name = options[:function_name] || "main"
+  end
+  
+  def output
+    exec
+  end
+  
+  def method_missing(m, *args, &block)
+    @function_name = m
+    if block
+      @source = encode(block.call.strip)
+    end
+    @args = *args
+    exec
+  end
+
+  protected
+
+  def encode(string)
+    string.encode('UTF-8')
+  end
+  
+  def exec
+    source = @executor.compile_source(@source, @args.to_json, @function_name)
+    tmpfile = write_to_tempfile(source)
+    filepath = tmpfile.path
+
+    begin
+      extract_result(@executor.exec(filepath), filepath)
+    ensure
+      File.unlink(tmpfile)
+    end
+  end
+
+  def create_tempfile(basename)
+    tmpfile = nil
+    Dir::Tmpname.create(basename) do |tmpname|
+      mode    = File::WRONLY | File::CREAT | File::EXCL
+      tmpfile = File.open(tmpname, mode, 0600)
+    end
+    tmpfile
+  end
+
+  def write_to_tempfile(contents)
+    tmpfile = create_tempfile(['node_runner', 'js'])
+    tmpfile.write(contents)
+    tmpfile.close
+    tmpfile
+  end
+
+  def extract_result(output, filename)
+    status, value, stack = output.empty? ? [] : ::JSON.parse(output, create_additions: false)
+    if status == "ok"
+      value
+    else
+      stack ||= ""
+      real_filename = File.realpath(filename)
+      stack = stack.split("\n").map do |line|
+        line.sub(" at ", "")
+            .sub(real_filename, "node_runner")
+            .sub(filename, "node_runner")
+            .strip
+      end
+      stack.shift # first line is already part of the message (aka value)
+      error = NodeRunnerError.new(value)
+      error.set_backtrace(stack + caller)
+      raise error
+    end
+  end
+end
+
+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
+
+    @popen_options = {}
+    @popen_options[:external_encoding] = @encoding if @encoding
+    @popen_options[:internal_encoding] = ::Encoding.default_internal || 'UTF-8'
+
+    if @runner_path
+      instance_eval generate_compile_method(@runner_path)
+    end
+  end
+
+  def exec(filename)
+    stdout, stderr, status = Open3.capture3("#{binary} #{filename}")
+    if status.success?
+      stdout
+    else
+      raise exec_runtime_error(stderr)
+    end
+  end
+  
+  protected
+
+  def binary
+    @binary ||= which(@command)
+  end
+
+  def locate_executable(command)
+    commands = Array(command)
+
+    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 && File.expand_path(cmd, path)
+      end
+    }
+  end
+
+  def generate_compile_method(path)
+    <<-RUBY
+    def compile_source(source, args, func)
+      <<-RUNNER
+      #{IO.read(path)}
+      RUNNER
+    end
+    RUBY
+  end
+
+  def encode_source(source)
+    encoded_source = encode_unicode_codepoints(source)
+    ::JSON.generate("(function(){ #{encoded_source} })()", quirks_mode: true)
+  end
+
+  def encode_unicode_codepoints(str)
+    str.gsub(/[\u0080-\uffff]/) do |ch|
+      "\\u%04x" % ch.codepoints.to_a
+    end
+  end
+
+  def exec_runtime_error(output)
+    error = RuntimeError.new(output)
+    lines = output.split("\n")
+    lineno = lines[0][/:(\d+)$/, 1] if lines[0]
+    lineno ||= 1
+    error.set_backtrace(["(node_runner):#{lineno}"] + caller)
+    error
+  end
+
+  def which(command)
+    Array(command).find do |name|
+      name, args = name.split(/\s+/, 2)
+      path = locate_executable(name)
+
+      next unless path
+
+      args ? "#{path} #{args}" : path
+    end
+  end
+end

data/lib/node_runner.js

@@ -0,0 +1,9 @@
+#{source}
+
+try {
+  const args = #{args}
+  const output = JSON.stringify(['ok', #{func}(...args), []])
+  process.stdout.write(output)
+} catch (err) {
+  process.stdout.write(JSON.stringify(['err', '' + err, err.stack]))
+}

data/lib/version.rb

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

data/node-runner.gemspec

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "lib/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "node-runner"
+  spec.version       = NodeRunner::VERSION
+  spec.author        = "Bridgetown Team"
+  spec.email         = "maintainers@bridgetownrb.com"
+  spec.summary       = "A simple way to execute Javascript in a Ruby context via Node"
+  spec.homepage      = "https://github.com/bridgetownrb/node-runner"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = ">= 2.5"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|script|spec|features)/!) }
+  spec.require_paths = ["lib"]
+end
+

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: node-runner
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Bridgetown Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-30 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: maintainers@bridgetownrb.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/node-runner.rb
+- lib/node_runner.js
+- lib/version.rb
+- node-runner.gemspec
+homepage: https://github.com/bridgetownrb/node-runner
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: A simple way to execute Javascript in a Ruby context via Node
+test_files: []