ts2famix 1.0.1

package/src/analyze_functions/processImportClauses.ts

@@ -0,0 +1,77 @@
+import { ImportDeclaration, SourceFile, ExportedDeclarations } from "ts-morph";
+import { FamixFunctions } from "../famix_functions/famix_functions";
+
+/**
+ * This class is used to build a Famix model for the import clauses
+ */
+export class ProcessImportClauses {
+
+    private famixFunctions: FamixFunctions; // FamixFunctions object, it contains all the functions needed to create Famix entities
+
+    /**
+     * Initializes the ProcessImportClauses object
+     * @param famixFunctions FamixFunctions object, it contains all the functions needed to create Famix entities
+     */
+    constructor(famixFunctions: FamixFunctions) {
+        this.famixFunctions = famixFunctions;
+    }
+
+    /**
+     * Builds a Famix model for the import clauses of the source files which are modules
+     * @param modules An array of modules
+     * @param exports An array of maps of exported declarations
+     */
+    public processImportClauses(modules: Array<SourceFile>, exports: Array<ReadonlyMap<string, ExportedDeclarations[]>>): void {
+        console.info(`processImportClauses: Creating import clauses:`);
+        modules.forEach(f => {
+            f.getImportDeclarations().forEach(i => {
+                const path = this.getModulePath(i);
+
+                i.getNamedImports().forEach(ni => {
+                    console.info(`processImportClauses: Importing (named) ${ni.getName()} from ${i.getModuleSpecifierValue()}`);
+                    const importedEntityName = ni.getName();
+                    let bool = false;
+                    exports.forEach(e => {
+                        if (e.has(importedEntityName)) {
+                            bool = true;
+                        }
+                    });
+                    this.famixFunctions.createFamixImportClause(f, i.getModuleSpecifierValue(), path, ni, bool, false);
+                });
+
+                const defaultImport = i.getDefaultImport();
+                if (defaultImport !== undefined) {
+                    console.info(`processImportClauses: Importing (default) ${defaultImport.getText()} from ${i.getModuleSpecifierValue()}`);
+                    this.famixFunctions.createFamixImportClause(f, i.getModuleSpecifierValue(), path, defaultImport, false, true);
+                }
+
+                const namespaceImport = i.getNamespaceImport();
+                if (namespaceImport !== undefined) {
+                    console.info(`processImportClauses: Importing (namespace) ${namespaceImport.getText()} from ${i.getModuleSpecifierValue()}`);
+                    this.famixFunctions.createFamixImportClause(f, i.getModuleSpecifierValue(), path, namespaceImport, false, false);
+                }
+            }); 
+        });
+    }
+
+    /**
+     * Gets the path of a module to be imported
+     * @param i An import declaration
+     * @returns The path of the module to be imported
+     */
+    private getModulePath(i: ImportDeclaration): string {
+        let path: string;
+        if (i.getModuleSpecifierSourceFile() === undefined) {
+            if (i.getModuleSpecifierValue().substring(i.getModuleSpecifierValue().length - 3) === ".ts") {
+                path = i.getModuleSpecifierValue();
+            }
+            else {
+                path = i.getModuleSpecifierValue() + ".ts";
+            }
+        }
+        else {
+            path = i.getModuleSpecifierSourceFile().getFilePath();
+        }
+        return path;
+    }
+}

package/src/analyze_functions/processInheritances.ts

