shakapacker 6.0.0.rc.6

data/lib/webpacker/helper.rb

@@ -0,0 +1,161 @@
+module Webpacker::Helper
+  # Returns the current Webpacker instance.
+  # Could be overridden to use multiple Webpacker
+  # configurations within the same app (e.g. with engines).
+  def current_webpacker_instance
+    Webpacker.instance
+  end
+
+  # Computes the relative path for a given Webpacker asset.
+  # Returns the relative path using manifest.json and passes it to path_to_asset helper.
+  # This will use path_to_asset internally, so most of their behaviors will be the same.
+  #
+  # Example:
+  #
+  #   <%= asset_pack_path 'calendar.css' %> # => "/packs/calendar-1016838bab065ae1e122.css"
+  def asset_pack_path(name, **options)
+    path_to_asset(current_webpacker_instance.manifest.lookup!(name), options)
+  end
+
+  # Computes the absolute path for a given Webpacker asset.
+  # Returns the absolute path using manifest.json and passes it to url_to_asset helper.
+  # This will use url_to_asset internally, so most of their behaviors will be the same.
+  #
+  # Example:
+  #
+  #   <%= asset_pack_url 'calendar.css' %> # => "http://example.com/packs/calendar-1016838bab065ae1e122.css"
+  def asset_pack_url(name, **options)
+    url_to_asset(current_webpacker_instance.manifest.lookup!(name), options)
+  end
+
+  # Computes the relative path for a given Webpacker image with the same automated processing as image_pack_tag.
+  # Returns the relative path using manifest.json and passes it to path_to_asset helper.
+  # This will use path_to_asset internally, so most of their behaviors will be the same.
+  def image_pack_path(name, **options)
+    resolve_path_to_image(name, **options)
+  end
+
+  # Computes the absolute path for a given Webpacker image with the same automated
+  # processing as image_pack_tag. Returns the relative path using manifest.json
+  # and passes it to path_to_asset helper. This will use path_to_asset internally,
+  # so most of their behaviors will be the same.
+  def image_pack_url(name, **options)
+    resolve_path_to_image(name, **options.merge(protocol: :request))
+  end
+
+  # Creates an image tag that references the named pack file.
+  #
+  # Example:
+  #
+  #  <%= image_pack_tag 'application.png', size: '16x10', alt: 'Edit Entry' %>
+  #  <img alt='Edit Entry' src='/packs/application-k344a6d59eef8632c9d1.png' width='16' height='10' />
+  #
+  #  <%= image_pack_tag 'picture.png', srcset: { 'picture-2x.png' => '2x' } %>
+  #  <img srcset= "/packs/picture-2x-7cca48e6cae66ec07b8e.png 2x" src="/packs/picture-c38deda30895059837cf.png" >
+  def image_pack_tag(name, **options)
+    if options[:srcset] && !options[:srcset].is_a?(String)
+      options[:srcset] = options[:srcset].map do |src_name, size|
+        "#{resolve_path_to_image(src_name)} #{size}"
+      end.join(", ")
+    end
+
+    image_tag(resolve_path_to_image(name), options)
+  end
+
+  # Creates a link tag for a favicon that references the named pack file.
+  #
+  # Example:
+  #
+  #  <%= favicon_pack_tag 'mb-icon.png', rel: 'apple-touch-icon', type: 'image/png' %>
+  #  <link href="/packs/mb-icon-k344a6d59eef8632c9d1.png" rel="apple-touch-icon" type="image/png" />
+  def favicon_pack_tag(name, **options)
+    favicon_link_tag(resolve_path_to_image(name), options)
+  end
+
+  # Creates script tags that reference the js chunks from entrypoints when using split chunks API,
+  # as compiled by webpack per the entries list in package/environments/base.js.
+  # By default, this list is auto-generated to match everything in
+  # app/packs/entrypoints/*.js and all the dependent chunks. In production mode, the digested reference is automatically looked up.
+  # See: https://webpack.js.org/plugins/split-chunks-plugin/
+  #
+  # Example:
+  #
+  #   <%= javascript_pack_tag 'calendar', 'map', 'data-turbolinks-track': 'reload' %> # =>
+  #   <script src="/packs/vendor-16838bab065ae1e314.chunk.js" data-turbolinks-track="reload" defer="true"></script>
+  #   <script src="/packs/calendar~runtime-16838bab065ae1e314.chunk.js" data-turbolinks-track="reload" defer="true"></script>
+  #   <script src="/packs/calendar-1016838bab065ae1e314.chunk.js" data-turbolinks-track="reload" defer="true"></script>
+  #   <script src="/packs/map~runtime-16838bab065ae1e314.chunk.js" data-turbolinks-track="reload" defer="true"></script>
+  #   <script src="/packs/map-16838bab065ae1e314.chunk.js" data-turbolinks-track="reload" defer="true"></script>
+  #
+  # DO:
+  #
+  #   <%= javascript_pack_tag 'calendar', 'map' %>
+  #
+  # DON'T:
+  #
+  #   <%= javascript_pack_tag 'calendar' %>
+  #   <%= javascript_pack_tag 'map' %>
+  def javascript_pack_tag(*names, defer: true, **options)
+    javascript_include_tag(*sources_from_manifest_entrypoints(names, type: :javascript), **options.tap { |o| o[:defer] = defer })
+  end
+
+  # Creates a link tag, for preloading, that references a given Webpacker asset.
+  # In production mode, the digested reference is automatically looked up.
+  # See: https://developer.mozilla.org/en-US/docs/Web/HTML/Preloading_content
+  #
+  # Example:
+  #
+  #   <%= preload_pack_asset 'fonts/fa-regular-400.woff2' %> # =>
+  #   <link rel="preload" href="/packs/fonts/fa-regular-400-944fb546bd7018b07190a32244f67dc9.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+  def preload_pack_asset(name, **options)
+    if self.class.method_defined?(:preload_link_tag)
+      preload_link_tag(current_webpacker_instance.manifest.lookup!(name), options)
+    else
+      raise "You need Rails >= 5.2 to use this tag."
+    end
+  end
+
+  # Creates link tags that reference the css chunks from entrypoints when using split chunks API,
+  # as compiled by webpack per the entries list in package/environments/base.js.
+  # By default, this list is auto-generated to match everything in
+  # app/packs/entrypoints/*.js and all the dependent chunks. In production mode, the digested reference is automatically looked up.
+  # See: https://webpack.js.org/plugins/split-chunks-plugin/
+  #
+  # Examples:
+  #
+  #   <%= stylesheet_pack_tag 'calendar', 'map' %> # =>
+  #   <link rel="stylesheet" media="screen" href="/packs/3-8c7ce31a.chunk.css" />
+  #   <link rel="stylesheet" media="screen" href="/packs/calendar-8c7ce31a.chunk.css" />
+  #   <link rel="stylesheet" media="screen" href="/packs/map-8c7ce31a.chunk.css" />
+  #
+  #   When using the webpack-dev-server, CSS is inlined so HMR can be turned on for CSS,
+  #   including CSS modules
+  #   <%= stylesheet_pack_tag 'calendar', 'map' %> # => nil
+  #
+  # DO:
+  #
+  #   <%= stylesheet_pack_tag 'calendar', 'map' %>
+  #
+  # DON'T:
+  #
+  #   <%= stylesheet_pack_tag 'calendar' %>
+  #   <%= stylesheet_pack_tag 'map' %>
+  def stylesheet_pack_tag(*names, **options)
+    return "" if Webpacker.inlining_css?
+
+    stylesheet_link_tag(*sources_from_manifest_entrypoints(names, type: :stylesheet), **options)
+  end
+
+  private
+
+    def sources_from_manifest_entrypoints(names, type:)
+      names.map { |name| current_webpacker_instance.manifest.lookup_pack_with_chunks!(name.to_s, type: type) }.flatten.uniq
+    end
+
+    def resolve_path_to_image(name, **options)
+      path = name.starts_with?("static/") ? name : "static/#{name}"
+      path_to_asset(current_webpacker_instance.manifest.lookup!(path), options)
+    rescue
+      path_to_asset(current_webpacker_instance.manifest.lookup!(name), options)
+    end
+end

data/lib/webpacker/instance.rb

@@ -0,0 +1,41 @@
+class Webpacker::Instance
+  cattr_accessor(:logger) { ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new(STDOUT)) }
+
+  attr_reader :root_path, :config_path
+
+  def initialize(root_path: Rails.root, config_path: Rails.root.join("config/webpacker.yml"))
+    @root_path, @config_path = root_path, config_path
+  end
+
+  def env
+    @env ||= Webpacker::Env.inquire self
+  end
+
+  def config
+    @config ||= Webpacker::Configuration.new(
+      root_path: root_path,
+      config_path: config_path,
+      env: env
+    )
+  end
+
+  def compiler
+    @compiler ||= Webpacker::Compiler.new self
+  end
+
+  def dev_server
+    @dev_server ||= Webpacker::DevServer.new config
+  end
+
+  def manifest
+    @manifest ||= Webpacker::Manifest.new self
+  end
+
+  def commands
+    @commands ||= Webpacker::Commands.new self
+  end
+
+  def inlining_css?
+    dev_server.hmr? && dev_server.running?
+  end
+end

data/lib/webpacker/manifest.rb

@@ -0,0 +1,120 @@
+# 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-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 preceded by a compilation if one is needed.
+class Webpacker::Manifest
+  class MissingEntryError < StandardError; end
+
+  delegate :config, :compiler, :dev_server, to: :@webpacker
+
+  def initialize(webpacker)
+    @webpacker = webpacker
+  end
+
+  def refresh
+    @data = load
+  end
+
+  def lookup_pack_with_chunks(name, pack_type = {})
+    compile if compiling?
+
+    manifest_pack_type = manifest_type(pack_type[:type])
+    manifest_pack_name = manifest_name(name, manifest_pack_type)
+    find("entrypoints")[manifest_pack_name]["assets"][manifest_pack_type]
+  rescue NoMethodError
+    nil
+  end
+
+  def lookup_pack_with_chunks!(name, pack_type = {})
+    lookup_pack_with_chunks(name, pack_type) || handle_missing_entry(name, pack_type)
+  end
+
+  # Computes the relative path for a given Webpacker asset using manifest.json.
+  # If no asset is found, returns nil.
+  #
+  # Example:
+  #
+  #   Webpacker.manifest.lookup('calendar.js') # => "/packs/calendar-1016838bab065ae1e122.js"
+  def lookup(name, pack_type = {})
+    compile if compiling?
+
+    find(full_pack_name(name, pack_type[:type]))
+  end
+
+  # Like lookup, except that if no asset is found, raises a Webpacker::Manifest::MissingEntryError.
+  def lookup!(name, pack_type = {})
+    lookup(name, pack_type) || handle_missing_entry(name, pack_type)
+  end
+
+  private
+    def compiling?
+      config.compile? && !dev_server.running?
+    end
+
+    def compile
+      Webpacker.logger.tagged("Webpacker") { compiler.compile }
+    end
+
+    def data
+      if config.cache_manifest?
+        @data ||= load
+      else
+        refresh
+      end
+    end
+
+    def find(name)
+      data[name.to_s].presence
+    end
+
+    def full_pack_name(name, pack_type)
+      return name unless File.extname(name.to_s).empty?
+      "#{name}.#{manifest_type(pack_type)}"
+    end
+
+    def handle_missing_entry(name, pack_type)
+      raise Webpacker::Manifest::MissingEntryError, missing_file_from_manifest_error(full_pack_name(name, pack_type[:type]))
+    end
+
+    def load
+      if config.public_manifest_path.exist?
+        JSON.parse config.public_manifest_path.read
+      else
+        {}
+      end
+    end
+
+    # The `manifest_name` method strips of the file extension of the name, because in the
+    # manifest hash the entrypoints are defined by their pack name without the extension.
+    # When the user provides a name with a file extension, we want to try to strip it off.
+    def manifest_name(name, pack_type)
+      name.chomp(".#{pack_type}")
+    end
+
+    def manifest_type(pack_type)
+      case pack_type
+      when :javascript then "js"
+      when :stylesheet then "css"
+      else pack_type.to_s
+      end
+    end
+
+    def missing_file_from_manifest_error(bundle_name)
+      <<-MSG
+Webpacker can't find #{bundle_name} in #{config.public_manifest_path}. Possible causes:
+1. You forgot to install node packages (try `yarn install`) or are running an incompatible version of Node
+2. Your app has code with a non-standard extension (like a `.jsx` file) but the extension is not in the `extensions` config in `config/webpacker.yml`
+3. You have set compile: false (see `config/webpacker.yml`) for this environment
+   (unless you are using the `bin/webpacker -w` or the `bin/webpacker-dev-server`, in which case maybe you aren't running the dev server in the background?)
+4. webpack has not yet re-run to reflect updates.
+5. You have misconfigured Webpacker's `config/webpacker.yml` file.
+6. Your webpack configuration is not creating a manifest.
+
+Your manifest contains:
+#{JSON.pretty_generate(@data)}
+      MSG
+    end
+end

data/lib/webpacker/railtie.rb

@@ -0,0 +1,63 @@
+require "rails/railtie"
+
+require "webpacker/helper"
+require "webpacker/dev_server_proxy"
+
+class Webpacker::Engine < ::Rails::Engine
+  # Allows Webpacker config values to be set via Rails env config files
+  config.webpacker = ActiveSupport::OrderedOptions.new
+
+  initializer "webpacker.proxy" do |app|
+    if (Webpacker.config.dev_server.present? rescue nil)
+      app.middleware.insert_before 0,
+        Rails::VERSION::MAJOR >= 5 ?
+          Webpacker::DevServerProxy : "Webpacker::DevServerProxy", ssl_verify_none: true
+    end
+  end
+
+  initializer "webpacker.helper" do
+    ActiveSupport.on_load :action_controller do
+      ActionController::Base.helper Webpacker::Helper
+    end
+
+    ActiveSupport.on_load :action_view do
+      include Webpacker::Helper
+    end
+  end
+
+  initializer "webpacker.logger" do
+    config.after_initialize do
+      if ::Rails.logger.respond_to?(:tagged)
+        Webpacker.logger = ::Rails.logger
+      else
+        Webpacker.logger = ActiveSupport::TaggedLogging.new(::Rails.logger)
+      end
+    end
+  end
+
+  initializer "webpacker.bootstrap" do
+    if defined?(Rails::Server) || defined?(Rails::Console)
+      Webpacker.bootstrap
+      if defined?(Spring)
+        require "spring/watcher"
+        Spring.after_fork { Webpacker.bootstrap }
+        Spring.watch(Webpacker.config.config_path)
+      end
+    end
+  end
+
+  initializer "webpacker.set_source" do |app|
+    if Webpacker.config.config_path.exist?
+      app.config.javascript_path = Webpacker.config.source_path.relative_path_from(Rails.root.join("app")).to_s
+    end
+  end
+
+  initializer "webpacker.remove_app_packs_from_the_autoload_paths" do
+    Rails.application.config.before_initialize do
+      if Webpacker.config.config_path.exist?
+        source_path = Webpacker.config.source_path.to_s
+        ActiveSupport::Dependencies.autoload_paths.delete(source_path)
+      end
+    end
+  end
+end

data/lib/webpacker/runner.rb

@@ -0,0 +1,23 @@
+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_bin_path = ENV["WEBPACKER_NODE_MODULES_BIN_PATH"] || `yarn bin`.chomp
+      @webpack_config        = File.join(@app_path, "config/webpack/webpack.config.js")
+      @webpacker_config      = ENV["WEBPACKER_CONFIG"] || File.join(@app_path, "config/webpacker.yml")
+
+      unless File.exist?(@webpack_config)
+        $stderr.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

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

data/lib/webpacker/webpack_runner.rb

@@ -0,0 +1,58 @@
+require "shellwords"
+require "webpacker/runner"
+
+module Webpacker
+  class WebpackRunner < Webpacker::Runner
+    WEBPACK_COMMANDS = [
+      "help",
+      "h",
+      "--help",
+      "-h",
+      "version",
+      "v",
+      "--version",
+      "-v",
+      "info",
+      "i"
+    ].freeze
+
+    def run
+      env = Webpacker::Compiler.env
+      env["WEBPACKER_CONFIG"] = @webpacker_config
+
+      cmd = if node_modules_bin_exist?
+        ["#{@node_modules_bin_path}/webpack"]
+      else
+        ["yarn", "webpack"]
+      end
+
+      if @argv.delete "--debug-webpacker"
+        cmd = ["node", "--inspect-brk"] + cmd
+      end
+
+      if @argv.delete "--trace-deprecation"
+        cmd = ["node", "--trace-deprecation"] + cmd
+      end
+
+      if @argv.delete "--no-deprecation"
+        cmd = ["node", "--no-deprecation"] + cmd
+      end
+
+      # Webpack commands are not compatible with --config option.
+      if (@argv & WEBPACK_COMMANDS).empty?
+        cmd += ["--config", @webpack_config]
+      end
+
+      cmd += @argv
+
+      Dir.chdir(@app_path) do
+        Kernel.exec env, *cmd
+      end
+    end
+
+    private
+      def node_modules_bin_exist?
+        File.exist?("#{@node_modules_bin_path}/webpack")
+      end
+  end
+end

data/lib/webpacker.rb

@@ -0,0 +1,46 @@
+require "active_support/core_ext/module/attribute_accessors"
+require "active_support/core_ext/string/inquiry"
+require "active_support/logger"
+require "active_support/tagged_logging"
+
+module Webpacker
+  extend self
+
+  def instance=(instance)
+    @instance = instance
+  end
+
+  def instance
+    @instance ||= Webpacker::Instance.new
+  end
+
+  def with_node_env(env)
+    original = ENV["NODE_ENV"]
+    ENV["NODE_ENV"] = env
+    yield
+  ensure
+    ENV["NODE_ENV"] = original
+  end
+
+  def ensure_log_goes_to_stdout
+    old_logger = Webpacker.logger
+    Webpacker.logger = Logger.new(STDOUT)
+    yield
+  ensure
+    Webpacker.logger = old_logger
+  end
+
+  delegate :logger, :logger=, :env, :inlining_css?, to: :instance
+  delegate :config, :compiler, :manifest, :commands, :dev_server, to: :instance
+  delegate :bootstrap, :clean, :clobber, :compile, to: :commands
+end
+
+require "webpacker/instance"
+require "webpacker/env"
+require "webpacker/configuration"
+require "webpacker/manifest"
+require "webpacker/compiler"
+require "webpacker/commands"
+require "webpacker/dev_server"
+
+require "webpacker/railtie" if defined?(Rails)

data/package/__tests__/config.js

@@ -0,0 +1,34 @@
+/* global test expect, describe */
+
+const { chdirCwd, chdirTestApp, resetEnv } = require('../utils/helpers')
+
+chdirTestApp()
+
+const config = require('../config')
+
+describe('Config', () => {
+  beforeEach(() => jest.resetModules() && resetEnv())
+  afterAll(chdirCwd)
+
+  test('public path', () => {
+    process.env.RAILS_ENV = 'development'
+    const config = require('../config')
+    expect(config.publicPath).toEqual('/packs/')
+  })
+
+  test('public path with asset host', () => {
+    process.env.RAILS_ENV = 'development'
+    process.env.WEBPACKER_ASSET_HOST = 'http://foo.com/'
+    const config = require('../config')
+    expect(config.publicPath).toEqual('http://foo.com/packs/')
+  })
+
+  test('should return additional paths as listed in app config, with resolved paths', () => {
+    expect(config.additional_paths).toEqual([
+      'app/assets',
+      '/etc/yarn',
+      'some.config.js',
+      'app/elm'
+    ])
+  })
+})

data/package/__tests__/dev_server.js

@@ -0,0 +1,45 @@
+/* global test expect, describe */
+
+const { chdirTestApp, chdirCwd } = require('../utils/helpers')
+
+chdirTestApp()
+
+describe('DevServer', () => {
+  beforeEach(() => jest.resetModules())
+  afterAll(chdirCwd)
+
+  test('with NODE_ENV and RAILS_ENV set to development', () => {
+    process.env.NODE_ENV = 'development'
+    process.env.RAILS_ENV = 'development'
+    process.env.WEBPACKER_DEV_SERVER_HOST = '0.0.0.0'
+    process.env.WEBPACKER_DEV_SERVER_PORT = 5000
+    process.env.WEBPACKER_DEV_SERVER_DISABLE_HOST_CHECK = false
+
+    const devServer = require('../dev_server')
+    expect(devServer).toBeDefined()
+    expect(devServer.host).toEqual('0.0.0.0')
+    expect(devServer.port).toEqual('5000')
+    expect(devServer.disable_host_check).toBe(false)
+  })
+
+  test('with custom env prefix', () => {
+    const config = require('../config')
+    config.dev_server.env_prefix = 'TEST_WEBPACKER_DEV_SERVER'
+
+    process.env.NODE_ENV = 'development'
+    process.env.RAILS_ENV = 'development'
+    process.env.TEST_WEBPACKER_DEV_SERVER_HOST = '0.0.0.0'
+    process.env.TEST_WEBPACKER_DEV_SERVER_PORT = 5000
+
+    const devServer = require('../dev_server')
+    expect(devServer).toBeDefined()
+    expect(devServer.host).toEqual('0.0.0.0')
+    expect(devServer.port).toEqual('5000')
+  })
+
+  test('with NODE_ENV and RAILS_ENV set to production', () => {
+    process.env.RAILS_ENV = 'production'
+    process.env.NODE_ENV = 'production'
+    expect(require('../dev_server')).toEqual({})
+  })
+})

data/package/__tests__/development.js

@@ -0,0 +1,35 @@
+/* test expect, describe, afterAll, beforeEach */
+
+const { resolve } = require('path')
+const { chdirTestApp, chdirCwd } = require('../utils/helpers')
+
+chdirTestApp()
+
+describe('Development environment', () => {
+  afterAll(chdirCwd)
+
+  describe('webpackConfig', () => {
+    beforeEach(() => jest.resetModules())
+
+    test('should use development config and environment including devServer if WEBPACK_SERVE', () => {
+      process.env.RAILS_ENV = 'development'
+      process.env.NODE_ENV = 'development'
+      process.env.WEBPACK_SERVE = 'true'
+      const { webpackConfig } = require('../index')
+
+      expect(webpackConfig.output.path).toEqual(resolve('public', 'packs'))
+      expect(webpackConfig.output.publicPath).toEqual('/packs/')
+    })
+
+    test('should use development config and environment if WEBPACK_SERVE', () => {
+      process.env.RAILS_ENV = 'development'
+      process.env.NODE_ENV = 'development'
+      process.env.WEBPACK_SERVE = undefined
+      const { webpackConfig } = require('../index')
+
+      expect(webpackConfig.output.path).toEqual(resolve('public', 'packs'))
+      expect(webpackConfig.output.publicPath).toEqual('/packs/')
+      expect(webpackConfig.devServer).toEqual(undefined)
+    })
+  })
+})