shakapacker 7.0.0 → 7.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0eef3643fb556af4dc928c1d651fa46cfe5543fc6d5a227d29fcbfd7b3876c3c
-  data.tar.gz: 4530e671bb02c0af5bbfc37ba1696fff4e81548c40af6df65a06e2bc2d0a9815
+  metadata.gz: 51bc05e46de3c757f9d47e0435cb1928759bff38a354b4b63a5e28f5fe91b1c6
+  data.tar.gz: a21060c6cd736a1171c78d1bdd927292523148cedccb90e361a4c645be05983e
 SHA512:
-  metadata.gz: a7803b77d1d0e9dff88d6cdb25f88c1a89fb4c036153e03d153fe994b216a82a69aaa85d446331945a528443fbd097ac4f49cb64661e66f29b5941a5971315a8
-  data.tar.gz: 98aba0b391b59a50932d43cab666604998d66c5bcf548f8ceea06c77919a9196ba5ca2861a204ce3f66cd490d69b64e0e8c0dfb10610b6ba64842049f49d2df4
+  metadata.gz: eb9e323ebfcc603375ab766b3b2fc87641379e40a18f033703d4b0e1887001d7e7a915f42359a71d307b651f0de2e15e7cb209ccb7d40ccbfd3d839e2436e0ad
+  data.tar.gz: c839ce0d465e2fa67379938264de5da4e00f9374202b2e13a36e3f1e6943dde73f80304f9e88f49632a8944ddc2238ea96a81136e609ed16873ce8e06c2cca01

data/CHANGELOG.md

@@ -9,6 +9,14 @@ Changes since last non-beta release.
 
 _Please add entries here for your pull requests that are not yet released._
 
