webpacker-react-on-rails 2.0

data/lib/webpacker/file_loader.rb

@@ -0,0 +1,47 @@
+# Provides a base singleton-configuration pattern for loading a file, given a path
+class Webpacker::FileLoader
+  class NotFoundError < StandardError; end
+  class FileLoaderError < StandardError; end
+
+  class_attribute :instance
+  attr_accessor :data, :mtime, :path
+
+  class << self
+    def load_instance(path = file_path)
+      # Assume production is 100% cached and don't reload if file's mtime not changed
+      cached = self.instance && # if we have a singleton
+        (env == "production" || # skip if production bc always cached
+          (File.exist?(path) && self.instance.mtime == File.mtime(path))) # skip if mtime not changed
+
+      return if cached
+      self.instance = new(path)
+    end
+
+    def file_path
+      raise FileLoaderError.new("Subclass of Webpacker::FileLoader should override this method")
+    end
+
+    def reset
+      self.instance = nil
+      load_instance
+    end
+
+    private
+
+    # Prefer the NODE_ENV to the rails env.
+    def env
+      ENV["NODE_ENV"].presence || Rails.env
+    end
+  end
+
+  private
+    def initialize(path)
+      @path = path
+      @mtime = File.exist?(path) ? File.mtime(path) : nil
+      @data = load_data
+    end
+
+    def load_data
+      {}.freeze
+    end
+end

data/lib/webpacker/helper.rb

