ts2famix 2.0.0 → 2.0.1

package/src/analyze_functions/process_functions.ts

@@ -1,5 +1,5 @@
 import { ClassDeclaration, MethodDeclaration, VariableStatement, FunctionDeclaration, VariableDeclaration, InterfaceDeclaration, ParameterDeclaration, ConstructorDeclaration, MethodSignature, SourceFile, ModuleDeclaration, PropertyDeclaration, PropertySignature, Decorator, GetAccessorDeclaration, SetAccessorDeclaration, ExportedDeclarations, CommentRange, EnumDeclaration, EnumMember, TypeParameterDeclaration, TypeAliasDeclaration, SyntaxKind, FunctionExpression, Block, Identifier, ExpressionWithTypeArguments, ImportDeclaration, Node, ArrowFunction, Scope, ClassExpression } from "ts-morph";
-import * as Famix from "../lib/famix/src/model/famix";
+import * as Famix from "../lib/famix/model/famix";
 import { calculate } from "../lib/ts-complex/cyclomatic-service";
 import * as fs from 'fs';
 import { logger , entityDictionary } from "../analyze";
@@ -15,7 +15,7 @@ export const classes = new Array<ClassDeclaration>(); // Array of all the classe
 export const interfaces = new Array<InterfaceDeclaration>(); // Array of all the interfaces of the source files
 export const modules = new Array<SourceFile>(); // Array of all the source files which are modules
 export const listOfExportMaps = new Array<ReadonlyMap<string, ExportedDeclarations[]>>(); // Array of all the export maps
-export let currentCC: unknown; // Stores the cyclomatic complexity metrics for the current source file
+export let currentCC: { [key: string]: number }; // Stores the cyclomatic complexity metrics for the current source file
 
 /**
  * Checks if the file has any imports or exports to be considered a module
@@ -28,21 +28,21 @@ function isSourceFileAModule(sourceFile: SourceFile): boolean {
 
 /**
  * Gets the path of a module to be imported
- * @param i An import declaration
+ * @param importDecl An import declaration
  * @returns The path of the module to be imported
  */
-export function getModulePath(i: ImportDeclaration): string {
+export function getModulePath(importDecl: ImportDeclaration): string {
     let path: string;
-    if (i.getModuleSpecifierSourceFile() === undefined) {
-        if (i.getModuleSpecifierValue().substring(i.getModuleSpecifierValue().length - 3) === ".ts") {
-            path = i.getModuleSpecifierValue();
+    if (importDecl.getModuleSpecifierSourceFile() === undefined) {
+        if (importDecl.getModuleSpecifierValue().substring(importDecl.getModuleSpecifierValue().length - 3) === ".ts") {
+            path = importDecl.getModuleSpecifierValue();
         }
         else {
-            path = i.getModuleSpecifierValue() + ".ts";
+            path = importDecl.getModuleSpecifierValue() + ".ts";
         }
     }
     else {
-        path = i.getModuleSpecifierSourceFile().getFilePath();
+        path = importDecl.getModuleSpecifierSourceFile()!.getFilePath();
     }
     return path;
 }
@@ -89,7 +89,7 @@ export function processFiles(sourceFiles: Array<SourceFile>): void {
         if (fs.existsSync(file.getFilePath()))
             currentCC = calculate(file.getFilePath());
         else
-            currentCC = 0;
+            currentCC = {};
 
         processFile(file);
     });
@@ -111,7 +111,7 @@ function processFile(f: SourceFile): void {
 
     const fmxFile = entityDictionary.createOrGetFamixFile(f, isModule);
 
-    logger.debug(`processFile: file: ${f.getBaseName()}, fqn = ${fmxFile.getFullyQualifiedName()}`);
+    logger.debug(`processFile: file: ${f.getBaseName()}, fqn = ${fmxFile.fullyQualifiedName}`);
 
     processComments(f, fmxFile);
 
@@ -149,7 +149,7 @@ export function isNamespace(node: ModuleDeclaration): boolean {
 function processModule(m: ModuleDeclaration): Famix.Module {
     const fmxModule = entityDictionary.createOrGetFamixModule(m);
 
-    logger.debug(`module: ${m.getName()}, (${m.getType().getText()}), ${fmxModule.getFullyQualifiedName()}`);
+    logger.debug(`module: ${m.getName()}, (${m.getType().getText()}), ${fmxModule.fullyQualifiedName}`);
 
     processComments(m, fmxModule);
 
@@ -310,7 +310,7 @@ function processModules(m: SourceFile | ModuleDeclaration, fmxScope: Famix.Scrip
 function processAlias(a: TypeAliasDeclaration): Famix.Alias {
     const fmxAlias = entityDictionary.createFamixAlias(a);
 
-    logger.debug(`Alias: ${a.getName()}, (${a.getType().getText()}), fqn = ${fmxAlias.getFullyQualifiedName()}`);
+    logger.debug(`Alias: ${a.getName()}, (${a.getType().getText()}), fqn = ${fmxAlias.fullyQualifiedName}`);
 
     processComments(a, fmxAlias);
 
@@ -327,7 +327,7 @@ function processClass(c: ClassDeclaration): Famix.Class | Famix.ParametricClass
 
     const fmxClass = entityDictionary.createOrGetFamixClass(c);
 
-    logger.debug(`Class: ${c.getName()}, (${c.getType().getText()}), fqn = ${fmxClass.getFullyQualifiedName()}`);
+    logger.debug(`Class: ${c.getName()}, (${c.getType().getText()}), fqn = ${fmxClass.fullyQualifiedName}`);
 
     processComments(c, fmxClass);
 
@@ -363,7 +363,7 @@ function processInterface(i: InterfaceDeclaration): Famix.Interface | Famix.Para
 
     const fmxInterface = entityDictionary.createOrGetFamixInterface(i);
 
-    logger.debug(`Interface: ${i.getName()}, (${i.getType().getText()}), fqn = ${fmxInterface.getFullyQualifiedName()}`);
+    logger.debug(`Interface: ${i.getName()}, (${i.getType().getText()}), fqn = ${fmxInterface.fullyQualifiedName}`);
 
     processComments(i, fmxInterface);
 
@@ -402,7 +402,7 @@ function processStructuredType(c: ClassDeclaration | InterfaceDeclaration, fmxSc
 function processProperty(p: PropertyDeclaration | PropertySignature): Famix.Property {
     const fmxProperty = entityDictionary.createFamixProperty(p);
 
-    logger.debug(`property: ${p.getName()}, (${p.getType().getText()}), fqn = ${fmxProperty.getFullyQualifiedName()}`);
+    logger.debug(`property: ${p.getName()}, (${p.getType().getText()}), fqn = ${fmxProperty.fullyQualifiedName}`);
     logger.debug(` ---> It's a Property${(p instanceof PropertySignature) ? "Signature" : "Declaration"}!`);
     const ancestor = p.getFirstAncestorOrThrow();
     logger.debug(` ---> Its first ancestor is a ${ancestor.getKindName()}`);
@@ -412,7 +412,7 @@ function processProperty(p: PropertyDeclaration | PropertySignature): Famix.Prop
         processDecorators(p, fmxProperty);
         // only add access if the p's first ancestor is not a PropertyDeclaration
         if (ancestor.getKindName() !== "PropertyDeclaration") {
-            logger.debug(`adding access to map: ${p.getName()}, (${p.getType().getText()}) Famix ${fmxProperty.getName()} id: ${fmxProperty.id}`);
+            logger.debug(`adding access to map: ${p.getName()}, (${p.getType().getText()}) Famix ${fmxProperty.name} id: ${fmxProperty.id}`);
             accessMap.set(fmxProperty.id, p);
         }
     }
@@ -430,7 +430,7 @@ function processProperty(p: PropertyDeclaration | PropertySignature): Famix.Prop
 function processMethod(m: MethodDeclaration | ConstructorDeclaration | MethodSignature | GetAccessorDeclaration | SetAccessorDeclaration): Famix.Method | Famix.Accessor {
     const fmxMethod = entityDictionary.createOrGetFamixMethod(m, currentCC);
 
-    logger.debug(`Method: ${!(m instanceof ConstructorDeclaration) ? m.getName() : "constructor"}, (${m.getType().getText()}), parent: ${(m.getParent() as ClassDeclaration | InterfaceDeclaration).getName()}, fqn = ${fmxMethod.getFullyQualifiedName()}`);
+    logger.debug(`Method: ${!(m instanceof ConstructorDeclaration) ? m.getName() : "constructor"}, (${m.getType().getText()}), parent: ${(m.getParent() as ClassDeclaration | InterfaceDeclaration).getName()}, fqn = ${fmxMethod.fullyQualifiedName}`);
 
     processComments(m, fmxMethod);
 
@@ -539,26 +539,29 @@ function processParameters(m: MethodDeclaration | ConstructorDeclaration | Metho
 
 // This function should create a Famix.Property model from a ParameterDeclaration
 // You'll need to implement it according to your Famix model structure
-function processParameterAsProperty(param: ParameterDeclaration, c: ClassDeclaration | ClassExpression): Famix.Property {
+function processParameterAsProperty(param: ParameterDeclaration, classDecl: ClassDeclaration | ClassExpression): Famix.Property {
     // Convert the parameter into a Property
     const propertyRepresentation = convertParameterToPropertyRepresentation(param);
 
     // Add the property to the class so we can have a PropertyDeclaration object
-    c.addProperty(propertyRepresentation);
+    classDecl.addProperty(propertyRepresentation);
 
-    const p = c.getProperty(propertyRepresentation.name);
-    const fmxProperty = entityDictionary.createFamixProperty(p);
-    if (c instanceof ClassDeclaration) {
-        const fmxClass = entityDictionary.createOrGetFamixClass(c);
+    const property = classDecl.getProperty(propertyRepresentation.name);
+    if (!property) {
+        throw new Error(`Property ${propertyRepresentation.name} not found in class ${classDecl.getName()}`);
+    }
+    const fmxProperty = entityDictionary.createFamixProperty(property);
+    if (classDecl instanceof ClassDeclaration) {
+        const fmxClass = entityDictionary.createOrGetFamixClass(classDecl);
         fmxClass.addProperty(fmxProperty);
     } else { 
         throw new Error("Unexpected type ClassExpression.");
     }
 
-    processComments(p, fmxProperty);
+    processComments(property, fmxProperty);
 
     // remove the property from the class
-    p.remove();
+    property.remove();
 
     return fmxProperty;
 
@@ -579,6 +582,8 @@ function convertParameterToPropertyRepresentation(param: ParameterDeclaration) {
         scope = Scope.Protected;
     } else if (param.hasModifier(SyntaxKind.PublicKeyword)) {
         scope = Scope.Public;
+    } else {
+        throw new Error(`Parameter property ${paramName} in constructor does not have a visibility modifier.`);
     }
 
     // Determine if readonly
@@ -597,23 +602,23 @@ function convertParameterToPropertyRepresentation(param: ParameterDeclaration) {
 
 /**
  * Builds a Famix model for a parameter
- * @param p A parameter
+ * @param paramDecl A parameter
  * @returns A Famix.Parameter representing the parameter
  */
-function processParameter(p: ParameterDeclaration): Famix.Parameter {
-    const fmxParam = entityDictionary.createFamixParameter(p);
+function processParameter(paramDecl: ParameterDeclaration): Famix.Parameter {
+    const fmxParam = entityDictionary.createFamixParameter(paramDecl);
 
-    logger.debug(`parameter: ${p.getName()}, (${p.getType().getText()}), fqn = ${fmxParam.getFullyQualifiedName()}`);
+    logger.debug(`parameter: ${paramDecl.getName()}, (${paramDecl.getType().getText()}), fqn = ${fmxParam.fullyQualifiedName}`);
 
-    processComments(p, fmxParam);
+    processComments(paramDecl, fmxParam);
 
-    processDecorators(p, fmxParam);
+    processDecorators(paramDecl, fmxParam);
 
-    const parent = p.getParent();
+    const parent = paramDecl.getParent();
 
     if (!(parent instanceof MethodSignature)) {
-        logger.debug(`adding access: ${p.getName()}, (${p.getType().getText()}) Famix ${fmxParam.getName()}`);
-        accessMap.set(fmxParam.id, p);
+        logger.debug(`adding access: ${paramDecl.getName()}, (${paramDecl.getType().getText()}) Famix ${fmxParam.name}`);
+        accessMap.set(fmxParam.id, paramDecl);
     }
 
     return fmxParam;
@@ -640,7 +645,7 @@ function processTypeParameters(e: ClassDeclaration | InterfaceDeclaration | Meth
 function processTypeParameter(tp: TypeParameterDeclaration): Famix.ParameterType {
     const fmxTypeParameter = entityDictionary.createFamixParameterType(tp);
 
-    logger.debug(`type parameter: ${tp.getName()}, (${tp.getType().getText()}), fqn = ${fmxTypeParameter.getFullyQualifiedName()}`);
+    logger.debug(`type parameter: ${tp.getName()}, (${tp.getType().getText()}), fqn = ${fmxTypeParameter.fullyQualifiedName}`);
 
     processComments(tp, fmxTypeParameter);
 
@@ -674,11 +679,11 @@ function processVariableStatement(v: VariableStatement): Array<Famix.Variable> {
 function processVariable(v: VariableDeclaration): Famix.Variable {
     const fmxVar = entityDictionary.createFamixVariable(v);
 
-    logger.debug(`variable: ${v.getName()}, (${v.getType().getText()}), ${v.getInitializer() ? "initializer: " + v.getInitializer().getText() : "initializer: "}, fqn = ${fmxVar.getFullyQualifiedName()}`);
+    logger.debug(`variable: ${v.getName()}, (${v.getType().getText()}), ${v.getInitializer() ? "initializer: " + v.getInitializer()!.getText() : "initializer: "}, fqn = ${fmxVar.fullyQualifiedName}`);
 
     processComments(v, fmxVar);
 
-    logger.debug(`adding access: ${v.getName()}, (${v.getType().getText()}) Famix ${fmxVar.getName()}`);
+    logger.debug(`adding access: ${v.getName()}, (${v.getType().getText()}) Famix ${fmxVar.name}`);
     accessMap.set(fmxVar.id, v);
 
     return fmxVar;
@@ -692,7 +697,7 @@ function processVariable(v: VariableDeclaration): Famix.Variable {
 function processEnum(e: EnumDeclaration): Famix.Enum {
     const fmxEnum = entityDictionary.createFamixEnum(e);
 
-    logger.debug(`enum: ${e.getName()}, (${e.getType().getText()}), fqn = ${fmxEnum.getFullyQualifiedName()}`);
+    logger.debug(`enum: ${e.getName()}, (${e.getType().getText()}), fqn = ${fmxEnum.fullyQualifiedName}`);
 
     processComments(e, fmxEnum);
 
@@ -712,11 +717,11 @@ function processEnum(e: EnumDeclaration): Famix.Enum {
 function processEnumValue(v: EnumMember): Famix.EnumValue {
     const fmxEnumValue = entityDictionary.createFamixEnumValue(v);
 
-    logger.debug(`enum value: ${v.getName()}, (${v.getType().getText()}), fqn = ${fmxEnumValue.getFullyQualifiedName()}`);
+    logger.debug(`enum value: ${v.getName()}, (${v.getType().getText()}), fqn = ${fmxEnumValue.fullyQualifiedName}`);
 
     processComments(v, fmxEnumValue);
 
-    logger.debug(`adding access: ${v.getName()}, (${v.getType().getText()}) Famix ${fmxEnumValue.getName()}`);
+    logger.debug(`adding access: ${v.getName()}, (${v.getType().getText()}) Famix ${fmxEnumValue.name}`);
     accessMap.set(fmxEnumValue.id, v);
 
     return fmxEnumValue;
@@ -744,7 +749,7 @@ function processDecorators(e: ClassDeclaration | MethodDeclaration | GetAccessor
 function processDecorator(d: Decorator, e: ClassDeclaration | MethodDeclaration | GetAccessorDeclaration | SetAccessorDeclaration | ParameterDeclaration | PropertyDeclaration): Famix.Decorator {
     const fmxDec = entityDictionary.createOrGetFamixDecorator(d, e);
 
-    logger.debug(`decorator: ${d.getName()}, (${d.getType().getText()}), fqn = ${fmxDec.getFullyQualifiedName()}`);
+    logger.debug(`decorator: ${d.getName()}, (${d.getType().getText()}), fqn = ${fmxDec.fullyQualifiedName}`);
 
     processComments(d, fmxDec);
 
@@ -819,7 +824,7 @@ function processNodeForAccesses(n: Identifier, id: number): void {
         entityDictionary.createFamixAccess(n, id);
         logger.debug(`processNodeForAccesses: node kind: ${n.getKindName()}, ${n.getText()}, (${n.getType().getText()})`);
     // } catch (error) {
-    //     logger.error(`> Got exception "${error}".\nScopeDeclaration invalid for "${n.getSymbol().getFullyQualifiedName()}".\nContinuing...`);
+    //     logger.error(`> Got exception "${error}".\nScopeDeclaration invalid for "${n.getSymbol().fullyQualifiedName}".\nContinuing...`);
     // }
 }
 
@@ -981,7 +986,7 @@ function processNodeForInvocations(n: Identifier, m: MethodDeclaration | Constru
 
         logger.debug(`node: node, (${n.getType().getText()})`);
     } catch (error) {
-        logger.error(`> WARNING: got exception ${error}. ScopeDeclaration invalid for ${n.getSymbol().getFullyQualifiedName()}. Continuing...`);
+        logger.error(`> WARNING: got exception ${error}. ScopeDeclaration invalid for ${n.getSymbol()!.getFullyQualifiedName()}. Continuing...`);
     }
 }