codecharta-visualization 1.119.0 → 1.120.0

package/app/codeCharta/util/gameObjectsParser/gameObjectsImporter.ts

@@ -1,201 +0,0 @@
-import md5 from "md5"
-import { AttributeTypes, AttributeTypeValue, CodeMapNode, Edge, FixedPosition, NodeType } from "../../codeCharta.model"
-import { ExportWrappedCCFile } from "../../codeCharta.api.model"
-
-export interface GameObject {
-	name: string
-	position: Coordinates
-	scale: Coordinates
-}
-
-export interface Coordinates {
-	x: number
-	y: number
-	z: number
-}
-
-export interface Cycle {
-	from: string
-	to: string
-}
-
-const BASE_NAME = "base"
-
-export function parseGameObjectsFile(data): ExportWrappedCCFile {
-	const { gameObjectPositions: gameObjects, cycles = [] } = JSON.parse(data)
-
-	const codeChartaJson: ExportWrappedCCFile = {
-		checksum: "",
-		data: {
-			projectName: "GameObjects",
-			fileChecksum: "",
-			apiVersion: "1.3",
-			nodes: []
-		}
-	}
-
-	const nodes = [{ name: BASE_NAME, type: NodeType.FOLDER, attributes: {}, children: [] }]
-	fixGameObjectsNames(gameObjects)
-
-	const rootGameObject = gameObjects.find(gameObject => gameObject.name === "root")
-	const baseGameObject = createBaseGameObjectPosition(rootGameObject.scale)
-	gameObjects.push(baseGameObject)
-
-	for (const gameObject of gameObjects) {
-		const nodeNames = gameObject.name.split(".")
-		if (nodeNames[0] !== BASE_NAME) {
-			addNodeRecursively(nodeNames, nodes[0].children, BASE_NAME, gameObject, gameObjects, rootGameObject)
-		}
-	}
-
-	codeChartaJson.data.nodes = nodes
-	codeChartaJson.data.edges = cycles.map(cycle => createEdge(cycle))
-	codeChartaJson.data.attributeTypes = createAttributeTypes()
-	codeChartaJson.checksum = md5(JSON.stringify(codeChartaJson.data))
-	return codeChartaJson
-}
-
-function fixGameObjectsNames(gameObjects: GameObject[]) {
-	for (const gameObject of gameObjects) {
-		if (!gameObject.name.startsWith("root")) {
-			gameObject.name = gameObject.name.startsWith(".") ? `root${gameObject.name}` : `root.${gameObject.name}`
-		}
-	}
-}
-
-function addNodeRecursively(
-	nodeNames: string[],
-	nodes: CodeMapNode[],
-	parentNodeName: string,
-	gameObject: GameObject,
-	gameObjects: GameObject[],
-	rootGameObject: GameObject
-) {
-	if (nodeNames.length === 0) {
-		return
-	}
-
-	// get current node name and create cc node structure
-	const [nodeName] = nodeNames
-	let node: CodeMapNode = {
-		name: nodeName,
-		type: isFile(nodeNames) ? NodeType.FILE : NodeType.FOLDER,
-		attributes: {}
-	}
-
-	if (isFile(nodeNames)) {
-		node = wrapFileInAFolder(nodeName, node, gameObject)
-	} else {
-		node.children = []
-	}
-
-	if (nodeAlreadyExists(nodes, nodeName)) {
-		node = nodes.find(singleNode => singleNode.name === nodeName)
-	} else {
-		nodes.push(node)
-	}
-
-	const parentGameObject = gameObjects.find(gameObject => gameObject.name === parentNodeName)
-	node.fixedPosition = calculateFixedFolderPosition(node, parentGameObject, gameObject, rootGameObject.name)
-
-	const newParentName = parentNodeName === BASE_NAME ? node.name : `${parentNodeName}.${node.name}`
-	addNodeRecursively(nodeNames.slice(1), node.children, newParentName, gameObject, gameObjects, rootGameObject)
-}
-
-function isFile(names: string[]) {
-	return names.length === 1
-}
-
-function nodeAlreadyExists(nodes: CodeMapNode[], name: string) {
-	return nodes.some(singleNode => singleNode.name === name)
-}
-
-function wrapFileInAFolder(nodeName: string, node: CodeMapNode, gameObject: GameObject): CodeMapNode {
-	const childNode = { ...node }
-	childNode.attributes = { height: gameObject.scale.y }
-	return { name: nodeName, type: NodeType.FOLDER, attributes: {}, children: [childNode] }
-}
-
-function calculateFixedFolderPosition(
-	node: CodeMapNode,
-	parentGameObject: GameObject,
-	childGameObject: GameObject,
-	rootGameObjectName: string
-): FixedPosition {
-	let position: FixedPosition
-
-	if (node.type === NodeType.FOLDER) {
-		// translate the center point from the middle of the gameObject to the corner (needed for fixedPosition)
-		const cornerXofParent = parentGameObject.position.x - parentGameObject.scale.x / 2
-		const cornerZofParent = parentGameObject.position.z - parentGameObject.scale.z / 2
-		const cornerXofChild = childGameObject.position.x - childGameObject.scale.x / 2
-		const cornerZofChild = childGameObject.position.z - childGameObject.scale.z / 2
-
-		const top = round(((cornerXofChild - cornerXofParent) / parentGameObject.scale.x) * 100, 2)
-		const left = round(((cornerZofChild - cornerZofParent) / parentGameObject.scale.z) * 100, 2)
-		const width = round((childGameObject.scale.z / parentGameObject.scale.z) * 100, 2)
-		const height = round((childGameObject.scale.x / parentGameObject.scale.x) * 100, 2)
-		position = { left, top, width, height }
-	}
-
-	if (node.name === rootGameObjectName) {
-		position = getCenteredRootPosition(position)
-	}
-
-	return position
-}
-
-function round(value: number, decimalPoints: number): number {
-	const roundingValue = Math.pow(10, decimalPoints)
-	return Math.round(value * roundingValue) / roundingValue
-}
-
-function getCenteredRootPosition(rootFixedPosition: FixedPosition): FixedPosition {
-	const centeredPosition: FixedPosition = { ...rootFixedPosition }
-	centeredPosition.top = Math.floor(50 - centeredPosition.height / 2)
-	centeredPosition.left = Math.floor(50 - centeredPosition.width / 2)
-	return centeredPosition
-}
-
-function wrapFilePath(filePath: string): string {
-	const filePathWithSlash = filePath.replaceAll(".", "/")
-	const splitFilePath = filePath.split(".")
-	const fileName = splitFilePath.slice(-1)
-	// add file name again to the end because the file has been wrapped in a folder. (with the same name)
-	return `/${BASE_NAME}/${filePathWithSlash}/${fileName}`
-}
-
-function createEdge(cycle: Cycle): Edge {
-	return {
-		fromNodeName: wrapFilePath(cycle.from),
-		toNodeName: wrapFilePath(cycle.to),
-		attributes: {
-			coupling: 100
-		}
-	}
-}
-
-function createAttributeTypes(): AttributeTypes {
-	return {
-		edges: {
-			coupling: AttributeTypeValue.relative
-		}
-	}
-}
-
-function createBaseGameObjectPosition(rootGameObjectScale: Coordinates): GameObject {
-	const longEdge = Math.max(rootGameObjectScale.x, rootGameObjectScale.z)
-	return {
-		name: BASE_NAME,
-		position: {
-			x: 0,
-			y: 0,
-			z: 0
-		},
-		scale: {
-			x: longEdge,
-			y: 0,
-			z: longEdge
-		}
-	}
-}

