Bundler 2 is shipped with truffleruby-head now

https://www.ruby-lang.org/en/news/2020/04/05/support-of-ruby-2-4-has-ended/

.github/workflows/test.yml

@@ -19,7 +19,6 @@ jobs:
         # Use various version syntax here for testing
         ruby: [ 2.1, 2.2, 2.3, 2.4, 2.5, 2.6.6, 2.7, ruby-head, debug, jruby-9.1, jruby, jruby-head, truffleruby, truffleruby-head ]
         include:
-        - { os: ubuntu-18.04, ruby: rubinius }
         - { os: windows-2016, ruby: mingw }
         - { os: windows-2019, ruby: mingw }
         - { os: windows-2019, ruby: mswin }

README.md

@@ -17,18 +17,20 @@ This action currently supports these versions of MRI, JRuby and TruffleRuby:
 | 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.2.0, head |
-| Rubinius | 4.14 |
 
 `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.
 
+Preview and RC versions of Ruby might be available too on Ubuntu and macOS (not on Windows).
+However, it is recommended to test against `ruby-head` rather than previews,
+as it provides more useful feedback for the Ruby core team and for upcoming changes.
+
 Only versions published by [RubyInstaller](https://rubyinstaller.org/downloads/archives/) are available on Windows.
 Due to that, Ruby 2.2 resolves to 2.2.6 on Windows and 2.2.10 on other platforms.
 And Ruby 2.3 on Windows only has builds for 2.3.0, 2.3.1 and 2.3.3.
 
-Note that Ruby ≤ 2.3 and the OpenSSL version it needs (1.0.2) are both end-of-life,
-which means Ruby ≤ 2.3 is unmaintained and considered insecure.
-On Windows, Ruby 2.4 uses OpenSSL 1.0.2, which is no longer maintained.
+Note that Ruby ≤ 2.4 and the OpenSSL version it needs (1.0.2) are both end-of-life,
+which means Ruby ≤ 2.4 is unmaintained and considered insecure.
 
 ### Supported Platforms
 
@@ -40,8 +42,6 @@ The action works for all [GitHub-hosted runners](https://help.github.com/en/acti
 | macOS   | `macos-latest`   (= `macos-10.15`)  | |
 | Windows | `windows-latest` (= `windows-2019`) | `windows-2016` |
 
-Rubinius is only available on `ubuntu-18.04`.
-
 The prebuilt releases are generated by [ruby-builder](https://github.com/ruby/ruby-builder)
 and on Windows by [RubyInstaller2](https://github.com/oneclick/rubyinstaller2).
 `mingw` and `mswin` builds are generated by [ruby-loco](https://github.com/MSP-Greg/ruby-loco).
@@ -203,6 +203,9 @@ if the [virtual environment](https://github.com/actions/virtual-environments) is
 * Make sure to use the same operating system and version.
 * Make sure to use the same version of libssl.
 * Make sure that the operating system has `libyaml-0` installed
+* The environment variable `RUNNER_TOOL_CACHE` must be set to same value as on GitHub-hosted runners
+  (`/opt/hostedtoolcache` on Linux, `/Users/runner/hostedtoolcache` on macOS, `C:\hostedtoolcache\windows` on Windows).
+* That directory must be writable by the `runner` user.
 * The runner software is running as user `runner` with a home directory of `/home/runner`, or you have created a symlink for the home directory of whatever user that the runner is running as to `/home/runner`.
 
 In other cases, please use a system Ruby or [install Ruby manually](https://github.com/postmodern/chruby/wiki#installing-rubies) instead.

common.js

@@ -59,6 +59,18 @@ function findUbuntuVersion() {
   }
 }
 
+export function shouldExtractInToolCache(engine, version) {
+  return engine === 'ruby' && !isHeadVersion(version)
+}
+
+export function getToolCacheRubyPrefix(version) {
+  const toolCache = process.env['RUNNER_TOOL_CACHE']
+  if (!toolCache) {
+    throw new Error('$RUNNER_TOOL_CACHE must be set')
+  }
+  return path.join(toolCache, 'Ruby', version, 'x64')
+}
+
 // convert windows path like C:\Users\runneradmin to /c/Users/runneradmin
 export function win2nix(path) {
   if (/^[A-Z]:/i.test(path)) {

dist/index.js

@@ -27682,6 +27682,7 @@ const path = __webpack_require__(622)
 const cp = __webpack_require__(129)
 const core = __webpack_require__(186)
 const exec = __webpack_require__(514)
+const io = __webpack_require__(436)
 const tc = __webpack_require__(188)
 const common = __webpack_require__(390)
 const rubyInstallerVersions = __webpack_require__(223).versions
@@ -27711,7 +27712,13 @@ async function install(platform, engine, version) {
   }
   const base = url.slice(url.lastIndexOf('/') + 1, url.length - '.7z'.length)
 
-  const rubyPrefix = `${drive}:\\${base}`
+  let rubyPrefix
+  if (common.shouldExtractInToolCache(engine, version)) {
+    rubyPrefix = common.getToolCacheRubyPrefix(version)
+  } else {
+    rubyPrefix = `${drive}:\\${base}`
+  }
+  const parentDir = path.dirname(rubyPrefix)
 
   let toolchainPaths = (version === 'mswin') ? await setupMSWin() : await setupMingw(version)
 
@@ -27723,7 +27730,11 @@ async function install(platform, engine, version) {
   })
 
   await common.measure('Extracting Ruby', async () =>
-    exec.exec('7z', ['x', downloadPath, `-xr!${base}\\share\\doc`, `-o${drive}:\\`], { 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)
+  }
 
   return rubyPrefix
 }
@@ -32087,6 +32098,8 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "isHeadVersion", function() { return isHeadVersion; });
 /* 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__, "shouldExtractInToolCache", function() { return shouldExtractInToolCache; });
+/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "getToolCacheRubyPrefix", function() { return getToolCacheRubyPrefix; });
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "win2nix", function() { return win2nix; });
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "setupPath", function() { return setupPath; });
 const os = __webpack_require__(87)
@@ -32150,6 +32163,18 @@ function findUbuntuVersion() {
   }
 }
 
+function shouldExtractInToolCache(engine, version) {
+  return engine === 'ruby' && !isHeadVersion(version)
+}
+
+function getToolCacheRubyPrefix(version) {
+  const toolCache = process.env['RUNNER_TOOL_CACHE']
+  if (!toolCache) {
+    throw new Error('$RUNNER_TOOL_CACHE must be set')
+  }
+  return path.join(toolCache, 'Ruby', version, 'x64')
+}
+
 // convert windows path like C:\Users\runneradmin to /c/Users/runneradmin
 function win2nix(path) {
   if (/^[A-Z]:/i.test(path)) {
@@ -44485,6 +44510,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",
       "head", "debug",
     ],
     "jruby": [
@@ -44499,12 +44525,6 @@ function getVersions(platform) {
     ]
   }
 
-  if (platform === 'ubuntu-18.04') {
-    versions['rubinius'] = [
-      "4.14"
-    ]
-  }
-
   return versions
 }
 
@@ -51161,7 +51181,7 @@ async function setupRuby(options = {}) {
   const [engine, parsedVersion] = parseRubyEngineAndVersion(inputs['ruby-version'])
 
   let installer
-  if (platform === 'windows-latest' && engine !== 'jruby') {
+  if (platform.startsWith('windows-') && engine === 'ruby') {
     installer = __webpack_require__(216)
   } else {
     installer = __webpack_require__(974)
@@ -51248,7 +51268,7 @@ function parseRubyEngineAndVersion(rubyVersion) {
     version = rubyVersion
   } else if (!rubyVersion.includes('-')) { // myruby -> myruby-stableVersion
     engine = rubyVersion
-    version = '' // Let the logic below find the version
+    version = '' // Let the logic in validateRubyEngineAndVersion() find the version
   } else { // engine-X.Y.Z
     [engine, version] = rubyVersion.split('-', 2)
   }
@@ -51317,7 +51337,7 @@ function readBundledWithFromGemfileLock(lockFile) {
 }
 
 async function installBundler(bundlerVersionInput, lockFile, platform, rubyPrefix, engine, rubyVersion) {
-  var bundlerVersion = bundlerVersionInput
+  let bundlerVersion = bundlerVersionInput
 
   if (bundlerVersion === 'default' || bundlerVersion === 'Gemfile.lock') {
     bundlerVersion = readBundledWithFromGemfileLock(lockFile)
@@ -51345,12 +51365,10 @@ async function installBundler(bundlerVersionInput, lockFile, platform, rubyPrefi
     bundlerVersion = '1'
   }
 
-  if (engine === 'ruby' && common.isHeadVersion(rubyVersion) && bundlerVersion === '2') {
+  if ((engine === 'ruby' || engine === 'truffleruby') && common.isHeadVersion(rubyVersion) && bundlerVersion === '2') {
     console.log(`Using Bundler 2 shipped with ${engine}-${rubyVersion}`)
-  } else if (engine === 'truffleruby' && bundlerVersion === '1') {
+  } else if (engine === 'truffleruby' && !common.isHeadVersion(rubyVersion) && bundlerVersion === '1') {
     console.log(`Using Bundler 1 shipped with ${engine}`)
-  } else if (engine === 'rubinius') {
-    console.log(`Rubinius only supports the version of Bundler shipped with it`)
   } else {
     const gem = path.join(rubyPrefix, 'bin', 'gem')
     await exec.exec(gem, ['install', 'bundler', '-v', `~> ${bundlerVersion}`, '--no-document'])
@@ -51373,12 +51391,12 @@ async function bundleInstall(gemfile, lockFile, platform, engine, version) {
 
   // cache key
   const paths = [path]
-  const baseKey = await computeBaseKey(platform, engine, version)
+  const baseKey = await computeBaseKey(platform, engine, version, gemfile)
   let key = baseKey
   let restoreKeys
   if (lockFile !== null) {
     key += `-${lockFile}-${await common.hashFile(lockFile)}`
-    // If only Gemfile.lock we can reuse some of the cache (but it will keep old gem versions in the cache)
+    // If only Gemfile.lock changes we can reuse part of the cache (but it will keep old gem versions in the cache)
     restoreKeys = [`${baseKey}-${lockFile}-`]
   } else {
     // Only exact key, to never mix native gems of different platforms or Ruby versions
@@ -51429,8 +51447,8 @@ async function bundleInstall(gemfile, lockFile, platform, engine, version) {
   return true
 }
 
-async function computeBaseKey(platform, engine, version) {
-  let baseKey = `setup-ruby-bundle-install-${platform}-${engine}-${version}`
+async function computeBaseKey(platform, engine, version, gemfile) {
+  let baseKey = `setup-ruby-toolcache-bundle-install-${platform}-${engine}-${version}-${gemfile}`
   if (engine !== 'jruby' && common.isHeadVersion(version)) {
     let revision = '';
     await exec.exec('ruby', ['-e', 'print RUBY_REVISION'], {
@@ -52867,7 +52885,7 @@ const tc = __webpack_require__(188)
 const common = __webpack_require__(390)
 const rubyBuilderVersions = __webpack_require__(694)
 
-const builderReleaseTag = 'enable-shared'
+const builderReleaseTag = 'toolcache'
 const releasesURL = 'https://github.com/ruby/ruby-builder/releases'
 
 const windows = common.windows
@@ -52881,19 +52899,22 @@ async function install(platform, engine, version) {
 }
 
 async function downloadAndExtract(platform, engine, version) {
-  const rubiesDir = windows ? `${common.drive}:` : path.join(os.homedir(), '.rubies')
-
-  const rubyPrefix = path.join(rubiesDir, `${engine}-${version}`)
-
-  // Set the PATH now, so the MSYS2 'tar' is in Path on Windows
-  if (engine === 'rubinius') {
-    core.warning('Rubinius builds will no longer be provided, see https://github.com/ruby/setup-ruby/issues/101')
-    common.setupPath([path.join(rubyPrefix, 'bin'), path.join(rubyPrefix, 'gems', 'bin')])
+  let rubyPrefix
+  if (common.shouldExtractInToolCache(engine, version)) {
+    rubyPrefix = common.getToolCacheRubyPrefix(version)
+  } else if (windows) {
+    rubyPrefix = path.join(`${common.drive}:`, `${engine}-${version}`)
   } else {
-    common.setupPath([path.join(rubyPrefix, 'bin')])
+    rubyPrefix = path.join(os.homedir(), '.rubies', `${engine}-${version}`)
   }
 
-  await io.mkdirP(rubiesDir)
+  const parentDir = path.dirname(rubyPrefix)
+
+  // Set the PATH now, so the MSYS2 'tar' is in Path on Windows
+  common.setupPath([path.join(rubyPrefix, 'bin')])
+
+  await io.rmRF(rubyPrefix)
+  await io.mkdirP(parentDir)
 
   const downloadPath = await common.measure('Downloading Ruby', async () => {
     const url = getDownloadURL(platform, engine, version)
@@ -52904,9 +52925,9 @@ async function downloadAndExtract(platform, engine, version) {
   await common.measure('Extracting Ruby', async () => {
     if (windows) {
       // Windows 2016 doesn't have system tar, use MSYS2's, it needs unix style paths
-      await exec.exec('tar', [ '-xz', '-C', common.win2nix(rubiesDir), '-f', common.win2nix(downloadPath) ])
+      await exec.exec('tar', [ '-xz', '-C', common.win2nix(parentDir), '-f', common.win2nix(downloadPath) ])
     } else {
-      await exec.exec('tar', [ '-xz', '-C', rubiesDir, '-f',  downloadPath ])
+      await exec.exec('tar', [ '-xz', '-C', parentDir, '-f',  downloadPath ])
     }
   })
 

index.js

@@ -39,7 +39,7 @@ export async function setupRuby(options = {}) {
   const [engine, parsedVersion] = parseRubyEngineAndVersion(inputs['ruby-version'])
 
   let installer
-  if (platform === 'windows-latest' && engine !== 'jruby') {
+  if (platform.startsWith('windows-') && engine === 'ruby') {
     installer = require('./windows')
   } else {
     installer = require('./ruby-builder')
@@ -126,7 +126,7 @@ function parseRubyEngineAndVersion(rubyVersion) {
     version = rubyVersion
   } else if (!rubyVersion.includes('-')) { // myruby -> myruby-stableVersion
     engine = rubyVersion
-    version = '' // Let the logic below find the version
+    version = '' // Let the logic in validateRubyEngineAndVersion() find the version
   } else { // engine-X.Y.Z
     [engine, version] = rubyVersion.split('-', 2)
   }
@@ -195,7 +195,7 @@ function readBundledWithFromGemfileLock(lockFile) {
 }
 
 async function installBundler(bundlerVersionInput, lockFile, platform, rubyPrefix, engine, rubyVersion) {
-  var bundlerVersion = bundlerVersionInput
+  let bundlerVersion = bundlerVersionInput
 
   if (bundlerVersion === 'default' || bundlerVersion === 'Gemfile.lock') {
     bundlerVersion = readBundledWithFromGemfileLock(lockFile)
@@ -223,12 +223,10 @@ async function installBundler(bundlerVersionInput, lockFile, platform, rubyPrefi
     bundlerVersion = '1'
   }
 
-  if (engine === 'ruby' && common.isHeadVersion(rubyVersion) && bundlerVersion === '2') {
+  if ((engine === 'ruby' || engine === 'truffleruby') && common.isHeadVersion(rubyVersion) && bundlerVersion === '2') {
     console.log(`Using Bundler 2 shipped with ${engine}-${rubyVersion}`)
-  } else if (engine === 'truffleruby' && bundlerVersion === '1') {
+  } else if (engine === 'truffleruby' && !common.isHeadVersion(rubyVersion) && bundlerVersion === '1') {
     console.log(`Using Bundler 1 shipped with ${engine}`)
-  } else if (engine === 'rubinius') {
-    console.log(`Rubinius only supports the version of Bundler shipped with it`)
   } else {
     const gem = path.join(rubyPrefix, 'bin', 'gem')
     await exec.exec(gem, ['install', 'bundler', '-v', `~> ${bundlerVersion}`, '--no-document'])
@@ -251,12 +249,12 @@ async function bundleInstall(gemfile, lockFile, platform, engine, version) {
 
   // cache key
   const paths = [path]
-  const baseKey = await computeBaseKey(platform, engine, version)
+  const baseKey = await computeBaseKey(platform, engine, version, gemfile)
   let key = baseKey
   let restoreKeys
   if (lockFile !== null) {
     key += `-${lockFile}-${await common.hashFile(lockFile)}`
-    // If only Gemfile.lock we can reuse some of the cache (but it will keep old gem versions in the cache)
+    // If only Gemfile.lock changes we can reuse part of the cache (but it will keep old gem versions in the cache)
     restoreKeys = [`${baseKey}-${lockFile}-`]
   } else {
     // Only exact key, to never mix native gems of different platforms or Ruby versions
@@ -307,8 +305,8 @@ async function bundleInstall(gemfile, lockFile, platform, engine, version) {
   return true
 }
 
-async function computeBaseKey(platform, engine, version) {
-  let baseKey = `setup-ruby-bundle-install-${platform}-${engine}-${version}`
+async function computeBaseKey(platform, engine, version, gemfile) {
+  let baseKey = `setup-ruby-toolcache-bundle-install-${platform}-${engine}-${version}-${gemfile}`
   if (engine !== 'jruby' && common.isHeadVersion(version)) {
     let revision = '';
     await exec.exec('ruby', ['-e', 'print RUBY_REVISION'], {

ruby-builder-versions.js

@@ -8,6 +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",
       "head", "debug",
     ],
     "jruby": [
@@ -22,11 +23,5 @@ export function getVersions(platform) {
     ]
   }
 
-  if (platform === 'ubuntu-18.04') {
-    versions['rubinius'] = [
-      "4.14"
-    ]
-  }
-
   return versions
 }

ruby-builder.js

@@ -7,7 +7,7 @@ const tc = require('@actions/tool-cache')
 const common = require('./common')
 const rubyBuilderVersions = require('./ruby-builder-versions')
 
-const builderReleaseTag = 'enable-shared'
+const builderReleaseTag = 'toolcache'
 const releasesURL = 'https://github.com/ruby/ruby-builder/releases'
 
 const windows = common.windows
@@ -21,19 +21,22 @@ export async function install(platform, engine, version) {
 }
 
 async function downloadAndExtract(platform, engine, version) {
-  const rubiesDir = windows ? `${common.drive}:` : path.join(os.homedir(), '.rubies')
-
-  const rubyPrefix = path.join(rubiesDir, `${engine}-${version}`)
-
-  // Set the PATH now, so the MSYS2 'tar' is in Path on Windows
-  if (engine === 'rubinius') {
-    core.warning('Rubinius builds will no longer be provided, see https://github.com/ruby/setup-ruby/issues/101')
-    common.setupPath([path.join(rubyPrefix, 'bin'), path.join(rubyPrefix, 'gems', 'bin')])
+  let rubyPrefix
+  if (common.shouldExtractInToolCache(engine, version)) {
+    rubyPrefix = common.getToolCacheRubyPrefix(version)
+  } else if (windows) {
+    rubyPrefix = path.join(`${common.drive}:`, `${engine}-${version}`)
   } else {
-    common.setupPath([path.join(rubyPrefix, 'bin')])
+    rubyPrefix = path.join(os.homedir(), '.rubies', `${engine}-${version}`)
   }
 
-  await io.mkdirP(rubiesDir)
+  const parentDir = path.dirname(rubyPrefix)
+
+  // Set the PATH now, so the MSYS2 'tar' is in Path on Windows
+  common.setupPath([path.join(rubyPrefix, 'bin')])
+
+  await io.rmRF(rubyPrefix)
+  await io.mkdirP(parentDir)
 
   const downloadPath = await common.measure('Downloading Ruby', async () => {
     const url = getDownloadURL(platform, engine, version)
@@ -44,9 +47,9 @@ async function downloadAndExtract(platform, engine, version) {
   await common.measure('Extracting Ruby', async () => {
     if (windows) {
       // Windows 2016 doesn't have system tar, use MSYS2's, it needs unix style paths
-      await exec.exec('tar', [ '-xz', '-C', common.win2nix(rubiesDir), '-f', common.win2nix(downloadPath) ])
+      await exec.exec('tar', [ '-xz', '-C', common.win2nix(parentDir), '-f', common.win2nix(downloadPath) ])
     } else {
-      await exec.exec('tar', [ '-xz', '-C', rubiesDir, '-f',  downloadPath ])
+      await exec.exec('tar', [ '-xz', '-C', parentDir, '-f',  downloadPath ])
     }
   })
 

windows.js

@@ -6,6 +6,7 @@ const path = require('path')
 const cp = require('child_process')
 const core = require('@actions/core')
 const exec = require('@actions/exec')
+const io = require('@actions/io')
 const tc = require('@actions/tool-cache')
 const common = require('./common')
 const rubyInstallerVersions = require('./windows-versions').versions
@@ -35,7 +36,13 @@ export async function install(platform, engine, version) {
   }
   const base = url.slice(url.lastIndexOf('/') + 1, url.length - '.7z'.length)
 
-  const rubyPrefix = `${drive}:\\${base}`
+  let rubyPrefix
+  if (common.shouldExtractInToolCache(engine, version)) {
+    rubyPrefix = common.getToolCacheRubyPrefix(version)
+  } else {
+    rubyPrefix = `${drive}:\\${base}`
+  }
+  const parentDir = path.dirname(rubyPrefix)
 
   let toolchainPaths = (version === 'mswin') ? await setupMSWin() : await setupMingw(version)
 
@@ -47,7 +54,11 @@ export async function install(platform, engine, version) {
   })
 
   await common.measure('Extracting Ruby', async () =>
-    exec.exec('7z', ['x', downloadPath, `-xr!${base}\\share\\doc`, `-o${drive}:\\`], { 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)
+  }
 
   return rubyPrefix
 }