shakapacker 6.6.0 → 7.0.0.rc.0

data/spec/backward_compatibility_specs/webpack_runner_spec_bc.rb

@@ -0,0 +1,56 @@
+require_relative "spec_helper_initializer"
+# Requiring from webpacker directory to ensure old ./bin/webpacker-dev-server works fine
+require "webpacker/webpack_runner"
+
+describe "WebpackRunner" do
+  before :all do
+    @original_node_env, ENV["NODE_ENV"] = ENV["NODE_ENV"], "development"
+    @original_rails_env, ENV["RAILS_ENV"] = ENV["RAILS_ENV"], "development"
+  end
+
+  after :all do
+    ENV["NODE_ENV"] = @original_node_env
+    ENV["RAILS_ENV"] = @original_rails_env
+  end
+
+  it "runs cmd 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 "runs cmd via yarn" do
+    cmd = ["yarn", "webpack", "--config", "#{test_app_path}/config/webpack/webpack.config.js"]
+
+    verify_command(cmd, use_node_modules: false)
+  end
+
+  it "runs cmd argv" 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
+
+  private
+    def test_app_path
+      File.expand_path("webpacker_test_app", __dir__)
+    end
+
+    def verify_command(cmd, use_node_modules: true, argv: [])
+      cwd = Dir.pwd
+      Dir.chdir(test_app_path)
+
+      klass = Webpacker::WebpackRunner
+      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)
+
+      klass.run(argv)
+
+      expect(Kernel).to have_received(:exec).with(Webpacker::Compiler.env, *cmd)
+    ensure
+      Dir.chdir(cwd)
+    end
+end

data/spec/backward_compatibility_specs/webpacker_spec_bc.rb

@@ -0,0 +1,41 @@
+require_relative "spec_helper_initializer"
+
+describe "webpacker" do
+  describe "#inline_css?" do
+    let(:dev_server) { instance_double("Webpacker::DevServer") }
+
+    before :each 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
+
+    it "returns nil with disabled dev_server" do
+      expect(Webpacker.inlining_css?).to be nil
+    end
+
+    it "returns true with enabled hmr" do
+      allow(dev_server).to receive(:hmr?).and_return(true)
+      allow(dev_server).to receive(:inline_css?).and_return(true)
+
+      allow(Webpacker.instance).to receive(:dev_server).and_return(dev_server)
+
+      expect(Webpacker.inlining_css?).to be true
+    end
+
+    it "returns false with enabled hmr and explicitly setting inline_css to false" do
+      allow(dev_server).to receive(:hmr?).and_return(true)
+      allow(dev_server).to receive(:inline_css?).and_return(false)
+
+      allow(Webpacker.instance).to receive(:dev_server).and_return(dev_server)
+
+      expect(Webpacker.inlining_css?).to be false
+    end
+  end
+
+  it "has app_autoload_paths cleanup" do
+    expect($test_app_autoload_paths_in_initializer).to eq []
+  end
+end

data/spec/backward_compatibility_specs/webpacker_test_app/.gitignore

@@ -0,0 +1,2 @@
+log/
+tmp/

data/spec/backward_compatibility_specs/webpacker_test_app/Rakefile

@@ -0,0 +1,3 @@
+require_relative "config/application"
+
+Rails.application.load_tasks

data/spec/{test_app → backward_compatibility_specs/webpacker_test_app}/app/packs/entrypoints/application.js

@@ -7,4 +7,4 @@
 // To reference this file, add <%= javascript_pack_tag 'application' %> to the appropriate
 // layout file, like app/views/layouts/application.html.erb
 
-console.log('Hello World from Webpacker')
+console.log('Hello World from shakapacker')

data/spec/backward_compatibility_specs/webpacker_test_app/config/application.rb

@@ -0,0 +1,11 @@
+require "action_controller/railtie"
+require "action_view/railtie"
+require "shakapacker"
+
+module WebpackerTestApp
+  class Application < ::Rails::Application
+    config.secret_key_base = "abcdef"
+    config.eager_load = true
+    config.active_support.test_order = :sorted
+  end
+end

data/spec/backward_compatibility_specs/webpacker_test_app/config/environment.rb

@@ -0,0 +1,4 @@
+require_relative "application"
+
+Rails.backtrace_cleaner.remove_silencers!
+Rails.application.initialize!

data/spec/backward_compatibility_specs/webpacker_test_app/config/initializers/inspect_autoload_paths.rb

@@ -0,0 +1 @@
+$test_app_autoload_paths_in_initializer = ActiveSupport::Dependencies.autoload_paths

data/spec/{test_app → backward_compatibility_specs/webpacker_test_app}/config/webpacker.yml

@@ -1,4 +1,4 @@
-# Note: You must restart bin/webpacker-dev-server for changes to take effect
+# Note: You must restart bin/shakapacker-dev-server for changes to take effect
 
 default: &default
   source_path: app/packs

data/spec/{test_app → backward_compatibility_specs/webpacker_test_app}/config/webpacker_css_extract_ignore_order_warnings.yml

@@ -1,4 +1,4 @@
-# Note: You must restart bin/webpacker-dev-server for changes to take effect
+# Note: You must restart bin/shakapacker-dev-server for changes to take effect
 
 default: &default
   source_path: app/packs

data/spec/{test_app → backward_compatibility_specs/webpacker_test_app}/config/webpacker_defaults_fallback.yml

@@ -1,4 +1,4 @@
-# Note: You must restart bin/webpacker-dev-server for changes to take effect
+# Note: You must restart bin/shakapacker-dev-server for changes to take effect
 
 default: &default
   # cache_manifest will be fetched from bundled defaults

data/spec/backward_compatibility_specs/webpacker_test_app/config/webpacker_no_precompile.yml

@@ -0,0 +1,7 @@
+# Note: You must restart bin/shakapacker-dev-server for changes to take effect
+
+default: &default
+  webpacker_precompile: false
+
+production:
+  <<: *default

data/spec/{test_app → backward_compatibility_specs/webpacker_test_app}/config/webpacker_other_location.yml

@@ -1,4 +1,4 @@
-# Note: You must restart bin/webpacker-dev-server for changes to take effect
+# Note: You must restart bin/shakapacker-dev-server for changes to take effect
 
 default: &default
   source_path: app/packs

data/spec/{test_app → backward_compatibility_specs/webpacker_test_app}/config/webpacker_public_root.yml

@@ -1,4 +1,4 @@
-# Note: You must restart bin/webpacker-dev-server for changes to take effect
+# Note: You must restart bin/shakapacker-dev-server for changes to take effect
 
 default: &default
   public_root_path: ../public

data/spec/backward_compatibility_specs/webpacker_test_app/config.ru

@@ -0,0 +1,5 @@
+# This file allows the `Rails.root` to be correctly determined.
+
+require_relative "config/environment"
+
+run Rails.application

data/spec/backward_compatibility_specs/webpacker_test_app/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "webpacker_test_app",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "private": true,
+  "dependencies": {
+    "left-pad": "^1.2.0"
+  },
+  "devDependencies": {
+    "right-pad": "^1.0.1"
+  }
+}

data/spec/backward_compatibility_specs/webpacker_test_app/public/packs/manifest.json

@@ -0,0 +1,58 @@
+{
+  "bootstrap.css": "/packs/bootstrap-c38deda30895059837cf.css",
+  "application.css": "/packs/application-dd6b1cd38bfa093df600.css",
+  "bootstrap.js": "/packs/bootstrap-300631c4f0e0f9c865bc.js",
+  "main.js": "/packs/main-e323a53c7f30f5d53cbb.js",
+  "application.js": "/packs/application-k344a6d59eef8632c9d1.js",
+  "application.png": "/packs/application-k344a6d59eef8632c9d1.png",
+  "fonts/fa-regular-400.woff2": "/packs/fonts/fa-regular-400-944fb546bd7018b07190a32244f67dc9.woff2",
+  "static/image.jpg": "/packs/static/image-c38deda30895059837cf.jpg",
+  "static/image-2x.jpg": "/packs/static/image-2x-7cca48e6cae66ec07b8e.jpg",
+  "static/nested/image.jpg": "/packs/static/nested/image-c38deda30895059837cf.jpg",
+  "static/mb-icon.png": "/packs/static/mb-icon-c38deda30895059837cf.png",
+  "static/nested/mb-icon.png": "/packs/static/nested/mb-icon-c38deda30895059837cf.png",
+  "entrypoints": {
+    "application": {
+      "assets": {
+        "js": [
+          "/packs/vendors~application~bootstrap-c20632e7baf2c81200d3.chunk.js",
+          "/packs/vendors~application-e55f2aae30c07fb6d82a.chunk.js",
+          "/packs/application-k344a6d59eef8632c9d1.js"
+        ],
+        "css": [
+          "/packs/1-c20632e7baf2c81200d3.chunk.css",
+          "/packs/application-k344a6d59eef8632c9d1.chunk.css"
+        ]
+      }
+    },
+    "bootstrap": {
+      "assets": {
+        "js": [
+          "/packs/bootstrap-300631c4f0e0f9c865bc.js"
+        ]
+      }
+    },
+    "main": {
+      "assets": {
+        "js": [
+          "/packs/main-e323a53c7f30f5d53cbb.js"
+        ]
+      }
+    },
+    "hello_stimulus": {
+      "assets": {
+        "css": [
+          "/packs/1-c20632e7baf2c81200d3.chunk.css",
+          "/packs/hello_stimulus-k344a6d59eef8632c9d1.chunk.css"
+        ]
+      }
+    },
+    "print/application": {
+      "assets": {
+        "css": [
+          "/packs/print/application-983b6c164a47f7ed49cd.css"
+        ]
+      }
+    }
+  }
+}

data/spec/backward_compatibility_specs/webpacker_test_app/tmp/shakapacker/last-compilation-digest-production

@@ -0,0 +1 @@
+70edce1bd3ecd60639ea9e56a3cd098a3641ca07

data/spec/backward_compatibility_specs/webpacker_test_app/yarn.lock

@@ -0,0 +1,11 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+
+left-pad@^1.2.0:
+  version "1.2.0"
+  resolved "https://registry.yarnpkg.com/left-pad/-/left-pad-1.2.0.tgz#d30a73c6b8201d8f7d8e7956ba9616087a68e0ee"
+
+right-pad@^1.0.1:
+  version "1.0.1"
+  resolved "https://registry.yarnpkg.com/right-pad/-/right-pad-1.0.1.tgz#8ca08c2cbb5b55e74dafa96bf7fd1a27d568c8d0"

data/spec/command_spec.rb

@@ -1,27 +1,29 @@
+require_relative "spec_helper_initializer"
+
 describe "Command" do
   before do
-    allow(Webpacker.logger).to receive(:info)
+    allow(Shakapacker.logger).to receive(:info)
   end
 
   describe "#compile" do
     it "returns success status when stale" do
-      expect(Webpacker.compiler).to receive(:stale?).and_return(true)
-      expect(Webpacker.compiler).to receive(:run_webpack).and_return(true)
+      expect(Shakapacker.compiler).to receive(:stale?).and_return(true)
+      expect(Shakapacker.compiler).to receive(:run_webpack).and_return(true)
 
-      expect(Webpacker.commands.compile).to be true
+      expect(Shakapacker.commands.compile).to be true
     end
 
     it "returns success status when fresh" do
-      expect(Webpacker.compiler).to receive(:stale?).and_return(false)
+      expect(Shakapacker.compiler).to receive(:stale?).and_return(false)
 
-      expect(Webpacker.commands.compile).to be true
+      expect(Shakapacker.commands.compile).to be true
     end
 
     it "returns failure status when stale" do
-      expect(Webpacker.compiler).to receive(:stale?).and_return(true)
-      expect(Webpacker.compiler).to receive(:run_webpack).and_return(false)
+      expect(Shakapacker.compiler).to receive(:stale?).and_return(true)
+      expect(Shakapacker.compiler).to receive(:run_webpack).and_return(false)
 
-      expect(Webpacker.commands.compile).to be false
+      expect(Shakapacker.commands.compile).to be false
     end
   end
 
@@ -30,7 +32,7 @@ describe "Command" do
     let(:prev_files) do
       # Test assets to be kept and deleted, path and mtime
       {
-        # recent versions to be kept with Webpacker.commands.clean(count = 2)
+        # recent versions to be kept with Shakapacker.commands.clean(count = 2)
         "js/application-deadbeef.js" => now - 4000,
         "js/common-deadbeee.js" => now - 4002,
         "css/common-deadbeed.css" => now - 4004,
@@ -39,12 +41,12 @@ describe "Command" do
         "js/common-1eadbeee.js" => now - 8002,
         "css/common-1eadbeed.css" => now - 8004,
         "media/images/logo-1eadbeeb.css" => now - 8006,
-        # new files to be kept with Webpacker.commands.clean(age = 3600)
+        # new files to be kept with Shakapacker.commands.clean(age = 3600)
         "js/brandnew-0001.js" => now,
         "js/brandnew-0002.js" => now - 10,
         "js/brandnew-0003.js" => now - 20,
         "js/brandnew-0004.js" => now - 40,
-      }.transform_keys { |path| "#{Webpacker.config.public_output_path}/#{path}" }
+      }.transform_keys { |path| "#{Shakapacker.config.public_output_path}/#{path}" }
     end
 
     let(:expired_files) do
@@ -54,7 +56,7 @@ describe "Command" do
         "js/common-0eadbeee.js" => now - 9002,
         "css/common-0eadbeed.css" => now - 9004,
         "js/brandnew-0005.js" => now - 3640,
-      }.transform_keys { |path| "#{Webpacker.config.public_output_path}/#{path}" }
+      }.transform_keys { |path| "#{Shakapacker.config.public_output_path}/#{path}" }
     end
 
     let(:all_files) { prev_files.merge(expired_files) }
@@ -66,7 +68,7 @@ describe "Command" do
     before :context do
       @dir_glob_stub = Proc.new { |arg|
         case arg
-        when "#{Webpacker.config.public_output_path}/**/*"
+        when "#{Shakapacker.config.public_output_path}/**/*"
           all_files.keys
         else
           []
@@ -76,7 +78,7 @@ describe "Command" do
 
     it "works with nested hashes and without any compiled files" do
       allow(File).to receive(:delete).and_return(true)
-      expect(Webpacker.commands.clean).to be true
+      expect(Shakapacker.commands.clean).to be true
     end
 
     it "deletes only and only expired versioned files if no parameter passed" do
@@ -85,7 +87,7 @@ describe "Command" do
       end
 
       with_time_dir_and_files_stub do
-        expect(Webpacker.commands.clean).to be true
+        expect(Shakapacker.commands.clean).to be true
 
         # Verify that only and only expired files are deleted
         all_files.keys.each do |longpath|

data/spec/compiler_spec.rb

@@ -1,32 +1,34 @@
-describe "Webpacker::Compiler" do
+require_relative "spec_helper_initializer"
+
+describe "Shakapacker::Compiler" do
   it "accepts custom environment variables" do
-    expect(Webpacker.compiler.send(:webpack_env)["FOO"]).to be nil
+    expect(Shakapacker.compiler.send(:webpack_env)["FOO"]).to be nil
 
-    Webpacker.compiler.env["FOO"] = "BAR"
-    expect(Webpacker.compiler.send(:webpack_env)["FOO"]).to eq "BAR"
+    Shakapacker.compiler.env["FOO"] = "BAR"
+    expect(Shakapacker.compiler.send(:webpack_env)["FOO"]).to eq "BAR"
   ensure
-    Webpacker.compiler.env = {}
+    Shakapacker.compiler.env = {}
   end
 
   it "returns true when fresh" do
     mocked_strategy = double("Strategy")
     expect(mocked_strategy).to receive(:stale?).and_return(false)
 
-    expect(Webpacker.compiler).to receive(:strategy).and_return(mocked_strategy)
+    expect(Shakapacker.compiler).to receive(:strategy).and_return(mocked_strategy)
 
-    expect(Webpacker.compiler.compile).to be true
+    expect(Shakapacker.compiler.compile).to be true
   end
 
   it "returns true and calls after_compile_hook on successful compile" do
     mocked_strategy = spy("Strategy")
     expect(mocked_strategy).to receive(:stale?).and_return(true)
 
-    allow(Webpacker.compiler).to receive(:strategy).and_return(mocked_strategy)
+    allow(Shakapacker.compiler).to receive(:strategy).and_return(mocked_strategy)
 
     status = OpenStruct.new(success?: true)
     allow(Open3).to receive(:capture3).and_return([:sterr, :stdout, status])
 
-    expect(Webpacker.compiler.compile).to be true
+    expect(Shakapacker.compiler.compile).to be true
     expect(mocked_strategy).to have_received(:after_compile_hook)
   end
 
@@ -35,23 +37,23 @@ describe "Webpacker::Compiler" do
     allow(mocked_strategy).to receive(:stale?).and_return(true)
     allow(mocked_strategy).to receive(:after_compile_hook)
 
-    allow(Webpacker.compiler).to receive(:strategy).and_return(mocked_strategy)
+    allow(Shakapacker.compiler).to receive(:strategy).and_return(mocked_strategy)
 
     status = OpenStruct.new(success?: false)
     allow(Open3).to receive(:capture3).and_return([:sterr, :stdout, status])
 
-    expect(Webpacker.compiler.compile).to be false
+    expect(Shakapacker.compiler.compile).to be false
     expect(mocked_strategy).to have_received(:after_compile_hook)
   end
 
   it "accepts external env variables" do
-    expect(Webpacker.compiler.send(:webpack_env)["WEBPACKER_ASSET_HOST"]).to be nil
-    expect(Webpacker.compiler.send(:webpack_env)["WEBPACKER_RELATIVE_URL_ROOT"]).to be nil
+    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
 
-    ENV["WEBPACKER_ASSET_HOST"] = "foo.bar"
-    ENV["WEBPACKER_RELATIVE_URL_ROOT"] = "/baz"
+    ENV["SHAKAPACKER_ASSET_HOST"] = "foo.bar"
+    ENV["SHAKAPACKER_RELATIVE_URL_ROOT"] = "/baz"
 
-    expect(Webpacker.compiler.send(:webpack_env)["WEBPACKER_ASSET_HOST"]).to eq "foo.bar"
-    expect(Webpacker.compiler.send(:webpack_env)["WEBPACKER_RELATIVE_URL_ROOT"]).to eq "/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/compiler_strategy_spec.rb

@@ -1,20 +1,22 @@
-describe "Webpacker::CompilerStrategy" do
+require_relative "spec_helper_initializer"
+
+describe "Shakapacker::CompilerStrategy" do
   describe "#from_config" do
     it "returns and instance of MtimeStrategy when compiler_strategy is set to mtime" do
-      allow(Webpacker.config).to receive(:compiler_strategy).and_return("mtime")
-      expect(Webpacker::CompilerStrategy.from_config).to be_an_instance_of(Webpacker::MtimeStrategy)
+      allow(Shakapacker.config).to receive(:compiler_strategy).and_return("mtime")
+      expect(Shakapacker::CompilerStrategy.from_config).to be_an_instance_of(Shakapacker::MtimeStrategy)
     end
 
     it "returns and instance of DigestStrategy when compiler_strategy is set to digest" do
-      allow(Webpacker.config).to receive(:compiler_strategy).and_return("digest")
-      expect(Webpacker::CompilerStrategy.from_config).to be_an_instance_of(Webpacker::DigestStrategy)
+      allow(Shakapacker.config).to receive(:compiler_strategy).and_return("digest")
+      expect(Shakapacker::CompilerStrategy.from_config).to be_an_instance_of(Shakapacker::DigestStrategy)
     end
 
     it "raise exception for unknown compiler_strategy in the config file" do
       expected_error_message = "Unknown strategy 'other'. Available options are 'mtime' and 'digest'."
-      allow(Webpacker.config).to receive(:compiler_strategy).and_return("other")
+      allow(Shakapacker.config).to receive(:compiler_strategy).and_return("other")
 
-      expect { Webpacker::CompilerStrategy.from_config }.to raise_error(expected_error_message)
+      expect { Shakapacker::CompilerStrategy.from_config }.to raise_error(expected_error_message)
     end
   end
 end