package/app/codeCharta/util/gameObjectsParser/gameObjectsMocks.ts

@@ -1,75 +0,0 @@
-export const TEST_GAMEOBJECTS_FILE = {
-	gameObjectPositions: [
-		{
-			name: "visualization.ui",
-			position: {
-				x: 159.5,
-				y: 3.5,
-				z: 8.5
-			},
-			scale: {
-				x: 5,
-				y: 1,
-				z: 5
-			}
-		},
-		{
-			name: "visualization.packageLock",
-			position: {
-				x: 82,
-				y: 5,
-				z: 89
-			},
-			scale: {
-				x: 2,
-				y: 4,
-				z: 2
-			}
-		},
-		{
-			name: ".visualization",
-			position: {
-				x: 84,
-				y: 2.5,
-				z: 48
-			},
-			scale: {
-				x: 160,
-				y: 1,
-				z: 88
-			}
-		},
-		{
-			name: "root.CHANGELOG",
-			position: {
-				x: 84,
-				y: 2.5,
-				z: 552.5
-			},
-			scale: {
-				x: 5,
-				y: 1,
-				z: 5
-			}
-		},
-		{
-			name: "root",
-			position: {
-				x: 84,
-				y: 0.5,
-				z: 279.5
-			},
-			scale: {
-				x: 168,
-				y: 1,
-				z: 559
-			}
-		}
-	],
-	cycles: [
-		{
-			from: "root.CHANGELOG",
-			to: "root.visualization.packageLock"
-		}
-	]
-}

package/app/codeCharta/util/gameObjectsParser/gameObjectsSchema.json

@@ -1,271 +0,0 @@
-{
-	"$id": "http://example.com/example.json",
-	"$schema": "http://json-schema.org/draft-07/schema",
-	"default": {},
-	"description": "This is the JSON Schema for the GameObjectsPositions structure",
-	"examples": [
-		{
-			"gameObjectPositions": [
-				{
-					"name": "root.analysis.import.SourceCodeParser.src.test.kotlin.de.maibornwolff.codecharta.importer.sourcecodeparser.oop.core.extract.HelloWorldTest",
-					"position": {
-						"x": 69.0,
-						"y": 18.5,
-						"z": 228.5
-					},
-					"scale": {
-						"x": 9.0,
-						"y": 5.0,
-						"z": 9.0
-					}
-				},
-				{
-					"name": "root.analysis.import.SourceCodeParser.src.test.kotlin.de.maibornwolff.codecharta.importer.sourcecodeparser.oop.core.extract.TryCatchFinallyTest",
-					"position": {
-						"x": 66.0,
-						"y": 22.5,
-						"z": 177.5
-					},
-					"scale": {
-						"x": 1.0,
-						"y": 13.0,
-						"z": 1.0
-					}
-				}
-			],
-			"cycles": [
-				{
-					"from": "root.analysis.import.SCMLogParser.src.main.java.de.maibornwolff.codecharta.importer.scmlogparser.SCMLogParser",
-					"to": "root.analysis.import.SCMLogParser.src.main.java.de.maibornwolff.codecharta.importer.scmlogparser.SCMLogParserParameter"
-				}
-			]
-		}
-	],
-	"required": ["gameObjectPositions"],
-	"title": "The root schema",
-	"type": "object",
-	"properties": {
-		"gameObjectPositions": {
-			"$id": "#/properties/gameObjectPositions",
-			"type": "array",
-			"title": "The gameObjectPositions schema",
-			"description": "Defines the position and scale of GameObjects",
-			"default": [],
-			"examples": [
-				[
-					{
-						"name": "root.analysis.import.SourceCodeParser.src.test.kotlin.de.maibornwolff.codecharta.importer.sourcecodeparser.oop.core.extract.HelloWorldTest",
-						"position": {
-							"x": 69.0,
-							"y": 18.5,
-							"z": 228.5
-						},
-						"scale": {
-							"x": 9.0,
-							"y": 5.0,
-							"z": 9.0
-						}
-					},
-					{
-						"name": "root.analysis.import.SourceCodeParser.src.test.kotlin.de.maibornwolff.codecharta.importer.sourcecodeparser.oop.core.extract.SwitchCaseTest",
-						"position": {
-							"x": 65.0,
-							"y": 22.0,
-							"z": 181.0
-						},
-						"scale": {
-							"x": 2.0,
-							"y": 12.0,
-							"z": 2.0
-						}
-					}
-				]
-			],
-			"additionalItems": true,
-			"items": {
-				"$id": "#/properties/gameObjectPositions/items",
-				"anyOf": [
-					{
-						"$id": "#/properties/gameObjectPositions/items/anyOf/0",
-						"type": "object",
-						"title": "The first anyOf schema",
-						"description": "Defines the properties of a GameObject",
-						"default": {},
-						"examples": [
-							{
-								"name": "root.analysis.import.SourceCodeParser.src.test.kotlin.de.maibornwolff.codecharta.importer.sourcecodeparser.oop.core.extract.HelloWorldTest",
-								"position": {
-									"x": 69.0,
-									"y": 18.5,
-									"z": 228.5
-								},
-								"scale": {
-									"x": 9.0,
-									"y": 5.0,
-									"z": 9.0
-								}
-							}
-						],
-						"required": ["name", "position", "scale"],
-						"properties": {
-							"name": {
-								"$id": "#/properties/gameObjectPositions/items/anyOf/0/properties/name",
-								"type": "string",
-								"title": "The name schema",
-								"description": "An explanation about the purpose of this instance.",
-								"default": "",
-								"examples": [
-									"root.analysis.import.SourceCodeParser.src.test.kotlin.de.maibornwolff.codecharta.importer.sourcecodeparser.oop.core.extract.HelloWorldTest"
-								]
-							},
-							"position": {
-								"$id": "#/properties/gameObjectPositions/items/anyOf/0/properties/position",
-								"type": "object",
-								"title": "The position schema",
-								"description": "The position in absolute values",
-								"default": {},
-								"examples": [
-									{
-										"x": 69.0,
-										"y": 18.5,
-										"z": 228.5
-									}
-								],
-								"required": ["x", "y", "z"],
-								"properties": {
-									"x": {
-										"$id": "#/properties/gameObjectPositions/items/anyOf/0/properties/position/properties/x",
-										"type": "number",
-										"title": "The x schema",
-										"description": "x position",
-										"default": 0.0,
-										"examples": [69.0]
-									},
-									"y": {
-										"$id": "#/properties/gameObjectPositions/items/anyOf/0/properties/position/properties/y",
-										"type": "number",
-										"title": "The y schema",
-										"description": "y position",
-										"default": 0.0,
-										"examples": [18.5]
-									},
-									"z": {
-										"$id": "#/properties/gameObjectPositions/items/anyOf/0/properties/position/properties/z",
-										"type": "number",
-										"title": "The z schema",
-										"description": "z position",
-										"default": 0.0,
-										"examples": [228.5]
-									}
-								},
-								"additionalProperties": true
-							},
-							"scale": {
-								"$id": "#/properties/gameObjectPositions/items/anyOf/0/properties/scale",
-								"type": "object",
-								"title": "The scale schema",
-								"description": "The scale of GameObjects",
-								"default": {},
-								"examples": [
-									{
-										"x": 9.0,
-										"y": 5.0,
-										"z": 9.0
-									}
-								],
-								"required": ["x", "y", "z"],
-								"properties": {
-									"x": {
-										"$id": "#/properties/gameObjectPositions/items/anyOf/0/properties/scale/properties/x",
-										"type": "number",
-										"title": "The x schema",
-										"description": "x scale",
-										"default": 0.0,
-										"examples": [9.0]
-									},
-									"y": {
-										"$id": "#/properties/gameObjectPositions/items/anyOf/0/properties/scale/properties/y",
-										"type": "number",
-										"title": "The y schema",
-										"description": "y scale",
-										"default": 0.0,
-										"examples": [5.0]
-									},
-									"z": {
-										"$id": "#/properties/gameObjectPositions/items/anyOf/0/properties/scale/properties/z",
-										"type": "number",
-										"title": "The z schema",
-										"description": "z scale",
-										"default": 0.0,
-										"examples": [9.0]
-									}
-								},
-								"additionalProperties": true
-							}
-						},
-						"additionalProperties": true
-					}
-				]
-			}
-		},
-		"cycles": {
-			"$id": "#/properties/cycles",
-			"type": "array",
-			"title": "The cycles schema",
-			"description": "Defines the cycles between GameObjects",
-			"default": [],
-			"examples": [
-				[
-					{
-						"from": "root.analysis.import.SCMLogParser.src.main.java.de.maibornwolff.codecharta.importer.scmlogparser.SCMLogParser",
-						"to": "root.analysis.import.SCMLogParser.src.main.java.de.maibornwolff.codecharta.importer.scmlogparser.SCMLogParserParameter"
-					}
-				]
-			],
-			"additionalItems": true,
-			"items": {
-				"$id": "#/properties/cycles/items",
-				"anyOf": [
-					{
-						"$id": "#/properties/cycles/items/anyOf/0",
-						"type": "object",
-						"title": "The first anyOf schema",
-						"description": "A cycle between two GameObjects",
-						"default": {},
-						"examples": [
-							{
-								"from": "root.analysis.import.SCMLogParser.src.main.java.de.maibornwolff.codecharta.importer.scmlogparser.SCMLogParser",
-								"to": "root.analysis.import.SCMLogParser.src.main.java.de.maibornwolff.codecharta.importer.scmlogparser.SCMLogParserParameter"
-							}
-						],
-						"required": ["from", "to"],
-						"properties": {
-							"from": {
-								"$id": "#/properties/cycles/items/anyOf/0/properties/from",
-								"type": "string",
-								"title": "The from schema",
-								"description": "from GameObject",
-								"default": "",
-								"examples": [
-									"root.analysis.import.SCMLogParser.src.main.java.de.maibornwolff.codecharta.importer.scmlogparser.SCMLogParser"
-								]
-							},
-							"to": {
-								"$id": "#/properties/cycles/items/anyOf/0/properties/to",
-								"type": "string",
-								"title": "The to schema",
-								"description": "to GameObject",
-								"default": "",
-								"examples": [
-									"root.analysis.import.SCMLogParser.src.main.java.de.maibornwolff.codecharta.importer.scmlogparser.SCMLogParserParameter"
-								]
-							}
-						},
-						"additionalProperties": true
-					}
-				]
-			}
-		}
-	},
-	"additionalProperties": true
-}

package/app/codeCharta/util/gameObjectsParser/gameObjectsValidator.spec.ts

@@ -1,18 +0,0 @@
-import { validateGameObjects } from "./gameObjectsValidator"
-import { clone } from "../clone"
-import { TEST_GAMEOBJECTS_FILE } from "./gameObjectsMocks"
-
-describe("GameObjectsValidator", () => {
-	it("should check if gameObjects File structure is valid", function () {
-		const gameObjectsFile = clone(TEST_GAMEOBJECTS_FILE)
-
-		expect(validateGameObjects(JSON.stringify(gameObjectsFile))).toBeTruthy()
-
-		// @ts-ignore
-		gameObjectsFile.gameObjectPositions[0].position.x = false
-		// @ts-ignore
-		gameObjectsFile.gameObjectPositions[0].scale = {}
-
-		expect(validateGameObjects(JSON.stringify(gameObjectsFile))).toBeFalsy()
-	})
-})

package/app/codeCharta/util/gameObjectsParser/gameObjectsValidator.ts

@@ -1,7 +0,0 @@
-import Ajv from "ajv"
-import gameObjectsSchema from "./gameObjectsSchema.json"
-
-export function validateGameObjects(jsonContent: string) {
-	const ajv = new Ajv({ allErrors: true })
-	return ajv.validate(gameObjectsSchema, JSON.parse(jsonContent))
-}