webpack-rails 0.0.1 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1dd95fbc45c74fae0baf21f9a6ea1913ce20bc6
-  data.tar.gz: 1290831b5deaf7579b449f14a717f0c60e4c84a8
+  metadata.gz: e8ed91330119b96f41c0089cd1fa500192ee48de
+  data.tar.gz: 487700e5d02b4f62d4d6d69a1a0229035b42bff5
 SHA512:
-  metadata.gz: fb372999b1751a5526f88cbd3014f35f159170f7ea41d0f1f30c53e1ea749f8363060b3229633968c587231e8b54fccce1b93999657041aa1ce7b72901326824
-  data.tar.gz: 4e796dafeac7ba5d2667609936164654cc5c15165def8e1730be189d81d14b0942121d4f0570657a262be80253864ca5843f9c0e9971390475f727d0514905d2
+  metadata.gz: 4e198a0d4f06183ca3e44c53e3d6b37ac04eff2c61524084e6b75a118c3b2aa851f9d5d44a20f54131cd63ef47311f94f08c2ad578680ad0107fea9ea7a2ca32
+  data.tar.gz: 71b2eb10a882de41005f18221cca32b86daa7fa4d66c9e9692fbd76b9454c3e9f9d1cd5371a6e1b711240f96f3673d832b7a3f3d2466347ce8c3a887c5321b4a

data/{LICENSE.txt → MIT-LICENSE}

@@ -1,6 +1,4 @@
-Copyright (c) 2014 Leonard Garvey
-
-MIT License
+Copyright 2015 Michael Pearson
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,31 +1,70 @@
-# Webpack::Rails
+# webpack-rails
 