@@ -0,0 +1,84 @@
+import { ClassDeclaration, InterfaceDeclaration, ExpressionWithTypeArguments } from "ts-morph";
+import { FamixFunctions } from "../famix_functions/famix_functions";
+
+/**
+ * This class is used to build a Famix model for the inheritances
+ */
+export class ProcessInheritances {
+
+    private famixFunctions: FamixFunctions; // FamixFunctions object, it contains all the functions needed to create Famix entities
+
+    /**
+     * Initializes the ProcessInheritances object
+     * @param famixFunctions FamixFunctions object, it contains all the functions needed to create Famix entities
+     */
+    constructor(famixFunctions: FamixFunctions) {
+        this.famixFunctions = famixFunctions;
+    }
+
+    /**
+     * Builds a Famix model for the inheritances of the classes and interfaces of the source files
+     * @param classes An array of classes
+     * @param interfaces An array of interfaces
+     */
+    public processInheritances(classes: Array<ClassDeclaration>, interfaces: Array<InterfaceDeclaration>): void {
+        console.info(`processInheritances: Creating inheritances:`);
+        classes.forEach(cls => {
+            console.info(`processInheritances: Checking class inheritance for ${cls.getName()}`);
+            const extClass = cls.getBaseClass();
+            if (extClass !== undefined) {
+                this.famixFunctions.createFamixInheritance(cls, extClass);
+                
+                console.info(`processInheritances: class: ${cls.getName()}, (${cls.getType().getText()}), extClass: ${extClass.getName()}, (${extClass.getType().getText()})`);
+            }
+
+            console.info(`processInheritances: Checking interface inheritance for ${cls.getName()}`);
+            const implementedInterfaces = this.getImplementedOrExtendedInterfaces(interfaces, cls);
+            implementedInterfaces.forEach(impInter => {
+                this.famixFunctions.createFamixInheritance(cls, impInter);
+
+                console.info(`processInheritances: class: ${cls.getName()}, (${cls.getType().getText()}), impInter: ${(impInter instanceof InterfaceDeclaration) ? impInter.getName() : impInter.getExpression().getText()}, (${(impInter instanceof InterfaceDeclaration) ? impInter.getType().getText() : impInter.getExpression().getText()})`);
+            });
+        });
+
+        interfaces.forEach(inter => {
+            console.info(`processInheritances: Checking interface inheritance for ${inter.getName()}`);
+            const extendedInterfaces = this.getImplementedOrExtendedInterfaces(interfaces, inter);
+            extendedInterfaces.forEach(extInter => {
+                this.famixFunctions.createFamixInheritance(inter, extInter);
+
+                console.info(`processInheritances: inter: ${inter.getName()}, (${inter.getType().getText()}), extInter: ${(extInter instanceof InterfaceDeclaration) ? extInter.getName() : extInter.getExpression().getText()}, (${(extInter instanceof InterfaceDeclaration) ? extInter.getType().getText() : extInter.getExpression().getText()})`);
+            });
+        });
+    }
+
+    /**
+     * Gets the interfaces implemented or extended by a class or an interface
+     * @param interfaces An array of interfaces
+     * @param subClass A class or an interface
+     * @returns An array of InterfaceDeclaration and ExpressionWithTypeArguments containing the interfaces implemented or extended by the subClass
+     */
+    private getImplementedOrExtendedInterfaces(interfaces: Array<InterfaceDeclaration>, subClass: ClassDeclaration | InterfaceDeclaration): Array<InterfaceDeclaration | ExpressionWithTypeArguments> {
+        let impOrExtInterfaces: Array<ExpressionWithTypeArguments>;
+        if (subClass instanceof ClassDeclaration) {
+            impOrExtInterfaces = subClass.getImplements();
+        }
+        else {
+            impOrExtInterfaces = subClass.getExtends();
+        }
+
+        const interfacesNames = interfaces.map(i => i.getName());
+        const implementedOrExtendedInterfaces = new Array<InterfaceDeclaration | ExpressionWithTypeArguments>();
+
+        impOrExtInterfaces.forEach(i => {
+            if (interfacesNames.includes(i.getExpression().getText())) {
+                implementedOrExtendedInterfaces.push(interfaces[interfacesNames.indexOf(i.getExpression().getText())]);
+            }
+            else {
+                implementedOrExtendedInterfaces.push(i);
+            }
+        });
+
+        return implementedOrExtendedInterfaces;
+    }
+}

package/src/analyze_functions/processInvocations.ts

@@ -0,0 +1,51 @@
+import { MethodDeclaration, FunctionDeclaration, Identifier, ConstructorDeclaration, GetAccessorDeclaration, SetAccessorDeclaration, FunctionExpression } from "ts-morph";
+import { FamixFunctions } from "../famix_functions/famix_functions";
+
+/**
+ * This class is used to build a Famix model for the invocations
+ */
+export class ProcessInvocations {
+
+    private famixFunctions: FamixFunctions; // FamixFunctions object, it contains all the functions needed to create Famix entities
+
+    /**
+     * Initializes the ProcessInvocations object
+     * @param famixFunctions FamixFunctions object, it contains all the functions needed to create Famix entities
+     */
+    constructor(famixFunctions: FamixFunctions) {
+        this.famixFunctions = famixFunctions;
+    }
+
+    /**
+     * Builds a Famix model for the invocations of the methods and functions of the source files
+     * @param methodsAndFunctionsWithId A map of methods and functions with their id
+     */
+    public processInvocations(methodsAndFunctionsWithId: Map<number, MethodDeclaration | ConstructorDeclaration | GetAccessorDeclaration | SetAccessorDeclaration | FunctionDeclaration | FunctionExpression>): void {
+        console.info(`Creating invocations:`);
+        methodsAndFunctionsWithId.forEach((m, id) => {
+            console.info(`Invocations to ${(m instanceof MethodDeclaration || m instanceof GetAccessorDeclaration || m instanceof SetAccessorDeclaration || m instanceof FunctionDeclaration) ? m.getName() : ((m instanceof ConstructorDeclaration) ? 'constructor' : (m.getName() ? m.getName() : 'anonymous'))}`);
+            try {
+                const temp_nodes = m.findReferencesAsNodes() as Array<Identifier>;
+                temp_nodes.forEach(node => this.processNodeForInvocations(node, m, id));
+            } catch (error) {
+                console.error(`> WARNING: got exception ${error}. Continuing...`);
+            }
+        });
+    }
+
+    /**
+     * Builds a Famix model for an invocation of a method or a function
+     * @param n A node
+     * @param m A method or a function
+     * @param id The id of the method or the function
+     */
+    private processNodeForInvocations(n: Identifier, m: MethodDeclaration | ConstructorDeclaration | GetAccessorDeclaration | SetAccessorDeclaration | FunctionDeclaration | FunctionExpression, id: number): void {
+        try {
+            this.famixFunctions.createFamixInvocation(n, m, id);
+
+            console.info(`node: node, (${n.getType().getText()})`);
+        } catch (error) {
+            console.error(`> WARNING: got exception ${error}. ScopeDeclaration invalid for ${n.getSymbol().getFullyQualifiedName()}. Continuing...`);
+        }
+    }
+}

