browserify-rails 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf502572f6275f391156cf2273f3a0f8b907a366
-  data.tar.gz: 8befbde05169e6bb26cb29755f0fbd741728c28a
+  metadata.gz: 8fc080c61fe2b627b3bbbda924d2f9c26b47bfde
+  data.tar.gz: b37b833f9fc8fa5bdc68880891c6d8db2c2a042c
 SHA512:
-  metadata.gz: d68033290efa9969de781573a246c244db84ed3c1ad275863d75904b5dbcdeef0f705d1c30dec0fbdd83cbb4ddf9bcbf2b0ad6f52295a46951ec98516abb4394
-  data.tar.gz: 87530c1f97cd9d2f07ccabb2e9619bece8e7c5c4a8d6f928facf52d34eaf00400f1cf960de09546235f4deae5c9da3c5c96519fbe963ace578f87264013bdb79
+  metadata.gz: 1254b0e0c49f8e6ebeae8d1edc23f7fca5b846591b622588f7af2db5258ce9f145da0063dc8fb55e0edb34bea7b7acdb26f3df6885913961278d127a8399395a
+  data.tar.gz: e0a6be283f1e0f65e1df78b34a95cb68058d05c33c586267d43e8ba62c58ada5e040d5031403432b0ede5ce8e2b70578a9e14aea297bdf005e366e3be71b886a

data/CHANGELOG.md

@@ -1,6 +1,9 @@
 # Change Log
 All notable changes to this project will be documented in this file going forward.
 
+## [3.1.0] - 2016-05-23
+- relax railties requirement to < 5.1
+
 ## [3.0.1] - 2016-03-03
 - detect import keyword and process as module if found
 

data/README.md

@@ -1,8 +1,5 @@
 # browserify-rails
 
