shakapacker 6.3.0.pre.rc.1 → 6.4.1

data/package/environments/base.js

@@ -14,8 +14,15 @@ const { moduleExists } = require('../utils/helpers')
 const getEntryObject = () => {
   const entries = {}
   const rootPath = join(config.source_path, config.source_entry_path)
+  if (config.source_entry_path === '/' && config.nested_entries) {
+    throw new Error(
+      "Your webpacker config specified using a source_entry_path of '/' with 'nested_entries' == " +
+      "'true'. Doing this would result in packs for every one of your source files"
+    )
+  }
+  const nesting = config.nested_entries ? '**/' : ''
 
-  globSync(`${rootPath}/*.*`).forEach((path) => {
+  globSync(`${rootPath}/${nesting}*.*`).forEach((path) => {
     const namespace = relative(join(rootPath), dirname(path))
     const name = join(namespace, basename(path, extname(path)))
     let assetPaths = resolve(path)

data/package/rules/erb.js

@@ -9,7 +9,13 @@ module.exports = canProcess('rails-erb-loader', (resolvedPath) => ({
   use: [
     {
       loader: resolvedPath,
-      options: { runner: `${runner}bin/rails runner` }
+      options: {
+        runner: `${runner}bin/rails runner`,
+        env: {
+          ...process.env,
+          DISABLE_SPRING: 1
+        }
+      }
     }
   ]
 }))

data/package/rules/file.js

@@ -1,4 +1,4 @@
-const { dirname, join } = require('path')
+const { dirname } = require('path')
 const { source_path: sourcePath } = require('../config')
 
 module.exports = {
@@ -12,7 +12,7 @@ module.exports = {
         .split('/')
         .slice(1)
 
-      const foldersWithStatic = join('static', ...folders)
+      const foldersWithStatic = ['static', ...folders].join('/')
       return `${foldersWithStatic}/[name]-[hash][ext][query]`
     }
   }

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shakapacker",
-  "version": "6.3.0-rc.1",
+  "version": "6.4.1",
   "description": "Use webpack to manage app-like JavaScript modules in Rails",
   "main": "package/index.js",
   "files": [
@@ -13,16 +13,16 @@
   },
   "peerDependencies": {
     "@babel/core": "^7.17.9",
-    "@babel/plugin-transform-runtime": "^7.17.9",
+    "@babel/plugin-transform-runtime": "^7.17.0",
     "@babel/preset-env": "^7.16.11",
     "@babel/runtime": "^7.17.9",
     "babel-loader": "^8.2.4",
-    "compression-webpack-plugin": "^9.0.0",
+    "compression-webpack-plugin": "^9.0.0 || ^10.0.0",
     "terser-webpack-plugin": "^5.3.1",
     "webpack": "^5.72.0",
     "webpack-assets-manifest": "^5.0.6",
     "webpack-cli": "^4.9.2",
-    "webpack-dev-server": "^4.8.1",
+    "webpack-dev-server": "^4.9.0",
     "webpack-merge": "^5.8.0"
   },
   "dependencies": {

data/test/compiler_strategy_test.rb

@@ -0,0 +1,27 @@
+require "test_helper"
+
+class CompilerStrategyTest < Minitest::Test
+  def test_mtime_strategy_returned
+    Webpacker.config.stub :compiler_strategy, "mtime" do
+      assert_instance_of Webpacker::MtimeStrategy, Webpacker::CompilerStrategy.from_config
+    end
+  end
+
+  def test_digest_strategy_returned
+    Webpacker.config.stub :compiler_strategy, "digest" do
+      assert_instance_of Webpacker::DigestStrategy, Webpacker::CompilerStrategy.from_config
+    end
+  end
+
+  def test_raise_on_unknown_strategy
+    Webpacker.config.stub :compiler_strategy, "other" do
+      error = assert_raises do
+        Webpacker::CompilerStrategy.from_config
+      end
+
+      assert_equal \
+        "Unknown strategy 'other'. Available options are 'mtime' and 'digest'.",
+        error.message
+    end
+  end
+end

data/test/compiler_test.rb

@@ -9,46 +9,43 @@ class CompilerTest < Minitest::Test
     Webpacker.compiler.env = {}
   end
 
-  def setup
-    @manifest_timestamp = Time.parse("2021-01-01 12:34:56 UTC")
-  end
-
-  def with_stubs(latest_timestamp:, manifest_exists: true)
-    Webpacker.compiler.stub :latest_modified_timestamp, latest_timestamp do
-      FileTest.stub :exist?, manifest_exists do
-        File.stub :mtime, @manifest_timestamp do
-          yield
-        end
-      end
+  def test_compile_true_when_fresh
+    mock = Minitest::Mock.new
+    mock.expect(:stale?, false)
+    Webpacker.compiler.stub(:strategy, mock) do
+      assert Webpacker.compiler.compile
     end
+    assert_mock mock
   end
 
-  def test_freshness_when_manifest_missing
-    latest_timestamp = @manifest_timestamp + 3600
-
-    with_stubs(latest_timestamp: latest_timestamp.to_i, manifest_exists: false) do
-      assert Webpacker.compiler.stale?
-    end
-  end
+  def test_after_compile_hook_called_on_success
+    mock = Minitest::Mock.new
+    mock.expect(:stale?, true)
+    mock.expect(:after_compile_hook, nil)
 
-  def test_freshness_when_manifest_older
-    latest_timestamp = @manifest_timestamp + 3600
+    status = OpenStruct.new(success?: true)
 
-    with_stubs(latest_timestamp: latest_timestamp.to_i) do
-      assert Webpacker.compiler.stale?
+    Webpacker.compiler.stub(:strategy, mock) do
+      Open3.stub :capture3, [:sterr, :stdout, status] do
+        Webpacker.compiler.compile
+      end
     end
+    assert_mock mock
   end
 
-  def test_freshness_when_manifest_newer
-    latest_timestamp = @manifest_timestamp - 3600
+  def test_after_compile_hook_called_on_failure
+    mock = Minitest::Mock.new
+    mock.expect(:stale?, true)
+    mock.expect(:after_compile_hook, nil)
 
-    with_stubs(latest_timestamp: latest_timestamp.to_i) do
-      assert Webpacker.compiler.fresh?
-    end
-  end
+    status = OpenStruct.new(success?: false)
 
-  def test_compile
-    assert !Webpacker.compiler.compile
+    Webpacker.compiler.stub(:strategy, mock) do
+      Open3.stub :capture3, [:sterr, :stdout, status] do
+        Webpacker.compiler.compile
+      end
+    end
+    assert_mock mock
   end
 
   def test_external_env_variables

data/test/digest_strategy_test.rb

@@ -0,0 +1,33 @@
+require "test_helper"
+
+class DigestStrategyTest < Minitest::Test
+  def remove_compilation_digest_path
+    @digest_strategy.send(:compilation_digest_path).tap do |path|
+      path.delete if path.exist?
+    end
+  end
+
+  def setup
+    @digest_strategy = Webpacker::DigestStrategy.new
+    remove_compilation_digest_path
+  end
+
+  def teardown
+    remove_compilation_digest_path
+  end
+
+  def test_freshness
+    assert @digest_strategy.stale?
+    assert !@digest_strategy.fresh?
+  end
+
+  def test_freshness_after_compilation_hook
+    @digest_strategy.after_compile_hook
+    assert @digest_strategy.fresh?
+    assert !@digest_strategy.stale?
+  end
+
+  def test_compilation_digest_path
+    assert_equal @digest_strategy.send(:compilation_digest_path).basename.to_s, "last-compilation-digest-#{Webpacker.env}"
+  end
+end

data/test/mtime_strategy_test.rb

@@ -0,0 +1,42 @@
+require "test_helper"
+
+class MtimeStrategyTest < Minitest::Test
+  def setup
+    @mtime_strategy = Webpacker::MtimeStrategy.new
+    @manifest_timestamp = Time.parse("2021-01-01 12:34:56 UTC")
+  end
+
+  def with_stubs(latest_timestamp:, manifest_exists: true)
+    @mtime_strategy.stub :latest_modified_timestamp, latest_timestamp do
+      FileTest.stub :exist?, manifest_exists do
+        File.stub :mtime, @manifest_timestamp do
+          yield
+        end
+      end
+    end
+  end
+
+  def test_freshness_when_manifest_missing
+    latest_timestamp = @manifest_timestamp + 3600
+
+    with_stubs(latest_timestamp: latest_timestamp.to_i, manifest_exists: false) do
+      assert @mtime_strategy.stale?
+    end
+  end
+
+  def test_freshness_when_manifest_older
+    latest_timestamp = @manifest_timestamp + 3600
+
+    with_stubs(latest_timestamp: latest_timestamp.to_i) do
+      assert @mtime_strategy.stale?
+    end
+  end
+
+  def test_freshness_when_manifest_newer
+    latest_timestamp = @manifest_timestamp - 3600
+
+    with_stubs(latest_timestamp: latest_timestamp.to_i) do
+      assert @mtime_strategy.fresh?
+    end
+  end
+end

data/test/rake_tasks_test.rb

@@ -30,42 +30,8 @@ class RakeTasksTest < Minitest::Test
     refute_includes output, "Webpacker requires Yarn"
   end
 
-  def test_rake_webpacker_yarn_install_in_non_production_environments
-    assert_includes test_app_dev_dependencies, "right-pad"
-
-    Webpacker.with_node_env("test") do
-      Dir.chdir(test_app_path) do
-        `bundle exec rake webpacker:yarn_install`
-      end
-    end
-
-    assert_includes installed_node_module_names, "right-pad",
-                    "Expected dev dependencies to be installed"
-  end
-
-  def test_rake_webpacker_yarn_install_in_production_environment
-    Webpacker.with_node_env("production") do
-      Dir.chdir(test_app_path) do
-        `bundle exec rake webpacker:yarn_install`
-      end
-    end
-
-    refute_includes installed_node_module_names, "right-pad",
-                    "Expected only production dependencies to be installed"
-  end
-
   private
     def test_app_path
       File.expand_path("test_app", __dir__)
     end
-
-    def test_app_dev_dependencies
-      package_json = File.expand_path("package.json", test_app_path)
-      JSON.parse(File.read(package_json))["devDependencies"]
-    end
-
-    def installed_node_module_names
-      node_modules_path = File.expand_path("node_modules", test_app_path)
-      Dir.chdir(node_modules_path) { Dir.glob("*") }
-    end
 end

data/test/test_app/app/packs/entrypoints/generated/something.js

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

data/test/test_app/config/webpacker.yml

@@ -3,6 +3,7 @@
 default: &default
   source_path: app/packs
   source_entry_path: entrypoints
+  nested_entries: false
   public_root_path: public
   public_output_path: packs
   cache_path: tmp/webpacker

data/test/test_app/config/webpacker_nested_entries.yml

@@ -0,0 +1,83 @@
+# Note: You must restart bin/webpacker-dev-server for changes to take effect
+
+default: &default
+  source_path: app/packs
+  source_entry_path: entrypoints
+  nested_entries: true
+  public_root_path: public
+  public_output_path: packs
+  cache_path: tmp/webpacker
+  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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shakapacker
 version: !ruby/object:Gem::Version
-  version: 6.3.0.pre.rc.1
+  version: 6.4.1
 platform: ruby
 authors:
 - David Heinemeier Hansson
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-24 00:00:00.000000000 Z
+date: 2022-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -142,6 +142,8 @@ files:
 - docs/customizing_babel_config.md
 - docs/deployment.md
 - docs/developing_webpacker.md
+- docs/react.md
+- docs/sprockets.md
 - docs/style_loader_vs_mini_css.md
 - docs/troubleshooting.md
 - docs/using_esbuild_loader.md
@@ -179,16 +181,20 @@ files:
 - lib/tasks/webpacker/yarn_install.rake
 - lib/tasks/yarn.rake
 - lib/webpacker.rb
+- lib/webpacker/base_strategy.rb
 - lib/webpacker/commands.rb
 - lib/webpacker/compiler.rb
+- lib/webpacker/compiler_strategy.rb
 - lib/webpacker/configuration.rb
 - lib/webpacker/dev_server.rb
 - lib/webpacker/dev_server_proxy.rb
 - lib/webpacker/dev_server_runner.rb
+- lib/webpacker/digest_strategy.rb
 - lib/webpacker/env.rb
 - lib/webpacker/helper.rb
 - lib/webpacker/instance.rb
 - lib/webpacker/manifest.rb
+- lib/webpacker/mtime_strategy.rb
 - lib/webpacker/railtie.rb
 - lib/webpacker/runner.rb
 - lib/webpacker/version.rb
@@ -236,10 +242,12 @@ files:
 - package/utils/helpers.js
 - rakelib/release.rake
 - test/command_test.rb
+- test/compiler_strategy_test.rb
 - test/compiler_test.rb
 - test/configuration_test.rb
 - test/dev_server_runner_test.rb
 - test/dev_server_test.rb
+- test/digest_strategy_test.rb
 - test/engine_rake_tasks_test.rb
 - test/env_test.rb
 - test/fixtures/beta_package.json
@@ -261,9 +269,11 @@ files:
 - test/mounted_app/test/dummy/config/environment.rb
 - test/mounted_app/test/dummy/config/webpacker.yml
 - test/mounted_app/test/dummy/package.json
+- test/mtime_strategy_test.rb
 - test/rake_tasks_test.rb
 - test/test_app/Rakefile
 - test/test_app/app/packs/entrypoints/application.js
+- test/test_app/app/packs/entrypoints/generated/something.js
 - test/test_app/app/packs/entrypoints/multi_entry.css
 - test/test_app/app/packs/entrypoints/multi_entry.js
 - test/test_app/bin/webpacker
@@ -275,6 +285,7 @@ files:
 - test/test_app/config/webpack/webpack.config.js
 - test/test_app/config/webpacker.yml
 - test/test_app/config/webpacker_manifest_path.yml
+- test/test_app/config/webpacker_nested_entries.yml
 - test/test_app/config/webpacker_no_precompile.yml
 - test/test_app/config/webpacker_other_location.yml
 - test/test_app/config/webpacker_public_root.yml
@@ -292,7 +303,7 @@ homepage: https://github.com/shakacode/shakapacker
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/shakacode/shakapacker/tree/v6.3.0-rc.1
+  source_code_uri: https://github.com/shakacode/shakapacker/tree/v6.4.1
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -304,9 +315,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.2.32
 signing_key:
@@ -314,10 +325,12 @@ specification_version: 4
 summary: Use webpack to manage app-like JavaScript modules in Rails
 test_files:
 - test/command_test.rb
+- test/compiler_strategy_test.rb
 - test/compiler_test.rb
 - test/configuration_test.rb
 - test/dev_server_runner_test.rb
 - test/dev_server_test.rb
+- test/digest_strategy_test.rb
 - test/engine_rake_tasks_test.rb
 - test/env_test.rb
 - test/fixtures/beta_package.json
@@ -339,9 +352,11 @@ test_files:
 - test/mounted_app/test/dummy/config/environment.rb
 - test/mounted_app/test/dummy/config/webpacker.yml
 - test/mounted_app/test/dummy/package.json
+- test/mtime_strategy_test.rb
 - test/rake_tasks_test.rb
 - test/test_app/Rakefile
 - test/test_app/app/packs/entrypoints/application.js
+- test/test_app/app/packs/entrypoints/generated/something.js
 - test/test_app/app/packs/entrypoints/multi_entry.css
 - test/test_app/app/packs/entrypoints/multi_entry.js
 - test/test_app/bin/webpacker
@@ -353,6 +368,7 @@ test_files:
 - test/test_app/config/webpack/webpack.config.js
 - test/test_app/config/webpacker.yml
 - test/test_app/config/webpacker_manifest_path.yml
+- test/test_app/config/webpacker_nested_entries.yml
 - test/test_app/config/webpacker_no_precompile.yml
 - test/test_app/config/webpacker_other_location.yml
 - test/test_app/config/webpacker_public_root.yml