feat: enhance create_loc_graph function with empty data handling and add unit tests for various scenarios

Author: ImBIOS

.pre-commit-config.yaml

@@ -1,10 +1,4 @@
 repos:
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.3.0
-    hooks:
-      - id: check-yaml
-      - id: end-of-file-fixer
-      - id: trailing-whitespace
   - repo: local
     hooks:
       - id: pytest-check
@@ -13,6 +7,12 @@ repos:
         language: system
         pass_filenames: false
         always_run: true
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
   - repo: https://github.com/PyCQA/flake8
     rev: 6.0.0
     hooks:

sources/graphics_chart_drawer.py

@@ -1,12 +1,10 @@
 from typing import Dict
 
-from numpy import arange, array, add, amax, zeros
 import matplotlib.patches as mpatches
 import matplotlib.pyplot as plt
-
 from manager_download import DownloadManager as DM
 from manager_file import FileManager as FM
-
+from numpy import add, amax, arange, array, zeros
 
 MAX_LANGUAGES = 5  # Number of top languages to add to chart, for each year quarter
 GRAPH_PATH = f"{FM.ASSETS_DIR}/bar_graph.png"  # Chart saving path.
@@ -20,6 +18,15 @@ async def create_loc_graph(yearly_data: Dict, save_path: str):
     :param yearly_data: GitHub user yearly data.
     :param save_path: Path to save the graph file.
     """
+    # Handle empty data case
+    if not yearly_data:
+        fig = plt.figure()
+        ax = fig.add_axes([0, 0, 1.5, 1])
+        ax.set_ylabel("LOC added", fontdict=dict(weight="bold"))
+        plt.savefig(save_path, bbox_inches="tight")
+        plt.close(fig)
+        return
+
     colors = await DM.get_remote_yaml("linguist")
     if colors is None:
         colors = dict()
@@ -49,7 +56,10 @@ async def create_loc_graph(yearly_data: Dict, save_path: str):
     cumulative = zeros((years, 4, 2), dtype=int)
 
     for key, value in languages_all_loc.items():
-        color = colors[key].get("color", "tab:gray")
+        # Handle missing colors gracefully
+        color = "tab:gray"
+        if key in colors:
+            color = colors[key].get("color", "tab:gray")
         language_handles += [mpatches.Patch(color=color, label=key)]
 
         for quarter in range(4):
@@ -94,11 +104,12 @@ async def create_loc_graph(yearly_data: Dict, save_path: str):
     ax.spines["top"].set_visible(False)
     ax.spines["right"].set_visible(False)
 
-    max_offset = 0.05 * amax(cumulative.flatten())
-    joined = cumulative.reshape(-1, cumulative.shape[-1])
-    max_additions = amax(joined[:, 0])
-    max_deletions = amax(joined[:, 1])
-    plt.ylim(top=max_additions + max_offset, bottom=-max_deletions - max_offset)
+    if cumulative.size > 0:  # Only calculate limits if there's data
+        max_offset = 0.05 * amax(cumulative.flatten())
+        joined = cumulative.reshape(-1, cumulative.shape[-1])
+        max_additions = amax(joined[:, 0])
+        max_deletions = amax(joined[:, 1])
+        plt.ylim(top=max_additions + max_offset, bottom=-max_deletions - max_offset)
 
     plt.savefig(save_path, bbox_inches="tight")
     plt.close(fig)

sources/graphics_chart_drawer_test.py

@@ -0,0 +1,162 @@
+import os
+from unittest.mock import AsyncMock, patch
+
+import pytest
+
+# Import the function and constants we're testing
+from graphics_chart_drawer import GRAPH_PATH, MAX_LANGUAGES, create_loc_graph
+
+
+@pytest.fixture
+def sample_yearly_data():
+    return {
+        "2022": {
+            1: {
+                "Python": {"add": 100, "del": 50},
+                "JavaScript": {"add": 80, "del": 30},
+                "Java": {"add": 60, "del": 20},
+            },
+            2: {
+                "Python": {"add": 120, "del": 40},
+                "JavaScript": {"add": 90, "del": 35},
+            },
+            3: {
+                "Python": {"add": 150, "del": 60},
+                "TypeScript": {"add": 70, "del": 25},
+            },
+            4: {
+                "Python": {"add": 200, "del": 80},
+                "Go": {"add": 100, "del": 40},
+            },
+        },
+        "2023": {
+            1: {
+                "Python": {"add": 180, "del": 70},
+                "Rust": {"add": 90, "del": 30},
+            },
+            2: {
+                "Python": {"add": 160, "del": 65},
+                "JavaScript": {"add": 85, "del": 25},
+            },
+            3: {
+                "Python": {"add": 140, "del": 55},
+                "TypeScript": {"add": 75, "del": 30},
+            },
+            4: {
+                "Python": {"add": 130, "del": 50},
+                "Go": {"add": 95, "del": 35},
+            },
+        },
+    }
+
+
+@pytest.fixture
+def sample_colors():
+    return {
+        "Python": {"color": "blue"},
+        "JavaScript": {"color": "yellow"},
+        "Java": {"color": "red"},
+        "TypeScript": {"color": "blue"},
+        "Go": {"color": "cyan"},
+        "Rust": {"color": "orange"},
+    }
+
+
+@pytest.mark.asyncio
+async def test_create_loc_graph_success(sample_yearly_data, sample_colors, tmp_path):
+    test_save_path = str(tmp_path / "test_graph.png")
+
+    with patch(
+        "manager_download.DownloadManager.get_remote_yaml", new_callable=AsyncMock
+    ) as mock_get_yaml:
+        mock_get_yaml.return_value = sample_colors
+
+        await create_loc_graph(sample_yearly_data, test_save_path)
+
+        assert os.path.exists(test_save_path)
+        assert os.path.getsize(test_save_path) > 0
+
+
+@pytest.mark.asyncio
+async def test_create_loc_graph_no_colors(sample_yearly_data, tmp_path):
+    test_save_path = str(tmp_path / "test_graph_no_colors.png")
+
+    with patch(
+        "manager_download.DownloadManager.get_remote_yaml", new_callable=AsyncMock
+    ) as mock_get_yaml:
+        mock_get_yaml.return_value = None
+
+        await create_loc_graph(sample_yearly_data, test_save_path)
+
+        assert os.path.exists(test_save_path)
+        assert os.path.getsize(test_save_path) > 0
+
+
+@pytest.mark.asyncio
+async def test_create_loc_graph_empty_data(tmp_path):
+    test_save_path = str(tmp_path / "test_graph_empty.png")
+    empty_data = {}
+
+    with patch(
+        "manager_download.DownloadManager.get_remote_yaml", new_callable=AsyncMock
+    ) as mock_get_yaml:
+        mock_get_yaml.return_value = {}
+
+        await create_loc_graph(empty_data, test_save_path)
+
+        assert os.path.exists(test_save_path)
+        assert os.path.getsize(test_save_path) > 0
+
+
+@pytest.mark.asyncio
+async def test_create_loc_graph_single_language(tmp_path):
+    test_save_path = str(tmp_path / "test_graph_single.png")
+    single_lang_data = {
+        "2022": {
+            1: {"Python": {"add": 100, "del": 50}},
+            2: {"Python": {"add": 120, "del": 40}},
+            3: {"Python": {"add": 150, "del": 60}},
+            4: {"Python": {"add": 200, "del": 80}},
+        }
+    }
+
+    with patch(
+        "manager_download.DownloadManager.get_remote_yaml", new_callable=AsyncMock
+    ) as mock_get_yaml:
+        mock_get_yaml.return_value = {"Python": {"color": "blue"}}
+
+        await create_loc_graph(single_lang_data, test_save_path)
+
+        assert os.path.exists(test_save_path)
+        assert os.path.getsize(test_save_path) > 0
+
+
+@pytest.mark.asyncio
+async def test_create_loc_graph_max_languages(
+    sample_yearly_data, sample_colors, tmp_path
+):
+    test_save_path = str(tmp_path / "test_graph_max.png")
+
+    # Add more than MAX_LANGUAGES languages to test the limit
+    sample_yearly_data["2022"][1].update(
+        {
+            "Ruby": {"add": 50, "del": 20},
+            "C++": {"add": 40, "del": 15},
+            "PHP": {"add": 30, "del": 10},
+        }
+    )
+
+    with patch(
+        "manager_download.DownloadManager.get_remote_yaml", new_callable=AsyncMock
+    ) as mock_get_yaml:
+        mock_get_yaml.return_value = sample_colors
+
+        await create_loc_graph(sample_yearly_data, test_save_path)
+
+        assert os.path.exists(test_save_path)
+        assert os.path.getsize(test_save_path) > 0
+
+
+def test_constants():
+    assert MAX_LANGUAGES == 5
+    assert GRAPH_PATH.endswith("/bar_graph.png")