feat(core): add getter for dependencies subscriber function

Ovidiu Barabula · Ovidiu Barabula · commit 377efc4d14a0 · 2018-05-08T16:32:12.000+03:00
diff --git a/src/util/dependencies-installer.spec.ts b/src/util/dependencies-installer.spec.ts
@@ -10,6 +10,7 @@ import { stdout } from 'test-console';
 import { StringIncludesAll } from '../../test/utilities';
 import InstallerSingleton, {
   DependenciesInstaller,
+  DependenciesSubscriber,
   ERRORS,
   Installer,
 } from './dependencies-installer';
@@ -118,6 +119,46 @@ describe('DependenciesInstaller', () => {
       expect(devDependencies['my-dev-package-1']).to.equal('^1.0.0');
     });
   });
+
+
+  describe('getSubscriber()', () => {
+    let subscriber: DependenciesSubscriber;
+
+    beforeEach(() => {
+      subscriber = installer.getSubscriber();
+    });
+
+    it('returns a function', () => {
+      expect(subscriber).to.be.a('function');
+    });
+
+
+    it('returns a limited function', () => {
+      subscriber();
+      expect(subscriber()).to.be.an('undefined');
+    });
+
+
+    it('returns a function which returns a promise', () => {
+      expect(subscriber()).to.be.a('promise');
+    });
+
+
+    it('returns a function that accepts two parameters', () => {
+      expect(subscriber({}, 'awesome-plugin')).to.be.a('promise');
+    });
+
+
+    it('returns a function that calls .add() method', async () => {
+      fileReader = FileReader(path.join(process.cwd(), 'test.package.json'));
+      await subscriber(
+        {
+          dependencies: { 'my-package': '^0.1.0' },
+        },
+      );
+      const { dependencies } = await fileReader.read();
+      expect(dependencies).to.contains.keys('my-package');
+    });
   });
 
 
diff --git a/src/util/dependencies-installer.ts b/src/util/dependencies-installer.ts
@@ -50,6 +50,7 @@ export type DependenciesSubscriber = (manifest: DependenciesManifest, name: stri
 
 export interface DependenciesInstaller {
   add(manifest: DependenciesManifest): Promise<void>;
+  getSubscriber(): DependenciesSubscriber;
   run(): Promise<void>;
   /* test:start */
   checkForManagers?(): Promise<void>;
@@ -359,6 +360,20 @@ export async function Installer(
   }
 
 
+  /**
+   * Get dependencies subscriber function
+   */
+  function getSubscriber(): DependenciesSubscriber {
+    // Return a limited function (1 maximum call) to register plugin dependencies
+    return limitFn(async function (manifest: DependenciesManifest, name?: string) {
+      if (typeof name !== 'undefined') {
+        logger.debug(`${MESSAGES.REGISTERING_PLUGIN_DEPS} for ${chalk.cyan.bold(pluginName(name))}`);
+      }
+      await add(manifest);
+    });
+  }
+
+
   /**
    * Log stderr handler
    * @param stream Standard Error stream
@@ -395,6 +410,7 @@ export async function Installer(
   // Public API object
   let publicApi: DependenciesInstaller = {
     add,
+    getSubscriber,
     run,
   };
 
