browserify-rails 0.0.1 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 907912f1aadcbeafc0c4d0a980f519e5c9ca1ba6
+  data.tar.gz: 81dfa83d15625dcbc59c3991dbfd040025213702
+SHA512:
+  metadata.gz: be64aec51ab18d1fa128560901a749caff2044419755e38e9eb9092a433e8f63d47fe65f07f514bd31a2f8a826efb48ebab91407ca0e3bddf4b06fa4f8702b32
+  data.tar.gz: ecebfdc971e5617d74278a29dbdaf4d9cd761b5586d517a0cf5ad7faddcf9f79fa2b195ea3c3d4ed1f9fa9042033249cfd776df905f2bdba2980efd87ebc1dfb

data/.gitignore

@@ -14,4 +14,13 @@ rdoc
 spec/reports
 test/tmp
 test/version_tmp
+test/dummy/data
+test/dummy/db/*.sqlite3
+test/dummy/log/*
+test/dummy/node_modules
+test/dummy/public/assets
+test/dummy/public/system
+test/dummy/db/schema.rb
 tmp
+test/dummy/app/assets/javascripts/*.js
+test/dummy/app/assets/javascripts/**/*.js

data/.travis.yml

@@ -0,0 +1 @@
+language: ruby

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Aaron Rutkovsky
+Copyright (c) 2013 Henry Hsu
 
 MIT License
 
@@ -19,4 +19,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,29 +1,97 @@
-# Browserify::Rails
+# browserify-rails
 
-TODO: Write a gem description
+[![Build Status](https://travis-ci.org/hsume2/browserify-rails.png?branch=master)](https://travis-ci.org/hsume2/browserify-rails)
 
-## Installation
+This library adds CommonJS module support to Sprockets (via Browserify).
+
+It let's you mix and match  `//= require` directives and `require()` calls for including plain javascript files as well as modules.
+
+1. Manage JS modules with `npm`
+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 'browserify-rails'
+    gem "hsume2-browserify-rails", "~> 0.2.0", :require => "browserify-rails"
+
+Create `package.json` in your Rails root:
+
+```js
+{
+  "name": "something",
+  "devDependencies" : {
+    "browserify": "~> 4.1"
+  },
+  "license": "MIT",
+  "engines": {
+    "node": ">= 0.10"
+  }
+}
+```
+
+Then run:
+
+    npm install
 
-And then execute:
+Then start writing CommonJS, and everything will magically work!:
 
-    $ bundle
+```js
+// foo.js
+module.exports = function (n) { return n * 11 }
 
-Or install it yourself as:
+// application.js
+var foo = require('./foo');
+console.log(foo(12));
+```
 
-    $ gem install browserify-rails
+## Coffeescript
 
-## Usage
+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.
 
-TODO: Write usage instructions here
+## Configuration
+
+You can configure different options of browserify-rails by adding one of lines
+mentioned below into your `config/application.rb` or your environment file
+(`config/environments/*.rb`):
+
+```ruby
+class My::Application < Rails::Application
+  # Paths, that should be browserified. We browserify everything, that
+  # matches (===) one of the paths. So you will most likely put lambdas
+  # regexes in here.
+  #
+  # By default only files in /app and /node_modules are browserified,
+  # vendor stuff is normally not made for browserification and may stop
+  # working.
+  config.browserify_rails.paths << /vendor\/assets\/javascripts\/module.js/
+
+  # Environments, in which to generate source maps
+  #
+  # The default is `["development"]`.
+  config.browserify_rails.source_map_environments << "production"
+
+  # Command line options used when running browserify
+  #
+  # can be provided as an array:
+  config.browserify_rails.commandline_options = ["-t browserify-shim", "--fast"]
+
+  # or as a string:
+  config.browserify_rails.commandline_options = "-t browserify-shim --fast"
+```
 
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+Pull requests appreciated.
+
+## Contributors
+
+* [Henry Hsu](https://github.com/hsume2)
+* [Cássio Souza](https://github.com/cassiozen)
+* [Marten Lienen](https://github.com/CQQL)
+* [Lukasz Sagol](https://github.com/zgryw)

data/Rakefile

@@ -1 +1,27 @@
 require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+namespace :dummy do
+  namespace :npm do
+    desc "Run npm install for dummy app"
+    task :install do
+      dummy_dir = Bundler.root.join 'test/dummy'
+
+      sh "cd #{dummy_dir} && npm install" do |ok, res|
+        fail "Error running npm install in #{dummy_dir}." unless ok
+      end
+    end
+  end
+end
+
+task :test => ['dummy:npm:install']
+
+task :default => :test

data/browserify-rails.gemspec

@@ -1,22 +1,27 @@
-# -*- encoding: utf-8 -*-
+# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'browserify-rails/version'
 
-Gem::Specification.new do |gem|
-  gem.name          = "browserify-rails"
-  gem.version       = "0.0.1"
-  gem.authors       = ["Aaron Rutkovsky"]
-  gem.email         = ["aaron.rutkovsky@gmail.com"]
-  gem.description   = %q{Rails + Browserify}
-  gem.summary       = %q{summary}
-  gem.homepage      = ""
-  gem.license       = "MIT"
+Gem::Specification.new do |spec|
+  spec.name          = "browserify-rails"
+  spec.version       = BrowserifyRails::VERSION
+  spec.authors       = ["Henry Hsu"]
+  spec.email         = ["hhsu@zendesk.com"]
+  spec.description   = %q{Browserify + Rails = CommonJS Heaven}
+  spec.summary       = %q{Get the best of both worlds: Browserify + Rails = CommonJS Heaven}
+  spec.homepage      = ""
+  spec.license       = "MIT"
 
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
 
-  gem.add_development_dependency "rake"
-  gem.add_development_dependency "rspec"
+  spec.add_runtime_dependency "sprockets", "~> 2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rails", "~> 3.2"
+  spec.add_development_dependency "mocha"
 end

data/lib/browserify-rails.rb

@@ -1 +1,9 @@
+require "sprockets"
 
+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,109 @@
+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 should_browserify? && commonjs_module?
+        asset_dependencies(context.environment.paths).each do |path|
+          context.depend_on(path)
+        end
+
+        browserify
+      else
+        data
+      end
+    end
+
+    private
+
+    def should_browserify?
+      Rails.application.config.browserify_rails.paths.any? do |path_spec|
+        path_spec === file
+      end
+    end
+
+    # Is this a commonjs module?
+    #
+    # Be here as strict as possible, so that non-commonjs files are not
+    # preprocessed.
+    def commonjs_module?
+      data.to_s.include?("module.exports") || dependencies.length > 0
+    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
+      @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
+      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)
+      # The dash tells browserify to read from STDIN
+      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
+
+    def options
+      options = []
+
+      options.push("-d") if config.source_map_environments.include?(Rails.env)
+
+      options += Array(config.commandline_options) if config.commandline_options.present?
+
+      options.uniq.join(" ")
+    end
+
+    def config
+      BrowserifyRails::Railtie.config.browserify_rails
+    end
+  end
+end

data/lib/browserify-rails/railtie.rb

@@ -0,0 +1,20 @@
+module BrowserifyRails
+  class Railtie < Rails::Engine
+    config.browserify_rails = ActiveSupport::OrderedOptions.new
+
+    # Which paths should be browserified?
+    config.browserify_rails.paths = [lambda { |p| p.start_with?(Rails.root.join("app").to_s) },
+                                     lambda { |p| p.start_with?(Rails.root.join("node_modules").to_s) }]
+
+    # Environments to generate source maps in
+    config.browserify_rails.source_map_environments = ["development"]
+
+    initializer :setup_browserify do |app|
+      app.assets.register_postprocessor "application/javascript", BrowserifyRails::BrowserifyProcessor
+    end
+
+    rake_tasks do
+      Dir[File.join(File.dirname(__FILE__), "tasks/*.rake")].each { |f| load f }
+    end
+  end
+end

data/lib/browserify-rails/tasks/npm.rake

@@ -0,0 +1,20 @@
+namespace :npm do
+  desc "Run npm install"
+  task :install do
+    sh "npm install" do |ok, res|
+      fail "Error running npm install." unless ok
+    end
+  end
+
+  desc "Clean npm node_modules"
+  task :clean do
+    sh "rm -rf ./node_modules" do |ok, res|
+      fail "Error cleaning npm node_modules." unless ok
+    end
+  end
+
+  namespace :install do
+    desc "Run a clean npm install"
+    task :clean => ['npm:clean', 'npm:install']
+  end
+end

data/lib/browserify-rails/version.rb

@@ -0,0 +1,3 @@
+module BrowserifyRails
+  VERSION = "0.3.0"
+end

data/test/browserify_processor_test.rb

@@ -0,0 +1,46 @@
+require 'test_helper'
+
+class BrowserifyProcessorTest < ActiveSupport::TestCase
+  setup do
+    @empty_module = fixture("empty_module.js")
+    @processor = BrowserifyRails::BrowserifyProcessor.new { |p| @empty_module }
+  end
+
+  test "should run command without options if none provided" do
+    stub_engine_config :commandline_options, nil
+    assert_equal "", @processor.send(:options)
+  end
+
+  test "should run command without options if empty array provided" do
+    stub_engine_config :commandline_options, []
+    assert_equal "", @processor.send(:options)
+  end
+
+  test "should convert options provided as an array to string" do
+    stub_engine_config :commandline_options, ["-d", "-i test1.js"]
+    assert_equal "-d -i test1.js", @processor.send(:options)
+  end
+
+  test "should allow providing options as a string" do
+    stub_engine_config :commandline_options, "-d -i test2.js"
+
+    assert_equal "-d -i test2.js", @processor.send(:options)
+  end
+
+  test "should remove duplicate options when provided as an array" do
+    stub_engine_config :commandline_options, ["-d", "-i test3.js", "-d"]
+
+    assert_equal "-d -i test3.js", @processor.send(:options)
+  end
+
+  test "should add -d option if current env is in source_maps_env list" do
+    stub_engine_config :commandline_options, ["-i test4.js"]
+    stub_engine_config :source_map_environments, [Rails.env]
+
+    assert_equal "-d -i test4.js", @processor.send(:options)
+  end
+
+  def stub_engine_config(key, value)
+    @processor.send(:config).stubs(key).returns(value)
+  end
+end