Fix checks for head versions

* Always use common.isHeadVersion().

.github/workflows/test.yml

@@ -15,12 +15,13 @@ jobs:
       matrix:
         os: [ ubuntu, macos, windows ]
         # Use various version syntax here for testing
-        ruby: [ 2.2, 2.3, 2.4, 2.5, 2.6.6, 2.7, ruby-head, jruby-9.1, jruby, jruby-head, truffleruby, truffleruby-head ]
+        ruby: [ 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, ruby: rubinius }
         - { os: windows, ruby: mingw }
         - { os: windows, ruby: mswin }
         exclude:
+        - { os: windows, ruby: debug }
         - { os: windows, ruby: truffleruby }
         - { os: windows, ruby: truffleruby-head }
 

README.md

@@ -14,11 +14,12 @@ This action currently supports these versions of MRI, JRuby and TruffleRuby:
 
 | Interpreter | Versions |
 | ----------- | -------- |
-| Ruby | 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.1, head, mingw, mswin |
+| Ruby | 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.1, head, debug, mingw, mswin |
 | JRuby | 9.1.17.0, 9.2.9.0 - 9.2.11.1, head |
 | TruffleRuby | 19.3.0 - 20.0.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.
 
 Ruby 2.2 resolves to 2.2.6 on Windows (last build from RubyInstaller) and 2.2.10 otherwise.  

common.js

@@ -16,6 +16,10 @@ export async function measure(name, block) {
   })
 }
 
+export function isHeadVersion(rubyVersion) {
+  return rubyVersion === 'head' || rubyVersion === 'debug' || rubyVersion === 'mingw' || rubyVersion === 'mswin'
+}
+
 export function getVirtualEnvironmentName() {
   const platform = os.platform()
   if (platform === 'linux') {

dist/index.js

@@ -988,7 +988,7 @@ async function main() {
   process.chdir(core.getInput('working-directory'))
 
   const platform = common.getVirtualEnvironmentName()
-  const [engine, version] = parseRubyEngineAndVersion(core.getInput('ruby-version'))
+  const [engine, parsedVersion] = parseRubyEngineAndVersion(core.getInput('ruby-version'))
 
   let installer
   if (platform === 'windows-latest' && engine !== 'jruby') {
@@ -998,13 +998,13 @@ async function main() {
   }
 
   const engineVersions = installer.getAvailableVersions(platform, engine)
-  const ruby = validateRubyEngineAndVersion(platform, engineVersions, engine, version)
+  const version = validateRubyEngineAndVersion(platform, engineVersions, engine, parsedVersion)
 
   createGemRC()
 
-  const [rubyPrefix, newPathEntries] = await installer.install(platform, ruby)
+  const [rubyPrefix, newPathEntries] = await installer.install(platform, engine, version)
 
-  setupPath(ruby, newPathEntries)
+  setupPath(newPathEntries)
 
   if (core.getInput('bundler') !== 'none') {
     await common.measure('Installing Bundler', async () =>
@@ -1036,7 +1036,7 @@ function parseRubyEngineAndVersion(rubyVersion) {
   }
 
   let engine, version
-  if (rubyVersion.match(/^(\d+|head|mingw|mswin)/)) { // X.Y.Z => ruby-X.Y.Z
+  if (rubyVersion.match(/^(\d+)/) || common.isHeadVersion(rubyVersion)) { // X.Y.Z => ruby-X.Y.Z
     engine = 'ruby'
     version = rubyVersion
   } else if (!rubyVersion.includes('-')) { // myruby -> myruby-stableVersion
@@ -1049,24 +1049,25 @@ function parseRubyEngineAndVersion(rubyVersion) {
   return [engine, version]
 }
 
-function validateRubyEngineAndVersion(platform, engineVersions, engine, version) {
+function validateRubyEngineAndVersion(platform, engineVersions, engine, parsedVersion) {
   if (!engineVersions) {
     throw new Error(`Unknown engine ${engine} on ${platform}`)
   }
 
-  if (!engineVersions.includes(version)) {
+  let version = parsedVersion
+  if (!engineVersions.includes(parsedVersion)) {
     const latestToFirstVersion = engineVersions.slice().reverse()
-    const found = latestToFirstVersion.find(v => v !== 'head' && v.startsWith(version))
+    const found = latestToFirstVersion.find(v => !common.isHeadVersion(v) && v.startsWith(parsedVersion))
     if (found) {
       version = found
     } else {
-      throw new Error(`Unknown version ${version} for ${engine} on ${platform}
+      throw new Error(`Unknown version ${parsedVersion} for ${engine} on ${platform}
         available versions for ${engine} on ${platform}: ${engineVersions.join(', ')}
         File an issue at https://github.com/ruby/setup-ruby/issues if would like support for a new version`)
     }
   }
 
-  return engine + '-' + version
+  return version
 }
 
 function createGemRC() {
@@ -1076,7 +1077,7 @@ function createGemRC() {
   }
 }
 
-function setupPath(ruby, newPathEntries) {
+function setupPath(newPathEntries) {
   const originalPath = process.env['PATH'].split(path.delimiter)
   let cleanPath = originalPath.filter(entry => !/\bruby\b/i.test(entry))
 
@@ -1135,7 +1136,7 @@ async function installBundler(platform, rubyPrefix, engine, rubyVersion) {
     throw new Error(`Cannot parse bundler input: ${bundlerVersion}`)
   }
 
-  if (engine === 'ruby' && isHeadVersion(rubyVersion) && bundlerVersion === '2') {
+  if (engine === 'ruby' && common.isHeadVersion(rubyVersion) && bundlerVersion === '2') {
     console.log(`Using Bundler 2 shipped with ${engine}-${rubyVersion}`)
   } else if (engine === 'truffleruby' && bundlerVersion === '1') {
     console.log(`Using Bundler 1 shipped with ${engine}`)
@@ -1147,10 +1148,6 @@ async function installBundler(platform, rubyPrefix, engine, rubyVersion) {
   }
 }
 
-function isHeadVersion(rubyVersion) {
-  return rubyVersion === 'head' || rubyVersion === 'mingw' || rubyVersion === 'mswin'
-}
-
 if (__filename.endsWith('index.js')) { run() }
 
 
@@ -1465,7 +1462,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",
-      "head"
+      "head", "debug",
     ],
     "jruby": [
       "9.1.17.0",
@@ -1504,6 +1501,7 @@ module.exports = require("https");
 "use strict";
 __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__, "getVirtualEnvironmentName", function() { return getVirtualEnvironmentName; });
 const os = __webpack_require__(87)
 const fs = __webpack_require__(747)
@@ -1523,6 +1521,10 @@ async function measure(name, block) {
   })
 }
 
+function isHeadVersion(rubyVersion) {
+  return rubyVersion === 'head' || rubyVersion === 'debug' || rubyVersion === 'mingw' || rubyVersion === 'mswin'
+}
+
 function getVirtualEnvironmentName() {
   const platform = os.platform()
   if (platform === 'linux') {
@@ -3541,10 +3543,10 @@ function getAvailableVersions(platform, engine) {
   return rubyBuilderVersions.getVersions(platform)[engine]
 }
 
-async function install(platform, ruby) {
+async function install(platform, engine, version) {
-  const rubyPrefix = await downloadAndExtract(platform, ruby)
+  const rubyPrefix = await downloadAndExtract(platform, engine, version)
   let newPathEntries
-  if (ruby.startsWith('rubinius')) {
+  if (engine === 'rubinius') {
     newPathEntries = [path.join(rubyPrefix, 'bin'), path.join(rubyPrefix, 'gems', 'bin')]
   } else {
     newPathEntries = [path.join(rubyPrefix, 'bin')]
@@ -3552,12 +3554,12 @@ async function install(platform, ruby) {
   return [rubyPrefix, newPathEntries]
 }
 
-async function downloadAndExtract(platform, ruby) {
+async function downloadAndExtract(platform, engine, version) {
   const rubiesDir = path.join(os.homedir(), '.rubies')
   await io.mkdirP(rubiesDir)
 
   const downloadPath = await common.measure('Downloading Ruby', async () => {
-    const url = getDownloadURL(platform, ruby)
+    const url = getDownloadURL(platform, engine, version)
     console.log(url)
     return await tc.downloadTool(url)
   })
@@ -3566,20 +3568,19 @@ async function downloadAndExtract(platform, ruby) {
   await common.measure('Extracting Ruby', async () =>
     exec.exec(tar, [ '-xz', '-C', rubiesDir, '-f',  downloadPath ]))
 
-  return path.join(rubiesDir, ruby)
+  return path.join(rubiesDir, `${engine}-${version}`)
 }
 
-function getDownloadURL(platform, ruby) {
+function getDownloadURL(platform, engine, version) {
-  if (ruby.endsWith('-head')) {
+  if (common.isHeadVersion(version)) {
-    return getLatestHeadBuildURL(platform, ruby)
+    return getLatestHeadBuildURL(platform, engine, version)
   } else {
-    return `${releasesURL}/download/${builderReleaseTag}/${ruby}-${platform}.tar.gz`
+    return `${releasesURL}/download/${builderReleaseTag}/${engine}-${version}-${platform}.tar.gz`
   }
 }
 
-function getLatestHeadBuildURL(platform, ruby) {
+function getLatestHeadBuildURL(platform, engine, version) {
-  const engine = ruby.split('-')[0]
+  return `https://github.com/ruby/${engine}-dev-builder/releases/latest/download/${engine}-${version}-${platform}.tar.gz`
-  return `https://github.com/ruby/${engine}-dev-builder/releases/latest/download/${engine}-head-${platform}.tar.gz`
 }
 
 
@@ -5001,8 +5002,7 @@ function getAvailableVersions(platform, engine) {
   }
 }
 
-async function install(platform, ruby) {
+async function install(platform, engine, version) {
-  const version = ruby.split('-', 2)[1]
   const url = rubyInstallerVersions[version]
 
   if (!url.endsWith('.7z')) {

index.js

@@ -17,7 +17,7 @@ async function main() {
   process.chdir(core.getInput('working-directory'))
 
   const platform = common.getVirtualEnvironmentName()
-  const [engine, version] = parseRubyEngineAndVersion(core.getInput('ruby-version'))
+  const [engine, parsedVersion] = parseRubyEngineAndVersion(core.getInput('ruby-version'))
 
   let installer
   if (platform === 'windows-latest' && engine !== 'jruby') {
@@ -27,13 +27,13 @@ async function main() {
   }
 
   const engineVersions = installer.getAvailableVersions(platform, engine)
-  const ruby = validateRubyEngineAndVersion(platform, engineVersions, engine, version)
+  const version = validateRubyEngineAndVersion(platform, engineVersions, engine, parsedVersion)
 
   createGemRC()
 
-  const [rubyPrefix, newPathEntries] = await installer.install(platform, ruby)
+  const [rubyPrefix, newPathEntries] = await installer.install(platform, engine, version)
 
-  setupPath(ruby, newPathEntries)
+  setupPath(newPathEntries)
 
   if (core.getInput('bundler') !== 'none') {
     await common.measure('Installing Bundler', async () =>
@@ -65,7 +65,7 @@ function parseRubyEngineAndVersion(rubyVersion) {
   }
 
   let engine, version
-  if (rubyVersion.match(/^(\d+|head|mingw|mswin)/)) { // X.Y.Z => ruby-X.Y.Z
+  if (rubyVersion.match(/^(\d+)/) || common.isHeadVersion(rubyVersion)) { // X.Y.Z => ruby-X.Y.Z
     engine = 'ruby'
     version = rubyVersion
   } else if (!rubyVersion.includes('-')) { // myruby -> myruby-stableVersion
@@ -78,24 +78,25 @@ function parseRubyEngineAndVersion(rubyVersion) {
   return [engine, version]
 }
 
-function validateRubyEngineAndVersion(platform, engineVersions, engine, version) {
+function validateRubyEngineAndVersion(platform, engineVersions, engine, parsedVersion) {
   if (!engineVersions) {
     throw new Error(`Unknown engine ${engine} on ${platform}`)
   }
 
-  if (!engineVersions.includes(version)) {
+  let version = parsedVersion
+  if (!engineVersions.includes(parsedVersion)) {
     const latestToFirstVersion = engineVersions.slice().reverse()
-    const found = latestToFirstVersion.find(v => v !== 'head' && v.startsWith(version))
+    const found = latestToFirstVersion.find(v => !common.isHeadVersion(v) && v.startsWith(parsedVersion))
     if (found) {
       version = found
     } else {
-      throw new Error(`Unknown version ${version} for ${engine} on ${platform}
+      throw new Error(`Unknown version ${parsedVersion} for ${engine} on ${platform}
         available versions for ${engine} on ${platform}: ${engineVersions.join(', ')}
         File an issue at https://github.com/ruby/setup-ruby/issues if would like support for a new version`)
     }
   }
 
-  return engine + '-' + version
+  return version
 }
 
 function createGemRC() {
@@ -105,7 +106,7 @@ function createGemRC() {
   }
 }
 
-function setupPath(ruby, newPathEntries) {
+function setupPath(newPathEntries) {
   const originalPath = process.env['PATH'].split(path.delimiter)
   let cleanPath = originalPath.filter(entry => !/\bruby\b/i.test(entry))
 
@@ -164,7 +165,7 @@ async function installBundler(platform, rubyPrefix, engine, rubyVersion) {
     throw new Error(`Cannot parse bundler input: ${bundlerVersion}`)
   }
 
-  if (engine === 'ruby' && isHeadVersion(rubyVersion) && bundlerVersion === '2') {
+  if (engine === 'ruby' && common.isHeadVersion(rubyVersion) && bundlerVersion === '2') {
     console.log(`Using Bundler 2 shipped with ${engine}-${rubyVersion}`)
   } else if (engine === 'truffleruby' && bundlerVersion === '1') {
     console.log(`Using Bundler 1 shipped with ${engine}`)
@@ -176,8 +177,4 @@ async function installBundler(platform, rubyPrefix, engine, rubyVersion) {
   }
 }
 
-function isHeadVersion(rubyVersion) {
-  return rubyVersion === 'head' || rubyVersion === 'mingw' || rubyVersion === 'mswin'
-}
-
 if (__filename.endsWith('index.js')) { run() }

ruby-builder-versions.js

@@ -7,7 +7,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",
-      "head"
+      "head", "debug",
     ],
     "jruby": [
       "9.1.17.0",

ruby-builder.js

@@ -13,10 +13,10 @@ export function getAvailableVersions(platform, engine) {
   return rubyBuilderVersions.getVersions(platform)[engine]
 }
 
-export async function install(platform, ruby) {
+export async function install(platform, engine, version) {
-  const rubyPrefix = await downloadAndExtract(platform, ruby)
+  const rubyPrefix = await downloadAndExtract(platform, engine, version)
   let newPathEntries
-  if (ruby.startsWith('rubinius')) {
+  if (engine === 'rubinius') {
     newPathEntries = [path.join(rubyPrefix, 'bin'), path.join(rubyPrefix, 'gems', 'bin')]
   } else {
     newPathEntries = [path.join(rubyPrefix, 'bin')]
@@ -24,12 +24,12 @@ export async function install(platform, ruby) {
   return [rubyPrefix, newPathEntries]
 }
 
-async function downloadAndExtract(platform, ruby) {
+async function downloadAndExtract(platform, engine, version) {
   const rubiesDir = path.join(os.homedir(), '.rubies')
   await io.mkdirP(rubiesDir)
 
   const downloadPath = await common.measure('Downloading Ruby', async () => {
-    const url = getDownloadURL(platform, ruby)
+    const url = getDownloadURL(platform, engine, version)
     console.log(url)
     return await tc.downloadTool(url)
   })
@@ -38,18 +38,17 @@ async function downloadAndExtract(platform, ruby) {
   await common.measure('Extracting Ruby', async () =>
     exec.exec(tar, [ '-xz', '-C', rubiesDir, '-f',  downloadPath ]))
 
-  return path.join(rubiesDir, ruby)
+  return path.join(rubiesDir, `${engine}-${version}`)
 }
 
-function getDownloadURL(platform, ruby) {
+function getDownloadURL(platform, engine, version) {
-  if (ruby.endsWith('-head')) {
+  if (common.isHeadVersion(version)) {
-    return getLatestHeadBuildURL(platform, ruby)
+    return getLatestHeadBuildURL(platform, engine, version)
   } else {
-    return `${releasesURL}/download/${builderReleaseTag}/${ruby}-${platform}.tar.gz`
+    return `${releasesURL}/download/${builderReleaseTag}/${engine}-${version}-${platform}.tar.gz`
   }
 }
 
-function getLatestHeadBuildURL(platform, ruby) {
+function getLatestHeadBuildURL(platform, engine, version) {
-  const engine = ruby.split('-')[0]
+  return `https://github.com/ruby/${engine}-dev-builder/releases/latest/download/${engine}-${version}-${platform}.tar.gz`
-  return `https://github.com/ruby/${engine}-dev-builder/releases/latest/download/${engine}-head-${platform}.tar.gz`
 }

windows.js

@@ -33,8 +33,7 @@ export function getAvailableVersions(platform, engine) {
   }
 }
 
-export async function install(platform, ruby) {
+export async function install(platform, engine, version) {
-  const version = ruby.split('-', 2)[1]
   const url = rubyInstallerVersions[version]
 
   if (!url.endsWith('.7z')) {