ts2famix 1.0.10 → 1.0.12

package/src/famix_functions/famix_functions_types.ts

@@ -1,100 +1,105 @@
-import { ConstructorDeclaration, FunctionDeclaration, MethodDeclaration, MethodSignature, PropertyDeclaration, PropertySignature, VariableDeclaration, ParameterDeclaration, GetAccessorDeclaration, SetAccessorDeclaration, EnumMember, TypeAliasDeclaration, Node, SyntaxKind, FunctionExpression } from "ts-morph";
-import * as Famix from "../lib/famix/src/model/famix";
-import { FamixRepository } from "../lib/famix/src/famix_repository";
-import { FQNFunctions } from "../fqn";
-import { FamixFunctionsIndex } from "./famix_functions_index";
-
-/**
- * This class is used to build a Famix model for the types
- */
-export class FamixFunctionsTypes {
-
-    private famixRep: FamixRepository; // The Famix repository
-    private FQNFunctions = new FQNFunctions(); // The fully qualified name functions
-    private fmxTypes = new Map<string, Famix.Type | Famix.PrimitiveType | Famix.ParameterizedType>(); // Maps the type names to their Famix model
-    private famixFunctionsIndex: FamixFunctionsIndex; // FamixFunctionsIndex object, it contains all the functions needed to create Famix index file anchors
-
-    /**
-     * Initializes the FamixFunctionsIndex object
-     * @param famixRep The Famix repository
-     */
-    constructor(famixRep: FamixRepository) {
-        this.famixRep = famixRep;
-        this.famixFunctionsIndex = new FamixFunctionsIndex(famixRep);
-    }
-
-    /**
-     * Creates or gets a Famix type
-     * @param typeName A type name
-     * @param element A ts-morph element
-     * @returns The Famix model of the type
-     */
-    public createOrGetFamixType(typeName: string, element: TypeAliasDeclaration | PropertyDeclaration | PropertySignature | MethodDeclaration | ConstructorDeclaration | MethodSignature | GetAccessorDeclaration | SetAccessorDeclaration | FunctionDeclaration | FunctionExpression | ParameterDeclaration | VariableDeclaration | EnumMember): Famix.Type | Famix.PrimitiveType | Famix.ParameterizedType {
-        let fmxType: Famix.Type | Famix.PrimitiveType | Famix.ParameterizedType;
-        let isPrimitiveType = false;
-        let isParameterizedType = false;
-
-        const typeAncestor = this.findTypeAncestor(element);
-        const ancestorFullyQualifiedName = this.FQNFunctions.getFQN(typeAncestor);
-        const ancestor = this.getFamixEntityByFullyQualifiedName(ancestorFullyQualifiedName) as Famix.ContainerEntity;
-
-        if (typeName === "number" || typeName === "string" || typeName === "boolean" || typeName === "bigint" || typeName === "symbol" || typeName === "undefined" || typeName === "null") {
-            isPrimitiveType = true;
-        }
-
-        if(!isPrimitiveType && typeName.includes("<") && typeName.includes(">") && !(typeName.includes("=>"))) {
-            isParameterizedType = true;
-        }
-
-        if (!this.fmxTypes.has(typeName)) {
-            if (isPrimitiveType) {
-                fmxType = new Famix.PrimitiveType(this.famixRep);
-                fmxType.setIsStub(true);
-            }
-            else if (isParameterizedType) {
-                fmxType = new Famix.ParameterizedType(this.famixRep);
-                const parameterTypeNames = typeName.substring(typeName.indexOf("<") + 1, typeName.indexOf(">")).split(",").map(s => s.trim());
-                const baseTypeName = typeName.substring(0, typeName.indexOf("<")).trim();
-                parameterTypeNames.forEach(parameterTypeName => {
-                    const fmxParameterType = this.createOrGetFamixType(parameterTypeName, element);
-                    (fmxType as Famix.ParameterizedType).addArgument(fmxParameterType);
-                });
-                const fmxBaseType = this.createOrGetFamixType(baseTypeName, element);
-                (fmxType as Famix.ParameterizedType).setBaseType(fmxBaseType);
-            }
-            else {
-                fmxType = new Famix.Type(this.famixRep);
-            }
-
-            fmxType.setName(typeName);
-            fmxType.setContainer(ancestor);
-            
-            this.famixFunctionsIndex.makeFamixIndexFileAnchor(null, fmxType);
-
-            this.fmxTypes.set(typeName, fmxType);
-        }
-        else {
-            fmxType = this.fmxTypes.get(typeName);
-        }
-
-        return fmxType;
-    }
-
-    /**
-     * Gets a Famix entity by fully qualified name
-     * @param fullyQualifiedName A fully qualified name
-     * @returns The Famix entity corresponding to the fully qualified name
-     */
-    private getFamixEntityByFullyQualifiedName(fullyQualifiedName: string): Famix.Entity {
-        return this.famixRep.getFamixEntityByFullyQualifiedName(fullyQualifiedName) as Famix.Entity;
-    }
-
-    /**
-     * Finds the ancestor of a ts-morph element
-     * @param element A ts-morph element
-     * @returns The ancestor of the ts-morph element
-     */
-    private findTypeAncestor(element: TypeAliasDeclaration | PropertyDeclaration | PropertySignature | MethodDeclaration | ConstructorDeclaration | MethodSignature | GetAccessorDeclaration | SetAccessorDeclaration | FunctionDeclaration | FunctionExpression | ParameterDeclaration | VariableDeclaration | EnumMember): Node {
-        return element.getAncestors().find(a => a.getKind() === SyntaxKind.MethodDeclaration || a.getKind() === SyntaxKind.Constructor || a.getKind() === SyntaxKind.MethodSignature || a.getKind() === SyntaxKind.FunctionDeclaration || a.getKind() === SyntaxKind.FunctionExpression || a.getKind() === SyntaxKind.ModuleDeclaration || a.getKind() === SyntaxKind.SourceFile || a.getKindName() === "GetAccessor" || a.getKindName() === "SetAccessor" || a.getKind() === SyntaxKind.ClassDeclaration || a.getKind() === SyntaxKind.InterfaceDeclaration);
-    }
-}
+import { ConstructorDeclaration, FunctionDeclaration, MethodDeclaration, MethodSignature, PropertyDeclaration, PropertySignature, VariableDeclaration, ParameterDeclaration, GetAccessorDeclaration, SetAccessorDeclaration, EnumMember, TypeAliasDeclaration, Node, SyntaxKind, FunctionExpression } from "ts-morph";
+import * as Famix from "../lib/famix/src/model/famix";
+import { FamixRepository } from "../lib/famix/src/famix_repository";
+import { FQNFunctions } from "../fqn";
+import { FamixFunctionsIndex } from "./famix_functions_index";
+
+/**
+ * This class is used to build a Famix model for the types
+ */
+export class FamixFunctionsTypes {
+
+    private famixRep: FamixRepository; // The Famix repository
+    private FQNFunctions = new FQNFunctions(); // The fully qualified name functions
+    private fmxTypeMap = new Map<string, Famix.Type | Famix.PrimitiveType | Famix.ParameterizedType>(); // Maps the type names to their Famix model
+    private famixFunctionsIndex: FamixFunctionsIndex; // FamixFunctionsIndex object, it contains all the functions needed to create Famix index file anchors
+
+    /**
+     * Initializes the FamixFunctionsIndex object
+     * @param famixRep The Famix repository
+     */
+    constructor(famixRep: FamixRepository) {
+        this.famixRep = famixRep;
+        this.famixFunctionsIndex = new FamixFunctionsIndex(famixRep);
+    }
+
+    /**
+     * Creates or gets a Famix type
+     * @param typeName A type name
+     * @param element A ts-morph element
+     * @returns The Famix model of the type
+     */
+    public createOrGetFamixType(typeName: string, element: TypeAliasDeclaration | PropertyDeclaration | PropertySignature | MethodDeclaration | ConstructorDeclaration | MethodSignature | GetAccessorDeclaration | SetAccessorDeclaration | FunctionDeclaration | FunctionExpression | ParameterDeclaration | VariableDeclaration | EnumMember): Famix.Type | Famix.PrimitiveType | Famix.ParameterizedType {
+        let fmxType: Famix.Type | Famix.PrimitiveType | Famix.ParameterizedType;
+        let isPrimitiveType = false;
+        let isParameterizedType = false;
+
+        console.info("Creating (or getting) type: " + typeName + "' of element: " + element.getText() + " of kind: " + element.getKindName());
+
+        const typeAncestor = this.findTypeAncestor(element);
+        const ancestorFullyQualifiedName = this.FQNFunctions.getFQN(typeAncestor);
+        const ancestor = this.getFamixEntityByFullyQualifiedName(ancestorFullyQualifiedName) as Famix.ContainerEntity;
+        if (!ancestor) {
+            throw new Error(`Ancestor ${ancestorFullyQualifiedName} not found.`);
+        }
+
+        if (typeName === "number" || typeName === "string" || typeName === "boolean" || typeName === "bigint" || typeName === "symbol" || typeName === "undefined" || typeName === "null") {
+            isPrimitiveType = true;
+        }
+
+        if(!isPrimitiveType && typeName.includes("<") && typeName.includes(">") && !(typeName.includes("=>"))) {
+            isParameterizedType = true;
+        }
+
+        if (!this.fmxTypeMap.has(typeName)) {
+            if (isPrimitiveType) {
+                fmxType = new Famix.PrimitiveType(this.famixRep);
+                fmxType.setIsStub(true);
+            }
+            else if (isParameterizedType) {
+                fmxType = new Famix.ParameterizedType(this.famixRep);
+                const parameterTypeNames = typeName.substring(typeName.indexOf("<") + 1, typeName.indexOf(">")).split(",").map(s => s.trim());
+                const baseTypeName = typeName.substring(0, typeName.indexOf("<")).trim();
+                parameterTypeNames.forEach(parameterTypeName => {
+                    const fmxParameterType = this.createOrGetFamixType(parameterTypeName, element);
+                    (fmxType as Famix.ParameterizedType).addArgument(fmxParameterType);
+                });
+                const fmxBaseType = this.createOrGetFamixType(baseTypeName, element);
+                (fmxType as Famix.ParameterizedType).setBaseType(fmxBaseType);
+            }
+            else {
+                fmxType = new Famix.Type(this.famixRep);
+            }
+
+            fmxType.setName(typeName);
+            fmxType.setContainer(ancestor);
+            
+            this.famixFunctionsIndex.makeFamixIndexFileAnchor(null, fmxType);
+
+            this.fmxTypeMap.set(typeName, fmxType);
+        }
+        else {
+            fmxType = this.fmxTypeMap.get(typeName);
+        }
+
+        return fmxType;
+    }
+
+    /**
+     * Gets a Famix entity by fully qualified name
+     * @param fullyQualifiedName A fully qualified name
+     * @returns The Famix entity corresponding to the fully qualified name
+     */
+    private getFamixEntityByFullyQualifiedName(fullyQualifiedName: string): Famix.Entity {
+        return this.famixRep.getFamixEntityByFullyQualifiedName(fullyQualifiedName) as Famix.Entity;
+    }
+
+    /**
+     * Finds the ancestor of a ts-morph element
+     * @param element A ts-morph element
+     * @returns The ancestor of the ts-morph element
+     */
+    private findTypeAncestor(element: TypeAliasDeclaration | PropertyDeclaration | PropertySignature | MethodDeclaration | ConstructorDeclaration | MethodSignature | GetAccessorDeclaration | SetAccessorDeclaration | FunctionDeclaration | FunctionExpression | ParameterDeclaration | VariableDeclaration | EnumMember): Node {
+        return element.getAncestors().find(a => a.getKind() === SyntaxKind.MethodDeclaration || a.getKind() === SyntaxKind.Constructor || a.getKind() === SyntaxKind.MethodSignature || a.getKind() === SyntaxKind.FunctionDeclaration || a.getKind() === SyntaxKind.FunctionExpression || a.getKind() === SyntaxKind.ModuleDeclaration || a.getKind() === SyntaxKind.SourceFile || a.getKindName() === "GetAccessor" || a.getKindName() === "SetAccessor" || a.getKind() === SyntaxKind.ClassDeclaration || a.getKind() === SyntaxKind.InterfaceDeclaration);
+    }
+}

