shakapacker 8.0.1 → 8.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11198f6552ef8050f8946a58ebdf5ff5cffa7a79a9dd8aec3932afd1b7befdc3
-  data.tar.gz: 7b50eca8202c5f2bcadabd61d5f9dfb15c48a91d5b4c45125beb58c5e1943ce1
+  metadata.gz: db9b65b6bcad3c69564cc6e9a1c81ef86586b551cceac4426ff4648388943063
+  data.tar.gz: 764219a7ff3a435f16bf8554f538f56b5d32f29e1849cdf06241504098b5f9c9
 SHA512:
-  metadata.gz: 82d676202bfbd8d99d0192e91f1215715094122f32e3776c9ab394cb9f35c7e0bbc67f31aacc88b07c4081b059c46011be883c7bf4f48988f82d3f18a9b99024
-  data.tar.gz: dac55e80ee92fa06ba53580b0555a677788dfb0d061148db7fef18bd34b9ad11cbe3350b4ee84609b3207d0f2dc45a9e6a454f21eb2dbf3688e17eaf7861bf44
+  metadata.gz: 1b45a4a37953a95d40eeaa8382350991058e074157594a8eeb977eace38db31d0c2507db9aec61eb8eea20485e135d68e9e9d688fc8fe094f4672532715ecc01
+  data.tar.gz: b053d207e3e1d56ab2e92987d216212f75e4b6d41d49d6b5bed1ccfdb29d917b94ac4d17220f607253ffc9d335de733089deb1e5aca44dc389a6177168e244da

data/CHANGELOG.md

@@ -10,6 +10,12 @@ _next_ branch is for v8 changes
 ## [Unreleased]
 Changes since the last non-beta release.
 
