shakapacker 6.5.5 → 6.6.0

data/spec/configuration_spec.rb

@@ -0,0 +1,281 @@
+describe "Webpacker::Configuration" do
+  ROOT_PATH = Pathname.new(File.expand_path("test_app", __dir__))
+
+  context "with standard webpacker.yml" do
+    let(:config) do
+      Webpacker::Configuration.new(
+        root_path: ROOT_PATH,
+        config_path: Pathname.new(File.expand_path("./test_app/config/webpacker.yml", __dir__)),
+        env: "production"
+      )
+    end
+
+    it "#source_path returns correct path" do
+      source_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/app/packs").to_s
+      expect(config.source_path.to_s).to eq source_path
+    end
+
+    it "#source_entry_path returns correct path" do
+      source_entry_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/app/packs", "entrypoints").to_s
+      expect(config.source_entry_path.to_s).to eq source_entry_path
+    end
+
+    it "#public_root_path returns correct path" do
+      public_root_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/public").to_s
+      expect(config.public_path.to_s).to eq public_root_path
+    end
+
+    it "#public_output_path returns correct path" do
+      public_output_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/public/packs").to_s
+      expect(config.public_output_path.to_s).to eq public_output_path
+    end
+
+    it "#public_manifest_path returns correct path" do
+      public_manifest_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/public/packs", "manifest.json").to_s
+      expect(config.public_manifest_path.to_s).to eq public_manifest_path
+    end
+
+    it "#manifest_path returns correct path" do
+      manifest_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/public/packs", "manifest.json").to_s
+      expect(config.manifest_path.to_s).to eq manifest_path
+    end
+
+    it "#cache_path returns correct path" do
+      cache_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/tmp/webpacker").to_s
+      expect(config.cache_path.to_s).to eq cache_path
+    end
+
+    it "#additional_paths returns correct path" do
+      expect(config.additional_paths).to eq ["app/assets", "/etc/yarn", "some.config.js", "app/elm"]
+    end
+
+    describe "#cache_manifest?" do
+      it "returns true in production environment" do
+        expect(config.cache_manifest?).to be true
+      end
+
+      it "returns false in developemnt environemnt" do
+        with_rails_env("development") do
+          expect(Webpacker.config.cache_manifest?).to be false
+        end
+      end
+
+      it "returns false in test environment" do
+        with_rails_env("test") do
+          expect(Webpacker.config.cache_manifest?).to be false
+        end
+      end
+    end
+
+    describe "#compile?" do
+      it "returns false in production environment" do
+        expect(config.compile?).to be false
+      end
+
+      it "returns true in developemnt environemnt" do
+        with_rails_env("development") do
+          expect(Webpacker.config.compile?).to be true
+        end
+      end
+
+      it "returns true in test environemnt" do
+        with_rails_env("test") do
+          expect(Webpacker.config.compile?).to be true
+        end
+      end
+    end
+
+    describe "#nested_entries?" do
+      it "returns false in production environment" do
+        expect(config.nested_entries?).to be false
+      end
+
+      it "returns false in development environment" do
+        with_rails_env("development") do
+          expect(Webpacker.config.nested_entries?).to be false
+        end
+      end
+
+      it "returns false in test environment" do
+        with_rails_env("test") do
+          expect(Webpacker.config.nested_entries?).to be false
+        end
+      end
+    end
+
+    describe "#ensure_consistent_versioning?" do
+      it "returns false in production environment" do
+        expect(config.ensure_consistent_versioning?).to be false
+      end
+
+      it "returns true in development environment" do
+        with_rails_env("development") do
+          expect(Webpacker.config.ensure_consistent_versioning?).to be true
+        end
+      end
+
+      it "returns false in test environment" do
+        with_rails_env("test") do
+          expect(Webpacker.config.ensure_consistent_versioning?).to be false
+        end
+      end
+    end
+
+    describe "#webpacker_precompile?" do
+      before :each do
+        ENV["WEBPACKER_PRECOMPILE"] = nil
+      end
+
+      subject { config.webpacker_precompile? }
+
+      it "returns true when WEBPACKER_PRECOMPILE is unset" do
+        is_expected.to be true
+      end
+
+      it "returns false when WEBPACKER_PRECOMPILE sets to no" do
+        ENV["WEBPACKER_PRECOMPILE"] = "no"
+        is_expected.to be false
+      end
+
+      it "returns true when WEBPACKER_PRECOMPILE sets to yes" do
+        ENV["WEBPACKER_PRECOMPILE"] = "yes"
+        is_expected.to be true
+      end
+
+      it "returns false when WEBPACKER_PRECOMPILE sets to false" do
+        ENV["WEBPACKER_PRECOMPILE"] = "false"
+        is_expected.to be false
+      end
+
+      it "returns true when WEBPACKER_PRECOMPILE sets to true" do
+        ENV["WEBPACKER_PRECOMPILE"] = "true"
+        is_expected.to be true
+      end
+
+      it "returns false when WEBPACKER_PRECOMPILE sets to n" do
+        ENV["WEBPACKER_PRECOMPILE"] = "n"
+        is_expected.to be false
+      end
+
+      it "returns true when WEBPACKER_PRECOMPILE sets to y" do
+        ENV["WEBPACKER_PRECOMPILE"] = "y"
+        is_expected.to be true
+      end
+
+      it "returns false when WEBPACKER_PRECOMPILE sets to f" do
+        ENV["WEBPACKER_PRECOMPILE"] = "f"
+        is_expected.to be false
+      end
+
+      it "returns true when WEBPACKER_PRECOMPILE sets to t" do
+        ENV["WEBPACKER_PRECOMPILE"] = "t"
+        is_expected.to be true
+      end
+    end
+  end
+
+  context "with webpacker config file containing public_output_path entry" do
+    config = Webpacker::Configuration.new(
+      root_path: ROOT_PATH,
+      config_path: Pathname.new(File.expand_path("./test_app/config/webpacker_public_root.yml", __dir__)),
+      env: "production"
+    )
+
+    it "#public_output_path returns correct path" do
+      expected_public_output_path = File.expand_path File.join(File.dirname(__FILE__), "public/packs").to_s
+      expect(config.public_output_path.to_s).to eq expected_public_output_path
+    end
+  end
+
+  context "with webpacker config file containing manifext_path entry" do
+    config = Webpacker::Configuration.new(
+      root_path: ROOT_PATH,
+      config_path: Pathname.new(File.expand_path("./test_app/config/webpacker_manifest_path.yml", __dir__)),
+      env: "production"
+    )
+
+    it "#manifest_path returns correct expected value" do
+      expected_manifest_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/app/packs", "manifest.json").to_s
+      expect(config.manifest_path.to_s).to eq expected_manifest_path
+    end
+  end
+
+  context "with webpacker_precompile entry set to false" do
+    describe "#webpacker_precompile?" do
+      before :each do
+        ENV["WEBPACKER_PRECOMPILE"] = nil
+      end
+
+      let(:config) {
+        Webpacker::Configuration.new(
+          root_path: ROOT_PATH,
+          config_path: Pathname.new(File.expand_path("./test_app/config/webpacker_no_precompile.yml", __dir__)),
+          env: "production"
+        )
+      }
+
+      subject { config.webpacker_precompile? }
+
+      it "returns false with unset WEBPACKER_PRECOMPILE" do
+        expect(subject).to be false
+      end
+
+      it "returns true with WEBPACKER_PRECOMPILE set to true" do
+        ENV["WEBPACKER_PRECOMPILE"] = "true"
+        expect(subject).to be true
+      end
+
+      it "returns false with WEBPACKER_PRECOMPILE set to nil" do
+        ENV["WEBPACKER_PRECOMPILE"] = nil
+        expect(subject).to be false
+      end
+    end
+  end
+
+  context "with webpacker config file containing invalid path" do
+    config = Webpacker::Configuration.new(
+      root_path: ROOT_PATH,
+      config_path: Pathname.new(File.expand_path("./test_app/config/invalid_path.yml", __dir__)),
+      env: "default"
+    )
+
+    it "#webpacker_precompile? returns false" do
+      expect(config.webpacker_precompile?).to be false
+    end
+  end
+
+  context "with webpacker config file with defaults fallback" do
+    let(:config) do
+      Webpacker::Configuration.new(
+        root_path: ROOT_PATH,
+        config_path: Pathname.new(File.expand_path("./test_app/config/webpacker_defaults_fallback.yml", __dir__)),
+        env: "default"
+      )
+    end
+
+    it "#cache_manifest? falls back to 'default' config from bundled file" do
+      expect(config.cache_manifest?).to be false
+    end
+
+    it "#webpacker_precompile? uses 'default' config from custom file" do
+      expect(config.webpacker_precompile?).to be false
+    end
+  end
+
+  context "falls back to bundled production config for custom environments" do
+    let(:config) do
+      Webpacker::Configuration.new(
+        root_path: ROOT_PATH,
+        config_path: Pathname.new(File.expand_path("./test_app/config/webpacker_defaults_fallback.yml", __dir__)),
+        env: "staging"
+      )
+    end
+
+    it "#cache_manifest? fall back to 'production' config from bundled file" do
+      expect(config.cache_manifest?).to be true
+    end
+    it "#webpacker_precompile? use 'staging' config from custom file" do
+      expect(config.webpacker_precompile?).to be false
+    end
+  end
+end

data/{test/dev_server_runner_test.rb → spec/dev_server_runner_spec.rb}

@@ -1,52 +1,47 @@
-require "test_helper"
 require "webpacker/dev_server_runner"
 
-class DevServerRunnerTest < Webpacker::Test
-  def setup
+describe "DevServerRunner" do
+  before do
     @original_node_env, ENV["NODE_ENV"] = ENV["NODE_ENV"], "development"
     @original_rails_env, ENV["RAILS_ENV"] = ENV["RAILS_ENV"], "development"
     @original_webpacker_config = ENV["WEBPACKER_CONFIG"]
   end
 
-  def teardown
+  after do
     ENV["NODE_ENV"] = @original_node_env
     ENV["RAILS_ENV"] = @original_rails_env
     ENV["WEBPACKER_CONFIG"] = @original_webpacker_config
   end
 
-  def test_run_cmd_via_node_modules
-    cmd = ["#{test_app_path}/node_modules/.bin/webpack", "serve", "--config", "#{test_app_path}/config/webpack/webpack.config.js"]
+  let(:test_app_path) { File.expand_path("test_app", __dir__) }
 
+  it "run cmd 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
-
-  def test_run_cmd_via_yarn
+  it "run cmd via yarn" do
     cmd = ["yarn", "webpack", "serve", "--config", "#{test_app_path}/config/webpack/webpack.config.js"]
-
     verify_command(cmd, use_node_modules: false)
   end
-
-  def test_run_cmd_argv
+  it "run cmd argv" 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"])
+    verify_command(cmd, argv: (["--quiet"]))
   end
-
-  def test_run_cmd_argv_with_https
+  it "run cmd argv with https" do
     cmd = ["#{test_app_path}/node_modules/.bin/webpack", "serve", "--config", "#{test_app_path}/config/webpack/webpack.config.js", "--https"]
 
-    dev_server = Webpacker::DevServer.new({})
-    def dev_server.host; "localhost"; end
-    def dev_server.port; "3035"; end
-    def dev_server.pretty?; false; end
-    def dev_server.https?; true; end
-    def dev_server.hmr?; false; end
-    Webpacker::DevServer.stub(:new, dev_server) do
-      verify_command(cmd, argv: ["--https"])
-    end
-  end
+    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)
 
-  def test_environment_variables
+    allow(Webpacker::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 = Webpacker::Compiler.env.dup
     ENV["WEBPACKER_CONFIG"] = env["WEBPACKER_CONFIG"] = "#{test_app_path}/config/webpacker_other_location.yml"
@@ -55,27 +50,22 @@ class DevServerRunnerTest < Webpacker::Test
   end
 
   private
-    def test_app_path
-      File.expand_path("test_app", __dir__)
-    end
 
     def verify_command(cmd, use_node_modules: true, argv: [], env: Webpacker::Compiler.env)
       cwd = Dir.pwd
       Dir.chdir(test_app_path)
-
       klass = Webpacker::DevServerRunner
       instance = klass.new(argv)
-      mock = Minitest::Mock.new
-      mock.expect(:call, nil, [env, *cmd])
 
-      klass.stub(:new, instance) do
-        instance.stub(:node_modules_bin_exist?, use_node_modules) do
-          Kernel.stub(:exec, mock) { klass.run(argv) }
-        end
-      end
+      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)
 
-      mock.verify
-    ensure
-      Dir.chdir(cwd)
+      ensure
+        Dir.chdir(cwd)
     end
 end

data/spec/dev_server_spec.rb

@@ -0,0 +1,45 @@
+describe "DevServer" do
+  it "doesn't run by default" do
+    expect(Webpacker.dev_server.running?).to be_falsy
+  end
+
+  it "uses localhost as host in development environment" do
+    with_rails_env("development") do
+      expect(Webpacker.dev_server.host).to eq "localhost"
+    end
+  end
+
+  it "uses port 3035 in development environment" do
+    with_rails_env("development") do
+      expect(Webpacker.dev_server.port).to eq 3035
+    end
+  end
+
+  it "doesn't use https in development environment" do
+    with_rails_env("development") do
+      expect(Webpacker.dev_server.https?).to be false
+    end
+  end
+
+  it "uses http protocol in development environment" do
+    with_rails_env("development") do
+      expect(Webpacker.dev_server.protocol).to eq "http"
+    end
+  end
+
+  it "sets host_with_port to localhost:3035 in development environment" do
+    with_rails_env("development") do
+      expect(Webpacker.dev_server.host_with_port).to eq "localhost:3035"
+    end
+  end
+
+  it "doesn't use pretty in development environment" do
+    with_rails_env("development") do
+      expect(Webpacker.dev_server.pretty?).to be false
+    end
+  end
+
+  it "users WEBPACKER_DEV_SERVER for DEFAULT_ENV_PREFIX" do
+    expect(Webpacker::DevServer::DEFAULT_ENV_PREFIX).to eq "WEBPACKER_DEV_SERVER"
+  end
+end

data/spec/digest_strategy_spec.rb

@@ -0,0 +1,33 @@
+describe "DigestStrategy" do
+  def remove_compilation_digest_path
+    @digest_strategy.send(:compilation_digest_path).tap do |path|
+      path.delete if path.exist?
+    end
+  end
+
+  before :all do
+    @digest_strategy = Webpacker::DigestStrategy.new
+    remove_compilation_digest_path
+  end
+
+  after :all do
+    remove_compilation_digest_path
+  end
+
+  it "is not fresh before compilation" do
+    expect(@digest_strategy.stale?).to be true
+    expect(@digest_strategy.fresh?).to be_falsy
+  end
+
+  it "is fresh after compilation" do
+    @digest_strategy.after_compile_hook
+    expect(@digest_strategy.stale?).to be false
+    expect(@digest_strategy.fresh?).to be true
+  end
+
+  it "generates correct compilation_digest_path" do
+    actual_path = @digest_strategy.send(:compilation_digest_path).basename.to_s
+    expected_path = "last-compilation-digest-#{Webpacker.env}"
+    expect(actual_path).to eq expected_path
+  end
+end

data/{test/engine_rake_tasks_test.rb → spec/engine_rake_tasks_spec.rb}

@@ -1,22 +1,25 @@
-require "test_helper"
-
-class EngineRakeTasksTest < Minitest::Test
-  def setup
+describe "EngineRakeTasks" do
+  before :context do
     remove_webpack_binstubs
   end
 
-  def teardown
+  after :context do
     remove_webpack_binstubs
   end
 
-  def test_task_mounted
+  it "mounts app:webpacker task successfully" do
     output = Dir.chdir(mounted_app_path) { `rake -T` }
-    assert_includes output, "app:webpacker"
+    expect(output).to include "app:webpacker"
   end
 
-  def test_binstubs
+  it "binstubs adds only expected files to bin directory" do
+    original_files_in_bin = current_files_in_bin
+
     Dir.chdir(mounted_app_path) { `bundle exec rake app:webpacker:binstubs` }
-    webpack_binstub_paths.each { |path| assert File.exist?(path) }
+    webpack_binstub_paths.each { |path| expect(File.exist?(path)).to be true }
+
+    # and no other files are added
+    expect(current_files_in_bin - webpack_binstub_paths).to match_array original_files_in_bin
   end
 
   private
@@ -24,8 +27,13 @@ class EngineRakeTasksTest < Minitest::Test
       File.expand_path("mounted_app", __dir__)
     end
 
+    def current_files_in_bin
+      Dir.glob("#{mounted_app_path}/test/dummy/bin/*")
+    end
+
     def webpack_binstub_paths
       [
+        "#{mounted_app_path}/test/dummy/bin/yarn",
         "#{mounted_app_path}/test/dummy/bin/webpacker",
         "#{mounted_app_path}/test/dummy/bin/webpacker-dev-server",
       ]

data/spec/env_spec.rb

@@ -0,0 +1,21 @@
+RSpec.describe "Env" do
+  it "uses the same env for Rails and Webpacker" do
+    expect(Webpacker.env).to eq Rails.env
+  end
+
+  it "uses production env without config" do
+    with_rails_env("foo") do
+      expect(Webpacker.env).to eq "production"
+    end
+  end
+
+  it "uses the given env in custom config" do
+    with_rails_env("staging") do
+      expect(Webpacker.env).to eq "staging"
+    end
+  end
+
+  it "uses 'production' as default env" do
+    expect(Webpacker::DEFAULT_ENV).to eq "production"
+  end
+end