sprockets-illusionist 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e352a0b15a5ddb95b09c9daf526c88808c6f48c
-  data.tar.gz: 1eb5d68ab1f381bddc67be7211e57a4bfb115b01
+  metadata.gz: c7a3eee8fde5607db4866c3f897201132f48b1ce
+  data.tar.gz: a5986dc33e817201819451dfd0a8e0072dba1202
 SHA512:
-  metadata.gz: aaee57e020598995d97b685cf70f752c66992e5e6e874346d0e60e436ec326373dbea788a59b8d35d73d333e42b36a0741873952e6bb60ce2baf681ca083ae1a
-  data.tar.gz: a989e98ba458e15d53cc9b7b7acf74a4f468d588984a761a2f9bfefed02166bf441eb193f4e667f049260f7baaae68d3af49c9fe9fe8ac6466d5ff84a37caac9
+  metadata.gz: 13d421ac1f0fbe271daa87fb7d87f275f47017303768aea1fb883d11664449b3f94069cda1c4af83b343a8d77951ed674d12a30c891c7443e7c99bc9c5d72567
+  data.tar.gz: 04bfdfdf542891614d96a14a9803d782de23b2b4a3c6297379c7742c6ebe94d059c27eb77516b21151aa2b57afbe8891b7d68192e926f2e3f9b7763bf058c4bb

data/README.md

@@ -1,7 +1,11 @@
 # sprockets-illusionist
 
