schmooze 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b6a0a8f35d4f1469388e762084d088396808bddb
+  data.tar.gz: a580bee0dcadce15ad6b0b0cd3da7b0c7cbca61a
+SHA512:
+  metadata.gz: 72e0014d48a46d389e088c9ce5675d353febdf1b0cbdb514e496890428ffa067d8c3f1d905f4a3d3892acebc6c9bddd2bf14d8db0ba40148896139e540ddfff6
+  data.tar.gz: aa9d86a8bed3b12741f68096b01d0865224227bd2c82ed1394abf45f920d9d2d70f05a056d3420dc88659be76f3fc685e58f77a2df318d9e1edfb7bf1b92a693

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+node_modules

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in schmooze.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Shopify Inc.
+
+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,106 @@
+# Schmooze
+
+Schmooze lets Ruby and Node.js work together intimately. It has a DSL that allows you to define what methods you need, and it executes code by spawning a Node.js process and sending messages back and forth.
+
+## Requirements
+
+Schmooze requires that you have [nodejs](https://nodejs.org/en/) installed and in the `$PATH`.
+
+## Gem Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'schmooze'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+To use Schmooze, you first need to create a sublcass of `Schmooze::Base`. Your subclass needs to list all of the package dependencies, and methods that you want to have available. For example, here is a Schmooze class that interfaces with [Babel](https://babeljs.io/):
+
+```ruby
+require 'schmooze'
+
+class BabelSchmoozer < Schmooze::Base
+  dependencies babel: 'babel-core'
+
+  method :transform, 'babel.transform'
+  method :version, 'function() { return [process.version, babel.version]; }'
+end
+```
+
+Note that the `babel-core` package is available under the name `babel`, because that's how we requested it.
+
+To define a method, you simply give it a name and pass in a JavaScript string that should resolve to a function. Let's put this class to use!
+
+First we need to make sure we install any needed packages.
+
+`$ npm install babel-core babel-preset-es2015`
+
+All we need to do next is to instantiate the class with a path to where the node modules are installed, and then we can call the methods! (Note that we need to pass in `ast: false` because of a [caveat](#caveats)).
+
+```ruby
+$ pry
+Ruby 2.2.2
+pry> load './babel_schmoozer.rb'
+pry> babel = BabelSchmoozer.new(__dir__)
+pry> babel.version
+=> ["v5.5.0", "6.5.2"]
+pry> puts babel.transform('a = () => 1', ast: false, presets: ['es2015'])['code']
+"use strict";
+
+a = function a() {
+  return 1;
+};
+```
+
+This could easily be turned into a Sprockets plugin.
+
+## Error handling
+
+Errors happen, and Schmooze tries to make them as painless as possible to handle. If there is a dependency missing, Schmooze will throw a helpful Error when you try to initialize the class. Here is an example from the tests:
+
+```ruby
+class ErrorSchmoozer < Schmooze::Base
+  dependencies nonexistant: 'this-package-is-not-here'
+end
+ErrorSchmoozer.new(__dir__)
+```
+
+This will raise
+
+```
+Schmooze::DependencyError: Cannot find module 'this-package-is-not-here'.
+You need to add it to '/Users/bouke/code/schmooze/test/fixtures/uninstalled_package/package.json' and run 'npm install'
+```
+
+Any JavaScript errors that happen get converted to Ruby errors under the `Schmooze::Javascript` namespace. For example (once again, from the tests):
+
+```ruby
+class CoffeeSchmoozer < Schmooze::Base
+  dependencies coffee: 'coffee-script'
+  method :compile, 'coffee.compile'
+end
+
+CoffeeSchmoozer.new(dir).compile('<=> 1')
+```
+
+This will raise
+
+```
+Schmooze::JavaScript::SyntaxError: [stdin]:1:1: error: unexpected <=
+ <=> 1
+ ^^
+```
+
+## Caveats
+
+* Because we serialize the return values from JavaScript to JSON, you can't return circular data structures (like the Babel AST).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/schmooze.

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 => :spec

data/circle.yml

@@ -0,0 +1,13 @@
+machine:
+  node:
+    version: v5.7.0
+  ruby:
+    version: 2.2.2
+
+dependencies:
+  override:
+    - script/setup
+
+test:
+  override:
+    - script/test

data/lib/schmooze.rb

@@ -0,0 +1,7 @@
+module Schmooze
+end
+
+require 'schmooze/version'
+require 'schmooze/errors'
+require 'schmooze/processor_generator'
+require 'schmooze/base'

data/lib/schmooze/base.rb

@@ -0,0 +1,118 @@
+require 'json'
+require 'open3'
+
+require 'schmooze/processor_generator'
+
+module Schmooze
+  class Base
+    class << self
+      protected
+        def dependencies(deps)
+          @imports ||= []
+          deps.each do |identifier, package|
+            @imports << {
+              identifier: identifier,
+              package: package
+            }
+          end
+        end
+
+        def method(name, code)
+          @methods ||= []
+          @methods << {
+            name: name,
+            code: code
+          }
+
+          define_method(name) do |*args|
+            call_js_method(name, args)
+          end
+        end
+
+        def finalize(stdin, stdout, stderr, process_thread)
+          proc do
+            stdin.close
+            stdout.close
+            stderr.close
+            Process.kill(0, process_thread.pid)
+            process_thread.value
+          end
+        end
+    end
+
+    def initialize(root, env={})
+      @env = env
+      @root = root
+      @code = ProcessorGenerator.generate(self.class.instance_variable_get(:@imports) || [], self.class.instance_variable_get(:@methods) || [])
+
+      spawn_process
+    end
+
+    def pid
+      @process_thread.pid
+    end
+
+    private
+      def spawn_process
+        @stdin, @stdout, @stderr, @process_thread = Open3.popen3(
+          @env,
+          'node',
+          '-e',
+          @code,
+          chdir: @root
+        )
+        ensure_packages_are_initiated
+        ObjectSpace.define_finalizer(self, self.class.send(:finalize, @stdin, @stdout, @stderr, @process_thread))
+      end
+
+      def ensure_packages_are_initiated
+        input = @stdout.gets
+        result = JSON.parse(input)
+        unless result[0] == 'ok'
+          @stdin.close
+          @stdout.close
+          @stderr.close
+          @process_thread.join
+
+          error_message = result[1]
+          if /\AError: Cannot find module '(.*)'\z/ =~ error_message
+            package_name = $1
+            package_json_path = File.join(@root, 'package.json')
+            begin
+              package = JSON.parse(File.read(package_json_path))
+              %w(dependencies devDependencies).each do |key|
+                if package.has_key?(key) && package[key].has_key?(package_name)
+                  raise Schmooze::DependencyError, "Cannot find module '#{package_name}'. The module was found in '#{package_json_path}' however, please run 'npm install' from '#{@root}'"
+                end
+              end
+            rescue Errno::ENOENT
+            end
+            raise Schmooze::DependencyError, "Cannot find module '#{package_name}'. You need to add it to '#{package_json_path}' and run 'npm install'"
+          else
+            raise Schmooze::Error, error_message
+          end
+        end
+      end
+
+      def call_js_method(method, args)
+        @stdin.puts JSON.dump([method, args])
+        input = @stdout.gets
+        raise Errno::EPIPE, "Can't read from stdout" if input.nil?
+
+        status, message, error_class = JSON.parse(input)
+
+        if status == 'ok'
+          message
+        else
+          if error_class.nil?
+            raise Schmooze::JavaScript::UnknownError, message
+          else
+            raise Schmooze::JavaScript.const_get(error_class, false), message
+          end
+        end
+      rescue Errno::EPIPE
+        # TODO(bouk): restart or something? If this happens the process is completely broken
+        raise ::StandardError, "Schmooze process failed:\n#{@stderr.read}"
+      end
+  end
+end

data/lib/schmooze/errors.rb

@@ -0,0 +1,11 @@
+module Schmooze
+  Error = Class.new(StandardError)
+  DependencyError = Class.new(Error)
+  module JavaScript
+    Error = Class.new(::Schmooze::Error)
+    UnknownError = Class.new(Error)
+    def self.const_missing(name)
+      const_set(name, Class.new(Error))
+    end
+  end
+end

data/lib/schmooze/processor_generator.rb

@@ -0,0 +1,52 @@
+require 'json'
+
+module Schmooze
+  class ProcessorGenerator
+    class << self
+      def generate(imports, methods)
+%{try {
+#{imports.map {|import| generate_import(import)}.join}} catch (e) {
+  process.stdout.write(JSON.stringify(['err', e.toString()]));
+  process.stdout.write("\\n");
+  process.exit(1);
+}
+process.stdout.write("[\\"ok\\"]\\n");
+var __methods__ = {};
+#{methods.map{ |method| generate_method(method[:name], method[:code]) }.join}
+function __handle_error__(error) {
+  if (error instanceof Error) {
+    process.stdout.write(JSON.stringify(['err', error.toString().replace(new RegExp('^' + error.name + ': '), ''), error.name]));
+  } else {
+    process.stdout.write(JSON.stringify(['err', error.toString()]));
+  }
+  process.stdout.write("\\n");
+}
+require('readline').createInterface({
+  input: process.stdin,
+  terminal: false,
+}).on('line', function(line) {
+  var input = JSON.parse(line);
+  try {
+    Promise.resolve(__methods__[input[0]].apply(null, input[1])
+    ).then(function (result) {
+      process.stdout.write(JSON.stringify(['ok', result]));
+      process.stdout.write("\\n");
+    }).catch(__handle_error__);
+  } catch(error) {
+    __handle_error__(error);
+  }
+});
+}
+      end
+
+      def generate_method(name, code)
+        "__methods__[#{name.to_json}] = (#{code});\n"
+      end
+
+      def generate_import(import)
+        package, mid, path = import[:package].partition('.')
+        "  var #{import[:identifier]} = require(#{package.to_json})#{mid}#{path};\n"
+      end
+    end
+  end
+end

data/lib/schmooze/version.rb

@@ -0,0 +1,3 @@
+module Schmooze
+  VERSION = "0.1.2"
+end

data/schmooze.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'schmooze/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'schmooze'
+  spec.version       = Schmooze::VERSION
+  spec.authors       = ['Bouke van der Bijl']
+  spec.email         = ['bouke@shopify.com']
+
+  spec.license       = "MIT"
+  spec.summary       = %q{Schmooze lets Ruby and Node.js work together intimately.}
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.description   = File.read(File.join(__dir__, 'README.md'))
+  spec.homepage      = 'https://github.com/Shopify/schmooze'
+
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+end

data/script/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -e
+gem install bundler
+bundle install
+pushd test/fixtures/coffee
+npm install
+popd

data/script/test

@@ -0,0 +1,3 @@
+#!/bin/bash
+set -e
+bundle exec rake test

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification
+name: schmooze
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Bouke van der Bijl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: |
+  # Schmooze
+
+  Schmooze lets Ruby and Node.js work together intimately. It has a DSL that allows you to define what methods you need, and it executes code by spawning a Node.js process and sending messages back and forth.
+
+  ## Requirements
+
+  Schmooze requires that you have [nodejs](https://nodejs.org/en/) installed and in the `$PATH`.
+
+  ## Gem Installation
+
+  Add this line to your application's Gemfile:
+
+  ```ruby
+  gem 'schmooze'
+  ```
+
+  And then execute:
+
+      $ bundle
+
+  ## Usage
+
+  To use Schmooze, you first need to create a sublcass of `Schmooze::Base`. Your subclass needs to list all of the package dependencies, and methods that you want to have available. For example, here is a Schmooze class that interfaces with [Babel](https://babeljs.io/):
+
+  ```ruby
+  require 'schmooze'
+
+  class BabelSchmoozer < Schmooze::Base
+    dependencies babel: 'babel-core'
+
+    method :transform, 'babel.transform'
+    method :version, 'function() { return [process.version, babel.version]; }'
+  end
+  ```
+
+  Note that the `babel-core` package is available under the name `babel`, because that's how we requested it.
+
+  To define a method, you simply give it a name and pass in a JavaScript string that should resolve to a function. Let's put this class to use!
+
+  First we need to make sure we install any needed packages.
+
+  `$ npm install babel-core babel-preset-es2015`
+
+  All we need to do next is to instantiate the class with a path to where the node modules are installed, and then we can call the methods! (Note that we need to pass in `ast: false` because of a [caveat](#caveats)).
+
+  ```ruby
+  $ pry
+  Ruby 2.2.2
+  pry> load './babel_schmoozer.rb'
+  pry> babel = BabelSchmoozer.new(__dir__)
+  pry> babel.version
+  => ["v5.5.0", "6.5.2"]
+  pry> puts babel.transform('a = () => 1', ast: false, presets: ['es2015'])['code']
+  "use strict";
+
+  a = function a() {
+    return 1;
+  };
+  ```
+
+  This could easily be turned into a Sprockets plugin.
+
+  ## Error handling
+
+  Errors happen, and Schmooze tries to make them as painless as possible to handle. If there is a dependency missing, Schmooze will throw a helpful Error when you try to initialize the class. Here is an example from the tests:
+
+  ```ruby
+  class ErrorSchmoozer < Schmooze::Base
+    dependencies nonexistant: 'this-package-is-not-here'
+  end
+  ErrorSchmoozer.new(__dir__)
+  ```
+
+  This will raise
+
+  ```
+  Schmooze::DependencyError: Cannot find module 'this-package-is-not-here'.
+  You need to add it to '/Users/bouke/code/schmooze/test/fixtures/uninstalled_package/package.json' and run 'npm install'
+  ```
+
+  Any JavaScript errors that happen get converted to Ruby errors under the `Schmooze::Javascript` namespace. For example (once again, from the tests):
+
+  ```ruby
+  class CoffeeSchmoozer < Schmooze::Base
+    dependencies coffee: 'coffee-script'
+    method :compile, 'coffee.compile'
+  end
+
+  CoffeeSchmoozer.new(dir).compile('<=> 1')
+  ```
+
+  This will raise
+
+  ```
+  Schmooze::JavaScript::SyntaxError: [stdin]:1:1: error: unexpected <=
+   <=> 1
+   ^^
+  ```
+
+  ## Caveats
+
+  * Because we serialize the return values from JavaScript to JSON, you can't return circular data structures (like the Babel AST).
+
+  ## Contributing
+
+  Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/schmooze.
+email:
+- bouke@shopify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- circle.yml
+- lib/schmooze.rb
+- lib/schmooze/base.rb
+- lib/schmooze/errors.rb
+- lib/schmooze/processor_generator.rb
+- lib/schmooze/version.rb
+- schmooze.gemspec
+- script/setup
+- script/test
+homepage: https://github.com/Shopify/schmooze
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Schmooze lets Ruby and Node.js work together intimately.
+test_files: []