ts2famix 2.0.0 → 2.0.1

package/src/lib/famix/src/famix_base_element.ts

@@ -1,22 +0,0 @@
-import { logger } from "../../../analyze";
-import { FamixJSONExporter } from "./famix_JSON_exporter";
-// import { FamixRepository } from "./famix_repository";
-
-export abstract class FamixBaseElement {
-
-  public id: number;
-
-  // constructor(repo: FamixRepository) {
-  //   repo.addElement(this);
-  // }
-
-  constructor(){
-  }
-
-  public abstract getJSON(): string;
-
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  public addPropertiesToExporter(exporter: FamixJSONExporter): void {
-    logger.debug("addPropertiesToExporter not implemented for " + this.constructor.name + `(${exporter})`);
-  }
-}

package/src/lib/famix/src/famix_repository.ts

@@ -1,243 +0,0 @@
-import { FamixBaseElement } from "./famix_base_element";
-import { Class, Interface, Variable, Method, ArrowFunction, Function as FamixFunctionEntity, Type, NamedEntity, ScriptEntity, Module, SourceLanguage } from "./model/famix";
-// import { ClassDeclaration, ConstructorDeclaration, FunctionDeclaration, Identifier, InterfaceDeclaration, MethodDeclaration, MethodSignature, ModuleDeclaration, PropertyDeclaration, PropertySignature, SourceFile, TypeParameterDeclaration, VariableDeclaration, ParameterDeclaration, Decorator, GetAccessorDeclaration, SetAccessorDeclaration, ImportSpecifier, CommentRange, EnumDeclaration, EnumMember, TypeAliasDeclaration, FunctionExpression, ExpressionWithTypeArguments, ImportDeclaration, ImportEqualsDeclaration } from "ts-morph";
-import * as Famix from "./model/famix";
-import { TSMorphObjectType } from "../../../famix_functions/EntityDictionary";
-/**
- * This class is used to store all Famix elements
- */
-export class FamixRepository {
-  private elements = new Set<FamixBaseElement>(); // All Famix elements
-  private famixClasses = new Set<Class>(); // All Famix classes
-  private famixInterfaces = new Set<Interface>(); // All Famix interfaces
-  private famixModules = new Set<Module>(); // All Famix namespaces
-  private famixMethods = new Set<Method>(); // All Famix methods
-  private famixVariables = new Set<Variable>(); // All Famix variables
-  private famixFunctions = new Set<FamixFunctionEntity>(); // All Famix functions
-  private famixFiles = new Set<ScriptEntity | Module>(); // All Famix files
-  private idCounter = 1; // Id counter
-  private absolutePath: string = "";
-  private fmxElementObjectMap = new Map<Famix.Entity,TSMorphObjectType>();
-
-  constructor() {
-    this.addElement(new SourceLanguage());  // add the source language entity (TypeScript)
-  }
-
-  public setFmxElementObjectMap(fmxElementObjectMap: Map<Famix.Entity,TSMorphObjectType>){
-    this.fmxElementObjectMap = fmxElementObjectMap;
-  }
-
-  public getFmxElementObjectMap(){
-    return this.fmxElementObjectMap;
-  }
-
-  public getAbsolutePath() : string {
-    return this.absolutePath;
-  }
-
-  public setAbsolutePath( path: string ){
-    this.absolutePath = path;
-  }
-
-  /**
-   * Gets a Famix entity by id
-   * @param id An id of a Famix entity
-   * @returns The Famix entity corresponding to the id or undefined if it doesn't exist
-   */
-  public getFamixEntityById(id: number): FamixBaseElement | undefined {
-    const entity = Array.from(this.elements.values()).find(e => e.id === id);
-    return entity;
-  }
-
-  /**
-   * Gets a Famix entity by fully qualified name
-   * @param fullyQualifiedName A fully qualified name
-   * @returns The Famix entity corresponding to the fully qualified name or undefined if it doesn't exist
-   */
-  public getFamixEntityByFullyQualifiedName(fullyQualifiedName: string): FamixBaseElement | undefined {
-    const allEntities = Array.from(this.elements.values()).filter(e => e instanceof NamedEntity) as Array<NamedEntity>;
-    const entity = allEntities.find(e => e.getFullyQualifiedName() === fullyQualifiedName);
-    return entity;
-  }
-
-  export(arg0: { format: string; }) {
-    if(arg0.format === "json") {
-      return this.getJSON();
-    } else {
-      throw new Error("Unsupported format");
-    }
-  }
-
-
-  // Only for tests
-
-  /**
-   * Gets all Famix entities
-   * @returns All Famix entities
-   */
-  public _getAllEntities(): Set<FamixBaseElement> {
-    return new Set(Array.from(this.elements.values()));
-  }
-
-  /**
-   * Gets all Famix entities of a given type
-   * @param theType A type of Famix entity
-   * @returns All Famix entities of the given type
-   */
-  public _getAllEntitiesWithType(theType: string): Set<FamixBaseElement> {
-    return new Set(Array.from(this.elements.values()).filter(e => (e as FamixBaseElement).constructor.name === theType));
-  }
-
-  /**
-   * Gets a Famix class by name
-   * @param name A class name
-   * @returns The Famix class corresponding to the name or undefined if it doesn't exist
-   */
-  public _getFamixClass(fullyQualifiedName: string): Class | undefined {
-    return Array.from(this.famixClasses.values()).find(ns => ns.getFullyQualifiedName() === fullyQualifiedName);
-  }
-
-  /**
-   * Gets a Famix interface by name
-   * @param name An interface name
-   * @returns The Famix interface corresponding to the name or undefined if it doesn't exist
-   */
-  public _getFamixInterface(fullyQualifiedName: string): Interface | undefined {
-    return Array.from(this.famixInterfaces.values()).find(ns => ns.getFullyQualifiedName() === fullyQualifiedName);
-  }
-
-  /**
-   * Gets a Famix method by name
-   * @param name A method name
-   * @returns The Famix method corresponding to the name or undefined if it doesn't exist
-   */
-  public _getFamixMethod(fullyQualifiedName: string): Method | undefined {
-    return Array.from(this.famixMethods.values()).find(ns => ns.getFullyQualifiedName() === fullyQualifiedName);
-  }
-
-  /**
-   * Gets a Famix function by name
-   * @param name A function name
-   * @returns The Famix function corresponding to the name or undefined if it doesn't exist
-   */
-  public _getFamixFunction(fullyQualifiedName: string): FamixFunctionEntity | undefined {
-    return Array.from(this.famixFunctions.values()).find(ns => ns.getFullyQualifiedName() === fullyQualifiedName);
-  }
-
-
-  /**
-   * Gets a Famix variable by name
-   * @param name A variable name
-   * @returns The Famix variable corresponding to the name or undefined if it doesn't exist
-   */
-  public _getFamixVariable(fullyQualifiedName: string): Variable | undefined {
-    return Array.from(this.famixVariables.values()).find(v => v.getFullyQualifiedName() === fullyQualifiedName);
-  }
-
-  /**
-   * Gets a Famix namespace by name
-   * @param name A namespace name
-   * @returns The Famix namespace corresponding to the name or undefined if it doesn't exist
-   */
-  public _getFamixModule(fullyQualifiedName: string): Module | undefined {
-    return Array.from(this.famixModules.values()).find(ns => ns.getFullyQualifiedName() === fullyQualifiedName);
-  }
-
-  /**
-   * Gets all Famix namespaces
-   * @returns All Famix namespaces
-   */
-  public _getFamixModules(): Set<Module> {
-    return new Set(Array.from(this.famixModules.values()));
-  }
-
-  /**
-   * Gets a Famix file by name
-   * @param name A file name
-   * @returns The Famix file corresponding to the name or undefined if it doesn't exist
-   */
-  public _getFamixFile(fullyQualifiedName: string): ScriptEntity | Module | undefined {
-    return Array.from(this.famixFiles.values()).find(ns => ns.getName() === fullyQualifiedName);
-  }
-
-  /**
-   * Gets all Famix files
-   * @returns All Famix files
-   */
-  public _getFamixFiles(): Set<ScriptEntity | Module> {
-    return new Set(Array.from(this.famixFiles.values()));
-  }
-
-  /**
-   * Gets all method names as a set from a class
-   * @param className A class name
-   * @returns The set of class "className" method names
-   */
-  public _methodNamesAsSetFromClass(className: string): Set<string> {
-    const theClass = this._getFamixClass(className) as Class;
-    return new Set(Array.from(theClass.getMethods()).map(m => m.getName()));
-  }
-
-  /**
-   * Gets all method parents as a set from a class
-   * @param className A class name
-   * @returns The set of class "className" method parents
-   */
-  public _methodParentsAsSetFromClass(className: string): Set<Type> {
-    const theClass = this._getFamixClass(className) as Class;
-    return new Set(Array.from(theClass.getMethods()).map(m => m.getParentEntity()));
-  }
-
-  /**
-   * Gets the map of Famix element ids and their Famix element from a JSON model
-   * @param model A JSON model
-   * @returns The map of Famix element ids and their Famix element from the JSON model
-   */
-  public _initMapFromModel(model: string): Map<number, unknown> {
-    const parsedModel: Array<FamixBaseElement> = JSON.parse(model);
-    const idToElementMap: Map<number, unknown> = new Map();
-    parsedModel.forEach(element => {
-        idToElementMap.set(element.id, element);
-    });
-    return idToElementMap;
-  }
-
-
-  /**
-   * Adds a Famix element to the repository
-   * @param element A Famix element
-   */
-  public addElement(element: FamixBaseElement): void {
-    if (element instanceof Class) {
-      this.famixClasses.add(element);
-    } else if (element instanceof Interface) {
-      this.famixInterfaces.add(element);
-    } else if (element instanceof Module) {
-      this.famixModules.add(element);
-    } else if (element instanceof Variable) {
-      this.famixVariables.add(element);
-    } else if (element instanceof Method) {
-      this.famixMethods.add(element);
-    } else if (element instanceof FamixFunctionEntity || element instanceof ArrowFunction) {
-      this.famixFunctions.add(element);
-    } else if (element instanceof ScriptEntity || element instanceof Module) {
-      this.famixFiles.add(element);
-    }
-    this.elements.add(element);
-    element.id = this.idCounter;
-    this.idCounter++;
-  }
-
-  /**
-   * Gets a JSON representation of the repository
-   * @returns A JSON representation of the repository
-   */
-  public getJSON(): string {
-    let ret = "[";
-    for (const element of Array.from(this.elements.values())) {
-      ret = ret + element.getJSON() + ",";
-    }
-    ret = ret.substring(0, ret.length - 1);
-    return ret + "]";
-  }
-}

package/src/lib/famix/src/model/famix/access.ts

@@ -1,53 +0,0 @@
-import { FamixJSONExporter } from "../../famix_JSON_exporter";
-import { StructuralEntity } from "./structural_entity";
-import { ContainerEntity } from "./container_entity";
-import { Entity } from "./entity";
-
-export class Access extends Entity {
-
-  private accessor: ContainerEntity;
-
-  public getAccessor(): ContainerEntity {
-    return this.accessor;
-  }
-
-  public setAccessor(accessor: ContainerEntity): void {
-    this.accessor = accessor;
-    accessor.addAccess(this);
-  }
-
-  private variable: StructuralEntity;
-
-  public getVariable(): StructuralEntity {
-    return this.variable;
-  }
-
-  public setVariable(variable: StructuralEntity): void {
-    this.variable = variable;
-    variable.addIncomingAccess(this);
-  }
-
-  private isWrite: boolean;
-
-  public getIsWrite(): boolean {
-    return this.isWrite;
-  }
-
-  public setIsWrite(isWrite: boolean): void {
-    this.isWrite = isWrite;
-  }
-
-
-  public getJSON(): string {
-    const json: FamixJSONExporter = new FamixJSONExporter("Access", this);
-    this.addPropertiesToExporter(json);
-    return json.getJSON();
-  }
-
-  public addPropertiesToExporter(exporter: FamixJSONExporter): void {
-    super.addPropertiesToExporter(exporter);
-    exporter.addProperty("accessor", this.getAccessor());
-    exporter.addProperty("variable", this.getVariable());
-    exporter.addProperty("isWrite", this.getIsWrite());
-  }
-}