-TODO: Write a gem description
+[![Build Status](https://travis-ci.org/mipearson/webpack-rails.svg?branch=master)](https://travis-ci.org/mipearson/webpack-rails)
 
-## Installation
+**webpack-rails** gives you tools to integrate Webpack in to an existing Ruby on Rails application.
 
-Add this line to your application's Gemfile:
+It will happily co-exist with sprockets but does not use it for production fingerprinting or asset serving. **webpack-rails** is designed with the assumption that if you're using Webpack you treat Javascript as a first-class citizen. This means that you control the webpack config, package.json, and use npm to install Webpack & its plugins.
 
-```ruby
-gem 'webpack-rails'
+In development mode [webpack-dev-server](http://webpack.github.io/docs/webpack-dev-server.html) is used to serve webpacked entry points and offer hot module reloading. In production entry points are built in to `public/webpack`. **webpack-rails** uses [stats-webpack-plugin](https://www.npmjs.com/package/stats-webpack-plugin) to translate entry points in to asset paths.
+
+It was designed for use at [Marketplacer](http://www.marketplacer.com) to assist us in migrating our Javascript (and possibly our SCSS) off of Sprockets. It first saw production use in June 2015.
+
+As this is pre-1.0 software its API and configuration may change as we become more familiar with Webpack. This gem has been developed against Ruby 2.2 and Rails 4.2. Previous versions might work, but I haven't tested them. Assume Rails 3.2 and Ruby 1.9 as an absolute minimum.
+
+## Getting Started
+
+Have a look at the files in the `examples` directory. Of note:
+
+  * We use [foreman](https://github.com/ddollar/foreman) and a `Procfile` to run our rails server & the webpack dev server in development at the same time
+  * The webpack and gem configuration must be in sync - look at our railtie for configuration options
+  * We require that **stats-webpack-plugin** is loaded to automatically generate a production manifest & resolve paths during development
+
+To access webpacked assets from your views:
+
+```erb
+<%= javascript_include_tag *webpack_asset_paths("entry_point_name") %>
 ```
 
-And then execute:
+Take note of the splat (`*`): `webpack_asset_paths` returns an array, as one entry point can map to multiple paths, especially if hot reloading is enabled in Webpack.
 
-    $ bundle
+### Configuration Defaults
 
-Or install it yourself as:
+  * Webpack configuration lives in `config/webpack.config.js`
+  * Webpack & Webpack Dev Server binaries are in `node_modules/.bin/`
+  * Webpack Dev Server will run on port 3808 on localhost
+  * Webpack Dev Server is enabled in development & test, but not in production
+  * Webpacked assets will be compiled to `public/webpack`
+  * The manifest file is named `manifest.json`
 
-    $ gem install webpack-rails
+### Working with browser tests
 
-## Usage
+In development, we make sure that the `webpack-dev-server` is running when browser tests are running. In CI, we manually run `webpack` to compile the assets to public and set `config.webpack.dev_server.enabled` to false.
 
-TODO: Write usage instructions here
+### Production Deployment
+
+Add `rake webpack:compile` to your deployment. It serves a similar purpose as Sprockets' `assets:precompile` task. If you're using Webpack and Sprockets (as we are at Marketplacer) you'll need to run both tasks - but it doesn't matter which order they're run in.
+
+If you're using `[chunkhash]` in your build asset filenames (which you should be, if you want to cache them in production), you'll need to persist built assets between deployments. Consider in-flight requests at the time of deployment: they'll receive paths based on the old `manifest.json`, not the new one.
+
+## TODO
+
+* Release gem
+* travisci & codeclimate & gem badges
+* Drive config via JSON, have webpack.config.js read same JSON?
+* Generators for webpack config, Gemfile, Procfile, package.json
+* Custom webpack-dev-server that exposes errors, stats, etc
+* [react-rails](https://github.com/reactjs/react-rails) fork for use with this workflow
+* Integration tests
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/webpack-rails/fork )
-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 a new Pull Request
+Pull requests & issues welcome. Advice & criticism regarding webpack config approach also welcome.
+
+Please ensure that pull requests pass both rubocop & rspec. New functionality should be discussed in an issue first.
+
+## Acknowledgements
+
+* Len Garvey for his [webpack-rails](https://github.com/lgarvey/webpack-rails) gem which inspired this implementation
+* Sebastian Porto for [Rails with Webpack](https://reinteractive.net/posts/213-rails-with-webpack-why-and-how)
+* Clark Dave for [How to use Webpack with Rails](http://clarkdave.net/2015/01/how-to-use-webpack-with-rails/)

data/Rakefile

@@ -1,2 +1,24 @@
-require "bundler/gem_tasks"
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
 
+require 'rdoc/task'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'WebpackRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+task default: [:rubocop, :spec]

data/lib/tasks/webpack.rake

@@ -0,0 +1,18 @@
+namespace :webpack do
+  desc "Compile webpack bundles"
+  task compile: :environment do
+    ENV["TARGET"] = 'production'
+    webpack_bin = ::Rails.root.join(::Rails.configuration.webpack.binary)
+    config_file = ::Rails.root.join(::Rails.configuration.webpack.config_file)
+
+    unless File.exist?(webpack_bin)
+      raise "Can't find our webpack executable at #{webpack_bin} - have you run `npm install`?"
+    end
+
+    unless File.exist?(config_file)
+      raise "Can't find our webpack config file at #{config_file}"
+    end
+
+    sh "#{webpack_bin} --bail --config #{config_file}"
+  end
+end

data/lib/webpack/rails.rb

@@ -1,4 +1,2 @@
 require 'webpack/rails/version'
-if defined? Rails::Railtie
-  require 'webpack/railtie'
-end
+require 'webpack/railtie' if defined? ::Rails::Railtie

data/lib/webpack/rails/helper.rb

@@ -1,33 +1,31 @@
 require 'action_view'
+require 'webpack/rails/manifest'
 
 module Webpack
   module Rails
+    # Asset path helpers for use with webpack
     module Helper
-      include ActionView::Helpers::AssetUrlHelper
-      include ActionView::Helpers::AssetTagHelper
+      # Return asset paths for a particular webpack entry point.
+      #
+      # Response may either be full URLs (eg http://localhost/...) if the dev server
+      # is in use or a host-relative URl (eg /webpack/...) if assets are precompiled.
+      #
+      # Will raise an error if our manifest can't be found or the entry point does
+      # not exist.
+      def webpack_asset_paths(source)
+        return "" unless source.present?
 
-      def stylesheet_link_tag(*sources)
-        options = sources.extract_options!.stringify_keys
+        paths = Webpack::Rails::Manifest.asset_paths(source)
+        host = ::Rails.configuration.webpack.dev_server.host
+        port = ::Rails.configuration.webpack.dev_server.port
 
-        if options['debug'] != false
-          sources.map do |source|
-            super("/assets/#{source}", options)
-          end.flatten.uniq.join('\n').html_safe
-        else
-          super(*sources)
+        if ::Rails.configuration.webpack.dev_server.enabled
+          paths.map! do |p|
+            "http://#{host}:#{port}#{p}"
+          end
         end
-      end
-
-      def javascript_include_tag(*sources)
-        options = sources.extract_options!.stringify_keys
 
-        if options['debug'] != false
-          sources.map do |source|
-            super("/assets/#{source}", options)
-          end.flatten.uniq.join('\n').html_safe
-        else
-          super(*sources)
-        end
+        paths
       end
     end
   end

data/lib/webpack/rails/manifest.rb

@@ -0,0 +1,87 @@
+require 'net/http'
+require 'uri'
+
+module Webpack
+  module Rails
+    # Webpack manifest loading, caching & entry point retrieval
+    class Manifest
+      # Raised if we can't read our webpack manifest for whatever reason
+      class ManifestLoadError < StandardError
+        def initialize(message, orig)
+          super "#{message} (original error #{orig})"
+        end
+      end
+
+      # Raised if a supplied entry point does not exist in the webpack manifest
+      class EntryPointMissingError < StandardError
+      end
+
+      class << self
+        # :nodoc:
+        def asset_paths(source)
+          paths = manifest["assetsByChunkName"][source]
+          if paths
+            # Can be either a string or an array of strings
+            [paths].flatten.map do |p|
+              "/#{::Rails.configuration.webpack.public_path}/#{p}"
+            end
+          else
+            raise EntryPointMissingError, "Can't find entry point '#{source}' in webpack manifest"
+          end
+        end
+
+        private
+
+        def manifest
+          if ::Rails.configuration.webpack.dev_server.enabled
+            # Don't cache if we're in dev server mode, manifest may change ...
+            load_manifest
+          else
+            # ... otherwise cache at class level, as JSON loading/parsing can be expensive
+            @manifest ||= load_manifest
+          end
+        end
+
+        def load_manifest
+          data = if ::Rails.configuration.webpack.dev_server.enabled
+            load_dev_server_manifest
+          else
+            load_static_manifest
+          end
+          JSON.parse(data)
+        end
+
+        def load_dev_server_manifest
+          Net::HTTP.get(
+            "localhost",
+            dev_server_path,
+            ::Rails.configuration.webpack.dev_server.port
+          )
+        rescue => e
+          raise ManifestLoadError.new("Could not load manifest from webpack-dev-server at #{dev_server_url} - is it running, and is stats-webpack-plugin loaded?", e)
+        end
+
+        def load_static_manifest
+          File.read(static_manifest_path)
+        rescue => e
+          raise ManifestLoadError.new("Could not load compiled manifest from #{static_manifest_path} - have you run `rake webpack:compile`?", e)
+        end
+
+        def static_manifest_path
+          ::Rails.root.join(
+            ::Rails.configuration.webpack.output_dir,
+            ::Rails.configuration.webpack.manifest_filename
+          )
+        end
+
+        def dev_server_path
+          "/#{::Rails.configuration.webpack.public_path}/#{::Rails.configuration.webpack.manifest_filename}"
+        end
+
+        def dev_server_url
+          "http://localhost:#{::Rails.configuration.webpack.dev_server.port}#{dev_server_path}"
+        end
+      end
+    end
+  end
+end

data/lib/webpack/rails/version.rb

@@ -1,5 +1,6 @@
 module Webpack
+  # :nodoc:
   module Rails
-    VERSION = "0.0.1"
+    VERSION = "0.9.1"
   end
 end

data/lib/webpack/railtie.rb

@@ -1,18 +1,32 @@
 require 'rails'
 require 'rails/railtie'
 require 'webpack/rails/helper'
-require 'webpack/rails/environment'
 
 module Webpack
+  # :nodoc:
   class Railtie < ::Rails::Railtie
-    config.after_initialize do |app|
+    config.after_initialize do
       ActiveSupport.on_load(:action_view) do
         include Webpack::Rails::Helper
       end
+    end
 
-      app.routes.prepend do
-        mount Webpack::Rails::Environment.new(File.join(app.config.root, 'tmp', 'assets')) => '/assets'
-      end
+    config.webpack = ActiveSupport::OrderedOptions.new
+    config.webpack.config_file = 'config/webpack.config.js'
+    config.webpack.binary = 'node_modules/.bin/webpack'
+
+    config.webpack.dev_server = ActiveSupport::OrderedOptions.new
+    config.webpack.dev_server.host = 'localhost'
+    config.webpack.dev_server.port = 3808
+    config.webpack.dev_server.binary = 'node_modules/.bin/webpack-dev-server'
+    config.webpack.dev_server.enabled = !::Rails.env.production?
+
+    config.webpack.output_dir = "public/webpack"
+    config.webpack.public_path = "webpack"
+    config.webpack.manifest_filename = "manifest.json"
+
+    rake_tasks do
+      load "tasks/webpack.rake"
     end
   end
 end

metadata

@@ -1,62 +1,47 @@
 --- !ruby/object:Gem::Specification
 name: webpack-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.9.1
 platform: ruby
 authors:
-- Leonard Garvey
+- Michael Pearson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-16 00:00:00.000000000 Z
+date: 2015-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :development
+        version: 3.2.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-description: Replaces sprockets with webpack
+        version: 3.2.0
+description: webpack-dev-server usage in development and dynamic asset filenames in
+  production via clever helpers
 email:
-- lengarvey@gmail.com
+- mipearson@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- Gemfile
-- LICENSE.txt
+- MIT-LICENSE
 - README.md
 - Rakefile
+- lib/tasks/webpack.rake
 - lib/webpack/rails.rb
-- lib/webpack/rails/environment.rb
 - lib/webpack/rails/helper.rb
+- lib/webpack/rails/manifest.rb
 - lib/webpack/rails/version.rb
 - lib/webpack/railtie.rb
-- webpack-rails.gemspec
-homepage: ''
+homepage: http://github.com/mipearson/webpack-rails
 licenses:
 - MIT
 metadata: {}
@@ -76,8 +61,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Webpack for Rails
+summary: Webpack & Rails integration toolset
 test_files: []

data/.gitignore

@@ -1,14 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in webpack-rails.gemspec
-gemspec

data/lib/webpack/rails/environment.rb

@@ -1,10 +0,0 @@
-module Webpack
-  module Rails
-    class Environment < Rack::File
-      def call(env)
-        `webpack --config config/webpack.development.js`
-        super(env)
-      end
-    end
-  end
-end

data/webpack-rails.gemspec

@@ -1,23 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'webpack/rails/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "webpack-rails"
-  spec.version       = Webpack::Rails::VERSION
-  spec.authors       = ["Leonard Garvey"]
-  spec.email         = ["lengarvey@gmail.com"]
-  spec.summary       = %q{Webpack for Rails}
-  spec.description   = %q{Replaces sprockets with webpack}
-  spec.homepage      = ""
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  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"]
-
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-end