update parser tests

ShMcK · ShMcK · commit 323433b115c7 · 2016-09-11T11:12:21.000-07:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,10 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.12.3] - WIP
+- improved page open. uses `onDidOpen` callback
+- improved documentation, tests
+
 ## [0.12.2] - 2016-08-25
 - drop "core-coderoad" dependency
 - remove additional dependencies for a smaller footprint
diff --git a/src/modules/page/actions.ts b/src/modules/page/actions.ts
@@ -1,13 +1,29 @@
 import {hintPositionSet, routeSet, testLoad} from '../../actions';
 import {PAGE_SET} from './types';
 
+/**
+ * calls PAGE_SET with next page
+ * @param  {} any
+ * @returns thunk
+ */
 export function pageNext(): Redux.ThunkAction<any, any, {}> {
   return (dispatch, getState): void => {
     let {pagePosition} = getState();
     dispatch(pageSet(pagePosition + 1));
   };
 }
 
+/**
+ * PAGE_SET action creator
+ * 
+ * opens new page, sets hintPosition to 0, resets tasks
+ * loads tests
+ * 
+ * if final page, routes to final
+ * 
+ * @param  {} pagePosition=0
+ * @returns thunk
+ */
 export function pageSet(pagePosition = 0): Redux.ThunkAction<any, any, {}> {
   return (dispatch, getState): void => {
     const state = getState();
diff --git a/src/modules/page/task-actions/handle-action-string.ts b/src/modules/page/task-actions/handle-action-string.ts
@@ -14,7 +14,7 @@ const Type = {
 // parse task string for command/params
 export default function handleActionString(
   actionString: string
-): Promise<void> {
+): Promise<any> {
   return new Promise((resolve, reject) => {
     if (typeof actionString !== 'string') {
       reject(actionString);
diff --git a/src/modules/page/task-actions/handle-actions.ts b/src/modules/page/task-actions/handle-actions.ts
@@ -1,5 +1,10 @@
 import handleActionString from './handle-action-string';
 
+/**
+ * call each task action in sequential order
+ * @param  {string[][]} actions
+ * @returns void
+ */
 export default function handleTaskActions(actions: string[][]): void {
   const next = actions.shift();
   if (next && next.length) {
diff --git a/src/modules/page/task-actions/index.ts b/src/modules/page/task-actions/index.ts
@@ -3,7 +3,12 @@ import handleTaskActions from './handle-actions';
 
 // trigger actions only once, moving fowards
 let taskPositionTracker = 0;
-
+/**
+ * task action reducer
+ * @param  {} t=[]
+ * @param  {Action} action
+ * @returns string[][] array of array of actions
+ */
 export default function taskActionsReducer(
   t = [], action: Action
 ): string[][] {
diff --git a/src/modules/page/task-actions/parser.spec.ts b/src/modules/page/task-actions/parser.spec.ts
diff --git a/src/modules/page/task-actions/parser.test.ts b/src/modules/page/task-actions/parser.test.ts
@@ -0,0 +1,44 @@
+/// <reference path="../../../typings/globals/jest/index.d.ts" />
+
+import parseParams from './parse-params';
+
+describe('parseBreaks', function() {
+
+  describe('getParams', function() {
+    it('should return the same string in an array if only one param', function () {
+      let params = 'first';
+      let parser = new parseParams();
+      let breaks = parser.getParams(params);
+      expect(breaks).toEqual(['first']);
+    });
+
+    it('should return params in a simple string', function() {
+      let params = 'first, second, third';
+      let parser = new parseParams();
+      let breaks = parser.getParams(params);
+      expect(breaks).toEqual(['first', 'second', 'third']);
+    });
+
+    it('should ignore breaks within an object', function() {
+      let params = '{ a: 1, b: 2 }, second, third';
+      let parser = new parseParams();
+      let breaks = parser.getParams(params);
+      expect(breaks).toEqual(['{ a: 1, b: 2 }', 'second', 'third']);
+    });
+
+    it('should ignore breaks within an array', function() {
+      let params = '[ a: 1, b: 2 ], second, third';
+      let parser = new parseParams();
+      let breaks = parser.getParams(params);
+      expect(breaks).toEqual(['[ a: 1, b: 2 ]', 'second', 'third']);
+    });
+
+    it('should ignore breaks within brackets', function() {
+      let params = 'function (a, b) {}, second, third';
+      let parser = new parseParams();
+      let breaks = parser.getParams(params);
+      expect(breaks).toEqual(['function (a, b) {}', 'second', 'third']);
+    });
+  });
+
+});
diff --git a/src/modules/page/task-actions/parser.ts b/src/modules/page/task-actions/parser.ts
@@ -1,5 +1,11 @@
 import ParseParams from './parse-params';
 
+/**
+ * gets the command from the front of an action
+ * example: open('file.js') -> open
+ * @param  {string} actionString
+ * @returns string action command
+ */
 export function getCommand(actionString: string): string {
   // content before bracket
   let command = actionString.substring(0, actionString.indexOf('('));
@@ -10,6 +16,12 @@ export function getCommand(actionString: string): string {
   return command;
 }
 
+/**
+ * gets the params from an action
+ * example: open('file.js') -> file.js
+ * @param  {string} actionString
+ * @returns string action params
+ */
 export function getParams(actionString: string): string[] {
   // content in brackets, split by comma
   let parser = new ParseParams();
@@ -23,6 +35,11 @@ export function getParams(actionString: string): string[] {
   return paramsList;
 }
 
+/**
+ * 
+ * @param  {string} text
+ * @returns Object
+ */
 function createObjectFromKeyValString(text: string): Object {
   let keyValList: string[] = text.split(/[:,]/);
   let obj = {};
@@ -41,6 +58,11 @@ function createObjectFromKeyValString(text: string): Object {
   return obj;
 }
 
+/**
+ * get options from an action string
+ * @param  {string} paramString
+ * @returns Object
+ */
 export function getOptions(paramString: string): { param: string, options: Object } {
   let hasOptions = paramString.match(/\{(.+)?\}/);
   let options = {};
diff --git a/src/modules/page/task-actions/reducer.test.ts b/src/modules/page/task-actions/reducer.test.ts
@@ -0,0 +1,16 @@
+/// <reference path="../../../typings/globals/jest/index.d.ts" />
+
+import reducer from './index';
+
+describe('task-action reducer', () => {
+
+  // it('does nothing if no known action is called', () => {
+  //   const action = { type: 'unknown' };
+  //   expect(reducer([], action)).toEqual([]);
+  // });
+
+  it('demo', () => {
+    expect(true).toBe(true);
+  });
+
+});
diff --git a/src/modules/page/task-tests/index.ts b/src/modules/page/task-tests/index.ts
@@ -2,13 +2,20 @@ import {readFileSync} from 'fs';
 
 import {PAGE_SET} from '../types';
 
+/**
+ * task test reducer
+ * @param  {} taskTests=''
+ * @param  {Action} action
+ * @returns string
+ */
 export default function taskTestsReducer(
   taskTests = '', action: Action
 ): string {
   switch (action.type) {
 
     case PAGE_SET:
-      const {tutorial, tasks} = action.payload;
+      const {tasks} = action.payload;
+      
       // map over task tests from coderoad.json
       return [].concat.apply([], tasks.map(
           task => task.tests || []
@@ -20,7 +27,7 @@ export default function taskTestsReducer(
         } catch (e) {
           console.log('Error reading test file', e);
         }
-        // return concatted test files
+        // return concatenated test files
         return output;
       }, '');
 
diff --git a/src/modules/page/task-tests/reducer.test.ts b/src/modules/page/task-tests/reducer.test.ts
@@ -0,0 +1,17 @@
+/// <reference path="../../../typings/globals/jest/index.d.ts" />
+
+import reducer from './index';
+
+describe('task tests reducer', () => {
+
+  it('does nothing if no known action', () => {
+    const action = { type: 'unknown' };
+    expect(reducer(undefined, action)).toBe('');
+  });
+
+  // it('handles PAGE_SET', () => {
+  //   const tutorial = {};
+  //   const tasks = [];
+  // });
+
+});
