shakapacker 7.2.3 → 8.0.0.pre.rc.1

data/Rakefile

@@ -14,12 +14,6 @@ namespace :run_spec do
     sh("bundle exec rspec spec/shakapacker/*_spec.rb")
   end
 
-  desc "Run backward compatibility specs"
-  task :gem_bc do
-    puts "Running Shakapacker gem specs for backward compatibility"
-    sh("bundle exec rspec spec/backward_compatibility_specs/*_spec.rb")
-  end
-
   desc "Run specs in the dummy app"
   task :dummy do
     puts "Running dummy app specs"
@@ -41,7 +35,7 @@ namespace :run_spec do
   end
 
   desc "Run all specs"
-  task all_specs: %i[gem gem_bc dummy generator] do
+  task all_specs: %i[gem dummy generator] do
     puts "Completed all RSpec tests"
   end
 end

data/docs/customizing_babel_config.md

@@ -20,8 +20,8 @@ This example shows how you can create an object and apply _additional_ presets a
 To use this example file,
 
 ```
-yarn add react react-dom @babel/preset-react
-yarn add --dev @pmmmwh/react-refresh-webpack-plugin react-refresh
+npm install react react-dom @babel/preset-react
+npm install --dev @pmmmwh/react-refresh-webpack-plugin react-refresh
 ```
 
 ```js

data/docs/deployment.md

@@ -24,7 +24,7 @@ We're essentially doing the following here:
 * Adding the Heroku NodeJS and Ruby buildpacks for your app. This allows the `npm` or `yarn` executables to properly function when compiling your app - as well as Ruby.
 * Pushing your code to Heroku and kicking off the deployment
 
-Your production build process is responsible for running `yarn install` before `rake assets:precompile`. For example, if you are on Heroku, the `heroku/nodejs` buildpack must run **prior** to the `heroku/ruby` buildpack for precompilation to run successfully.
+Your production build process is responsible for installing your JavaScript dependencies before `rake assets:precompile`. For example, if you are on Heroku, the `heroku/nodejs` buildpack must run **prior** to the `heroku/ruby` buildpack for precompilation to run successfully.
 
 ## Nginx
 
@@ -100,18 +100,25 @@ Make sure you have your public output path (default `public/packs`), the shakapa
 append :linked_dirs, "log", "tmp/pids", "tmp/cache", "tmp/sockets", "tmp/shakapacker", "public/packs", ".bundle", "node_modules"
 ```
 
-If you have `node_modules` added to `:linked_dirs` you'll need to run yarn install before `deploy:assets:precompile`, so you can add this code snippet at the bottom deploy.rb
+If you have `node_modules` added to `:linked_dirs` you'll need to install your JavaScript dependencies before `deploy:assets:precompile`; you can use `package_json` to do this generically:
 
 ```ruby
-before "deploy:assets:precompile", "deploy:yarn_install"
+before "deploy:assets:precompile", "deploy:js_install"
 namespace :deploy do
-  desc "Run rake yarn install"
-  task :yarn_install do
+  desc "Run rake js install"
+  task :js_install do
+    require "package_json"
+    
+    # this will use the package manager specified via `packageManager`, or otherwise fallback to `npm`
+    native_js_install_command = PackageJson.read.manager.native_install_command(frozen: true).join(" ")
+    
     on roles(:web) do
       within release_path do
-        execute("cd #{release_path} && yarn install --silent --no-progress --no-audit --no-optional")
+        execute("cd #{release_path} && #{native_js_install_command}")
       end
     end
   end
 end
 ```
+
+You can also replace the use of `package_json` with the underlying native install command for your preferred package manager.

data/docs/react.md

@@ -2,12 +2,6 @@
 
 These steps describe creating a Rails/React app, using Shakapacker as the bundler.
 
-Before starting, ensure that you have Yarn installed, for example:
-
-```shell
-npm i -g yarn
-```
-
 ## Easy Setup
 If you'd like easy integration of React with Ruby on Rails, see [React on Rails](https://github.com/shakacode/react_on_rails).
 
@@ -24,8 +18,8 @@ Create a new Rails app as per the [installation instructions in the README](http
 Add React, as well as the necessary libraries to enable CSS support in your application:
 
 ```shell
-yarn add react react-dom @babel/preset-react
-yarn add css-loader style-loader mini-css-extract-plugin css-minimizer-webpack-plugin
+npm install react react-dom @babel/preset-react
+npm install css-loader style-loader mini-css-extract-plugin css-minimizer-webpack-plugin
 ```
 
 Update the Babel configuration in the `package.json` file:
@@ -52,7 +46,7 @@ In `config/shakapacker.yml` set `hmr` is set to `true`.
 Install the [react-refresh](https://www.npmjs.com/package/react-refresh) package, as well as [@pmmmwh/react-refresh-webpack-plugin](https://www.npmjs.com/package/@pmmmwh/react-refresh-webpack-plugin):
 
 ```shell
-yarn add --dev react-refresh @pmmmwh/react-refresh-webpack-plugin
+npm install --dev react-refresh @pmmmwh/react-refresh-webpack-plugin
 ```
 
 Alter `config/webpack/webpack.config.js` like so:
@@ -142,8 +136,8 @@ cd myapp
 bundle add shakapacker --strict
 ./bin/bundle install
 ./bin/rails shakapacker:install
-yarn add react react-dom @babel/preset-react
-yarn add css-loader style-loader mini-css-extract-plugin css-minimizer-webpack-plugin
+npm install react react-dom @babel/preset-react
+npm install css-loader style-loader mini-css-extract-plugin css-minimizer-webpack-plugin
 ```
 
 2. Generate a controller
@@ -192,7 +186,7 @@ hmr: true
 8. Install the [react-refresh](https://www.npmjs.com/package/react-refresh) package, as well as [@pmmmwh/react-refresh-webpack-plugin](https://www.npmjs.com/package/@pmmmwh/react-refresh-webpack-plugin):
 
 ```shell
-yarn add --dev react-refresh @pmmmwh/react-refresh-webpack-plugin
+npm install --dev react-refresh @pmmmwh/react-refresh-webpack-plugin
 ```
 
 9. Alter `config/webpack/webpack.config.js` like so:

data/docs/troubleshooting.md

@@ -18,9 +18,9 @@
 4. You can also pass additional options to the command to run the webpack-dev-server and start the webpack-dev-server with the option `--debug-shakapacker`
 
 ## Incorrect peer dependencies
-The latest version of Shakapacker uses peer dependencies to make upgrading easier. However, there's a catch.
-
-If you fail to update peer dependencies, you'll see an easy-to-overlook warning from `yarn install`. 
+Shakapacker uses peer dependencies to make it easier to manage what versions are being used for your app, which is especially
+useful for patching security vulnerabilities. However, not all package managers will actually enforce these versions - notably,
+Yarn will omit a warning rather than erroring if you forget to update a peer dependency:
 
 ```
 warning " > shakapacker@6.1.1" has incorrect peer dependency "compression-webpack-plugin@^9.0.0".
@@ -31,7 +31,7 @@ This omission resulted in an error in the browser:
 Failed to load resource: net::ERR_CONTENT_DECODING_FAILED
 ```
 
-The error was caused by an old version of the peer dependency webpack-compression-plugin.
+The error was caused by an old version of the peer dependency `webpack-compression-plugin`.
 
 So, be sure to investigate warnings from `yarn install`!
 

data/docs/using_esbuild_loader.md

@@ -24,7 +24,7 @@ To use esbuild as your transpiler today. You need to do two things:
 1. Make sure you've installed `esbuild` and `esbuild-loader` packages.
 
 ```
-yarn add esbuild esbuild-loader
+npm install esbuild esbuild-loader
 ```
 
 2. Add or change `shakapacker_loader` value in your default `shakapacker.yml` config to `esbuild`

data/docs/using_swc_loader.md

@@ -19,7 +19,7 @@ In order to use SWC as your compiler today. You need to do two things:
 1. Make sure you've installed `@swc/core` and `swc-loader` packages.
 
 ```
-yarn add @swc/core swc-loader
+npm install @swc/core swc-loader
 ```
 
 2. Add or change `webpack_loader` value in your default `shakapacker.yml` config to `swc`

data/docs/v8_upgrade.md

@@ -0,0 +1,148 @@
+# Upgrading from Shakapacker v7 to v8
+
+The majority of the breaking changes in v8 were about dropping deprecated
+functions and features, along with switching to be agnostic about what package
+manager is used to manage JavaScript dependencies.
+
+Support for Ruby 2.6 and Node v12 has also been dropped since they're very old
+at this point.
+
+## The `packageManager` property in `package.json` is used to determine the package manager
+
+The biggest functional change in v8, `shakapacker` is now able to work with any
+of the major JavaScript package managers thanks to the
+[`package_json`](https://github.com/shakacode/package_json) gem which uses the
+[`packageManager`](https://nodejs.org/api/packages.html#packagemanager) property
+in the `package.json`.
+
+In alignment with the behaviour of Node and `corepack`, in the absence of the
+`packageManager` property `npm` will be used as the package manager so as part
+of upgrading you will want to ensure that is set to `yarn@<version>` if you want
+to continue using Yarn.
+
+An error will be raised in the presences of a lockfile other than
+`package-lock.json` if this property is not set with the recommended value to
+use, but it important the property is set to ensure all tooling uses the right
+package manager.
+
+The `check_yarn` rake task has also been renamed to `check_manager` to reflect
+this change.
+
+Check out the [installation section](../README.md#installation) of the readme
+for more details.
+
+## Usages of `webpacker` must now be `shakapacker`
+
+The `webpacker` spelling was deprecated in v7 and has now been completely
+removed in v8 - this includes constants, environment variables, and rake tasks.
+
+If you are still using references to `webpacker`, see the
+[v7 Upgrade Guide](../docs/v7_upgrade.md) for how to migrate.
+
+## JavaScript dependencies are no longer installed automatically as part of `assets:precompile`
+
+You will now need to ensure your dependencies are installed before compiling
+assets.
+
+Some platforms like Heroku will install dependencies automatically but if you're
+using a tool like `capistrano` to deploy to servers you can enhance the
+`assets:precompile` command like so:
+
+```ruby
+namespace :assets do
+  desc "Ensures that dependencies required to compile assets are installed"
+  task install_dependencies: :environment do
+    # npm v6+
+    raise if File.exist?("package.json") && !(system "npm ci")
+
+    # yarn v1.x (classic)
+    raise if File.exist?("package.json") && !(system "yarn install --immutable")
+
+    # yarn v2+ (berry)
+    raise if File.exist?("package.json") && !(system "yarn install --frozen-lockfile")
+
+    # bun v1+
+    raise if File.exist?("package.json") && !(system "bun install --frozen-lockfile")
+
+    # pnpm v6+
+    raise if File.exist?("package.json") && !(system "pnpm install --frozen-lockfile")
+  end
+end
+
+Rake::Task["assets:precompile"].enhance ["assets:install_dependencies"]
+```
+
+This allows more flexibility than what `shakapacker` could provide - for
+example, you might only want to do an immutable install if you're in CI.
+
+## `ensure_consistent_versioning` is now enabled by default
+
+This has `shakapacker` check that the versions of the installed Ruby gem and
+JavaScript package are compatible; this should only be impactful for codebases
+that are not using lockfiles.
+
+## Usages of `globalMutableWebpackConfig` must be replaced with `generateWebpackConfig()`
+
+The function will return the same object with less risk:
+
+```js
+// before
+const { globalMutableWebpackConfig, merge } = require('shakapacker');
+
+const customConfig = {
+  module: {
+    rules: [
+      {
+        test: require.resolve('jquery'),
+        loader: 'expose-loader',
+        options: { exposes: ['$', 'jQuery'] }
+      }
+    ]
+  }
+};
+
+module.exports = merge(globalMutableWebpackConfig, customConfig);
+```
+
+```js
+// after
+const { generateWebpackConfig } = require('shakapacker');
+
+const customConfig = {
+  module: {
+    rules: [
+      {
+        test: require.resolve('jquery'),
+        loader: 'expose-loader',
+        options: { exposes: ['$', 'jQuery'] }
+      }
+    ]
+  }
+};
+
+// you can also pass your config directly to the generator function to have it merged in!
+module.exports = merge(generateWebpackConfig(), customConfig);
+```
+
+## `additional_paths` are now stripped just like with `source_path`
+
+This means going forward asset paths should be same regardless of their source:
+
+```erb
+<%# before %>
+<%= image_pack_tag('marketing/images/people_looking_happy.png') %>
+
+<%# after %>
+<%= image_pack_tag('image/people_looking_happy.png') %>
+```
+
+## Misc. removals
+
+In addition to the above, v8 has also removed a number of miscellaneous
+functions that no one is probably using anyway but technically could have been
+including:
+
+- `isArray` js utility function (just use `Array.isArray` directly)
+- `relative_url_root` config getter (it was never used)
+- `verify_file_existance` method (use `verify_file_existence` instead)
+- `https` option for `webpack-dev-server` (use `server: 'https'` instead)

data/gemfiles/Gemfile-rails.7.1.x

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

data/jest.config.js

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

data/lib/install/config/shakapacker.yml

@@ -39,8 +39,8 @@ default: &default
   # Select loader to use, available options are 'babel' (default), 'swc' or 'esbuild'
   webpack_loader: 'babel'
 
-  # Set to true to enable check for matching versions of shakapacker gem and NPM package - will raise an error if there is a mismatch or wildcard versioning is used
-  ensure_consistent_versioning: false
+  # Raises an error if there is a mismatch in the shakapacker gem and npm package being used
+  ensure_consistent_versioning: true
 
   # Select whether the compiler will use SHA digest ('digest' option) or most most recent modified timestamp ('mtime') to determine freshness
   compiler_strategy: digest

data/lib/install/template.rb

@@ -1,12 +1,14 @@
 require "shakapacker/utils/misc"
+require "shakapacker/utils/manager"
 require "shakapacker/utils/version_syntax_converter"
+require "package_json"
 
 # Install Shakapacker
 
 force_option = ENV["FORCE"] ? { force: true } : {}
 
 copy_file "#{__dir__}/config/shakapacker.yml", "config/shakapacker.yml", force_option
-copy_file "#{__dir__}/package.json", "package.json", force_option
+remove_file "#{__dir__}/package.json" if force_option[:force]
 
 say "Copying webpack core config"
 directory "#{__dir__}/config/webpack", "config/webpack", force_option
@@ -43,22 +45,37 @@ else
 end
 
 def package_json
-  if @package_json.nil?
-    Shakapacker::Utils::Misc.require_package_json_gem
+  @package_json ||= PackageJson.new
+end
+
+# setup the package manager with default values
+package_json.merge! do |pj|
+  babel = pj.fetch("babel", {})
+
+  babel["presets"] ||= []
+  babel["presets"].push("./node_modules/shakapacker/package/babel/preset.js")
 
-    @package_json = PackageJson.read
+  package_manager = pj.fetch("packageManager") do
+    "#{Shakapacker::Utils::Manager.guess_binary}@#{Shakapacker::Utils::Manager.guess_version}"
   end
 
-  @package_json
+  {
+    "name" => "app",
+    "private" => true,
+    "version" => "0.1.0",
+    "babel" => babel,
+    "browserslist" => [
+      "defaults"
+    ],
+    "packageManager" => package_manager
+  }.merge(pj)
 end
 
+Shakapacker::Utils::Manager.error_unless_package_manager_is_obvious!
+
 # Ensure there is `system!("bin/yarn")` command in `./bin/setup` file
 if (setup_path = Rails.root.join("bin/setup")).exist?
-  def native_install_command
-    return "bin/yarn" unless Shakapacker::Utils::Misc.use_package_json_gem
-
-    package_json.manager.native_install_command.join(" ")
-  end
+  native_install_command = package_json.manager.native_install_command.join(" ")
 
   say "Run #{native_install_command} during bin/setup"
 
@@ -88,23 +105,14 @@ if (setup_path = Rails.root.join("bin/setup")).exist?
 end
 
 def add_dependencies(dependencies, type)
-  return package_json.manager.add!(dependencies, type: type) if Shakapacker::Utils::Misc.use_package_json_gem
-
-  # TODO: check that run actually errors
-  run("yarn add #{dependencies.join(" ")}") if type == :production
-  run("yarn add --dev #{dependencies.join(" ")}") if type == :dev
+  package_json.manager.add!(dependencies, type: type)
 rescue PackageJson::Error
   say "Shakapacker installation failed 😭 See above for details.", :red
   exit 1
 end
 
 def fetch_peer_dependencies
-  if Shakapacker::Utils::Misc.use_package_json_gem
-    return PackageJson.read("#{__dir__}/../../").fetch("peerDependencies")
-  end
-
-  package_json = File.read("#{__dir__}/../../package.json")
-  JSON.parse(package_json)["peerDependencies"]
+  PackageJson.read("#{__dir__}/../../").fetch("peerDependencies")
 end
 
 Dir.chdir(Rails.root) do
@@ -112,15 +120,13 @@ Dir.chdir(Rails.root) do
   say "Installing shakapacker@#{npm_version}"
   add_dependencies(["shakapacker@#{npm_version}"], :production)
 
-  if Shakapacker::Utils::Misc.use_package_json_gem
-    package_json.merge! do |pj|
-      {
-        "dependencies" => pj["dependencies"].merge({
-          # TODO: workaround for test suite - long-run need to actually account for diff pkg manager behaviour
-          "shakapacker" => pj["dependencies"]["shakapacker"].delete_prefix("^")
-        })
-      }
-    end
+  package_json.merge! do |pj|
+    {
+      "dependencies" => pj["dependencies"].merge({
+        # TODO: workaround for test suite - long-run need to actually account for diff pkg manager behaviour
+        "shakapacker" => pj["dependencies"]["shakapacker"].delete_prefix("^")
+      })
+    }
   end
 
   peers = fetch_peer_dependencies

data/lib/shakapacker/base_strategy.rb

@@ -16,7 +16,8 @@ module Shakapacker
         [
           *config.additional_paths.map { |path| "#{path}{,/**/*}" },
           "#{config.source_path}{,/**/*}",
-          "yarn.lock", "package.json",
+          "package.json", "package-lock.json", "yarn.lock",
+          "pnpm-lock.yaml", "bun.lockb",
           "config/webpack{,/**/*}"
         ].freeze
       end

data/lib/shakapacker/compiler.rb

@@ -72,7 +72,7 @@ class Shakapacker::Compiler
       config.root_path.join("tmp/shakapacker.lock")
     end
 
-    def optionalRubyRunner
+    def optional_ruby_runner
       first_line = File.readlines(bin_shakapacker_path).first.chomp
       /ruby/.match?(first_line) ? RbConfig.ruby : ""
     end
@@ -82,7 +82,7 @@ class Shakapacker::Compiler
 
       stdout, stderr, status = Open3.capture3(
         webpack_env,
-        "#{optionalRubyRunner} '#{bin_shakapacker_path}'",
+        "#{optional_ruby_runner} '#{bin_shakapacker_path}'",
         chdir: File.expand_path(config.root_path)
       )
 
@@ -104,28 +104,13 @@ class Shakapacker::Compiler
     def webpack_env
       return env unless defined?(ActionController::Base)
 
-      Shakapacker.set_shakapacker_env_variables_for_backward_compatibility
-
       env.merge(
-        "SHAKAPACKER_ASSET_HOST"        => instance.config.asset_host,
-        "SHAKAPACKER_RELATIVE_URL_ROOT" => instance.config.relative_url_root,
-        "SHAKAPACKER_CONFIG"            => instance.config_path.to_s
+        "SHAKAPACKER_ASSET_HOST" => instance.config.asset_host,
+        "SHAKAPACKER_CONFIG"     => instance.config.config_path.to_s
       )
     end
 
     def bin_shakapacker_path
-      if File.exist?(config.root_path.join("bin/shakapacker"))
-        config.root_path.join("bin/shakapacker")
-      elsif File.exist?(config.root_path.join("bin/webpacker"))
-        Shakapacker.puts_deprecation_message(
-          Shakapacker.short_deprecation_message(
-            "bin/webpacker",
-            "bin/shakapacker"
-          )
-        )
-        config.root_path.join("bin/webpacker")
-      else
-        config.root_path.join("bin/shakapacker")
-      end
+      config.root_path.join("bin/shakapacker")
     end
 end

data/lib/shakapacker/configuration.rb

@@ -12,10 +12,7 @@ class Shakapacker::Configuration
   def initialize(root_path:, config_path:, env:)
     @root_path = root_path
     @env = env
-
-    # For backward compatibility
-    Shakapacker.set_shakapacker_env_variables_for_backward_compatibility
-    @config_path = Pathname.new(ENV["SHAKAPACKER_CONFIG"] || config_path)
+    @config_path = config_path
   end
 
   def dev_server
@@ -43,17 +40,6 @@ class Shakapacker::Configuration
     fetch(:shakapacker_precompile)
   end
 
-  def webpacker_precompile?
-    Shakapacker.puts_deprecation_message(
-      Shakapacker.short_deprecation_message(
-        "webpacker_precompile?",
-        "shakapacker_precompile?"
-      )
-    )
-
-    shakapacker_precompile?
-  end
-
   def source_path
     root_path.join(fetch(:source_path))
   end
@@ -103,17 +89,7 @@ class Shakapacker::Configuration
   end
 
   def fetch(key)
-    return data.fetch(key, defaults[key]) unless key == :webpacker_precompile
-
-    # for backward compatibility
-    Shakapacker.puts_deprecation_message(
-      Shakapacker.short_deprecation_message(
-        "webpacker_precompile",
-        "shakapacker_precompile"
-      )
-    )
-
-    data.fetch(key, defaults[:shakapacker_precompile])
+    data.fetch(key, defaults[key])
   end
 
   def asset_host
@@ -123,19 +99,6 @@ class Shakapacker::Configuration
     )
   end
 
-  def relative_url_root
-    result = ENV.fetch(
-      "SHAKAPACKER_RELATIVE_URL_ROOT",
-      fetch(:relative_url_root) || ActionController::Base.relative_url_root
-    )
-
-    if result
-      Shakapacker.puts_deprecation_message("The usage of relative_url_root is deprecated in Shakapacker and will be removed in v8.")
-    end
-
-    result
-  end
-
   private
     def data
       @data ||= load
@@ -149,13 +112,6 @@ class Shakapacker::Configuration
       end
       symbolized_config = config[env].deep_symbolize_keys
 
-      # For backward compatibility
-      if symbolized_config.key?(:shakapacker_precompile) && !symbolized_config.key?(:webpacker_precompile)
-        symbolized_config[:webpacker_precompile] = symbolized_config[:shakapacker_precompile]
-      elsif !symbolized_config.key?(:shakapacker_precompile) && symbolized_config.key?(:webpacker_precompile)
-        symbolized_config[:shakapacker_precompile] = symbolized_config[:webpacker_precompile]
-      end
-
       return symbolized_config
     rescue Errno::ENOENT => e
       if self.class.installing