Merges the 2.0.0 release candidate branch (#89)

* Adds the ability to read the typescript files (#76)

This addition is not meant to be full support of typescript from the library. It's meant to allow the reading of the files in the case you are looking to use TS files and are responsible for the transpilation/compilation of those files.

We are experimenting adding this to allow us to use ts files with ts-jest and other tooling in our tests and source files. The compilation is happening locally and doesn't depend on the package having full support for a build pipeline.

This will be published a major version so that those who may have .ts files won't have a break in their dev flow but once it's promoted out of release candidate, it will have proper documentation if we opt to keep the support.

* v2.0.0-rc.0 (#77)

* feat(*): [RO-18670] add ability to ignore dependencies (#78)

* feat(*): RO-18670 Extend spur-ioc to add the ability to skip dependency registration
add support for skipping dependency injection by setting

* feat(*): RO-18670 Extend spur-ioc to add the ability to skip dependency registration
improve logging output when warning against dependency registration collisions

* feat(*): RO-18670 Extend spur-ioc to add the ability to skip dependency registration
fix passing incorrect parameters
improve logging

* feat(*): RO-18670 Extend spur-ioc to add the ability to skip dependency registration
add warning for ignored dependencies

* feat(*): RO-18670 Extend spur-ioc to add the ability to skip dependency registration
add test cases for registerFolders and addResolvableDependency

* feat(*): RO-18670 Extend spur-ioc to add the ability to skip dependency registration
add test cases for addDependency

* feat(*): RO-18670 Extend spur-ioc to add the ability to skip dependency registration
update FileFilterExpression to ignore .d.ts files
add test

* feat(*): RO-18670 Extend spur-ioc to add the ability to skip dependency registration
fix file filter causing issues with some imports
update logging to print primitive types

* feat(*): RO-18670 Extend spur-ioc to add the ability to skip dependency registration
added missing lodash.get dependency

* feat(*): RO-18670 Extend spur-ioc to add the ability to skip dependency registration (#80)

fix logging

* v2.0.0-rc.1 (#79)

* refactor(warnings): Removes the noisy ignored dependency warnings (#81)

* v2.0.0-rc.2 (#82)

---------

Co-authored-by: Terry Lewis <[email protected]>

Author: acolchado

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "spur-ioc",
   "description": "Dependency Injection library for Node.js",
-  "version": "1.2.1",
+  "version": "2.0.0-rc.2",
   "main": "./src/Injector",
   "scripts": {
     "lint": "eslint .",
@@ -54,6 +54,7 @@
     "lodash.bindall": "^4.4.0",
     "lodash.compact": "^3.0.1",
     "lodash.foreach": "^4.5.0",
+    "lodash.get": "^4.4.2",
     "lodash.isfunction": "^3.0.9",
     "lodash.isobject": "^3.0.2",
     "lodash.keys": "^4.2.0",

package.json

@@ -1,35 +1,60 @@
 const _forEach = require('lodash.foreach');
+const _get = require('lodash.get');
+const _isFunction = require('lodash.isfunction');
+const _isObject = require('lodash.isobject');
 const Dependency = require('./Dependency');
 
 const rall = /.+/;
 
 module.exports = {
 
-  warnIfNeeded(name) {
+  getDependencySourceHint(dependency) {
+    if (_isFunction(dependency)) {
+      return _get(dependency, 'name') || '<anonymous function>';
+    }
+
+    if (_isObject(dependency)) {
+      return _get(dependency, 'constructor.name') || '<object>';
+    }
+
+    return `<${typeof dependency}>`;
+  },
+
+  warnOverrideIfNeeded(name, dependency) {
     if (this.hasDependency(name)) {
-      this.logger.warn(`warning: ${name} dependency is being overwritten in ${this.name} injector`);
+      const hint = this.getDependencySourceHint(dependency);
+      this.logger.warn(`warning: ${name} (${hint}) dependency is being overwritten in ${this.name} injector`);
     }
   },
 
   addResolvableDependency(name, dependency, suppressWarning = false) {
+    if (this.shouldIgnoreDependency(dependency)) {
+      return this;
+    }
     if (!suppressWarning) {
-      this.warnIfNeeded(name);
+      this.warnOverrideIfNeeded(name, dependency);
     }
     this.dependencies[name] = Dependency.resolvableDependency(name, dependency);
     return this;
   },
 
   addDependency(name, dependency, suppressWarning = false) {
+    if (this.shouldIgnoreDependency(dependency)) {
+      return this;
+    }
     if (!suppressWarning) {
-      this.warnIfNeeded(name);
+      this.warnOverrideIfNeeded(name, dependency);
     }
     this.dependencies[name] = Dependency.dependency(name, dependency);
     return this;
   },
 
   addConstructedDependency(name, dependency, suppressWarning = false) {
+    if (this.shouldIgnoreDependency(dependency)) {
+      return this;
+    }
     if (!suppressWarning) {
-      this.warnIfNeeded(name);
+      this.warnOverrideIfNeeded(name, dependency);
     }
     this.dependencies[name] = dependency;
     return this;
@@ -48,6 +73,10 @@ module.exports = {
     return !!this.dependencies[name];
   },
 
+  shouldIgnoreDependency(dependency) {
+    return Boolean(_get(dependency, 'spurIocIgnore', false));
+  },
+
   merge(otherInjector, suppressWarning = false) {
     const dependencies = otherInjector.dependencies;
 

src/ContainerManagement.js

@@ -0,0 +1,12 @@
+/*
+The addition of ts (typescript) file registration is only meant to allow the
+registration of the file itself. It doesn't guarantee full compilation but it
+expects that you have that handled with the use of something like on your end.
+
+TypeScript is not officially supported, but will be available through a
+beta/release candidate version.
+*/
+
+const expression = /^(?!.*\.d\.ts$)([^\.].*)\.(js|json|ts)?$$/;
+
+module.exports = expression;

src/FileFilterExpression.js

@@ -4,7 +4,7 @@ const _forEach = require('lodash.foreach');
 const _isFunction = require('lodash.isfunction');
 const _isObject = require('lodash.isobject');
 
-const rfileFilter = /(.+)\.(js|json)$/;
+const fileFilterExpression = require('./FileFilterExpression');
 
 const hasOwnProp = function (source, propertyName) {
   return Object.prototype.hasOwnProperty.call(source, propertyName);
@@ -15,7 +15,7 @@ module.exports = {
     const dirname = path.resolve(rootDir, dir);
     const libs = requireAll({
       dirname,
-      filter: rfileFilter
+      filter: fileFilterExpression
     });
     this.registerLibMap(libs);
     return this;

src/RegistrationManagement.js

@@ -0,0 +1,3 @@
+module.exports = function () {
+  return 'Fence';
+};

test/fixtures/Fence.js

@@ -0,0 +1,3 @@
+module.exports = function () {
+  return 'Wall';
+};

test/fixtures/Wall.js

@@ -0,0 +1,5 @@
+module.exports = function () {
+  return 'Fence ignored';
+};
+
+module.exports.spurIocIgnore = true;

test/fixtures/sub/Fence.js

@@ -0,0 +1,5 @@
+module.exports = function () {
+  return 'Wall override';
+};
+
+module.exports.spurIocIgnore = false;

test/fixtures/sub/Wall.js

@@ -60,4 +60,38 @@ describe('injector - Container Management', () => {
     }))
     .to.throw('Resolver encountered errors');
   });
+
+  describe('ignored dependencies', () => {
+    const initialDep = function () {
+      return 'initial';
+    };
+
+    const ignoredDep = function() {
+      throw new Error('this should not be called');
+      return 'ignored';
+    };
+    ignoredDep.spurIocIgnore = true;
+
+    const replacementDep = function () {
+      return 'updated';
+    };
+
+    it('ignores registered dependencies which have spurIocIgnore=true', function () {
+      this.injector.addDependency('a', initialDep);
+      this.injector.addDependency('a', ignoredDep);
+
+      const dep = this.injector.getDependency('a');
+      expect(dep.name).to.deep.equal('a');
+      expect(dep.instance).to.be.eq(initialDep);
+    });
+
+    it('overrides registered dependencies which have spurIocIgnore=false', function() {
+      this.injector.addDependency('a', initialDep);
+      this.injector.addDependency('a', replacementDep);
+
+      const dep = this.injector.getDependency('a');
+      expect(dep.name).to.equal('a');
+      expect(dep.instance).to.be.eq(replacementDep);
+    });
+  });
 });

test/unit/ContainerSpec.js

@@ -0,0 +1,47 @@
+const subject = require('../../src/FileFilterExpression');
+
+describe('FileFilterExpression tests', function () {
+
+  it('should match a js file path', () => {
+    const path1 = 'src/some/path/FileFilterExpression.js';
+    const path2 = 'src\\somepath\\FileFilterExpression.js';
+
+    expect(subject.test(path1)).to.be.true;
+    expect(subject.test(path2)).to.be.true;
+  });
+
+  it('should match a json file path', () => {
+    const path1 = 'src/some/path/FileFilterExpression.json';
+    const path2 = 'src\\somepath\\FileFilterExpression.json';
+
+    expect(subject.test(path1)).to.be.true;
+    expect(subject.test(path2)).to.be.true;
+  });
+
+  it('should match a ts file path', () => {
+    const path1 = 'src/some/path/FileFilterExpression.ts';
+    const path2 = 'src\\somepath\\FileFilterExpression.ts';
+
+    expect(subject.test(path1)).to.be.true;
+    expect(subject.test(path2)).to.be.true;
+  });
+
+  it('should match a d.ts file path', () => {
+    const path1 = 'src/some/path/FileFilterExpression.d.ts';
+    const path2 = 'src\\somepath\\FileFilterExpression.d.ts';
+
+    expect(subject.test(path1)).to.be.false;
+    expect(subject.test(path2)).to.be.false;
+  });
+
+  it('should not match partial matches', () => {
+    const path1 = 'src/some/path/FileFilterExpression.js2';
+    const path2 = 'src/some/path/FileFilterExpression.json2';
+    const path3 = 'src/some/path/FileFilterExpression.ts2';
+
+    expect(subject.test(path1)).to.be.false;
+    expect(subject.test(path2)).to.be.false;
+    expect(subject.test(path3)).to.be.false;
+  });
+
+});

test/unit/FileFilterExpressionSpec.js

@@ -107,6 +107,80 @@ describe('Injector', () => {
     this.injector.inject(function (_, chai, $injector, foo) {});
   });
 
+  describe('ignored dependencies', () => {
+    const initialDep = function () {
+      return 'initial';
+    };
+
+    const ignoredDep = function() {
+      throw new Error('this should not be called');
+      return 'ignored';
+    };
+    ignoredDep.spurIocIgnore = true;
+
+    const replacementDep = function () {
+      return 'updated';
+    };
+
+    describe('spurIocIgnore=true', () => {
+      it('ignores registered dependencies which have spurIocIgnore=true', function () {
+        this.injector.registerDependencies({ a: initialDep, });
+        this.injector.registerDependencies({ a: ignoredDep });
+
+        this.injector.inject(function (a) {
+          expect(a).to.deep.equal(initialDep);
+          expect(a()).to.be.eq('initial');
+        });
+      });
+
+      it('ignores registered folder dependencies which have spurIocIgnore=true', function() {
+        this.injector.registerFolders(__dirname, ['../fixtures']);
+
+        this.injector.inject(function (Wall) {
+          expect(Wall).to.equal('Wall override');
+        });
+      });
+
+      it('ignores resolvable dependencies which have spurIocIgnore=true', function() {
+        this.injector.addResolvableDependency('b', initialDep);
+        this.injector.addResolvableDependency('b', ignoredDep);
+
+        this.injector.inject(function ($injector) {
+          expect($injector.get('b')).to.equal('initial');
+        });
+      });
+    });
+
+    describe('explicitly marked not to be ignored', () => {
+      it('overrides registered dependencies which have spurIocIgnore=false', function() {
+        this.injector.registerDependencies({ a: initialDep, });
+        this.injector.registerDependencies({ a: replacementDep });
+
+        this.injector.inject(function (a) {
+          expect(a).to.equal(replacementDep);
+          expect(a()).to.be.eq('updated');
+        });
+      });
+
+      it('overrides registered folder dependencies which have spurIocIgnore=false', function() {
+        this.injector.registerFolders(__dirname, ['../fixtures']);
+
+        this.injector.inject(function (Wall) {
+          expect(Wall).to.equal('Wall override');
+        });
+      });
+
+      it('overrides resolvable dependencies which have spurIocIgnore=false', function() {
+        this.injector.addResolvableDependency('b', initialDep);
+        this.injector.addResolvableDependency('b', replacementDep);
+
+        this.injector.inject(function ($injector) {
+          expect($injector.get('b')).to.equal('updated');
+        });
+      });
+    });
+  });
+
   describe('expose and link', () => {
     beforeEach(function () {
       this.injector.registerDependencies({