shakapacker 6.4.1 → 6.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2ce3fcf970a230e5d52a78be7e8acd7b7bd11338a33a24f1d1ad55b6636ff3c
-  data.tar.gz: 239818a24f0db0e7239a2d114f387b0e3990127350b3e900ee8c2e358fa800dc
+  metadata.gz: b82b9f5ec11e2c2f705b17b2c36bcdc4446dc966c8f08ed0f620b9b0325b6a7a
+  data.tar.gz: 422c4152faf9cc24b1b10a84da9c5e2eda53c52c8a9369e2b01b7a4107a4cde0
 SHA512:
-  metadata.gz: b587960642b7351b54a429dcff2230d0fc08aba1cd8c48d9460c19c981d29262d6e1010d07ebaddaf96f7b1f0154de7b9b99c5263b75f7207c1ee9c647b9941c
-  data.tar.gz: 2574d2356fc023d4a7747c3e4f594042c85553d7c8b429fda2a6fe76e0a87e67fdb8bb478ed5c4267541dfb38b599c0af6c760b417df44b7f4ae6a6337ec7c66
+  metadata.gz: edbc0fc84e0cd99618aeacf63066f2e5bd4abb8a6f160a2d4b3dcfbb8ddd50879add52a4acce0d25c559801b017c20bc8a1d32e2667a97672b383ec668468786
+  data.tar.gz: 9d3ba188baa5731713e472f11dd812ef8a0f33ac6e6cea3ce84c1984c0b3073bec3eefccb5728b5181164db61db1e363cde7affce2a3d3a8d3dce433c7171e58

data/CHANGELOG.md

@@ -1,6 +1,6 @@
 * For the changelog of versions prior to v6, see the [5.x stable branch of rails/webpacker](https://github.com/rails/webpacker/tree/5-x-stable).
 * Please see the [v6 Upgrade Guide](./docs/v6_upgrade.md) to go from versions prior to v6.
-* [ShakaCode](https://www.shakacode.com) offers support for upgrading from webpacker or using Shakapacker. If interested, contact [justin@shakacode.com](mailto:justin@shakacode.com).
+* [ShakaCode](https://www.shakacode.com) offers support for upgrading from webpacker or using Shakapacker. If interested, contact Justin Gordon, [justin@shakacode.com](mailto:justin@shakacode.com).
 
 ## Versions
 ## [Unreleased]
@@ -8,6 +8,13 @@ Changes since last non-beta release.
 
 _Please add entries here for your pull requests that are not yet released._
 
+## [v6.5.0] - July 4, 2022
+### Added
+- `append_stylesheet_pack_tag` helper. It helps in configuring stylesheet pack names from the view for a route or partials. It is also required for filesystem-based automated Component Registry API on React on Rails gem. [PR 144](https://github.com/shakacode/shakapacker/pull/144) by [pulkitkkr](https://github.com/pulkitkkr).
+
+### Improved
+- Make sure at most one compilation runs at a time [PR 139](https://github.com/shakacode/shakapacker/pull/139) by [artemave](https://github.com/artemave)
+
 ## [v6.4.1] - June 5, 2022
 ### Fixed
 - Restores automatic installation of yarn packages removed in [#131](https://github.com/shakacode/shakapacker/pull/131), with added deprecation notice. [PR 140](https://github.com/shakacode/shakapacker/pull/140) by [tomdracz](https://github.com/tomdracz).
@@ -145,7 +152,8 @@ Note: [Rubygem is 6.3.0.pre.rc.1](https://rubygems.org/gems/shakapacker/versions
 ## v5.4.3 and prior changes from rails/webpacker
 See [CHANGELOG.md in rails/webpacker (up to v5.4.3)](https://github.com/rails/webpacker/blob/master/CHANGELOG.md) 
 
-[Unreleased]: https://github.com/shakacode/shakapacker/compare/v6.4.1...master
+[Unreleased]: https://github.com/shakacode/shakapacker/compare/v6.5.0...master
+[v6.5.0]: https://github.com/shakacode/shakapacker/compare/v6.4.1...v6.5.0
 [v6.4.1]: https://github.com/shakacode/shakapacker/compare/v6.4.0...v6.4.1
 [v6.4.0]: https://github.com/shakacode/shakapacker/compare/v6.3.0...v6.4.0
 [v6.3.0]: https://github.com/shakacode/shakapacker/compare/v6.2.1...v6.3.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shakapacker (6.4.0)
+    shakapacker (6.5.0)
       activesupport (>= 5.2)
       rack-proxy (>= 0.6.1)
       railties (>= 5.2)

data/README.md

@@ -26,50 +26,60 @@ Discussion forum and Slack to discuss debugging and troubleshooting tips. Please
 2. [Slack discussion channel](https://reactrails.slack.com/join/shared_invite/enQtNjY3NTczMjczNzYxLTlmYjdiZmY3MTVlMzU2YWE0OWM0MzNiZDI0MzdkZGFiZTFkYTFkOGVjODBmOWEyYWQ3MzA2NGE1YWJjNmVlMGE)
 3. [Tweets with tag `#shakapacker`](https://twitter.com/hashtag/shakapacker?src=hashtag_click)
 
-[ShakaCode](https://www.shakacode.com) offers support for upgrading from webpacker or using Shakapacker. If interested, contact [justin@shakacode.com](mailto:justin@shakacode.com). ShakaCode is [hiring passionate engineers](https://jobs.lever.co/shakacode/3bdbfdb3-4495-4611-a279-01dddb351abe) that love open source.
+[ShakaCode](https://www.shakacode.com) offers support for upgrading from webpacker and using Shakapacker. If interested, contact Justin Gordon, [justin@shakacode.com](mailto:justin@shakacode.com). ShakaCode is [hiring passionate engineers](https://jobs.lever.co/shakacode/3bdbfdb3-4495-4611-a279-01dddb351abe) that love open source.
 
 ---
 
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
-- [Prerequisites](#prerequisites)
-- [Features](#features)
-  - [Optional support](#optional-support)
-- [Installation](#installation)
-  - [Rails v6+](#rails-v6)
-  - [Note for Sprockets usage](#note-for-sprockets-usage)
-  - [Note for Yarn v2 usage](#note-for-yarn-v2-usage)
-- [Usage](#usage)
-  - [View Helpers](#view-helpers)
-  - [Defer for `javascript_pack_tag`](#defer-for-javascript_pack_tag)
-  - [Server-Side Rendering (SSR)](#server-side-rendering-ssr)
-  - [Development](#development)
-  - [Webpack Configuration](#webpack-configuration)
-  - [Babel configuration](#babel-configuration)
-  - [SWC configuration](#swc-configuration)
-  - [esbuild loader configuration](#esbuild-loader-configuration)
-  - [Integrations](#integrations)
-    - [React](#react)
-    - [Typescript](#typescript)
-    - [CoffeeScript](#coffeescript)
-    - [TypeScript](#typescript)
-    - [CSS](#css)
-    - [Postcss](#postcss)
-    - [Sass](#sass)
-    - [Less](#less)
-    - [Stylus](#stylus)
-    - [Other frameworks](#other-frameworks)
-  - [Custom Rails environments](#custom-rails-environments)
-  - [Upgrading](#upgrading)
-  - [Compiler strategies](#compiler-strategies)
-  - [Paths](#paths)
-  - [Additional paths](#additional-paths)
-- [Deployment](#deployment)
-- [Example Apps](#example-apps)
-- [Troubleshooting](#troubleshooting)
-- [Contributing](#contributing)
-- [License](#license)
+  - [Prerequisites](#prerequisites)
+  - [Features](#features)
+    - [Optional support](#optional-support)
+  - [Installation](#installation)
+    - [Rails v6+](#rails-v6)
+    - [Note for Yarn v2 usage](#note-for-yarn-v2-usage)
+  - [Concepts](#concepts)
+  - [Usage](#usage)
+    - [Configuration and Code](#configuration-and-code)
+    - [View Helpers](#view-helpers)
+      - [View Helpers `javascript_pack_tag` and `stylesheet_pack_tag`](#view-helpers-javascript_pack_tag-and-stylesheet_pack_tag)
+      - [View Helper `append_javascript_pack_tag` and `append_stylesheet_pack_tag`](#view-helper-append_javascript_pack_tag-and-append_stylesheet_pack_tag)
+      - [View Helper: `asset_pack_path`](#view-helper-asset_pack_path)
+      - [View Helper: `image_pack_tag`](#view-helper-image_pack_tag)
+      - [View Helper: `favicon_pack_tag`](#view-helper-favicon_pack_tag)
+      - [View Helper: `preload_pack_asset`](#view-helper-preload_pack_asset)
+    - [Images in Stylesheets](#images-in-stylesheets)
+    - [Server-Side Rendering (SSR)](#server-side-rendering-ssr)
+    - [Development](#development)
+      - [Automatic Webpack Code Building](#automatic-webpack-code-building)
+      - [Compiler strategies](#compiler-strategies)
+      - [Common Development Commands](#common-development-commands)
+    - [Webpack Configuration](#webpack-configuration)
+    - [Babel configuration](#babel-configuration)
+    - [SWC configuration](#swc-configuration)
+    - [esbuild loader configuration](#esbuild-loader-configuration)
+    - [Integrations](#integrations)
+      - [React](#react)
+      - [Typescript](#typescript)
+      - [CoffeeScript](#coffeescript)
+      - [TypeScript](#typescript)
+      - [CSS](#css)
+      - [Postcss](#postcss)
+      - [Sass](#sass)
+      - [Less](#less)
+      - [Stylus](#stylus)
+      - [Other frameworks](#other-frameworks)
+    - [Custom Rails environments](#custom-rails-environments)
+    - [Upgrading](#upgrading)
+    - [Paths](#paths)
+    - [Additional paths](#additional-paths)
+  - [Deployment](#deployment)
+  - [Example Apps](#example-apps)
+  - [Troubleshooting](#troubleshooting)
+  - [Contributing](#contributing)
+  - [License](#license)
+- [Supporters](#supporters)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
@@ -249,37 +259,41 @@ While this also generally applies to `stylesheet_pack_tag`, you may use multiple
 <%= stylesheet_pack_tag 'print', media: 'print' %>
 ```
 
-#### View Helper `append_javascript_pack_tag`
+#### View Helper `append_javascript_pack_tag` and `append_stylesheet_pack_tag`
 
-If you need configure your pack names from the view for a route or partials, then you will need some logic to ensure you call the helpers only once with multiple arguments. The new view helper `append_javascript_pack_tag` can solve this problem. This helper will queue up packs when the `javascript_pack_tag` is finally used.
+If you need configure your script pack names or stylesheet pack names from the view for a route or partials, then you will need some logic to ensure you call the helpers only once with multiple arguments. The new view helpers, `append_javascript_pack_tag` and `append_stylesheet_pack_tag` can solve this problem. The helper `append_javascript_pack_tag` will queue up script packs when the `javascript_pack_tag` is finally used. Similarly,`append_stylesheet_pack_tag` will queue up style packs when the `stylesheet_pack_tag` is finally used.
 
 Main view:
 ```erb
 <% append_javascript_pack_tag 'calendar' %>
+<% append_stylesheet_pack_tag 'calendar' %>
 ```
 
 Some partial:
 ```erb
 <% append_javascript_pack_tag 'map' %>
+<% append_stylesheet_pack_tag 'map' %>
 ```
 
 And the main layout has:
 ```erb
 <%= javascript_pack_tag 'application' %>
+<%= stylesheet_pack_tag 'application' %>
 ```
 
 is the same as using this in the main layout:
 
 ```erb
 <%= javascript_pack_tag 'calendar', 'map', application' %>
+<%= stylesheet_pack_tag 'calendar', 'map', application' %>
 ```
 
 However, you typically can't do that in the main layout, as the view and partial codes will depend on the route.
 
-Thus, you can distribute the logic of what packs are needed for any route. All the magic of splitting up the code was automatic!
+Thus, you can distribute the logic of what packs are needed for any route. All the magic of splitting up the code and CSS was automatic!
+
+**Important:** Both `append_(javascript/stylesheet)_pack_tag` helpers can be used anywhere in your application as long as they are executed BEFORE `(javascript/stylesheet)_pack_tag` respectively. If you attempt to call one of the `append_(javascript/stylesheet)_pack_tag` helpers after the respective `(javascript/stylesheet)_pack_tag`, an error will be raised.
 
-**Important:** `append_javascript_pack_tag` can be used anywhere in your application as long as it is executed BEFORE the `javascript_pack_tag`. If you attempt to call `append_javascript_pack_tag` helper after `javascript_pack_tag`, an error will be raised. You should have only a single `javascript_pack_tag` invocation in your page load.
-                                                                                                    
 The typical issue is that your layout might reference some partials that need to configure packs. A good way to solve this problem is to use `content_for` to ensure that the code to render your partial comes before the call to `javascript_pack_tag`.
 
 ```erb

data/lib/webpacker/compiler.rb

@@ -14,19 +14,53 @@ class Webpacker::Compiler
   end
 
   def compile
-    if stale?
-      run_webpack.tap do |success|
-        after_compile_hook
-      end
-    else
+    unless stale?
       logger.debug "Everything's up-to-date. Nothing to do"
+      return true
+    end
+
+    if compiling?
+      wait_for_compilation_to_complete
       true
+    else
+      acquire_ipc_lock do
+        run_webpack.tap do |success|
+          after_compile_hook
+        end
+      end
     end
   end
 
   private
     attr_reader :webpacker
 
+    def acquire_ipc_lock
+      open_lock_file do |lf|
+        lf.flock(File::LOCK_EX)
+        yield if block_given?
+      end
+    end
+
+    def locked?
+      open_lock_file do |lf|
+        lf.flock(File::LOCK_EX | File::LOCK_NB) != 0
+      end
+    end
+
+    alias compiling? locked?
+
+    def wait_for_compilation_to_complete
+      logger.info "Waiting for the compilation to complete..."
+      acquire_ipc_lock
+    end
+
+    def open_lock_file
+      lock_file_name = File.join(Dir.tmpdir, "shakapacker.lock")
+      File.open(lock_file_name, File::CREAT) do |lf|
+        return yield lf
+      end
+    end
+
     def optionalRubyRunner
       bin_webpack_path = config.root_path.join("bin/webpacker")
       first_line = File.readlines(bin_webpack_path).first.chomp

data/lib/webpacker/helper.rb

@@ -98,7 +98,7 @@ module Webpacker::Helper
   def javascript_pack_tag(*names, defer: true, **options)
     if @javascript_pack_tag_loaded
       raise "To prevent duplicated chunks on the page, you should call javascript_pack_tag only once on the page. " \
-      "Please refer to https://github.com/shakacode/shakapacker/blob/master/README.md#usage for the usage guide"
+      "Please refer to https://github.com/shakacode/shakapacker/blob/master/README.md#view-helpers-javascript_pack_tag-and-stylesheet_pack_tag for the usage guide"
     end
 
     append_javascript_pack_tag(*names, defer: defer)
@@ -158,13 +158,28 @@ module Webpacker::Helper
   def stylesheet_pack_tag(*names, **options)
     return "" if Webpacker.inlining_css?
 
-    stylesheet_link_tag(*sources_from_manifest_entrypoints(names, type: :stylesheet), **options)
+    requested_packs = sources_from_manifest_entrypoints(names, type: :stylesheet)
+    appended_packs = available_sources_from_manifest_entrypoints(@stylesheet_pack_tag_queue || [], type: :stylesheet)
+
+    @stylesheet_pack_tag_loaded = true
+
+    stylesheet_link_tag(*(requested_packs | appended_packs), **options)
+  end
+
+  def append_stylesheet_pack_tag(*names)
+    if @stylesheet_pack_tag_loaded
+      raise "You can only call append_stylesheet_pack_tag before stylesheet_pack_tag helper. " \
+      "Please refer to https://github.com/shakacode/shakapacker/blob/master/README.md#view-helper-append_javascript_pack_tag-and-append_stylesheet_pack_tag for the usage guide"
+    end
+
+    @stylesheet_pack_tag_queue ||= []
+    @stylesheet_pack_tag_queue.concat names
   end
 
   def append_javascript_pack_tag(*names, defer: true)
     if @javascript_pack_tag_loaded
       raise "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"
+      "Please refer to https://github.com/shakacode/shakapacker/blob/master/README.md#view-helper-append_javascript_pack_tag-and-append_stylesheet_pack_tag for the usage guide"
     end
 
     hash_key = defer ? :deferred : :non_deferred
@@ -184,6 +199,10 @@ module Webpacker::Helper
       names.map { |name| current_webpacker_instance.manifest.lookup_pack_with_chunks!(name.to_s, type: type) }.flatten.uniq
     end
 
+    def available_sources_from_manifest_entrypoints(names, type:)
+      names.map { |name| current_webpacker_instance.manifest.lookup_pack_with_chunks(name.to_s, type: type) }.flatten.compact.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)

data/lib/webpacker/version.rb

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

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shakapacker",
-  "version": "6.4.1",
+  "version": "6.5.0",
   "description": "Use webpack to manage app-like JavaScript modules in Rails",
   "main": "package/index.js",
   "files": [

data/rakelib/release.rake

@@ -44,6 +44,7 @@ task :create_release, %i[gem_version dry_run] do |_t, args|
   # See https://github.com/svenfuchs/gem-release
   Shakapacker::Utils::Misc.sh_in_dir(gem_root, "git pull --rebase")
   Shakapacker::Utils::Misc.sh_in_dir(gem_root, "gem bump --no-commit #{gem_version.strip.empty? ? '' : %(--version #{gem_version})}")
+  Shakapacker::Utils::Misc.sh_in_dir(gem_root, "bundle install")
 
   # Will bump the yarn version, commit, tag the commit, push to repo, and release on yarn
   release_it_command = +"release-it"

data/test/helper_test.rb

@@ -133,7 +133,7 @@ class HelperTest < ActionView::TestCase
 
     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",
+        "Please refer to https://github.com/shakacode/shakapacker/blob/master/README.md#view-helper-append_javascript_pack_tag-and-append_stylesheet_pack_tag for the usage guide",
       error.message
   end
 
@@ -161,7 +161,7 @@ class HelperTest < ActionView::TestCase
 
     assert_equal \
       "To prevent duplicated chunks on the page, you should call javascript_pack_tag only once on the page. " +
-        "Please refer to https://github.com/shakacode/shakapacker/blob/master/README.md#usage for the usage guide",
+        "Please refer to https://github.com/shakacode/shakapacker/blob/master/README.md#view-helpers-javascript_pack_tag-and-stylesheet_pack_tag for the usage guide",
       error.message
   end
 
@@ -204,5 +204,45 @@ class HelperTest < ActionView::TestCase
     assert_equal \
       hello_stimulus_stylesheet_chunks.map { |chunk| stylesheet_link_tag(chunk) }.join("\n"),
       stimulus_style
+
+    assert_nothing_raised do
+      stylesheet_pack_tag(:application)
+      stylesheet_pack_tag(:hello_stimulus)
+    end
+  end
+
+  def test_stylesheet_pack_with_append
+    append_stylesheet_pack_tag(:hello_stimulus)
+
+    assert_equal \
+      (application_stylesheet_chunks + hello_stimulus_stylesheet_chunks).uniq.map { |chunk| stylesheet_link_tag(chunk) }.join("\n"),
+      stylesheet_pack_tag(:application)
+  end
+
+  def test_stylesheet_pack_with_duplicate_append
+    append_stylesheet_pack_tag(:hello_stimulus)
+    append_stylesheet_pack_tag(:application)
+
+    assert_equal \
+      (application_stylesheet_chunks + hello_stimulus_stylesheet_chunks).uniq.map { |chunk| stylesheet_link_tag(chunk) }.join("\n"),
+      stylesheet_pack_tag(:application)
+  end
+
+  def test_multiple_stylesheet_pack_with_different_media_attr
+    app_style = stylesheet_pack_tag(:application)
+    app_style_with_media = stylesheet_pack_tag(:application, media: "print")
+    hello_stimulus_style_with_media = stylesheet_pack_tag(:hello_stimulus, media: "all")
+
+    assert_equal \
+      application_stylesheet_chunks.map { |chunk| stylesheet_link_tag(chunk) }.join("\n"),
+      app_style
+
+    assert_equal \
+      application_stylesheet_chunks.map { |chunk| stylesheet_link_tag(chunk, media: "print") }.join("\n"),
+      app_style_with_media
+
+    assert_equal \
+      hello_stimulus_stylesheet_chunks.map { |chunk| stylesheet_link_tag(chunk, media: "all") }.join("\n"),
+      hello_stimulus_style_with_media
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shakapacker
 version: !ruby/object:Gem::Version
-  version: 6.4.1
+  version: 6.5.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-05 00:00:00.000000000 Z
+date: 2022-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -303,7 +303,7 @@ homepage: https://github.com/shakacode/shakapacker
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/shakacode/shakapacker/tree/v6.4.1
+  source_code_uri: https://github.com/shakacode/shakapacker/tree/v6.5.0
 post_install_message:
 rdoc_options: []
 require_paths: