shakapacker 6.6.0 → 7.0.0.rc.0

data/spec/test_app/config/shakapacker_nested_entries.yml

@@ -0,0 +1,83 @@
+# Note: You must restart bin/shakapacker-dev-server for changes to take effect
+
+default: &default
+  source_path: app/javascript
+  source_entry_path: entrypoints
+  nested_entries: true
+  public_root_path: public
+  public_output_path: packs
+  cache_path: tmp/shakapacker
+  webpack_compile_output: false
+  webpack_loader: babel
+
+  # Location for manifest.json, defaults to {public_output_path}/manifest.json if unset
+  # manifest_path: public/packs/manifest.json
+
+  # Additional paths webpack should look up modules
+  # ['app/assets', 'engine/foo/app/assets']
+  additional_paths:
+    - app/assets
+    - /etc/yarn
+    - some.config.js
+    - app/elm
+
+  # Reload manifest.json on all requests so we reload latest compiled packs
+  cache_manifest: false
+
+  static_assets_extensions:
+    - .jpg
+    - .jpeg
+    - .png
+    - .gif
+    - .tiff
+    - .ico
+    - .svg
+
+  extensions:
+    - .mjs
+    - .js
+
+development:
+  <<: *default
+  compile: true
+  ensure_consistent_versioning: true
+
+  # Reference: https://webpack.js.org/configuration/dev-server/
+  dev_server:
+    https: false
+    host: localhost
+    port: 3035
+    public: localhost:3035
+    hmr: false
+    overlay: true
+    disable_host_check: true
+    use_local_ip: false
+    pretty: false
+
+test:
+  <<: *default
+  compile: true
+
+  # Compile test packs to a separate directory
+  public_output_path: packs-test
+
+production:
+  <<: *default
+
+  # Production depends on precompilation of packs prior to booting for performance.
+  compile: false
+
+  # Cache manifest.json for performance
+  cache_manifest: true
+
+staging:
+  <<: *default
+
+  # Production depends on precompilation of packs prior to booting for performance.
+  compile: false
+
+  # Cache manifest.json for performance
+  cache_manifest: true
+
+  # Compile staging packs to a separate directory
+  public_output_path: packs-staging

data/spec/test_app/config/shakapacker_no_precompile.yml

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

data/spec/test_app/config/shakapacker_other_location.yml

@@ -0,0 +1,85 @@
+# Note: You must restart bin/shakapacker-dev-server for changes to take effect
+
+default: &default
+  source_path: app/javascript
+  source_entry_path: entrypoints
+  public_root_path: public
+  public_output_path: packs
+  cache_path: tmp/cache/shakapacker
+  webpack_compile_output: false
+
+  # Additional paths webpack should look up modules
+  # ['app/assets', 'engine/foo/app/assets']
+  additional_paths:
+    - app/assets
+    - /etc/yarn
+    - some.config.js
+    - app/elm
+
+  # Reload manifest.json on all requests so we reload latest compiled packs
+  cache_manifest: false
+
+  static_assets_extensions:
+    - .jpg
+    - .jpeg
+    - .png
+    - .gif
+    - .tiff
+    - .ico
+    - .svg
+
+  extensions:
+    - .mjs
+    - .js
+
+development:
+  <<: *default
+  compile: true
+
+  # Reference: https://webpack.js.org/configuration/dev-server/
+  dev_server:
+    https: false
+    host: localhost
+    port: 3035
+    public: localhost:3035
+    hmr: false
+    # If HMR is on, CSS will by inlined by delivering it as part of the script payload via style-loader. Be sure
+    # that you add style-loader to your project dependencies.
+    #
+    # If you want to instead deliver CSS via <link> with the mini-extract-css-plugin, set inline_css to false.
+    # In that case, style-loader is not needed as a dependency.
+    #
+    # mini-extract-css-plugin is a required dependency in both cases.
+    inline_css: true
+    overlay: true
+    disable_host_check: true
+    use_local_ip: false
+    pretty: false
+
+test:
+  <<: *default
+  compile: true
+
+  # Compile test packs to a separate directory
+  public_output_path: packs-test
+
+production:
+  <<: *default
+
+  # Production depends on precompilation of packs prior to booting for performance.
+  compile: false
+
+  # Cache manifest.json for performance
+  cache_manifest: true
+
+staging:
+  <<: *default
+
+  # Production depends on precompilation of packs prior to booting for performance.
+  compile: false
+
+  # Cache manifest.json for performance
+  cache_manifest: true
+
+  # Compile staging packs to a separate directory
+  public_output_path: packs-staging

data/spec/test_app/config/shakapacker_public_root.yml

@@ -0,0 +1,18 @@
+# Note: You must restart bin/shakapacker-dev-server for changes to take effect
+
+default: &default
+  public_root_path: ../public
+
+development:
+  <<: *default
+  compile: true
+
+test:
+  <<: *default
+  compile: true
+  public_output_path: packs-test
+
+production:
+  <<: *default
+  compile: false
+  cache_manifest: true

data/spec/version_checker_spec.rb

@@ -1,4 +1,5 @@
-require "webpacker/version"
+require_relative "spec_helper_initializer"
+require "shakapacker/version"
 
 class NodePackageVersionDouble
   attr_reader :raw, :major_minor_patch
@@ -20,10 +21,10 @@ class NodePackageVersionDouble
 end
 
 describe "VersionChecker" do
-  def check_version(node_package_version, stub_gem_version = Webpacker::VERSION, stub_config = true)
-    version_checker = Webpacker::VersionChecker.new(node_package_version)
+  def check_version(node_package_version, stub_gem_version = Shakapacker::VERSION, stub_config = true)
+    version_checker = Shakapacker::VersionChecker.new(node_package_version)
     allow(version_checker).to receive(:gem_version).and_return(stub_gem_version)
-    allow(Webpacker.config).to receive(:ensure_consistent_versioning?).and_return(stub_config)
+    allow(Shakapacker.config).to receive(:ensure_consistent_versioning?).and_return(stub_config)
 
     version_checker.raise_if_gem_and_node_package_versions_differ
   end
@@ -32,7 +33,7 @@ describe "VersionChecker" 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(/Webpacker::VersionChecker - Version mismatch/)
+      .to output(/Shakapacker::VersionChecker - Version mismatch/)
       .to_stderr
   end
 
@@ -40,7 +41,7 @@ describe "VersionChecker" 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(/Webpacker::VersionChecker - Semver wildcard without a lockfile detected/)
+      .to output(/Shakapacker::VersionChecker - Semver wildcard without a lockfile detected/)
       .to_stderr
   end
 
@@ -48,28 +49,28 @@ describe "VersionChecker" do
     node_package_version = NodePackageVersionDouble.new(raw: "6.1.0", major_minor_patch: ["6", "1", "0"])
 
     expect { check_version(node_package_version, "7.0.0") }
-      .to raise_error(/\*\*ERROR\*\* Webpacker: Webpacker gem and node package versions do not match/)
+      .to raise_error(/\*\*ERROR\*\* Shakapacker: Shakapacker gem and node package versions do not match/)
   end
 
   it "raises exception on different minor version" do
     node_package_version = NodePackageVersionDouble.new(raw: "6.1.0", major_minor_patch: ["6", "1", "0"])
 
     expect { check_version(node_package_version, "6.2.0") }
-      .to raise_error(/\*\*ERROR\*\* Webpacker: Webpacker gem and node package versions do not match/)
+      .to raise_error(/\*\*ERROR\*\* Shakapacker: Shakapacker gem and node package versions do not match/)
   end
 
   it "raises exception on different patch version" do
     node_package_version = NodePackageVersionDouble.new(raw: "6.1.1", major_minor_patch: ["6", "1", "1"])
 
     expect { check_version(node_package_version, "6.1.2") }
-      .to raise_error(/\*\*ERROR\*\* Webpacker: Webpacker gem and node package versions do not match/)
+      .to raise_error(/\*\*ERROR\*\* Shakapacker: Shakapacker gem and node package versions do not match/)
   end
 
   it "raises exception on semver wildcard" do
     node_package_version = NodePackageVersionDouble.new(raw: "^6.0.0", major_minor_patch: ["6", "0", "0"], semver_wildcard: true)
 
     expect { check_version(node_package_version, "6.0.0") }
-      .to raise_error(/\*\*ERROR\*\* Webpacker: Your node package version for shakapacker contains a \^ or ~/)
+      .to raise_error(/\*\*ERROR\*\* Shakapacker: Your node package version for shakapacker contains a \^ or ~/)
   end
 
   it "doesn't raise exception on matching versions" do
@@ -100,7 +101,7 @@ end
 describe "VersionChecker::NodePackageVersion" do
   context "with no yarn.lock file" do
     def node_package_version(fixture_version:)
-      Webpacker::VersionChecker::NodePackageVersion.new(
+      Shakapacker::VersionChecker::NodePackageVersion.new(
         File.expand_path("fixtures/#{fixture_version}_package.json", __dir__),
         "file/does/not/exist",
         "file/does/not/exist"
@@ -270,7 +271,7 @@ describe "VersionChecker::NodePackageVersion" do
 
   context "with yarn.lock v1" do
     def node_package_version(fixture_version:)
-      Webpacker::VersionChecker::NodePackageVersion.new(
+      Shakapacker::VersionChecker::NodePackageVersion.new(
         File.expand_path("fixtures/#{fixture_version}_package.json", __dir__),
         File.expand_path("fixtures/#{fixture_version}_yarn.v1.lock", __dir__),
         "file/does/not/exist"
@@ -440,7 +441,7 @@ describe "VersionChecker::NodePackageVersion" do
 
   context "with yarn.lock v2" do
     def node_package_version(fixture_version:)
-      Webpacker::VersionChecker::NodePackageVersion.new(
+      Shakapacker::VersionChecker::NodePackageVersion.new(
         File.expand_path("fixtures/#{fixture_version}_package.json", __dir__),
         File.expand_path("fixtures/#{fixture_version}_yarn.v2.lock", __dir__),
         "file/does/not/exist"
@@ -610,7 +611,7 @@ describe "VersionChecker::NodePackageVersion" do
 
   context "with package-lock.json v1" do
     def node_package_version(fixture_version:)
-      Webpacker::VersionChecker::NodePackageVersion.new(
+      Shakapacker::VersionChecker::NodePackageVersion.new(
         File.expand_path("fixtures/#{fixture_version}_package.json", __dir__),
         "file/does/not/exist",
         File.expand_path("fixtures/#{fixture_version}_package-lock.v1.json", __dir__),
@@ -780,7 +781,7 @@ describe "VersionChecker::NodePackageVersion" do
 
   context "with package-lock.json v2" do
     def node_package_version(fixture_version:)
-      Webpacker::VersionChecker::NodePackageVersion.new(
+      Shakapacker::VersionChecker::NodePackageVersion.new(
         File.expand_path("fixtures/#{fixture_version}_package.json", __dir__),
         "file/does/not/exist",
         File.expand_path("fixtures/#{fixture_version}_package-lock.v2.json", __dir__),

data/spec/webpack_runner_spec.rb

@@ -1,4 +1,5 @@
-require "webpacker/webpack_runner"
+require_relative "spec_helper_initializer"
+require "shakapacker/webpack_runner"
 
 describe "WebpackRunner" do
   before :all do
@@ -38,7 +39,7 @@ describe "WebpackRunner" do
       cwd = Dir.pwd
       Dir.chdir(test_app_path)
 
-      klass = Webpacker::WebpackRunner
+      klass = Shakapacker::WebpackRunner
       instance = klass.new(argv)
 
       allow(klass).to receive(:new).and_return(instance)
@@ -47,7 +48,7 @@ describe "WebpackRunner" do
 
       klass.run(argv)
 
-      expect(Kernel).to have_received(:exec).with(Webpacker::Compiler.env, *cmd)
+      expect(Kernel).to have_received(:exec).with(Shakapacker::Compiler.env, *cmd)
     ensure
       Dir.chdir(cwd)
     end

data/spec/webpacker_spec.rb

@@ -1,6 +1,8 @@
-describe "Webpacker" do
+require_relative "spec_helper_initializer"
+
+describe "Shakapacker" do
   describe "#inline_css?" do
-    let(:dev_server) { instance_double("Webpacker::DevServer") }
+    let(:dev_server) { instance_double("Shakapacker::DevServer") }
 
     before :each do
       allow(dev_server).to receive(:host).and_return("localhost")
@@ -11,47 +13,25 @@ describe "Webpacker" do
     end
 
     it "returns nil with disabled dev_server" do
-      expect(Webpacker.inlining_css?).to be nil
+      expect(Shakapacker.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)
+      allow(Shakapacker.instance).to receive(:dev_server).and_return(dev_server)
 
-      expect(Webpacker.inlining_css?).to be true
+      expect(Shakapacker.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
-
-  describe "configurable config" do
-    before do
-      @original_webpacker_config = ENV["WEBPACKER_CONFIG"]
-    end
-
-    after do
-      ENV["WEBPACKER_CONFIG"] = @original_webpacker_config
-    end
-
-    it "allows config file to be changed based on ENV variable" do
-      ENV.delete("WEBPACKER_CONFIG")
-      Webpacker.instance = nil
-      expect(Webpacker.config.config_path.to_s).to eq(Rails.root.join("config/webpacker.yml").to_s)
-    end
+      allow(Shakapacker.instance).to receive(:dev_server).and_return(dev_server)
 
-    it "allows config file to be changed based on ENV variable" do
-      ENV["WEBPACKER_CONFIG"] = "/some/random/path.yml"
-      Webpacker.instance = nil
-      expect(Webpacker.config.config_path.to_s).to eq("/some/random/path.yml")
+      expect(Shakapacker.inlining_css?).to be false
     end
   end