shakapacker 7.1.0 → 7.2.0.rc.0

data/spec/shakapacker/configuration_spec.rb

@@ -330,4 +330,52 @@ describe "Shakapacker::Configuration" do
       expect(actual).to eq(expected)
     end
   end
+
+  describe "#asset_host" do
+    let(:config) do
+      Shakapacker::Configuration.new(
+        root_path: ROOT_PATH,
+        config_path: Pathname.new(File.expand_path("./test_app/config/shakapacker.yml", __dir__)),
+        env: "production"
+      )
+    end
+
+    it "returns the value of SHAKAPACKER_ASSET_HOST if set" do
+      with_env_variable("SHAKAPACKER_ASSET_HOST" => "custom_host.abc") do
+        expect(config.asset_host).to eq "custom_host.abc"
+      end
+    end
+
+    it "returns ActionController::Base.helpers.compute_asset_host if SHAKAPACKER_ASSET_HOST is not set" do
+      allow(ActionController::Base.helpers).to receive(:compute_asset_host).and_return("domain.abc")
+
+      with_env_variable("SHAKAPACKER_ASSET_HOST" => nil) do
+        expect(config.asset_host).to eq "domain.abc"
+      end
+    end
+  end
+
+  describe "#relative_url_root" do
+    let(:config) do
+      Shakapacker::Configuration.new(
+        root_path: ROOT_PATH,
+        config_path: Pathname.new(File.expand_path("./test_app/config/shakapacker.yml", __dir__)),
+        env: "production"
+      )
+    end
+
+    it "returns the value of SHAKAPACKER_RELATIVE_URL_ROOT if set" do
+      with_env_variable("SHAKAPACKER_RELATIVE_URL_ROOT" => "custom_value") do
+        expect(config.relative_url_root).to eq "custom_value"
+      end
+    end
+
+    it "returns ActionController::Base.helpers.compute_asset_host if SHAKAPACKER_RELATIVE_URL_ROOT is not set" do
+      allow(ActionController::Base).to receive(:relative_url_root).and_return("abcd")
+
+      with_env_variable("SHAKAPACKER_RELATIVE_URL_ROOT" => nil) do
+        expect(config.relative_url_root).to eq "abcd"
+      end
+    end
+  end
 end

data/spec/shakapacker/dev_server_runner_spec.rb

@@ -16,47 +16,106 @@ describe "DevServerRunner" do
 
   let(:test_app_path) { File.expand_path("./test_app", __dir__) }
 
-  it "supports running via node modules" do
-    cmd = ["#{test_app_path}/node_modules/.bin/webpack", "serve", "--config", "#{test_app_path}/config/webpack/webpack.config.js"]
+  NODE_PACKAGE_MANAGERS.each do |fallback_manager|
+    context "when using package_json with #{fallback_manager} as the manager" do
+      with_use_package_json_gem(enabled: true, fallback_manager: fallback_manager)
 
-    verify_command(cmd, use_node_modules: true)
-  end
+      let(:package_json) { PackageJson.read(test_app_path) }
 
-  it "supports running via yarn" do
-    cmd = ["yarn", "webpack", "serve", "--config", "#{test_app_path}/config/webpack/webpack.config.js"]
+      require "package_json"
 
-    verify_command(cmd, use_node_modules: false)
-  end
+      it "uses the expected package manager", unless: fallback_manager == "yarn_classic" do
+        cmd = package_json.manager.native_exec_command("webpack", ["serve", "--config", "#{test_app_path}/config/webpack/webpack.config.js"])
 
-  it "passes on arguments" do
-    cmd = ["#{test_app_path}/node_modules/.bin/webpack", "serve", "--config", "#{test_app_path}/config/webpack/webpack.config.js", "--quiet"]
+        manager_name = fallback_manager.split("_")[0]
 
