shakapacker 8.0.1 → 8.1.0

data/gemfiles/Gemfile-rails.7.2.x

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+gemspec path: "../"
+
+gem "rails", '~>7.2.0'
+gem "rake", ">= 11.1"
+gem "rack-proxy", require: false
+gem "rspec-rails", "~> 7.0"
+gem "byebug"

data/gemfiles/Gemfile-rails.8.0.x

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+gemspec path: "../"
+
+gem "rails", '~>8.0.0'
+gem "rake", ">= 11.1"
+gem "rack-proxy", require: false
+gem "rspec-rails", "~> 7.0"
+gem "byebug"

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/compiler.rb

@@ -1,7 +1,8 @@
 require "open3"
-require "shakapacker/compiler_strategy"
 require "fileutils"
 
+require_relative "compiler_strategy"
+
 class Shakapacker::Compiler
   # Additional environment variables that the compiler is being run with
   # Shakapacker::Compiler.env['FRONTEND_API_KEY'] = 'your_secret_key'

data/lib/shakapacker/compiler_strategy.rb

@@ -1,5 +1,5 @@
-require "shakapacker/mtime_strategy"
-require "shakapacker/digest_strategy"
+require_relative "mtime_strategy"
+require_relative "digest_strategy"
 
 module Shakapacker
   class CompilerStrategy

data/lib/shakapacker/dev_server_runner.rb

@@ -1,8 +1,9 @@
 require "shellwords"
 require "socket"
-require "shakapacker/configuration"
-require "shakapacker/dev_server"
-require "shakapacker/runner"
+
+require_relative "configuration"
+require_relative "dev_server"
+require_relative "runner"
 
 module Shakapacker
   class DevServerRunner < Shakapacker::Runner

data/lib/shakapacker/digest_strategy.rb

@@ -1,5 +1,6 @@
 require "digest/sha1"
-require "shakapacker/base_strategy"
+
+require_relative "base_strategy"
 
 module Shakapacker
   class DigestStrategy < BaseStrategy

data/lib/shakapacker/helper.rb

@@ -195,7 +195,7 @@ module Shakapacker::Helper
 
     def update_javascript_pack_tag_queue(defer:)
       if @javascript_pack_tag_loaded
-        raise "You can only call #{caller_locations(1..1).first.label} before javascript_pack_tag helper. " \
+        raise "You can only call #{caller_locations(1..1).first.base_label} before javascript_pack_tag helper. " \
         "Please refer to https://github.com/shakacode/shakapacker/blob/main/README.md#view-helper-append_javascript_pack_tag-prepend_javascript_pack_tag-and-append_stylesheet_pack_tag for the usage guide"
       end
 

data/lib/shakapacker/mtime_strategy.rb

@@ -1,4 +1,4 @@
-require "shakapacker/base_strategy"
+require_relative "base_strategy"
 
 module Shakapacker
   class MtimeStrategy < BaseStrategy

data/lib/shakapacker/railtie.rb

@@ -1,9 +1,9 @@
 require "rails/railtie"
 
-require "shakapacker/helper"
-require "shakapacker/dev_server_proxy"
-require "shakapacker/version_checker"
-require "shakapacker/utils/manager"
+require_relative "helper"
+require_relative "dev_server_proxy"
+require_relative "version_checker"
+require_relative "utils/manager"
 
 class Shakapacker::Engine < ::Rails::Engine
   # Allows Shakapacker config values to be set via Rails env config files

data/lib/shakapacker/runner.rb

@@ -1,5 +1,6 @@
-require "shakapacker/utils/misc"
-require "shakapacker/utils/manager"
+require_relative "utils/misc"
+require_relative "utils/manager"
+
 require "package_json"
 
 module Shakapacker
@@ -14,13 +15,8 @@ module Shakapacker
       @argv = argv
 
       @app_path              = File.expand_path(".", Dir.pwd)
-      @webpack_config        = File.join(@app_path, "config/webpack/webpack.config.js")
       @shakapacker_config    = ENV["SHAKAPACKER_CONFIG"] || File.join(@app_path, "config/shakapacker.yml")
-
-      unless File.exist?(@webpack_config)
-        $stderr.puts "webpack config #{@webpack_config} not found, please run 'bundle exec rails shakapacker:install' to install Shakapacker with default configs or add the missing config file for your custom environment."
-        exit!
-      end
+      @webpack_config        = find_webpack_config
 
       Shakapacker::Utils::Manager.error_unless_package_manager_is_obvious!
     end
