From ac315e8a55d82b9422a3e3a0d37671cc8bd071e3 Mon Sep 17 00:00:00 2001
From: Andrej730 <azhilenkov@gmail.com>
Date: Mon, 13 Jan 2025 17:48:50 +0500
Subject: [PATCH] ifcfm cobie 2.4 - color code excel tabs

example - https://i.imgur.com/tSeqyjj.png
---
 src/ifcfm/ifcfm/__init__.py |  8 ++++++--
 src/ifcfm/ifcfm/cobie24.py  | 16 ++++++++++++++++
 2 files changed, 22 insertions(+), 2 deletions(-)

diff --git a/src/ifcfm/ifcfm/__init__.py b/src/ifcfm/ifcfm/__init__.py
index 10741bb798..f7e45d403a 100644
--- a/src/ifcfm/ifcfm/__init__.py
+++ b/src/ifcfm/ifcfm/__init__.py
@@ -271,19 +271,23 @@ class Writer:
     def write_xlsx(self, output: str) -> None:
         workbook = Workbook()
 
-        cell_formats = {}
+        cell_formats: dict[str, PatternFill] = {}
         for key, value in self.config.get("colours", {}).items():
             fill = PatternFill(start_color=value, end_color=value, fill_type="solid")
             cell_formats[key] = fill
 
         for category, data in self.categories.items():
-            colours = self.config.get("categories", {}).get(category, {}).get("colours", [])
+            category_data = self.config.get("categories", {}).get(category, {})
+            colours = category_data.get("colours", ())
 
             if category in workbook.sheetnames:
                 worksheet = workbook[category]
             else:
                 worksheet = workbook.create_sheet(category)
 
+            if category_colour := category_data.get("colour", None):
+                worksheet.sheet_properties.tabColor = cell_formats[category_colour].start_color.rgb
+
             r = 1  # Openpyxl uses 1-based indexing
             c = 1
             for header in data["headers"]:
diff --git a/src/ifcfm/ifcfm/cobie24.py b/src/ifcfm/ifcfm/cobie24.py
index 1d5451de3b..25166191e4 100644
--- a/src/ifcfm/ifcfm/cobie24.py
+++ b/src/ifcfm/ifcfm/cobie24.py
@@ -1141,6 +1141,7 @@ config = {
     "bool_false": "No",
     "categories": {
         "Contact": {
+            "colour": "r",
             "keys": ["Email"],
             "headers": [
                 "Email",
@@ -1169,6 +1170,7 @@ config = {
             "get_element_data": get_contact_data,
         },
         "Facility": {
+            "colour": "r",
             "keys": ["Name"],
             "headers": [
                 "Name",
@@ -1200,6 +1202,7 @@ config = {
             "get_element_data": get_facility_data,
         },
         "Floor": {
+            "colour": "r",
             "keys": ["Name"],
             "headers": [
                 "Name",
@@ -1219,6 +1222,7 @@ config = {
             "get_element_data": get_floor_data,
         },
         "Space": {
+            "colour": "r",
             "keys": ["Name"],
             "headers": [
                 "Name",
@@ -1241,6 +1245,7 @@ config = {
             "get_element_data": get_space_data,
         },
         "Zone": {
+            "colour": "o",
             "keys": ["Name", "Category", "SpaceNames"],
             "headers": [
                 "Name",
@@ -1259,6 +1264,7 @@ config = {
             "get_element_data": get_zone_data,
         },
         "Type": {
+            "colour": "r",
             "keys": ["Name"],
             "headers": [
                 "Name",
@@ -1303,6 +1309,7 @@ config = {
             "get_element_data": get_type_data,
         },
         "Component": {
+            "colour": "r",
             "keys": ["Name"],
             "headers": [
                 "Name",
@@ -1331,6 +1338,7 @@ config = {
             "get_element_data": get_component_data,
         },
         "System": {
+            "colour": "o",
             "keys": ["Name", "Category", "ComponentNames"],
             "headers": [
                 "Name",
@@ -1349,6 +1357,7 @@ config = {
             "get_element_data": get_system_data,
         },
         "Assembly": {  # Note that this is technically "not required"
+            "colour": "o",
             "keys": ["Name", "SheetName", "ParentName"],
             "headers": [
                 "Name",
@@ -1369,6 +1378,7 @@ config = {
             "get_element_data": get_assembly_data,
         },
         "Connection": {  # Note that this is technically "not required"
+            "colour": "o",
             "keys": ["Name", "ConnectionType", "RowName1", "RowName2"],
             "headers": [
                 "Name",
@@ -1392,6 +1402,7 @@ config = {
             "get_element_data": get_connection_data,
         },
         "Spare": {
+            "colour": "r",
             "keys": ["Name"],
             "headers": [
                 "Name",
@@ -1413,6 +1424,7 @@ config = {
             "get_element_data": get_spare_data,
         },
         "Resource": {
+            "colour": "r",
             "keys": ["Name"],
             "headers": [
                 "Name",
@@ -1430,6 +1442,7 @@ config = {
             "get_element_data": get_resource_data,
         },
         "Job": {
+            "colour": "r",
             "keys": ["Name", "TypeName", "TaskNumber"],
             "headers": [
                 "Name",
@@ -1458,6 +1471,7 @@ config = {
             "get_element_data": get_job_data,
         },
         "Document": {
+            "colour": "r",
             "keys": ["Name", "Stage", "SheetName", "RowName"],
             "headers": [
                 "Name",
@@ -1482,6 +1496,7 @@ config = {
             "get_element_data": get_document_data,
         },
         "Attribute": {
+            "colour": "o",
             "keys": ["Name", "SheetName", "RowName"],
             "headers": [
                 "Name",
@@ -1504,6 +1519,7 @@ config = {
             "get_element_data": pass_category_elements_as_data,
         },
         "Coordinate": {
+            "colour": "o",
             "keys": ["Name", "SheetName", "RowName"],
             "headers": (
                 "Name",