Various cleanups

Author: eregon

common.js

@@ -7,7 +7,9 @@ const crypto = require('crypto')
 const core = require('@actions/core')
 const { performance } = require('perf_hooks')
 
-const isWin = (os.platform() === 'win32')
+export const windows = (os.platform() === 'win32')
+// Extract to SSD on Windows, see https://github.com/ruby/setup-ruby/pull/14
+export const drive = (windows ? (process.env['GITHUB_WORKSPACE'] || 'C')[0] : undefined)
 
 export async function measure(name, block) {
   return await core.group(name, async () => {
@@ -58,7 +60,7 @@ function findUbuntuVersion() {
 }
 
 // convert windows path like C:\Users\runneradmin to /c/Users/runneradmin
-export function win2nix(path) { 
+export function win2nix(path) {
   if (/^[A-Z]:/i.test(path)) {
     // path starts with drive
     path = `/${path[0].toLowerCase()}${path.split(':', 2)[1]}`
@@ -67,10 +69,11 @@ export function win2nix(path) {
 }
 
 export function setupPath(newPathEntries) {
-  const envPath = isWin ? 'Path' : 'PATH'
+  const envPath = windows ? 'Path' : 'PATH'
   const originalPath = process.env[envPath].split(path.delimiter)
   let cleanPath = originalPath.filter(entry => !/\bruby\b/i.test(entry))
 
+  // First remove the conflicting path entries
   if (cleanPath.length !== originalPath.length) {
     core.startGroup(`Cleaning ${envPath}`)
     console.log(`Entries removed from ${envPath} to avoid conflicts with Ruby:`)
@@ -82,9 +85,11 @@ export function setupPath(newPathEntries) {
     core.exportVariable(envPath, cleanPath.join(path.delimiter))
     core.endGroup()
   }
+
+  // Then add new path entries using core.addPath()
   let newPath
-  if (isWin) {
-    // add MSYS2 path to all for bash shell
+  if (windows) {
+    // add MSYS2 in path for all Rubies on Windows, as it provides a better bash shell and a native toolchain
     const msys2 = ['C:\\msys64\\mingw64\\bin', 'C:\\msys64\\usr\\bin']
     newPath = [...newPathEntries, ...msys2]
   } else {

dist/index.js

@@ -6,7 +6,7 @@ const exec = require('@actions/exec')
 const cache = require('@actions/cache')
 const common = require('./common')
 
-const isWin = (os.platform() === 'win32')
+const windows = common.windows
 
 const inputDefaults = {
   'ruby-version': 'default',
@@ -49,12 +49,10 @@ export async function setupRuby(options = {}) {
   const version = validateRubyEngineAndVersion(platform, engineVersions, engine, parsedVersion)
 
   createGemRC()
-
   envPreInstall()
 
   const rubyPrefix = await installer.install(platform, engine, version)
 
-
   // When setup-ruby is used by other actions, this allows code in them to run
   // before 'bundle install'.  Installed dependencies may require additional
   // libraries & headers, build tools, etc.
@@ -139,10 +137,10 @@ function createGemRC() {
 }
 
 // sets up ENV variables
-// currrently only used on Windows runners
+// currently only used on Windows runners
 function envPreInstall() {
   const ENV = process.env
-  if (isWin) {
+  if (windows) {
     // puts normal Ruby temp folder on SSD
     core.exportVariable('TMPDIR', ENV['RUNNER_TEMP'])
     // bash - sets home to match native windows, normally C:\Users\<user name>

index.js

@@ -9,28 +9,27 @@ const rubyBuilderVersions = require('./ruby-builder-versions')
 const builderReleaseTag = 'enable-shared'
 const releasesURL = 'https://github.com/ruby/ruby-builder/releases'
 
-const isWin = (os.platform() === 'win32')
+const windows = common.windows
 
 export function getAvailableVersions(platform, engine) {
   return rubyBuilderVersions.getVersions(platform)[engine]
 }
 
 export async function install(platform, engine, version) {
-  const rubyPrefix = await downloadAndExtract(platform, engine, version)
-  return rubyPrefix
+  return await downloadAndExtract(platform, engine, version)
 }
 
 async function downloadAndExtract(platform, engine, version) {
-  const rubiesDir = isWin ?
-    `${(process.env.GITHUB_WORKSPACE || 'C')[0]}:` :
-    path.join(os.homedir(), '.rubies')
+  const rubiesDir = windows ? `${common.drive}:` : path.join(os.homedir(), '.rubies')
 
   const rubyPrefix = path.join(rubiesDir, `${engine}-${version}`)
-  const newPathEntries = (engine === 'rubinius') ?
-    [path.join(rubyPrefix, 'bin'), path.join(rubyPrefix, 'gems', 'bin')] :
-    [path.join(rubyPrefix, 'bin')]
 
-  common.setupPath(newPathEntries)
+  // Set the PATH now, so the MSYS2 'tar' is in Path on Windows
+  if (engine === 'rubinius') {
+    common.setupPath([path.join(rubyPrefix, 'bin'), path.join(rubyPrefix, 'gems', 'bin')])
+  } else {
+    common.setupPath([path.join(rubyPrefix, 'bin')])
+  }
 
   await io.mkdirP(rubiesDir)
 
@@ -41,8 +40,8 @@ async function downloadAndExtract(platform, engine, version) {
   })
 
   await common.measure('Extracting Ruby', async () => {
-    // Windows 2016 doesn't have system tar, use MSYS2's, it needs unix style paths
-    if (isWin) {
+    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) ])
     } else {
       await exec.exec('tar', [ '-xz', '-C', rubiesDir, '-f',  downloadPath ])

ruby-builder.js

@@ -10,16 +10,14 @@ const tc = require('@actions/tool-cache')
 const common = require('./common')
 const rubyInstallerVersions = require('./windows-versions').versions
 
-// Extract to SSD, see https://github.com/ruby/setup-ruby/pull/14
-const drive = (process.env['GITHUB_WORKSPACE'] || 'C')[0]
+const drive = common.drive
 
 // needed for 2.1, 2.2, 2.3, and mswin, cert file used by Git for Windows
 const certFile = 'C:\\Program Files\\Git\\mingw64\\ssl\\cert.pem'
 
 // location & path for old RubyInstaller DevKit (MSYS), Ruby 2.1, 2.2 and 2.3
 const msys = `${drive}:\\DevKit64`
-const msysPathEntries = [`${msys}\\mingw\\x86_64-w64-mingw32\\bin`,
-  `${msys}\\mingw\\bin`, `${msys}\\bin`]
+const msysPathEntries = [`${msys}\\mingw\\x86_64-w64-mingw32\\bin`, `${msys}\\mingw\\bin`, `${msys}\\bin`]
 
 export function getAvailableVersions(platform, engine) {
   if (engine === 'ruby') {
@@ -39,8 +37,7 @@ export async function install(platform, engine, version) {
 
   const rubyPrefix = `${drive}:\\${base}`
 
-  let toolchainPaths = (version === 'mswin') ?
-    await setupMSWin() : await setupMingw(version)
+  let toolchainPaths = (version === 'mswin') ? await setupMSWin() : await setupMingw(version)
 
   common.setupPath([`${rubyPrefix}\\bin`, ...toolchainPaths])
 
@@ -96,10 +93,7 @@ async function setupMSWin() {
     fs.copyFileSync(certFile, cert)
   }
 
-  const VCPathEntries = await common.measure('Setting up MSVC environment', async () =>
-    addVCVARSEnv())
-
-  return VCPathEntries
+  return await common.measure('Setting up MSVC environment', async () => addVCVARSEnv())
 }
 
 /* Sets MSVC environment for use in Actions