codecharta-visualization 1.119.1 → 1.120.0

package/app/codeCharta/util/generatedSchema.json

@@ -1,265 +0,0 @@
-{
-	"$ref": "#/definitions/ExportCCFile",
-	"$schema": "http://json-schema.org/draft-07/schema#",
-	"definitions": {
-		"AttributeTypes": {
-			"properties": {
-				"edges": {
-					"additionalProperties": {
-						"enum": ["absolute", "relative"],
-						"type": "string"
-					},
-					"type": "object"
-				},
-				"nodes": {
-					"additionalProperties": {
-						"enum": ["absolute", "relative"],
-						"type": "string"
-					},
-					"type": "object"
-				}
-			},
-			"type": "object"
-		},
-		"CodeMapNode": {
-			"properties": {
-				"attributes": {
-					"$ref": "#/definitions/KeyValuePair"
-				},
-				"children": {
-					"items": {
-						"$ref": "#/definitions/CodeMapNode"
-					},
-					"type": "array"
-				},
-				"deltas": {
-					"additionalProperties": {
-						"type": "number"
-					},
-					"type": "object"
-				},
-				"edgeAttributes": {
-					"additionalProperties": {
-						"$ref": "#/definitions/EdgeMetricCount"
-					},
-					"type": "object"
-				},
-				"fixedPosition": {
-					"$ref": "#/definitions/FixedPosition"
-				},
-				"id": {
-					"type": "number"
-				},
-				"isExcluded": {
-					"type": "boolean"
-				},
-				"isFlattened": {
-					"type": "boolean"
-				},
-				"link": {
-					"type": "string"
-				},
-				"name": {
-					"type": "string"
-				},
-				"path": {
-					"type": "string"
-				},
-				"type": {
-					"$ref": "#/definitions/NodeType"
-				}
-			},
-			"required": ["name", "type"],
-			"type": "object"
-		},
-		"Edge": {
-			"properties": {
-				"attributes": {
-					"$ref": "#/definitions/KeyValuePair"
-				},
-				"fromNodeName": {
-					"type": "string"
-				},
-				"toNodeName": {
-					"type": "string"
-				},
-				"visible": {
-					"$ref": "#/definitions/EdgeVisibility"
-				}
-			},
-			"required": ["attributes", "fromNodeName", "toNodeName"],
-			"type": "object"
-		},
-		"EdgeMetricCount": {
-			"properties": {
-				"incoming": {
-					"type": "number"
-				},
-				"outgoing": {
-					"type": "number"
-				}
-			},
-			"required": ["incoming", "outgoing"],
-			"type": "object"
-		},
-		"EdgeVisibility": {
-			"enum": ["both", "from", "none", "to"],
-			"type": "string"
-		},
-		"ExportBlacklistItem": {
-			"properties": {
-				"path": {
-					"type": "string"
-				},
-				"type": {
-					"$ref": "#/definitions/ExportBlacklistType"
-				}
-			},
-			"required": ["path", "type"],
-			"type": "object"
-		},
-		"ExportBlacklistType": {
-			"enum": ["exclude", "hide"],
-			"type": "string"
-		},
-		"ExportCCFile": {
-			"properties": {
-				"apiVersion": {
-					"type": "string"
-				},
-				"attributeTypes": {
-					"anyOf": [
-						{
-							"$ref": "#/definitions/OldAttributeTypes"
-						},
-						{
-							"$ref": "#/definitions/AttributeTypes"
-						}
-					]
-				},
-				"blacklist": {
-					"items": {
-						"$ref": "#/definitions/ExportBlacklistItem"
-					},
-					"type": "array"
-				},
-				"edges": {
-					"items": {
-						"$ref": "#/definitions/Edge"
-					},
-					"type": "array"
-				},
-				"markedPackages": {
-					"items": {
-						"$ref": "#/definitions/MarkedPackage"
-					},
-					"type": "array"
-				},
-				"nodes": {
-					"items": {
-						"$ref": "#/definitions/CodeMapNode"
-					},
-					"type": "array"
-				},
-				"projectName": {
-					"type": "string"
-				}
-			},
-			"required": ["apiVersion", "nodes", "projectName"],
-			"type": "object"
-		},
-		"FixedPosition": {
-			"properties": {
-				"height": {
-					"type": "number"
-				},
-				"left": {
-					"type": "number"
-				},
-				"top": {
-					"type": "number"
-				},
-				"width": {
-					"type": "number"
-				}
-			},
-			"required": ["height", "left", "top", "width"],
-			"type": "object"
-		},
-		"KeyValuePair": {
-			"additionalProperties": {
-				"type": "number"
-			},
-			"type": "object"
-		},
-		"MarkedPackage": {
-			"properties": {
-				"color": {
-					"type": "string"
-				},
-				"path": {
-					"type": "string"
-				}
-			},
-			"required": ["color", "path"],
-			"type": "object"
-		},
-		"NodeType": {
-			"enum": ["File", "Folder"],
-			"type": "string"
-		},
-		"OldAttributeTypes": {
-			"properties": {
-				"edges": {
-					"additionalItems": {
-						"anyOf": [
-							{
-								"additionalProperties": {
-									"enum": ["absolute", "relative"],
-									"type": "string"
-								},
-								"type": "object"
-							}
-						]
-					},
-					"items": [
-						{
-							"additionalProperties": {
-								"enum": ["absolute", "relative"],
-								"type": "string"
-							},
-							"type": "object"
-						}
-					],
-					"minItems": 0,
-					"type": "array"
-				},
-				"nodes": {
-					"additionalItems": {
-						"anyOf": [
-							{
-								"additionalProperties": {
-									"enum": ["absolute", "relative"],
-									"type": "string"
-								},
-								"type": "object"
-							}
-						]
-					},
-					"items": [
-						{
-							"additionalProperties": {
-								"enum": ["absolute", "relative"],
-								"type": "string"
-							},
-							"type": "object"
-						}
-					],
-					"minItems": 0,
-					"type": "array"
-				}
-			},
-			"type": "object"
-		}
-	}
-}

