shakapacker 6.1.1 → 6.3.0.pre.rc.1

data/test/helper_test.rb

@@ -14,7 +14,6 @@ class HelperTest < ActionView::TestCase
     end.new
 
     @javascript_pack_tag_loaded = nil
-    @stylesheet_pack_tag_loaded = nil
   end
 
   def test_asset_pack_path
@@ -116,6 +115,28 @@ class HelperTest < ActionView::TestCase
       javascript_pack_tag("application", "bootstrap", defer: false)
   end
 
+  def test_javascript_pack_with_append
+    append_javascript_pack_tag("bootstrap", defer: false)
+    assert_equal \
+      %(<script src="/packs/vendors~application~bootstrap-c20632e7baf2c81200d3.chunk.js" defer="defer"></script>\n) +
+        %(<script src="/packs/vendors~application-e55f2aae30c07fb6d82a.chunk.js" defer="defer"></script>\n) +
+        %(<script src="/packs/application-k344a6d59eef8632c9d1.js" defer="defer"></script>\n) +
+        %(<script src="/packs/bootstrap-300631c4f0e0f9c865bc.js"></script>),
+      javascript_pack_tag("application")
+  end
+
+  def test_append_javascript_pack_tag_raises
+    error = assert_raises do
+      javascript_pack_tag("application")
+      append_javascript_pack_tag("bootstrap", defer: false)
+    end
+
+    assert_equal \
+      "You can only call append_javascript_pack_tag before javascript_pack_tag helper. " +
+        "Please refer to https://github.com/shakacode/shakapacker/blob/master/README.md#usage for the usage guide",
+      error.message
+  end
+
   def test_javascript_pack_tag_splat
     assert_equal \
       %(<script src="/packs/vendors~application~bootstrap-c20632e7baf2c81200d3.chunk.js" defer="defer"></script>\n) +
@@ -149,19 +170,19 @@ class HelperTest < ActionView::TestCase
   end
 
   def hello_stimulus_stylesheet_chunks
-    %w[/packs/hello_stimulus-k344a6d59eef8632c9d1.chunk.css]
+    %w[/packs/1-c20632e7baf2c81200d3.chunk.css /packs/hello_stimulus-k344a6d59eef8632c9d1.chunk.css]
   end
 
   def test_stylesheet_pack_tag
     assert_equal \
-      (application_stylesheet_chunks + hello_stimulus_stylesheet_chunks)
+      (application_stylesheet_chunks + hello_stimulus_stylesheet_chunks).uniq
         .map { |chunk| stylesheet_link_tag(chunk) }.join("\n"),
       stylesheet_pack_tag("application", "hello_stimulus")
   end
 
   def test_stylesheet_pack_tag_symbol
     assert_equal \
-      (application_stylesheet_chunks + hello_stimulus_stylesheet_chunks)
+      (application_stylesheet_chunks + hello_stimulus_stylesheet_chunks).uniq
         .map { |chunk| stylesheet_link_tag(chunk) }.join("\n"),
       stylesheet_pack_tag(:application, :hello_stimulus)
   end
@@ -172,15 +193,16 @@ class HelperTest < ActionView::TestCase
       stylesheet_pack_tag("application", media: "all")
   end
 
-  def test_stylesheet_pack_tag_multiple_invocations
-    error = assert_raises do
-      stylesheet_pack_tag(:application)
-      stylesheet_pack_tag(:hello_stimulus)
-    end
+  def test_stylesheet_pack_tag_multiple_invocations_are_allowed
+    app_style = stylesheet_pack_tag(:application)
+    stimulus_style = stylesheet_pack_tag(:hello_stimulus)
 
     assert_equal \
-      "To prevent duplicated chunks on the page, you should call stylesheet_pack_tag only once on the page. " +
-        "Please refer to https://github.com/shakacode/shakapacker/blob/master/README.md#usage for the usage guide",
-      error.message
+      application_stylesheet_chunks.map { |chunk| stylesheet_link_tag(chunk) }.join("\n"),
+      app_style
+
+    assert_equal \
+      hello_stimulus_stylesheet_chunks.map { |chunk| stylesheet_link_tag(chunk) }.join("\n"),
+      stimulus_style
   end
 end

data/test/manifest_test.rb

@@ -8,7 +8,7 @@ class ManifestTest < Minitest::Test
       Webpacker.manifest.lookup!(asset_file)
     end
 
-    assert_match "Webpacker can't find #{asset_file} in #{manifest_path}", error.message
+    assert_match "Shakapacker can't find #{asset_file} in #{manifest_path}", error.message
   end
 
   def test_lookup_with_type_exception!
@@ -18,7 +18,7 @@ class ManifestTest < Minitest::Test
       Webpacker.manifest.lookup!(asset_file, type: :javascript)
     end
 
-    assert_match "Webpacker can't find #{asset_file}.js in #{manifest_path}", error.message
+    assert_match "Shakapacker can't find #{asset_file}.js in #{manifest_path}", error.message
   end
 
   def test_lookup_success!
@@ -60,7 +60,7 @@ class ManifestTest < Minitest::Test
       Webpacker.manifest.lookup_pack_with_chunks!(asset_file, type: :javascript)
     end
 
-    assert_match "Webpacker can't find #{asset_file}.js in #{manifest_path}", error.message
+    assert_match "Shakapacker can't find #{asset_file}.js in #{manifest_path}", error.message
   end
 
   def test_lookup_entrypoint

data/test/test_app/config/webpacker.yml

@@ -9,6 +9,9 @@ default: &default
   webpack_compile_output: false
   webpack_loader: babel
 
+  # Location for manifest.json, defaults to {public_output_path}/manifest.json if unset
+  # manifest_path: public/packs/manifest.json
+
   # Additional paths webpack should look up modules
   # ['app/assets', 'engine/foo/app/assets']
   additional_paths:
@@ -36,6 +39,7 @@ default: &default
 development:
   <<: *default
   compile: true
+  ensure_consistent_versioning: true
 
   # Reference: https://webpack.js.org/configuration/dev-server/
   dev_server:

data/test/test_app/config/webpacker_manifest_path.yml

@@ -0,0 +1,80 @@
+# Note: You must restart bin/webpack-dev-server for changes to take effect
+
+default: &default
+  source_path: app/packs
+  source_entry_path: entrypoints
+  public_root_path: public
+  public_output_path: packs
+  cache_path: tmp/webpacker
+  webpack_compile_output: false
+
+  # Location for manifest.json, defaults to {public_output_path}/manifest.json if unset
+  manifest_path: app/packs/manifest.json
+
+  # Additional paths webpack should look up modules
+  # ['app/assets', 'engine/foo/app/assets']
+  additional_paths:
+    - app/assets
+    - /etc/yarn
+    - some.config.js
+    - app/elm
+
+  # Reload manifest.json on all requests so we reload latest compiled packs
+  cache_manifest: false
+
+  static_assets_extensions:
+    - .jpg
+    - .jpeg
+    - .png
+    - .gif
+    - .tiff
+    - .ico
+    - .svg
+
+  extensions:
+    - .mjs
+    - .js
+
+development:
+  <<: *default
+  compile: true
+
+  # Reference: https://webpack.js.org/configuration/dev-server/
+  dev_server:
+    https: false
+    host: localhost
+    port: 3035
+    public: localhost:3035
+    hmr: false
+    overlay: true
+    disable_host_check: true
+    use_local_ip: false
+    pretty: false
+
+test:
+  <<: *default
+  compile: true
+
+  # Compile test packs to a separate directory
+  public_output_path: packs-test
+
+production:
+  <<: *default
+
+  # Production depends on precompilation of packs prior to booting for performance.
+  compile: false
+
+  # Cache manifest.json for performance
+  cache_manifest: true
+
+staging:
+  <<: *default
+
+  # Production depends on precompilation of packs prior to booting for performance.
+  compile: false
+
+  # Cache manifest.json for performance
+  cache_manifest: true
+
+  # Compile staging packs to a separate directory
+  public_output_path: packs-staging

data/test/test_app/config/webpacker_no_precompile.yml

@@ -0,0 +1,7 @@
+# Note: You must restart bin/webpacker-dev-server for changes to take effect
+
+default: &default
+  webpacker_precompile: false
+
+production:
+  <<: *default

data/test/version_checker_test.rb

@@ -0,0 +1,271 @@
+require "test_helper"
+require "webpacker/version"
+
+class NodePackageVersionDouble
+  attr_reader :raw, :major_minor_patch
+
+  def initialize(raw: nil, major_minor_patch: nil, semver_wildcard: false, skip_processing: false)
+    @raw = raw
+    @major_minor_patch = major_minor_patch
+    @semver_wildcard = semver_wildcard
+    @skip_processing = skip_processing
+  end
+
+  def semver_wildcard?
+    @semver_wildcard
+  end
+
+  def skip_processing?
+    @skip_processing
+  end
+end
+
+class VersionCheckerTest < Minitest::Test
+  def check_version(node_package_version, stub_gem_version = Webpacker::VERSION, stub_config = true)
+    version_checker = Webpacker::VersionChecker.new(node_package_version)
+    version_checker.stub :gem_version, stub_gem_version do
+      Webpacker.config.stub :ensure_consistent_versioning?, stub_config do
+        version_checker.raise_if_gem_and_node_package_versions_differ
+      end
+    end
+  end
+
+  def test_message_printed_if_consistency_check_disabled_and_mismatch
+    node_package_version = NodePackageVersionDouble.new(raw: "6.1.0", major_minor_patch: ["6", "1", "0"])
+
+    out, err = capture_io do
+      check_version(node_package_version, "6.0.0", false)
+    end
+
+    assert_match \
+      "Webpacker::VersionChecker - Version mismatch detected",
+      err
+  end
+
+  def test_message_printed_if_consistency_check_disabled_and_semver
+    node_package_version = NodePackageVersionDouble.new(raw: "^6.1.0", major_minor_patch: ["6", "1", "0"], semver_wildcard: true)
+
+    out, err = capture_io do
+      check_version(node_package_version, "6.1.0", false)
+    end
+
+    assert_match \
+      "Webpacker::VersionChecker - Semver wildcard detected",
+      err
+  end
+
+  def test_raise_on_different_major_version
+    node_package_version = NodePackageVersionDouble.new(raw: "6.1.0", major_minor_patch: ["6", "1", "0"])
+
+    error = assert_raises do
+      check_version(node_package_version, "7.0.0")
+    end
+
+    assert_match \
+      "**ERROR** Webpacker: Webpacker gem and node package versions do not match",
+      error.message
+  end
+
+  def test_raise_on_different_minor_version
+    node_package_version = NodePackageVersionDouble.new(raw: "6.1.0", major_minor_patch: ["6", "1", "0"])
+
+    error = assert_raises do
+      check_version(node_package_version, "6.2.0")
+    end
+
+    assert_match \
+      "**ERROR** Webpacker: Webpacker gem and node package versions do not match",
+      error.message
+  end
+
+  def test_raise_on_different_patch_version
+    node_package_version = NodePackageVersionDouble.new(raw: "6.1.1", major_minor_patch: ["6", "1", "1"])
+
+    error = assert_raises do
+      check_version(node_package_version, "6.1.2")
+    end
+
+    assert_match \
+      "**ERROR** Webpacker: Webpacker gem and node package versions do not match",
+      error.message
+  end
+
+  def test_raise_on_semver_wildcard
+    node_package_version = NodePackageVersionDouble.new(raw: "^6.0.0", major_minor_patch: ["6", "0", "0"], semver_wildcard: true)
+
+    error = assert_raises do
+      check_version(node_package_version, "6.0.0")
+    end
+
+    assert_match \
+      "**ERROR** Webpacker: Your node package version for shakapacker contains a ^ or ~",
+      error.message
+  end
+
+  def test_no_raise_on_matching_versions
+    node_package_version = NodePackageVersionDouble.new(raw: "6.0.0", major_minor_patch: ["6", "0", "0"])
+
+    assert_silent do
+      check_version(node_package_version, "6.0.0")
+    end
+  end
+
+  def test_no_raise_on_matching_versions_beta
+    node_package_version = NodePackageVersionDouble.new(raw: "6.0.0-beta.1", major_minor_patch: ["6", "0", "0"])
+
+    assert_silent do
+      check_version(node_package_version, "6.0.0.beta.1")
+    end
+  end
+
+  def test_no_raise_on_no_package
+    node_package_version = NodePackageVersionDouble.new(raw: nil, skip_processing: true)
+
+    assert_silent do
+      check_version(node_package_version, "6.0.0")
+    end
+  end
+
+  def test_no_raise_on_skipped_path
+    node_package_version = NodePackageVersionDouble.new(raw: "../shakapacker", skip_processing: true)
+
+    assert_silent do
+      check_version(node_package_version, "6.0.0")
+    end
+  end
+end
+
+class NodePackageVersionTest < Minitest::Test
+  def node_package_version(fixture_version: "normal")
+    file_path = File.expand_path("fixtures/#{fixture_version}_package.json", __dir__)
+    Webpacker::VersionChecker::NodePackageVersion.new(file_path)
+  end
+
+  def test_normal_package_raw
+    assert_equal "6.0.0", node_package_version.raw
+  end
+
+  def test_normal_package_major_minor_patch
+    assert_equal ["6", "0", "0"], node_package_version.major_minor_patch
+  end
+
+  def test_normal_package_skip_processing
+    assert_equal false, node_package_version.skip_processing?
+  end
+
+  def test_normal_package_semver_wildcard
+    assert_equal false, node_package_version.semver_wildcard?
+  end
+
+  def test_beta_package_raw
+    assert_equal "6.0.0-beta.1", node_package_version(fixture_version: "beta").raw
+  end
+
+  def test_beta_package_major_minor_patch
+    assert_equal ["6", "0", "0"], node_package_version(fixture_version: "beta").major_minor_patch
+  end
+
+  def test_beta_package_skip_processing
+    assert_equal false, node_package_version(fixture_version: "beta").skip_processing?
+  end
+
+  def test_beta_package_semver_wildcard
+    assert_equal false, node_package_version(fixture_version: "beta").semver_wildcard?
+  end
+
+  def test_semver_caret_package_raw
+    assert_equal "^6.0.0", node_package_version(fixture_version: "semver_caret").raw
+  end
+
+  def test_semver_caret_package_major_minor_patch
+    assert_equal ["6", "0", "0"], node_package_version(fixture_version: "semver_caret").major_minor_patch
+  end
+
+  def test_semver_caret_package_skip_processing
+    assert_equal false, node_package_version(fixture_version: "semver_caret").skip_processing?
+  end
+
+  def test_semver_caret_package_semver_wildcard
+    assert_equal true, node_package_version(fixture_version: "semver_caret").semver_wildcard?
+  end
+
+  def test_semver_tilde_package_raw
+    assert_equal "~6.0.0", node_package_version(fixture_version: "semver_tilde").raw
+  end
+
+  def test_semver_tilde_package_major_minor_patch
+    assert_equal ["6", "0", "0"], node_package_version(fixture_version: "semver_tilde").major_minor_patch
+  end
+
+  def test_semver_tilde_package_skip_processing
+    assert_equal false, node_package_version(fixture_version: "semver_tilde").skip_processing?
+  end
+
+  def test_semver_tilde_package_semver_wildcard
+    assert_equal true, node_package_version(fixture_version: "semver_tilde").semver_wildcard?
+  end
+
+  def test_relative_path_package_raw
+    assert_equal "../shakapacker", node_package_version(fixture_version: "relative_path").raw
+  end
+
+  def test_relative_path_package_major_minor_patch
+    assert_nil node_package_version(fixture_version: "relative_path").major_minor_patch
+  end
+
+  def test_relative_path_package_skip_processing
+    assert_equal true, node_package_version(fixture_version: "relative_path").skip_processing?
+  end
+
+  def test_relative_path_package_semver_wildcard
+    assert_equal false, node_package_version(fixture_version: "relative_path").semver_wildcard?
+  end
+
+  def test_git_url_package_raw
+    assert_equal "git://github.com/shakapacker/shakapacker.git", node_package_version(fixture_version: "git_url").raw
+  end
+
+  def test_git_url_package_major_minor_patch
+    assert_nil node_package_version(fixture_version: "git_url").major_minor_patch
+  end
+
+  def test_git_url_package_skip_processing
+    assert_equal true, node_package_version(fixture_version: "git_url").skip_processing?
+  end
+
+  def test_git_url_package_semver_wildcard
+    assert_equal false, node_package_version(fixture_version: "git_url").semver_wildcard?
+  end
+
+  def test_github_url_package_raw
+    assert_equal "shakapacker/shakapacker#feature/branch", node_package_version(fixture_version: "github_url").raw
+  end
+
+  def test_github_url_package_major_minor_patch
+    assert_nil node_package_version(fixture_version: "github_url").major_minor_patch
+  end
+
+  def test_github_url_package_skip_processing
+    assert_equal true, node_package_version(fixture_version: "github_url").skip_processing?
+  end
+
+  def test_github_url_package_semver_wildcard
+    assert_equal false, node_package_version(fixture_version: "github_url").semver_wildcard?
+  end
+
+  def test_without_package_raw
+    assert_equal "", node_package_version(fixture_version: "without").raw
+  end
+
+  def test_without_package_major_minor_patch
+    assert_nil node_package_version(fixture_version: "without").major_minor_patch
+  end
+
+  def test_without_package_skip_processing
+    assert_equal true, node_package_version(fixture_version: "without").skip_processing?
+  end
+
+  def test_without_package_semver_wildcard
+    assert_equal false, node_package_version(fixture_version: "without").semver_wildcard?
+  end
+end

data/test/webpacker_test.rb

@@ -23,11 +23,26 @@ class WebpackerTest < Webpacker::Test
     def dev_server.https?; true; end
     def dev_server.hmr?; true; end
     def dev_server.running?; true; end
+    def dev_server.inline_css?; true; end
     Webpacker.instance.stub(:dev_server, dev_server) do
       assert Webpacker.inlining_css?
     end
   end
 
+  def test_explicit_no_inline_css_with_hmr
+    dev_server = Webpacker::DevServer.new({})
+    def dev_server.host; "localhost"; end
+    def dev_server.port; "3035"; end
+    def dev_server.pretty?; false; end
+    def dev_server.https?; true; end
+    def dev_server.hmr?; true; end
+    def dev_server.running?; true; end
+    def dev_server.inline_css?; false; end
+    Webpacker.instance.stub(:dev_server, dev_server) do
+      assert !Webpacker.inlining_css?
+    end
+  end
+
   def test_app_autoload_paths_cleanup
     assert_empty $test_app_autoload_paths_in_initializer
   end