Feature/fixed folders validation

analysis/tools/ValidationTool/src/main/resources/cc.json

@@ -44,6 +44,9 @@
 					},
 					"type": "object"
 				},
+				"fixedPosition": {
+					"$ref": "#/definitions/FixedPosition"
+				},
 				"id": {
 					"type": "number"
 				},
@@ -165,6 +168,24 @@
 			"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"
@@ -210,7 +231,7 @@
 							"type": "object"
 						}
 					],
-					"minItems": 1,
+					"minItems": 0,
 					"type": "array"
 				},
 				"nodes": {
@@ -234,7 +255,7 @@
 							"type": "object"
 						}
 					],
-					"minItems": 1,
+					"minItems": 0,
 					"type": "array"
 				}
 			},

visualization/.eslintrc.js

@@ -40,6 +40,7 @@ module.exports = {
         "@typescript-eslint/no-unused-vars": ["error"],
         "object-shorthand": ["error", "always"],
         "no-else-return": ["error"],
+        "no-lonely-if": ["error"],
 
         // Do not apply inappropriate rules below
         "@typescript-eslint/no-use-before-define":

visualization/API.md

@@ -0,0 +1,32 @@
+# API-Changelog
+
+## 1.1
+
+-   An additional optional property `edges` has been added to the `cc.json`
+-   Defines an array of edges between buildings
+-   Use SCMLogParser to generate edges
+
+```ts
+export interface Edge {
+	fromNodeName: string
+	toNodeName: string
+	attributes: KeyValuePair
+}
+```
+
+## 1.2
+
+-   An additional optional property `fixed` has been added to the `cc.json`
+-   Property can be set to direct children of the root-folder
+-   Define `x` and `y` as the top-left corner of the folder
+-   Define `width` and `height` for the length in x and y-direction
+-   Folders can't overlap and must be defined in range of `[0-100]`
+
+```ts
+export interface Fixed {
+	x: number
+	y: number
+	width: number
+	height: number
+}
+```

visualization/app/codeCharta/assets/sample1.cc.json

@@ -1,6 +1,6 @@
 {
 	"projectName": "Sample Project with Edges",
-	"apiVersion": "1.1",
+	"apiVersion": "1.2",
 	"nodes": [
 		{
 			"name": "root",

visualization/app/codeCharta/assets/sample2.cc.json

@@ -1,6 +1,6 @@
 {
 	"projectName": "Sample Project",
-	"apiVersion": "1.1",
+	"apiVersion": "1.2",
 	"nodes": [
 		{
 			"name": "root",

visualization/app/codeCharta/assets/sample3.cc.json

@@ -1,6 +1,6 @@
 {
 	"projectName": "Sample Project",
-	"apiVersion": "1.1",
+	"apiVersion": "1.2",
 	"nodes": [
 		{
 			"name": "root",

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

@@ -23,7 +23,8 @@ export enum ExportBlacklistType {
 export enum APIVersions {
 	ZERO_POINT_ONE = "0.1",
 	ONE_POINT_ZERO = "1.0",
-	ONE_POINT_ONE = "1.1"
+	ONE_POINT_ONE = "1.1",
+	ONE_POINT_TWO = "1.2"
 }
 
 export interface ExportScenario {

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

@@ -10,6 +10,7 @@ import { getCCFiles, isSingleState } from "./model/files/files.helper"
 import { DialogService } from "./ui/dialog/dialog.service"
 import { CCValidationResult, ERROR_MESSAGES } from "./util/fileValidator"
 import { setNodeMetricData } from "./state/store/metricData/nodeMetricData/nodeMetricData.actions"
+import packageJson from "../../package.json"
 import { clone } from "./util/clone"
 
 describe("codeChartaService", () => {
@@ -52,7 +53,7 @@ describe("codeChartaService", () => {
 
 	describe("loadFiles", () => {
 		const expected: CCFile = {
-			fileMeta: { apiVersion: "1.1", fileName, projectName: "Sample Map" },
+			fileMeta: { apiVersion: packageJson.codecharta.apiVersion, fileName, projectName: "Sample Map" },
 			map: {
 				attributes: {},
 				isExcluded: false,
@@ -169,8 +170,7 @@ describe("codeChartaService", () => {
 
 		it("should show error on invalid file", () => {
 			const expectedError: CCValidationResult = {
-				title: ERROR_MESSAGES.fileIsInvalid.title,
-				error: [ERROR_MESSAGES.fileIsInvalid.message],
+				error: [ERROR_MESSAGES.fileIsInvalid],
 				warning: []
 			}
 
@@ -182,8 +182,7 @@ describe("codeChartaService", () => {
 
 		it("should show error on a random string", () => {
 			const expectedError: CCValidationResult = {
-				title: ERROR_MESSAGES.apiVersionIsInvalid.title,
-				error: [ERROR_MESSAGES.apiVersionIsInvalid.message],
+				error: [ERROR_MESSAGES.apiVersionIsInvalid],
 				warning: []
 			}
 
@@ -195,7 +194,6 @@ describe("codeChartaService", () => {
 
 		it("should show error if a file is missing a required property", () => {
 			const expectedError: CCValidationResult = {
-				title: ERROR_MESSAGES.validationError.title,
 				error: ["Required error:  should have required property 'projectName'"],
 				warning: []
 			}
@@ -224,7 +222,6 @@ describe("codeChartaService", () => {
 
 		it("should break the loop after the first invalid file was validated", () => {
 			const expectedError: CCValidationResult = {
-				title: ERROR_MESSAGES.validationError.title,
 				error: ["Required error:  should have required property 'projectName'"],
 				warning: []
 			}

visualization/app/codeCharta/ressources/fixed-folders/fixed-folders-example.ts

@@ -82,15 +82,15 @@ export const fileWithFixedFolders: ExportCCFile = {
 					attributes: {},
 					children: [
 						{
-							name: "children_5",
+							name: "children_6",
 							type: NodeType.FILE,
 							attributes: {
 								custom_metric: 4
 							},
 							children: []
 						},
 						{
-							name: "children_6",
+							name: "children_7",
 							type: NodeType.FILE,
 							attributes: {
 								custom_metric: 0
@@ -111,15 +111,15 @@ export const fileWithFixedFolders: ExportCCFile = {
 					attributes: {},
 					children: [
 						{
-							name: "children_7",
+							name: "children_8",
 							type: NodeType.FILE,
 							attributes: {
 								custom_metric: 20
 							},
 							children: []
 						},
 						{
-							name: "children_8",
+							name: "children_9",
 							type: NodeType.FILE,
 							attributes: {
 								custom_metric: 5
@@ -140,15 +140,15 @@ export const fileWithFixedFolders: ExportCCFile = {
 					attributes: {},
 					children: [
 						{
-							name: "children_9",
+							name: "children_10",
 							type: NodeType.FILE,
 							attributes: {
 								custom_metric: 10
 							},
 							children: []
 						},
 						{
-							name: "children_10",
+							name: "children_11",
 							type: NodeType.FILE,
 							attributes: {
 								custom_metric: 0
@@ -169,15 +169,15 @@ export const fileWithFixedFolders: ExportCCFile = {
 					attributes: {},
 					children: [
 						{
-							name: "children_11",
+							name: "children_12",
 							type: NodeType.FILE,
 							attributes: {
 								custom_metric: 1
 							},
 							children: []
 						},
 						{
-							name: "children_12",
+							name: "children_13",
 							type: NodeType.FILE,
 							attributes: {
 								custom_metric: 1

visualization/app/codeCharta/ressources/sample1_with_different_edges.cc.json

@@ -1,6 +1,6 @@
 {
 	"projectName": "Sample Project with different edges",
-	"apiVersion": "1.1",
+	"apiVersion": "1.2",
 	"nodes": [
 		{
 			"name": "root",

visualization/app/codeCharta/ressources/sample1_with_lower_minor_api.cc.json

@@ -0,0 +1,96 @@
+{
+	"projectName": "Sample Project with Edges",
+	"apiVersion": "1.1",
+	"nodes": [
+		{
+			"name": "root",
+			"type": "Folder",
+			"attributes": {},
+			"children": [
+				{
+					"name": "sample1OnlyLeaf.scss",
+					"type": "File",
+					"attributes": {
+						"rloc": 400,
+						"functions": 10,
+						"mcc": 100,
+						"pairingRate": 32,
+						"avgCommits": 17
+					},
+					"link": "http://www.google.de"
+				},
+				{
+					"name": "bigLeaf.ts",
+					"type": "File",
+					"attributes": {
+						"rloc": 100,
+						"functions": 10,
+						"mcc": 1,
+						"pairingRate": 77,
+						"avgCommits": 56
+					},
+					"link": "http://www.google.de"
+				},
+				{
+					"name": "ParentLeaf",
+					"type": "Folder",
+					"attributes": {},
+					"children": [
+						{
+							"name": "smallLeaf.html",
+							"type": "File",
+							"attributes": {
+								"rloc": 30,
+								"functions": 100,
+								"mcc": 100,
+								"pairingRate": 60,
+								"avgCommits": 51
+							}
+						},
+						{
+							"name": "otherSmallLeaf.ts",
+							"type": "File",
+							"attributes": {
+								"rloc": 70,
+								"functions": 1000,
+								"mcc": 10,
+								"pairingRate": 65,
+								"avgCommits": 22
+							}
+						}
+					]
+				}
+			]
+		}
+	],
+	"edges": [
+		{
+			"fromNodeName": "/root/bigLeaf.ts",
+			"toNodeName": "/root/ParentLeaf/smallLeaf.html",
+			"attributes": {
+				"pairingRate": 89,
+				"avgCommits": 34
+			}
+		},
+		{
+			"fromNodeName": "/root/sample1OnlyLeaf.scss",
+			"toNodeName": "/root/ParentLeaf/smallLeaf.html",
+			"attributes": {
+				"pairingRate": 32,
+				"avgCommits": 17
+			}
+		},
+		{
+			"fromNodeName": "/root/ParentLeaf/otherSmallLeaf.ts",
+			"toNodeName": "/root/bigLeaf.ts",
+			"attributes": {
+				"pairingRate": 65,
+				"avgCommits": 22
+			}
+		}
+	],
+	"attributeTypes": {
+		"nodes": { "rloc": "absolute", "functions": "absolute", "mcc": "absolute", "pairingRate": "relative" },
+		"edges": { "pairingRate": "relative", "avgCommits": "absolute" }
+	}
+}

visualization/app/codeCharta/ui/dialog/dialog.service.ts

@@ -38,15 +38,15 @@ export class DialogService {
 
 		const htmlMessage = this.buildHtmlMessage(warningSymbol, validationResult.warning)
 
-		this.showErrorDialog(htmlMessage, validationResult.title)
+		this.showErrorDialog(htmlMessage, "Validation Warning")
 	}
 
 	public showValidationErrorDialog(validationResult: CCValidationResult) {
 		const errorSymbol = '<i class="fa fa-exclamation-circle"></i> '
 
 		const htmlMessage = this.buildHtmlMessage(errorSymbol, validationResult.error)
 
-		this.showErrorDialogAndOpenFileChooser(htmlMessage, validationResult.title)
+		this.showErrorDialogAndOpenFileChooser(htmlMessage, "Validation Error")
 	}
 
 	private buildHtmlMessage(symbol: string, validationResult: string[]): string {