+[![Gem Version](https://badge.fury.io/rb/sprockets-illusionist.png)](http://badge.fury.io/rb/sprockets-illusionist) [![Code Climate](https://codeclimate.com/github/mirego/sprockets-illusionist.png)](https://codeclimate.com/github/mirego/sprockets-illusionist)
+
 `sprockets-illusionist` makes it possible to transpile your ES6 files into ES5 using the [Illusionist node module](https://github.com/mirego/illusionist) and Sprockets.
 
+**This entire guide assumes that you have [node](http://nodejs.org) and [npm](http://npmjs.org) already installed on your local machine.**
+
 ## Installation
 
 First, you will need the [Illusionist](https://github.com/mirego/illusionist) node package:
@@ -10,7 +14,7 @@ First, you will need the [Illusionist](https://github.com/mirego/illusionist) no
 $ npm install -g illusionist
 ```
 
-Add this line to your application’s Gemfile:
+Add this line to your application’s `Gemfile`:
 
 ```ruby
 gem 'sprockets-illusionist'
@@ -24,15 +28,35 @@ $ bundle
 
 ## Usage
 
-### Setting the `base_path`
+### Options
+
+- `module_type`
+
+	The module type you want to use.
+
+	Available options: `amd`, `cjs` and `globals`
+
+	Default: `amd`
+
+- `base_path` (only applies to AMD modules)
+
+	The `base_path` setting is used to name modules. Module names are relative paths to `base_path`, if you don’t set it, only the file name is used.
+
+- `node_path`
+
+	The path to the node executable.
 
-The `base_path` setting is used to name modules. Module names are relative paths to `base_path`, if you don’t set it, only the file name is used.
+- `illusionist_path`
 
-#### Using Rails
+	The path to the `illusionist` executable.
+
+
+### Integrating with Rails
 
 Create an initializer:
 
 ```ruby
+# sprockets_illusionist.rb
 SprocketsIllusionist::Config.configure do |config|
   config.base_path = Rails.root.join('app', 'assets', 'javascripts')
 
@@ -58,6 +82,82 @@ controllers/foo_controller
 
 With `sprockets-illusionist` just write your JavaScript files with the extension `.js.es6` and everything will be transpiled for you.
 
+## Deploying on Heroku
+
+**This guide assumes that you’re using environment variables which are available in Heroku Labs**
+
+You can enable this feature by doing:
+
+```bash
+$ heroku labs:enable user-env-compile
+```
+
+Let’s get started!
+
+1. You will need to use [heroku-buildpack-multi](https://github.com/ddollar/heroku-buildpack-multi) to install node and Ruby.
+
+	Tell Heroku to use the right buildpack:
+
+	```bash
+	$ heroku config:add BUILDPACK_URL=https://github.com/ddollar/heroku-buildpack-multi.git
+	```
+
+	Create a `.buildpacks` file with the following content:
+
+	```
+	https://github.com/heroku/heroku-buildpack-nodejs.git
+	https://github.com/heroku/heroku-buildpack-ruby.git
+	```
+
+2. You will need to include `illusionist` as a dependency of your project.
+
+	Create a `package.json` file with the following content:
+
+	```json
+	{
+	  "name": "Your-Project",
+	  "version": "0.0.1",
+	  "dependencies": {
+	    "illusionist": "~<insert latest version>"
+	  }
+	}
+	```
+
+	Install the dependencies on your local machine for development:
+
+	```bash
+	$ npm install
+	```
+
+	**Note that `heroku-buildpack-nodejs` does that for you at deploy time.**
+
+3. You will need to link to the local installation of `illusionist` and node to get the latest version.
+
+	Your initializer should look like this:
+
+	```ruby
+	SprocketsIllusionist::Config.configure do |config|
+	  config.node_path = ENV['NODE_BIN_PATH']
+	  config.illusionist_path = ENV['ILLUSIONIST_BIN_PATH']
+	  config.base_path = Rails.root.join('app', 'assets', 'javascripts')
+	  config.module_type = 'amd'
+	end
+	```
+
+	Then in `.env` on your local machine:
+
+	```
+	NODE_BIN_PATH=node
+	ILLUSIONIST_BIN_PATH=./node_modules/.bin/illusionist
+	```
+
+	Finally, set these environment variables on Heroku:
+
+	```bash
+	$ heroku config:set NODE_BIN_PATH=./vendor/node/bin/node
+	$ heroku config:set ILLUSIONIST_BIN_PATH=./node_modules/.bin/illusionist
+	```
+
 ## License
 
 `sprockets-illusionist` is © 2014 [Mirego](http://www.mirego.com) and may be freely distributed under the [New BSD license](http://opensource.org/licenses/BSD-3-Clause).
@@ -65,6 +165,6 @@ See the [`LICENSE.md`](https://github.com/mirego/sprockets-illusionist/blob/mast
 
 ## About Mirego
 
-[Mirego](http://mirego.com) is a team of passionate people who believe that work is a place where you can innovate and have fun. We're a team of [talented people](http://life.mirego.com) who imagine and build beautiful Web and mobile applications. We come together to share ideas and [change the world](http://mirego.org).
+[Mirego](http://mirego.com) is a team of passionate people who believe that work is a place where you can innovate and have fun. We’re a team of [talented people](http://life.mirego.com) who imagine and build beautiful Web and mobile applications. We come together to share ideas and [change the world](http://mirego.org).
 
 We also [love open-source software](http://open.mirego.com) and we try to give back to the community as much as we can.

data/lib/sprockets_illusionist/illusionist_template.rb

@@ -10,8 +10,8 @@ module SprocketsIllusionist
     end
 
     def evaluate(scope, locals, &block)
-      stdout, _stderr, _status = Open3.capture3("#{node_path} #{illusionist_path} #{option_string_from_config}", stdin_data: data)
-      stdout
+      stdout, stderr, _status = Open3.capture3("#{node_path} #{illusionist_path} #{option_string_from_config}", stdin_data: data)
+      stderr.empty? ? stdout : render_error(stderr)
     end
 
   private
@@ -52,5 +52,11 @@ module SprocketsIllusionist
 
       options.join(' ')
     end
+
+    def render_error(error)
+      error = error.gsub('"', '\"').gsub("\n", "\\n")
+      "// The file could not be compiled into JavaScript
+      document.getElementsByTagName('body')[0].innerHTML = \"<pre>#{error}</pre>\";"
+    end
   end
 end

data/lib/sprockets_illusionist/version.rb

@@ -1,3 +1,3 @@
 module SprocketsIllusionist
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sprockets-illusionist
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Charles Demers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-12 00:00:00.000000000 Z
+date: 2014-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler