browserify-rails 0.9.1 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 753653fe9ebcc36fcbfe9ebcb4a44050ecc8e382
-  data.tar.gz: 8f7f954f0c7b9f4d254e4e5e7cb0324f9a06a266
+  metadata.gz: 7f9e37a33cb04145996240865debf9ea327d1feb
+  data.tar.gz: bcee606ba1195f4147ee10d698063cb3d926c919
 SHA512:
-  metadata.gz: 78bfe52c9f4c44658b35ea15116a5b5c26328b5c990b8c70d30bba305bbd0378c6d9e15901f5c8d7a828e122b40903c6b3f5f6301ce39b21a61a49085c2fa1b9
-  data.tar.gz: 970bfab72485509afa047b616c40f78623352c3f052816b44bcdd56ae61914534e3de54d46e903340a39a980f15385cf0fc6a9d5284d92f682b0b6f6a31888e2
+  metadata.gz: aaa4a37b369a164fd6db990c0a57b1ae8e39cbaddf182f19b42551dee0a9a6b18f8acb9aeba457ef325a22c4efbb584519300cecf29ece3368fecf66f8f92128
+  data.tar.gz: 5a198d7ea6c81f0f053c039929a88db67522c0816943701016538e7b7466485e46db96fc6ed5d69fe436c1d69fe3552d0b7973a28ad420e8e2a4056220c05b5c

data/.gitignore

@@ -25,5 +25,6 @@ tmp
 test/dummy/app/assets/javascripts/*.js
 test/dummy/app/assets/javascripts/**/*.js
 test/dummy/app/assets/javascripts/**/*.js.coffee
+test/dummy/app/assets/javascripts/**/*.map
 /.ruby-*
 vendor/*

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Change Log
 All notable changes to this project will be documented in this file going forward.
 
+## [0.9.3] - 2015-06-03
+- allow parentheses in path names
+- support for piping output through Exorcist to extract sourcemaps
+
 ## [0.9.1] - 2015-04-20
 - options can be set to a proc
 

data/README.md

@@ -1,4 +1,6 @@
 # browserify-rails
+
+[![Join the chat at https://gitter.im/browserify-rails/browserify-rails](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/browserify-rails/browserify-rails?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![Build Status](https://travis-ci.org/browserify-rails/browserify-rails.svg?branch=master)](https://travis-ci.org/browserify-rails/browserify-rails)
 [![Gem Version](https://badge.fury.io/rb/browserify-rails.svg)](http://badge.fury.io/rb/browserify-rails)
 

data/lib/browserify-rails/browserify_processor.rb

@@ -1,6 +1,7 @@
 require "open3"
 require "fileutils"
 require "tempfile"
+require "shellwords"
 
 module BrowserifyRails
   class BrowserifyProcessor < Tilt::Template
@@ -39,6 +40,10 @@ module BrowserifyRails
       @browserifyinc_cmd ||= File.join(config.node_bin, "browserifyinc").freeze
     end
 
+    def exorcist_cmd
+      @exorcist_cmd ||= rails_path(File.join(config.node_bin, "exorcist").freeze)
+    end
+
     def ensure_tmp_dir_exists!
       FileUtils.mkdir_p(rails_path(tmp_path))
     end
@@ -119,10 +124,10 @@ module BrowserifyRails
     # NODE_ENV is set to the Rails.env. This is used by some modules to determine
     # how to build. Example: https://facebook.github.io/react/downloads.html#npm
     def env
-      {
-        "NODE_PATH" => asset_paths,
-        "NODE_ENV"  => config.node_env || Rails.env
-      }
+      env_hash = {}
+      env_hash["NODE_PATH"] = asset_paths unless uses_exorcist
+      env_hash["NODE_ENV"] = config.node_env || Rails.env
+      env_hash
     end
 
     # Run the requested version of browserify (browserify or browserifyinc)
@@ -147,7 +152,7 @@ module BrowserifyRails
       # we're going to use browserifyinc.
       if uses_browserifyinc(force_browserifyinc)
         cache_file_path = rails_path(tmp_path, "browserifyinc-cache.json")
-        command_options << " --cachefile=#{cache_file_path.inspect}"
+        command_options << " --cachefile=#{Shellwords.escape(cache_file_path.inspect)}"
       end
 
       # Create a temporary file for the output. Such file is necessary when
@@ -156,7 +161,7 @@ module BrowserifyRails
       command_options << " -o #{output_file.path.inspect}"
 
       # Compose the full command (using browserify or browserifyinc as necessary)
-      command = "#{browserify_command(force_browserifyinc)} #{command_options} -"
+      command = "#{Shellwords.escape(browserify_command(force_browserifyinc))} #{command_options} -"
 
       # The directory the command will be executed from
       base_directory = File.dirname(file)
@@ -168,6 +173,26 @@ module BrowserifyRails
         raise BrowserifyRails::BrowserifyError.new("Error while running `#{command}`:\n\n#{stderr}")
       end
 
+      # If using exorcist, pipe output from browserify command into exorcist
+      if uses_exorcist && logical_path
+        if stdout.present?
+          bfy_output = stdout
+        else
+          bfy_output = output_file.read
+        end
+        sourcemap_output_file = "#{File.dirname(file)}/#{logical_path.split('/')[-1]}.map"
+        exorcist_command = "#{exorcist_cmd} #{sourcemap_output_file} #{exorcist_options}"
+        Logger::log "Exorcist: #{exorcist_command}"
+        exorcist_stdout, exorcist_stderr, exorcist_status = Open3.capture3(env,
+                                                                           exorcist_command,
+                                                                           stdin_data: bfy_output,
+                                                                           chdir: base_directory)
+
+        if !exorcist_status.success?
+          raise BrowserifyRails::BrowserifyError.new("Error while running `#{exorcist_command}`:\n\n#{exorcist_stderr}")
+        end
+      end
+
       # Read the output that was stored in the temp file
       output = output_file.read
 
@@ -177,7 +202,10 @@ module BrowserifyRails
 
       # Some command flags (such as --list) make the output go to stdout,
       # ignoring -o. If this happens, we give out stdout instead.
-      if stdout.present?
+      # If we're using exorcist, then we directly use its output
+      if uses_exorcist && exorcist_stdout.present?
+        exorcist_stdout
+      elsif stdout.present?
         stdout
       else
         output
@@ -188,11 +216,15 @@ module BrowserifyRails
       !force.nil? ? force : config.use_browserifyinc
     end
 
+    def uses_exorcist
+      config.use_exorcist
+    end
+
     def browserify_command(force=nil)
       rails_path(uses_browserifyinc(force) ? browserifyinc_cmd : browserify_cmd)
     end
 
-    def options_to_array(options, file)
+    def options_to_array(options)
       if options.respond_to? :call
         options.call(file)
       else
@@ -200,16 +232,23 @@ module BrowserifyRails
       end
     end
 
-    def options(file = file)
+    def options
       options = []
 
       options.push("-d") if config.source_map_environments.include?(Rails.env)
 
-      options += options_to_array(config.commandline_options, file) if config.commandline_options.present?
+      options += options_to_array(config.commandline_options) if config.commandline_options.present?
 
       options.uniq.join(" ")
     end
 
+    def exorcist_options
+      exorcist_options = []
+      exorcist_base_path = config.exorcist_base_path || config.root
+      exorcist_options.push("-b #{exorcist_base_path}")
+      exorcist_options.join(" ")
+    end
+
     def get_granular_config(logical_path)
       granular_config = config.granular["javascript"]
 

data/lib/browserify-rails/version.rb

@@ -1,3 +1,3 @@
 module BrowserifyRails
-  VERSION = "0.9.1"
+  VERSION = "0.9.3"
 end

data/test/browserify_processor_test.rb

@@ -2,8 +2,11 @@ require 'test_helper'
 
 class BrowserifyProcessorTest < ActiveSupport::TestCase
   setup do
-    @empty_module = fixture("empty_module.js")
-    @processor = BrowserifyRails::BrowserifyProcessor.new { |p| @empty_module }
+    template = "empty_module.js"
+    @empty_module = fixture(template)
+    @processor = BrowserifyRails::BrowserifyProcessor.new(template) do |p|
+      @empty_module
+    end
   end
 
   test "should run command without options if none provided" do
@@ -34,8 +37,8 @@ class BrowserifyProcessorTest < ActiveSupport::TestCase
   end
 
   test "should allow command line options to be a function" do
-    stub_engine_config :commandline_options, -> file { ["-d", "-i #{file}.js"] }
-    assert_equal "-d -i foo.js", @processor.send(:options, "foo")
+    stub_engine_config :commandline_options, -> file { ["-d", "-i #{file}"] }
+    assert_equal "-d -i empty_module.js", @processor.send(:options)
   end
 
   test "should add -d option if current env is in source_maps_env list" do

data/test/compilation_test.rb

@@ -184,6 +184,29 @@ class BrowserifyTest < ActionController::IntegrationTest
     assert_equal expected_output, @response.body.strip
   end
 
+  test "generates sourcemap and writes to file if --use-exorcist" do
+    [:set_base_path, :default_base_path].each do |mode|
+      processor = BrowserifyRails::BrowserifyProcessor.new { |p| fixture("plain.js") }
+      processor.send(:config).stubs(:commandline_options).returns(["-d"])
+      Dummy::Application.config.browserify_rails.use_exorcist = true
+      if mode == :set_base_path
+        Dummy::Application.config.browserify_rails.exorcist_base_path = File.join(File.dirname(File.expand_path(__FILE__))).to_s
+      else
+        Dummy::Application.config.browserify_rails.exorcist_base_path = nil
+      end
+      begin
+        expected_output = fixture("js-with-sourcemap-url.out.js")
+
+        get "/assets/application.js"
+
+        assert_response :success
+        assert_equal expected_output, @response.body.strip
+      ensure
+        Dummy::Application.config.browserify_rails.use_exorcist = false
+      end
+    end
+  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');"

data/test/dummy/package.json

@@ -6,6 +6,7 @@
     "browserify": "~> 6.2",
     "browserify-incremental": "^1.4.0",
     "coffeeify": "~> 0.6",
+    "exorcist": "~> 0.3.0",
     "node-test-package": "~> 0.0.2"
   },
   "license": "MIT",

data/test/fixtures/js-with-sourcemap-url.out.js

@@ -0,0 +1,16 @@
+(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);var f=new Error("Cannot find module '"+o+"'");throw f.code="MODULE_NOT_FOUND",f}var l=n[o]={exports:{}};t[o][0].call(l.exports,function(e){var n=t[o][1][e];return s(n?n:e)},l,l.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})({"__RAILS_ROOT__/app/assets/javascripts/_stream_0.js":[function(require,module,exports){
+var foo = require('./foo');
+var nodeTestPackage = require('node-test-package');
+
+},{"./foo":"__RAILS_ROOT__/app/assets/javascripts/foo.js","node-test-package":"__RAILS_ROOT__/node_modules/node-test-package/index.js"}],"__RAILS_ROOT__/app/assets/javascripts/foo.js":[function(require,module,exports){
+require('./nested');
+module.exports = function (n) { return n * 11 }
+
+},{"./nested":"__RAILS_ROOT__/app/assets/javascripts/nested/index.js"}],"__RAILS_ROOT__/app/assets/javascripts/nested/index.js":[function(require,module,exports){
+module.exports.NESTED = true;
+
+},{}],"__RAILS_ROOT__/node_modules/node-test-package/index.js":[function(require,module,exports){
+module.exports = console.log("hello friend");
+
+},{}]},{},["__RAILS_ROOT__/app/assets/javascripts/_stream_0.js"])
+//# sourceMappingURL=application.map

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: browserify-rails
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.3
 platform: ruby
 authors:
 - Henry Hsu, Cymen Vig
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-20 00:00:00.000000000 Z
+date: 2015-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sprockets
@@ -202,6 +202,7 @@ files:
 - test/fixtures/browserified.out.js
 - test/fixtures/empty_module.js
 - test/fixtures/foo.out.js
+- test/fixtures/js-with-sourcemap-url.out.js
 - test/fixtures/main.out.js
 - test/fixtures/mocha.js
 - test/fixtures/node_path_based_require.out.js
@@ -293,6 +294,7 @@ test_files:
 - test/fixtures/browserified.out.js
 - test/fixtures/empty_module.js
 - test/fixtures/foo.out.js
+- test/fixtures/js-with-sourcemap-url.out.js
 - test/fixtures/main.out.js
 - test/fixtures/mocha.js
 - test/fixtures/node_path_based_require.out.js