package/src/generate_uml.sh

@@ -1,16 +1,16 @@
-# Gets latest plantuml
-rm -f plantuml.jar
-wget --no-verbose https://downloads.sourceforge.net/project/plantuml/plantuml.jar
-# Builds metamodel plantuml from TypeScript sources
-npx tplant -i src/lib/famix/**/*.ts -o doc-metamodel/famix-typescript-model.puml
-sed -i 's/@startuml/& metamodel/' doc-metamodel/famix-typescript-model.puml
-# Converts plantuml source to SVG image
-java -jar plantuml.jar -v -tsvg doc-metamodel/famix-typescript-model.puml
-mv doc-metamodel/metamodel.svg doc-metamodel/metamodel-full.svg
-# Inserts include line to customize the file
-sed -i '/@startuml metamodel/a !include skins.include.puml' doc-metamodel/famix-typescript-model.puml
-# Converts plantuml source to SVG image
-java -jar plantuml.jar -v -tsvg doc-metamodel/famix-typescript-model.puml
-# Moves artifacts
-rm -f doc-uml/*
-mv doc-metamodel/*.svg doc-uml
+# Gets latest plantuml
+rm -f plantuml.jar
+wget --no-verbose https://downloads.sourceforge.net/project/plantuml/plantuml.jar
+# Builds metamodel plantuml from TypeScript sources
+npx tplant -i src/lib/famix/**/*.ts -o doc-metamodel/famix-typescript-model.puml
+sed -i 's/@startuml/& metamodel/' doc-metamodel/famix-typescript-model.puml
+# Converts plantuml source to SVG image
+java -jar plantuml.jar -v -tsvg doc-metamodel/famix-typescript-model.puml
+mv doc-metamodel/metamodel.svg doc-metamodel/metamodel-full.svg
+# Inserts include line to customize the file
+sed -i '/@startuml metamodel/a !include skins.include.puml' doc-metamodel/famix-typescript-model.puml
+# Converts plantuml source to SVG image
+java -jar plantuml.jar -v -tsvg doc-metamodel/famix-typescript-model.puml
+# Moves artifacts
+rm -f doc-uml/*
+mv doc-metamodel/*.svg doc-uml

package/src/lib/famix/License.md

@@ -1,23 +1,23 @@
-Portions of the code in the famix directory:
-
-MIT License
-
-Copyright (c) 2019 Pascal Erni
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+Portions of the code in the famix directory:
+
+MIT License
+
+Copyright (c) 2019 Pascal Erni
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.