-    verify_command(cmd, argv: (["--quiet"]))
-  end
+        expect(cmd).to start_with(manager_name)
+      end
+
+      it "runs the command using the manager" do
+        cmd = package_json.manager.native_exec_command("webpack", ["serve", "--config", "#{test_app_path}/config/webpack/webpack.config.js"])
+
+        verify_command(cmd)
+      end
+
+      it "passes on arguments" do
+        cmd = package_json.manager.native_exec_command("webpack", ["serve", "--config", "#{test_app_path}/config/webpack/webpack.config.js", "--quiet"])
 
-  it "supports the https flag" do
-    cmd = ["#{test_app_path}/node_modules/.bin/webpack", "serve", "--config", "#{test_app_path}/config/webpack/webpack.config.js", "--https"]
+        verify_command(cmd, argv: (["--quiet"]))
+      end
+
+      it "supports the https flag" do
+        cmd = package_json.manager.native_exec_command("webpack", ["serve", "--config", "#{test_app_path}/config/webpack/webpack.config.js", "--https"])
+
+        dev_server = double()
+        allow(dev_server).to receive(:host).and_return("localhost")
+        allow(dev_server).to receive(:port).and_return("3035")
+        allow(dev_server).to receive(:pretty?).and_return(false)
+        allow(dev_server).to receive(:https?).and_return(true)
+        allow(dev_server).to receive(:hmr?).and_return(false)
+
+        allow(Shakapacker::DevServer).to receive(:new) do
+          verify_command(cmd, argv: (["--https"]))
+        end.and_return(dev_server)
+      end
+
+      it "accepts environment variables" do
+        cmd = package_json.manager.native_exec_command("webpack", ["serve", "--config", "#{test_app_path}/config/webpack/webpack.config.js"])
 
-    dev_server = double()
-    allow(dev_server).to receive(:host).and_return("localhost")
-    allow(dev_server).to receive(:port).and_return("3035")
-    allow(dev_server).to receive(:pretty?).and_return(false)
-    allow(dev_server).to receive(:https?).and_return(true)
-    allow(dev_server).to receive(:hmr?).and_return(false)
+        env = Shakapacker::Compiler.env.dup
+        ENV["SHAKAPACKER_CONFIG"] = env["SHAKAPACKER_CONFIG"] = "#{test_app_path}/config/shakapacker_other_location.yml"
+        env["WEBPACK_SERVE"] = "true"
 
-    allow(Shakapacker::DevServer).to receive(:new) do
-      verify_command(cmd, argv: (["--https"]))
-    end.and_return(dev_server)
+        verify_command(cmd, env: env)
+      end
+    end
   end
 
-  it "accepts environment variables" do
-    cmd = ["#{test_app_path}/node_modules/.bin/webpack", "serve", "--config", "#{test_app_path}/config/webpack/webpack.config.js"]
-    env = Shakapacker::Compiler.env.dup
+  context "when not using package_json" do
+    with_use_package_json_gem(enabled: false)
 
-    ENV["SHAKAPACKER_CONFIG"] = env["SHAKAPACKER_CONFIG"] = "#{test_app_path}/config/shakapacker_other_location.yml"
-    env["WEBPACK_SERVE"] = "true"
+    it "supports running via node modules" do
+      cmd = ["#{test_app_path}/node_modules/.bin/webpack", "serve", "--config", "#{test_app_path}/config/webpack/webpack.config.js"]
 
