Binstubs (#833)

Convert webpacker executables to binstubs

Author: rossta

exe/webpack

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+ENV["RAILS_ENV"] ||= ENV["RACK_ENV"] || "development"
+ENV["NODE_ENV"] ||= ENV["RAILS_ENV"]
+
+require "webpacker"
+require "webpacker/webpack_runner"
+Webpacker::WebpackRunner.run(ARGV)

exe/webpack-dev-server

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+ENV["RAILS_ENV"] ||= ENV["RACK_ENV"] || "development"
+ENV["NODE_ENV"] ||= ENV["RAILS_ENV"]
+
+require "webpacker"
+require "webpacker/dev_server_runner"
+Webpacker::DevServerRunner.run(ARGV)

lib/install/bin/webpack-dev-server.tt

@@ -13,10 +13,8 @@
 puts "Creating javascript app source directory"
 directory "#{__dir__}/javascript", Webpacker.config.source_path
 
-puts "Copying binstubs"
-directory "#{__dir__}/bin", "bin"
-
-chmod "bin", 0755 & ~File.umask, verbose: false
+puts "Installing binstubs"
+run "bundle binstubs webpacker"
 
 if File.exists?(".gitignore")
   append_to_file ".gitignore", <<-EOS

lib/install/bin/webpack.tt

@@ -0,0 +1,72 @@
+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")
+        @default_listen_host_addr = ENV["NODE_ENV"] == "development" ? "localhost" : "0.0.0.0"
+
+        dev_server = YAML.load_file(@config_file)[ENV["RAILS_ENV"]]["dev_server"]
+
+        @hostname          = args("--host") || dev_server["host"]
+        @port              = args("--port") || dev_server["port"]
+        @https             = @argv.include?("--https") || dev_server["https"]
+        @dev_server_addr   = "http#{"s" if @https}://#{@hostname}:#{@port}"
+        @listen_host_addr  = args("--listen-host") || @default_listen_host_addr
+
+      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(@listen_host_addr, @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
+        argv = @argv.dup
+
+        # Delete supplied host, port and listen-host CLI arguments
+        ["--host", "--port", "--listen-host"].each do |arg|
+          argv.delete(args(arg))
+          argv.delete(arg)
+        end
+
+        env = { "NODE_PATH" => @node_modules_path.shellescape }
+
+        cmd = [
+          "#{@node_modules_path}/.bin/webpack-dev-server", "--progress", "--color",
+          "--config", @webpack_config,
+          "--host", @listen_host_addr,
+          "--public", "#{@hostname}:#{@port}",
+          "--port", @port.to_s
+        ] + argv
+
+        Dir.chdir(@app_path) do
+          exec env, *cmd
+        end
+      end
+
+      def args(key)
+        index = @argv.index(key)
+        index ? @argv[index + 1] : nil
+      end
+  end
+end

lib/install/template.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

lib/webpacker/dev_server_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

lib/webpacker/runner.rb

@@ -9,6 +9,8 @@ Gem::Specification.new do |s|
   s.summary  = "Use Webpack to manage app-like JavaScript modules in Rails"
   s.homepage = "https://github.com/rails/webpacker"
   s.license  = "MIT"
+  s.bindir   = "exe"
+  s.executables = `git ls-files -- exe/*`.split("\n").map { |f| File.basename(f) }
 
   s.required_ruby_version = ">= 1.9.3"