Verbose logging, which we can switch off with service

Author: David Milne

ask-logic.js

@@ -35,7 +35,7 @@ var AskLogic = angular.module('ask-logic', [])
 })
 
 
-.factory('AnswerStates', function() {
+.factory('AnswerStates', ['$log', function($log) {
 
 
 	function isSinglechoiceAnswered(answer) {
@@ -85,32 +85,54 @@ var AskLogic = angular.module('ask-logic', [])
 
 		isAnswered : function(field, answer) {
 
-			if (!answer)
+			if (!field) {
+				console.warn("tried to check answer to nonexistent field") ;
 				return false ;
+			}
+
+			if (!answer) {
+				$log.warn("tried to check undefined answer to field " + field.id)
+				return false ;
+			}
+
+			var answered = false ;
 
 			switch(field.type) {
 
 				case 'singlechoice' :
-					return isSinglechoiceAnswered(answer) ;
+					answered = isSinglechoiceAnswered(answer) ;
+					break ;
 				case 'multichoice' :
-					return isMultichoiceAnswered(answer) ;
+					answered = isMultichoiceAnswered(answer) ;
+					break ;
 				case 'numeric' :
-					return isNumericAnswered(answer) ;
+					answered = isNumericAnswered(answer) ;
+					break ;
 				case 'freetext' :
-					return isFreetextAnswered(answer) ;
+					answered = isFreetextAnswered(answer) ;
+					break ;
 				case 'mood' :
-					return isMoodAnswered(answer) ;
+					answered = isMoodAnswered(answer) ;
+					break ;
+				default :
+					$log.warn("cannot check answer of unknown field type " + field.type + " (" + field.id + ")") ;
+
 			}
 
-			return false ;
+			if (answered)
+				$log.debug(field.id + " IS answered") ;
+			else
+				$log.debug(field.id + " IS NOT answered") ;
+
+			return answered ;
 		} 
 	}
-})
+}])
 
 
 
 
-.factory('TriggerStates', ['Normalizer', function(Normalizer) {
+.factory('TriggerStates', ['$log','Normalizer', function($log, Normalizer) {
 
 	function isSinglechoiceTriggerFired(trigger, answer) {
 
@@ -255,21 +277,36 @@ var AskLogic = angular.module('ask-logic', [])
 
 		isFired : function (trigger, field, answer) {
 
+			var fired = false ;
+
 			switch(field.type) {
 
 				case 'singlechoice' :
-					return isSinglechoiceTriggerFired(trigger, answer) ;
+					fired = isSinglechoiceTriggerFired(trigger, answer) ;
+					break ;
 				case 'multichoice' :
-					return isMultichoiceTriggerFired(trigger, answer) ;
+					fired = isMultichoiceTriggerFired(trigger, answer) ;
+					break ;
 				case 'numeric' :
-					return isNumericTriggerFired(trigger, answer) ;
+					fired = isNumericTriggerFired(trigger, answer) ;
+					break ;
 				case 'freetext' :
-					return isFreetextTriggerFired(trigger, answer) ;
+					fired = isFreetextTriggerFired(trigger, answer) ;
+					break ;
 				case 'mood' : 
-					return isMoodTriggerFired(trigger, answer) ;
+					fired = isMoodTriggerFired(trigger, answer) ;
+					break ;
+				default :
+					$log.warn("could not identify fire state of trigger for field type " + field.type) ;
+					break ;
 			} 
 
-			return false ;
+			if (fired)
+				$log.debug("trigger " + JSON.stringify(trigger) + " IS fired") ;
+			else
+				$log.debug("trigger " + JSON.stringify(trigger) + " IS NOT fired") ;
+
+			return fired ;
 		} 
 	}
 }]) 
@@ -281,7 +318,7 @@ var AskLogic = angular.module('ask-logic', [])
 	Each SurveyState obj is instantiated with a schema and a response object, and provides methods to track what happens to the survey state 
 	(e.g current page, visible fields, etc). 
 */
-.factory('SurveyStates', ['TriggerStates', 'AnswerStates', function(TriggerStates, AnswerStates) {
+.factory('SurveyStates', ['$log','TriggerStates', 'AnswerStates', function($log, TriggerStates, AnswerStates) {
 
 
 	function SurveyState(schema, response) {
@@ -574,12 +611,17 @@ var AskLogic = angular.module('ask-logic', [])
 
 	SurveyState.prototype.handleAnswerChanged = function(fieldId) {
 
-		//console.log("Answer changed:" + fieldId) ;
+		$log.debug("answer changed for " + fieldId) ;
 
 		var field = this.fieldsById[fieldId] ;
 		var answer = this.response.answers[fieldId] ;
 
-		//console.log(this.response) ;
+		
+		if (field == undefined) {
+			$log.warn("Could not find field " + fieldId) ;
+			return ;
+		}
+
 
 		field.answered = AnswerStates.isAnswered(field, answer) ;
 
@@ -588,7 +630,7 @@ var AskLogic = angular.module('ask-logic', [])
 
 		_.each(field.relevantTriggers, function(trigger) {
 
-			//console.log("checking trigger: " + trigger.fieldRuleIndex);
+			$log.debug("  checking trigger: " + trigger.fieldRuleIndex);
 
 			var triggerFired = TriggerStates.isFired(trigger, field, answer) ;
 
@@ -603,9 +645,8 @@ var AskLogic = angular.module('ask-logic', [])
 
 	SurveyState.prototype.handleTriggerStateChanged = function(trigger) {
 
-		//console.log("trigger state changed") ;
-		//console.log(trigger);
-
+		$log.debug("state changed for trigger: " + JSON.stringify(trigger)) ;
+		
 		var ruleType, rule ;
 
 		if (trigger.fieldRuleIndex != null) {
@@ -655,13 +696,15 @@ var AskLogic = angular.module('ask-logic', [])
 
 	SurveyState.prototype.handleFieldRuleStateChanged = function(rule) {
 
-		//console.log("fieldRule state changed to " + rule.fired) ;
+
+
+		$log.debug("field rule state changed to " + rule.fired) ;
 
 		_.each(rule.actions, function(action) {
 
 			var field = this.fieldsById[action.fieldId] ;
 
-			//console.log("  - handling action to " + action.action + " " + action.fieldId) ;
+			$log.debug("  - handling action to " + action.action + " " + action.fieldId) ;
 
 			if (action.action == 'show') {
 				if (rule.fired)
@@ -678,23 +721,23 @@ var AskLogic = angular.module('ask-logic', [])
 			//if a field gets hidden, wipe any answers to it
 			if (field.fieldRuleState == "hide") {
 				if (AnswerStates.isAnswered(field, this.response.answers[field.id])) {
-					//console.log("Recursively clearing answer to " + field.id) ;
+
+					$log.debug("Recursively clearing answer to " + field.id) ;
+
 					this.response.answers[field.id] = {} ;
 					this.handleAnswerChanged(field.id) ;
 				}
 			}
 
 			this.updateVisibility(field) ;
 
-			//console.log("  - " + field.fieldRuleState) ;
-
 		}, this) ;
 	}
 
 	SurveyState.prototype.handlePageRuleStateChanged = function(rule) {
 
-		//console.log("rule state changed")
-		//console.log(rule) ;
+		$log.debug("page rule state changed to " + rule.fired) ;
+		$log.debug(rule) ;
 
 		//identify earliest effected page, which is the next page after the last trigger
 		var earliestEffectedPageIndex ;
@@ -707,8 +750,6 @@ var AskLogic = angular.module('ask-logic', [])
 		}, this) ;
 		earliestEffectedPageIndex ++ ;
 
-		//console.log("earliestEffectedPageIndex=" + earliestEffectedPageIndex) ;
-
 		_.each(rule.actions, function(action) {
 
 			switch (action.action) {

bower.json

@@ -1,6 +1,6 @@
 {
   "name": "ask-logic",
-  "version": "0.0.1",
+  "version": "0.0.5",
   "dependencies": {
     "angular": "latest",
     "lodash": "latest"

karma.conf.js

@@ -19,9 +19,8 @@ module.exports = function(config) {
       'bower_components/lodash/dist/lodash.js',
       'bower_components/angular-mocks/angular-mocks.js',
       'bower_components/angular-resource/angular-resource.js',
-
       'ask-logic.js',
-      'test/**/*.js',
+      'test/*.js',
 
       {pattern: 'test/schemas/*.json', watched: true, served: true, included: false}
     ],

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "angular-ask-2",
+  "name": "ask-logic-testing",
   "version": "0.0.0",
   "description": "",
   "main": "index.js",

test/chatScript-spec.js

@@ -130,7 +130,6 @@ describe('chatScript', function() {
 			response.answers["qAge"] = {number:12} ;
 			state.handleAnswerChanged("qAge") ;
 			state.handleContinue() ;
-			debugger;
 			expect(response.completed).toEqual(true) ;
 
 			state.handleBack() ;

test/chatVisitorFeedback-spec.js

@@ -2,18 +2,20 @@ describe('chatVisitorFeedback', function() {
 
 	var SurveyStates ;
 
-	beforeEach(function() {
-
-		module('ask-logic') ;
 
-		inject(function ($injector) {
-			SurveyStates = $injector.get('SurveyStates') ;
-		}) ;
+	beforeEach(module('ask-logic', function($provide) {
 
-		jasmine.getJSONFixtures().fixturesPath='base/test/schemas';
+	  	$provide.value('$log', console);
 
+	  	jasmine.getJSONFixtures().fixturesPath='base/test/schemas';
 		schema = getJSONFixture('chatVisitorFeedback.json') ;
+	})) ;
 
+	beforeEach(function() {
+
+		inject(function ($injector) {
+			SurveyStates = $injector.get('SurveyStates') ;
+		}) ;
 	}) ;
 
 	describe('initialization', function() {
@@ -47,6 +49,8 @@ describe('chatVisitorFeedback', function() {
 			expect(state.fieldRules.length).toEqual(2) ;
 		})
 
+		
+
 	}) ;
 
 

test/genderAndParenthood-spec.js

@@ -2,19 +2,21 @@ describe('genderAndParenthood', function() {
 
 	var SurveyStates ;
 
-	beforeEach(function() {
+	beforeEach(module('ask-logic', function($provide) {
 
-		module('ask-logic') ;
+	  $provide.value('$log', console);
 
-		inject(function ($injector) {
-			SurveyStates = $injector.get('SurveyStates') ;
-		}) ;
+	  jasmine.getJSONFixtures().fixturesPath='base/test/schemas';
+	  schema = getJSONFixture('genderAndParenthood.json') ;
 
-		jasmine.getJSONFixtures().fixturesPath='base/test/schemas';
+	})) ;
 
-		schema = getJSONFixture('genderAndParenthood.json') ;
+	beforeEach(
 
-	}) ;
+	 	inject(function ($injector) {
+	        SurveyStates = $injector.get('SurveyStates') ;
+		}) 
+	);
 
 	it ("Should inject blank answers for question fields", function() {
 
@@ -33,7 +35,6 @@ describe('genderAndParenthood', function() {
 
 		//can skip right to end if user doesn't give a gender,
 		//and then skip right back to start if they ask to go back
-
 		var response = {
 			answers:{
 				qGender:{choice:"I'd rather not say"},