feat(core): remove add method from task manager in favor of get subscribers method

Ovidiu Barabula · Ovidiu Barabula · commit e6d7bd9fbdbb · 2018-03-31T14:57:23.000+03:00
diff --git a/src/task-manager/index.spec.ts b/src/task-manager/index.spec.ts
@@ -28,7 +28,7 @@ describe('TaskManager', () => {
     const taskManager = TaskManager();
     expect(taskManager)
       .to.be.an('object')
-      .to.have.all.keys('add', 'run', 'hasTasks', 'getHooks', 'getTasks');
+      .to.have.all.keys('getSubscribers', 'run', 'hasTasks', 'getHooks', 'getTasks');
   });
 
 
@@ -53,36 +53,37 @@ describe('TaskManager', () => {
       },
     };
 
-    taskManager.add(task);
+    task.install(taskManager.getSubscribers());
   });
 
 
   it('subscribes task to hook', () => {
     const taskManager = TaskManager(options);
+    const subscribers = taskManager.getSubscribers();
     const task = makeTask('before');
 
-    taskManager.add(task);
+    task.install(subscribers);
 
     expect(taskManager.getTasks().before)
       .to.be.an('array')
       .to.have.members(['before-task']);
   });
 
 
-  it('returns true on task subscription', () => {
-    const taskManager = TaskManager(options);
+  it('returns true on task subscription', async () => {
     const task = {
-      install(subscriptions: TaskSubscriber) {
-        expect(subscriptions.before('before-task')).to.be.true;
+      install(subscribers: TaskSubscriber) {
+        expect(subscribers.before('before-task')).to.be.true;
       },
     };
-    taskManager.add(task);
+    const taskSubscribers = TaskManager(options).getSubscribers();
+    task.install(taskSubscribers);
   });
 
 
   it('returns true when task is run', async () => {
     const taskManager = TaskManager(options);
-    taskManager.add(makeTask('before'));
+    makeTask('before').install(taskManager.getSubscribers());
     expect(await taskManager.run('before')).to.be.true;
   });
 
@@ -95,7 +96,7 @@ describe('TaskManager', () => {
 
   it('returns true if specific hook has tasks', () => {
     const taskManager = TaskManager(options);
-    taskManager.add(makeTask('before'));
+    makeTask('before').install(taskManager.getSubscribers());
     expect(taskManager.hasTasks('before')).to.be.true;
   });
 
@@ -106,12 +107,6 @@ describe('TaskManager', () => {
   });
 
 
-  it('throws when .add() doesn\'t receive appropriate task', () => {
-    const taskManager = TaskManager(options);
-    assert.throws(() => taskManager.add(undefined), ERRORS.BAD_TASK);
-  });
-
-
   it('returns false when trying to subscribe an already subscribed task name', () => {
     const task1 = {
       install(subscriptions: TaskSubscriber) {
@@ -125,8 +120,8 @@ describe('TaskManager', () => {
     };
 
     const taskManager = TaskManager(options);
-    taskManager.add(task1);
-    taskManager.add(task2);
+    task1.install(taskManager.getSubscribers());
+    task2.install(taskManager.getSubscribers());
   });
 
 
@@ -138,6 +133,6 @@ describe('TaskManager', () => {
       },
     };
     const taskManager = TaskManager(options);
-    taskManager.add(abusingTask);
+    abusingTask.install(taskManager.getSubscribers());
   });
 });
diff --git a/src/task-manager/index.ts b/src/task-manager/index.ts
@@ -6,13 +6,14 @@
  */
 
 import * as gulp from 'gulp';
+import { QuestionnaireSubscriber } from '../config-wizard';
 import { hasNested, limitFn } from '../util/utility-functions';
 
 
 export interface Task {
   name?: string;
   description?: string;
-  install(subscriber: TaskSubscriber): void;
+  install(subscriber: TaskSubscriber, configSubscriber: QuestionnaireSubscriber): Promise<void>;
 }
 
 export interface Tasks {
@@ -24,8 +25,8 @@ export interface TaskSubscriber {
 }
 
 export interface TaskManager {
-  add(task: Task): void;
   run(hook: string): Promise<boolean>;
+  getSubscribers(): TaskSubscriber;
   hasTasks?(hook: string): boolean;
   getTasks?(): Tasks;
   getHooks?(): string[];
@@ -55,23 +56,6 @@ function TaskManager(options?: TaskManagerOptions): TaskManager {
   }
 
 
-  /**
-   * Register new task
-   * @param task Task object
-   */
-  function add(task: Task): void {
-    if (
-      typeof task !== 'object' ||
-      !task.hasOwnProperty('install') ||
-      typeof task.install !== 'function'
-    ) {
-      throw new Error(ERRORS.BAD_TASK);
-    }
-
-    task.install(Object.freeze(createSubscriptions()));
-  }
-
-
   /**
    * Runs tasks associated with the passed hook
    * @param hook Name of the hook
@@ -114,6 +98,14 @@ function TaskManager(options?: TaskManagerOptions): TaskManager {
   }
 
 
+  /**
+   * Return task subscribers object
+   */
+  function getSubscribers(): TaskSubscriber {
+    return createSubscriptions();
+  }
+
+
   function subscribe(task: string, hook: string): boolean {
     // Create new array for hook, if not available
     if (!hasNested(tasks, hook)) {
@@ -158,7 +150,7 @@ function TaskManager(options?: TaskManagerOptions): TaskManager {
 
   // Creating the public API object
   let publicApi: TaskManager = {
-    add,
+    getSubscribers,
     run,
   };
 
