shakapacker 7.3.0.beta.1 → 8.0.0.rc.2

data/package/webpackDevServerConfig.js

@@ -1,35 +1,38 @@
-const shakapackerDevServerYamlConfig = require('./dev_server')
-const snakeToCamelCase = require('./utils/snakeToCamelCase')
-const { outputPath: contentBase, publicPath } = require('./config')
+const shakapackerDevServerYamlConfig = require("./dev_server")
+const snakeToCamelCase = require("./utils/snakeToCamelCase")
+const { outputPath: contentBase, publicPath } = require("./config")
 
 const webpackDevServerMappedKeys = new Set([
   // client, server, liveReload, devMiddleware are handled separately
-  'allowedHosts',
-  'bonjour',
-  'compress',
-  'headers',
-  'historyApiFallback',
-  'host',
-  'hot',
-  'http2',
-  'https',
-  'ipc',
-  'magicHtml',
-  'onAfterSetupMiddleware',
-  'onBeforeSetupMiddleware',
-  'open',
-  'port',
-  'proxy',
-  'server',
-  'setupExitSignals',
-  'setupMiddlewares',
-  'watchFiles',
-  'webSocketServer'
+  "allowedHosts",
+  "bonjour",
+  "compress",
+  "headers",
+  "historyApiFallback",
+  "host",
+  "hot",
+  "http2",
+  "https",
+  "ipc",
+  "magicHtml",
+  "onAfterSetupMiddleware",
+  "onBeforeSetupMiddleware",
+  "open",
+  "port",
+  "proxy",
+  "server",
+  "setupExitSignals",
+  "setupMiddlewares",
+  "watchFiles",
+  "webSocketServer"
 ])
 
 function createDevServerConfig() {
   const devServerYamlConfig = { ...shakapackerDevServerYamlConfig }
-  const liveReload = devServerYamlConfig.live_reload !== undefined ? devServerYamlConfig.live_reload : !devServerYamlConfig.hmr
+  const liveReload =
+    devServerYamlConfig.live_reload !== undefined
+      ? devServerYamlConfig.live_reload
+      : !devServerYamlConfig.hmr
   delete devServerYamlConfig.live_reload
 
   const config = {

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shakapacker",
-  "version": "7.3.0-beta.1",
+  "version": "8.0.0-rc.2",
   "description": "Use webpack to manage app-like JavaScript modules in Rails",
   "homepage": "https://github.com/shakacode/shakapacker",
   "bugs": {
@@ -19,21 +19,10 @@
     "lib/install/config/shakapacker.yml"
   ],
   "scripts": {
-    "lint": "eslint package/",
+    "lint": "eslint .",
     "test": "jest"
   },
-  "jest": {
-    "roots": [
-      "<rootDir>/package"
-    ],
-    "testPathIgnorePatterns": [
-      "/__fixtures__/",
-      "/__utils__/"
-    ],
-    "testRegex": "(/__tests__/.*|(\\.|/))\\.jsx?$"
-  },
   "dependencies": {
-    "glob": "^7.2.0",
     "js-yaml": "^4.1.0",
     "path-complete-extname": "^1.0.0"
   },
@@ -41,14 +30,18 @@
     "babel-loader": "^8.2.4",
     "compression-webpack-plugin": "^9.0.0",
     "esbuild-loader": "^2.18.0",
-    "eslint": "^7.32.0",
-    "eslint-config-airbnb": "^18.2.1",
-    "eslint-config-prettier": "^8.3.0",
+    "eslint": "^8.0.0",
+    "eslint-config-airbnb": "^19.0.0",
+    "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-import": "^2.24.2",
+    "eslint-plugin-jest": "^27.9.0",
     "eslint-plugin-jsx-a11y": "^6.4.1",
+    "eslint-plugin-prettier": "^5.1.3",
     "eslint-plugin-react": "^7.26.0",
+    "eslint-plugin-react-hooks": "^4.6.0",
     "jest": "^28.1.3",
     "memory-fs": "^0.5.0",
+    "prettier": "^3.2.5",
     "swc-loader": "^0.1.15",
     "thenify": "^3.3.1",
     "webpack": "^5.72.0",
@@ -68,7 +61,7 @@
     "webpack": "^5.72.0",
     "webpack-assets-manifest": "^5.0.6",
     "webpack-cli": "^4.9.2 || ^5.0.0",
-    "webpack-dev-server": "^4.9.0",
+    "webpack-dev-server": "^4.9.0 || ^5.0.0",
     "webpack-merge": "^5.8.0"
   },
   "peerDependenciesMeta": {
@@ -79,8 +72,9 @@
       "optional": true
     }
   },
+  "packageManager": "yarn@1.22.22",
   "engines": {
-    "node": "^12.13.0 || ^14 || >=16",
+    "node": ">= 14",
     "yarn": ">=1 <5"
   },
   "publishConfig": {

data/prettier.config.js

@@ -0,0 +1,4 @@
+module.exports = {
+  semi: false,
+  trailingComma: "none"
+}

data/shakapacker.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
     "source_code_uri" => "https://github.com/shakacode/shakapacker/tree/v#{npm_version}",
   }
 
-  s.required_ruby_version = ">= 2.6.0"
+  s.required_ruby_version = ">= 2.7.0"
 
   s.add_dependency "activesupport", ">= 5.2"
   s.add_dependency "package_json"

data/spec/dummy/app/javascript/packs/application.js

@@ -14,4 +14,4 @@
 // const images = require.context('../images', true)
 // const imagePath = (name) => images(name, true)
 
-console.log('Hello World from Webpacker')
+console.log('Hello World from Shakapacker')

data/spec/dummy/config/application.rb

@@ -19,6 +19,9 @@ require "rails/test_unit/railtie"
 # you've limited to :test, :development, or :production.
 Bundler.require(*Rails.groups)
 
+# Temp patch for dummy specs
+Webpacker = Shakapacker
+
 module TestReactOnRailsV12SsrV2
   class Application < Rails::Application
     # Initialize configuration defaults for originally generated Rails version.

data/spec/dummy/config/initializers/react_on_rails.rb

@@ -24,8 +24,8 @@ ReactOnRails.configure do |config|
   # to automatically refresh your webpack assets on every test run.
   #
   # Alternately, you can remove the `ReactOnRails::TestHelper.configure_rspec_to_compile_assets`
-  # and set the config/webpacker.yml option for test to true.
-  config.build_test_command = "RAILS_ENV=test bin/webpacker"
+  # and set the config/shakapacker.yml option for test to true.
+  config.build_test_command = "RAILS_ENV=test bin/shakapacker"
 
   ################################################################################
   ################################################################################

data/spec/dummy/config/shakapacker.yml

@@ -1,11 +1,11 @@
-# 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/javascript
   source_entry_path: packs
   public_root_path: public
   public_output_path: packs
-  cache_path: tmp/webpacker
+  cache_path: tmp/shakapacker
   webpack_compile_output: true
 
   # Additional paths webpack should lookup modules
@@ -17,12 +17,11 @@ default: &default
 
 development:
   <<: *default
-  # This is false since we're running `bin/webpacker -w` in Procfile.dev-setic
+  # This is false since we're running `bin/shakapacker -w` in Procfile.dev-setic
   compile: false
 
   # Reference: https://webpack.js.org/configuration/dev-server/
   dev_server:
-    https: false
     host: localhost
     port: 3035
     # Hot Module Replacement updates modules while the application is running without a full reload

data/spec/dummy/config/webpack/commonWebpackConfig.js

@@ -1,6 +1,5 @@
 // Common configuration applying to client and server configuration
 
-// const { globalMutableWebpackConfig: baseClientWebpackConfig, merge } = require('shakapacker')
 const { generateWebpackConfig, merge } = require('shakapacker')
 const commonOptions = {
   resolve: {

data/spec/dummy/config/webpack/webpack.config.js

@@ -16,7 +16,7 @@ const webpackConfiguration = envSpecificConfig()
 
 // To debug the webpack configuration
 // 1. Uncomment debugger line below
-// 2. Run `bin/webpacker --debug-webpacker`
+// 2. Run `bin/shakapacker --debug-shakapacker`
 // 3. Examine the webpackConfiguration variable
 // 4. Consider adding a 'debugger` line to the beginning of this file.
 // debugger

data/spec/dummy/package.json

@@ -39,5 +39,6 @@
     "fork-ts-checker-webpack-plugin": "^6.5.2",
     "react-refresh": "^0.14.0",
     "webpack-dev-server": "^4.9.2"
-  }
+  },
+  "packageManager": "yarn@1.22.24"
 }

data/spec/dummy/yarn.lock

@@ -2571,7 +2571,7 @@ glob-to-regexp@^0.4.1:
   resolved "https://registry.yarnpkg.com/glob-to-regexp/-/glob-to-regexp-0.4.1.tgz#c75297087c851b9a578bd217dd59a92f59fe546e"
   integrity sha512-lkX1HJXwyMcprw/5YUZc2s7DrpAiHB21/V+E1rHUrVNokkvB6bqMzT0VfV6/86ZNabt1k14YOIaT7nDvOX3Iiw==
 
-glob@^7.1.3, glob@^7.1.6, glob@^7.2.0:
+glob@^7.1.3, glob@^7.1.6:
   version "7.2.3"
   resolved "https://registry.yarnpkg.com/glob/-/glob-7.2.3.tgz#b8df0fb802bbfa8e89bd1d938b4e16578ed44f2b"
   integrity sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==
@@ -4060,9 +4060,8 @@ setprototypeof@1.2.0:
   integrity sha512-E5LDX7Wrp85Kil5bhZv46j8jOeboKq5JMmYM3gVGdGH8xFpPWXUMsNrlODCrkoxMEeNi/XZIwuRvY4XNwYMJpw==
 
 "shakapacker@file:.yalc/shakapacker":
-  version "7.0.0-rc.0"
+  version "7.2.3"
   dependencies:
-    glob "^7.2.0"
     js-yaml "^4.1.0"
     path-complete-extname "^1.0.0"
 

data/spec/fixtures/github_url_package-lock.v1.json

@@ -102,7 +102,7 @@
     },
     "shakapacker": {
       "version": "github:shakacode/shakapacker#31854a58be49f736f3486a946b72d7e4f334e2b2",
-      "from": "github:shakacode/shakapacker#master",
+      "from": "github:shakacode/shakapacker#main",
       "requires": {
         "glob": "^7.2.0",
         "js-yaml": "^4.1.0",

data/spec/fixtures/github_url_package-lock.v2.json

@@ -9,7 +9,7 @@
       "version": "1.0.0",
       "license": "MIT",
       "dependencies": {
-        "shakapacker": "shakacode/shakapacker#master"
+        "shakapacker": "shakacode/shakapacker#main"
       },
       "devDependencies": {
         "right-pad": "^1.0.1"
@@ -9594,7 +9594,7 @@
     },
     "shakapacker": {
       "version": "git+ssh://git@github.com/shakacode/shakapacker.git#31854a58be49f736f3486a946b72d7e4f334e2b2",
-      "from": "shakapacker@shakacode/shakapacker#master",
+      "from": "shakapacker@shakacode/shakapacker#main",
       "requires": {
         "glob": "^7.2.0",
         "js-yaml": "^4.1.0",

data/spec/fixtures/github_url_package.json

@@ -5,7 +5,7 @@
   "license": "MIT",
   "private": true,
   "dependencies": {
-    "shakapacker": "shakacode/shakapacker#master"
+    "shakapacker": "shakacode/shakapacker#main"
   },
   "devDependencies": {
     "right-pad": "^1.0.1"

data/spec/fixtures/github_url_pnpm-lock.v7.yaml

@@ -2,7 +2,7 @@ lockfileVersion: 5.4
 
 specifiers:
   right-pad: ^1.0.1
-  shakapacker: shakacode/shakapacker#master
+  shakapacker: shakacode/shakapacker#main
 
 dependencies:
   shakapacker: github.com/shakacode/shakapacker/cdf32835d3e0949952b8b4b53063807f714f9b24

data/spec/fixtures/github_url_pnpm-lock.v8.yaml

@@ -6,7 +6,7 @@ settings:
 
 dependencies:
   shakapacker:
-    specifier: shakacode/shakapacker#master
+    specifier: shakacode/shakapacker#main
     version: github.com/shakacode/shakapacker/cdf32835d3e0949952b8b4b53063807f714f9b24(@babel/core@7.22.10)(@babel/plugin-transform-runtime@7.22.10)(@babel/preset-env@7.22.10)(@babel/runtime@7.22.10)(babel-loader@9.1.3)(compression-webpack-plugin@10.0.0)(terser-webpack-plugin@5.3.9)(webpack-assets-manifest@5.1.0)(webpack-cli@5.1.4)(webpack-dev-server@4.15.1)(webpack-merge@5.9.0)(webpack@5.88.2)
 
 devDependencies:

data/spec/fixtures/github_url_yarn.v1.lock

@@ -91,7 +91,7 @@ right-pad@^1.0.1:
   resolved "https://registry.yarnpkg.com/right-pad/-/right-pad-1.0.1.tgz#8ca08c2cbb5b55e74dafa96bf7fd1a27d568c8d0"
   integrity sha512-bYBjgxmkvTAfgIYy328fmkwhp39v8lwVgWhhrzxPV3yHtcSqyYKe9/XOhvW48UFjATg3VuJbpsp5822ACNvkmw==
 
-shakapacker@shakacode/shakapacker#master:
+shakapacker@shakacode/shakapacker#main:
   version "6.5.0"
   resolved "https://codeload.github.com/shakacode/shakapacker/tar.gz/31854a58be49f736f3486a946b72d7e4f334e2b2"
   dependencies:

data/spec/fixtures/github_url_yarn.v2.lock

@@ -124,7 +124,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"shakapacker@shakacode/shakapacker#master":
+"shakapacker@shakacode/shakapacker#main":
   version: 6.5.0
   resolution: "shakapacker@https://github.com/shakacode/shakapacker.git#commit=31854a58be49f736f3486a946b72d7e4f334e2b2"
   dependencies:
@@ -153,7 +153,7 @@ __metadata:
   resolution: "test_app@workspace:."
   dependencies:
     right-pad: ^1.0.1
-    shakapacker: "shakacode/shakapacker#master"
+    shakapacker: "shakacode/shakapacker#main"
   languageName: unknown
   linkType: soft
 

data/spec/generator_specs/e2e_template/template.rb

@@ -1,33 +1,20 @@
 require "shakapacker/utils/misc"
 
-if Shakapacker::Utils::Misc.use_package_json_gem
-  Shakapacker::Utils::Misc.require_package_json_gem
-
-  package_json = PackageJson.new
-
-  # install react
-  package_json.manager.add(["react", "react-dom", "@babel/preset-react"])
-
-  # update webpack presets for react
-  package_json.merge! do |pj|
-    babel = pj.fetch("babel", {})
-
-    babel["presets"] ||= []
-    babel["presets"].unshift("@babel/preset-react")
-
-    { "babel" => babel }
-  end
-else
-  # install react
-  system("yarn add react react-dom @babel/preset-react")
-
-  # update webpack presets for react
-  package_json_path = Rails.root.join("./package.json")
-  insert_into_file(
-    package_json_path,
-    %(      "@babel/preset-react",\n),
-    after: /"presets": \[\n/
-  )
+require "package_json"
+
+package_json = PackageJson.new
+
+# install react
+package_json.manager.add(["react", "react-dom", "@babel/preset-react"])
+
+# update webpack presets for react
+package_json.merge! do |pj|
+  babel = pj.fetch("babel", {})
+
+  babel["presets"] ||= []
+  babel["presets"].unshift("@babel/preset-react")
+
+  { "babel" => babel }
 end
 
 # install rspec-rails

data/spec/generator_specs/generator_spec.rb

@@ -58,10 +58,12 @@ describe "Generator" do
           expect(actual_content).to eq expected_content
         end
 
-        it "replaces package.json with the template file" do
+        it "ensures the 'packageManager' field is set" do
           package_json = PackageJson.read(path_in_the_app)
 
-          expect(package_json.fetch("name", "")).to eq("app")
+          manager_name = fallback_manager.split("_")[0]
+
+          expect(package_json.fetch("packageManager", "")).to match(/#{manager_name}@\d+\.\d+\.\d+/)
         end
 
         it "creates webpack config directory and its files" do
@@ -161,132 +163,6 @@ describe "Generator" do
         end
       end
     end
-
-    context "when not using package_json" do
-      before :all do
-        sh_opts = { fallback_manager: nil }
-
-        sh_in_dir(sh_opts, SPEC_PATH, "cp -r '#{BASE_RAILS_APP_PATH}' '#{TEMP_RAILS_APP_PATH}'")
-
-        Bundler.with_unbundled_env do
-          sh_in_dir(sh_opts, TEMP_RAILS_APP_PATH, "FORCE=true bundle exec rails shakapacker:install")
-        end
-      end
-
-      after :all do
-        Dir.chdir(SPEC_PATH)
-        FileUtils.rm_rf(TEMP_RAILS_APP_PATH)
-      end
-
-      it "creates `config/shakapacker.yml`" do
-        config_file_relative_path = "config/shakapacker.yml"
-        actual_content = read(path_in_the_app(config_file_relative_path))
-        expected_content = read(path_in_the_gem(config_file_relative_path))
-
-        expect(actual_content).to eq expected_content
-      end
-
-      it "replaces package.json with template file" do
-        package_json = PackageJson.read(path_in_the_app)
-
-        expect(package_json.fetch("name", "")).to eq("app")
-      end
-
-      it "creates the webpack config directory and its files" do
-        expected_files = [
-          "webpack.config.js"
-        ]
-
-        Dir.chdir(path_in_the_app("config/webpack")) do
-          existing_files_in_config_webpack_dir = Dir.glob("*")
-          expect(existing_files_in_config_webpack_dir).to eq expected_files
-        end
-      end
-
-      it "adds binstubs" do
-        expected_binstubs = []
-        Dir.chdir(File.join(GEM_ROOT, "lib/install/bin")) do
-          expected_binstubs = Dir.glob("bin/*")
-        end
-
-        Dir.chdir(File.join(TEMP_RAILS_APP_PATH, "bin")) do
-          actual_binstubs = Dir.glob("*")
-
-          expect(actual_binstubs).to include(*expected_binstubs)
-        end
-      end
-
-      it "modifies .gitignore" do
-        actual_content = read(path_in_the_app(".gitignore"))
-
-        expect(actual_content).to match ".yarn-integrity"
-      end
-
-      it 'adds <%= javascript_pack_tag "application" %>' do
-        actual_content = read(path_in_the_app("app/views/layouts/application.html.erb"))
-
-        expect(actual_content).to match '<%= javascript_pack_tag "application" %>'
-      end
-
-      it "updates `bin/setup`" do
-        setup_file_content = read(path_in_the_app("bin/setup"))
-
-        expect(setup_file_content).to match %r(^\s*system!\(['"]bin/yarn['"]\))
-      end
-
-      it "uses the shakapacker version in package.json depending on gem version" do
-        npm_version = Shakapacker::Utils::VersionSyntaxConverter.new.rubygem_to_npm(Shakapacker::VERSION)
-
-        package_json = PackageJson.read(path_in_the_app)
-        actual_version = package_json.fetch("dependencies", {})["shakapacker"]
-
-        expect(actual_version).to eq(npm_version)
-      end
-
-      it "adds Shakapacker peer dependencies to package.json" do
-        package_json = PackageJson.read(path_in_the_app)
-        actual_dependencies = package_json.fetch("dependencies", {}).keys
-
-        expected_dependencies = %w(
-          @babel/core
-          @babel/plugin-transform-runtime
-          @babel/preset-env
-          @babel/runtime
-          babel-loader
-          compression-webpack-plugin
-          terser-webpack-plugin
-          webpack
-          webpack-assets-manifest
-          webpack-cli
-          webpack-merge
-        )
-
-        expect(actual_dependencies).to include(*expected_dependencies)
-      end
-
-      it "adds Shakapacker peer dev dependencies to package.json" do
-        package_json = PackageJson.read(path_in_the_app)
-        actual_dev_dependencies = package_json.fetch("devDependencies", {}).keys
-
-        expected_dev_dependencies = %w(
-          webpack-dev-server
-        )
-
-        expect(actual_dev_dependencies).to include(*expected_dev_dependencies)
-      end
-
-      context "with a basic react app setup" do
-        it "passes the test for rendering react component on the page" do
-          sh_opts = { fallback_manager: nil }
-
-          Bundler.with_unbundled_env do
-            sh_in_dir(sh_opts, TEMP_RAILS_APP_PATH, "./bin/rails app:template LOCATION=../e2e_template/template.rb")
-
-            expect(sh_in_dir(sh_opts, TEMP_RAILS_APP_PATH, "bundle exec rspec")).to be_truthy
-          end
-        end
-      end
-    end
   end
 
   private
@@ -306,14 +182,8 @@ describe "Generator" do
     def sort_out_package_json(opts)
       ENV["PATH"] = "#{SPEC_PATH}/fake-bin:#{ENV["PATH"]}"
 
-      if opts[:fallback_manager].nil?
-        ENV["SHAKAPACKER_EXPECTED_PACKAGE_MANGER"] = "yarn_classic"
-        ENV["SHAKAPACKER_USE_PACKAGE_JSON_GEM"] = "false"
-      else
-        ENV["SHAKAPACKER_EXPECTED_PACKAGE_MANGER"] = opts[:fallback_manager]
-        ENV["SHAKAPACKER_USE_PACKAGE_JSON_GEM"] = "true"
-        ENV["PACKAGE_JSON_FALLBACK_MANAGER"] = opts[:fallback_manager]
-      end
+      ENV["SHAKAPACKER_EXPECTED_PACKAGE_MANGER"] = opts[:fallback_manager]
+      ENV["PACKAGE_JSON_FALLBACK_MANAGER"] = opts[:fallback_manager]
     end
 
     def sh_in_dir(opts, dir, *shell_commands)

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

@@ -36,7 +36,6 @@ development:
 
   # Reference: https://webpack.js.org/configuration/dev-server/
   dev_server:
-    https: false
     host: localhost
     port: 3035
     public: localhost:3035

data/spec/shakapacker/compiler_spec.rb

@@ -1,4 +1,5 @@
 require_relative "spec_helper_initializer"
+require "ostruct"
 
 describe "Shakapacker::Compiler" do
   it "accepts custom environment variables" do
@@ -48,12 +49,9 @@ describe "Shakapacker::Compiler" do
 
   it "accepts external env variables" do
     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
 
     allow(ENV).to receive(:fetch).with("SHAKAPACKER_ASSET_HOST", nil).and_return("foo.bar")
-    allow(ENV).to receive(:fetch).with("SHAKAPACKER_RELATIVE_URL_ROOT", nil).and_return("/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