+### Fixed
+- Fixed creation of assets:precompile if it is missing [PR 325](https://github.com/shakacode/shakapacker/pull/325) by [ahangarha](https://github.com/ahangarha).
+
+## [v7.0.1] - June 27, 2023
+### Fixed
+- Fixed the condition for showing warning for setting `useContentHash` to `false` in the production environment. [PR 320](https://github.com/shakacode/shakapacker/pull/320) by [ahangarha](https://github.com/ahangarha).
+
+## [v7.0.0] - June 23, 2023
 ### Breaking changes
 - Removes defaults passed to `@babel/preset-typescript`. [PR 273](https://github.com/shakacode/shakapacker/pull/273) by [tomdracz](https://github.com/tomdracz).
 
@@ -254,7 +262,9 @@ 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.6.0...master
+[Unreleased]: https://github.com/shakacode/shakapacker/compare/v7.0.1...master
+[v7.0.1]: https://github.com/shakacode/shakapacker/compare/v7.0.0...v7.0.1
+[v7.0.0]: https://github.com/shakacode/shakapacker/compare/v6.6.0...v7.0.0
 [v6.6.0]: https://github.com/shakacode/shakapacker/compare/v6.5.6...v6.6.0
 [v6.5.6]: https://github.com/shakacode/shakapacker/compare/v6.5.5...v6.5.6
 [v6.5.5]: https://github.com/shakacode/shakapacker/compare/v6.5.4...v6.5.5

data/docs/v7_upgrade.md

@@ -1,41 +1,44 @@
 # Upgrading from Shakapacker v6 to v7
 
-There will be several substantial and breaking changes in Shakapacker v7 that you need to manually account for when coming from Shakapacker v6.
+There are several breaking changes in Shakapacker v7 that you need to manually account for when coming from Shakapacker v6.
 
-## Usages of 'webpacker' should now be 'shakapacker'
+## Usages of `webpacker` should now be `shakapacker`
 
 Shakapacker v6 kept the 'webpacker' spelling. As a result, many config filenames, environment variables, rake tasks, etc., used the 'webpacker' spelling. Shakapacker 7 requires renaming to the 'shakapacker' spelling.
 
 Shakapacker v7 provides a high degree of backward compatibility for spelling changes. It displays deprecation messages in the terminal to help the developers have a smooth experience in making the required transition to the new requirements.
 
-Please note that Shakapacker v8 will remove any backward compatibility for spelling.
+Just so you know, Shakapacker v8 will remove any backward compatibility for spelling.
 
 ### Upgrade Steps
 
 **Note:** At each step of changing the version, ensure that you update both gem and npm versions to the same "exact" version (like `x.y.z` and not `^x.y.z` or `>= x.y.z`).
 
-1. Upgrade Shakapacker to the latest 6.x version and ensure no issues running your application. 
+1. Upgrade Shakapacker to the latest 6.x version and make sure there are no issues running your application. 
 2. Upgrade Shakapacker to version 7.
 3. Run `rake shakapacker:binstubs` to get the new files in place. Then delete the `bin/webpacker` and `bin/webpacker-dev-server` ones.
 4. Change spelling from Webpacker to Shakapacker in the code
    - Change `webpacker_precompile` entry to `shakapacker_precompile` if it exists in the config file.
-   - Rename Ruby constant `Webpacker` to `Shakapacker` doing a global search and replace in your code. You might not be using it.
+   - Rename Ruby constant `Webpacker` to `Shakapacker` by doing a global search and replace in your code. You might not be using it.
      - Rename`Shakapacker.config.webpacker_precompile?` method, replace it with `Shakapacker.config.shakapacker_precompile?`
    - `--debug-webpacker` is now `--debug-shakapacker` for your shakapacker binstubs.
 5. Rename files
     - Rename `config/webpacker.yml` to `config/shakapacker.yml`.
     - Rename environment variables from `WEBPACKER_XYZ` to `SHAKAPACKER_XYZ`.
-6. Where you have used webpackConfig, you now need to invoke it as it is a function. Alternatively, you can rename the import to globalMutableWebpackConfig which retains the v6 behavior.
-7. You may need to upgrade dependencies in package.json. You should use `yarn upgrade-interactive`. Note, some upgrades introduce issues. Some will fix issues. You may need to try a few different versions of a dependency to find one that works.
+6. Where you have used webpackConfig, you must create a new instance with `generateWebpackConfig`. Alternatively, you can rename the import to globalMutableWebpackConfig, which retains the v6 behavior of a global, mutable object.
+7. You may need to upgrade dependencies in package.json. You should use `yarn upgrade-interactive`.
 
+## Stop stripping top-level dirs for static assets
+
+When generating file paths for static assets, a top-level directory will no longer be stripped. This will necessitate the update of file name references in asset helpers. For example, the file sourced from `app/javascript/images/image.png` will now be output to `static/images/image.png`, and needs to be referenced as `image_pack_tag("images/image.jpg")` or `image_pack_tag("static/images/image.jpg")`. Nested directories are supported.
 
 ## The `webpackConfig` property is changed
 
 The `webpackConfig` property in the `shakapacker` module has been changed. The shakapacker module has two options:
-1. `generatedWebpackConfig`: a function that returns an immutable webpack configuration object, which ensures that any modifications made to it will not affect any other usage of the webpack configuration. 
-2. `globalMutableWebpackConfig`: if a project still requires the old mutable object. You can rename your imports of `webpackConfig` with `globalMutableWebpackConfig`.
+1. `generatedWebpackConfig`: a function that returns a new webpack configuration object, which ensures that any modifications made to it will not affect any other usage of the webpack configuration.
+2. `globalMutableWebpackConfig`: if a project still desires the old mutable object. You can rename your imports of `webpackConfig` with `globalMutableWebpackConfig`.
 
-### Example Upgrade
+## Example Upgrade
 If you started with:
 
 ```js

data/lib/shakapacker/version.rb

@@ -1,4 +1,4 @@
 module Shakapacker
   # Change the version in package.json too, please!
-  VERSION = "7.0.0".freeze
+  VERSION = "7.0.2".freeze
 end

data/lib/tasks/shakapacker/compile.rake

@@ -22,5 +22,7 @@ end
 if Shakapacker.config.shakapacker_precompile?
   if Rake::Task.task_defined?("assets:precompile")
     invoke_shakapacker_compile_in_assets_precompile_task
+  else
+    Rake::Task.define_task("assets:precompile" => ["shakapacker:compile"])
   end
 end

data/package/environments/__tests__/production.js

@@ -23,6 +23,19 @@ describe('Production specific config', () => {
         'js/[name]-[contenthash].chunk.js'
       )
     })
+
+    test("doesn't shows any warning message", () => {
+      const consoleWarnSpy = jest.spyOn(console, 'warn');
+      const config = require("../../config");
+      config.useContentHash = true
+      const environmnetConfig = require('../production')
+
+      expect(consoleWarnSpy).not.toHaveBeenCalledWith(
+        expect.stringMatching(/Setting 'useContentHash' to 'false' in the production environment/)
+      )
+
+      consoleWarnSpy.mockRestore()
+    })
   })
 
   describe('with config.useContentHash = false', () => {
@@ -36,6 +49,19 @@ describe('Production specific config', () => {
         'js/[name]-[contenthash].chunk.js'
       )
     })
+
+    test('shows a warning message', () => {
+      const consoleWarnSpy = jest.spyOn(console, 'warn');
+      const config = require("../../config");
+      config.useContentHash = false
+      const environmnetConfig = require('../production')
+
+      expect(consoleWarnSpy).toHaveBeenCalledWith(
+        expect.stringMatching(/Setting 'useContentHash' to 'false' in the production environment/)
+      )
+
+      consoleWarnSpy.mockRestore()
+    })
   })
 
   describe('with unset config.useContentHash', () => {
@@ -49,5 +75,18 @@ describe('Production specific config', () => {
         'js/[name]-[contenthash].chunk.js'
       )
     })
+
+    test("doesn't shows any warning message", () => {
+      const consoleWarnSpy = jest.spyOn(console, 'warn');
+      const config = require("../../config");
+      delete config.useContentHash
+      const environmnetConfig = require('../production')
+
+      expect(consoleWarnSpy).not.toHaveBeenCalledWith(
+        expect.stringMatching(/Setting 'useContentHash' to 'false' in the production environment/)
+      )
+
+      consoleWarnSpy.mockRestore()
+    })
   })
 })

data/package/environments/production.js

@@ -77,7 +77,7 @@ const productionConfig = {
   }
 }
 
-if (config.useContentHash === true) {
+if (config.useContentHash === false) {
   // eslint-disable-next-line no-console
   console.warn(`⚠️ WARNING
 Setting 'useContentHash' to 'false' in the production environment (specified by NODE_ENV environment variable) is not allowed!

data/package.json

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shakapacker
 version: !ruby/object:Gem::Version
-  version: 7.0.0
+  version: 7.0.2
 platform: ruby
 authors:
 - David Heinemeier Hansson
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-23 00:00:00.000000000 Z
+date: 2023-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -528,7 +528,7 @@ homepage: https://github.com/shakacode/shakapacker
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/shakacode/shakapacker/tree/v7.0.0
+  source_code_uri: https://github.com/shakacode/shakapacker/tree/v7.0.2
 post_install_message:
 rdoc_options: []
 require_paths: