webpacker 3.0.1 → 3.0.2

data/lib/webpacker/dev_server_proxy.rb

@@ -2,7 +2,7 @@ require "rack/proxy"
 
 class Webpacker::DevServerProxy < Rack::Proxy
   def rewrite_response(response)
-    status, headers, body = response
+    _status, headers, _body = response
     headers.delete "transfer-encoding"
     headers.delete "content-length" if Webpacker.dev_server.running? && Webpacker.dev_server.https?
     response

data/lib/webpacker/dev_server_runner.rb

@@ -0,0 +1,51 @@
+require "shellwords"
+require "yaml"
+require "socket"
+require "webpacker/runner"
+
+module Webpacker
+  class DevServerRunner < Webpacker::Runner
+    def run
+      load_config
+      detect_port!
+      execute_cmd
+    end
+
+    private
+      def load_config
+        @config_file = File.join(@app_path, "config/webpacker.yml")
+        dev_server = YAML.load_file(@config_file)[ENV["RAILS_ENV"]]["dev_server"]
+
+        @hostname          = dev_server["host"]
+        @port              = dev_server["port"]
+
+      rescue Errno::ENOENT, NoMethodError
+        $stdout.puts "Webpack dev_server configuration not found in #{@config_file}."
+        $stdout.puts "Please run bundle exec rails webpacker:install to install webpacker"
+        exit!
+      end
+
+      def detect_port!
+        server = TCPServer.new(@hostname, @port)
+        server.close
+
+      rescue Errno::EADDRINUSE
+        $stdout.puts "Another program is running on port #{@port}. Set a new port in #{@config_file} for dev_server"
+        exit!
+      end
+
+      def execute_cmd
+        env = { "NODE_PATH" => @node_modules_path.shellescape }
+        cmd = [
+          "#{@node_modules_path}/.bin/webpack-dev-server",
+          "--progress",
+          "--color",
+          "--config", @webpack_config
+        ]
+
+        Dir.chdir(@app_path) do
+          exec env, *cmd
+        end
+      end
+  end
+end

data/lib/webpacker/helper.rb

@@ -2,26 +2,19 @@ module Webpacker::Helper
   # Computes the full path for a given webpacker asset.
   # Return relative path using manifest.json and passes it to asset_url helper
   # This will use asset_path internally, so most of their behaviors will be the same.
-  # Examples:
   #
-  # In development mode:
-  #   <%= asset_pack_path 'calendar.js' %> # => "/packs/calendar.js"
-  # In production mode:
+  # Example:
+  #
   #   <%= asset_pack_path 'calendar.css' %> # => "/packs/calendar-1016838bab065ae1e122.css"
   def asset_pack_path(name, **options)
-    asset_path(Webpacker.manifest.lookup(name), **options)
+    asset_path(Webpacker.manifest.lookup!(name), **options)
   end
   # Creates a script tag that references the named pack file, as compiled by Webpack per the entries list
   # in config/webpack/shared.js. By default, this list is auto-generated to match everything in
   # app/javascript/packs/*.js. In production mode, the digested reference is automatically looked up.
   #
-  # Examples:
-  #
-  #   # In development mode:
-  #   <%= javascript_pack_tag 'calendar', 'data-turbolinks-track': 'reload' %> # =>
-  #   <script src="/packs/calendar.js" data-turbolinks-track="reload"></script>
+  # Example:
   #
-  #   # In production mode:
   #   <%= javascript_pack_tag 'calendar', 'data-turbolinks-track': 'reload' %> # =>
   #   <script src="/packs/calendar-1016838bab065ae1e314.js" data-turbolinks-track="reload"></script>
   def javascript_pack_tag(*names, **options)
@@ -37,10 +30,6 @@ module Webpacker::Helper
   #
   # Examples:
   #
-  #   # In development mode:
-  #   <%= stylesheet_pack_tag 'calendar', 'data-turbolinks-track': 'reload' %> # =>
-  #   <link rel="stylesheet" media="screen" href="/packs/calendar.css" data-turbolinks-track="reload" />
-  #
   #   # In development mode with hot module replacement:
   #   <%= stylesheet_pack_tag 'calendar', 'data-turbolinks-track': 'reload' %> # =>
   #   nil
@@ -56,7 +45,7 @@ module Webpacker::Helper
 
   private
     def sources_from_pack_manifest(names, type:)
-      names.map { |name| Webpacker.manifest.lookup(pack_name_with_extension(name, type: type)) }
+      names.map { |name| Webpacker.manifest.lookup!(pack_name_with_extension(name, type: type)) }
     end
 
     def pack_name_with_extension(name, type:)

data/lib/webpacker/manifest.rb

@@ -1,11 +1,7 @@
 # Singleton registry for accessing the packs path using a generated manifest.
 # This allows javascript_pack_tag, stylesheet_pack_tag, asset_pack_path to take a reference to,
-# say, "calendar.js" or "calendar.css" and turn it into "/packs/calendar.js" or
-# "/packs/calendar.css" in development.
-#
-# In production mode, it returns compiles files, like
-# "/packs/calendar-1016838bab065ae1e314.js" and "/packs/calendar-1016838bab065ae1e314.css",
-# for long-term caching.
+# say, "calendar.js" or "calendar.css" and turn it into "/packs/calendar-1016838bab065ae1e314.js" or
+# "/packs/calendar-1016838bab065ae1e314.css".
 #
 # When the configuration is set to on-demand compilation, with the `compile: true` option in
 # the webpacker.yml file, any lookups will be preceeded by a compilation if one is needed.
@@ -27,6 +23,10 @@ class Webpacker::Manifest
     find name
   end
 
+  def lookup!(name)
+    lookup(name) || handle_missing_entry(name)
+  end
+
   private
     def compiling?
       config.compile? && !dev_server.running?
@@ -37,7 +37,7 @@ class Webpacker::Manifest
     end
 
     def find(name)
-      data[name.to_s] || handle_missing_entry(name)
+      data[name.to_s].presence
     end
 
     def handle_missing_entry(name)
@@ -45,7 +45,7 @@ class Webpacker::Manifest
     end
 
     def missing_file_from_manifest_error(bundle_name)
-      msg = <<-MSG
+      <<-MSG
 Webpacker can't find #{bundle_name} in #{config.public_manifest_path}. Possible causes:
 1. You want to set webpacker.yml value of compile to true for your environment
    unless you are using the `webpack -w` or the webpack-dev-server.

data/lib/webpacker/runner.rb

@@ -0,0 +1,22 @@
+module Webpacker
+  class Runner
+    def self.run(argv)
+      $stdout.sync = true
+
+      new(argv).run
+    end
+
+    def initialize(argv)
+      @argv = argv
+
+      @app_path          = File.expand_path(".", Dir.pwd)
+      @node_modules_path = File.join(@app_path, "node_modules")
+      @webpack_config    = File.join(@app_path, "config/webpack/#{ENV["NODE_ENV"]}.js")
+
+      unless File.exist?(@webpack_config)
+        puts "Webpack config #{@webpack_config} not found, please run 'bundle exec rails webpacker:install' to install webpacker with default configs or add the missing config file for your custom environment."
+        exit!
+      end
+    end
+  end
+end

data/lib/webpacker/version.rb

@@ -1,4 +1,4 @@
 module Webpacker
   # Change the version in package.json too, please!
-  VERSION = "3.0.1".freeze
+  VERSION = "3.0.2".freeze
 end

data/lib/webpacker/webpack_runner.rb

@@ -0,0 +1,15 @@
+require "shellwords"
+require "webpacker/runner"
+
+module Webpacker
+  class WebpackRunner < Webpacker::Runner
+    def run
+      env = { "NODE_PATH" => @node_modules_path.shellescape }
+      cmd = [ "#{@node_modules_path}/.bin/webpack", "--config", @webpack_config ] + @argv
+
+      Dir.chdir(@app_path) do
+        exec env, *cmd
+      end
+    end
+  end
+end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rails/webpacker",
-  "version": "3.0.1",
+  "version": "3.0.2",
   "description": "Use Webpack to manage app-like JavaScript modules in Rails",
   "main": "package/index.js",
   "files": [
@@ -19,7 +19,6 @@
     "babel-polyfill": "^6.26.0",
     "babel-preset-env": "^1.6.0",
     "coffee-loader": "^0.8.0",
-    "coffeescript": "^1.12.7",
     "compression-webpack-plugin": "^1.0.0",
     "css-loader": "^0.28.5",
     "extract-text-webpack-plugin": "^3.0.0",
@@ -45,6 +44,9 @@
     "eslint-plugin-jsx-a11y": "^4.0.0",
     "eslint-plugin-react": "^6.10.0"
   },
