update docs for mocha-coderoad@0.10 and next atom version

ShMcK · ShMcK · commit 9a63d87a80e5 · 2016-08-08T17:04:51.000-07:00
diff --git a/_posts/tutorial-docs/2016-01-02-coderoad-api.md b/_posts/tutorial-docs/2016-01-02-coderoad-api.md
@@ -44,7 +44,7 @@ Defaults for loading tests are specified in the tutorial *package.json* file.
   "config": {
     "language": "JS",
     "dir": "tutorial",
-    "testSuffix": ".spec.js",
+    "testSuffix": ".js",
     "runner": "mocha-coderoad"
   }
 }
diff --git a/_posts/tutorial-docs/2016-01-04-loaders.md b/_posts/tutorial-docs/2016-01-04-loaders.md
@@ -6,11 +6,58 @@ categories:
 - tutorial-docs
 ---
 
-Loaders are hidden behind comments, which may differ based on the programming language or compiler.
+Use a **loader** to run the user saved file in the context of your file. Think of a loader as a way to place the file your testing inside of your test file.
 
-##### JavaScript / TypeScript / JSX
+```js
+// paths are prefixed with "BASE"
+const userTextEditorContent = require('BASE/path/to/file');
+const dataFile = require('BASE/path/to/data');
+```
 
-`/// load('file.js')`
+The keyword "BASE" will be over-ridden with an absolute path to the file.
 
-##### Python
-`# load('file.py')`
+*Note: When using spies, stubs or mocks, initiate them above your loader call.*
+
+
+### Testing
+
+If the editor exports a variable or function, units tests are easy to setup.
+
+##### user file
+
+```js
+export const a = 1;
+```
+
+##### unit test
+
+```js
+expect(a).to.be(1);
+```
+
+Otherwise, there is a slightly more complicated way to test globals.
+
+### Unit Tests with Globals
+
+Running unit tests on globals requires two additional steps.
+
+1. capture the file as a module
+2. use a built-in `__get__` method to capture the target
+
+##### user file
+
+```js
+const a = 1;
+```
+
+##### unit test
+
+```js
+// 1. capture the file's module.
+// Note that BASE will be replaced with an absolute path to the project dir
+const file = require('BASE/path/to/file.js');
+// 2. use the __get__ method to capture the target variable
+const a = filter.__get__('a');
+
+expect(a).to.be(1);
+```
diff --git a/_posts/tutorial-docs/2016-01-06-test-examples.md b/_posts/tutorial-docs/2016-01-06-test-examples.md
@@ -11,67 +11,67 @@ Here are examples using *mocha* with *chai*'s *expect*. See the [Chai/Expect doc
 #### exists
 
 ```js
-it('doesn\'t exist', function() {
+it('doesn\'t exist', () => {
     expect(target).to.be.defined;
 });
 ```
 
 #### type
 
 ```js
-it('should be a function', function() {
+it('should be a function', () => {
     expect(target).to.be.a('function');
 });
 ```
 
 #### function params
 
 ```js
-it('should have two parameters', function() {
+it('should have two parameters', () => {
     expect(target).to.have.length(2);
 });
 ```
 
 #### function returns
 
 ```js
-it('should add one to the number', function () {
+it('should add one to the number', () => {
     expect(addOne(1)).to.equal(2);
 });
 ```
 
 #### equals
 
 ```js
-it('should be 42', function () {
+it('should be 42', () => {
     expect(target).to.equal(42);
 });
 ```
 
 #### deep equals (with objects or arrays)
 
 ```js
-it('should be {a: 42}', function () {
+it('should be {a: 42}', () => {
     expect(target).to.deep.equal({a: 42});
 });
 ```
 
 #### regex
 
 ```js
-it('should include the variable "count"', function () {
-    var regex = new RegExp('count');
-    var string = target.toString();
+it('should include the variable "count"', () => {
+    const regex = new RegExp('count');
+    const string = target.toString();
     expect(string).to.match(regex);
 });
 ```
 
 ```js
-it('should access the property "prop"', function () {
-    var regex1 = /\.prop/;            // dot notation
-    var regex2 = /\[["']prop["']\]/;  // bracket notation
-    var string = target.toString();
-    var result = !!string.match(regex1) || !!string.match(regex2);
+it('should access the property "prop"', () => {
+    const regex1 = /\.prop/;            // dot notation
+    const regex2 = /\[["']prop["']\]/;  // bracket notation
+    const string = target.toString();
+    const result = !!string.match(regex1) || !!string.match(regex2);
     expect(result).to.be.true;
 });
 ```
@@ -83,15 +83,18 @@ You can use [*sinon*](http://sinonjs.org/docs/) or [*chai-spies*](https://github
 `> npm i -s chai-spies`
 
 ```js
-var chai = require('chai'),
-    spies = require('chai-spies');
-var expect = chai.expect;
-    chai.use(spies);
+const chai = require('chai');
+const spies = require('chai-spies');
+const expect = chai.expect;
+chai.use(spies);
 
-var spy = chai.spy.on(console, 'log');
-loadJS('04-forEach.js');
+// setup the console.log spy listener
+let spy = chai.spy.on(console, 'log');
 
-it('should write "hello world" to the console', function () {
+// load the user file content
+const example = require('BASE/path/to/example.js');
+
+it('should write "hello world" to the console', () => {
     expect(spy).to.have.been.called.with('hello world');
 });
 ```
@@ -105,7 +108,7 @@ Some variables are passed into the test runner through the node environment *pro
 See an example of dynamic data based on the task position below:
 
 ```js
-var data = [1, 2, 3];
+const data = [1, 2, 3];
 
 if (process.env.TASK_POSITION === '4') {
     data = [1, 2, 3, 4];
diff --git a/_posts/tutorial-docs/2016-01-07-config.md b/_posts/tutorial-docs/2016-01-07-config.md
@@ -12,7 +12,7 @@ CodeRoad tutorial configurations can be set in the *package.json* config.
   "config": {
     "language": "JS",
     "dir": "tutorial",
-    "testSuffix": ".spec.js",
+    "testSuffix": ".js",
     "runner": "mocha-coderoad",
     "edit": true
   }

Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ Defaults for loading tests are specified in the tutorial package.json file.`
`44`	`44`	`"config": {`
`45`	`45`	`"language": "JS",`
`46`	`46`	`"dir": "tutorial",`
`47`		`- "testSuffix": ".spec.js",`
	`47`	`+ "testSuffix": ".js",`
`48`	`48`	`"runner": "mocha-coderoad"`
`49`	`49`	`}`
`50`	`50`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ CodeRoad tutorial configurations can be set in the package.json config.`
`12`	`12`	`"config": {`
`13`	`13`	`"language": "JS",`
`14`	`14`	`"dir": "tutorial",`
`15`		`- "testSuffix": ".spec.js",`
	`15`	`+ "testSuffix": ".js",`
`16`	`16`	`"runner": "mocha-coderoad",`
`17`	`17`	`"edit": true`
`18`	`18`	`}`