ts2famix 1.0.12 → 1.0.14

package/src/lib/famix/package.json

@@ -1,28 +1,28 @@
-{
-  "name": "famix",
-  "version": "1.0.5",
-  "description": "a FAMIX model written typescript",
-  "main": "build/index.js",
-  "types": "build/index.d.ts",
-  "files": ["dist/**/*"],
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/pascalerni/famix.git"
-  },
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 0",
-    "build" : "tsc",
-    "lint": "tslint -p tsconfig.json",
-    "prepare": "npm run build",
-    "prepublishOnly": "npm test && npm run lint",
-    "preversion": "npm run lint",
-    "version": "git add -A src",
-    "postversion": "git push && git push --tags"
-  },
-  "author": "Pascal Erni",
-  "license": "MIT",
-  "devDependencies": {
-    "tslint": "^5.20.0",
-    "typescript": "^3.6.3"
-  }
+{
+  "name": "famix",
+  "version": "1.0.5",
+  "description": "a FAMIX model written typescript",
+  "main": "build/index.js",
+  "types": "build/index.d.ts",
+  "files": ["dist/**/*"],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/pascalerni/famix.git"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 0",
+    "build" : "tsc",
+    "lint": "tslint -p tsconfig.json",
+    "prepare": "npm run build",
+    "prepublishOnly": "npm test && npm run lint",
+    "preversion": "npm run lint",
+    "version": "git add -A src",
+    "postversion": "git push && git push --tags"
+  },
+  "author": "Pascal Erni",
+  "license": "MIT",
+  "devDependencies": {
+    "tslint": "^5.20.0",
+    "typescript": "^3.6.3"
+  }
 }

package/src/lib/famix/readme.md

@@ -1,5 +1,5 @@
-# FAMIX model in typescript
-
-FAMIX is a family of metamodels to represent source code.
-
+# FAMIX model in typescript
+
+FAMIX is a family of metamodels to represent source code.
+
 Learn more about the MSE file format and the FAMIX model https://www.researchgate.net/publication/265428652

package/src/lib/famix/src/famix_JSON_exporter.ts

@@ -1,56 +1,56 @@
-import { FamixBaseElement } from "./famix_base_element";
-
-/**
- * This class is used to export Famix elements to JSON
- */
-export class FamixJSONExporter {
-
-  private element: FamixBaseElement; // A Famix element to export
-  private bufferArray: any = {}; // A buffer to store the properties of the Famix element
-  private FamixPrefix = "FamixTypeScript"; // Prefix of the Famix element
-
-  /**
-   * Constructor of the FamixJSONExporter class
-   * @param packageClass Name of a Famix class
-   * @param element A Famix element to export, this element is an instance of the class named "packageClass"
-   */
-  constructor(packageClass: string, element: FamixBaseElement) {
-    this.element = element;
-    this.bufferArray["FM3"] = this.FamixPrefix + "." + packageClass;
-    this.bufferArray["id"] = this.element.id;
-  }
-
-  /**
-   * Adds a property to the Famix element
-   * @param name Name of the property
-   * @param prop A property
-   */
-  public addProperty(name: string, prop: unknown): void {
-    if (prop instanceof Set) {
-      const valueArray: Array<unknown> = [];
-      for (const value of Array.from(prop.values())) {
-        if (value instanceof FamixBaseElement) {
-          valueArray.push({ "ref": value.id });
-        }
-        else {
-          valueArray.push(value);
-        }
-      }
-      this.bufferArray[name] = valueArray;
-    }
-    else if (prop instanceof FamixBaseElement) {
-      this.bufferArray[name] = { "ref": prop.id };
-    }
-    else if (prop !== undefined && !(prop instanceof Set)) {
-      this.bufferArray[name] = prop;
-    }
-  }
-
-  /**
-   * Gets a JSON representation of the Famix element
-   * @returns A JSON representation of the Famix element
-   */
-  public getJSON(): string {
-    return JSON.stringify(this.bufferArray);
-  }
-}
+import { FamixBaseElement } from "./famix_base_element";
+
+/**
+ * This class is used to export Famix elements to JSON
+ */
+export class FamixJSONExporter {
+
+  private element: FamixBaseElement; // A Famix element to export
+  private bufferArray: any = {}; // A buffer to store the properties of the Famix element
+  private FamixPrefix = "FamixTypeScript"; // Prefix of the Famix element
+
+  /**
+   * Constructor of the FamixJSONExporter class
+   * @param packageClass Name of a Famix class
+   * @param element A Famix element to export, this element is an instance of the class named "packageClass"
+   */
+  constructor(packageClass: string, element: FamixBaseElement) {
+    this.element = element;
+    this.bufferArray["FM3"] = this.FamixPrefix + "." + packageClass;
+    this.bufferArray["id"] = this.element.id;
+  }
+
+  /**
+   * Adds a property to the Famix element
+   * @param name Name of the property
+   * @param prop A property
+   */
+  public addProperty(name: string, prop: unknown): void {
+    if (prop instanceof Set) {
+      const valueArray: Array<unknown> = [];
+      for (const value of Array.from(prop.values())) {
+        if (value instanceof FamixBaseElement) {
+          valueArray.push({ "ref": value.id });
+        }
+        else {
+          valueArray.push(value);
+        }
+      }
+      this.bufferArray[name] = valueArray;
+    }
+    else if (prop instanceof FamixBaseElement) {
+      this.bufferArray[name] = { "ref": prop.id };
+    }
+    else if (prop !== undefined && !(prop instanceof Set)) {
+      this.bufferArray[name] = prop;
+    }
+  }
+
+  /**
+   * Gets a JSON representation of the Famix element
+   * @returns A JSON representation of the Famix element
+   */
+  public getJSON(): string {
+    return JSON.stringify(this.bufferArray);
+  }
+}

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

@@ -1,18 +1,18 @@
-import { FamixJSONExporter } from "./famix_JSON_exporter";
-import { FamixRepository } from "./famix_repository";
-
-export abstract class FamixBaseElement {
-
-  public id: number;
-
-  constructor(repo: FamixRepository) {
-    repo.addElement(this);
-  }
-
-  public abstract getJSON(): string;
-
-  // @ts-ignore
-  // tslint:disable-next-line:no-empty
-  public addPropertiesToExporter(exporter: FamixJSONExporter): void {
-  }
-}
+import { FamixJSONExporter } from "./famix_JSON_exporter";
+import { FamixRepository } from "./famix_repository";
+
+export abstract class FamixBaseElement {
+
+  public id: number;
+
+  constructor(repo: FamixRepository) {
+    repo.addElement(this);
+  }
+
+  public abstract getJSON(): string;
+
+  // @ts-ignore
+  // tslint:disable-next-line:no-empty
+  public addPropertiesToExporter(exporter: FamixJSONExporter): void {
+  }
+}

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

@@ -1,199 +1,199 @@
-import { FamixBaseElement } from "./famix_base_element";
-import { Class, Interface, Namespace, Method, Function, Type, NamedEntity, ScriptEntity, Module } from "./model/famix";
-
-/**
- * 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 famixNamespaces = new Set<Namespace>(); // All Famix namespaces
-  private famixMethods = new Set<Method>(); // All Famix methods
-  private famixFunctions = new Set<Function>(); // All Famix functions
-  private famixFiles = new Set<ScriptEntity | Module>(); // All Famix files
-  private idCounter = 1; // Id counter
-
-  /**
-   * 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;
-  }
-
-  
-  // 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 any).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(name: string): Class | undefined {
-    return Array.from(this.famixClasses.values()).find(ns => ns.getName() === name);
-  }
-
-  /**
-   * 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(name: string): Interface | undefined {
-    return Array.from(this.famixInterfaces.values()).find(ns => ns.getName() === name);
-  }
-
-  /**
-   * 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(name: string): Method | undefined {
-    return Array.from(this.famixMethods.values()).find(ns => ns.getName() === name);
-  }
-
-  /**
-   * 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(name: string): Function | undefined {
-    return Array.from(this.famixFunctions.values()).find(ns => ns.getName() === name);
-  }
-
-  /**
-   * 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 _getFamixNamespace(name: string): Namespace | undefined {
-    return Array.from(this.famixNamespaces.values()).find(ns => ns.getName() === name);
-  }
-
-  /**
-   * Gets all Famix namespaces
-   * @returns All Famix namespaces
-   */
-  public _getFamixNamespaces(): Set<Namespace> {
-    return new Set(Array.from(this.famixNamespaces.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(name: string): ScriptEntity | Module | undefined {
-    return Array.from(this.famixFiles.values()).find(ns => ns.getName() === name);
-  }
-
-  /**
-   * 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<any> = 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 Namespace) {
-      this.famixNamespaces.add(element);
-    } else if (element instanceof Method) {
-      this.famixMethods.add(element);
-    } else if (element instanceof Function) {
-      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 + "]";
-  }
-}
+import { FamixBaseElement } from "./famix_base_element";
+import { Class, Interface, Namespace, Method, Function, Type, NamedEntity, ScriptEntity, Module } from "./model/famix";
+
+/**
+ * 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 famixNamespaces = new Set<Namespace>(); // All Famix namespaces
+  private famixMethods = new Set<Method>(); // All Famix methods
+  private famixFunctions = new Set<Function>(); // All Famix functions
+  private famixFiles = new Set<ScriptEntity | Module>(); // All Famix files
+  private idCounter = 1; // Id counter
+
+  /**
+   * 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;
+  }
+
+  
+  // 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 any).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(name: string): Class | undefined {
+    return Array.from(this.famixClasses.values()).find(ns => ns.getName() === name);
+  }
+
+  /**
+   * 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(name: string): Interface | undefined {
+    return Array.from(this.famixInterfaces.values()).find(ns => ns.getName() === name);
+  }
+
+  /**
+   * 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(name: string): Method | undefined {
+    return Array.from(this.famixMethods.values()).find(ns => ns.getName() === name);
+  }
+
+  /**
+   * 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(name: string): Function | undefined {
+    return Array.from(this.famixFunctions.values()).find(ns => ns.getName() === name);
+  }
+
+  /**
+   * 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 _getFamixNamespace(name: string): Namespace | undefined {
+    return Array.from(this.famixNamespaces.values()).find(ns => ns.getName() === name);
+  }
+
+  /**
+   * Gets all Famix namespaces
+   * @returns All Famix namespaces
+   */
+  public _getFamixNamespaces(): Set<Namespace> {
+    return new Set(Array.from(this.famixNamespaces.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(name: string): ScriptEntity | Module | undefined {
+    return Array.from(this.famixFiles.values()).find(ns => ns.getName() === name);
+  }
+
+  /**
+   * 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<any> = 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 Namespace) {
+      this.famixNamespaces.add(element);
+    } else if (element instanceof Method) {
+      this.famixMethods.add(element);
+    } else if (element instanceof Function) {
+      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/index.ts

@@ -1,8 +1,8 @@
-import * as Famix from "./model/famix";
-import { FamixBaseElement } from "./famix_base_element";
-import { FamixJSONExporter } from "./famix_JSON_exporter";
-import { FamixRepository } from "./famix_repository";
-
-const model = { Famix };
-
-export = { FamixBaseElement, FamixJSONExporter, FamixRepository, model };
+import * as Famix from "./model/famix";
+import { FamixBaseElement } from "./famix_base_element";
+import { FamixJSONExporter } from "./famix_JSON_exporter";
+import { FamixRepository } from "./famix_repository";
+
+const model = { Famix };
+
+export = { FamixBaseElement, FamixJSONExporter, FamixRepository, model };