+  "peerDependencies": {
+    "coffeescript": ">= 1.12.7 || >= 2.x"
+  },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "lint": "eslint {package,lib}/"

data/package/config.js

@@ -3,6 +3,23 @@ const { safeLoad } = require('js-yaml')
 const { readFileSync } = require('fs')
 
 const filePath = resolve('config', 'webpacker.yml')
-const config = safeLoad(readFileSync(filePath), 'utf8')
+const config = safeLoad(readFileSync(filePath), 'utf8')[process.env.NODE_ENV]
 
-module.exports = config[process.env.NODE_ENV]
+const isBoolean = str => /^true/.test(str) || /^false/.test(str)
+
+const fetch = key =>
+  (isBoolean(process.env[key]) ? JSON.parse(process.env[key]) : process.env[key])
+
+const devServer = (key) => {
+  const envValue = fetch(`WEBPACKER_DEV_SERVER_${key.toUpperCase().replace(/_/g, '')}`)
+  if (typeof envValue === 'undefined' || envValue === null) return config.dev_server[key]
+  return envValue
+}
+
+if (config.dev_server) {
+  Object.keys(config.dev_server).forEach((key) => {
+    config.dev_server[key] = devServer(key)
+  })
+}
+
+module.exports = config

data/package/environment.js

@@ -1,9 +1,6 @@
 /* eslint global-require: 0 */
 /* eslint import/no-dynamic-require: 0 */
 
-const config = require('./config')
-const assetHost = require('./asset_host')
-
 const { basename, dirname, join, relative, resolve } = require('path')
 const { sync } = require('glob')
 const extname = require('path-complete-extname')
@@ -12,6 +9,9 @@ const webpack = require('webpack')
 const ExtractTextPlugin = require('extract-text-webpack-plugin')
 const ManifestPlugin = require('webpack-manifest-plugin')
 
