hsume2-browserify-rails 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 469695df5508ae4f129ba905b0735f0926e54056
-  data.tar.gz: 507fde818f2e615d2eaa38b4175d7496aa177368
+  metadata.gz: 1cfe8c2634c87114f8c83d1d4b8ea1a9b690dbd0
+  data.tar.gz: 7c7170d2a116dec99bd786c71f9d22a4116a477b
 SHA512:
-  metadata.gz: 6d78c3dcb29c3882b5eccb993401b643945fbe9c94c82288ca5a3fbdbb7659382f1f832643b9ec9e87ad76cafd5a94294ce89451db43b9ef3cb33d817e638c61
-  data.tar.gz: 0c3406fb50d87677e2d623a8a418a6163fce0cd62279a42e66a6ea5ff86737208359d11f2d1da170817719d82077dc0d4d7e5f5f292ee08c8063aaeb9a012ffd
+  metadata.gz: d1b467af74253ecc9b46cb13fae112ec518c763755eced4ea2fa67a4a99ba48f6e5bdbed74c9d45f2645927439da1a780229e88e6b2576925a5ffaeb82df4733
+  data.tar.gz: 6c282412818608c37e746d380089de702ffb11fa244f7f877a274ab88b445965d20225bbe4d1f6ea5f406c7e3924eef839502f1ff8a7f2476cfd4d2970c47542

data/.gitignore

@@ -23,3 +23,4 @@ test/dummy/public/system
 test/dummy/db/schema.rb
 tmp
 test/dummy/app/assets/javascripts/*.js
+test/dummy/app/assets/javascripts/**/*.js

data/README.md

@@ -10,12 +10,13 @@ It let's you mix and match  `//= require` directives and `require()` calls for i
 2. Serve assets with Sprockets
 3. Require modules with `require()` (without separate `//= require` directives)
 4. Only build required modules
+5. Require *npm modules* in your Rails assets
 
 ## Getting Started
 
 Add this line to your application's Gemfile:
 
-    gem 'hsume2-browserify-rails'
+    gem "hsume2-browserify-rails", "~> 0.2.0", :require => "browserify-rails"
 
 Create `package.json` in your Rails root:
 
@@ -23,8 +24,7 @@ Create `package.json` in your Rails root:
 {
   "name": "something",
   "devDependencies" : {
-    "browserify": "2.13.x",
-    "module-deps": "1.7.x"
+    "browserify": "~> 3.33"
   },
   "license": "MIT",
   "engines": {
@@ -50,20 +50,10 @@ console.log(foo(12));
 ```
 
 ## Coffeescript
-If you want to use coffeescript files, add coffeeify as a dependency on `package.json`:
-```js
-{
-  "name": "something",
-  "devDependencies" : {
-    "browserify": "2.13.x"
-    "coffeeify": "0.6.x"
-  },
-  "license": "MIT",
-  "engines": {
-    "node": ">= 0.6"
-  }
-}
-```
+
+Coffeescript is handled seamlessly, if you name your files `*.js.coffee`. That
+way the coffeescript compiler will already have done it's work, when we are
+putting the javascript tools to work.
 
 ## Contributing
 
@@ -73,3 +63,4 @@ Pull requests appreciated.
 
 * [Henry Hsu](https://github.com/hsume2)
 * [Cássio Souza](https://github.com/cassiozen)
+* [Marten Lienen](https://github.com/CQQL)

data/lib/browserify-rails.rb

@@ -1,8 +1,9 @@
-require 'sprockets'
+require "sprockets"
 
-require 'browserify-rails/directive_processor'
-require 'browserify-rails/railtie'
-require 'browserify-rails/version'
+require "browserify-rails/browserify_error"
+require "browserify-rails/browserify_processor"
+require "browserify-rails/railtie"
+require "browserify-rails/version"
 
 module BrowserifyRails
 end

data/lib/browserify-rails/browserify_error.rb

@@ -0,0 +1,5 @@
+module BrowserifyRails
+  # Something went wrong while executing browserify
+  class BrowserifyError < RuntimeError
+  end
+end

data/lib/browserify-rails/browserify_processor.rb

@@ -0,0 +1,91 @@
+require "open3"
+require "json"
+
+module BrowserifyRails
+  class BrowserifyProcessor < Tilt::Template
+    BROWSERIFY_CMD = "./node_modules/.bin/browserify".freeze
+
+    def prepare
+    end
+
+    def evaluate(context, locals, &block)
+      if commonjs_module?
+        asset_dependencies(context.environment.paths).each do |path|
+          context.depend_on(path)
+        end
+
+        browserify
+      else
+        data
+      end
+    end
+
+    private
+
+    def commonjs_module?
+      data.to_s.include?("module.exports") || data.to_s.include?("require")
+    end
+
+    # This primarily filters out required files from node modules
+    #
+    # @return [<String>] Paths of dependencies, that are in asset directories
+    def asset_dependencies(asset_paths)
+      dependencies.select do |path|
+        path.start_with?(*asset_paths)
+      end
+    end
+
+    # @return [<String>] Paths of files, that this file depends on
+    def dependencies
+      run_browserify("--list").lines.map(&:strip).select do |path|
+        # Filter the temp file, where browserify caches the input stream
+        File.exists?(path)
+      end
+    end
+
+    def browserify
+      # Only generate source maps in development
+      if Rails.env == "development"
+        options = "-d"
+      else
+        options = ""
+      end
+
+      run_browserify(options)
+    end
+
+    def browserify_cmd
+      cmd = File.join(Rails.root, BROWSERIFY_CMD)
+
+      if !File.exist?(cmd)
+        raise BrowserifyRails::BrowserifyError.new("browserify could not be found at #{cmd}. Please run npm install.")
+      end
+
+      cmd
+    end
+
+    # Run browserify with `data` on standard input.
+    #
+    # We are passing the data via stdin, so that earlier preprocessing steps are
+    # respected. If you had, say, an "application.js.coffee.erb", passing the
+    # filename would fail, because browserify would read the original file with
+    # ERB tags and fail. By passing the data via stdin, we get the expected
+    # behavior of success, because everything has been compiled to plain
+    # javascript at the time this processor is called.
+    #
+    # @raise [BrowserifyRails::BrowserifyError] if browserify does not succeed
+    # @param options [String] Options for browserify
+    # @return [String] Output on standard out
+    def run_browserify(options)
+      command = "#{browserify_cmd} #{options}"
+      directory = File.dirname(file)
+      stdout, stderr, status = Open3.capture3(command, stdin_data: data, chdir: directory)
+
+      if !status.success?
+        raise BrowserifyRails::BrowserifyError.new("Error while running `#{command}`:\n\n#{stderr}")
+      end
+
+      stdout
+    end
+  end
+end

data/lib/browserify-rails/railtie.rb

@@ -1,13 +1,11 @@
 module BrowserifyRails
   class Railtie < Rails::Engine
-
     initializer :setup_browserify do |app|
-      app.assets.register_postprocessor 'application/javascript', BrowserifyRails::DirectiveProcessor
+      app.assets.register_postprocessor "application/javascript", BrowserifyRails::BrowserifyProcessor
     end
 
     rake_tasks do
-      Dir[File.join(File.dirname(__FILE__),'tasks/*.rake')].each { |f| load f }
+      Dir[File.join(File.dirname(__FILE__), "tasks/*.rake")].each { |f| load f }
     end
-
   end
-end
+end

data/lib/browserify-rails/version.rb

@@ -1,3 +1,3 @@
 module BrowserifyRails
-  VERSION = '0.1.0'
+  VERSION = "0.2.1"
 end

data/test/compilation_test.rb

@@ -3,36 +3,84 @@ require 'test_helper'
 class BrowserifyTest < ActionController::IntegrationTest
 
   setup do
-    FileUtils.rm_rf(File.join(Rails.root, 'tmp/cache'))
-    FileUtils.mkdir_p(File.join(Rails.root, 'tmp'))
+    Rails.application.assets.cache = nil
+
     FileUtils.cp(File.join(Rails.root, 'app/assets/javascripts/application.js.example'), File.join(Rails.root, 'app/assets/javascripts/application.js'))
     FileUtils.cp(File.join(Rails.root, 'app/assets/javascripts/foo.js.example'), File.join(Rails.root, 'app/assets/javascripts/foo.js'))
+    FileUtils.cp(File.join(Rails.root, 'app/assets/javascripts/nested/index.js.example'), File.join(Rails.root, 'app/assets/javascripts/nested/index.js'))
   end
 
   test "asset pipeline should serve application.js" do
+    expected_output = fixture("application.out.js")
+
     get "/assets/application.js"
     assert_response :success
-    assert @response.body.include? ";(function(e,t,n){function i(n,s){if(!t[n]){if(!e[n]){var o=typeof require==\"function\"&&require;if(!s&&o)return o(n,!0);if(r)return r(n,!0);throw new Error(\"Cannot find module '\"+n+\"'\")}var u=t[n]={exports:{}};e[n][0].call(u.exports,function(t){var r=e[n][1][t];return i(r?r:t)},u,u.exports)}return t[n].exports}var r=typeof require==\"function\"&&require;for(var s=0;s<n.length;s++)i(n[s]);return i})({1:[function(require,module,exports){\nvar foo = require('./foo');\n\n},{\"./foo\":2}],2:[function(require,module,exports){\nmodule.exports = function (n) { return n * 11 }\n\n},{}]},{},[1])\n"
+    assert_equal expected_output, @response.body.strip
   end
 
   test "asset pipeline should serve foo.js" do
+    expected_output = fixture("foo.out.js")
+
     get "/assets/foo.js"
     assert_response :success
-    assert @response.body.include? ";(function(e,t,n){function i(n,s){if(!t[n]){if(!e[n]){var o=typeof require==\"function\"&&require;if(!s&&o)return o(n,!0);if(r)return r(n,!0);throw new Error(\"Cannot find module '\"+n+\"'\")}var u=t[n]={exports:{}};e[n][0].call(u.exports,function(t){var r=e[n][1][t];return i(r?r:t)},u,u.exports)}return t[n].exports}var r=typeof require==\"function\"&&require;for(var s=0;s<n.length;s++)i(n[s]);return i})({1:[function(require,module,exports){\nmodule.exports = function (n) { return n * 11 }\n\n},{}]},{},[1])\n"
+    assert_equal expected_output, @response.body.strip
   end
 
   test "asset pipeline should regenerate application.js when foo.js changes" do
+    expected_output = fixture("application.out.js")
+
     get "/assets/application.js"
     assert_response :success
-    assert @response.body.include? ";(function(e,t,n){function i(n,s){if(!t[n]){if(!e[n]){var o=typeof require==\"function\"&&require;if(!s&&o)return o(n,!0);if(r)return r(n,!0);throw new Error(\"Cannot find module '\"+n+\"'\")}var u=t[n]={exports:{}};e[n][0].call(u.exports,function(t){var r=e[n][1][t];return i(r?r:t)},u,u.exports)}return t[n].exports}var r=typeof require==\"function\"&&require;for(var s=0;s<n.length;s++)i(n[s]);return i})({1:[function(require,module,exports){\nvar foo = require('./foo');\n\n},{\"./foo\":2}],2:[function(require,module,exports){\nmodule.exports = function (n) { return n * 11 }\n\n},{}]},{},[1])\n"
+    assert_equal expected_output, @response.body.strip
+
+    # Ensure that Sprockets can detect the change to the file modification time
+    sleep 1
 
     File.open(File.join(Rails.root, 'app/assets/javascripts/foo.js'), 'w+') do |f|
+      f.puts "require('./nested');"
       f.puts "module.exports = function (n) { return n * 12 }"
     end
 
+    expected_output = fixture("application.foo_changed.out.js")
+
+    get "/assets/application.js"
+    assert_response :success
+    assert_equal expected_output, @response.body.strip
+  end
+
+  test "asset pipeline should regenerate application.js when application.js changes" do
+    expected_output = fixture("application.out.js")
+
+    get "/assets/application.js"
+    assert_response :success
+    assert_equal expected_output, @response.body.strip
+
+    # Ensure that Sprockets can detect the change to the file modification time
+    sleep 1
+
+    File.open(File.join(Rails.root, 'app/assets/javascripts/application.js'), 'w+') do |f|
+      f.puts "var foo = require('./foo');"
+      f.puts "console.log(foo(11));"
+    end
+
+    expected_output = fixture("application.changed.out.js")
+
     get "/assets/application.js"
     assert_response :success
-    assert @response.body.include? ";(function(e,t,n){function i(n,s){if(!t[n]){if(!e[n]){var o=typeof require==\"function\"&&require;if(!s&&o)return o(n,!0);if(r)return r(n,!0);throw new Error(\"Cannot find module '\"+n+\"'\")}var u=t[n]={exports:{}};e[n][0].call(u.exports,function(t){var r=e[n][1][t];return i(r?r:t)},u,u.exports)}return t[n].exports}var r=typeof require==\"function\"&&require;for(var s=0;s<n.length;s++)i(n[s]);return i})({1:[function(require,module,exports){\nvar foo = require('./foo');\n\n},{\"./foo\":2}],2:[function(require,module,exports){\nmodule.exports = function (n) { return n * 12 }\n\n},{}]},{},[1])\n"
+    assert_equal expected_output, @response.body.strip
   end
 
+  test "throws BrowserifyError if something went wrong while executing browserify" do
+    File.open(File.join(Rails.root, 'app/assets/javascripts/application.js'), 'w+') do |f|
+      f.puts "var foo = require('./foo');"
+      f.puts "var bar = require('./bar');"
+    end
+
+    get "/assets/application.js"
+    assert_match /BrowserifyRails::BrowserifyError/, @response.body
+  end
+
+  def fixture(filename)
+    File.open(File.join(File.dirname(__FILE__), "/fixtures/#{filename}")).read.strip
+  end
 end

data/test/dummy/app/assets/javascripts/foo.js.example

@@ -1 +1,2 @@
+require('./nested');
 module.exports = function (n) { return n * 11 }

data/test/dummy/app/assets/javascripts/nested/index.js.example

@@ -0,0 +1 @@
+module.exports.NESTED = true;

data/test/dummy/package.json

@@ -3,11 +3,10 @@
   "author": "Henry Hsu <hhsu@zendesk.com>",
   "description": "a dummy Rails application",
   "devDependencies" : {
-    "browserify": "2.13.x",
-    "module-deps": "1.7.x"
+    "browserify": "~> 3.33"
   },
   "license": "MIT",
   "engines": {
-    "node": ">= 0.6"
+    "node": ">= 0.10"
   }
 }

data/test/fixtures/application.changed.out.js

@@ -0,0 +1,12 @@
+(function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);throw new Error("Cannot find module '"+o+"'")}var f=n[o]={exports:{}};t[o][0].call(f.exports,function(e){var n=t[o][1][e];return s(n?n:e)},f,f.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o<r.length;o++)s(r[o]);return s})({1:[function(require,module,exports){
+var foo = require('./foo');
+console.log(foo(11));
+
+},{"./foo":2}],2:[function(require,module,exports){
+require('./nested');
+module.exports = function (n) { return n * 11 }
+
+},{"./nested":3}],3:[function(require,module,exports){
+module.exports.NESTED = true;
+
+},{}]},{},[1])

data/test/fixtures/application.foo_changed.out.js

@@ -0,0 +1,11 @@
+(function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);throw new Error("Cannot find module '"+o+"'")}var f=n[o]={exports:{}};t[o][0].call(f.exports,function(e){var n=t[o][1][e];return s(n?n:e)},f,f.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o<r.length;o++)s(r[o]);return s})({1:[function(require,module,exports){
+var foo = require('./foo');
+
+},{"./foo":2}],2:[function(require,module,exports){
+require('./nested');
+module.exports = function (n) { return n * 12 }
+
+},{"./nested":3}],3:[function(require,module,exports){
+module.exports.NESTED = true;
+
+},{}]},{},[1])

data/test/fixtures/application.out.js

@@ -0,0 +1,11 @@
+(function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);throw new Error("Cannot find module '"+o+"'")}var f=n[o]={exports:{}};t[o][0].call(f.exports,function(e){var n=t[o][1][e];return s(n?n:e)},f,f.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o<r.length;o++)s(r[o]);return s})({1:[function(require,module,exports){
+var foo = require('./foo');
+
+},{"./foo":2}],2:[function(require,module,exports){
+require('./nested');
+module.exports = function (n) { return n * 11 }
+
+},{"./nested":3}],3:[function(require,module,exports){
+module.exports.NESTED = true;
+
+},{}]},{},[1])

data/test/fixtures/foo.out.js

@@ -0,0 +1,9 @@
+(function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);throw new Error("Cannot find module '"+o+"'")}var f=n[o]={exports:{}};t[o][0].call(f.exports,function(e){var n=t[o][1][e];return s(n?n:e)},f,f.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o<r.length;o++)s(r[o]);return s})({1:[function(require,module,exports){
+require('./nested');
+module.exports = function (n) { return n * 11 }
+;
+
+},{"./nested":2}],2:[function(require,module,exports){
+module.exports.NESTED = true;
+
+},{}]},{},[1])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hsume2-browserify-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Henry Hsu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-24 00:00:00.000000000 Z
+date: 2014-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sprockets
@@ -81,7 +81,8 @@ files:
 - Rakefile
 - browserify-rails.gemspec
 - lib/browserify-rails.rb
-- lib/browserify-rails/directive_processor.rb
+- lib/browserify-rails/browserify_error.rb
+- lib/browserify-rails/browserify_processor.rb
 - lib/browserify-rails/railtie.rb
 - lib/browserify-rails/tasks/npm.rake
 - lib/browserify-rails/version.rb
@@ -89,6 +90,7 @@ files:
 - test/dummy/Rakefile
 - test/dummy/app/assets/javascripts/application.js.example
 - test/dummy/app/assets/javascripts/foo.js.example
+- test/dummy/app/assets/javascripts/nested/index.js.example
 - test/dummy/app/assets/stylesheets/application.css
 - test/dummy/app/controllers/application_controller.rb
 - test/dummy/app/controllers/home_controller.rb
@@ -120,6 +122,10 @@ files:
 - test/dummy/public/500.html
 - test/dummy/public/favicon.ico
 - test/dummy/script/rails
+- test/fixtures/application.changed.out.js
+- test/fixtures/application.foo_changed.out.js
+- test/fixtures/application.out.js
+- test/fixtures/foo.out.js
 - test/test_helper.rb
 homepage: ''
 licenses:
@@ -150,6 +156,7 @@ test_files:
 - test/dummy/Rakefile
 - test/dummy/app/assets/javascripts/application.js.example
 - test/dummy/app/assets/javascripts/foo.js.example
+- test/dummy/app/assets/javascripts/nested/index.js.example
 - test/dummy/app/assets/stylesheets/application.css
 - test/dummy/app/controllers/application_controller.rb
 - test/dummy/app/controllers/home_controller.rb
@@ -181,4 +188,8 @@ test_files:
 - test/dummy/public/500.html
 - test/dummy/public/favicon.ico
 - test/dummy/script/rails
+- test/fixtures/application.changed.out.js
+- test/fixtures/application.foo_changed.out.js
+- test/fixtures/application.out.js
+- test/fixtures/foo.out.js
 - test/test_helper.rb

data/lib/browserify-rails/directive_processor.rb

@@ -1,70 +0,0 @@
-require 'open3'
-require 'json'
-
-module BrowserifyRails
-  class DirectiveProcessor < Sprockets::DirectiveProcessor
-    BROWSERIFY_CMD  = './node_modules/.bin/browserify'.freeze
-    MODULE_DEPS_CMD = './node_modules/.bin/module-deps'.freeze
-    COFFEEIFY_PATH  = './node_modules/coffeeify'.freeze
-
-    class BrowserifyError < RuntimeError
-    end
-
-    class ModuleDepsError < RuntimeError
-    end
-
-    def evaluate(context, locals, &block)
-      super
-
-      if commonjs_module?(data)
-        browserify_cmd = File.join(context.environment.root, BROWSERIFY_CMD)
-        module_deps_cmd = File.join(context.environment.root, MODULE_DEPS_CMD)
-
-        raise ArgumentError, "#{browserify_cmd} could not be found. Please run npm install." unless File.exist?(browserify_cmd)
-        raise ArgumentError, "#{module_deps_cmd} could not be found. Please run npm install." unless File.exist?(module_deps_cmd)
-
-        deps = JSON.parse(run_command("#{module_deps_cmd} #{pathname}"))
-        deps.each do |dep|
-          path = File.basename(dep['id'], context.environment.root)
-          next if path == File.basename(pathname)
-
-          if path =~ /<([^>]+)>/
-            path = $1
-          else
-            path = "./#{path}" unless relative?(path)
-          end
-
-          context.depend_on_asset(path)
-        end
-
-        params = "-d"
-        params += " -t coffeeify --extension='.coffee'" if File.directory?(COFFEEIFY_PATH)
-
-        run_command("#{browserify_cmd} #{params} #{pathname}")
-      else
-        data
-      end
-    end
-
-    def commonjs_module?(data)
-      data.to_s.include?('module.exports') || data.to_s.include?('require')
-    end
-
-    def run_command(command)
-      stdin, stdout, stderr = Open3.popen3("#{command}")
-      begin
-        result = stdout.read
-        result_error = stderr.read.strip
-        if result_error.empty?
-          result
-        else
-          raise ModuleDepsError, result_error
-        end
-      ensure
-        stdin.close
-        stdout.close
-        stderr.close
-      end
-    end
-  end
-end