package/src/lib/famix/src/model/famix/alias.ts

@@ -1,41 +0,0 @@
-import { FamixJSONExporter } from "../../famix_JSON_exporter";
-import { NamedEntity } from "./named_entity";
-import { Type } from "./type";
-
-export class Alias extends NamedEntity {
-
-  private parentEntity: NamedEntity;
-
-  public getParentEntity(): NamedEntity {
-    return this.parentEntity;
-  }
-
-  public setParentEntity(parentEntity: NamedEntity): void {
-    this.parentEntity = parentEntity;
-    parentEntity.addAlias(this);
-  }
-
-  private aliasedEntity: Type;
-
-  public getAliasedEntity(): Type {
-    return this.aliasedEntity;
-  }
-
-  public setAliasedEntity(aliasedEntity: Type): void {
-    this.aliasedEntity = aliasedEntity;
-    aliasedEntity.addTypeAlias(this);
-  }
-
-
-  public getJSON(): string {
-    const json: FamixJSONExporter = new FamixJSONExporter("Alias", this);
-    this.addPropertiesToExporter(json);
-    return json.getJSON();
-  }
-
-  public addPropertiesToExporter(exporter: FamixJSONExporter): void {
-    super.addPropertiesToExporter(exporter);
-    exporter.addProperty("parentType", this.getParentEntity());
-    exporter.addProperty("aliasedEntity", this.getAliasedEntity());
-  }
-}

package/src/lib/famix/src/model/famix/behavioral_entity.ts

@@ -1,100 +0,0 @@
-import { FamixJSONExporter } from "../../famix_JSON_exporter";
-import { Type } from "./type";
-import { ContainerEntity } from "./container_entity";
-import { Parameter } from "./parameter";
-import { Invocation } from "./invocation";
-import { ParameterType } from "./parameter_type";
-
-export class BehavioralEntity extends ContainerEntity {
-
-  private signature: string;
-
-  public getSignature(): string {
-    return this.signature;
-  }
-
-  public setSignature(signature: string): void {
-    this.signature = signature;
-  }
-
-  private parameters: Set<Parameter> = new Set();
-
-  public getParameters(): Set<Parameter> {
-    return this.parameters;
-  }
-
-  public addParameter(parameter: Parameter): void {
-    if (!this.parameters.has(parameter)) {
-      this.parameters.add(parameter);
-      parameter.setParentEntity(this);
-    }
-  }
-
-  private numberOfParameters: number;
-
-  public getNumberOfParameters(): number {
-    return this.numberOfParameters;
-  }
-
-  public setNumberOfParameters(numberOfParameters: number): void {
-    this.numberOfParameters = numberOfParameters;
-  }
-
-  private incomingInvocations: Set<Invocation> = new Set();
-
-  public getIncomingInvocations(): Set<Invocation> {
-    return this.incomingInvocations;
-  }
-
-  public addIncomingInvocation(incomingInvocation: Invocation): void {
-    if (!this.incomingInvocations.has(incomingInvocation)) {
-      this.incomingInvocations.add(incomingInvocation);
-      incomingInvocation.addCandidate(this);
-    }
-  }
-
-  private declaredType: Type;
-
-  public getDeclaredType(): Type {
-    return this.declaredType;
-  }
-
-  public setDeclaredType(declaredType: Type): void {
-    this.declaredType = declaredType;
-    declaredType.addBehavioralEntityWithDeclaredType(this);
-  }
-
-  private genericParameters: Set<ParameterType> = new Set();
-
-  public getGenericParameters(): Set<ParameterType> {
-    return this.genericParameters;
-  }
-
-  public addGenericParameter(genericParameter: ParameterType): void {
-    if (!this.genericParameters.has(genericParameter)) {
-      this.genericParameters.add(genericParameter);
-      genericParameter.setParentGeneric(this);
-    }
-  }
-
-  clearGenericParameters(): void {
-    this.genericParameters.clear();
-  }
-
-  public getJSON(): string {
-    const json: FamixJSONExporter = new FamixJSONExporter("BehavioralEntity", this);
-    this.addPropertiesToExporter(json);
-    return json.getJSON();
-  }
-
-  public addPropertiesToExporter(exporter: FamixJSONExporter): void {
-    super.addPropertiesToExporter(exporter);
-    exporter.addProperty("signature", this.getSignature());
-    exporter.addProperty("parameters", this.getParameters());
-    exporter.addProperty("numberOfParameters", this.getNumberOfParameters());
-    exporter.addProperty("incomingInvocations", this.getIncomingInvocations());
-    exporter.addProperty("declaredType", this.getDeclaredType());
-    /* don't add the property here, since it doesn't apply to all subclasses */
-//    exporter.addProperty("genericParameters", this.getGenericParameters());
-  }
-}

package/src/lib/famix/src/model/famix/class.ts

@@ -1,86 +0,0 @@
-import { FamixJSONExporter } from "../../famix_JSON_exporter";
-import { Type } from "./type";
-import { Method } from "./method";
-import { Property } from "./property";
-import { Inheritance } from "./inheritance";
-
-export class Class extends Type {
-
-  private isAbstract: boolean;
-
-  public getIsAbstract(): boolean {
-    return this.isAbstract;
-  }
-
-  public setIsAbstract(isAbstract: boolean): void {
-    this.isAbstract = isAbstract;
-  }
-
-  private properties: Set<Property> = new Set();
-
-  public getProperties(): Set<Property> {
-    return this.properties;
-  }
-
-  public addProperty(property: Property): void {
-    if (!this.properties.has(property)) {
-      this.properties.add(property);
-      property.setParentEntity(this);
-    }
-  }
-
-  private methods: Set<Method> = new Set();
-
-  public getMethods(): Set<Method> {
-    return this.methods;
-  }
-
-  public addMethod(method: Method): void {
-    if (!this.methods.has(method)) {
-      this.methods.add(method);
-      method.setParentEntity(this);
-    }
-  }
-
-  private superInheritances: Set<Inheritance> = new Set();
-
-  public getSuperInheritances(): Set<Inheritance> {
-    return this.superInheritances;
-  }
-
-  public addSuperInheritance(superInheritance: Inheritance): void {
-    if (!this.superInheritances.has(superInheritance)) {
-      this.superInheritances.add(superInheritance);
-      superInheritance.setSubclass(this);
-    }
-  }
-
-  private subInheritances: Set<Inheritance> = new Set();
-
-  public getSubInheritances(): Set<Inheritance> {
-    return this.subInheritances;
-  }
-
-  public addSubInheritance(subInheritance: Inheritance): void {
-    if (!this.subInheritances.has(subInheritance)) {
-      this.subInheritances.add(subInheritance);
-      subInheritance.setSuperclass(this);
-    }
-  }
-
-
-  public getJSON(): string {
-    const json: FamixJSONExporter = new FamixJSONExporter("Class", this);
-    this.addPropertiesToExporter(json);
-    return json.getJSON();
-  }
-
-  public addPropertiesToExporter(exporter: FamixJSONExporter): void {
-    super.addPropertiesToExporter(exporter);
-    exporter.addProperty("isAbstract", this.getIsAbstract());
-    exporter.addProperty("attributes", this.getProperties()); // Moose (10) codes them as attributes
-    exporter.addProperty("methods", this.getMethods());
-    exporter.addProperty("superInheritances", this.getSuperInheritances());
-    exporter.addProperty("subInheritances", this.getSubInheritances());  
-  }
-}

package/src/lib/famix/src/model/famix/comment.ts

@@ -1,50 +0,0 @@
-import { FamixJSONExporter } from "../../famix_JSON_exporter";
-import { SourcedEntity } from "./sourced_entity";
-
-export class Comment extends SourcedEntity {
-
-  private isJSDoc: boolean;
-
-  public getIsJSDoc(): boolean {
-    return this.isJSDoc;
-  }
-
-  public setIsJSDoc(isJSDoc: boolean): void {
-    this.isJSDoc = isJSDoc;
-  }
-
-  private container: SourcedEntity;
-
-  public getContainer(): SourcedEntity {
-    return this.container;
-  }
-
-  public setContainer(container: SourcedEntity): void {
-    this.container = container;
-    container.addComment(this);
-  }
-
-  private content: string;
-
-  public getContent(): string {
-    return this.content;
-  }
-
-  public setContent(content: string): void {
-    this.content = content;
-  }
-
-
-  public getJSON(): string {
-    const json: FamixJSONExporter = new FamixJSONExporter("Comment", this);
-    this.addPropertiesToExporter(json);
-    return json.getJSON();
-  }
-
-  public addPropertiesToExporter(exporter: FamixJSONExporter): void {
-    super.addPropertiesToExporter(exporter);
-    exporter.addProperty("isJSDoc", this.getIsJSDoc());
-    exporter.addProperty("commentedEntity", this.getContainer());
-    exporter.addProperty("content", this.getContent());
-  }
-}

package/src/lib/famix/src/model/famix/concretisation.ts

@@ -1,42 +0,0 @@
-import { FamixJSONExporter } from "../../famix_JSON_exporter";
-import { Entity } from "./entity";
-import { ParametricClass } from "./parametric_class";
-import { ParametricFunction } from "./parametric_function";
-import { ParametricInterface } from "./parametric_interface";
-import { ParametricMethod } from "./parametric_method";
-
-export class Concretisation extends Entity {
-
-    private genericEntity: ParametricClass | ParametricInterface | ParametricFunction | ParametricMethod;
-
-    public getGenericEntity(): ParametricClass | ParametricInterface | ParametricFunction | ParametricMethod {
-      return this.genericEntity;
-    }
-  
-    public setGenericEntity(genericEntity: ParametricClass | ParametricInterface | ParametricFunction | ParametricMethod): void {
-      this.genericEntity = genericEntity;
-    }
-  
-    private concreteEntity: ParametricClass | ParametricInterface | ParametricFunction | ParametricMethod;
-  
-    public getConcreteEntity(): ParametricClass | ParametricInterface | ParametricFunction | ParametricMethod {
-      return this.concreteEntity;
-    }
-  
-    public setConcreteEntity(concreteEntity: ParametricClass | ParametricInterface | ParametricFunction | ParametricMethod): void {
-      this.concreteEntity = concreteEntity;
-    }
-  
-    public getJSON(): string {
-      const json: FamixJSONExporter = new FamixJSONExporter("Concretisation", this);
-      this.addPropertiesToExporter(json);
-      return json.getJSON();
-    }
-  
-    public addPropertiesToExporter(exporter: FamixJSONExporter): void {
-      super.addPropertiesToExporter(exporter);
-      exporter.addProperty("genericEntity", this.getGenericEntity());
-      exporter.addProperty("concreteEntity", this.getConcreteEntity());
-    }
-
-}