@@ -28,5 +24,18 @@ module Shakapacker
     def package_json
       @package_json ||= PackageJson.read(@app_path)
     end
+
+    private
+      def find_webpack_config
+        possible_paths = %w[ts js].map do |ext|
+          File.join(@app_path, "config/webpack/webpack.config.#{ext}")
+        end
+        path = possible_paths.find { |f| File.exist?(f) }
+        unless path
+          $stderr.puts "webpack config #{possible_paths.last} not found, please run 'bundle exec rails shakapacker:install' to install Shakapacker with default configs or add the missing config file for your custom environment."
+          exit!
+        end
+        path
+      end
   end
 end

data/lib/shakapacker/utils/manager.rb

@@ -16,7 +16,7 @@ module Shakapacker
 
       # Emits a warning if it's not obvious what package manager to use
       def self.error_unless_package_manager_is_obvious!
-        return unless PackageJson.read.fetch("packageManager", nil).nil?
+        return unless PackageJson.read(rails_root).fetch("packageManager", nil).nil?
 
         guessed_binary = guess_binary
 
@@ -35,7 +35,7 @@ module Shakapacker
       #
       # @return [String]
       def self.guess_binary
-        MANAGER_LOCKS.find { |_, lock| File.exist?(lock) }&.first || "npm"
+        MANAGER_LOCKS.find { |_, lock| File.exist?(rails_root.join(lock)) }&.first || "npm"
       end
 
       # Guesses the version of the package manager to use by calling `<manager> --version`
@@ -53,6 +53,17 @@ module Shakapacker
 
         stdout.chomp
       end
+
+      private
+        def self.rails_root
+          if defined?(APP_ROOT)
+            Pathname.new(APP_ROOT)
+          elsif defined?(Rails)
+            Rails.root
+          else
+            raise "can only be called from a rails environment or with APP_ROOT defined"
+          end
+        end
     end
   end
 end

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.1.0".freeze
 end

data/lib/shakapacker/version_checker.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require "shakapacker/version"
+require_relative "version"
 
 module Shakapacker
   class VersionChecker

data/lib/shakapacker/webpack_runner.rb

@@ -1,5 +1,6 @@
 require "shellwords"
-require "shakapacker/runner"
+
+require_relative "runner"
 
 module Shakapacker
   class WebpackRunner < Shakapacker::Runner

data/lib/shakapacker.rb

@@ -37,13 +37,13 @@ module Shakapacker
   delegate :bootstrap, :clean, :clobber, :compile, to: :commands
 end
 
-require "shakapacker/instance"
-require "shakapacker/env"
-require "shakapacker/configuration"
-require "shakapacker/manifest"
-require "shakapacker/compiler"
-require "shakapacker/commands"
-require "shakapacker/dev_server"
-require "shakapacker/deprecation_helper"
-
-require "shakapacker/railtie" if defined?(Rails)
+require_relative "shakapacker/instance"
+require_relative "shakapacker/env"
+require_relative "shakapacker/configuration"
+require_relative "shakapacker/manifest"
+require_relative "shakapacker/compiler"
+require_relative "shakapacker/commands"
+require_relative "shakapacker/dev_server"
+require_relative "shakapacker/deprecation_helper"
+
+require_relative "shakapacker/railtie" if defined?(Rails)

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.1.0",
   "description": "Use webpack to manage app-like JavaScript modules in Rails",
   "homepage": "https://github.com/shakacode/shakapacker",
   "bugs": {
@@ -60,7 +60,7 @@
     "terser-webpack-plugin": "^5.3.1",
     "webpack": "^5.72.0",
     "webpack-assets-manifest": "^5.0.6",
-    "webpack-cli": "^4.9.2 || ^5.0.0",
+    "webpack-cli": "^4.9.2 || ^5.0.0 || ^6.0.0",
     "webpack-dev-server": "^4.9.0 || ^5.0.0",
     "webpack-merge": "^5.8.0 || ^6.0.0"
   },

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.1.0
 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: 2025-01-21 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
@@ -174,6 +176,8 @@ files:
 - gemfiles/Gemfile-rails.6.1.x
 - gemfiles/Gemfile-rails.7.0.x
 - gemfiles/Gemfile-rails.7.1.x
+- gemfiles/Gemfile-rails.7.2.x
+- gemfiles/Gemfile-rails.8.0.x
 - jest.config.js
 - lib/install/application.js
 - lib/install/bin/shakapacker
@@ -261,6 +265,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 +273,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.1.0
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -292,7 +300,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Use webpack to manage app-like JavaScript modules in Rails
@@ -305,6 +313,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 +321,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