shakapacker 6.0.0.rc.6

data/package/rules/coffee.js

@@ -0,0 +1,6 @@
+const { canProcess } = require('../utils/helpers')
+
+module.exports = canProcess('coffee-loader', (resolvedPath) => ({
+  test: /\.coffee(\.erb)?$/,
+  use: [{ loader: resolvedPath }]
+}))

data/package/rules/css.js

@@ -0,0 +1,3 @@
+const getStyleRule = require('../utils/get_style_rule')
+
+module.exports = getStyleRule(/\.(css)$/i)

data/package/rules/erb.js

@@ -0,0 +1,15 @@
+const { canProcess } = require('../utils/helpers')
+
+const runner = /^win/.test(process.platform) ? 'ruby ' : ''
+
+module.exports = canProcess('rails-erb-loader', (resolvedPath) => ({
+  test: /\.erb$/,
+  enforce: 'pre',
+  exclude: /node_modules/,
+  use: [
+    {
+      loader: resolvedPath,
+      options: { runner: `${runner}bin/rails runner` }
+    }
+  ]
+}))

data/package/rules/file.js

@@ -0,0 +1,23 @@
+module.exports = {
+  test: [
+    /\.bmp$/,
+    /\.gif$/,
+    /\.jpe?g$/,
+    /\.png$/,
+    /\.tiff$/,
+    /\.ico$/,
+    /\.avif$/,
+    /\.webp$/,
+    /\.eot$/,
+    /\.otf$/,
+    /\.ttf$/,
+    /\.woff$/,
+    /\.woff2$/,
+    /\.svg$/
+  ],
+  exclude: [/\.(js|mjs|jsx|ts|tsx)$/],
+  type: 'asset/resource',
+  generator: {
+    filename: 'static/[name]-[hash][ext][query]'
+  }
+}

data/package/rules/index.js

@@ -0,0 +1,18 @@
+/* eslint global-require: 0 */
+/* eslint import/no-dynamic-require: 0 */
+
+const rules = {
+  raw: require('./raw'),
+  file: require('./file'),
+  css: require('./css'),
+  sass: require('./sass'),
+  babel: require('./babel'),
+  erb: require('./erb'),
+  coffee: require('./coffee'),
+  less: require('./less'),
+  stylus: require('./stylus')
+}
+
+module.exports = Object.keys(rules)
+  .filter((key) => !!rules[key])
+  .map((key) => rules[key])

data/package/rules/less.js

@@ -0,0 +1,22 @@
+const path = require('path')
+const { canProcess } = require('../utils/helpers')
+const getStyleRule = require('../utils/get_style_rule')
+
+const {
+  additional_paths: paths,
+  source_path: sourcePath
+} = require('../config')
+
+module.exports = canProcess('less-loader', (resolvedPath) =>
+  getStyleRule(/\.(less)(\.erb)?$/i, [
+    {
+      loader: resolvedPath,
+      options: {
+        lessOptions: {
+          paths: [path.resolve(__dirname, 'node_modules'), sourcePath, ...paths]
+        },
+        sourceMap: true
+      }
+    }
+  ])
+)

data/package/rules/raw.js

@@ -0,0 +1,5 @@
+module.exports = {
+  test: [/\.html$/],
+  exclude: [/\.(js|mjs|jsx|ts|tsx)$/],
+  type: 'asset/source'
+}

data/package/rules/sass.js

@@ -0,0 +1,16 @@
+/* eslint global-require: 0 */
+
+const getStyleRule = require('../utils/get_style_rule')
+const { canProcess } = require('../utils/helpers')
+const { additional_paths: includePaths } = require('../config')
+
+module.exports = canProcess('sass-loader', (resolvedPath) =>
+  getStyleRule(/\.(scss|sass)(\.erb)?$/i, [
+    {
+      loader: resolvedPath,
+      options: {
+        sassOptions: { includePaths }
+      }
+    }
+  ])
+)

data/package/rules/stylus.js