@@ -0,0 +1,69 @@
+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:
+  #   <%= asset_pack_path 'calendar.css' %> # => "/packs/calendar-1016838bab065ae1e122.css"
+  def asset_pack_path(name, **options)
+    path = Webpacker::Configuration.public_output_path
+    file = Webpacker::Manifest.lookup(name)
+    full_path = "#{path}/#{file}"
+    asset_path(full_path, **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>
+  #
+  #   # 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)
+    javascript_include_tag(*asset_source(names, :javascript), **options)
+  end
+
+  # Creates a link 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:
+  #   <%= stylesheet_pack_tag 'calendar', 'data-turbolinks-track': 'reload' %> # =>
+  #   <link rel="stylesheet" media="screen" href="/packs/calendar.css" data-turbolinks-track="reload" />
+  #
+  #   # In production mode:
+  #   <%= stylesheet_pack_tag 'calendar', 'data-turbolinks-track': 'reload' %> # =>
+  #   <link rel="stylesheet" media="screen" href="/packs/calendar-1016838bab065ae1e122.css" data-turbolinks-track="reload" />
+  #   # In development mode with hot-reloading
+  #   <%= stylesheet_pack_tag('main') %> <% # Default is false for enabled_when_hot_loading%>
+  #   # No output
+  #
+  #   # In development mode with hot-reloading and enabled_when_hot_loading
+  #   # <%= stylesheet_pack_tag('main', enabled_when_hot_loading: true) %>
+  #   <link rel="stylesheet" media="screen" href="/public/webpack/development/calendar-1016838bab065ae1e122.css" />
+  #
+  def stylesheet_pack_tag(*names, **options)
+    return "" if Webpacker::DevServer.hot?
+    stylesheet_link_tag(*asset_source(names, :stylesheet), **options)
+  end
+
+  private
+    def asset_source(names, type)
+      output_path_or_url = Webpacker::Configuration.output_path_or_url
+      names.map do |name|
+        path = Webpacker::Manifest.lookup("#{name}#{compute_asset_extname(name, type: type)}")
+        "#{output_path_or_url}/#{path}"
+      end
+    end
+end

data/lib/webpacker/manifest.rb

@@ -0,0 +1,101 @@
+# Singleton registry for accessing the packs path using 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, # "/packs/calendar-1016838bab065ae1e314.js" and
+# "/packs/calendar-1016838bab065ae1e314.css" for long-term caching
+
+require "webpacker/file_loader"
+
+class Webpacker::Manifest < Webpacker::FileLoader
+  class << self
+    def file_path
+      Webpacker::Configuration.manifest_path
+    end
+
+    # Throws an error if the file is not found. If Configuration.compile? then compilation is invoked
+    # the file is missing.
+    # React on Rails users will need to set Configuration.compile? to false as compilation is configured
+    # in the package.json for React on Rails.
+    def lookup(name)
+      if Webpacker::Configuration.compile?
+        compile_and_find!(name)
+      else
+        find!(name)
+      end
+    end
+
+    # Why does this method exist? Testing? It's not in the README
+    def lookup_path(name)
+      Rails.root.join(File.join(Webpacker::Configuration.output_path, lookup(name)))
+    end
+
+    # Helper method to determine if the manifest file exists. Maybe Webpack needs to run?
+    # **Used by React on Rails.**
+    def exist?
+      path_object = Webpacker::Configuration.manifest_path
+      path_object.exist?
+    end
+
+    # Find the real file name from the manifest key. Don't throw an error if the file is simply
+    # missing from the manifest. Return nil in that case.
+    # If no manifest file exists, then throw an error.
+    # **Used by React on Rails.**
+    def lookup_no_throw(name)
+      instance.confirm_manifest_exists
+
+      load_instance
+      unless instance
+        raise Webpacker::FileLoader::FileLoaderError.new("Webpacker::Manifest.load must be called first")
+      end
+      instance.data[name.to_s]
+    end
+
+    private
+    def find!(name)
+      unless instance
+        raise Webpacker::FileLoader::FileLoaderError.new("Webpacker::Manifest.load must be called first")
+      end
+      instance.data[name.to_s] || missing_file_from_manifest_error(name)
+    end
+
+    def missing_file_from_manifest_error(bundle_name)
+      msg = <<-MSG
+        Webpacker can't find #{bundle_name} in your manifest at #{file_path}. Possible causes:
+          1. You are hot reloading.
+          2. You want to set Configuration.compile to true for your environment.
+          3. Webpack has not re-run to reflect updates.
+          4. You have misconfigured Webpacker's config/webpacker.yml file.
+          5. Your Webpack configuration is not creating a manifest.
+      MSG
+      raise(Webpacker::FileLoader::NotFoundError.new(msg))
+    end
+
+    def missing_manifest_file_error(path_object)
+      msg = <<-MSG
+        Webpacker can't find the manifest file: #{path_object}
+        Possible causes:
+          1. You have not invoked webpack.
+          2. You have misconfigured Webpacker's config/webpacker_.yml file.
+          3. Your Webpack configuration is not creating a manifest.
+      MSG
+      raise(Webpacker::FileLoader::NotFoundError.new(msg))
+    end
+
+    def compile_and_find!(name)
+      Webpacker.compile
+      find!(name)
+    end
+  end
+
+  def confirm_manifest_exists
+    raise missing_manifest_file_error(@path) unless File.exist?(@path)
+  end
+
+  private
+
+    def load_data
+      return super unless File.exist?(@path)
+      JSON.parse(File.read(@path))
+    end
+end

data/lib/webpacker/railtie.rb

@@ -0,0 +1,18 @@
+require "rails/railtie"
+
+require "webpacker/helper"
+
+class Webpacker::Engine < ::Rails::Engine
+  initializer :webpacker do |app|
+    ActiveSupport.on_load :action_controller do
+      ActionController::Base.helper Webpacker::Helper
+    end
+
+    ActiveSupport.on_load :action_view do
+      include Webpacker::Helper
+    end
+
+    Webpacker.bootstrap
+    Spring.after_fork { Webpacker.bootstrap } if defined?(Spring)
+  end
+end

data/lib/webpacker/version.rb

@@ -0,0 +1,3 @@
+module Webpacker
+  VERSION = "2.0".freeze
+end

data/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "webpacker",
+  "version": "1.0.0",
+  "description": "Webpacker makes it easy to use the JavaScript preprocessor and bundler [Webpack](https://webpack.github.io) to manage application-like JavaScript in Rails. It coexists with the asset pipeline, as the purpose is only to use Webpack for app-like JavaScript, not images, css, or even JavaScript Sprinkles (that all continues to live in app/assets).",
+  "main": "index.js",
+  "engines": {
+    "node": ">= 6.4.0"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "eslint": "^3.16.1",
+    "eslint-config-airbnb": "^14.1.0",
+    "eslint-plugin-import": "^2.2.0",
+    "eslint-plugin-jsx-a11y": "^4.0.0",
+    "eslint-plugin-react": "^6.10.0"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "lint": "yarn run eslint lib/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/rails/webpacker.git"
+  },
+  "author": "David Heinemeier Hansson <david@basecamp.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/rails/webpacker/issues"
+  },
+  "homepage": "https://github.com/rails/webpacker"
+}