+### Changed
+
+- Fix wrong instruction in esbuild loader documentation [PR 504](https://github.com/shakacode/shakapacker/pull/504) by [adriangohjw](https://github.com/adriangohjw)
+
+## [v8.0.1] - July 10, 2024
+
 ### Changed
 - Update outdated GitHub Actions to use Node.js 20.0 versions instead [PR 497](https://github.com/shakacode/shakapacker/pull/497) by [adriangohjw](https://github.com/adriangohjw).
 - Allow `webpack-merge` v6 to be used [PR 502](https://github.com/shakacode/shakapacker/pull/502) by [G-Rath](https://github.com/g-rath).
@@ -380,7 +386,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/v8.0.0...main
+[Unreleased]: https://github.com/shakacode/shakapacker/compare/v8.0.1...main
+[v8.0.1]: https://github.com/shakacode/shakapacker/compare/v8.0.0...v8.0.1
 [v8.0.0]: https://github.com/shakacode/shakapacker/compare/v7.2.3...v8.0.0
 [v7.2.3]: https://github.com/shakacode/shakapacker/compare/v7.2.2...v7.2.3
 [v7.2.2]: https://github.com/shakacode/shakapacker/compare/v7.2.1...v7.2.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shakapacker (8.0.1)
+    shakapacker (8.0.2)
       activesupport (>= 5.2)
       package_json
       rack-proxy (>= 0.6.1)

data/__mocks__/nonexistent/package.json

@@ -0,0 +1,4 @@
+{
+  "main": "./wat",
+  "version": "12.0.0"
+}

data/__mocks__/sass-loader/package.json

@@ -0,0 +1,4 @@
+{
+  "main": "./lib/api.js",
+  "version": "16.56.81"
+}

data/docs/using_esbuild_loader.md

@@ -27,7 +27,7 @@ To use esbuild as your transpiler today. You need to do two things:
 npm install esbuild esbuild-loader
 ```
 
-2. Add or change `shakapacker_loader` value in your default `shakapacker.yml` config to `esbuild`
+2. Add or change `webpack_loader` value in your default `shakapacker.yml` config to `esbuild`
 The default configuration of babel is done by using `package.json` to use the file within the `shakapacker` package.
 
 ```yml

data/jest.config.js

@@ -1,4 +1,5 @@
 module.exports = {
   roots: ["<rootDir>/test"],
-  testPathIgnorePatterns: ["/__fixtures__/", "/__utils__/"]
+  testPathIgnorePatterns: ["/__fixtures__/", "/__utils__/"],
+  resolver: "<rootDir>/test/resolver"
 }

data/lib/shakapacker/version.rb

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

data/package/rules/sass.js

@@ -1,16 +1,18 @@
 /* eslint global-require: 0 */
 
 const getStyleRule = require("../utils/getStyleRule")
-const { canProcess } = require("../utils/helpers")
-const { additional_paths: includePaths } = require("../config")
+const { canProcess, packageMajorVersion } = require("../utils/helpers")
+const { additional_paths: extraPaths } = require("../config")
 
-module.exports = canProcess("sass-loader", (resolvedPath) =>
-  getStyleRule(/\.(scss|sass)(\.erb)?$/i, [
+module.exports = canProcess("sass-loader", (resolvedPath) => {
+  const optionKey =
+    packageMajorVersion("sass-loader") > 15 ? "loadPaths" : "includePaths"
+  return getStyleRule(/\.(scss|sass)(\.erb)?$/i, [
     {
       loader: resolvedPath,
       options: {
-        sassOptions: { includePaths }
+        sassOptions: { [optionKey]: extraPaths }
       }
     }
   ])
-)
+})

data/package/utils/helpers.js

@@ -41,10 +41,18 @@ const loaderMatches = (configLoader, loaderToCheck, fn) => {
   return fn()
 }
 
+const packageMajorVersion = (packageName) => {
+  // eslint-disable-next-line import/no-dynamic-require
+  const packageJsonPath = require.resolve(`${packageName}/package.json`)
+  // eslint-disable-next-line import/no-dynamic-require, global-require
+  return require(packageJsonPath).version.match(/^\d+/)[0]
+}
+
 module.exports = {
   isBoolean,
   ensureTrailingSlash,
   canProcess,
   moduleExists,
-  loaderMatches
+  loaderMatches,
+  packageMajorVersion
 }

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shakapacker",
-  "version": "8.0.1",
+  "version": "8.0.2",
   "description": "Use webpack to manage app-like JavaScript modules in Rails",
   "homepage": "https://github.com/shakacode/shakapacker",
   "bugs": {

data/test/package/development.test.js

@@ -4,6 +4,15 @@ const { chdirTestApp, resetEnv } = require("../helpers")
 const rootPath = process.cwd()
 chdirTestApp()
 
+jest.mock("../../package/utils/helpers", () => {
+  const original = jest.requireActual("../../package/utils/helpers")
+  const moduleExists = () => false
+  return {
+    ...original,
+    moduleExists
+  }
+})
+
 describe("Development environment", () => {
   beforeEach(() => jest.resetModules() && resetEnv())
   afterAll(() => process.chdir(rootPath))

data/test/package/environments/base.test.js

@@ -10,6 +10,15 @@ chdirTestApp()
 const baseConfig = require("../../../package/environments/base")
 const config = require("../../../package/config")
 
+jest.mock("../../../package/utils/helpers", () => {
+  const original = jest.requireActual("../../../package/utils/helpers")
+  const moduleExists = () => false
+  return {
+    ...original,
+    moduleExists
+  }
+})
+
 describe("Base config", () => {
   beforeEach(() => jest.resetModules() && resetEnv())
   afterAll(() => process.chdir(rootPath))

data/test/package/environments/development.test.js

@@ -3,6 +3,15 @@ const { chdirTestApp, resetEnv } = require("../../helpers")
 const rootPath = process.cwd()
 chdirTestApp()
 
+jest.mock("../../../package/utils/helpers", () => {
+  const original = jest.requireActual("../../../package/utils/helpers")
+  const moduleExists = () => false
+  return {
+    ...original,
+    moduleExists
+  }
+})
+
 describe("Development specific config", () => {
   beforeEach(() => {
     jest.resetModules()

data/test/package/environments/production.test.js

@@ -3,6 +3,15 @@ const { chdirTestApp, resetEnv } = require("../../helpers")
 const rootPath = process.cwd()
 chdirTestApp()
 
+jest.mock("../../../package/utils/helpers", () => {
+  const original = jest.requireActual("../../../package/utils/helpers")
+  const moduleExists = () => false
+  return {
+    ...original,
+    moduleExists
+  }
+})
+
 describe("Production specific config", () => {
   beforeEach(() => {
     jest.resetModules()

data/test/package/helpers.test.js

@@ -0,0 +1,11 @@
+const { packageMajorVersion } = require("../../package/utils/helpers")
+
+describe("packageMajorVersion", () => {
+  test("should find that sass-loader is v16", () => {
+    expect(packageMajorVersion("sass-loader")).toBe("16")
+  })
+
+  test("should find that nonexistent is v12", () => {
+    expect(packageMajorVersion("nonexistent")).toBe("12")
+  })
+})

data/test/package/index.test.js

@@ -1,5 +1,14 @@
 const index = require("../../package/index")
 
+jest.mock("../../package/utils/helpers", () => {
+  const original = jest.requireActual("../../package/utils/helpers")
+  const moduleExists = () => false
+  return {
+    ...original,
+    moduleExists
+  }
+})
+
 describe("index", () => {
   test("exports webpack-merge v5 functions", () => {
     expect(index.merge).toBeInstanceOf(Function)

data/test/package/production.test.js

@@ -4,6 +4,15 @@ const { chdirTestApp } = require("../helpers")
 const rootPath = process.cwd()
 chdirTestApp()
 
+jest.mock("../../package/utils/helpers", () => {
+  const original = jest.requireActual("../../package/utils/helpers")
+  const moduleExists = () => false
+  return {
+    ...original,
+    moduleExists
+  }
+})
+
 describe("Production environment", () => {
   afterAll(() => process.chdir(rootPath))
 

data/test/package/rules/index.test.js

@@ -1,5 +1,14 @@
 const rules = require("../../../package/rules/index")
 
+jest.mock("../../../package/utils/helpers", () => {
+  const original = jest.requireActual("../../../package/utils/helpers")
+  const moduleExists = () => false
+  return {
+    ...original,
+    moduleExists
+  }
+})
+
 describe("index", () => {
   test("rule tests are regexes", () => {
     rules.forEach((rule) => expect(rule.test instanceof RegExp).toBe(true))

data/test/package/rules/sass.test.js

@@ -0,0 +1,23 @@
+const sass = require("../../../package/rules/sass")
+
+jest.mock("../../../package/utils/helpers", () => {
+  const original = jest.requireActual("../../../package/utils/helpers")
+  const canProcess = (rule, fn) => {
+    return fn("This path was mocked")
+  }
+  const packageMajorVersion = () => "15"
+  return {
+    ...original,
+    canProcess,
+    packageMajorVersion
+  }
+})
+
+jest.mock("../../../package/utils/inliningCss", () => true)
+
+describe("sass rule", () => {
+  test("contains loadPaths as the sassOptions key if sass-loader is v15 or earlier", () => {
+    expect(typeof sass.use[3].options.sassOptions.includePaths).toBe("object")
+    expect(typeof sass.use[3].options.sassOptions.loadPaths).toBe("undefined")
+  })
+})

data/test/package/rules/sass1.test.js

@@ -0,0 +1,23 @@
+const sass = require("../../../package/rules/sass")
+
+jest.mock("../../../package/utils/helpers", () => {
+  const original = jest.requireActual("../../../package/utils/helpers")
+  const canProcess = (rule, fn) => {
+    return fn("This path was mocked")
+  }
+  return {
+    ...original,
+    canProcess
+  }
+})
+
+jest.mock("../../../package/utils/inliningCss", () => true)
+
+describe("sass rule", () => {
+  test("contains loadPaths as the sassOptions key if sass-loader is v15 or earlier", () => {
+    expect(typeof sass.use[3].options.sassOptions.includePaths).toBe(
+      "undefined"
+    )
+    expect(typeof sass.use[3].options.sassOptions.loadPaths).toBe("object")
+  })
+})

data/test/package/staging.test.js

@@ -4,6 +4,15 @@ const { chdirTestApp } = require("../helpers")
 const rootPath = process.cwd()
 chdirTestApp()
 
+jest.mock("../../package/utils/helpers", () => {
+  const original = jest.requireActual("../../package/utils/helpers")
+  const moduleExists = () => false
+  return {
+    ...original,
+    moduleExists
+  }
+})
+
 describe("Custom environment", () => {
   afterAll(() => process.chdir(rootPath))
 

data/test/package/test.test.js

@@ -4,6 +4,15 @@ const { chdirTestApp } = require("../helpers")
 const rootPath = process.cwd()
 chdirTestApp()
 
+jest.mock("../../package/utils/helpers", () => {
+  const original = jest.requireActual("../../package/utils/helpers")
+  const moduleExists = () => false
+  return {
+    ...original,
+    moduleExists
+  }
+})
+
 describe("Test environment", () => {
   afterAll(() => process.chdir(rootPath))
 

data/test/resolver.js

@@ -0,0 +1,13 @@
+const mapping = {
+  "css-loader": "this path was mocked",
+  "sass-loader/package.json": "../../__mocks__/sass-loader/package.json",
+  "nonexistent/package.json": "../../__mocks__/nonexistent/package.json"
+}
+
+function resolver(module, options) {
+  // If the path corresponds to a key in the mapping object, returns the fakely resolved path
+  // otherwise it calls the Jest's default resolver
+  return mapping[module] || options.defaultResolver(module, options)
+}
+
+module.exports = resolver

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shakapacker
 version: !ruby/object:Gem::Version
-  version: 8.0.1
+  version: 8.0.2
 platform: ruby
 authors:
 - David Heinemeier Hansson
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-10 00:00:00.000000000 Z
+date: 2024-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -155,6 +155,8 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- __mocks__/nonexistent/package.json
+- __mocks__/sass-loader/package.json
 - config/README.md
 - config/shakapacker.yml
 - docs/customizing_babel_config.md
@@ -261,6 +263,7 @@ files:
 - test/package/environments/base.test.js
 - test/package/environments/development.test.js
 - test/package/environments/production.test.js
+- test/package/helpers.test.js
 - test/package/index.test.js
 - test/package/production.test.js
 - test/package/rules/babel.test.js
@@ -268,15 +271,18 @@ files:
 - test/package/rules/file.test.js
 - test/package/rules/index.test.js
 - test/package/rules/raw.test.js
+- test/package/rules/sass.test.js
+- test/package/rules/sass1.test.js
 - test/package/rules/swc.test.js
 - test/package/staging.test.js
 - test/package/test.test.js
+- test/resolver.js
 - yarn.lock
 homepage: https://github.com/shakacode/shakapacker
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/shakacode/shakapacker/tree/v8.0.1
+  source_code_uri: https://github.com/shakacode/shakapacker/tree/v8.0.2
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -305,6 +311,7 @@ test_files:
 - test/package/environments/base.test.js
 - test/package/environments/development.test.js
 - test/package/environments/production.test.js
+- test/package/helpers.test.js
 - test/package/index.test.js
 - test/package/production.test.js
 - test/package/rules/babel.test.js
@@ -312,6 +319,9 @@ test_files:
 - test/package/rules/file.test.js
 - test/package/rules/index.test.js
 - test/package/rules/raw.test.js
+- test/package/rules/sass.test.js
+- test/package/rules/sass1.test.js
 - test/package/rules/swc.test.js
 - test/package/staging.test.js
 - test/package/test.test.js
+- test/resolver.js