@@ -0,0 +1,26 @@
+const path = require('path')
+const { canProcess } = require('../utils/helpers')
+const getStyleRule = require('../utils/get_style_rule')
+
+const {
+  additional_paths: paths,
+  source_path: sourcePath
+} = require('../config')
+
+module.exports = canProcess('stylus-loader', (resolvedPath) =>
+  getStyleRule(/\.(styl(us)?)(\.erb)?$/i, [
+    {
+      loader: resolvedPath,
+      options: {
+        stylusOptions: {
+          include: [
+            path.resolve(__dirname, 'node_modules'),
+            sourcePath,
+            ...paths
+          ]
+        },
+        sourceMap: true
+      }
+    }
+  ])
+)

data/package/utils/get_style_rule.js

@@ -0,0 +1,37 @@
+/* eslint global-require: 0 */
+const { canProcess, moduleExists } = require('./helpers')
+const inliningCss = require('../inliningCss')
+
+const getStyleRule = (test, preprocessors = []) => {
+  if (moduleExists('css-loader')) {
+    const tryPostcss = () =>
+      canProcess('postcss-loader', (loaderPath) => ({
+        loader: loaderPath,
+        options: { sourceMap: true }
+      }))
+
+    // style-loader is required when using css modules with HMR on the webpack-dev-server
+
+    const use = [
+      inliningCss ? 'style-loader' : require('mini-css-extract-plugin').loader,
+      {
+        loader: require.resolve('css-loader'),
+        options: {
+          sourceMap: true,
+          importLoaders: 2
+        }
+      },
+      tryPostcss(),
+      ...preprocessors
+    ].filter(Boolean)
+
+    return {
+      test,
+      use
+    }
+  }
+
+  return null
+}
+
+module.exports = getStyleRule

data/package/utils/helpers.js

@@ -0,0 +1,51 @@
+const isArray = (value) => Array.isArray(value)
+const isBoolean = (str) => /^true/.test(str) || /^false/.test(str)
+const chdirTestApp = () => {
+  try {
+    return process.chdir('test/test_app')
+  } catch (e) {
+    return null
+  }
+}
+
+const chdirCwd = () => process.chdir(process.cwd())
+
+const resetEnv = () => {
+  process.env = {}
+}
+
+const ensureTrailingSlash = (path) => (path.endsWith('/') ? path : `${path}/`)
+
+const resolvedPath = (packageName) => {
+  try {
+    return require.resolve(packageName)
+  } catch (e) {
+    if (e.code !== 'MODULE_NOT_FOUND') {
+      throw e
+    }
+    return null
+  }
+}
+
+const moduleExists = (packageName) => (!!resolvedPath(packageName))
+
+const canProcess = (rule, fn) => {
+  const modulePath = resolvedPath(rule)
+
+  if (modulePath) {
+    return fn(modulePath)
+  }
+
+  return null
+}
+
+module.exports = {
+  chdirTestApp,
+  chdirCwd,
+  isArray,
+  isBoolean,
+  ensureTrailingSlash,
+  canProcess,
+  moduleExists,
+  resetEnv
+}

data/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@shakacode/shakapacker",
+  "version": "6.0.0-rc.6",
+  "description": "Use webpack to manage app-like JavaScript modules in Rails",
+  "main": "package/index.js",
+  "files": [
+    "package",
+    "lib/install/config/webpacker.yml"
+  ],
+  "engines": {
+    "node": "^12.13.0 || ^14 || >=16",
+    "yarn": ">=1 <4"
+  },
+  "peerDependencies": {
+    "@babel/core": "^7.15.5",
+    "@babel/plugin-transform-runtime": "^7.15.0",
+    "@babel/preset-env": "^7.15.6",
+    "@babel/runtime": "^7.15.4",
+    "babel-loader": "^8.2.2",
+    "compression-webpack-plugin": "^9.0.0",
+    "pnp-webpack-plugin": "^1.7.0",
+    "terser-webpack-plugin": "^5.2.4",
+    "webpack": "^5.53.0",
+    "webpack-assets-manifest": "^5.0.6",
+    "webpack-cli": "^4.8.0",
+    "webpack-merge": "^5.8.0"
+  },
+  "dependencies": {
+    "glob": "^7.2.0",
+    "js-yaml": "^4.1.0",
+    "path-complete-extname": "^1.0.0"
+  },
+  "devDependencies": {
+    "babel-loader": "^8.2.2",
+    "compression-webpack-plugin": "^9.0.0",
+    "eslint": "^7.32.0",
+    "eslint-config-airbnb": "^18.2.1",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-import": "^2.24.2",
+    "eslint-plugin-jsx-a11y": "^6.4.1",
+    "eslint-plugin-react": "^7.26.0",
+    "jest": "^27.2.1",
+    "pnp-webpack-plugin": "^1.7.0",
+    "webpack": "^5.53.0",
+    "webpack-assets-manifest": "^5.0.6",
+    "webpack-merge": "^5.8.0"
+  },
+  "jest": {
+    "testRegex": "(/__tests__/.*|(\\.|/))\\.jsx?$",
+    "roots": [
+      "<rootDir>/package"
+    ]
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "test": "jest",
+    "lint": "eslint package/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/shakacode/shakapacker.git"
+  },
+  "author": "David Heinemeier Hansson <david@basecamp.com>, Justin Gordon <justin@shakacode.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/shakacode/shakapacker/issues"
+  },
+  "homepage": "https://github.com/shakacode/shakapacker"
+}

data/rakelib/release.rake

@@ -0,0 +1,57 @@
+require_relative File.join("..", "lib", "shakapacker", "utils", "version_syntax_converter")
+require_relative File.join("..", "lib", "shakapacker", "utils", "git_utils")
+
+class RaisingMessageHandler
+  def add_error(error)
+    raise error
+  end
+end
+
+desc("Releases both the gem and node package using the given version.
+
+IMPORTANT: the gem version must be in valid rubygem format (no dashes).
+It will be automatically converted to a valid yarn semver by the rake task
+for the node package version. This only makes a difference for pre-release
+versions such as `3.0.0.beta.1` (yarn version would be `3.0.0-beta.1`).
+
+This task depends on the gem-release (ruby gem) and release-it (node package)
+which are installed via `bundle install` and `yarn global add release-it`
+
+1st argument: The new version in rubygem format (no dashes). Pass no argument to
+              automatically perform a patch version bump.
+2nd argument: Perform a dry run by passing 'true' as a second argument.
+
+Note, accept defaults for npmjs options. Script will pause to get 2FA tokens.
+
+Example: `rake release[2.1.0,false]`")
+task :release, %i[gem_version dry_run tools_install] do |_t, args|
+  # Check if there are uncommited changes
+  Shakapacker::GitUtils.uncommitted_changes?(RaisingMessageHandler.new)
+  args_hash = args.to_hash
+
+  is_dry_run = Shakapacker::Utils.object_to_boolean(args_hash[:dry_run])
+
+  gem_version = args_hash.fetch(:gem_version, "")
+
+  gem_root = File.expand_path("..", __dir__)
+
+  npm_version = if gem_version.strip.empty?
+                  ""
+                else
+                  Shakapacker::VersionSyntaxConverter.new.rubygem_to_npm(gem_version)
+                end
+
+  # See https://github.com/svenfuchs/gem-release
+  sh_in_dir(gem_root, "git pull --rebase")
+  sh_in_dir(gem_root, "gem bump --no-commit #{gem_version.strip.empty? ? '' : %(--version #{gem_version})}")
+
+  # Will bump the yarn version, commit, tag the commit, push to repo, and release on yarn
+  release_it_command = +"release-it"
+  release_it_command << " #{npm_version}" unless npm_version.strip.empty?
+  release_it_command << " --npm.publish --no-git.requireCleanWorkingDir"
+  release_it_command << " --dry-run --verbose" if is_dry_run
+  sh_in_dir(gem_root, release_it_command)
+
+  # Release the new gem version
+  sh_in_dir(gem_root, "gem release") unless is_dry_run
+end

data/test/command_test.rb

@@ -0,0 +1,109 @@
+require "test_helper"
+
+class CommandTest < Minitest::Test
+  def test_compile_command_returns_success_status_when_stale
+    Webpacker.compiler.stub :stale?, true do
+      Webpacker.compiler.stub :run_webpack, true do
+        assert_equal true, Webpacker.commands.compile
+      end
+    end
+  end
+
+  def test_compile_command_returns_success_status_when_fresh
+    Webpacker.compiler.stub :stale?, false do
+      Webpacker.compiler.stub :run_webpack, true do
+        assert_equal true, Webpacker.commands.compile
+      end
+    end
+  end
+
+  def test_compile_command_returns_failure_status_when_stale
+    Webpacker.compiler.stub :stale?, true do
+      Webpacker.compiler.stub :run_webpack, false do
+        assert_equal false, Webpacker.commands.compile
+      end
+    end
+  end
+
+  def test_clean_command_works_with_nested_hashes_and_without_any_compiled_files
+    File.stub :delete, true do
+      assert Webpacker.commands.clean
+    end
+  end
+end
+
+class ClearCommandVersioningTest < Minitest::Test
+  def setup
+    @now = Time.parse("2021-01-01 12:34:56 UTC")
+    # Test assets to be kept and deleted, path and mtime
+    @prev_files = {
+      # recent versions to be kept with Webpacker.commands.clean(count = 2)
+      "js/application-deadbeef.js" => @now - 4000,
+      "js/common-deadbeee.js" => @now - 4002,
+      "css/common-deadbeed.css" => @now - 4004,
+      "media/images/logo-deadbeeb.css" => @now - 4006,
+      "js/application-1eadbeef.js" => @now - 8000,
+      "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)
+      "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}" }
+    @expired_files = {
+      # old files that are outside count = 2 or age = 3600 and to be deleted
+      "js/application-0eadbeef.js" => @now - 9000,
+      "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}" }
+    @all_files = @prev_files.merge(@expired_files)
+    @dir_glob_stub = Proc.new { |arg|
+      case arg
+      when "#{Webpacker.config.public_output_path}/**/*"
+        @all_files.keys
+      else
+        []
+      end
+    }
+    @file_mtime_stub = Proc.new { |longpath|
+      @all_files[longpath]
+    }
+    @file_delete_mock = Minitest::Mock.new
+    @expired_files.keys.each do |longpath|
+      @file_delete_mock.expect(:delete, 1, [longpath])
+    end
+    @file_delete_stub = Proc.new { |longpath|
+      if @prev_files.has_key?(longpath)
+        flunk "#{longpath} should not be deleted"
+      else
+        @file_delete_mock.delete(longpath)
+      end
+    }
+  end
+
+  def time_and_files_stub(&proc)
+    Time.stub :now, @now do
+      Dir.stub :glob, @dir_glob_stub do
+        File.stub :directory?, false do
+          File.stub :file?, true do
+            File.stub :mtime, @file_mtime_stub do
+              File.stub :delete, @file_delete_stub do
+                yield proc
+              end
+            end
+          end
+        end
+      end
+    end
+    @file_delete_mock.verify
+  end
+
+  def test_clean_command_with_versioned_files
+    time_and_files_stub do
+      assert Webpacker.commands.clean
+    end
+  end
+end

data/test/compiler_test.rb

@@ -0,0 +1,68 @@
+require "test_helper"
+
+class CompilerTest < Minitest::Test
+  def remove_compilation_digest_path
+    Webpacker.compiler.send(:compilation_digest_path).tap do |path|
+      path.delete if path.exist?
+    end
+  end
+
+  def setup
+    remove_compilation_digest_path
+  end
+
+  def teardown
+    remove_compilation_digest_path
+  end
+
+  def test_custom_environment_variables
+    assert_nil Webpacker.compiler.send(:webpack_env)["FOO"]
+    Webpacker.compiler.env["FOO"] = "BAR"
+    assert Webpacker.compiler.send(:webpack_env)["FOO"] == "BAR"
+  ensure
+    Webpacker.compiler.env = {}
+  end
+
+  def test_freshness
+    assert Webpacker.compiler.stale?
+    assert !Webpacker.compiler.fresh?
+  end
+
+  def test_compile
+    assert !Webpacker.compiler.compile
+  end
+
+  def test_freshness_on_compile_success
+    status = OpenStruct.new(success?: true)
+
+    assert Webpacker.compiler.stale?
+    Open3.stub :capture3, [:sterr, :stdout, status] do
+      Webpacker.compiler.compile
+      assert Webpacker.compiler.fresh?
+    end
+  end
+
+  def test_freshness_on_compile_fail
+    status = OpenStruct.new(success?: false)
+
+    assert Webpacker.compiler.stale?
+    Open3.stub :capture3, [:sterr, :stdout, status] do
+      Webpacker.compiler.compile
+      assert Webpacker.compiler.fresh?
+    end
+  end
+
+  def test_compilation_digest_path
+    assert_equal Webpacker.compiler.send(:compilation_digest_path).basename.to_s, "last-compilation-digest-#{Webpacker.env}"
+  end
+
+  def test_external_env_variables
+    assert_nil Webpacker.compiler.send(:webpack_env)["WEBPACKER_ASSET_HOST"]
+    assert_nil Webpacker.compiler.send(:webpack_env)["WEBPACKER_RELATIVE_URL_ROOT"]
+
+    ENV["WEBPACKER_ASSET_HOST"] = "foo.bar"
+    ENV["WEBPACKER_RELATIVE_URL_ROOT"] = "/baz"
+    assert_equal Webpacker.compiler.send(:webpack_env)["WEBPACKER_ASSET_HOST"], "foo.bar"
+    assert_equal Webpacker.compiler.send(:webpack_env)["WEBPACKER_RELATIVE_URL_ROOT"], "/baz"
+  end
+end

data/test/configuration_test.rb

@@ -0,0 +1,78 @@
+require "test_helper"
+
+class ConfigurationTest < Webpacker::Test
+  def setup
+    @config = Webpacker::Configuration.new(
+      root_path: Pathname.new(File.expand_path("test_app", __dir__)),
+      config_path: Pathname.new(File.expand_path("./test_app/config/webpacker.yml", __dir__)),
+      env: "production"
+    )
+  end
+
+  def test_source_path
+    source_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/app/packs").to_s
+    assert_equal source_path, @config.source_path.to_s
+  end
+
+  def test_source_entry_path
+    source_entry_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/app/packs", "entrypoints").to_s
+    assert_equal @config.source_entry_path.to_s, source_entry_path
+  end
+
+  def test_public_root_path
+    public_root_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/public").to_s
+    assert_equal @config.public_path.to_s, public_root_path
+  end
+
+  def test_public_output_path
+    public_output_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/public/packs").to_s
+    assert_equal @config.public_output_path.to_s, public_output_path
+
+    @config = Webpacker::Configuration.new(
+      root_path: @config.root_path,
+      config_path: Pathname.new(File.expand_path("./test_app/config/webpacker_public_root.yml", __dir__)),
+      env: "production"
+    )
+
+    public_output_path = File.expand_path File.join(File.dirname(__FILE__), "public/packs").to_s
+    assert_equal @config.public_output_path.to_s, public_output_path
+  end
+
+  def test_public_manifest_path
+    public_manifest_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/public/packs", "manifest.json").to_s
+    assert_equal @config.public_manifest_path.to_s, public_manifest_path
+  end
+
+  def test_cache_path
+    cache_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/tmp/webpacker").to_s
+    assert_equal @config.cache_path.to_s, cache_path
+  end
+
+  def test_additional_paths
+    assert_equal @config.additional_paths, ["app/assets", "/etc/yarn", "some.config.js", "app/elm"]
+  end
+
+  def test_cache_manifest?
+    assert @config.cache_manifest?
+
+    with_rails_env("development") do
+      refute Webpacker.config.cache_manifest?
+    end
+
+    with_rails_env("test") do
+      refute Webpacker.config.cache_manifest?
+    end
+  end
+
+  def test_compile?
+    refute @config.compile?
+
+    with_rails_env("development") do
+      assert Webpacker.config.compile?
+    end
+
+    with_rails_env("test") do
+      assert Webpacker.config.compile?
+    end
+  end
+end