-**If you are using react-rails or experience any issues with browserify-rails 2.x, please use the 1.5.x versions until 2.x is stabilized. Please see the issues for discussions and feel free to post your experience. The use of react-rails with browserify-rails is a bit of an anti-pattern in terms of going to CommonJS so it may never be supported. Consider using a browserify transform for React support.
-
-[![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)
 [![Gem Version](https://badge.fury.io/rb/browserify-rails.svg)](http://badge.fury.io/rb/browserify-rails)
 
 This library adds CommonJS module support to Sprockets (via Browserify).
@@ -29,7 +26,7 @@ Create `package.json` in your Rails root:
 {
   "name": "something",
   "dependencies" : {
-    "browserify": "~> 10.2.4",
+    "browserify": "~10.2.4",
     "browserify-incremental": "^3.0.1"
   },
   "license": "MIT",
@@ -72,21 +69,20 @@ string, comment, or function.
 ## CoffeeScript
 
 For CoffeeScript support, make sure to follow the standard rails
-`.js.coffee` naming convention.  You'll also need to do the following:
-
-Add `coffeeify` as a dependency within `package.json`:
+`.js.coffee` naming convention.  You'll also need to add the npm
+package `coffeeify` as a dependency:
 
 ```js
 {
   // ...
   "dependencies" : {
     // ...
-    "coffeeify": "~> 0.6"
+    "coffeeify": "~0.6"
   }
 }
 ```
 
-Add the following command line options within `application.rb`:
+and configure `browserify_rails` accordingly:
 
 ```rb
 config.browserify_rails.commandline_options = "-t coffeeify --extension=\".js.coffee\""
@@ -107,7 +103,7 @@ mentioned below into your `config/application.rb` or your environment file
 
 ```ruby
 class My::Application < Rails::Application
-  # Paths, that should be browserified. We browserify everything, that
+  # Specify the file paths that should be browserified. We browserify everything that
   # matches (===) one of the paths. So you will most likely put lambdas
   # regexes in here.
   #
@@ -116,7 +112,7 @@ class My::Application < Rails::Application
   # working.
   config.browserify_rails.paths << /vendor\/assets\/javascripts\/module\.js/
 
-  # Environments, in which to generate source maps
+  # Environments in which to generate source maps
   #
   # The default is none
   config.browserify_rails.source_map_environments << "development"
@@ -150,6 +146,14 @@ class My::Application < Rails::Application
 
 [browserify-incremental](https://github.com/jsdf/browserify-incremental) is used to cache browserification of CommonJS modules. One of the side effects is that the absolute module path is included in the emitted JavaScript. Most people do not want this for production code so browerify-incremental is current disabled for the `production` and `staging` environments. Note that counter-intuitively, browserify-incremental helps even with a single build pass of your code because typically the same modules are used multiple times. So it helps even for say asset compilation on a push to Heroku.
 
+#### Enabling browserify-incremental in production
+
+To enable browserify-incremental in production, add the following line to `config/environments/production.rb`:
+
+```ruby
+config.browserify_rails.use_browserifyinc = true
+```
+
 ### Multiple bundles
 
 node-browserify supports [multiple bundles](https://github.com/substack/node-browserify#multiple-bundles)
@@ -174,17 +178,16 @@ javascript:
       - a_huge_library
 ```
 
-Note that any valid browserify option is allowed in the YAML file but not
+Note that any valid browserify option is allowed in the YAML file but not all
 use cases have been considered. If your use case does not work, please open
-an issue with a runnable example of the problem including your
-browserify.yml file.
+an issue with a runnable example of the problem including your browserify.yml file.
 
 ### Inside Isolated Engines
 
 To make browserify-rails work inside an isolated engine, add the engine app directory to the browserify-rails paths (inside engine.rb):
 
 ```ruby
-config.browserify_rails.paths << lambda { |p| p.start_with?(Engine.root.join("app").to_s) }
+config.browserify_rails.paths << -> (p) { p.start_with?(Engine.root.join("app").to_s) }
 ```
 
 If you wish to put the node_modules directory within the engine, you have some control over it with:
@@ -228,10 +231,10 @@ buildpacks that run `bundle` and `npm install` on the target machine.
 
 You can easily use a browserify transform by adding it to your `package.json`, then adding the transform flag to your `application.rb`, using `config.browserify_rails.commandline_options`. For example, here is how you can add ES6 support in your app:
 
-1. Add babelify to your `package.json` in your app's root directory, then run `npm install`
+1. Add `babelify` and `babel-preset-es2015` to your `package.json` in your app's root directory, then run `npm install`
 2. Add this line to your config/application.rb:
-   `config.browserify_rails.commandline_options = "-t babelify --extension-\".es6\""`
-3. Create some `.es6` files and require them with `var m = require('./m.es6')` or `import m from './m.es6`
+   `config.browserify_rails.commandline_options = "-t [ babelify --presets [ es2015 ] --extensions .es6 ]"`
+3. Create some `.es6` files and require them with `var m = require('./m.es6')` or `import m from './m.es6'`
 4. Restart your server, and you now have ES6 support!
 
 
@@ -250,6 +253,16 @@ The second method is definitely brute force but if you experience issues,
 it is definitely worth trying before spending too much time debugging
 why something that is browserified appears to not match the sources files.
 
+### Javascript Tests
+
+If you want to use `browserify` to process test files as well, you will
+need to configure `browserify-rails` to process files in your `spec` or `test`
+directories.
+
+```ruby
+config.browserify_rails.paths << -> (p) { p.start_with?(Rails.root.join("spec/javascripts").to_s) }
+```
+
 ## Acceptance Test Failures
 
 If you have Sprockets precompile multiple JS files, each of which include
@@ -274,6 +287,18 @@ consume the main module. It would be nice to be able to establish this
 relationship in the YAML file to avoid having to manually manage the require
 and external entries for the involved modules.
 
+## Alternatives
+
+### Use webpack or browserify directly instead of the asset pipeline
+
+Use a tool like ProcMan to kick off a webpack or browserify process to rebuild your JavaScript on change. Reference the bundle in your Rails template and away you go. With webpack, you can even use the dev server and point to the dev server port in your Rails template to load JavaScript directly from webpack (it'll block on build so you'll always get your latest code). This does require configuring webpack hot middleware to have a port (see [__webpack_hmr goes to the wrong port and fails](http://stackoverflow.com/questions/35446109/webpack-hmr-goes-to-the-wrong-port-and-fails/35446292#35446292)).
+
+
+### react_on_rails
+
+[Webpack](http://webpack.github.io/) is a popular alternative to Browserify for JavaScript tooling. A quick [Google search](https://www.google.com/search?q=browserify+vs+webpack&gws_rd=ssl) yields many articles on this topic. If you wish to use Webpack with Rails, the most popular solution is the gem [github.com/shakacode/react_on_rails](https://github.com/shakacode/react_on_rails/). While this gem focuses on React integration, it offers a solid example of how to integrate Webpack into your Rails workflow, even supporting hot-module-reloading. It also provides useful helpers to ensure that your Webpack created files are ready before tests run. A live example of these techniques can be found at [github.com/shakacode/react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial/).
+
+
 ## Contributors
 
 * [Henry Hsu](https://github.com/hsume2)

data/browserify-rails.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
 
-  spec.add_runtime_dependency "railties", ">= 4.0.0", "< 5.0"
+  spec.add_runtime_dependency "railties", ">= 4.0.0", "< 5.1"
   spec.add_runtime_dependency "sprockets", ">= 3.5.2"
 
   spec.add_development_dependency "bundler", ">= 1.3"

data/lib/browserify-rails/version.rb

@@ -1,3 +1,3 @@
 module BrowserifyRails
-  VERSION = "3.0.1"
+  VERSION = "3.1.0"
 end

data/test/fixtures/use_import.out.js

@@ -1,4 +1,4 @@
-(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})({"/Users/cymen/dev/browserify-rails/test/dummy/app/assets/javascripts/_stream_0.js":[function(require,module,exports){
+(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})({"/Users/cvig/dev/browserify-rails/test/dummy/app/assets/javascripts/_stream_0.js":[function(require,module,exports){
 'use strict';
 
 var _simple_module = require('./simple_module');
@@ -9,7 +9,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 
 console.log((0, _simple_module2.default)());
 
-},{"./simple_module":"/Users/cymen/dev/browserify-rails/test/dummy/app/assets/javascripts/simple_module.js"}],"/Users/cymen/dev/browserify-rails/test/dummy/app/assets/javascripts/simple_module.js":[function(require,module,exports){
+},{"./simple_module":"__RAILS_ROOT__/app/assets/javascripts/simple_module.js"}],"__RAILS_ROOT__/app/assets/javascripts/simple_module.js":[function(require,module,exports){
 "use strict";
 
 Object.defineProperty(exports, "__esModule", {
@@ -20,4 +20,4 @@ exports.default = function () {
   return 42;
 };
 
-},{}]},{},["/Users/cymen/dev/browserify-rails/test/dummy/app/assets/javascripts/_stream_0.js"]);
+},{}]},{},["__RAILS_ROOT__/app/assets/javascripts/_stream_0.js"]);

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: browserify-rails
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - Henry Hsu, Cymen Vig
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-03 00:00:00.000000000 Z
+date: 2016-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -19,7 +19,7 @@ dependencies:
         version: 4.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 4.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: sprockets
   requirement: !ruby/object:Gem::Requirement
@@ -255,7 +255,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: 'Get the best of both worlds: Browserify + Rails = CommonJS Heaven'