shakapacker 7.3.0.beta.1 → 8.0.0.rc.2

data/spec/shakapacker/configuration_spec.rb

@@ -113,8 +113,8 @@ describe "Shakapacker::Configuration" do
     end
 
     describe "#ensure_consistent_versioning?" do
-      it "returns false in production environment" do
-        expect(config.ensure_consistent_versioning?).to be false
+      it "returns true in production environment" do
+        expect(config.ensure_consistent_versioning?).to be true
       end
 
       it "returns true in development environment" do
@@ -123,9 +123,9 @@ describe "Shakapacker::Configuration" do
         end
       end
 
-      it "returns false in test environment" do
+      it "returns true in test environment" do
         with_rails_env("test") do
-          expect(Shakapacker.config.ensure_consistent_versioning?).to be false
+          expect(Shakapacker.config.ensure_consistent_versioning?).to be true
         end
       end
     end
@@ -374,56 +374,4 @@ describe "Shakapacker::Configuration" do
     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
-
-    context "with SHAKAPACKER_RELATIVE_URL_ROOT set" do
-      before do
-        expect(ENV).to receive(:fetch).with("SHAKAPACKER_RELATIVE_URL_ROOT", nil).and_return("custom_value")
-      end
-      it "shows deprecation message" do
-        expect { config.relative_url_root }.to output(/deprecated/).to_stdout
-      end
-
-      it "returns the value of SHAKAPACKER_RELATIVE_URL_ROOT" do
-        expect(config.relative_url_root).to eq "custom_value"
-      end
-    end
-
-    context "without SHAKAPACKER_RELATIVE_URL_ROOT set" do
-      it "returns relative_url_root in shakapacker.yml if set" do
-        expect(config).to receive(:fetch).with(:relative_url_root).and_return("value-in-config-file")
-        expect(ENV).to receive(:fetch).with("SHAKAPACKER_RELATIVE_URL_ROOT", "value-in-config-file").and_return("value-in-config-file")
-
-        expect(config.relative_url_root).to eq "value-in-config-file"
-      end
-
-      context "without relative_url_root set in the shakapacker.yml" do
-        it "returns ActionController::Base.relative_url_root if SHAKAPACKER_RELATIVE_URL_ROOT is not set" do
-          expect(ActionController::Base).to receive(:relative_url_root).and_return("abcd")
-          expect(ENV).to receive(:fetch).with("SHAKAPACKER_RELATIVE_URL_ROOT", "abcd").and_return("abcd")
-
-          expect(config.relative_url_root).to eq "abcd"
-        end
-
-        context "without ActionController::Base.relative_url_root returing any value" do
-          it "returns an empty string" do
-            expect(ENV).to receive(:fetch).with("SHAKAPACKER_RELATIVE_URL_ROOT", nil).and_return(nil)
-
-            expect(config.relative_url_root).to be nil
-          end
-
-          it "doesn't shows deprecation message" do
-            expect { config.relative_url_root }.to_not output(/deprecated/).to_stdout
-          end
-        end
-      end
-    end
-  end
 end

data/spec/shakapacker/dev_server_runner_spec.rb

@@ -2,6 +2,13 @@ require_relative "spec_helper_initializer"
 require "shakapacker/dev_server_runner"
 
 describe "DevServerRunner" do
+  around do |example|
+    within_temp_directory do
+      FileUtils.cp_r(File.expand_path("./test_app", __dir__), Dir.pwd)
+      Dir.chdir("test_app") { example.run }
+    end
+  end
+
   before do
     @original_node_env, ENV["NODE_ENV"] = ENV["NODE_ENV"], "development"
     @original_rails_env, ENV["RAILS_ENV"] = ENV["RAILS_ENV"], "development"
@@ -14,15 +21,21 @@ describe "DevServerRunner" do
     ENV["SHAKAPACKER_CONFIG"] = @original_shakapacker_config
   end
 
-  let(:test_app_path) { File.expand_path("./test_app", __dir__) }
+  let(:test_app_path) { Dir.pwd }
 
   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)
+      before do
+        manager_name = fallback_manager.split("_")[0]
+        manager_version = "1.2.3"
+        manager_version = "4.5.6" if fallback_manager == "yarn_berry"
 
