webpack-rails 0.9.7 → 0.9.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3be54a13fb6e00927655f4ac50ef87cde665ff1
-  data.tar.gz: e8e408c0cd2964b1d94b8daba3bcf6686aae10bb
+  metadata.gz: cfcf45814f51f113a5689c534a745ded9c30f0df
+  data.tar.gz: 3dd10a9be3d3c47a5c6571512096a0ca9d819da7
 SHA512:
-  metadata.gz: 5a43f41e7f1cacdbf08805a8fe4329610f41a47d97743538fe84e20c95354f59b24fc335d2189958cc058f3a16dcdfd8a6c1c04db4e1cf86a2c2cea0661e6e83
-  data.tar.gz: 2db5c1a63ba3c9c2c49a02f9b93657da9df993336e9d93803fff2ee8e488bed078d99590db6306630b1e9c99f45d1b480caab5928b12e5f60515a7672ccaaf42
+  metadata.gz: 76391a93c60234bbd447bf0e71753d70759709db801a5447365736a98deaa9a5b8c0247294561741cc1ed150518d340b821933029621da10dfed3906699f6372
+  data.tar.gz: 11223b1c5d1eea5809581ab573b9b9c0140d607b0bbf12e14c9af38e57fc48b5ae135413c7da931302fccf321a4354b899741ece9b29324eb9bdb25a0231a188

data/README.md

@@ -12,7 +12,7 @@ It was designed for use at [Marketplacer](http://www.marketplacer.com) to assist
 
 Our examples show **webpack-rails** co-existing with sprockets (as that's how environment works), but sprockets is not used or required for development or production use of this gem.
 
-This gem has been tested against Rails 4.2 and Ruby 2.2. Earlier versions of Rails (>= 3.2) and Ruby (>= 1.9) may work, but we haven't tested them.
+This gem has been tested against Rails 4.2 and Ruby 2.2. Earlier versions of Rails (>= 3.2) and Ruby (>= 2.0) may work, but we haven't tested them.
 
 ## Using webpack-rails
 
@@ -70,6 +70,22 @@ Have a look at the files in the `examples` directory. Of note:
   * Webpacked assets will be compiled to `public/webpack`
   * The manifest file is named `manifest.json`
 
+#### Dynamic host
+
+To have the host evaluated at request-time, set `host` to a proc:
+
+```ruby
+config.webpack.dev_server.host = proc { request.host }
+```
+
+This is useful when accessing your Rails app over the network (remember to bind both your Rails app and your WebPack server to `0.0.0.0`).
+
+#### Use with docker-compose
+
+If you're running `webpack-dev-server` as part of docker compose rather than `foreman`, you might find that the host and port that rails needs to use to retrieve the manifest isn't the same as the host and port that you'll be giving to the browser to retrieve the assets.
+
+If so, you can set the `manifest_host` and `manifest_port` away from their default of `localhost` and port 3808.
+
 ### Working with browser tests
 
 In development, we make sure that the `webpack-dev-server` is running when browser tests are running.
@@ -79,13 +95,17 @@ In development, we make sure that the `webpack-dev-server` is running when brows
 In CI, we manually run `webpack` to compile the assets to public and set `config.webpack.dev_server.enabled` to `false` in our `config/environments/test.rb`:
 
 ``` ruby
-  config.webpack.dev_server.enabled = !ENV['CI']
+config.webpack.dev_server.enabled = !ENV['CI']
 ```
 
 ### 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 deploy to Heroku, you can add the special
+[webpack-rails-buildpack](https://github.com/febeling/webpack-rails-buildpack)
+in order to perform this rake task on each deployment.
+
 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

data/example/webpack.config.js

@@ -8,8 +8,8 @@ var StatsPlugin = require('stats-webpack-plugin');
 // must match config.webpack.dev_server.port
 var devServerPort = 3808;
 
-// set TARGET=production on the environment to add asset fingerprints
-var production = process.env.TARGET === 'production';
+// set NODE_ENV=production on the environment to add asset fingerprints
+var production = process.env.NODE_ENV === 'production';
 
 var config = {
   entry: {

data/lib/tasks/webpack.rake

@@ -1,7 +1,8 @@
 namespace :webpack do
   desc "Compile webpack bundles"
   task compile: :environment do
-    ENV["TARGET"] = 'production'
+    ENV["TARGET"] = 'production' # TODO: Deprecated, use NODE_ENV instead
+    ENV["NODE_ENV"] = 'production'
     webpack_bin = ::Rails.root.join(::Rails.configuration.webpack.binary)
     config_file = ::Rails.root.join(::Rails.configuration.webpack.config_file)
 
@@ -13,7 +14,7 @@ namespace :webpack do
       raise "Can't find our webpack config file at #{config_file}"
     end
 
-    result =  `#{webpack_bin} --bail --config #{config_file} 2>&1`
-    raise result unless $? == 0
+    result = `#{webpack_bin} --bail --config #{config_file} 2>&1`
+    raise result unless $CHILD_STATUS == 0
   end
 end

data/lib/webpack/rails/helper.rb

@@ -16,14 +16,17 @@ module Webpack
         return "" unless source.present?
 
         paths = Webpack::Rails::Manifest.asset_paths(source)
-        paths = paths.select {|p| p.ends_with? ".#{extension}" } if extension
+        paths = paths.select { |p| p.ends_with? ".#{extension}" } if extension
 
-        host = ::Rails.configuration.webpack.dev_server.host
         port = ::Rails.configuration.webpack.dev_server.port
+        protocol = ::Rails.configuration.webpack.dev_server.https ? 'https' : 'http'
+
+        host = ::Rails.configuration.webpack.dev_server.host
+        host = instance_eval(&host) if host.respond_to?(:call)
 
         if ::Rails.configuration.webpack.dev_server.enabled
           paths.map! do |p|
-            "//#{host}:#{port}#{p}"
+            "#{protocol}://#{host}:#{port}#{p}"
           end
         end
 

data/lib/webpack/rails/manifest.rb

@@ -12,6 +12,13 @@ module Webpack
         end
       end
 
+      # Raised if webpack couldn't build one of your entry points
+      class WebpackError < StandardError
+        def initialize(errors)
+          super "Error in webpack compile, details follow below:\n#{errors.join("\n\n")}"
+        end
+      end
+
       # Raised if a supplied entry point does not exist in the webpack manifest
       class EntryPointMissingError < StandardError
       end
@@ -19,6 +26,8 @@ module Webpack
       class << self
         # :nodoc:
         def asset_paths(source)
+          raise WebpackError, manifest["errors"] if manifest["errors"].present?
+
           paths = manifest["assetsByChunkName"][source]
           if paths
             # Can be either a string or an array of strings.
@@ -53,14 +62,14 @@ module Webpack
         end
 
         def load_dev_server_manifest
-          http = Net::HTTP.new(
-            "localhost",
-            ::Rails.configuration.webpack.dev_server.port)
+          host = ::Rails.configuration.webpack.dev_server.manifest_host
+          port = ::Rails.configuration.webpack.dev_server.manifest_port
+          http = Net::HTTP.new(host, port)
           http.use_ssl = ::Rails.configuration.webpack.dev_server.https
           http.verify_mode = OpenSSL::SSL::VERIFY_NONE
           http.get(dev_server_path).body
         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)
+          raise ManifestLoadError.new("Could not load manifest from webpack-dev-server at http://#{host}:#{port}#{dev_server_path} - is it running, and is stats-webpack-plugin loaded?", e)
         end
 
         def load_static_manifest
@@ -81,7 +90,7 @@ module Webpack
         end
 
         def dev_server_url
-          "http://localhost:#{::Rails.configuration.webpack.dev_server.port}#{dev_server_path}"
+          "http://#{::Rails.configuration.webpack.dev_server.host}:#{::Rails.configuration.webpack.dev_server.port}#{dev_server_path}"
         end
       end
     end

data/lib/webpack/rails/version.rb

@@ -1,6 +1,6 @@
 module Webpack
   # :nodoc:
   module Rails
-    VERSION = "0.9.7"
+    VERSION = "0.9.8"
   end
 end

data/lib/webpack/railtie.rb

@@ -12,12 +12,24 @@ module Webpack
     end
 
     config.webpack = ActiveSupport::OrderedOptions.new
+    config.webpack.dev_server = 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'
+    # Host & port to use when generating asset URLS in the manifest helpers in dev
+    # server mode. Defaults to the requested host rather than localhost, so
+    # that requests from remote hosts work.
+    config.webpack.dev_server.host = proc { respond_to?(:request) ? request.host : 'localhost' }
     config.webpack.dev_server.port = 3808
+
+    # The host and port to use when fetching the manifest
+    # This is helpful for e.g. docker containers, where the host and port you
+    # use via the web browser is not the same as those that the containers use
+    # to communicate among each other
+    config.webpack.dev_server.manifest_host = 'localhost'
+    config.webpack.dev_server.manifest_port = 3808
+
     config.webpack.dev_server.https = false # note - this will use OpenSSL::SSL::VERIFY_NONE
     config.webpack.dev_server.binary = 'node_modules/.bin/webpack-dev-server'
     config.webpack.dev_server.enabled = !::Rails.env.production?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webpack-rails
 version: !ruby/object:Gem::Version
-  version: 0.9.7
+  version: 0.9.8
 platform: ruby
 authors:
 - Michael Pearson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-07 00:00:00.000000000 Z
+date: 2016-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails