feat(global): add provideAutoSpy util for Angular tests

this saves time by shortening the repetitive syntax of providing an auto spy in Angular tests.
Credit for the idea goes to Benjamin Taylor.

closes #26

packages/jasmine-auto-spies/src/angular-provider-helper.ts

@@ -0,0 +1,18 @@
+import { ClassType, OnlyMethodKeysOf } from '@hirez_io/auto-spies-core';
+import { ClassSpyConfiguration, createSpyFromClass } from './create-spy-from-class';
+import { Spy } from './jasmine-auto-spies.types';
+
+export type AngularValueProvider<T> = {
+  provide: ClassType<T>;
+  useValue: Spy<T>;
+};
+
+export function provideAutoSpy<T>(
+  ObjectClass: ClassType<T>,
+  methodsToSpyOnOrConfig?: OnlyMethodKeysOf<T>[] | ClassSpyConfiguration<T>
+): AngularValueProvider<T> {
+  return {
+    provide: ObjectClass,
+    useValue: createSpyFromClass(ObjectClass, methodsToSpyOnOrConfig),
+  };
+}

packages/jasmine-auto-spies/src/index.ts

@@ -2,3 +2,4 @@ export * from './jasmine-auto-spies.types';
 export { createSpyFromClass, ClassSpyConfiguration } from './create-spy-from-class';
 export { createFunctionSpy } from './create-function-spy';
 export { createObservableWithValues } from '@hirez_io/auto-spies-core';
+export * from './angular-provider-helper';

packages/jasmine-auto-spies/webpack.config.ts

@@ -33,6 +33,7 @@ export function getWebpackConfig(forTest: boolean = false): webpack.Configuratio
             /node_modules/,
             /dist/,
             /fake-classes-to-test.ts/,
+            /angular-provider-helper.ts/,
             /error-handler.ts/,
             /create-observable-with-values.ts/,
           ],

packages/jest-auto-spies/jest.config.js

@@ -12,7 +12,11 @@ module.exports = {
       statements: 90,
     },
   },
-  coveragePathIgnorePatterns: ['/node_modules/', 'src/tests'],
+  coveragePathIgnorePatterns: [
+    '/node_modules/',
+    'src/tests',
+    'src/angular-provider-helper.ts',
+  ],
   setupFilesAfterEnv: [
     '../../node_modules/@hirez_io/jest-given/dist/jest-given.js',
     '../../node_modules/@hirez_io/observer-spy/dist/setup-auto-unsubscribe.js',

packages/jest-auto-spies/src/angular-provider-helper.ts

@@ -0,0 +1,18 @@
+import { ClassType, OnlyMethodKeysOf } from '@hirez_io/auto-spies-core';
+import { ClassSpyConfiguration, createSpyFromClass } from './create-spy-from-class';
+import { Spy } from './jest-auto-spies.types';
+
+export type AngularValueProvider<T> = {
+  provide: ClassType<T>;
+  useValue: Spy<T>;
+};
+
+export function provideAutoSpy<T>(
+  ObjectClass: ClassType<T>,
+  methodsToSpyOnOrConfig?: OnlyMethodKeysOf<T>[] | ClassSpyConfiguration<T>
+): AngularValueProvider<T> {
+  return {
+    provide: ObjectClass,
+    useValue: createSpyFromClass(ObjectClass, methodsToSpyOnOrConfig),
+  };
+}

packages/jest-auto-spies/src/index.ts

@@ -2,3 +2,4 @@ export * from './jest-auto-spies.types';
 export { createSpyFromClass, ClassSpyConfiguration } from './create-spy-from-class';
 export { createFunctionSpy } from './create-function-spy';
 export { createObservableWithValues } from '@hirez_io/auto-spies-core';
+export * from './angular-provider-helper';