-      let(:package_json) { PackageJson.read(test_app_path) }
+        PackageJson.read.merge! { { "packageManager" => "#{manager_name}@#{manager_version}" } }
 
-      require "package_json"
+        allow(Shakapacker::Utils::Manager).to receive(:error_unless_package_manager_is_obvious!)
+      end
+
+      let(:package_json) { PackageJson.read(test_app_path) }
 
       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"])
@@ -104,116 +117,20 @@ describe "DevServerRunner" do
     end
   end
 
-  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", "serve", "--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", "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 "does not automatically pass the --https flag" do
-      cmd = ["#{test_app_path}/node_modules/.bin/webpack", "serve", "--config", "#{test_app_path}/config/webpack/webpack.config.js"]
-
-      allow(Shakapacker::DevServer).to receive(:new).and_return(
-        double(
-          host: "localhost",
-          port: "3035",
-          pretty?: false,
-          protocol: "https",
-          hmr?: true
-        )
-      )
-
-      verify_command(cmd)
-    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"]
-
-      allow(Shakapacker::DevServer).to receive(:new).and_return(
-        double(
-          host: "localhost",
-          port: "3035",
-          pretty?: false,
-          protocol: "https",
-          hmr?: true
-        )
-      )
-
-      verify_command(cmd, argv: ["--https"])
-    end
-
-    it "supports disabling hot module reloading" do
-      cmd = ["#{test_app_path}/node_modules/.bin/webpack", "serve", "--config", "#{test_app_path}/config/webpack/webpack.config.js", "--no-hot"]
-
-      allow(Shakapacker::DevServer).to receive(:new).and_return(
-        double(
-          host: "localhost",
-          port: "3035",
-          pretty?: false,
-          protocol: "http",
-          hmr?: false
-        )
-      )
-
-      verify_command(cmd)
-    end
-
-    it "supports --hot being 'only'" do
-      cmd = ["#{test_app_path}/node_modules/.bin/webpack", "serve", "--config", "#{test_app_path}/config/webpack/webpack.config.js", "--hot", "only"]
-
-      allow(Shakapacker::DevServer).to receive(:new).and_return(
-        double(
-          host: "localhost",
-          port: "3035",
-          pretty?: false,
-          protocol: "http",
-          hmr?: "only"
-        )
-      )
-
-      verify_command(cmd)
-    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
 
-    def verify_command(cmd, use_node_modules: true, argv: [], env: Shakapacker::Compiler.env)
+    def verify_command(cmd, argv: [], env: Shakapacker::Compiler.env)
       Dir.chdir(test_app_path) do
         klass = Shakapacker::DevServerRunner
         instance = klass.new(argv)
 
         allow(klass).to receive(:new).and_return(instance)
-        allow(instance).to receive(:node_modules_bin_exist?).and_return(use_node_modules)
         allow(Kernel).to receive(:exec).with(env, *cmd)
 
         klass.run(argv)
 
         expect(Kernel).to have_received(:exec).with(env, *cmd)
+        expect(Shakapacker::Utils::Manager).to have_received(:error_unless_package_manager_is_obvious!)
       end
     end
 end

data/spec/shakapacker/dev_server_spec.rb

@@ -17,12 +17,6 @@ describe "DevServer" do
     end
   end
 
-  it "doesn't use https in development environment" do
-    with_rails_env("development") do
-      expect(Shakapacker.dev_server.https?).to be false
-    end
-  end
-
   it "uses http protocol in development environment" do
     with_rails_env("development") do
       expect(Shakapacker.dev_server.protocol).to eq "http"
@@ -48,7 +42,7 @@ describe "DevServer" do
   context "#protocol in development environment" do
     let(:dev_server) { Shakapacker.dev_server }
 
-    it "returns `http` by default (with unset `server` and `https`)" do
+    it "returns `http` by default (with unset `server`)" do
       with_rails_env("development") do
         expect(dev_server.protocol).to eq "http"
       end
@@ -61,15 +55,6 @@ describe "DevServer" do
         expect(dev_server.protocol).to eq "https"
       end
     end
-
-    it "returns `https` with unset `server` and `https` set to `true`" do
-      expect(dev_server).to receive(:server).and_return("http")
-      expect(dev_server).to receive(:https?).and_return(true)
-
-      with_rails_env("development") do
-        expect(dev_server.protocol).to eq "https"
-      end
-    end
   end
 
   context "#server in development environment" do

data/spec/shakapacker/engine_rake_tasks_spec.rb

@@ -11,7 +11,7 @@ describe "EngineRakeTasks" do
 
   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)
+      with_package_json_fallback_manager(fallback_manager)
 
       it "mounts app:shakapacker task successfully" do
         output = Dir.chdir(mounted_app_path) { `rake -T` }
@@ -26,21 +26,6 @@ describe "EngineRakeTasks" do
     end
   end
 
-  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
     def mounted_app_path
       File.expand_path("../mounted_app", __dir__)

data/spec/shakapacker/helper_spec.rb

@@ -126,7 +126,7 @@ module ActionView::TestCase::Behavior
     it "#append_javascript_pack_tag raises an error if called after calling #javascript_pack_tag" do
       expected_error_message = \
         "You can only call append_javascript_pack_tag before javascript_pack_tag helper. " +
-        "Please refer to https://github.com/shakacode/shakapacker/blob/master/README.md#view-helper-append_javascript_pack_tag-prepend_javascript_pack_tag-and-append_stylesheet_pack_tag for the usage guide"
+        "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"
 
       expect {
         javascript_pack_tag("application")
@@ -137,7 +137,7 @@ module ActionView::TestCase::Behavior
     it "#prepend_javascript_pack_tag raises an error if called after calling #javascript_pack_tag" do
       expected_error_message = \
         "You can only call prepend_javascript_pack_tag before javascript_pack_tag helper. " +
-        "Please refer to https://github.com/shakacode/shakapacker/blob/master/README.md#view-helper-append_javascript_pack_tag-prepend_javascript_pack_tag-and-append_stylesheet_pack_tag for the usage guide"
+        "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"
 
       expect {
         javascript_pack_tag("application")
@@ -167,7 +167,7 @@ module ActionView::TestCase::Behavior
 
     it "#javascript_pack_tag rases error on multiple invocations" do
       expected_error_message = "To prevent duplicated chunks on the page, you should call javascript_pack_tag only once on the page. " +
-      "Please refer to https://github.com/shakacode/shakapacker/blob/master/README.md#view-helpers-javascript_pack_tag-and-stylesheet_pack_tag for the usage guide"
+      "Please refer to https://github.com/shakacode/shakapacker/blob/main/README.md#view-helpers-javascript_pack_tag-and-stylesheet_pack_tag for the usage guide"
 
       expect {
         javascript_pack_tag(:application)

data/spec/shakapacker/instance_spec.rb

@@ -2,13 +2,10 @@ require_relative "spec_helper_initializer"
 
 describe "Shakapacker::Instance" do
   before :each do
-    ENV.delete("WEBPACKER_CONFIG")
     ENV.delete("SHAKAPACKER_CONFIG")
-    Shakapacker.instance = Shakapacker::Instance.new
   end
 
   after :each do
-    ENV.delete("WEBPACKER_CONFIG")
     ENV.delete("SHAKAPACKER_CONFIG")
     Shakapacker.instance = Shakapacker::Instance.new
   end
@@ -22,6 +19,7 @@ describe "Shakapacker::Instance" do
 
   it "uses the SHAKAPACKER_CONFIG env variable for the config file path" do
     ENV["SHAKAPACKER_CONFIG"] = "/some/random/path.yml"
+    Shakapacker.instance = Shakapacker::Instance.new
 
     actual_config_path = "/some/random/path.yml"
     expected_config_path = Shakapacker.config.config_path.to_s

data/spec/shakapacker/rake_tasks_spec.rb

@@ -63,13 +63,7 @@ describe "RakeTasks" do
         FileUtils.mv("bin/shakapacker_renamed", "bin/shakapacker")
       end
 
-      it "passes if `./bin/webpacker exist" do
-        with_temporary_file("bin/webpacker") do
-          expect { system("bundle exec rake shakapacker:check_binstubs") }.to output(/DEPRECATION/).to_stdout_from_any_process
-        end
-      end
-
-      it "fails otherwise" do
+      it "fails" do
         expect { system("bundle exec rake shakapacker:check_binstubs") }.to output(/Couldn't find shakapacker binstubs!/).to_stdout_from_any_process
       end
     end
@@ -83,13 +77,7 @@ describe "RakeTasks" do
         FileUtils.mv("bin/shakapacker-dev-server_renamed", "bin/shakapacker-dev-server")
       end
 
-      it "passes if `./bin/webpacker-dev-server exist" do
-        with_temporary_file("bin/webpacker-dev-server") do
-          expect { system("bundle exec rake shakapacker:check_binstubs") }.to output(/DEPRECATION/).to_stdout_from_any_process
-        end
-      end
-
-      it "fails otherwise" do
+      it "fails" do
         expect { system("bundle exec rake shakapacker:check_binstubs") }.to output(/Couldn't find shakapacker binstubs!/).to_stdout_from_any_process
       end
     end

data/spec/shakapacker/shakapacker_spec.rb

@@ -8,7 +8,6 @@ describe "Shakapacker" do
       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(:running?).and_return(true)
     end
 

data/spec/shakapacker/test_app/config/shakapacker_css_extract_ignore_order_warnings.yml

@@ -45,7 +45,6 @@ development:
 
   # Reference: https://webpack.js.org/configuration/dev-server/
   dev_server:
-    https: false
     host: localhost
     port: 3035
     public: localhost:3035

data/spec/shakapacker/test_app/config/shakapacker_manifest_path.yml

@@ -41,7 +41,6 @@ development:
 
   # Reference: https://webpack.js.org/configuration/dev-server/
   dev_server:
-    https: false
     host: localhost
     port: 3035
     public: localhost:3035

data/spec/shakapacker/test_app/config/shakapacker_nested_entries.yml

@@ -44,7 +44,6 @@ development:
 
   # Reference: https://webpack.js.org/configuration/dev-server/
   dev_server:
-    https: false
     host: localhost
     port: 3035
     public: localhost:3035

data/spec/shakapacker/test_app/config/shakapacker_other_location.yml

@@ -38,7 +38,6 @@ development:
 
   # Reference: https://webpack.js.org/configuration/dev-server/
   dev_server:
-    https: false
     host: localhost
     port: 3035
     public: localhost:3035

data/spec/shakapacker/test_app/package.json

@@ -9,5 +9,6 @@
   },
   "devDependencies": {
     "right-pad": "^1.0.1"
-  }
+  },
+  "packageManager": "yarn@1.22.24"
 }

data/spec/shakapacker/utils_manager_spec.rb

@@ -0,0 +1,125 @@
+require_relative "spec_helper_initializer"
+require "shakapacker/utils/manager"
+
+Struct.new("Status", :exit_code) do
+  def success?
+    exit_code.zero?
+  end
+
+  def exitstatus
+    exit_code
+  end
+end
+
+describe "Shakapacker::Utils::Manager" do
+  around do |example|
+    within_temp_directory { example.run }
+  end
+
+  describe "~error_unless_package_manager_is_obvious!" do
+    before do
+      allow(Shakapacker).to receive(:puts_deprecation_message)
+    end
+
+    context "when 'packageManager' is set in the package.json" do
+      before do
+        File.write("package.json", { "packageManager" => "pnpm" }.to_json)
+      end
+
+      it "does nothing" do
+        Shakapacker::Utils::Manager.error_unless_package_manager_is_obvious!
+
+        expect(Shakapacker).not_to have_received(:puts_deprecation_message)
+      end
+    end
+
+    context "when the guessed manager is npm" do
+      it "does nothing" do
+        File.write("package.json", {}.to_json)
+        FileUtils.touch("package-lock.json")
+
+        Shakapacker::Utils::Manager.error_unless_package_manager_is_obvious!
+
+        expect(Shakapacker).not_to have_received(:puts_deprecation_message)
+      end
+    end
+
+    Shakapacker::Utils::Manager::MANAGER_LOCKS.reject { |manager| manager == "npm" }.each do |manager, lock|
+      context "when there is a #{lock}" do
+        before do
+          allow(Open3).to receive(:capture3).and_return(["1.2.3\n", "", Struct::Status.new(0)])
+        end
+
+        it "raises an error about setting 'packageManager' for #{manager}" do
+          File.write("package.json", {}.to_json)
+          FileUtils.touch(lock)
+
+          expect { Shakapacker::Utils::Manager.error_unless_package_manager_is_obvious! }.to raise_error(Shakapacker::Utils::Manager::Error, <<~MSG)
+            You don't have "packageManager" set in your package.json
+            meaning that Shakapacker will use npm but you've got a #{lock}
+            file meaning you probably want to be using #{manager} instead.
+
+            To make this happen, set "packageManager" in your package.json to #{manager}@1.2.3
+          MSG
+        end
+      end
+    end
+  end
+
+  describe "~guess_binary" do
+    Shakapacker::Utils::Manager::MANAGER_LOCKS.each do |manager, lock|
+      context "when a #{lock} exists" do
+        before { FileUtils.touch(lock) }
+
+        it "guesses #{manager}" do
+          expect(Shakapacker::Utils::Manager.guess_binary).to eq manager
+        end
+      end
+    end
+
+    context "when there is no lockfile" do
+      it "returns npm" do
+        expect(Shakapacker::Utils::Manager.guess_binary).to eq "npm"
+      end
+    end
+  end
+
+  describe "~guess_version" do
+    before do
+      allow(Open3).to receive(:capture3).and_return(["1.2.3\n", "", Struct::Status.new(0)])
+    end
+
+    Shakapacker::Utils::Manager::MANAGER_LOCKS.each do |manager, lock|
+      context "when a #{lock} exists" do
+        before { FileUtils.touch(lock) }
+
+        it "calls #{manager} with --version" do
+          Shakapacker::Utils::Manager.guess_version
+
+          expect(Open3).to have_received(:capture3).with("#{manager} --version")
+        end
+      end
+    end
+
+    it "returns the output without a trailing newline" do
+      FileUtils.touch("package-lock.json")
+
+      expect(Shakapacker::Utils::Manager.guess_version).to eq("1.2.3")
+    end
+
+    context "when the command errors" do
+      before do
+        allow(Open3).to receive(:capture3).and_return(["", "oh noes!", Struct::Status.new(1)])
+      end
+
+      it "raises an error" do
+        FileUtils.touch("package-lock.json")
+
+        expect { Shakapacker::Utils::Manager.guess_version }.to raise_error(
+          Shakapacker::Utils::Manager::Error,
+          "npm --version failed with exit code 1: oh noes!"
+        )
+      end
+    end
+  end
+end

data/spec/shakapacker/version_checker_spec.rb

@@ -29,19 +29,19 @@ describe "VersionChecker" do
     version_checker.raise_if_gem_and_node_package_versions_differ
   end
 
-  it "prints error in stderr if consistency check is disabled and version mismatch" do
+  it "does nothing if consistency check is disabled and version mismatch" do
     node_package_version = NodePackageVersionDouble.new(raw: "6.1.0", major_minor_patch: ["6", "1", "0"])
 
     expect { check_version(node_package_version, "6.0.0", false) }
-      .to output(/Shakapacker::VersionChecker - Version mismatch/)
+      .not_to output
       .to_stderr
   end
 
-  it "prints error in stderr if consistency check is disabled and we have semver" do
+  it "does nothing if consistency check is disabled and we have semver" do
     node_package_version = NodePackageVersionDouble.new(raw: "^6.1.0", major_minor_patch: ["6", "1", "0"], semver_wildcard: true)
 
     expect { check_version(node_package_version, "6.0.0", false) }
-      .to output(/Shakapacker::VersionChecker - Semver wildcard without a lockfile detected/)
+      .not_to output
       .to_stderr
   end
 
@@ -233,7 +233,7 @@ describe "VersionChecker::NodePackageVersion" do
       let(:node_package_version_from_github_url) { node_package_version(fixture_version: "github_url") }
 
       it "#raw returns the GitHub repo address" do
-        expect(node_package_version_from_github_url.raw).to eq "shakacode/shakapacker#master"
+        expect(node_package_version_from_github_url.raw).to eq "shakacode/shakapacker#main"
       end
 
       it "#major_minor_patch returns nil" do