package/app/codeCharta/util/globalSettingsHelper.spec.ts

@@ -1,67 +0,0 @@
-import { GlobalSettings, LayoutAlgorithm, LocalStorageGlobalSettings, SharpnessMode } from "../codeCharta.model"
-import { GLOBAL_SETTINGS } from "./dataMocks"
-import packageJson from "../../../package.json"
-import { GlobalSettingsHelper } from "./globalSettingsHelper"
-
-describe("globalSettingsHelper", () => {
-	beforeEach(() => {
-		localStorage.clear()
-	})
-
-	describe("setGlobalSettingsInLocalStorage", () => {
-		it("should set the globalSetting into the localStorage", () => {
-			GlobalSettingsHelper.setGlobalSettingsInLocalStorage(GLOBAL_SETTINGS)
-			const localStorageGlobalSettings: LocalStorageGlobalSettings = JSON.parse(
-				localStorage.getItem(GlobalSettingsHelper.GLOBALSETTINGS_LOCAL_STORAGE_ELEMENT)
-			)
-
-			expect(localStorageGlobalSettings.globalSettings.hideFlatBuildings).toBeTruthy()
-			expect(localStorageGlobalSettings.globalSettings.isWhiteBackground).toBeTruthy()
-			expect(localStorageGlobalSettings.globalSettings.resetCameraIfNewFileIsLoaded).toBeTruthy()
-			expect(localStorageGlobalSettings.globalSettings.experimentalFeaturesEnabled).toBeTruthy()
-			expect(localStorageGlobalSettings.globalSettings.layoutAlgorithm).toEqual(LayoutAlgorithm.SquarifiedTreeMap)
-			expect(localStorageGlobalSettings.globalSettings.maxTreeMapFiles).toEqual(50)
-			expect(localStorageGlobalSettings.globalSettings.sharpnessMode).toEqual(SharpnessMode.Standard)
-		})
-
-		it("should not dispatch a global setting from localStorage if the setting is currently the same", () => {
-			const mockedStore = { dispatch: jest.fn() }
-			GlobalSettingsHelper.setGlobalSettingsInLocalStorage(GLOBAL_SETTINGS)
-
-			GlobalSettingsHelper.setGlobalSettingsOfLocalStorageIfExists(mockedStore, GLOBAL_SETTINGS)
-
-			expect(mockedStore.dispatch).not.toHaveBeenCalled()
-		})
-
-		it("have the recent version of CodeCharta Visualization", () => {
-			GlobalSettingsHelper.setGlobalSettingsInLocalStorage(GLOBAL_SETTINGS)
-			const localStorageGlobalSettings: LocalStorageGlobalSettings = JSON.parse(
-				localStorage.getItem(GlobalSettingsHelper.GLOBALSETTINGS_LOCAL_STORAGE_ELEMENT)
-			)
-
-			expect(localStorageGlobalSettings.version).toEqual(packageJson.version)
-		})
-	})
-
-	describe("getGlobalSettings", () => {
-		it("should return the globalSettings from localStorage", () => {
-			GlobalSettingsHelper.setGlobalSettingsInLocalStorage(GLOBAL_SETTINGS)
-
-			const result: GlobalSettings = GlobalSettingsHelper.getGlobalSettings()
-
-			expect(result.hideFlatBuildings).toBeTruthy()
-			expect(result.isWhiteBackground).toBeTruthy()
-			expect(result.resetCameraIfNewFileIsLoaded).toBeTruthy()
-			expect(result.experimentalFeaturesEnabled).toBeTruthy()
-			expect(result.layoutAlgorithm).toEqual(LayoutAlgorithm.SquarifiedTreeMap)
-			expect(result.maxTreeMapFiles).toEqual(50)
-			expect(result.sharpnessMode).toEqual(SharpnessMode.Standard)
-		})
-
-		it("should return nothing if no globalSettings are stored in localStorage", () => {
-			const result: GlobalSettings = GlobalSettingsHelper.getGlobalSettings()
-
-			expect(result).toBeUndefined()
-		})
-	})
-})

package/app/codeCharta/util/globalSettingsHelper.ts

@@ -1,68 +0,0 @@
-import { AppSettings, GlobalSettings, LocalStorageGlobalSettings } from "../codeCharta.model"
-import { setExperimentalFeaturesEnabled } from "../state/store/appSettings/enableExperimentalFeatures/experimentalFeaturesEnabled.actions"
-import { setHideFlatBuildings } from "../state/store/appSettings/hideFlatBuildings/hideFlatBuildings.actions"
-import { setIsWhiteBackground } from "../state/store/appSettings/isWhiteBackground/isWhiteBackground.actions"
-import { setLayoutAlgorithm } from "../state/store/appSettings/layoutAlgorithm/layoutAlgorithm.actions"
-import { setSharpnessMode } from "../state/store/appSettings/sharpnessMode/sharpnessMode.actions"
-import { setMaxTreeMapFiles } from "../state/store/appSettings/maxTreeMapFiles/maxTreeMapFiles.actions"
-import { setResetCameraIfNewFileIsLoaded } from "../state/store/appSettings/resetCameraIfNewFileIsLoaded/resetCameraIfNewFileIsLoaded.actions"
-import packageJson from "../../../package.json"
-import { setScreenshotToClipboardEnabled } from "../state/store/appSettings/enableClipboard/screenshotToClipboardEnabled.actions"
-import { Store } from "@ngrx/store"
-
-export class GlobalSettingsHelper {
-	static readonly GLOBALSETTINGS_LOCAL_STORAGE_ELEMENT = "globalSettings"
-
-	static setGlobalSettingsInLocalStorage(globalSettings: Partial<GlobalSettings>) {
-		const newLocalStorageElement: LocalStorageGlobalSettings = {
-			version: packageJson.version,
-			globalSettings: { ...GlobalSettingsHelper.getGlobalSettings(), ...globalSettings }
-		}
-		localStorage.setItem(this.GLOBALSETTINGS_LOCAL_STORAGE_ELEMENT, JSON.stringify(newLocalStorageElement))
-	}
-
-	static setGlobalSettingsOfLocalStorageIfExists(store: Pick<Store, "dispatch">, appSettings: Partial<AppSettings>) {
-		if (GlobalSettingsHelper.getGlobalSettings()) {
-			const globalSettings: GlobalSettings = JSON.parse(
-				localStorage.getItem(this.GLOBALSETTINGS_LOCAL_STORAGE_ELEMENT)
-			).globalSettings
-
-			if (appSettings.hideFlatBuildings !== globalSettings.hideFlatBuildings) {
-				store.dispatch(setHideFlatBuildings({ value: globalSettings.hideFlatBuildings }))
-			}
-			if (appSettings.isWhiteBackground !== globalSettings.isWhiteBackground) {
-				store.dispatch(setIsWhiteBackground({ value: globalSettings.isWhiteBackground }))
-			}
-			if (appSettings.resetCameraIfNewFileIsLoaded !== globalSettings.resetCameraIfNewFileIsLoaded) {
-				store.dispatch(setResetCameraIfNewFileIsLoaded({ value: globalSettings.resetCameraIfNewFileIsLoaded }))
-			}
-			if (appSettings.experimentalFeaturesEnabled !== globalSettings.experimentalFeaturesEnabled) {
-				store.dispatch(setExperimentalFeaturesEnabled({ value: globalSettings.experimentalFeaturesEnabled }))
-			}
-			if (appSettings.screenshotToClipboardEnabled !== globalSettings.screenshotToClipboardEnabled) {
-				store.dispatch(setScreenshotToClipboardEnabled({ value: globalSettings.screenshotToClipboardEnabled }))
-			}
-			if (appSettings.layoutAlgorithm !== globalSettings.layoutAlgorithm) {
-				store.dispatch(setLayoutAlgorithm({ value: globalSettings.layoutAlgorithm }))
-			}
-			if (appSettings.maxTreeMapFiles !== globalSettings.maxTreeMapFiles) {
-				store.dispatch(setMaxTreeMapFiles({ value: globalSettings.maxTreeMapFiles }))
-			}
-			if (appSettings.sharpnessMode !== globalSettings.sharpnessMode) {
-				store.dispatch(setSharpnessMode({ value: globalSettings.sharpnessMode }))
-			}
-		}
-	}
-
-	static getGlobalSettings() {
-		let ccLocalStorage: LocalStorageGlobalSettings
-		try {
-			ccLocalStorage = JSON.parse(localStorage.getItem(this.GLOBALSETTINGS_LOCAL_STORAGE_ELEMENT))
-		} catch {
-			ccLocalStorage = null
-		}
-		if (ccLocalStorage) {
-			return ccLocalStorage.globalSettings
-		}
-	}
-}

package/app/codeCharta/util/loadFilesValidationToErrorDialog.ts

@@ -1,37 +0,0 @@
-import { CCFileValidationResult } from "./fileValidator"
-
-export function loadFilesValidationToErrorDialog(fileValidationResults: CCFileValidationResult[]) {
-	const htmlMessages = [...buildErrorMessages(fileValidationResults), ...buildWarningsMessages(fileValidationResults)]
-	return {
-		title: "Something is wrong with the uploaded file(s)",
-		message: htmlMessages.join("")
-	}
-}
-
-function buildErrorMessages(fileValidationResults: CCFileValidationResult[]) {
-	const filesWithErrors = fileValidationResults.filter(validationResult => validationResult.errors.length > 0)
-	return filesWithErrors.length > 0
-		? ["<h2>Errors</h2>", ...filesWithErrors.map(fileWithErrors => buildFileErrorMessage(fileWithErrors))]
-		: []
-}
-
-function buildWarningsMessages(fileValidationResults: CCFileValidationResult[]) {
-	const filesWithWarnings = fileValidationResults.filter(validationResult => validationResult.warnings.length > 0)
-	return filesWithWarnings.length > 0
-		? ["<h2>Warnings</h2>", ...filesWithWarnings.map(fileWithWarnings => buildFileWarningMessage(fileWithWarnings))]
-		: []
-}
-
-function buildFileErrorMessage(fileValidationResult: CCFileValidationResult) {
-	const errorSymbol = '<i class="fa fa-exclamation-circle"></i> '
-	return `<p><strong>${fileValidationResult.fileName}:</strong> ${buildHtmlMessage(errorSymbol, fileValidationResult.errors)}</p>`
-}
-
-function buildFileWarningMessage(fileValidationResult: CCFileValidationResult) {
-	const warningSymbol = '<i class="fa fa-exclamation-triangle"></i> '
-	return `<p><strong>${fileValidationResult.fileName}:</strong> ${buildHtmlMessage(warningSymbol, fileValidationResult.warnings)}</p>`
-}
-
-function buildHtmlMessage(symbol: string, validationResult: string[]) {
-	return `<p>${validationResult.map(message => symbol + message).join("<br>")}</p>`
-}

package/app/codeCharta/util/metric/metricTitles.ts

@@ -1,19 +0,0 @@
-/*
-This file contains the fallback titles of the metrics
-*/
-
-export const metricTitles: Map<string, string> = new Map([
-	["loc", "Lines of Code"],
-	["rloc", "Real Lines of Code"],
-	["comment_lines", "Number of Code Lines with Comments"],
-	["mcc", "Cyclomatic Complexity"],
-	["avgCommits", "Average Number of Commits from this file"],
-	["functions", "Number of Functions"],
-	["pairingRate", "Pairing Rate of selected building"],
-	["unary", "-"],
-	["line_coverage", "Number of Code Lines covered by tests"],
-	["sonar_code_smells", "Number of Smells Sonar has identified"],
-	["avg_code_churn", "Average Number of Lines added or removed from this file"],
-	["number_of_authors", "Number of Authors that have edited this file"],
-	["statements", "Number of Statements"]
-])

package/app/codeCharta/util/mockHelper.ts

@@ -1,8 +0,0 @@
-import { FileState } from "../model/files/files"
-import { CCFile, CodeMapNode, NodeType } from "../codeCharta.model"
-
-export function createFileStateWithNodes(children: CodeMapNode[]) {
-	const map: CodeMapNode = { name: "root", type: NodeType.FOLDER, children }
-	const file: CCFile = { fileMeta: undefined, map, settings: { fileSettings: undefined } }
-	return { file, selectedAs: undefined } as FileState
-}