Merge pull request #70 from conveyal/dev

v1.3.0

Author: evansiroky

.travis.yml

@@ -2,18 +2,15 @@ sudo: false
 language: node_js
 cache:
   directories:
-    - node_modules
+    - ~/.yarn-cache
 notifications:
   email: false
 node_js:
   - '6'
 before_install:
-  - npm i -g npm@^3.0.0
+  - npm i -g codecov npm@^3 yarn
 install:
-  - npm i
-  - npm install -g codecov
-before_script:
-  - npm prune
+  - yarn
 script:
   - npm run cover
   - codecov

README.md

@@ -7,6 +7,18 @@
 
 <p align="center">Conveyal's front-end JavaScript tool-belt. Build, run, lint and deploy front-end code.</p>
 
+## Table of Contents
+
+* [Install](#install)
+* [Configuration](#configuration)
+* [CLI Usage](#cli-usage)
+  * [Build](#build)
+  * [Commit](#commit)
+  * [Deploy](#deploy)
+  * [Lint](#lint)
+  * [Test](#test)
+* [React Utils](#react-utils)
+
 ## Install
 
 With [node v6+ and npm 3+ installed](https://nodejs.org/en/download/current/):
@@ -31,7 +43,7 @@ This file should contain string messages to be used throughout the application.
 
 Settings contain both Mastarm configuration settings and per environment settings to be used in the application. To override base settings, create an environments section in the `yml` file. [Example in Modeify](https://github.com/conveyal/modeify/blob/master/configurations/example/settings.yml#L40). Each section below will contain the settings that they can use.
 
-## Usage
+## CLI Usage
 
 Not all options pertain to all commands.  Entries are in the format `input/file.js:output/file.js`.
 
@@ -139,15 +151,20 @@ Run tests using Jest
 
 Options:
 
-  -h, --help                output usage information
-  -u, --update-snapshots    Force update of snapshots.  USE WITH CAUTION.
-  --coverage                Run Jest with coverage reporting
-  --no-cache                Run Jest with cache
-  --coverage-paths <paths>  Extra paths to collect code coverage from
-  --setup-files <paths>     Setup files to run before each test
+  -h, --help                              output usage information
+  -u, --update-snapshots                  Force update of snapshots.  USE WITH CAUTION.
+  --coverage                              Run Jest with coverage reporting
+  --no-cache                              Run Jest without cache (defaults to using cache)
+  --coverage-paths <paths>                Extra paths to collect code coverage from
+  --setup-files <paths>                   Setup files to run before each test
+  --test-path-ignore-patterns <patterns>  File patterns to ignore when scanning for test files
 
 ```
 
+## React Utils
+
+Documentation coming soon
+
 [npm-image]: https://img.shields.io/npm/v/mastarm.svg?maxAge=2592000&style=flat-square
 [npm-url]: https://www.npmjs.com/package/mastarm
 [travis-image]: https://img.shields.io/travis/conveyal/mastarm.svg?style=flat-square

tests/bin/mastarm.test.js __tests__/bin/mastarm.js

@@ -6,7 +6,7 @@ const path = require('path')
 
 const mastarm = path.resolve('./bin/mastarm')
 
-const util = require('../util.js')
+const util = require('../test-utils/util.js')
 
 describe('mastarm cli', () => {
   it('should display usage with no args', (done) => {
@@ -21,17 +21,19 @@ describe('mastarm cli', () => {
   describe('build', function () {
     const buildFilePattern = 'built-bin-build'
     const cleanFn = util.makeCleanBuiltFilesFn(buildFilePattern)
+    const mockDir = util.mockDir
+
     beforeEach(cleanFn)
     afterEach(cleanFn)
 
     it('should build a project', (done) => {
-      exec(`node ${mastarm} build tests/mocks/mockComponent.js:tests/mocks/${buildFilePattern}.js tests/mocks/mock.css:tests/mocks/${buildFilePattern}.css`,
+      exec(`node ${mastarm} build ${mockDir}/mockComponent.js:${mockDir}/${buildFilePattern}.js ${mockDir}/mock.css:${mockDir}/${buildFilePattern}.css`,
         (err, stdout, stderr) => {
           expect(err).toBeNull()
           expect(stdout).toBe('')
           expect(stderr).toBe('')
-          expect(fs.existsSync(`tests/mocks/${buildFilePattern}.js`)).toBeTruthy()
-          expect(fs.existsSync(`tests/mocks/${buildFilePattern}.css`)).toBeTruthy()
+          expect(fs.existsSync(`${mockDir}/${buildFilePattern}.js`)).toBeTruthy()
+          expect(fs.existsSync(`${mockDir}/${buildFilePattern}.css`)).toBeTruthy()
           done()
         }
       )

__tests__/lib/__snapshots__/load-config.js.snap

@@ -0,0 +1,9 @@
+exports[`load-config should work without any config files present 1`] = `
+Object {
+  "env": Object {},
+  "environment": "test",
+  "messages": Object {},
+  "settings": Object {},
+  "store": Object {},
+}
+`;

tests/lib/__snapshots__/test.test.js.snap __tests__/lib/__snapshots__/test.js.snap

@@ -22,7 +22,9 @@ Object {
   "setupFiles": Array [
     "beforeTestsSetup.js",
   ],
+  "testPathIgnorePatterns": Array [
+    "<rootDir>/node_modules/",
+    "<rootDir>/__tests__/test-utils",
+  ],
 }
 `;
-
-exports[`test.js setupTestEnvironment should set MESSAGES environment variable if needed 1`] = `"{\"hi\":\"there\"}"`;

tests/lib/__snapshots__/util.test.js.snap __tests__/lib/__snapshots__/util.js.snap

@@ -3,21 +3,14 @@ exports[`util.js parseEntries should not find any paths if no matches 1`] = `Arr
 exports[`util.js parseEntries should return inputted file paths 1`] = `
 Array [
   Array [
-    "tests/mocks/mock.css",
-    "assets/tests/mocks/mock.css",
+    "__tests__/test-utils/mocks/mock.css",
+    "assets/__tests__/test-utils/mocks/mock.css",
   ],
   Array [
-    "tests/mocks/mockComponent.js",
+    "__tests__/test-utils/mocks/mockComponent.js",
     "blah",
   ],
 ]
 `;
 
 exports[`util.js parseEntries should try to find default file paths 1`] = `Array []`;
-
-exports[`util.js updateDependencies should run check-dependencies package 1`] = `
-Object {
-  "depsWereOk": true,
-  "status": 0,
-}
-`;

tests/lib/build.test.js __tests__/lib/build.js

@@ -3,27 +3,29 @@ const fs = require('fs')
 
 const build = require('../../lib/build')
 
-const util = require('../util.js')
+const util = require('../test-utils/util.js')
 
 describe('build', () => {
   const buildFilePattern = 'built-build'
   const cleanFn = util.makeCleanBuiltFilesFn(buildFilePattern)
+  const mockDir = util.mockDir
+
   beforeEach(cleanFn)
   afterEach(cleanFn)
 
   it('should transform js and css', (done) => {
     build({
       config: {},
       files: [
-        ['tests/mocks/mockComponent.js', `tests/mocks/${buildFilePattern}.js`],
-        ['tests/mocks/mock.css', `tests/mocks/${buildFilePattern}.css`]
+        [`${mockDir}/mockComponent.js`, `${mockDir}/${buildFilePattern}.js`],
+        [`${mockDir}/mock.css`, `${mockDir}/${buildFilePattern}.css`]
       ]
     })
 
     // css transform happens asynchronously, so wait 1 second before checking for file
     setTimeout(() => {
-      expect(fs.existsSync(`tests/mocks/${buildFilePattern}.js`)).toBeTruthy()
-      expect(fs.existsSync(`tests/mocks/${buildFilePattern}.css`)).toBeTruthy()
+      expect(fs.existsSync(`${mockDir}/${buildFilePattern}.js`)).toBeTruthy()
+      expect(fs.existsSync(`${mockDir}/${buildFilePattern}.css`)).toBeTruthy()
       done()
     }, 1000)
   })

__tests__/lib/load-config.js

@@ -0,0 +1,12 @@
+/* globals describe, expect, it */
+
+const loadConfig = require('../../lib/load-config')
+
+describe('load-config', () => {
+  it('should work without any config files present', () => {
+    const config = loadConfig(process.cwd(), '~/mastarm/configurations/default', 'test')
+    expect(config.path).toContain('mastarm/configurations/default')
+    delete config.path
+    expect(config).toMatchSnapshot()
+  })
+})

tests/lib/test.test.js __tests__/lib/test.js

@@ -18,9 +18,4 @@ describe('test.js', () => {
     delete jestCfg.scriptPreprocessor
     expect(jestCfg).toMatchSnapshot()
   })
-
-  it('setupTestEnvironment should set MESSAGES environment variable if needed', () => {
-    testUtils.setupTestEnvironment({ messages: { hi: 'there' } })
-    expect(process.env.MESSAGES).toMatchSnapshot()
-  })
 })

__tests__/lib/util.js

@@ -0,0 +1,60 @@
+/* globals describe, expect, it, jest */
+
+jest.mock('../../lib/pkg', () => { return {} })
+
+const util = require('../../lib/util')
+const testUtils = require('../test-utils/util')
+const mockDir = testUtils.mockDir
+
+describe('util.js', () => {
+  it('configureEnvironment should set process.env vars', () => {
+    const env2 = 'mock-env2'
+    const messages = { hi: 'there' }
+    const settings = { someSetting: true }
+    const store = {}
+    const config = {
+      env: 'mock-env',
+      path: '/made/up/path',
+      messages,
+      settings,
+      store
+    }
+    util.configureEnvironment({ config, env: env2 })
+    expect(process.env.NODE_ENV).toEqual(env2)
+    expect(JSON.parse(process.env.MESSAGES)).toEqual(messages)
+    expect(JSON.parse(process.env.SETTINGS)).toEqual(settings)
+    expect(JSON.parse(process.env.STORE)).toEqual(store)
+  })
+
+  it('makeGetFn should find the right value', () => {
+    expect(util.makeGetFn([{ a: 1 }, { a: 2 }])('a')).toEqual(1)
+  })
+
+  describe('parseEntries', () => {
+    const get = () => null
+    it('should try to find default file paths', () => {
+      const result = util.parseEntries([], get)
+      expect(result.length).toBe(0)
+      expect(result).toMatchSnapshot()
+    })
+
+    it('should not find any paths if no matches', () => {
+      const result = util.parseEntries(['fileDoesNotExist:blah'], get)
+      expect(result.length).toBe(0)
+      expect(result).toMatchSnapshot()
+    })
+
+    it('should return inputted file paths', () => {
+      const result = util.parseEntries([`${mockDir}/mock.css`, `${mockDir}/mockComponent.js:blah`], get)
+      expect(result.length).toBe(2)
+      expect(result).toMatchSnapshot()
+    })
+  })
+
+  it('popMastarmFromArgv should remove the mastarm command', () => {
+    const argv1 = process.argv[1]
+    expect(argv1).toContain('mastarm')
+    util.popMastarmFromArgv()
+    expect(process.argv[1]).not.toBe(argv1)
+  })
+})

tests/mocks/mock.css __tests__/test-utils/mocks/mock.css

@@ -0,0 +1,11 @@
+const rimraf = require('rimraf')
+
+const mockDir = '__tests__/test-utils/mocks'
+
+exports.mockDir = mockDir
+
+exports.makeCleanBuiltFilesFn = (filePattern) => {
+  return (done) => {
+    rimraf(`${mockDir}/${filePattern}*`, done)
+  }
+}

tests/mocks/mockComponent.js __tests__/test-utils/mocks/mockComponent.js

@@ -11,7 +11,7 @@ commander
   .option('-c, --config <path>', 'Path to configuration files.', path.join(process.cwd(), '/configurations/default'))
   .option('-e, --env <environment>', 'Environment to use.', process.env.NODE_ENV || 'development')
   .option('-m, --minify', 'Minify built files.')
-  .option('-S, --skip-check-dependencies', 'Skip checking and installing out of date package.json dependencies.')
+  .option('-S, --skip-check-dependencies', '**DEPRECATED**')
 
 commander
   .command('build [entries...]')
@@ -21,7 +21,6 @@ commander
   .option('-s, --serve', 'Serve with budo. Auto-matically rebuilds on changes.')
   .option('-w, --watch', 'Automatically rebuild on changes.')
   .action(function (entries, options) {
-    checkDependencies()
     const config = loadConfig(process.cwd(), commander.config, commander.env)
     const get = util.makeGetFn([options, commander, config.settings])
     const files = util.parseEntries(entries, get)
@@ -70,7 +69,6 @@ commander
   .option('--cloudfront', 'CloudFront Distribution ID to invalidate.')
   .option('--s3bucket', 'S3 Bucket to push to.')
   .action(function (entries, options) {
-    checkDependencies()
     const pushToS3 = require('../lib/push-to-s3')
     const config = loadConfig(process.cwd(), commander.config, commander.env)
     const get = util.makeGetFn([options, commander, config.settings])
@@ -107,25 +105,15 @@ commander
 commander
   .command('prepublish [entries...]')
   .description('Transpile JavaScript down to ES5 with Babel')
-  .action(function (entries) {
-    checkDependencies()
+  .action(function (entries, options) {
     const babel = require('babel-core')
     const fs = require('fs')
     const glob = require('glob')
     const mkdirp = require('mkdirp')
+    const babelConfig = require('../lib/babel-config')
+    const config = loadConfig(process.cwd(), commander.config, commander.env)
+    const get = util.makeGetFn([options, commander, config.settings])
     const outdir = path.join(process.cwd(), 'build')
-    const options = {
-      presets: [
-        require('babel-preset-es2015'),
-        require('babel-preset-react'),
-        require('babel-preset-stage-0')
-      ],
-      plugins: [
-        require('babel-plugin-add-module-exports'),
-        require('babel-plugin-transform-runtime')
-      ],
-      sourceMaps: true
-    }
     entries.forEach((entry) => {
       if (fs.statSync(entry).isDirectory()) {
         transformDir(entry)
@@ -137,7 +125,7 @@ commander
       const filepath = path.join(outdir, filename)
       const results = babel.transform(
         fs.readFileSync(filename, 'utf8'),
-        Object.assign({}, options, {filename})
+        Object.assign({}, babelConfig(get('env')), {filename, sourceMaps: true})
       )
       mkdirp.sync(path.dirname(filepath))
       fs.writeFileSync(filepath, results.code + '\n//# sourceMappingURL=' + path.basename(filepath))
@@ -156,29 +144,17 @@ commander
   .description('Run tests using Jest')
   .option('-u, --update-snapshots', 'Force update of snapshots.  USE WITH CAUTION.')
   .option('--coverage', 'Run Jest with coverage reporting')
-  .option('--no-cache', 'Run Jest with cache')
+  .option('--no-cache', 'Run Jest without cache (defaults to using cache)')
   .option('--coverage-paths <paths>', 'Extra paths to collect code coverage from')
   .option('--setup-files <paths>', 'Setup files to run before each test')
+  .option('--test-path-ignore-patterns <patterns>', 'File patterns to ignore when scanning for test files')
   .action(function (patterns, options) {
-    checkDependencies()
     const jest = require('jest')
     const config = loadConfig(process.cwd(), commander.config, commander.env)
+    const get = util.makeGetFn([options, commander, config.settings])
     const testUtils = require('../lib/test')
-    testUtils.setupTestEnvironment(config)
+    util.configureEnvironment({config, env: get('env')})
     jest.run(testUtils.generateTestConfig(patterns, options))
   })
 
 commander.parse(process.argv)
-
-function checkDependencies () {
-  if (!commander.skipCheckDependencies) {
-    const results = util.updateDependencies()
-    if (results.status !== 0) {
-      console.error(results.error)
-      process.exit(results.status)
-    } else if (!results.depsWereOk) {
-      console.log('Updated out of date dependencies found in package.json. Please try running the command again.')
-      process.exit(results.status)
-    }
-  }
-}