Feature/1066/display tooltip description in frontend

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/)
 
 ### Chore 👨‍💻 👩‍💻
 
+-   Metric titles in the legend are read from cc.json now [#3162](https://github.com/MaibornWolff/codecharta/pull/3162)
 -   Add attribute descriptors to SoureCodeParser [#3166](https://github.com/MaibornWolff/codecharta/pull/3166)
 
 ## [1.112.1] - 2022-12-01

visualization/app/codeCharta/codeCharta.api.model.ts

@@ -1,12 +1,22 @@
 import { Vector3 } from "three"
-import { AttributeTypes, AttributeTypeValue, CodeMapNode, Edge, MarkedPackage, RecursivePartial, Settings } from "./codeCharta.model"
+import {
+	AttributeDescriptors,
+	AttributeTypes,
+	AttributeTypeValue,
+	CodeMapNode,
+	Edge,
+	MarkedPackage,
+	RecursivePartial,
+	Settings
+} from "./codeCharta.model"
 
 export interface ExportCCFile {
 	projectName: string
 	apiVersion: string
 	fileChecksum: string
 	nodes: CodeMapNode[]
 	attributeTypes?: AttributeTypes | OldAttributeTypes
+	attributeDescriptors?: AttributeDescriptors
 	edges?: Edge[]
 	markedPackages?: MarkedPackage[]
 	blacklist?: ExportBlacklistItem[]

visualization/app/codeCharta/codeCharta.model.ts

@@ -108,6 +108,7 @@ export interface Settings {
 
 export interface FileSettings {
 	attributeTypes: AttributeTypes
+	attributeDescriptors: AttributeDescriptors
 	blacklist: Array<BlacklistItem>
 	edges: Edge[]
 	markedPackages: MarkedPackage[]
@@ -186,6 +187,18 @@ export interface AttributeTypes {
 	edges?: { [key: string]: AttributeTypeValue }
 }
 
+export interface AttributeDescriptors {
+	[key: string]: AttributeDescriptor
+}
+
+export interface AttributeDescriptor {
+	title: string
+	description: string
+	hintLowValue: string
+	hintHighValue: string
+	link: string
+}
+
 export enum AttributeTypeValue {
 	absolute = "absolute",
 	relative = "relative"

visualization/app/codeCharta/services/loadFile/loadFile.service.spec.ts

@@ -117,6 +117,7 @@ describe("loadFileService", () => {
 			settings: {
 				fileSettings: {
 					attributeTypes: { nodes: {}, edges: {} },
+					attributeDescriptors: {},
 					blacklist: [],
 					edges: [],
 					markedPackages: []

visualization/app/codeCharta/state/effects/updateFileSettings/updateFileSettings.effect.spec.ts

@@ -43,7 +43,8 @@ describe("UpdateFileSettingsEffect", () => {
 					edges: [],
 					markedPackages: [],
 					blacklist: [],
-					attributeTypes: {}
+					attributeTypes: {},
+					attributeDescriptors: {}
 				}
 			})
 		)

visualization/app/codeCharta/state/effects/updateFileSettings/updateFileSettings.effect.ts

@@ -1,4 +1,4 @@
-import { Injectable, Inject } from "@angular/core"
+import { Inject, Injectable } from "@angular/core"
 import { filter, map } from "rxjs"
 import { getVisibleFiles, isPartialState } from "../../../model/files/files.helper"
 import { isActionOfType } from "../../../util/reduxHelper"
@@ -12,6 +12,7 @@ import { getMergedAttributeTypes } from "./utils/attributeTypes.merger"
 import { getMergedBlacklist } from "./utils/blacklist.merger"
 import { getMergedEdges } from "./utils/edges.merger"
 import { getMergedMarkedPackages } from "./utils/markedPackages.merger"
+import { getMergedAttributeDescriptors } from "./utils/attributeDescriptors.merger"
 
 @Injectable()
 export class UpdateFileSettingsEffect {
@@ -25,12 +26,16 @@ export class UpdateFileSettingsEffect {
 				const visibleFiles = getVisibleFiles(state.files)
 				const withUpdatedPath = isPartialState(state.files)
 				const allAttributeTypes = visibleFileStatesSelector(state).map(({ file }) => file.settings.fileSettings.attributeTypes)
+				const allAttributeDescriptors = visibleFileStatesSelector(state).map(
+					({ file }) => file.settings.fileSettings.attributeDescriptors
+				)
 				return setState({
 					fileSettings: {
 						edges: getMergedEdges(visibleFiles, withUpdatedPath),
 						markedPackages: getMergedMarkedPackages(visibleFiles, withUpdatedPath),
 						blacklist: getMergedBlacklist(visibleFiles, withUpdatedPath),
-						attributeTypes: getMergedAttributeTypes(allAttributeTypes)
+						attributeTypes: getMergedAttributeTypes(allAttributeTypes),
+						attributeDescriptors: getMergedAttributeDescriptors(allAttributeDescriptors)
 					}
 				})
 			})

visualization/app/codeCharta/state/effects/updateFileSettings/utils/attributeDescriptors.merger.spec.ts

@@ -0,0 +1,70 @@
+import { AttributeDescriptors } from "../../../../codeCharta.model"
+import { getMergedAttributeDescriptors } from "./attributeDescriptors.merger"
+
+describe("AttributeDescriptorsMerger", () => {
+	describe("getMergedAttributeDescriptors", () => {
+		let attributes1: AttributeDescriptors
+		let attributes2: AttributeDescriptors
+		let attributes3: AttributeDescriptors
+
+		beforeEach(() => {
+			attributes1 = {}
+
+			attributes2 = {
+				rloc: {
+					title: "rloc2",
+					description: "",
+					hintLowValue: "",
+					hintHighValue: "",
+					link: "https://www.npmjs.com/package/metric-gardener"
+				}
+			}
+
+			attributes3 = {
+				rloc: {
+					title: "rloc3",
+					description: "DescriptionRloc3",
+					hintLowValue: "",
+					hintHighValue: "",
+					link: "https://www.npmjs.com/package/metric-gardener"
+				},
+				comment_lines: {
+					title: "Comment Lines",
+					description: "Number of lines containing either comment or commented-out code",
+					hintLowValue: "",
+					hintHighValue: "",
+					link: "https://www.npmjs.com/package/metric-gardener"
+				}
+			}
+		})
+
+		it("should merge attributeDescriptors if one file does not contain any attributeDescriptors", () => {
+			const attributeDescriptors = getMergedAttributeDescriptors([attributes1, attributes2])
+
+			expect(attributeDescriptors).toEqual(attributes2)
+		})
+
+		it("should merge attributeDescriptors. If they share the same key, simply take the first attributeDescriptor", () => {
+			const attributeDescriptors = getMergedAttributeDescriptors([attributes2, attributes3])
+
+			const expected = {
+				rloc: {
+					title: "rloc2",
+					description: "",
+					hintLowValue: "",
+					hintHighValue: "",
+					link: "https://www.npmjs.com/package/metric-gardener"
+				},
+				comment_lines: {
+					title: "Comment Lines",
+					description: "Number of lines containing either comment or commented-out code",
+					hintLowValue: "",
+					hintHighValue: "",
+					link: "https://www.npmjs.com/package/metric-gardener"
+				}
+			}
+
+			expect(attributeDescriptors).toEqual(expected)
+		})
+	})
+})

visualization/app/codeCharta/state/effects/updateFileSettings/utils/attributeDescriptors.merger.ts

@@ -0,0 +1,15 @@
+import { AttributeDescriptors } from "../../../../codeCharta.model"
+
+export function getMergedAttributeDescriptors(allAttributeDescriptors: AttributeDescriptors[]): AttributeDescriptors {
+	const uniqueAttributeDescriptors = {}
+
+	for (const attributeDescriptors of allAttributeDescriptors) {
+		for (const attributeDescriptorKey of Object.keys(attributeDescriptors)) {
+			if (!uniqueAttributeDescriptors[attributeDescriptorKey]) {
+				uniqueAttributeDescriptors[attributeDescriptorKey] = attributeDescriptors[attributeDescriptorKey]
+			}
+		}
+	}
+
+	return uniqueAttributeDescriptors
+}

visualization/app/codeCharta/state/store/fileSettings/attributeDescriptors/attributeDescriptors.action.ts

@@ -0,0 +1,23 @@
+import { AttributeDescriptors, CCAction } from "../../../../codeCharta.model"
+
+export enum AttributeDescriptorsActions {
+	SET_ATTRIBUTE_DESCRIPTORS = "SET_ATTRIBUTE_DESCRIPTORS"
+}
+
+export interface SetAttributeDescriptorsAction extends CCAction {
+	type: AttributeDescriptorsActions.SET_ATTRIBUTE_DESCRIPTORS
+	payload: AttributeDescriptors
+}
+
+export type AttributeDescriptorsAction = SetAttributeDescriptorsAction
+
+export function setAttributeDescriptors(
+	attributeDescriptors: AttributeDescriptors = defaultAttributeDescriptors
+): SetAttributeDescriptorsAction {
+	return {
+		type: AttributeDescriptorsActions.SET_ATTRIBUTE_DESCRIPTORS,
+		payload: attributeDescriptors
+	}
+}
+
+export const defaultAttributeDescriptors: AttributeDescriptors = {}

visualization/app/codeCharta/state/store/fileSettings/attributeDescriptors/attributeDescriptors.reducer.spec.ts

@@ -0,0 +1,30 @@
+import { attributeDescriptors } from "./attributeDescriptors.reducer"
+import { STATE } from "../../../../util/dataMocks"
+import { AttributeDescriptors } from "../../../../codeCharta.model"
+import { AttributeDescriptorsAction, setAttributeDescriptors } from "./attributeDescriptors.action"
+
+describe("attributeDescriptors", () => {
+	const defaultValue: AttributeDescriptors = {}
+
+	describe("Default State", () => {
+		it("should initialize the default state", () => {
+			const result = attributeDescriptors(undefined, {} as AttributeDescriptorsAction)
+
+			expect(result).toEqual(defaultValue)
+		})
+	})
+
+	describe("Action: SET_ATTRIBUTE_DESCRIPTORS", () => {
+		it("should set new attributeDescriptors", () => {
+			const result = attributeDescriptors(defaultValue, setAttributeDescriptors(STATE.fileSettings.attributeDescriptors))
+
+			expect(result).toEqual(STATE.fileSettings.attributeDescriptors)
+		})
+
+		it("should set default attributeDescriptors", () => {
+			const result = attributeDescriptors(STATE.fileSettings.attributeDescriptors, setAttributeDescriptors())
+
+			expect(result).toEqual(defaultValue)
+		})
+	})
+})

visualization/app/codeCharta/state/store/fileSettings/attributeDescriptors/attributeDescriptors.reducer.ts

@@ -0,0 +1,8 @@
+import { AttributeDescriptorsAction, AttributeDescriptorsActions, setAttributeDescriptors } from "./attributeDescriptors.action"
+
+export function attributeDescriptors(state = setAttributeDescriptors().payload, action: AttributeDescriptorsAction) {
+	if (action.type === AttributeDescriptorsActions.SET_ATTRIBUTE_DESCRIPTORS) {
+		return action.payload
+	}
+	return state
+}

visualization/app/codeCharta/state/store/fileSettings/attributeDescriptors/attributesDescriptors.selector.ts

@@ -0,0 +1,3 @@
+import { CcState } from "../../store"
+
+export const attributeDescriptorsSelector = (state: CcState) => state.fileSettings.attributeDescriptors

visualization/app/codeCharta/state/store/fileSettings/fileSettings.actions.ts

@@ -1,6 +1,7 @@
 import { CCAction, FileSettings, RecursivePartial } from "../../../codeCharta.model"
 
 import { defaultAttributeTypes } from "./attributeTypes/attributeTypes.actions"
+import { defaultAttributeDescriptors } from "./attributeDescriptors/attributeDescriptors.action"
 import { defaultBlacklist } from "./blacklist/blacklist.actions"
 import { defaultEdges } from "./edges/edges.actions"
 import { defaultMarkedPackages } from "./markedPackages/markedPackages.actions"
@@ -25,6 +26,7 @@ export function setFileSettings(fileSettings: RecursivePartial<FileSettings> = d
 
 export const defaultFileSettings: FileSettings = {
 	attributeTypes: defaultAttributeTypes,
+	attributeDescriptors: defaultAttributeDescriptors,
 	blacklist: defaultBlacklist,
 	edges: defaultEdges,
 	markedPackages: defaultMarkedPackages

visualization/app/codeCharta/state/store/fileSettings/fileSettings.reducer.ts

@@ -3,11 +3,13 @@ import { edges } from "./edges/edges.reducer"
 import { attributeTypes } from "./attributeTypes/attributeTypes.reducer"
 import { blacklist } from "./blacklist/blacklist.reducer"
 import { combineReducers } from "redux"
+import { attributeDescriptors } from "./attributeDescriptors/attributeDescriptors.reducer"
 
 const fileSettings = combineReducers({
 	markedPackages,
 	edges,
 	attributeTypes,
+	attributeDescriptors,
 	blacklist
 })
 

visualization/app/codeCharta/state/store/state.reducer.ts

@@ -34,6 +34,7 @@ function isSetStateAction(action: Action): action is SetStateAction {
 
 const objectWithDynamicKeysInStore = new Set([
 	"fileSettings.attributeTypes",
+	"fileSettings.attributeDescriptors",
 	"fileSettings.blacklist",
 	"fileSettings.edges",
 	"fileSettings.markedPackages",

visualization/app/codeCharta/ui/labelledColorPicker/labelledColorPicker.component.html

@@ -17,7 +17,7 @@
 			</span>
 		</div>
 		<div class="cc-labelled-color-picker-label">
-			<span *ngFor="let label of labels" [title]="label"> {{ label }} <br *ngIf="!last" /></span>
+			<span *ngFor="let label of labels"> {{ label }} <br *ngIf="!last" /></span>
 		</div>
 	</div>
 </ng-template>

visualization/app/codeCharta/ui/legendPanel/legendBlock/legendBlock.component.html

@@ -1,7 +1,20 @@
-<div *ngIf="legendMetric.description" class="legend-block">
-	{{ metricFor }} metric (<span class="bold">{{ legendMetric.metricName }}</span
-	>: {{ legendMetric.description }})
-</div>
-<div *ngIf="!legendMetric.description" class="legend-block">
-	{{ metricFor }} metric: <span class="bold">{{ legendMetric.metricName }}</span>
-</div>
+<ng-container *ngIf="legendMetric.title; then titleExists; else onlyShowName" class="legend-block"></ng-container>
+<ng-template #titleExists>
+	<ng-container *ngIf="legendMetric.description; then showTitleAndDescription; else showTitle"></ng-container>
+</ng-template>
+
+<ng-template #showTitleAndDescription>
+	<div title="{{ legendMetric.key + ': ' + legendMetric.description }}">
+		{{ metricFor }} metric: <span class="bold">{{ legendMetric.title }}</span> ({{ legendMetric.key }})
+	</div>
+</ng-template>
+<ng-template #showTitle>
+	<div title="{{ legendMetric.key }}">
+		{{ metricFor }} metric: <span class="bold">{{ legendMetric.title }}</span> ({{ legendMetric.key }})
+	</div>
+</ng-template>
+<ng-template #onlyShowName>
+	<div title="{{ legendMetric.key }}">
+		{{ metricFor }} metric: <span class="bold">{{ legendMetric.key }}</span>
+	</div>
+</ng-template>

visualization/app/codeCharta/ui/legendPanel/legendPanel.component.html

@@ -1,9 +1,8 @@
 <div class="block-wrapper" [class.visible]="isLegendVisible" [class.isAttributeSideBarVisible]="isAttributeSideBarVisibleService.isOpen">
 	<div *ngIf="!(isDeltaState$ | async)">
-		<cc-legend-block [metricFor]="'Size'" [legendMetric]="areaMetric$ | async"></cc-legend-block>
+		<cc-legend-block [metricFor]="'Area'" [legendMetric]="areaMetric$ | async"></cc-legend-block>
 		<cc-legend-block [metricFor]="'Height'" [legendMetric]="heightMetric$ | async"></cc-legend-block>
 		<cc-legend-block *ngIf="edgeMetric$ | async; let edgeMetric" [metricFor]="'Edge'" [legendMetric]="edgeMetric"></cc-legend-block>
-
 		<hr />
 		<cc-legend-block [metricFor]="'Color'" [legendMetric]="colorMetric$ | async"></cc-legend-block>
 		<cc-color-picker-for-map-color [mapColorFor]="'positive'"></cc-color-picker-for-map-color>

visualization/app/codeCharta/ui/legendPanel/legendPanel.component.spec.ts

@@ -53,9 +53,9 @@ describe("LegendPanelController", () => {
 		expect(areDeltaEntriesShown).toBe(false)
 
 		const metricDescriptions = container.querySelectorAll("cc-legend-block")
-		expect(metricDescriptions[0].textContent).toMatch("Size metric (loc: lines of code)")
-		expect(metricDescriptions[1].textContent).toMatch("Height metric (mcc: cyclomatic complexity)")
-		expect(metricDescriptions[2].textContent).toMatch("Color metric (rloc: real lines of code)")
+		expect(metricDescriptions[0].textContent).toMatch("Area metric: Lines of Code (loc)")
+		expect(metricDescriptions[1].textContent).toMatch("Height metric: Cyclomatic Complexity (mcc)")
+		expect(metricDescriptions[2].textContent).toMatch("Color metric: Real Lines of Code (rloc)")
 	})
 
 	it("should display legend for delta mode", async () => {

visualization/app/codeCharta/ui/legendPanel/selectors/legendAreaMetric.selector.ts

@@ -1,10 +1,10 @@
 import { createSelector } from "../../../state/angular-redux/createSelector"
 import { areaMetricSelector } from "../../../state/store/dynamicSettings/areaMetric/areaMetric.selector"
+import { attributeDescriptorsSelector } from "../../../state/store/fileSettings/attributeDescriptors/attributesDescriptors.selector"
 import { CcState } from "../../../state/store/store"
-import { metricDescriptions } from "../../../util/metric/metricDescriptions"
-import { LegendMetric } from "./legendMetric"
+import { getLegendMetric, LegendMetric } from "./legendMetric"
 
-export const legendAreaMetricSelector: (state: CcState) => LegendMetric = createSelector([areaMetricSelector], areaMetric => ({
-	metricName: areaMetric,
-	description: metricDescriptions.get(areaMetric)
-}))
+export const legendAreaMetricSelector: (state: CcState) => LegendMetric = createSelector(
+	[areaMetricSelector, attributeDescriptorsSelector],
+	(areaMetric, attributeDescriptors) => getLegendMetric(areaMetric, attributeDescriptors)
+)

visualization/app/codeCharta/ui/legendPanel/selectors/legendColorMetric.selector.ts

@@ -1,10 +1,10 @@
 import { createSelector } from "../../../state/angular-redux/createSelector"
 import { colorMetricSelector } from "../../../state/store/dynamicSettings/colorMetric/colorMetric.selector"
 import { CcState } from "../../../state/store/store"
-import { metricDescriptions } from "../../../util/metric/metricDescriptions"
-import { LegendMetric } from "./legendMetric"
+import { getLegendMetric, LegendMetric } from "./legendMetric"
+import { attributeDescriptorsSelector } from "../../../state/store/fileSettings/attributeDescriptors/attributesDescriptors.selector"
 
-export const legendColorMetricSelector: (state: CcState) => LegendMetric = createSelector([colorMetricSelector], colorMetric => ({
-	metricName: colorMetric,
-	description: metricDescriptions.get(colorMetric)
-}))
+export const legendColorMetricSelector: (state: CcState) => LegendMetric = createSelector(
+	[colorMetricSelector, attributeDescriptorsSelector],
+	(colorMetric, attributeDescriptors) => getLegendMetric(colorMetric, attributeDescriptors)
+)