shakapacker 6.6.0 → 7.0.0.rc.0

data/spec/instance_spec.rb

@@ -0,0 +1,31 @@
+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
+
+  it "uses default config path if no env variable defined" do
+    actual_config_path = Rails.root.join("config/shakapacker.yml")
+    expected_config_path = Shakapacker.config.config_path
+
+    expect(expected_config_path).to eq(actual_config_path)
+  end
+
+  it "uses SHAKAPACKER_CONFIG env variable for config file" do
+    ENV["SHAKAPACKER_CONFIG"] = "/some/random/path.yml"
+
+    actual_config_path = "/some/random/path.yml"
+    expected_config_path = Shakapacker.config.config_path.to_s
+
+    expect(expected_config_path).to eq(actual_config_path)
+  end
+end

data/spec/manifest_spec.rb

@@ -1,73 +1,75 @@
-describe "Webpacker::Manifest" do
+require_relative "spec_helper_initializer"
+
+describe "Shakapacker::Manifest" do
   let(:manifest_path) { File.expand_path File.join(File.dirname(__FILE__), "test_app/public/packs", "manifest.json").to_s }
 
   it "#lookup! throws exception for a non-existing asset file" do
     asset_file = "calendar.js"
     expected_error_message = "Shakapacker can't find #{asset_file} in #{manifest_path}"
 
-    allow(Webpacker.config).to receive(:compile?).and_return(false)
+    allow(Shakapacker.config).to receive(:compile?).and_return(false)
 
     expect {
-      Webpacker.manifest.lookup!(asset_file)
-    }.to raise_error(Webpacker::Manifest::MissingEntryError, /#{expected_error_message}/)
+      Shakapacker.manifest.lookup!(asset_file)
+    }.to raise_error(Shakapacker::Manifest::MissingEntryError, /#{expected_error_message}/)
   end
 
   it "#lookup! throws exception for a non-existing asset file with type and without extension" do
     asset_file = "calendar"
     expected_error_message = "Shakapacker can't find #{asset_file}.js in #{manifest_path}"
 
-    allow(Webpacker.config).to receive(:compile?).and_return(false)
+    allow(Shakapacker.config).to receive(:compile?).and_return(false)
 
     expect {
-      Webpacker.manifest.lookup!(asset_file, type: :javascript)
-    }.to raise_error(Webpacker::Manifest::MissingEntryError, /#{expected_error_message}/)
+      Shakapacker.manifest.lookup!(asset_file, type: :javascript)
+    }.to raise_error(Shakapacker::Manifest::MissingEntryError, /#{expected_error_message}/)
   end
 
   it "#lookup! returns path to bundled bootstrap.js" do
-    actual = Webpacker.manifest.lookup!("bootstrap.js")
+    actual = Shakapacker.manifest.lookup!("bootstrap.js")
     expected = "/packs/bootstrap-300631c4f0e0f9c865bc.js"
 
     expect(actual).to eq expected
   end
 
   it "#lookup_pack_with_chunks! returns array of path to bundled bootstrap with type of javascript" do
-    actual = Webpacker.manifest.lookup_pack_with_chunks!("bootstrap", type: :javascript)
+    actual = Shakapacker.manifest.lookup_pack_with_chunks!("bootstrap", type: :javascript)
     expected = ["/packs/bootstrap-300631c4f0e0f9c865bc.js"]
 
     expect(actual).to eq expected
   end
 
   it "#lookup_with_chunks! returns array of path to bundled bootstrap.js with type of javascript" do
-    actual = Webpacker.manifest.lookup_pack_with_chunks!("bootstrap.js", type: :javascript)
+    actual = Shakapacker.manifest.lookup_pack_with_chunks!("bootstrap.js", type: :javascript)
     expected = ["/packs/bootstrap-300631c4f0e0f9c865bc.js"]
 
     expect(actual).to eq expected
   end
 
   it "#lookup_with_chunks! returns array of path to bundled 'print/application' without extension and in a sub-directory" do
-    actual = Webpacker.manifest.lookup_pack_with_chunks!("print/application", type: :css)
+    actual = Shakapacker.manifest.lookup_pack_with_chunks!("print/application", type: :css)
     expected = ["/packs/print/application-983b6c164a47f7ed49cd.css"]
 
     expect(actual).to eq expected
   end
 
   it "#lookup_with_chunks! returns array of path to bundled 'print/application.css' in a sub-directory" do
-    actual = Webpacker.manifest.lookup_pack_with_chunks!("print/application.css", type: :css)
+    actual = Shakapacker.manifest.lookup_pack_with_chunks!("print/application.css", type: :css)
     expected = ["/packs/print/application-983b6c164a47f7ed49cd.css"]
 
     expect(actual).to eq expected
   end
 
   it "#lookup returns nil for non-existing asset file" do
-    expect(Webpacker.manifest.lookup("foo.js")).to be nil
+    expect(Shakapacker.manifest.lookup("foo.js")).to be nil
   end
 
   it "#lookup_pack_with_chunks returns nil for non-existing asset file" do
-    expect(Webpacker.manifest.lookup_pack_with_chunks("foo.js")).to be nil
+    expect(Shakapacker.manifest.lookup_pack_with_chunks("foo.js")).to be nil
   end
 
   it "#lookup returns path for bootstrap.js" do
-    actual = Webpacker.manifest.lookup("bootstrap.js")
+    actual = Shakapacker.manifest.lookup("bootstrap.js")
     expected = "/packs/bootstrap-300631c4f0e0f9c865bc.js"
 
     expect(actual).to eq expected
@@ -78,15 +80,15 @@ describe "Webpacker::Manifest" do
 
     expected_error_message = "Shakapacker can't find #{asset_file}.js in #{manifest_path}"
 
-    allow(Webpacker.config).to receive(:compile?).and_return(false)
+    allow(Shakapacker.config).to receive(:compile?).and_return(false)
 
     expect {
-      Webpacker.manifest.lookup_pack_with_chunks!(asset_file, type: :javascript)
-    }.to raise_error(Webpacker::Manifest::MissingEntryError, /#{expected_error_message}/)
+      Shakapacker.manifest.lookup_pack_with_chunks!(asset_file, type: :javascript)
+    }.to raise_error(Shakapacker::Manifest::MissingEntryError, /#{expected_error_message}/)
   end
 
   it "#lookup_pack_with_chunks! returns array of paths to bundled js files with 'application' in their name" do
-    actual_application_entrypoints = Webpacker.manifest.lookup_pack_with_chunks!("application", type: :javascript)
+    actual_application_entrypoints = Shakapacker.manifest.lookup_pack_with_chunks!("application", type: :javascript)
     expected_application_entrypoints = [
       "/packs/vendors~application~bootstrap-c20632e7baf2c81200d3.chunk.js",
       "/packs/vendors~application-e55f2aae30c07fb6d82a.chunk.js",

data/spec/mounted_app/test/dummy/config/application.rb

@@ -1,6 +1,6 @@
 require "action_controller/railtie"
 require "action_view/railtie"
-require "webpacker"
+require "shakapacker"
 
 module TestDummyApp
   class Application < Rails::Application

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

@@ -1,10 +1,10 @@
-# 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
+  source_path: app/javascript
   source_entry_path: entrypoints
   public_output_path: packs
-  cache_path: tmp/webpacker
+  cache_path: tmp/shakapacker
   webpack_loader: babel
 
   # Additional paths webpack should look up modules

data/spec/mtime_strategy_spec.rb

@@ -1,5 +1,7 @@
-describe "Webpacker::MtimeStrategy" do
-  let(:mtime_strategy) { Webpacker::MtimeStrategy.new }
+require_relative "spec_helper_initializer"
+
+describe "Shakapacker::MtimeStrategy" do
+  let(:mtime_strategy) { Shakapacker::MtimeStrategy.new }
   let(:manifest_timestamp) { Time.parse("2021-01-01 12:34:56 UTC") }
 
   describe "#fresh?" do

data/spec/rake_tasks_spec.rb

@@ -1,32 +1,34 @@
+require_relative "spec_helper_initializer"
+
 describe "RakeTasks" do
   let(:test_app_path) { File.expand_path("test_app", __dir__) }
 
-  it "`rake -T` lists webpacker tasks" do
+  it "`rake -T` lists Shakapacker tasks" do
     output = Dir.chdir(test_app_path) { `rake -T` }
-    expect(output).to include "webpacker"
-    expect(output).to include "webpacker:check_binstubs"
-    expect(output).to include "webpacker:check_node"
-    expect(output).to include "webpacker:check_yarn"
-    expect(output).to include "webpacker:clean"
-    expect(output).to include "webpacker:clobber"
-    expect(output).to include "webpacker:compile"
-    expect(output).to include "webpacker:install"
-    expect(output).to include "webpacker:verify_install"
+    expect(output).to include "shakapacker"
+    expect(output).to include "shakapacker:check_binstubs"
+    expect(output).to include "shakapacker:check_node"
+    expect(output).to include "shakapacker:check_yarn"
+    expect(output).to include "shakapacker:clean"
+    expect(output).to include "shakapacker:clobber"
+    expect(output).to include "shakapacker:compile"
+    expect(output).to include "shakapacker:install"
+    expect(output).to include "shakapacker:verify_install"
   end
 
-  it "`webpacker:check_binstubs` doesn't get 'webpack binstub not found' error" do
-    output = Dir.chdir(test_app_path) { `rake webpacker:check_binstubs 2>&1` }
+  it "`shakapacker:check_binstubs` doesn't get 'webpack binstub not found' error" do
+    output = Dir.chdir(test_app_path) { `rake shakapacker:check_binstubs 2>&1` }
     expect(output).to_not include "webpack binstub not found."
   end
 
-  it "`webpacker:check_node` doesn't get 'Webpacker requires Node.js' error" do
-    output = Dir.chdir(test_app_path) { `rake webpacker:check_node 2>&1` }
-    expect(output).to_not include "Webpacker requires Node.js"
+  it "`shakapacker:check_node` doesn't get 'shakapacker requires Node.js' error" do
+    output = Dir.chdir(test_app_path) { `rake shakapacker:check_node 2>&1` }
+    expect(output).to_not include "Shakapacker requires Node.js"
   end
 
-  it "`webpacker:check_yarn` doesn't get error related to yarn" do
-    output = Dir.chdir(test_app_path) { `rake webpacker:check_yarn 2>&1` }
+  it "`shakapacker:check_yarn` doesn't get error related to yarn" do
+    output = Dir.chdir(test_app_path) { `rake shakapacker:check_yarn 2>&1` }
     expect(output).to_not include "Yarn not installed"
-    expect(output).to_not include "Webpacker requires Yarn"
+    expect(output).to_not include "Shakapacker requires Yarn"
   end
 end

data/spec/spec_helper.rb

@@ -96,28 +96,3 @@ RSpec.configure do |config|
   Kernel.srand config.seed
 =end
 end
-
-require_relative "test_app/config/environment"
-
-Rails.env = "production"
-
-Webpacker.instance = ::Webpacker::Instance.new
-
-def reloaded_config
-  Webpacker.instance.instance_variable_set(:@env, nil)
-  Webpacker.instance.instance_variable_set(:@config, nil)
-  Webpacker.instance.instance_variable_set(:@dev_server, nil)
-  Webpacker.env
-  Webpacker.config
-  Webpacker.dev_server
-end
-
-def with_rails_env(env)
-  original = Rails.env
-  Rails.env = ActiveSupport::StringInquirer.new(env)
-  reloaded_config
-  yield
-ensure
-  Rails.env = ActiveSupport::StringInquirer.new(original)
-  reloaded_config
-end

data/spec/spec_helper_initializer.rb

@@ -0,0 +1,24 @@
+require_relative "test_app/config/environment"
+
+Rails.env = "production"
+
+Shakapacker.instance = ::Shakapacker::Instance.new
+
+def reloaded_config
+  Shakapacker.instance.instance_variable_set(:@env, nil)
+  Shakapacker.instance.instance_variable_set(:@config, nil)
+  Shakapacker.instance.instance_variable_set(:@dev_server, nil)
+  Shakapacker.env
+  Shakapacker.config
+  Shakapacker.dev_server
+end
+
+def with_rails_env(env)
+  original = Rails.env
+  Rails.env = ActiveSupport::StringInquirer.new(env)
+  reloaded_config
+  yield
+ensure
+  Rails.env = ActiveSupport::StringInquirer.new(original)
+  reloaded_config
+end

data/spec/test_app/.gitignore

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

data/spec/test_app/app/javascript/entrypoints/application.js

@@ -0,0 +1,10 @@
+/* eslint no-console:0 */
+// This file is automatically compiled by Webpack, along with any other files
+// present in this directory. You're encouraged to place your actual application logic in
+// a relevant structure within app/javascript and only use these pack files to reference
+// that code so it'll be compiled.
+//
+// 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 shakapacker')

data/spec/test_app/app/javascript/entrypoints/generated/something.js

@@ -0,0 +1,2 @@
+/* eslint no-console:0 */
+console.log('entrypoints/nested/something')

data/spec/test_app/app/javascript/entrypoints/multi_entry.css

@@ -0,0 +1,4 @@
+/*
+ * Dummy file #1 for Multi File Entry points: https://webpack.js.org/guides/entry-advanced/
+ * This file must be named the same
+ */

data/spec/test_app/app/javascript/entrypoints/multi_entry.js

@@ -0,0 +1,4 @@
+/*
+ * Dummy file #2 for Multi File Entry points: https://webpack.js.org/guides/entry-advanced/
+ * This file must be named the same
+ */

data/spec/test_app/bin/{webpacker-dev-server → shakapacker}

@@ -9,6 +9,6 @@ ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
 
 require "bundler/setup"
 
-require "webpacker"
-require "webpacker/dev_server_runner"
-Webpacker::DevServerRunner.run(ARGV)
+require "shakapacker"
+require "shakapacker/webpack_runner"
+Shakapacker::WebpackRunner.run(ARGV)

data/spec/test_app/bin/{webpacker → shakapacker-dev-server}

@@ -9,6 +9,6 @@ ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
 
 require "bundler/setup"
 
-require "webpacker"
-require "webpacker/webpack_runner"
-Webpacker::WebpackRunner.run(ARGV)
+require "shakapacker"
+require "shakapacker/dev_server_runner"
+Shakapacker::DevServerRunner.run(ARGV)

data/spec/test_app/config/application.rb

@@ -1,6 +1,6 @@
 require "action_controller/railtie"
 require "action_view/railtie"
-require "webpacker"
+require "shakapacker"
 
 module TestApp
   class Application < ::Rails::Application

data/spec/test_app/config/shakapacker.yml

@@ -0,0 +1,82 @@
+# 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: false
+  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:
+    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_css_extract_ignore_order_warnings.yml

@@ -0,0 +1,84 @@
+# 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
+  css_extract_ignore_order_warnings: true
+
+  # 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_defaults_fallback.yml

@@ -0,0 +1,11 @@
+# Note: You must restart bin/shakapacker-dev-server for changes to take effect
+
+default: &default
+  # cache_manifest will be fetched from bundled defaults
+  shakapacker_precompile: false
+
+staging:
+  <<: *default
+
+production:
+  <<: *default

data/spec/test_app/config/shakapacker_manifest_path.yml

@@ -0,0 +1,80 @@
+# Note: You must restart bin/webpack-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/shakapacker
+  webpack_compile_output: false
+
+  # Location for manifest.json, defaults to {public_output_path}/manifest.json if unset
+  manifest_path: app/javascript/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
+
+  # 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