Only set $BUNDLER_VERSION when needed (Bundler 1, Ruby >= 2.7)

* So the mapping to `engine-version` versions is clearer.

README.md

@@ -14,9 +14,9 @@ This action currently supports these versions of MRI, JRuby and TruffleRuby:
 
 | Interpreter | Versions |
 | ----------- | -------- |
-| Ruby | 2.1.9, 2.2, 2.3.0 - 2.3.8, 2.4.0 - 2.4.10, 2.5.0 - 2.5.8, 2.6.0 - 2.6.6, 2.7.2, head, debug, mingw, mswin |
-| JRuby | 9.1.17.0, 9.2.9.0 - 9.2.13.0, head |
-| TruffleRuby | 19.3.0 - 20.3.0, head |
+| `ruby` | 2.1.9, 2.2, 2.3.0 - 2.3.8, 2.4.0 - 2.4.10, 2.5.0 - 2.5.8, 2.6.0 - 2.6.6, 2.7.2, head, debug, mingw, mswin |
+| `jruby` | 9.1.17.0, 9.2.9.0 - 9.2.13.0, head |
+| `truffleruby` | 19.3.0 - 20.3.0, head |
 
 `ruby-debug` is the same as `ruby-head` but with assertions enabled (`-DRUBY_DEBUG=1`).  
 On Windows, `mingw` and `mswin` are `ruby-head` builds using the MSYS2/MinGW and the MSVC toolchains respectively.

common.js

@@ -40,6 +40,25 @@ export function isStableVersion(rubyVersion) {
   return /^\d+(\.\d+)*$/.test(rubyVersion)
 }
 
+export function isBundler2Default(engine, rubyVersion) {
+  if (engine === 'ruby') {
+    return isHeadVersion(rubyVersion) || floatVersion(rubyVersion) >= 2.7
+  } else if (engine === 'truffleruby') {
+    return isHeadVersion(rubyVersion)
+  } else {
+    return false
+  }
+}
+
+export function floatVersion(rubyVersion) {
+  const match = rubyVersion.match(/^\d+\.\d+/)
+  if (match) {
+    return parseFloat(match[0])
+  } else {
+    return 0.0
+  }
+}
+
 export async function hashFile(file) {
   // See https://github.com/actions/runner/blob/master/src/Misc/expressionFunc/hashFiles/src/hashFiles.ts
   const hash = crypto.createHash('sha256')

dist/index.js

@@ -27744,7 +27744,7 @@ async function downloadAndExtract(engine, version, url, base, rubyPrefix) {
   })
 
   await common.measure('Extracting Ruby', async () =>
-      exec.exec('7z', ['x', downloadPath, `-xr!${base}\\share\\doc`, `-o${parentDir}`], {silent: true}))
+    exec.exec('7z', ['x', downloadPath, `-xr!${base}\\share\\doc`, `-o${parentDir}`], { silent: true }))
 
   if (base !== path.basename(rubyPrefix)) {
     await io.mv(path.join(parentDir, base), rubyPrefix)
@@ -32114,6 +32114,8 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "measure", function() { return measure; });
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "isHeadVersion", function() { return isHeadVersion; });
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "isStableVersion", function() { return isStableVersion; });
+/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "isBundler2Default", function() { return isBundler2Default; });
+/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "floatVersion", function() { return floatVersion; });
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "hashFile", function() { return hashFile; });
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "getVirtualEnvironmentName", function() { return getVirtualEnvironmentName; });
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "shouldUseToolCache", function() { return shouldUseToolCache; });
@@ -32163,6 +32165,25 @@ function isStableVersion(rubyVersion) {
   return /^\d+(\.\d+)*$/.test(rubyVersion)
 }
 
+function isBundler2Default(engine, rubyVersion) {
+  if (engine === 'ruby') {
+    return isHeadVersion(rubyVersion) || floatVersion(rubyVersion) >= 2.7
+  } else if (engine === 'truffleruby') {
+    return isHeadVersion(rubyVersion)
+  } else {
+    return false
+  }
+}
+
+function floatVersion(rubyVersion) {
+  const match = rubyVersion.match(/^\d+\.\d+/)
+  if (match) {
+    return parseFloat(match[0])
+  } else {
+    return 0.0
+  }
+}
+
 async function hashFile(file) {
   // See https://github.com/actions/runner/blob/master/src/Misc/expressionFunc/hashFiles/src/hashFiles.ts
   const hash = crypto.createHash('sha256')
@@ -44562,7 +44583,7 @@ function getVersions(platform) {
       "2.5.0", "2.5.1", "2.5.2", "2.5.3", "2.5.4", "2.5.5", "2.5.6", "2.5.7", "2.5.8",
       "2.6.0", "2.6.1", "2.6.2", "2.6.3", "2.6.4", "2.6.5", "2.6.6",
       "2.7.0", "2.7.1", "2.7.2",
-      "3.0.0-preview1",
+      "3.0.0-preview1", "3.0.0-preview2",
       "head", "debug",
     ],
     "jruby": [
@@ -51257,12 +51278,12 @@ async function setupRuby(options = {}) {
   if (inputs['bundler'] !== 'none') {
     const [gemfile, lockFile] = detectGemfiles()
 
-    await common.measure('Installing Bundler', async () =>
+    const bundlerVersion = await common.measure('Installing Bundler', async () =>
       installBundler(inputs['bundler'], lockFile, platform, rubyPrefix, engine, version))
 
     if (inputs['bundler-cache'] === 'true') {
       await common.measure('bundle install', async () =>
-          bundleInstall(gemfile, lockFile, platform, engine, version))
+          bundleInstall(gemfile, lockFile, platform, engine, version, bundlerVersion))
     }
   }
 
@@ -51416,7 +51437,7 @@ async function installBundler(bundlerVersionInput, lockFile, platform, rubyPrefi
     bundlerVersion = '1'
   }
 
-  if ((engine === 'ruby' || engine === 'truffleruby') && common.isHeadVersion(rubyVersion) && bundlerVersion === '2') {
+  if (common.isHeadVersion(rubyVersion) && common.isBundler2Default(engine, rubyVersion) && bundlerVersion === '2') {
     console.log(`Using Bundler 2 shipped with ${engine}-${rubyVersion}`)
   } else if (engine === 'truffleruby' && !common.isHeadVersion(rubyVersion) && bundlerVersion === '1') {
     console.log(`Using Bundler 1 shipped with ${engine}`)
@@ -51425,31 +51446,39 @@ async function installBundler(bundlerVersionInput, lockFile, platform, rubyPrefi
     await exec.exec(gem, ['install', 'bundler', '-v', `~> ${bundlerVersion}`, '--no-document'])
   }
 
-  core.exportVariable('BUNDLER_VERSION', bundlerVersion)
+  return bundlerVersion
 }
 
-async function bundleInstall(gemfile, lockFile, platform, engine, version) {
+async function bundleInstall(gemfile, lockFile, platform, engine, rubyVersion, bundlerVersion) {
   if (gemfile === null) {
     console.log('Could not determine gemfile path, skipping "bundle install" and caching')
     return false
   }
 
+  let envOptions = {}
+  if (bundlerVersion.startsWith('1') && common.isBundler2Default(engine, rubyVersion)) {
+    // If Bundler 1 is specified on Rubies which ship with Bundler 2,
+    // we need to specify which Bundler version to use explicitly until the lockfile exists.
+    console.log(`Setting BUNDLER_VERSION=${bundlerVersion} for "bundle config|lock" commands below to ensure Bundler 1 is used`)
+    envOptions = { env: { ...process.env, BUNDLER_VERSION: bundlerVersion } }
+  }
+
   // config
   const path = 'vendor/bundle'
 
-  await exec.exec('bundle', ['config', '--local', 'path', path])
+  await exec.exec('bundle', ['config', '--local', 'path', path], envOptions)
 
   if (fs.existsSync(lockFile)) {
-    await exec.exec('bundle', ['config', '--local', 'deployment', 'true'])
+    await exec.exec('bundle', ['config', '--local', 'deployment', 'true'], envOptions)
   } else {
     // Generate the lockfile so we can use it to compute the cache key.
     // This will also automatically pick up the latest gem versions compatible with the Gemfile.
-    await exec.exec('bundle', ['lock'])
+    await exec.exec('bundle', ['lock'], envOptions)
   }
 
   // cache key
   const paths = [path]
-  const baseKey = await computeBaseKey(platform, engine, version, lockFile)
+  const baseKey = await computeBaseKey(platform, engine, rubyVersion, lockFile)
   const key = `${baseKey}-${await common.hashFile(lockFile)}`
   // If only Gemfile.lock changes we can reuse part of the cache, and clean old gem versions below
   const restoreKeys = [`${baseKey}-`]

index.js

@@ -63,12 +63,12 @@ export async function setupRuby(options = {}) {
   if (inputs['bundler'] !== 'none') {
     const [gemfile, lockFile] = detectGemfiles()
 
-    await common.measure('Installing Bundler', async () =>
+    const bundlerVersion = await common.measure('Installing Bundler', async () =>
       installBundler(inputs['bundler'], lockFile, platform, rubyPrefix, engine, version))
 
     if (inputs['bundler-cache'] === 'true') {
       await common.measure('bundle install', async () =>
-          bundleInstall(gemfile, lockFile, platform, engine, version))
+          bundleInstall(gemfile, lockFile, platform, engine, version, bundlerVersion))
     }
   }
 
@@ -222,7 +222,7 @@ async function installBundler(bundlerVersionInput, lockFile, platform, rubyPrefi
     bundlerVersion = '1'
   }
 
-  if ((engine === 'ruby' || engine === 'truffleruby') && common.isHeadVersion(rubyVersion) && bundlerVersion === '2') {
+  if (common.isHeadVersion(rubyVersion) && common.isBundler2Default(engine, rubyVersion) && bundlerVersion === '2') {
     console.log(`Using Bundler 2 shipped with ${engine}-${rubyVersion}`)
   } else if (engine === 'truffleruby' && !common.isHeadVersion(rubyVersion) && bundlerVersion === '1') {
     console.log(`Using Bundler 1 shipped with ${engine}`)
@@ -231,31 +231,39 @@ async function installBundler(bundlerVersionInput, lockFile, platform, rubyPrefi
     await exec.exec(gem, ['install', 'bundler', '-v', `~> ${bundlerVersion}`, '--no-document'])
   }
 
-  core.exportVariable('BUNDLER_VERSION', bundlerVersion)
+  return bundlerVersion
 }
 
-async function bundleInstall(gemfile, lockFile, platform, engine, version) {
+async function bundleInstall(gemfile, lockFile, platform, engine, rubyVersion, bundlerVersion) {
   if (gemfile === null) {
     console.log('Could not determine gemfile path, skipping "bundle install" and caching')
     return false
   }
 
+  let envOptions = {}
+  if (bundlerVersion.startsWith('1') && common.isBundler2Default(engine, rubyVersion)) {
+    // If Bundler 1 is specified on Rubies which ship with Bundler 2,
+    // we need to specify which Bundler version to use explicitly until the lockfile exists.
+    console.log(`Setting BUNDLER_VERSION=${bundlerVersion} for "bundle config|lock" commands below to ensure Bundler 1 is used`)
+    envOptions = { env: { ...process.env, BUNDLER_VERSION: bundlerVersion } }
+  }
+
   // config
   const path = 'vendor/bundle'
 
-  await exec.exec('bundle', ['config', '--local', 'path', path])
+  await exec.exec('bundle', ['config', '--local', 'path', path], envOptions)
 
   if (fs.existsSync(lockFile)) {
-    await exec.exec('bundle', ['config', '--local', 'deployment', 'true'])
+    await exec.exec('bundle', ['config', '--local', 'deployment', 'true'], envOptions)
   } else {
     // Generate the lockfile so we can use it to compute the cache key.
     // This will also automatically pick up the latest gem versions compatible with the Gemfile.
-    await exec.exec('bundle', ['lock'])
+    await exec.exec('bundle', ['lock'], envOptions)
   }
 
   // cache key
   const paths = [path]
-  const baseKey = await computeBaseKey(platform, engine, version, lockFile)
+  const baseKey = await computeBaseKey(platform, engine, rubyVersion, lockFile)
   const key = `${baseKey}-${await common.hashFile(lockFile)}`
   // If only Gemfile.lock changes we can reuse part of the cache, and clean old gem versions below
   const restoreKeys = [`${baseKey}-`]

ruby-builder-versions.js

@@ -8,7 +8,7 @@ export function getVersions(platform) {
       "2.5.0", "2.5.1", "2.5.2", "2.5.3", "2.5.4", "2.5.5", "2.5.6", "2.5.7", "2.5.8",
       "2.6.0", "2.6.1", "2.6.2", "2.6.3", "2.6.4", "2.6.5", "2.6.6",
       "2.7.0", "2.7.1", "2.7.2",
-      "3.0.0-preview1",
+      "3.0.0-preview1", "3.0.0-preview2",
       "head", "debug",
     ],
     "jruby": [

windows.js

@@ -68,7 +68,7 @@ async function downloadAndExtract(engine, version, url, base, rubyPrefix) {
   })
 
   await common.measure('Extracting Ruby', async () =>
-      exec.exec('7z', ['x', downloadPath, `-xr!${base}\\share\\doc`, `-o${parentDir}`], {silent: true}))
+    exec.exec('7z', ['x', downloadPath, `-xr!${base}\\share\\doc`, `-o${parentDir}`], { silent: true }))
 
   if (base !== path.basename(rubyPrefix)) {
     await io.mv(path.join(parentDir, base), rubyPrefix)