docs(exceptionHandler): document testing

fredsa · mhevery · commit 1f8be1ca66b3 · 2013-01-17T23:11:02.000-08:00
Update src/ng/exceptionHandler.js

Here's an iniitla attempt at documenting how one might write a
test using $exceptionHandlerProvider. The key take-away is the use
of this pattern:

it(...

 module(...
   $exceptionHandlerProvider.mode('log');
 });

 inject(...
 );

});
diff --git a/src/ng/exceptionHandler.js b/src/ng/exceptionHandler.js
@@ -11,11 +11,12 @@
  * the browser console.
  *
  * In unit tests, if `angular-mocks.js` is loaded, this service is overridden by
- * {@link ngMock.$exceptionHandler mock $exceptionHandler}
+ * {@link ngMock.$exceptionHandler mock $exceptionHandler} which aids in testing.
  *
  * @param {Error} exception Exception associated with the error.
  * @param {string=} cause optional information about the context in which
  *       the error was thrown.
+ *
  */
 function $ExceptionHandlerProvider() {
   this.$get = ['$log', function($log){
diff --git a/src/ngMock/angular-mocks.js b/src/ngMock/angular-mocks.js
@@ -202,6 +202,30 @@ angular.mock.$Browser.prototype = {
  * Mock implementation of {@link ng.$exceptionHandler} that rethrows or logs errors passed
  * into it. See {@link ngMock.$exceptionHandlerProvider $exceptionHandlerProvider} for configuration
  * information.
+ *
+ *
+ * <pre>
+ *   describe('$exceptionHandlerProvider', function() {
+ *
+ *     it('should capture log messages and exceptions', function() {
+ *
+ *       module(function($exceptionHandlerProvider) {
+ *         $exceptionHandlerProvider.mode('log');
+ *       });
+ *
+ *       inject(function($log, $exceptionHandler, $timeout) {
+ *         $timeout(function() { $log.log(1); });
+ *         $timeout(function() { $log.log(2); throw 'banana peel'; });
+ *         $timeout(function() { $log.log(3); });
+ *         expect($exceptionHandler.errors).toEqual([]);
+ *         expect($log.assertEmpty());
+ *         $timeout.flush();
+ *         expect($exceptionHandler.errors).toEqual(['banana peel']);
+ *         expect($log.log.logs).toEqual([[1], [2], [3]]);
+ *       });
+ *     });
+ *   });
+ * </pre>
  */
 
 angular.mock.$ExceptionHandlerProvider = function() {

Original file line number	Diff line number	Diff line change
`@@ -11,11 +11,12 @@`
`11`	`11`	`* the browser console.`
`12`	`12`	`*`
`13`	`13`	* In unit tests, if `angular-mocks.js` is loaded, this service is overridden by
`14`		`- * {@link ngMock.$exceptionHandler mock $exceptionHandler}`
	`14`	`+ * {@link ngMock.$exceptionHandler mock $exceptionHandler} which aids in testing.`
`15`	`15`	`*`
`16`	`16`	`* @param {Error} exception Exception associated with the error.`
`17`	`17`	`* @param {string=} cause optional information about the context in which`
`18`	`18`	`* the error was thrown.`
	`19`	`+ *`
`19`	`20`	`*/`
`20`	`21`	`function $ExceptionHandlerProvider() {`
`21`	`22`	`this.$get = ['$log', function($log){`