package/src/famix2puml.ts

@@ -0,0 +1,119 @@
+import * as fs from 'fs';
+import yargs from 'yargs';
+
+const argv = yargs
+    .example('ts-node src/famix2puml.ts -i JSONModels/projectName.json -o PUMLModels/projectName.puml', 'creates a PlantUML class diagram from a JSON-format model of a typescript project')
+    .alias('i', 'input')
+    .nargs('i', 1)
+    .alias('o', 'output')
+    .nargs('o', 1)
+    .demandOption('input').demandOption('output').parseSync();
+
+const INHERITANCE_LINK_COLOR = 'blue';
+
+// approximation for code completion
+interface FamixTypeScriptElement {
+    FM3: string
+    name: string
+    id?: string
+}
+
+interface Association {
+    from: string;
+    to: string;
+    name: string;
+}
+
+const jsonFileName = argv.input as string;
+const pumlFileName = (argv.output as string).substring((argv.output as string).indexOf("/")+1, (argv.output as string).lastIndexOf('.'));
+const parsedModel: Array<FamixTypeScriptElement> = JSON.parse(fs.readFileSync(jsonFileName, 'utf-8'));
+const classNameMap = new Map<string, string>();
+const associations = new Array<Association>();
+
+// maps all class names to their id
+parsedModel.forEach(element => {
+    // map has id as key and unique (plantuml) class name
+    classNameMap.set(element.id, uniqueElementName(element));
+    const nameWithoutPrefix = element.FM3.split('.')[1];
+    // special case association
+    if (nameWithoutPrefix.endsWith('Inheritance')) {
+        const subclass = element['subclass'].ref;
+        const superclass = element['superclass'].ref;
+        associations.push({ from: subclass, to: superclass, name: nameWithoutPrefix });
+    }
+});
+
+// generates plantuml
+let plantUMLOutString = `@startuml ${pumlFileName}
+skinparam style strictuml
+title Object diagram for ${jsonFileName}
+`;
+parsedModel.forEach(element => {
+    plantUMLOutString += `${toPlantUML(element)}\n`;
+});
+
+// creates associations
+associations.forEach(association => {
+    // inheritance is a special case, show it in UML even though it doesn't make 100% sense in object diagrams
+    const isInheritance = association.name.startsWith('Inheritance');
+    if (isInheritance) {
+        plantUMLOutString += `${classNameMap.get(association.from)} --|> ${classNameMap.get(association.to)} #line:${INHERITANCE_LINK_COLOR}\n`;
+    } else {
+        plantUMLOutString += `${classNameMap.get(association.from)} ..> "${association.name}" ${classNameMap.get(association.to)}\n`;
+    }
+});
+
+plantUMLOutString += '@enduml';
+
+// writes to output file
+fs.writeFile(argv.output as string, plantUMLOutString, (err) => {
+    if (err) { throw err; }
+});
+
+function uniqueElementName(element: FamixTypeScriptElement): string {
+    return `${element.FM3}${element.id}`;
+}
+
+function toPlantUML(element: FamixTypeScriptElement) {
+    let plantUMLString = '';
+    const optionalName = element.name || '';
+    const nameWithoutPrefix = element.FM3.split('.')[1];
+    plantUMLString += `object "${optionalName}:${nameWithoutPrefix}" as ${uniqueElementName(element)} {\n`;
+    plantUMLString += `id = ${element.id}\n`;
+    plantUMLString += propertiesToPlantUML(element);
+    plantUMLString += '}\n';
+    return plantUMLString;
+}
+
+function propertiesToPlantUML(element: FamixTypeScriptElement) {
+    let plantUMLString = '';
+    for (const property in element) {
+        const attribute = element[property];
+        const isOneToManyReference = typeof attribute !== 'string' && attribute.length; // array but not a string
+
+        switch (property) {
+            // ignores these properties
+            case 'subclass':
+            case 'superclass':
+            case 'FM3':
+            case 'id':
+            case 'name':
+                break;
+
+            default:
+                if (isOneToManyReference) {
+                    attribute.forEach((composite, index) => {
+                        associations.push({ from: element.id, to: composite.ref, name: `${property}[${index}]` });
+                    });
+                } else if (typeof attribute === 'object') {
+                    associations.push({ from: element.id, to: attribute.ref, name: property });
+                } else {  // typeof string, boolean, number, etc
+                    // treats it as a simple attribute
+                    plantUMLString += `${property} = ${element[property]}\n`;
+                }
+
+                break;
+        }
+    }
+    return plantUMLString;
+}