TypescriptAPIUtils: add isClassInstanceOf function

davidkudera · davidkudera · commit 8466592ec0d8 · 2017-11-24T18:04:31.000+01:00
diff --git a/packages/typescript-api-utils/classes/index.ts b/packages/typescript-api-utils/classes/index.ts
@@ -1 +1,2 @@
+export * from './instanceOf';
 export * from './lookupParentClass';
diff --git a/packages/typescript-api-utils/classes/instanceOf.ts b/packages/typescript-api-utils/classes/instanceOf.ts
@@ -0,0 +1,45 @@
+import {find, exists} from '@slicky/utils';
+import {lookupDeepParentClasses} from './lookupParentClass';
+import {ResolvedIdentifier} from '../resolvers';
+import {lookupSourceFile} from '../sourceFiles';
+import * as ts from 'typescript';
+
+
+export function isClassInstanceOf(classDeclaration: ts.ClassDeclaration, parentClass: ts.ClassDeclaration, compilerOptions: ts.CompilerOptions, moduleResolutionHost: ts.ModuleResolutionHost): boolean
+{
+	let parentClassSourceFile: ts.SourceFile = undefined;
+	function getParentClassSourceFile(): ts.SourceFile
+	{
+		return exists(parentClassSourceFile) ? parentClassSourceFile : parentClassSourceFile = lookupSourceFile(parentClass);
+	}
+
+	const parents = lookupDeepParentClasses(classDeclaration, compilerOptions, moduleResolutionHost);
+
+	if (!parents.parents.length) {
+		return false;
+	}
+
+	const foundParent = find(parents.parents, (parent: ResolvedIdentifier<ts.ClassDeclaration>) => {
+		if (parent.node === parentClass) {
+			return true;
+		}
+
+		if (!parent.imported) {
+			return false;
+		}
+
+		if (!exists(parentClass.name)) {
+			return false;
+		}
+
+		const parentSourceFile = getParentClassSourceFile();
+
+		if (parentSourceFile.fileName !== parent.sourceFile.fileName) {
+			return false;
+		}
+
+		return (<ts.Identifier>parentClass.name).text === parent.originalName;
+	});
+
+	return exists(foundParent);
+}
diff --git a/packages/typescript-api-utils/tests/data/classes/instanceOf/valid_1.ts b/packages/typescript-api-utils/tests/data/classes/instanceOf/valid_1.ts
@@ -0,0 +1,2 @@
+export class A {}
+export class B {}
diff --git a/packages/typescript-api-utils/tests/data/classes/instanceOf/valid_2.ts b/packages/typescript-api-utils/tests/data/classes/instanceOf/valid_2.ts
@@ -0,0 +1,2 @@
+export class A {}
+export class B extends A {}
diff --git a/packages/typescript-api-utils/tests/data/classes/instanceOf/valid_3.classA.ts b/packages/typescript-api-utils/tests/data/classes/instanceOf/valid_3.classA.ts
@@ -0,0 +1 @@
+export class A {}
diff --git a/packages/typescript-api-utils/tests/data/classes/instanceOf/valid_3.ts b/packages/typescript-api-utils/tests/data/classes/instanceOf/valid_3.ts
@@ -0,0 +1,4 @@
+import {A} from './valid_3.classA';
+
+
+export class B extends A {}
diff --git a/packages/typescript-api-utils/tests/data/classes/instanceOf/valid_4.classA.ts b/packages/typescript-api-utils/tests/data/classes/instanceOf/valid_4.classA.ts
@@ -0,0 +1 @@
+export class A {}
diff --git a/packages/typescript-api-utils/tests/data/classes/instanceOf/valid_4.classA1.ts b/packages/typescript-api-utils/tests/data/classes/instanceOf/valid_4.classA1.ts
@@ -0,0 +1 @@
+export * from './valid_4.classA2';
diff --git a/packages/typescript-api-utils/tests/data/classes/instanceOf/valid_4.classA2.ts b/packages/typescript-api-utils/tests/data/classes/instanceOf/valid_4.classA2.ts
@@ -0,0 +1 @@
+export * from './valid_4.classA';
diff --git a/packages/typescript-api-utils/tests/data/classes/instanceOf/valid_4.ts b/packages/typescript-api-utils/tests/data/classes/instanceOf/valid_4.ts
@@ -0,0 +1,4 @@
+import {A} from './valid_4.classA1';
+
+
+export class B extends A {}
diff --git a/packages/typescript-api-utils/tests/tests/classes/instanceOf.ts b/packages/typescript-api-utils/tests/tests/classes/instanceOf.ts
@@ -0,0 +1,66 @@
+import {findNode, isClassInstanceOf as _isClassInstanceOf, fsModuleResolutionHost} from '../../../';
+import {expect} from 'chai';
+import * as ts from 'typescript';
+import * as path from 'path';
+import * as fs from 'fs';
+
+
+const PATH = path.join(__dirname, '..', '..', 'data', 'classes', 'instanceOf');
+
+
+function getSourceFile(name: string): ts.SourceFile
+{
+	const filePath = path.join(PATH, `${name}.ts`);
+	const file = <string>fs.readFileSync(filePath, {encoding: 'utf8'});
+
+	return ts.createSourceFile(filePath, file, ts.ScriptTarget.Latest, true);
+}
+
+
+function isClassInstanceOf(classDeclaration: ts.ClassDeclaration, parentClass: ts.ClassDeclaration): boolean
+{
+	return _isClassInstanceOf(classDeclaration, parentClass, {}, fsModuleResolutionHost());
+}
+
+
+describe('#classes/instanceOf', () => {
+
+	describe('isClassInstanceOf()', () => {
+
+		it('should return false if class B does not extend from class A', () => {
+			const sourceFile = getSourceFile('valid_1');
+			const classA = findNode<ts.ClassDeclaration>(ts.SyntaxKind.ClassDeclaration, 'A', sourceFile);
+			const classB = findNode<ts.ClassDeclaration>(ts.SyntaxKind.ClassDeclaration, 'B', sourceFile);
+
+			expect(isClassInstanceOf(classB, classA)).to.be.equal(false);
+		});
+
+		it('should return true if class B extend from class A and classes are in the same file', () => {
+			const sourceFile = getSourceFile('valid_2');
+			const classA = findNode<ts.ClassDeclaration>(ts.SyntaxKind.ClassDeclaration, 'A', sourceFile);
+			const classB = findNode<ts.ClassDeclaration>(ts.SyntaxKind.ClassDeclaration, 'B', sourceFile);
+
+			expect(isClassInstanceOf(classB, classA)).to.be.equal(true);
+		});
+
+		it('should return true if class B extend from class A and classes are in different files [depth 1]', () => {
+			const sourceFileA = getSourceFile('valid_3.classA');
+			const sourceFileB = getSourceFile('valid_3');
+			const classA = findNode<ts.ClassDeclaration>(ts.SyntaxKind.ClassDeclaration, 'A', sourceFileA);
+			const classB = findNode<ts.ClassDeclaration>(ts.SyntaxKind.ClassDeclaration, 'B', sourceFileB);
+
+			expect(isClassInstanceOf(classB, classA)).to.be.equal(true);
+		});
+
+		it('should return true if class B extend from class A and classes are in different files [depth 3]', () => {
+			const sourceFileA = getSourceFile('valid_4.classA');
+			const sourceFileB = getSourceFile('valid_4');
+			const classA = findNode<ts.ClassDeclaration>(ts.SyntaxKind.ClassDeclaration, 'A', sourceFileA);
+			const classB = findNode<ts.ClassDeclaration>(ts.SyntaxKind.ClassDeclaration, 'B', sourceFileB);
+
+			expect(isClassInstanceOf(classB, classA)).to.be.equal(true);
+		});
+
+	});
+
+});

Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
	`1`	`+export * from './instanceOf';`
`1`	`2`	`export * from './lookupParentClass';`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+export class A {}`
	`2`	`+export class B {}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+export class A {}`
	`2`	`+export class B extends A {}`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +import {A} from './valid_3.classA';
++
++
 +export class B extends A {}