Merge pull request #78 from flossbank/bashProfile

Bash profile

Author: joelwass

src/index.js

@@ -11,6 +11,7 @@ const Profile = require('./profile')
 const TempWriter = require('./util/temp')
 const UpdateController = require('./update')
 const Runlog = require('./util/runlog')
+const PathChecks = require('./util/pathChecks')
 
 const app = require('./app')
 
@@ -33,7 +34,8 @@ function main () {
 
   const alias = new Alias({ config, pm })
   const env = new Env({ config, alias })
-  const profile = new Profile({ env, runlog })
+  const pathChecks = new PathChecks()
+  const profile = new Profile({ env, runlog, pathChecks })
 
   const ui = new Ui({ config, runlog, client, stdout: process.stdout })
   const args = new Args({ client, update, ui, config, alias, env, profile, runlog })

src/profile/index.js

@@ -13,43 +13,43 @@ const os = require('os')
 const path = require('path')
 const makeDir = require('make-dir')
 
-function inHome (...filepaths) {
-  return path.join(os.homedir(), ...filepaths)
-}
-
-function inConfig (...filepaths) {
-  return inHome('.config', ...filepaths)
-}
-
-// shells and an appropriate config file to add our source line to
-// ref: https://en.wikipedia.org/wiki/Unix_shell#Configuration_files
-const SUPPORTED_SHELLS = {
-  shellFormat: {
-    // only support shells that support functions
-    // ref: https://web.archive.org/web/20160403120601/http://www.unixnote.com/2010/05/different-unix-shell.html
-    sh: [inHome('.profile')],
-    ksh: [inHome('.kshrc')],
-    zsh: [inHome('.zshrc'), inHome('.profile'), inHome('.zprofile')],
-    bash: [inHome('.bashrc'), inHome('.profile'), inHome('.bash_profile')]
-  },
-  powerFormat: {
-    pwsh: os.platform() !== 'win32' // pwsh stores its profile in different places depending on the OS
-      ? [inConfig('powershell', 'Microsoft.PowerShell_profile.ps1')]
-      : [inHome('Documents', 'PowerShell', 'Microsoft.PowerShell_profile.ps1')],
-    'powershell.exe': [inHome('Documents', 'WindowsPowerShell', 'Microsoft.PowerShell_profile.ps1')]
-  }
-}
-
 /**
  * Profile is responsible for detecting appropriate shell profile files and appending/removing the
  *  source command to/from those shell profiles. Profile attempts to run many different shell variants
  *  to determine the appropriate paths to write to. Shells which are runnable are eligible to have their
  *  respective profiles updated with the source command.
  */
 class Profile {
-  constructor ({ env, runlog }) {
+  constructor ({ env, runlog, pathChecks }) {
     this.env = env
+    this.pathChecks = pathChecks
     this.runlog = runlog
+    // shells and an appropriate config file to add our source line to
+    // ref: https://en.wikipedia.org/wiki/Unix_shell#Configuration_files
+    this.SUPPORTED_SHELLS = {
+      shellFormat: {
+        // only support shells that support functions
+        // ref: https://web.archive.org/web/20160403120601/http://www.unixnote.com/2010/05/different-unix-shell.html
+        sh: [this.pathChecks.inHome('.profile')],
+        ksh: [this.pathChecks.inHome('.kshrc')],
+        zsh: [
+          this.pathChecks.inHome('.zshrc'),
+          this.pathChecks.inHome('.profile'),
+          this.pathChecks.inHome('.zprofile')
+        ],
+        bash: [
+          this.pathChecks.inHome('.bashrc'),
+          this.pathChecks.inHome('.profile'),
+          this.pathChecks.inHome('.bash_profile')
+        ]
+      },
+      powerFormat: {
+        pwsh: os.platform() !== 'win32' // pwsh stores its profile in different places depending on the OS
+          ? [this.pathChecks.inConfig('powershell', 'Microsoft.PowerShell_profile.ps1')]
+          : [this.pathChecks.inHome('Documents', 'PowerShell', 'Microsoft.PowerShell_profile.ps1')],
+        'powershell.exe': [this.pathChecks.inHome('Documents', 'WindowsPowerShell', 'Microsoft.PowerShell_profile.ps1')]
+      }
+    }
   }
 
   async installToProfiles () {
@@ -102,28 +102,28 @@ class Profile {
     const detectedShellFormatProfiles = new Set()
     const detectedPowerFormatProfiles = new Set()
 
-    const shellFormat = Object.keys(SUPPORTED_SHELLS.shellFormat).map(async shell => {
+    const shellFormat = Object.keys(this.SUPPORTED_SHELLS.shellFormat).map(async shell => {
       const runnable = await this._isRunnable(shell)
       return ({
         shell,
         runnable,
-        profiles: SUPPORTED_SHELLS.shellFormat[shell]
+        profiles: this.SUPPORTED_SHELLS.shellFormat[shell]
       })
     })
-    const powerFormat = Object.keys(SUPPORTED_SHELLS.powerFormat).map(async shell => {
+    const powerFormat = Object.keys(this.SUPPORTED_SHELLS.powerFormat).map(async shell => {
       const runnable = await this._isRunnable(shell)
       return ({
         shell,
         runnable,
-        profiles: SUPPORTED_SHELLS.powerFormat[shell]
+        profiles: this.SUPPORTED_SHELLS.powerFormat[shell]
       })
     })
 
     ;(await Promise.all(shellFormat)).filter(res => res.runnable).forEach(sh => {
-      detectedShellFormatProfiles.add(...sh.profiles)
+      sh.profiles.forEach(profile => detectedShellFormatProfiles.add(profile))
     })
     ;(await Promise.all(powerFormat)).filter(res => res.runnable).forEach(sh => {
-      detectedPowerFormatProfiles.add(...sh.profiles)
+      sh.profiles.forEach(profile => detectedPowerFormatProfiles.add(profile))
     })
 
     return {

src/util/pathChecks.js

@@ -0,0 +1,14 @@
+const os = require('os')
+const path = require('path')
+
+class PathChecks {
+  inHome (...filepaths) {
+    return path.join(os.homedir(), ...filepaths)
+  }
+
+  inConfig (...filepaths) {
+    return this.inHome('.config', ...filepaths)
+  }
+}
+
+module.exports = PathChecks

test/profile/index.test.js

@@ -0,0 +1,43 @@
+
+const test = require('ava')
+const sinon = require('sinon')
+const Profile = require('../../src/profile')
+
+test.beforeEach((t) => {
+  const config = {
+    getApiHost: () => 'http://localhost',
+    getApiKey: () => 'api_key'
+  }
+  const runlog = {
+    error: sinon.stub(),
+    debug: sinon.stub(),
+    record: sinon.stub(),
+    keys: {}
+  }
+  const pathChecks = {
+    inHome: (...args) => args.pop(),
+    inConfig: (...args) => args.pop()
+  }
+  t.context.profile = new Profile({ config, runlog, pathChecks })
+})
+
+test('writes to all shell and power profiles for system with all shells and power available', async (t) => {
+  const { profile } = t.context
+  profile._isRunnable = sinon.stub().returns(true)
+
+  const {
+    detectedShellFormatProfiles,
+    detectedPowerFormatProfiles
+  } = await profile._detectProfiles()
+  t.deepEqual([
+    '.profile',
+    '.kshrc',
+    '.zshrc',
+    '.zprofile',
+    '.bashrc',
+    '.bash_profile'
+  ], detectedShellFormatProfiles)
+  t.deepEqual([
+    'Microsoft.PowerShell_profile.ps1'
+  ], detectedPowerFormatProfiles)
+})