shakapacker 7.2.3 → 8.0.0.pre.rc.1

data/spec/generator_specs/generator_spec.rb

@@ -58,10 +58,12 @@ describe "Generator" do
           expect(actual_content).to eq expected_content
         end
 
-        it "replaces package.json with the template file" do
+        it "ensures the 'packageManager' field is set" do
           package_json = PackageJson.read(path_in_the_app)
 
-          expect(package_json.fetch("name", "")).to eq("app")
+          manager_name = fallback_manager.split("_")[0]
+
+          expect(package_json.fetch("packageManager", "")).to match(/#{manager_name}@\d+\.\d+\.\d+/)
         end
 
         it "creates webpack config directory and its files" do
@@ -161,132 +163,6 @@ describe "Generator" do
         end
       end
     end
-
-    context "when not using package_json" do
-      before :all do
-        sh_opts = { fallback_manager: nil }
-
-        sh_in_dir(sh_opts, SPEC_PATH, "cp -r '#{BASE_RAILS_APP_PATH}' '#{TEMP_RAILS_APP_PATH}'")
-
-        Bundler.with_unbundled_env do
-          sh_in_dir(sh_opts, TEMP_RAILS_APP_PATH, "FORCE=true bundle exec rails shakapacker:install")
-        end
-      end
-
-      after :all do
-        Dir.chdir(SPEC_PATH)
-        FileUtils.rm_rf(TEMP_RAILS_APP_PATH)
-      end
-
-      it "creates `config/shakapacker.yml`" do
-        config_file_relative_path = "config/shakapacker.yml"
-        actual_content = read(path_in_the_app(config_file_relative_path))
-        expected_content = read(path_in_the_gem(config_file_relative_path))
-
-        expect(actual_content).to eq expected_content
-      end
-
-      it "replaces package.json with template file" do
-        package_json = PackageJson.read(path_in_the_app)
-
-        expect(package_json.fetch("name", "")).to eq("app")
-      end
-
-      it "creates the webpack config directory and its files" do
-        expected_files = [
-          "webpack.config.js"
-        ]
-
-        Dir.chdir(path_in_the_app("config/webpack")) do
-          existing_files_in_config_webpack_dir = Dir.glob("*")
-          expect(existing_files_in_config_webpack_dir).to eq expected_files
-        end
-      end
-
-      it "adds binstubs" do
-        expected_binstubs = []
-        Dir.chdir(File.join(GEM_ROOT, "lib/install/bin")) do
-          expected_binstubs = Dir.glob("bin/*")
-        end
-
-        Dir.chdir(File.join(TEMP_RAILS_APP_PATH, "bin")) do
-          actual_binstubs = Dir.glob("*")
-
-          expect(actual_binstubs).to include(*expected_binstubs)
-        end
-      end
-
-      it "modifies .gitignore" do
-        actual_content = read(path_in_the_app(".gitignore"))
-
-        expect(actual_content).to match ".yarn-integrity"
-      end
-
-      it 'adds <%= javascript_pack_tag "application" %>' do
-        actual_content = read(path_in_the_app("app/views/layouts/application.html.erb"))
-
-        expect(actual_content).to match '<%= javascript_pack_tag "application" %>'
-      end
-
-      it "updates `bin/setup`" do
-        setup_file_content = read(path_in_the_app("bin/setup"))
-
-        expect(setup_file_content).to match %r(^\s*system!\(['"]bin/yarn['"]\))
-      end
-
-      it "uses the shakapacker version in package.json depending on gem version" do
-        npm_version = Shakapacker::Utils::VersionSyntaxConverter.new.rubygem_to_npm(Shakapacker::VERSION)
-
-        package_json = PackageJson.read(path_in_the_app)
-        actual_version = package_json.fetch("dependencies", {})["shakapacker"]
-
-        expect(actual_version).to eq(npm_version)
-      end
-
-      it "adds Shakapacker peer dependencies to package.json" do
-        package_json = PackageJson.read(path_in_the_app)
-        actual_dependencies = package_json.fetch("dependencies", {}).keys
-
-        expected_dependencies = %w(
-          @babel/core
-          @babel/plugin-transform-runtime
-          @babel/preset-env
-          @babel/runtime
-          babel-loader
-          compression-webpack-plugin
-          terser-webpack-plugin
-          webpack
-          webpack-assets-manifest
-          webpack-cli
-          webpack-merge
-        )
-
-        expect(actual_dependencies).to include(*expected_dependencies)
-      end
-
-      it "adds Shakapacker peer dev dependencies to package.json" do
-        package_json = PackageJson.read(path_in_the_app)
-        actual_dev_dependencies = package_json.fetch("devDependencies", {}).keys
-
-        expected_dev_dependencies = %w(
-          webpack-dev-server
-        )
-
-        expect(actual_dev_dependencies).to include(*expected_dev_dependencies)
-      end
-
-      context "with a basic react app setup" do
-        it "passes the test for rendering react component on the page" do
-          sh_opts = { fallback_manager: nil }
-
-          Bundler.with_unbundled_env do
-            sh_in_dir(sh_opts, TEMP_RAILS_APP_PATH, "./bin/rails app:template LOCATION=../e2e_template/template.rb")
-
-            expect(sh_in_dir(sh_opts, TEMP_RAILS_APP_PATH, "bundle exec rspec")).to be_truthy
-          end
-        end
-      end
-    end
   end
 
   private
@@ -306,14 +182,8 @@ describe "Generator" do
     def sort_out_package_json(opts)
       ENV["PATH"] = "#{SPEC_PATH}/fake-bin:#{ENV["PATH"]}"
 
-      if opts[:fallback_manager].nil?
-        ENV["SHAKAPACKER_EXPECTED_PACKAGE_MANGER"] = "yarn_classic"
-        ENV["SHAKAPACKER_USE_PACKAGE_JSON_GEM"] = "false"
-      else
-        ENV["SHAKAPACKER_EXPECTED_PACKAGE_MANGER"] = opts[:fallback_manager]
-        ENV["SHAKAPACKER_USE_PACKAGE_JSON_GEM"] = "true"
-        ENV["PACKAGE_JSON_FALLBACK_MANAGER"] = opts[:fallback_manager]
-      end
+      ENV["SHAKAPACKER_EXPECTED_PACKAGE_MANGER"] = opts[:fallback_manager]
+      ENV["PACKAGE_JSON_FALLBACK_MANAGER"] = opts[:fallback_manager]
     end
 
     def sh_in_dir(opts, dir, *shell_commands)

data/spec/mounted_app/test/dummy/config/webpacker.yml

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

data/spec/shakapacker/compiler_spec.rb

@@ -1,4 +1,5 @@
 require_relative "spec_helper_initializer"
+require "ostruct"
 
 describe "Shakapacker::Compiler" do
   it "accepts custom environment variables" do
@@ -48,12 +49,9 @@ describe "Shakapacker::Compiler" do
 
   it "accepts external env variables" do
     expect(Shakapacker.compiler.send(:webpack_env)["SHAKAPACKER_ASSET_HOST"]).to be nil
-    expect(Shakapacker.compiler.send(:webpack_env)["SHAKAPACKER_RELATIVE_URL_ROOT"]).to be nil
 
     allow(ENV).to receive(:fetch).with("SHAKAPACKER_ASSET_HOST", nil).and_return("foo.bar")
-    allow(ENV).to receive(:fetch).with("SHAKAPACKER_RELATIVE_URL_ROOT", nil).and_return("/baz")
 
     expect(Shakapacker.compiler.send(:webpack_env)["SHAKAPACKER_ASSET_HOST"]).to eq "foo.bar"
-    expect(Shakapacker.compiler.send(:webpack_env)["SHAKAPACKER_RELATIVE_URL_ROOT"]).to eq "/baz"
   end
 end

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/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"
 }