-    verify_command(cmd, env: env)
+      verify_command(cmd, use_node_modules: true)
+    end
+
+    it "supports running via yarn" do
+      cmd = ["yarn", "webpack", "serve", "--config", "#{test_app_path}/config/webpack/webpack.config.js"]
+
+      verify_command(cmd, use_node_modules: false)
+    end
+
+    it "passes on arguments" do
+      cmd = ["#{test_app_path}/node_modules/.bin/webpack", "serve", "--config", "#{test_app_path}/config/webpack/webpack.config.js", "--quiet"]
+
+      verify_command(cmd, argv: (["--quiet"]))
+    end
+
+    it "supports the https flag" do
+      cmd = ["#{test_app_path}/node_modules/.bin/webpack", "serve", "--config", "#{test_app_path}/config/webpack/webpack.config.js", "--https"]
+
+      dev_server = double()
+      allow(dev_server).to receive(:host).and_return("localhost")
+      allow(dev_server).to receive(:port).and_return("3035")
+      allow(dev_server).to receive(:pretty?).and_return(false)
+      allow(dev_server).to receive(:https?).and_return(true)
+      allow(dev_server).to receive(:hmr?).and_return(false)
+
+      allow(Shakapacker::DevServer).to receive(:new) do
+        verify_command(cmd, argv: (["--https"]))
+      end.and_return(dev_server)
+    end
+
+    it "accepts environment variables" do
+      cmd = ["#{test_app_path}/node_modules/.bin/webpack", "serve", "--config", "#{test_app_path}/config/webpack/webpack.config.js"]
+      env = Shakapacker::Compiler.env.dup
+
+      ENV["SHAKAPACKER_CONFIG"] = env["SHAKAPACKER_CONFIG"] = "#{test_app_path}/config/shakapacker_other_location.yml"
+      env["WEBPACK_SERVE"] = "true"
+
+      verify_command(cmd, env: env)
+    end
   end
 
   private

data/spec/shakapacker/engine_rake_tasks_spec.rb

@@ -9,15 +9,36 @@ describe "EngineRakeTasks" do
     remove_webpack_binstubs
   end
 
-  it "mounts app:shakapacker task successfully" do
-    output = Dir.chdir(mounted_app_path) { `rake -T` }
+  NODE_PACKAGE_MANAGERS.each do |fallback_manager|
+    context "when using package_json with #{fallback_manager} as the manager" do
+      with_use_package_json_gem(enabled: true, fallback_manager: fallback_manager)
 
-    expect(output).to include "app:shakapacker"
+      it "mounts app:shakapacker task successfully" do
+        output = Dir.chdir(mounted_app_path) { `rake -T` }
+
+        expect(output).to include "app:shakapacker"
+      end
+
+      it "only adds expected files to bin directory when binstubs is run" do
+        Dir.chdir(mounted_app_path) { `bundle exec rake app:shakapacker:binstubs` }
+        expected_binstub_paths.each { |path| expect(File.exist?(path)).to be true }
+      end
+    end
   end
 
-  it "only adds expected files to bin directory when binstubs is run" do
-    Dir.chdir(mounted_app_path) { `bundle exec rake app:shakapacker:binstubs` }
-    expected_binstub_paths.each { |path| expect(File.exist?(path)).to be true }
+  context "when not using package_json" do
+    with_use_package_json_gem(enabled: false)
+
+    it "mounts app:shakapacker task successfully" do
+      output = Dir.chdir(mounted_app_path) { `rake -T` }
+
+      expect(output).to include "app:shakapacker"
+    end
+
+    it "only adds expected files to bin directory when binstubs is run" do
+      Dir.chdir(mounted_app_path) { `bundle exec rake app:shakapacker:binstubs` }
+      expected_binstub_paths.each { |path| expect(File.exist?(path)).to be true }
+    end
   end
 
   private

data/spec/shakapacker/rake_tasks_spec.rb

@@ -8,7 +8,7 @@ describe "RakeTasks" do
     expect(output).to include "shakapacker"
     expect(output).to include "shakapacker:check_binstubs"
     expect(output).to include "shakapacker:check_node"
-    expect(output).to include "shakapacker:check_yarn"
+    expect(output).to include "shakapacker:check_manager"
     expect(output).to include "shakapacker:clean"
     expect(output).to include "shakapacker:clobber"
     expect(output).to include "shakapacker:compile"
@@ -28,11 +28,12 @@ describe "RakeTasks" do
     expect(output).to_not include "Shakapacker requires Node.js"
   end
 
-  it "`shakapacker:check_yarn` doesn't get errors related to yarn" do
-    output = Dir.chdir(TEST_APP_PATH) { `rake shakapacker:check_yarn 2>&1` }
+  # TODO: currently this test depends on external conditions & PACKAGE_JSON_FALLBACK_MANAGER
+  it "`shakapacker:check_manager` doesn't get errors related to the package manager" do
+    output = Dir.chdir(TEST_APP_PATH) { `rake shakapacker:check_manager 2>&1` }
 
-    expect(output).to_not include "Yarn not installed"
-    expect(output).to_not include "Shakapacker requires Yarn"
+    expect(output).to_not include "not installed"
+    expect(output).to_not include "Shakapacker requires"
   end
 
   describe "`shakapacker:check_binstubs`" do

data/spec/shakapacker/spec_helper_initializer.rb

@@ -22,3 +22,21 @@ ensure
   Rails.env = ActiveSupport::StringInquirer.new(original)
   reloaded_config
 end
+
+# Temportarily set env variables to a custom value
+# arg: a hash with key:value for each custom env
+#      Keys could be string or symbol
+def with_env_variable(custom_env_hash)
+  original_env = {}
+  custom_env_hash.each do |key, new_value|
+    upcased_key = key.to_s.upcase
+    original_env[upcased_key] = new_value
+    ENV[upcased_key] = new_value
+  end
+
+  yield
+ensure
+  original_env.each do |key, original_value|
+    ENV[key] = original_value
+  end
+end

data/spec/shakapacker/webpack_runner_spec.rb

@@ -14,22 +14,56 @@ describe "WebpackRunner" do
 
   let(:test_app_path) { File.expand_path("./test_app", __dir__) }
 
-  it "supports running via node_modules" do
-    cmd = ["#{test_app_path}/node_modules/.bin/webpack", "--config", "#{test_app_path}/config/webpack/webpack.config.js"]
+  NODE_PACKAGE_MANAGERS.each do |fallback_manager|
+    context "when using package_json with #{fallback_manager} as the manager" do
+      with_use_package_json_gem(enabled: true, fallback_manager: fallback_manager)
 
-    verify_command(cmd, use_node_modules: true)
-  end
+      let(:package_json) { PackageJson.read(test_app_path) }
+
+      require "package_json"
+
+      it "uses the expected package manager", unless: fallback_manager == "yarn_classic" do
+        cmd = package_json.manager.native_exec_command("webpack", ["--config", "#{test_app_path}/config/webpack/webpack.config.js"])
+
+        manager_name = fallback_manager.split("_")[0]
+
+        expect(cmd).to start_with(manager_name)
+      end
+
+      it "runs the command using the manager" do
+        cmd = package_json.manager.native_exec_command("webpack", ["--config", "#{test_app_path}/config/webpack/webpack.config.js"])
 
-  it "supports running via yarn" do
-    cmd = ["yarn", "webpack", "--config", "#{test_app_path}/config/webpack/webpack.config.js"]
+        verify_command(cmd)
+      end
 
-    verify_command(cmd, use_node_modules: false)
+      it "passes on arguments" do
+        cmd = package_json.manager.native_exec_command("webpack", ["--config", "#{test_app_path}/config/webpack/webpack.config.js", "--watch"])
+
+        verify_command(cmd, argv: (["--watch"]))
+      end
+    end
   end
 
-  it "passes on arguments" do
-    cmd = ["#{test_app_path}/node_modules/.bin/webpack", "--config", "#{test_app_path}/config/webpack/webpack.config.js", "--watch"]
+  context "when not using package_json" do
+    with_use_package_json_gem(enabled: false)
+
+    it "supports running via node_modules" do
+      cmd = ["#{test_app_path}/node_modules/.bin/webpack", "--config", "#{test_app_path}/config/webpack/webpack.config.js"]
+
+      verify_command(cmd, use_node_modules: true)
+    end
+
+    it "supports running via yarn" do
+      cmd = ["yarn", "webpack", "--config", "#{test_app_path}/config/webpack/webpack.config.js"]
 
