Merge pull request #2131 from medic/refactor-task-generator

Refactor task generator
medic · Mar 23, 2016 · 1587108 · 1587108
2 parents 21e93d1 + 1695d4d
commit 1587108
Show file tree

Hide file tree

Showing 9 changed files with 58 additions and 58 deletions.
diff --git a/static/js/controllers/contacts-content.js b/static/js/controllers/contacts-content.js
@@ -6,9 +6,9 @@ var _ = require('underscore');
 
   var inboxControllers = angular.module('inboxControllers');
 
-  inboxControllers.controller('ContactsContentCtrl', 
-    ['$parse', '$scope', '$stateParams', '$q', '$log', 'DB', 'TaskGenerator', 'Search', 'Changes', 'ContactSchema', 'UserDistrict', 'XmlForms',
-    function($parse, $scope, $stateParams, $q, $log, DB, TaskGenerator, Search, Changes, ContactSchema, UserDistrict, XmlForms) {
+  inboxControllers.controller('ContactsContentCtrl',
+    ['$parse', '$scope', '$stateParams', '$q', '$log', 'DB', 'RulesEngine', 'Search', 'Changes', 'ContactSchema', 'UserDistrict', 'XmlForms',
+    function($parse, $scope, $stateParams, $q, $log, DB, RulesEngine, Search, Changes, ContactSchema, UserDistrict, XmlForms) {
 
       $scope.showParentLink = false;
 
@@ -164,7 +164,7 @@ var _ = require('underscore');
           patientIds = _.pluck($scope.selected.children, 'id');
         }
         patientIds.push($scope.selected.doc._id);
-        TaskGenerator.listen('ContactsContentCtrl', 'task', function(err, tasks) {
+        RulesEngine.listen('ContactsContentCtrl', 'task', function(err, tasks) {
           if (err) {
             return $log.error('Error getting tasks', err);
           }

diff --git a/static/js/controllers/inbox.js b/static/js/controllers/inbox.js
@@ -15,8 +15,8 @@ var feedback = require('../modules/feedback'),
   var inboxControllers = angular.module('inboxControllers', []);
 
   inboxControllers.controller('InboxCtrl',
-    ['$window', '$scope', '$translate', '$rootScope', '$state', '$timeout', '$log', '$http', 'translateFilter', 'Facility', 'FacilityHierarchy', 'Form', 'Settings', 'UpdateSettings', 'Contact', 'Language', 'LiveListConfig', 'ReadMessages', 'UpdateUser', 'SendMessage', 'UserDistrict', 'CheckDate', 'DeleteDoc', 'DownloadUrl', 'SetLanguageCookie', 'CountMessages', 'BaseUrlService', 'DBSync', 'Snackbar', 'UserSettings', 'APP_CONFIG', 'DB', 'Session', 'Enketo', 'Changes', 'AnalyticsModules', 'Auth', 'TrafficStats', 'XmlForms', 'TaskGenerator', 'CONTACT_TYPES',
-    function ($window, $scope, $translate, $rootScope, $state, $timeout, $log, $http, translateFilter, Facility, FacilityHierarchy, Form, Settings, UpdateSettings, Contact, Language, LiveListConfig, ReadMessages, UpdateUser, SendMessage, UserDistrict, CheckDate, DeleteDoc, DownloadUrl, SetLanguageCookie, CountMessages, BaseUrlService, DBSync, Snackbar, UserSettings, APP_CONFIG, DB, Session, Enketo, Changes, AnalyticsModules, Auth, TrafficStats, XmlForms, TaskGenerator, CONTACT_TYPES) {
+    ['$window', '$scope', '$translate', '$rootScope', '$state', '$timeout', '$log', '$http', 'translateFilter', 'Facility', 'FacilityHierarchy', 'Form', 'Settings', 'UpdateSettings', 'Contact', 'Language', 'LiveListConfig', 'ReadMessages', 'UpdateUser', 'SendMessage', 'UserDistrict', 'CheckDate', 'DeleteDoc', 'DownloadUrl', 'SetLanguageCookie', 'CountMessages', 'BaseUrlService', 'DBSync', 'Snackbar', 'UserSettings', 'APP_CONFIG', 'DB', 'Session', 'Enketo', 'Changes', 'AnalyticsModules', 'Auth', 'TrafficStats', 'XmlForms', 'RulesEngine', 'CONTACT_TYPES',
+    function ($window, $scope, $translate, $rootScope, $state, $timeout, $log, $http, translateFilter, Facility, FacilityHierarchy, Form, Settings, UpdateSettings, Contact, Language, LiveListConfig, ReadMessages, UpdateUser, SendMessage, UserDistrict, CheckDate, DeleteDoc, DownloadUrl, SetLanguageCookie, CountMessages, BaseUrlService, DBSync, Snackbar, UserSettings, APP_CONFIG, DB, Session, Enketo, Changes, AnalyticsModules, Auth, TrafficStats, XmlForms, RulesEngine, CONTACT_TYPES) {
 
       Session.init();
 
@@ -33,7 +33,7 @@ var feedback = require('../modules/feedback'),
         $scope.initialReplication = result;
       });
 
-      TaskGenerator.init
+      RulesEngine.init
         .then(function() {
           $scope.dbWarmedUp = true;
         })

diff --git a/static/js/services/index.js b/static/js/services/index.js
@@ -52,7 +52,7 @@
   require('./settings');
   require('./snackbar');
   require('./target-generator');
-  require('./task-generator');
+  require('./rules-engine');
   require('./traffic-stats');
   require('./translate-from');
   require('./update-contact');

diff --git a/static/js/services/live-list.js b/static/js/services/live-list.js
@@ -11,9 +11,9 @@ function PARSER($parse, scope) {
 // This service should be invoked once at startup.
 angular.module('inboxServices').factory('LiveListConfig', [
   '$log', '$parse', '$templateCache', '$timeout',
-      'Changes', 'DB', 'LiveList', 'TaskGenerator', 'CONTACT_TYPES',
+      'Changes', 'DB', 'LiveList', 'RulesEngine', 'CONTACT_TYPES',
   function($log, $parse, $templateCache, $timeout,
-      Changes, DB, LiveList, TaskGenerator, CONTACT_TYPES) {
+      Changes, DB, LiveList, RulesEngine, CONTACT_TYPES) {
     // Configure LiveList service
     return function($scope) {
 
@@ -139,7 +139,7 @@ angular.module('inboxServices').factory('LiveListConfig', [
 
       LiveList.tasks.set([]);
 
-      TaskGenerator.listen('tasks-list', 'task', function(err, tasks) {
+      RulesEngine.listen('tasks-list', 'task', function(err, tasks) {
         if (err) {
           $log.error('Error getting tasks', err);
 

diff --git a/static/js/services/task-generator.js → static/js/services/rules-engine.js b/static/js/services/task-generator.js → static/js/services/rules-engine.js
@@ -10,7 +10,7 @@ var nools = require('nools'),
 
   var inboxServices = angular.module('inboxServices');
 
-  inboxServices.factory('TaskGenerator', ['$q', '$log', 'Search', 'Settings', 'Changes', 'CONTACT_TYPES',
+  inboxServices.factory('RulesEngine', ['$q', '$log', 'Search', 'Settings', 'Changes', 'CONTACT_TYPES',
     function($q, $log, Search, Settings, Changes, CONTACT_TYPES) {
 
       var callbacks = {};
@@ -127,10 +127,10 @@ var nools = require('nools'),
         });
       };
 
-      var getTasks = function() {
+      var assertFacts = function() {
         knownTypes.forEach(function(type) {
-          session.on(type, function(task) {
-            notifyCallbacks(task, type);
+          session.on(type, function(fact) {
+            notifyCallbacks(fact, type);
           });
         });
         facts.forEach(function(fact) {
@@ -139,7 +139,7 @@ var nools = require('nools'),
         session.matchUntilHalt().then(
           // halt
           function() {
-            notifyError(new Error('Unexpected halt in task generation rules.'));
+            notifyError(new Error('Unexpected halt in fact assertion.'));
           },
           // error
           notifyError
@@ -165,7 +165,7 @@ var nools = require('nools'),
         }
       };
 
-      var updateTasks = function(change) {
+      var updateFacts = function(change) {
         var fact;
         if (change.deleted) {
           fact = findFact(change.id);
@@ -216,8 +216,8 @@ var nools = require('nools'),
 
       var registerListener = function() {
         Changes({
-          key: 'task-generator',
-          callback: updateTasks,
+          key: 'rules-engine',
+          callback: updateFacts,
           filter: function(change) {
             return change.doc.form ||
                    CONTACT_TYPES.indexOf(change.doc.type) !== -1;
@@ -250,7 +250,7 @@ var nools = require('nools'),
           return $q.all([ getDataRecords(), getContacts() ])
             .then(function(results) {
               facts = deriveFacts(results[0], results[1]);
-              getTasks();
+              assertFacts();
             });
         });
 
@@ -272,4 +272,4 @@ var nools = require('nools'),
     }
   ]);
 
-}()); 
+}());
diff --git a/static/js/services/target-generator.js b/static/js/services/target-generator.js
@@ -7,8 +7,8 @@ var moment = require('moment'),
 
   var inboxServices = angular.module('inboxServices');
 
-  inboxServices.factory('TargetGenerator', ['$q', '$log', 'Settings', 'TaskGenerator',
-    function($q, $log, Settings, TaskGenerator) {
+  inboxServices.factory('TargetGenerator', ['$q', '$log', 'Settings', 'RulesEngine',
+    function($q, $log, Settings, RulesEngine) {
 
       var targets = [];
 
@@ -62,7 +62,7 @@ var moment = require('moment'),
       return function(callback) {
         init
           .then(function() {
-            TaskGenerator.listen('TargetGenerator', 'target', function(err, _targets) {
+            RulesEngine.listen('TargetGenerator', 'target', function(err, _targets) {
               if (!err) {
                 _targets.forEach(mergeTarget);
               }
@@ -74,4 +74,4 @@ var moment = require('moment'),
     }
   ]);
 
-}()); 
+}());
diff --git a/tests/karma/unit/controllers/inbox.js b/tests/karma/unit/controllers/inbox.js
@@ -127,7 +127,7 @@ describe('InboxCtrl controller', function() {
       $provide.factory('UserSettings', function() {
         return sinon.stub();
       });
-      $provide.value('TaskGenerator', { init: KarmaUtils.nullPromise()() });
+      $provide.value('RulesEngine', { init: KarmaUtils.nullPromise()() });
       $provide.factory('$window', function() {
         return sinon.stub();
       });

diff --git a/tests/karma/unit/services/task-generator.js → tests/karma/unit/services/rules-engine.js b/tests/karma/unit/services/task-generator.js → tests/karma/unit/services/rules-engine.js
@@ -1,4 +1,4 @@
-describe('TaskGenerator service', function() {
+describe('RulesEngine service', function() {
 
   'use strict';
 
@@ -212,7 +212,7 @@ describe('TaskGenerator service', function() {
         schedules: schedules
       }
     }));
-    var service = injector.get('TaskGenerator');
+    var service = injector.get('RulesEngine');
     service.listen('test', 'task', function(err) {
       chai.expect(err).to.equal('boom');
       chai.expect(Search.callCount).to.equal(2);
@@ -222,7 +222,7 @@ describe('TaskGenerator service', function() {
 
   it('returns settings errors', function(done) {
     Settings.returns(KarmaUtils.mockPromise('boom'));
-    var service = injector.get('TaskGenerator');
+    var service = injector.get('RulesEngine');
     service.listen('test', 'task', function(err) {
       chai.expect(err).to.equal('boom');
       chai.expect(Settings.callCount).to.equal(1);
@@ -232,7 +232,7 @@ describe('TaskGenerator service', function() {
 
   it('returns empty when settings returns no config', function(done) {
     Settings.returns(KarmaUtils.mockPromise(null, {}));
-    var service = injector.get('TaskGenerator');
+    var service = injector.get('RulesEngine');
     service.listen('test', 'task', function(err, actual) {
       chai.expect(Search.callCount).to.equal(0);
       chai.expect(Settings.callCount).to.equal(1);
@@ -322,7 +322,7 @@ describe('TaskGenerator service', function() {
       }
     };
 
-    var service = injector.get('TaskGenerator');
+    var service = injector.get('RulesEngine');
     var callbackCount = 0;
     service.listen('test', 'task', function(err, actuals) {
       actuals.forEach(function(actual) {
@@ -356,7 +356,7 @@ describe('TaskGenerator service', function() {
       }
     }));
 
-    var service = injector.get('TaskGenerator');
+    var service = injector.get('RulesEngine');
     var expected = {};
     service.listen('test', 'task', function(err, results) {
       results.forEach(function(result) {
@@ -404,7 +404,7 @@ describe('TaskGenerator service', function() {
     }));
 
     var callbackCount = 0;
-    var service = injector.get('TaskGenerator');
+    var service = injector.get('RulesEngine');
     service.listen('test', 'task', function(err, actual) {
       callbackCount++;
       if (callbackCount === 4) {
@@ -456,7 +456,7 @@ describe('TaskGenerator service', function() {
     }));
 
     var callbackCount = 0;
-    var service = injector.get('TaskGenerator');
+    var service = injector.get('RulesEngine');
     service.listen('test', 'task', function(err, actual) {
       callbackCount++;
       if (callbackCount === 4) {
@@ -502,7 +502,7 @@ describe('TaskGenerator service', function() {
     }));
 
     var callbackCount = 0;
-    var service = injector.get('TaskGenerator');
+    var service = injector.get('RulesEngine');
     service.listen('test', 'task', function(err, actual) {
       if (err) {
         return done(err);
@@ -559,7 +559,7 @@ describe('TaskGenerator service', function() {
     }));
 
     var callbackCount = 0;
-    var service = injector.get('TaskGenerator');
+    var service = injector.get('RulesEngine');
     service.listen('test', 'task', function(err, actual) {
       if (err) {
         return done(err);
@@ -608,7 +608,7 @@ describe('TaskGenerator service', function() {
     }));
 
     var callbackCount = 0;
-    var service = injector.get('TaskGenerator');
+    var service = injector.get('RulesEngine');
     service.listen('test', 'task', function(err, actual) {
       if (err) {
         return done(err);
@@ -657,7 +657,7 @@ describe('TaskGenerator service', function() {
     }));
 
     var callbackCount = 0;
-    var service = injector.get('TaskGenerator');
+    var service = injector.get('RulesEngine');
     service.listen('test', 'task', function(err, actual) {
       if (err) {
         return done(err);