improved comments in setup and tests

ShMcK · ShMcK · commit 3db0e169f314 · 2016-09-11T15:35:17.000-07:00
diff --git a/lib/modules/setup/utils/check-system.js b/lib/modules/setup/utils/check-system.js
@@ -33,7 +33,8 @@ function isAboveVersion(a, b) {
     }
     return true;
 }
-function minVersion(command, minVersion) {
+function minVersion(command) {
+    var minVersion = versions[command];
     return new Promise(function (resolve, reject) {
         var minOrLater = atom_plugin_command_line_1.default(command, '-v')
             .then(function (res) { return isAboveVersion(res, minVersion); });
@@ -45,6 +46,7 @@ function minVersion(command, minVersion) {
         }
     });
 }
+exports.minVersion = minVersion;
 function atomMinVersion() {
     return new Promise(function (resolve, reject) {
         var minOrLater = atom_plugin_command_line_1.default('atom', '-v').then(function (res) {
@@ -59,14 +61,6 @@ function atomMinVersion() {
     });
 }
 exports.atomMinVersion = atomMinVersion;
-function npmMinVersion() {
-    return minVersion('npm', versions.npm);
-}
-exports.npmMinVersion = npmMinVersion;
-function nodeMinVersion() {
-    return minVersion('node', versions.node);
-}
-exports.nodeMinVersion = nodeMinVersion;
 function requiresXCode() {
     if (!navigator.platform.match(/Mac/)) {
         return true;
diff --git a/lib/modules/setup/utils/verify.js b/lib/modules/setup/utils/verify.js
@@ -16,8 +16,8 @@ function setupVerify(dir, packageJson) {
     }
     var checks = {
         system: {
-            node: !!check_system_1.nodeMinVersion(),
-            npm: !!check_system_1.npmMinVersion(),
+            node: !!check_system_1.minVersion('node'),
+            npm: !!check_system_1.minVersion('npm'),
             xcode: !!check_system_1.requiresXCode(),
             atom: !!check_system_1.atomMinVersion(),
         },
diff --git a/src/modules/setup/package-json/index.ts b/src/modules/setup/package-json/index.ts
@@ -4,6 +4,9 @@ import { join } from 'path';
 import { SETUP_PACKAGE } from '../types';
 import fileExists from 'node-file-exists';
 
+/** 
+ * read a file and return contents as JSON
+ */
 const readParse = p => JSON.parse(readFileSync(p, 'utf8'));
 
 /**
diff --git a/src/modules/setup/utils/check-system.ts b/src/modules/setup/utils/check-system.ts
@@ -6,10 +6,22 @@ const versions = {
   npm: '3.0.0'
 };
 
-function matchVersions(v: string): string[] {
+/**
+ * extracts versions intro array from a string
+ * "0.1.0" -> ['0', '1', '0']
+ * or returns null
+ * @param  {string} v
+ */
+function matchVersions(v: string): string[]|null {
   return v.match(/([0-9]+)\.([0-9]+)/);
 }
 
+/**
+ * checks that a version is >= b version
+ * @param  {string} a
+ * @param  {string} b
+ * @returns boolean
+ */
 function isAboveVersion(a: string, b: string): boolean {
   if (a === b) { return true; }
   const a_components = a.split('.');
@@ -26,7 +38,14 @@ function isAboveVersion(a: string, b: string): boolean {
   return true;
 }
 
-function minVersion(command: string, minVersion: string): Promise<boolean> {
+/**
+ * calls command line to check that system version is above requirement
+ * @param  {string} command
+ * @param  {string} minVersion
+ * @returns Promise
+ */
+export function minVersion(command: string): Promise<boolean> {
+  const minVersion = versions[command];
   return new Promise((resolve, reject) => {
     let minOrLater: Promise<boolean> = commandLine(command, '-v')
       .then((res: string) => isAboveVersion(res, minVersion));
@@ -38,6 +57,10 @@ function minVersion(command: string, minVersion: string): Promise<boolean> {
   });
 }
 
+/**
+ * checks that the version of atom is above a minimum version
+ * @returns Promise
+ */
 export function atomMinVersion(): Promise<boolean> {
   return new Promise((resolve, reject) => {
     let minOrLater = commandLine('atom', '-v').then((res: string) => {
@@ -51,14 +74,6 @@ export function atomMinVersion(): Promise<boolean> {
   });
 }
 
-export function npmMinVersion(): Promise<boolean> {
-  return minVersion('npm', versions.npm);
-}
-
-export function nodeMinVersion(): Promise<boolean> {
-  return minVersion('node', versions.node);
-}
-
 /**
  * checks if is a mac
  * checks if xcode is installed
diff --git a/src/modules/setup/utils/verify.ts b/src/modules/setup/utils/verify.ts
@@ -1,4 +1,4 @@
-import {atomMinVersion, nodeMinVersion, npmMinVersion, requiresXCode} from './check-system';
+import {atomMinVersion, minVersion, requiresXCode} from './check-system';
 import {tutorials} from 'coderoad-cli';
 
 /**
@@ -32,8 +32,8 @@ export default function setupVerify(
 
   let checks: CR.Checks = {
     system: {
-      node: !!nodeMinVersion(),
-      npm: !!npmMinVersion(),
+      node: !!minVersion('node'),
+      npm: !!minVersion('npm'),
       xcode: !!requiresXCode(),
       atom: !!atomMinVersion(),
     },
diff --git a/src/modules/tests/task-position/index.ts b/src/modules/tests/task-position/index.ts
@@ -1,5 +1,11 @@
 import {TEST_RESULT} from '../types';
 
+/**
+ * task position reducer
+ * @param  {} taskPosition=0
+ * @param  {Action} action
+ * @returns number
+ */
 export default function taskPosition(
   taskPosition = 0, action: Action
 ): number {
diff --git a/src/modules/tests/task-position/reducer.test.ts b/src/modules/tests/task-position/reducer.test.ts
@@ -0,0 +1,22 @@
+/// <reference path="../../../typings/globals/jest/index.d.ts" />
+
+import reducer from './index';
+
+describe('task position reducer', () => {
+
+  it('should do nothing if no triggered action type', () => {
+    const action = { type: 'unknown' };
+    expect(reducer(undefined, action)).toBe(0);
+  });
+
+  it('should reset to 0 on PAGE_SET', () => {
+    const action = { type: 'PAGE_SET' };
+    expect(reducer(2, action)).toBe(0);
+  });
+
+  it('should set the task position on TEST_RESULT', () => {
+    const action = { type: 'TEST_RESULT', payload: { result: { taskPosition: 3 } } };
+    expect(reducer(1, action)).toBe(3);
+  });
+
+});
diff --git a/src/modules/tests/test-run/handle-result.ts b/src/modules/tests/test-run/handle-result.ts
@@ -1,7 +1,11 @@
 import store from '../../../store';
 import {testComplete} from '../actions';
 
-// function is passed into the test runner and called on completion
+/**
+ * function is passed into the test runner and called on completion
+ * @param  {Test.Result} result
+ * @returns void
+ */
 export default function handleResult(result: Test.Result): void {
   store.dispatch(testComplete(result));
 };
diff --git a/src/modules/tests/test-run/index.ts b/src/modules/tests/test-run/index.ts
@@ -16,6 +16,12 @@ const defaultTestRun: IRunTest = {
   time: performance.now(),
 };
 
+/**
+ * runs unit tests
+ * @param  {} testRun=defaultTestRun
+ * @param  {Action} action
+ * @returns IRunTest
+ */
 export default function runTest(
   testRun = defaultTestRun, action: Action
 ): IRunTest {
diff --git a/src/modules/tests/test-run/load.ts b/src/modules/tests/test-run/load.ts
@@ -1,7 +1,17 @@
 import { readFileSync } from 'fs';
 
+/**
+ * read files from paths and concat a data file together
+ * save the test data file to the test runner .tmp directory
+ * @param  {} {dir
+ * @param  {} tasks
+ * @param  {} load
+ * @param  {} testFile}
+ */
 export default function loadTaskTests({dir, tasks, load, testFile}) {
   
+  // first read files from paths and concat data together
+
   // map over task tests from coderoad.json
   const tests = [].concat.apply([], tasks.map(
       task => task.tests || []
@@ -17,5 +27,7 @@ export default function loadTaskTests({dir, tasks, load, testFile}) {
     return output;
   }, '');
   
+
+  // save the file
   load({dir, tests, testFile});
 }
diff --git a/src/modules/tests/test-run/run.ts b/src/modules/tests/test-run/run.ts
@@ -1,5 +1,14 @@
 import handleResult from './handle-result';
 
+/**
+ * call test runner
+ * @param  {} {hasTasks
+ * @param  {} dir
+ * @param  {} tutorial
+ * @param  {} taskPosition
+ * @param  {} testFile}
+ * @returns number
+ */
 export default function runTaskTests({
   hasTasks, dir, tutorial, taskPosition, testFile
 }): number {
diff --git a/src/modules/tests/test-run/testName.ts b/src/modules/tests/test-run/testName.ts
@@ -1,5 +1,16 @@
+/**
+ * turn a number into a two digit string
+ * for example: 1 -> '01'
+ */ 
 const twoDigitify = n => n > 9 ? '' + n : '0' + n;
 
+/**
+ * create a file name for the compiled test file
+ * for example: 'coderoad-functional-school__0.1.0__01'
+ * @param  {} {tutorial
+ * @param  {} pagePosition}
+ * @returns string
+ */
 export default function getTestName({tutorial, pagePosition}): string {
   if (!tutorial || !tutorial.name || !tutorial.version || typeof pagePosition !== 'number') {
     console.log('Error creating temporary test name');