data/test/compiler_test.rb

@@ -0,0 +1,25 @@
+require "webpacker_test"
+
+class CompilerTest < Minitest::Test
+  def test_default_watched_paths
+    assert_equal Webpacker::Compiler.default_watched_paths, ["app/javascript/**/*", "yarn.lock", "package.json", "config/webpack/**/*"]
+  end
+
+  def test_empty_watched_paths
+    assert_equal Webpacker::Compiler.watched_paths, []
+  end
+
+  def test_watched_paths
+    Webpacker::Compiler.stub :watched_paths, ["Gemfile"] do
+      assert_equal Webpacker::Compiler.watched_paths, ["Gemfile"]
+    end
+  end
+
+  def test_cache_dir
+    assert_equal Webpacker::Compiler.cache_dir, "tmp/webpacker"
+  end
+
+  def test_compile?
+    assert Webpacker::Compiler.compile?
+  end
+end

data/test/configuration_test.rb

@@ -0,0 +1,36 @@
+require "webpacker_test"
+
+class ConfigurationTest < Minitest::Test
+  def test_entry_path
+    entry_path = File.join(File.dirname(__FILE__), "test_app/app/javascript", "packs").to_s
+    assert_equal entry_path, Webpacker::Configuration.entry_path.to_s
+  end
+
+  def test_file_path
+    file_path = File.join(File.dirname(__FILE__), "test_app/config", "webpacker.yml").to_s
+    assert_equal file_path, Webpacker::Configuration.file_path.to_s
+  end
+
+  def test_manifest_path
+    manifest_path = File.join(File.dirname(__FILE__), "test_app/public/packs", "manifest.json").to_s
+    assert_equal manifest_path, Webpacker::Configuration.manifest_path.to_s
+  end
+
+  def test_output_path
+    output_path = File.join(File.dirname(__FILE__), "test_app/public/packs").to_s
+    assert_equal output_path, Webpacker::Configuration.output_path.to_s
+  end
+
+  def test_source
+    assert_equal "app/javascript", Webpacker::Configuration.source.to_s
+  end
+
+  def test_source_path
+    source_path = File.join(File.dirname(__FILE__), "test_app/app/javascript").to_s
+    assert_equal source_path, Webpacker::Configuration.source_path.to_s
+  end
+
+  def test_compile?
+    refute Webpacker::Configuration.compile?
+  end
+end

data/test/dev_server_test.rb

@@ -0,0 +1,56 @@
+require "webpacker_test"
+
+class DevServerTest < Minitest::Test
+  require "webpacker_test"
+
+  def check_assertion
+    stub_value = ActiveSupport::StringInquirer.new("development")
+    Webpacker.stub(:env, stub_value) do
+      Webpacker::Configuration.reset
+      Webpacker::DevServer.reset
+      result = yield
+      assert_equal(result[0], result[1])
+    end
+    Webpacker::Configuration.reset
+    Webpacker::DevServer.reset
+  end
+
+  def test_dev_server?
+    check_assertion { [true, Webpacker::DevServer.dev_server?] }
+  end
+
+  def test_dev_server_host
+    check_assertion { ["localhost", Webpacker::DevServer.host] }
+  end
+
+  def test_dev_server_port
+    check_assertion { [8080, Webpacker::DevServer.port] }
+  end
+
+  def test_dev_server_hot?
+    check_assertion { [false, Webpacker::DevServer.hot?] }
+
+    ENV.stub(:[], "TRUE") do
+      check_assertion { [true, Webpacker::DevServer.hot?] }
+    end
+
+    ENV.stub(:[], "FALSE") do
+      check_assertion { [false, Webpacker::DevServer.hot?] }
+    end
+    ENV.stub(:[], "true") do
+      check_assertion { [true, Webpacker::DevServer.hot?] }
+    end
+  end
+
+  def test_dev_server_https?
+    check_assertion { [false, Webpacker::DevServer.https?] }
+  end
+
+  def test_dev_server_protocol?
+    check_assertion { ["http", Webpacker::DevServer.protocol] }
+  end
+
+  def test_base_url?
+    check_assertion { ["http://localhost:8080", Webpacker::DevServer.base_url] }
+  end
+end

data/test/env_test.rb

@@ -0,0 +1,14 @@
+require "webpacker_test"
+
+class EnvTest < Minitest::Test
+  def test_current_env
+    assert_equal Webpacker::Env.current, "production"
+    assert_equal Webpacker.env, "production"
+    assert Webpacker.env.production?
+  end
+
+  def test_file_path
+    correct_path = File.join(File.dirname(__FILE__), "test_app/config", "webpacker.yml").to_s
+    assert_equal Webpacker::Env.file_path.to_s, correct_path
+  end
+end

data/test/helper_test.rb

@@ -0,0 +1,45 @@
+require "webpacker_test"
+
+class HelperTest < ActionView::TestCase
+  def setup
+    @view = ActionView::Base.new
+    @view.extend Webpacker::Helper
+  end
+
+  def test_asset_pack_path
+    assert_equal "/packs/bootstrap-300631c4f0e0f9c865bc.js", @view.asset_pack_path("bootstrap.js")
+    assert_equal "/packs/bootstrap-c38deda30895059837cf.css", @view.asset_pack_path("bootstrap.css")
+  end
+
+  def test_javascript_pack_tag
+    script = %(<script src="/packs/bootstrap-300631c4f0e0f9c865bc.js"></script>)
+    assert_equal script, @view.javascript_pack_tag("bootstrap.js")
+  end
+
+  def test_javascript_pack_tag_splat
+    script = %(<script src="/packs/bootstrap-300631c4f0e0f9c865bc.js" defer="defer"></script>\n) +
+      %(<script src="/packs/application-k344a6d59eef8632c9d1.js" defer="defer"></script>)
+    assert_equal script, @view.javascript_pack_tag("bootstrap.js", "application.js", defer: true)
+  end
+
+  def test_stylesheet_pack_tag
+    style = %(<link rel="stylesheet" media="screen" href="/packs/bootstrap-c38deda30895059837cf.css" />)
+    assert_equal style, @view.stylesheet_pack_tag("bootstrap.css")
+  end
+
+  def test_stylesheet_pack_tag_splat
+    style = %(<link rel="stylesheet" media="all" href="/packs/bootstrap-c38deda30895059837cf.css" />\n) +
+      %(<link rel="stylesheet" media="all" href="/packs/application-dd6b1cd38bfa093df600.css" />)
+    assert_equal style, @view.stylesheet_pack_tag("bootstrap.css", "application.css", media: "all")
+  end
+
+  def test_stylesheet_pack_tag_outputs_nothing_for_hot
+    Webpacker::DevServer.stub(:hot?, true) do
+      # Webpacker::Configuration.reset
+      # Webpacker::DevServer.reset
+      assert_equal "", @view.stylesheet_pack_tag("bootstrap.css")
+    end
+    # Webpacker::Configuration.reset
+    # Webpacker::DevServer.reset
+  end
+end