+const config = require('./config')
+const assetHost = require('./asset_host')
+
 function getLoaderMap() {
   const result = new Map()
   const paths = sync(resolve(__dirname, 'loaders', '*.js'))

data/package/environments/development.js

@@ -1,13 +1,13 @@
+const webpack = require('webpack')
 const Environment = require('../environment')
-const { dev_server } = require('../config')
+const { dev_server: devServer } = require('../config')
 const assetHost = require('../asset_host')
-const webpack = require('webpack')
 
 module.exports = class extends Environment {
   constructor() {
     super()
 
-    if (dev_server.hmr) {
+    if (devServer.hmr) {
       this.plugins.set('HotModuleReplacement', new webpack.HotModuleReplacementPlugin())
       this.plugins.set('NamedModules', new webpack.NamedModulesPlugin())
     }
@@ -15,25 +15,29 @@ module.exports = class extends Environment {
 
   toWebpackConfig() {
     const result = super.toWebpackConfig()
-    if (dev_server.hmr) {
+    if (devServer.hmr) {
       result.output.filename = '[name]-[hash].js'
     }
     result.output.pathinfo = true
     result.devtool = 'cheap-eval-source-map'
     result.devServer = {
-      host: dev_server.host,
-      port: dev_server.port,
-      https: dev_server.https,
-      hot: dev_server.hmr,
-      contentBase: assetHost.path,
-      publicPath: assetHost.publicPath,
       clientLogLevel: 'none',
       compress: true,
+      disableHostCheck: devServer.disable_host_check,
+      host: devServer.host,
+      port: devServer.port,
+      https: devServer.https,
+      hot: devServer.hmr,
+      contentBase: assetHost.path,
+      inline: devServer.inline,
+      useLocalIp: devServer.use_local_ip,
+      public: devServer.public,
+      publicPath: assetHost.publicPath,
       historyApiFallback: true,
       headers: {
         'Access-Control-Allow-Origin': '*'
       },
-      overlay: true,
+      overlay: devServer.overlay,
       watchOptions: {
         ignored: /node_modules/
       },

data/package/environments/production.js

@@ -1,6 +1,6 @@
-const Environment = require('../environment')
 const webpack = require('webpack')
 const CompressionPlugin = require('compression-webpack-plugin')
+const Environment = require('../environment')
 
 module.exports = class extends Environment {
   constructor() {
@@ -27,7 +27,7 @@ module.exports = class extends Environment {
 
   toWebpackConfig() {
     const result = super.toWebpackConfig()
-    result.devtool = 'source-map'
+    result.devtool = 'nosources-source-map'
     result.stats = 'normal'
     return result
   }

data/package/index.js

@@ -1,9 +1,9 @@
 /* eslint global-require: 0 */
 /* eslint import/no-dynamic-require: 0 */
 
-const Environment = require('./environment')
 const { resolve } = require('path')
 const { existsSync } = require('fs')
+const Environment = require('./environment')
 
 function createEnvironment() {
   const path = resolve(__dirname, 'environments', `${process.env.NODE_ENV}.js`)

data/package/loaders/file.js

@@ -1,14 +1,14 @@
-const config = require('../config')
-const assetHost = require('../asset_host')
 const { join } = require('path')
+const { source_path } = require('../config')
+const assetHost = require('../asset_host')
 
 module.exports = {
-  test: /\.(jpg|jpeg|png|gif|svg|eot|ttf|woff|woff2)$/i,
+  test: /\.(jpg|jpeg|png|gif|svg|eot|otf|ttf|woff|woff2)$/i,
   use: [{
     loader: 'file-loader',
     options: {
       name: '[path][name]-[hash].[ext]',
-      context: join(config.source_path),
+      context: join(source_path),
       publicPath: assetHost.publicPathWithHost
     }
   }]

data/package/loaders/style.js

@@ -1,10 +1,10 @@
 const ExtractTextPlugin = require('extract-text-webpack-plugin')
 const path = require('path')
-const config = require('../config')
+const { dev_server: devServer } = require('../config')
 
 const postcssConfigPath = path.resolve(process.cwd(), '.postcssrc.yml')
 const isProduction = process.env.NODE_ENV === 'production'
-const extractCSS = !(config.dev_server && config.dev_server.hmr)
+const extractCSS = !(devServer && devServer.hmr)
 
 const extractOptions = {
   fallback: 'style-loader',

data/package/loaders/vue.js

@@ -1,7 +1,7 @@
-const config = require('../config')
+const { dev_server: devServer } = require('../config')
 
 const isProduction = process.env.NODE_ENV === 'production'
-const extractCSS = !(config.dev_server && config.dev_server.hmr)
+const extractCSS = !(devServer && devServer.hmr)
 
 module.exports = {
   test: /\.vue(\.erb)?$/,

data/test/configuration_test.rb

@@ -26,6 +26,11 @@ class ConfigurationTest < Webpacker::Test
     assert_equal Webpacker.config.cache_path.to_s, cache_path
   end
 
+  def test_extensions
+    webpacker_yml = YAML.load_file("lib/install/config/webpacker.yml")
+    assert_equal Webpacker.config.extensions, webpacker_yml["default"]["extensions"]
+  end
+
   def test_cache_manifest?
     with_node_env("development") do
       refute reloaded_config.cache_manifest?

data/test/manifest_test.rb

@@ -1,19 +1,27 @@
 require "webpacker_test_helper"
 
 class ManifestTest < Minitest::Test
-  def test_lookup_exception
+  def test_lookup_exception!
     manifest_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/public/packs", "manifest.json").to_s
     asset_file = "calendar.js"
 
     Webpacker.config.stub :compile?, false do
       error = assert_raises Webpacker::Manifest::MissingEntryError do
-        Webpacker.manifest.lookup(asset_file)
+        Webpacker.manifest.lookup!(asset_file)
       end
 
       assert_match "Webpacker can't find #{asset_file} in #{manifest_path}", error.message
     end
   end
 
+  def test_lookup_success!
+    assert_equal Webpacker.manifest.lookup!("bootstrap.js"), "/packs/bootstrap-300631c4f0e0f9c865bc.js"
+  end
+
+  def test_lookup_nil
+    assert_nil Webpacker.manifest.lookup("foo.js")
+  end
+
   def test_lookup_success
     assert_equal Webpacker.manifest.lookup("bootstrap.js"), "/packs/bootstrap-300631c4f0e0f9c865bc.js"
   end