-    verify_command(cmd, argv: ["--watch"])
+      verify_command(cmd, use_node_modules: false)
+    end
+
+    it "passes on arguments" do
+      cmd = ["#{test_app_path}/node_modules/.bin/webpack", "--config", "#{test_app_path}/config/webpack/webpack.config.js", "--watch"]
+
+      verify_command(cmd, argv: ["--watch"])
+    end
   end
 
   private

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+require_relative "./support/package_json_helpers"
+
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
 # The generated `.rspec` file contains `--require spec_helper` which will cause

data/spec/support/package_json_helpers.rb

@@ -0,0 +1,16 @@
+NODE_PACKAGE_MANAGERS = ["npm", "yarn_classic", "yarn_berry", "pnpm", "bun"]
+
+def with_use_package_json_gem(enabled:, fallback_manager: nil)
+  around do |example|
+    old_use_package_json_gem_value = ENV["SHAKAPACKER_USE_PACKAGE_JSON_GEM"]
+    old_package_json_fallback_manager_value = ENV["PACKAGE_JSON_FALLBACK_MANAGER"]
+
+    ENV["SHAKAPACKER_USE_PACKAGE_JSON_GEM"] = enabled.to_s
+    ENV["PACKAGE_JSON_FALLBACK_MANAGER"] = fallback_manager.to_s
+
+    example.run
+
+    ENV["SHAKAPACKER_USE_PACKAGE_JSON_GEM"] = old_use_package_json_gem_value
+    ENV["PACKAGE_JSON_FALLBACK_MANAGER"] = old_package_json_fallback_manager_value
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shakapacker
 version: !ruby/object:Gem::Version
-  version: 7.1.0
+  version: 7.2.0.rc.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-01 00:00:00.000000000 Z
+date: 2023-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -26,6 +26,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: package_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -195,6 +209,7 @@ files:
 - lib/tasks/shakapacker.rake
 - lib/tasks/shakapacker/binstubs.rake
 - lib/tasks/shakapacker/check_binstubs.rake
+- lib/tasks/shakapacker/check_manager.rake
 - lib/tasks/shakapacker/check_node.rake
 - lib/tasks/shakapacker/check_yarn.rake
 - lib/tasks/shakapacker/clean.rake
@@ -486,8 +501,13 @@ files:
 - spec/generator_specs/e2e_template/files/config/routes.rb
 - spec/generator_specs/e2e_template/files/spec/system/test_react_component_renders_spec.rb
 - spec/generator_specs/e2e_template/template.rb
+- spec/generator_specs/fake-bin/bun
+- spec/generator_specs/fake-bin/npm
+- spec/generator_specs/fake-bin/pnpm
+- spec/generator_specs/fake-bin/yarn
 - spec/generator_specs/generator_spec.rb
 - spec/mounted_app/Rakefile
+- spec/mounted_app/package.json
 - spec/mounted_app/test/dummy/Rakefile
 - spec/mounted_app/test/dummy/bin/rails
 - spec/mounted_app/test/dummy/bin/rake
@@ -540,12 +560,13 @@ files:
 - spec/shakapacker/version_checker_spec.rb
 - spec/shakapacker/webpack_runner_spec.rb
 - spec/spec_helper.rb
+- spec/support/package_json_helpers.rb
 - yarn.lock
 homepage: https://github.com/shakacode/shakapacker
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/shakacode/shakapacker/tree/v7.1.0
+  source_code_uri: https://github.com/shakacode/shakapacker/tree/v7.2.0-rc.0
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -557,9 +578,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.4.12
 signing_key: