schmooze 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6a0a8f35d4f1469388e762084d088396808bddb
-  data.tar.gz: a580bee0dcadce15ad6b0b0cd3da7b0c7cbca61a
+  metadata.gz: a8a15e7e0c0a0e850c397bcf9c6816112484aeb9
+  data.tar.gz: df29bca677de10648f809044bd405284721e94a5
 SHA512:
-  metadata.gz: 72e0014d48a46d389e088c9ce5675d353febdf1b0cbdb514e496890428ffa067d8c3f1d905f4a3d3892acebc6c9bddd2bf14d8db0ba40148896139e540ddfff6
-  data.tar.gz: aa9d86a8bed3b12741f68096b01d0865224227bd2c82ed1394abf45f920d9d2d70f05a056d3420dc88659be76f3fc685e58f77a2df318d9e1edfb7bf1b92a693
+  metadata.gz: 7f1d9acbb36a475de6bad0176cd768354eea42b8ceb3247d8cc4a2da138d03ff0219a08e1ade100a4888744baad99d70561e785c41d3c987e748942c95b729cc
+  data.tar.gz: e3c3e83bec29386d52bdca384ec5b8ce98def024bc105afe944e841005f80e94a330f25c8239194cfcbb261fc5008279c08253fd345ae8c3b4365ca503e7e5ea

data/lib/schmooze/version.rb

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

data/schmooze.gemspec

@@ -11,8 +11,8 @@ Gem::Specification.new do |spec|
 
   spec.license       = "MIT"
   spec.summary       = %q{Schmooze lets Ruby and Node.js work together intimately.}
+  spec.description   = %q{Schmooze allows a Ruby library writer to succintly interoperate between Ruby and JavaScript code. It has a clever DSL to make this possible.}
   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']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: schmooze
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Bouke van der Bijl
@@ -52,113 +52,8 @@ dependencies:
     - - "~>"
       - !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.
+description: Schmooze allows a Ruby library writer to succintly interoperate between
+  Ruby and JavaScript code. It has a clever DSL to make this possible.
 email:
 - bouke@shopify.com
 executables: []