feat: add OrganizationHierarchyMetric metric

Author: mutantsan

ckanext/better_stats/assets/js/bstats-stats-manager.min.js

@@ -509,6 +509,15 @@ class BetterStatsManager {
         const holder = this._el("div", { className: "metric-chart" });
         container.appendChild(holder);
 
+        if (chartData.tooltip?._htmlTooltip) {
+            const template = chartData.tooltip.formatter as string;
+            chartData.tooltip.formatter = (params: any) =>
+                template
+                    .replace(/\{b\}/g, params.name ?? "")
+                    .replace(/\{c\}/g, params.value ?? "");
+            delete chartData.tooltip._htmlTooltip;
+        }
+
         const chart = echarts.init(holder, this._isDark() ? "dark" : "default");
         chart.setOption(chartData);
         chart._chartOptions = chartData;

ckanext/better_stats/assets/js/bstats-stats-manager.ts

@@ -1,3 +1,5 @@
+from ckan import plugins as p
+
 from ckanext.better_stats.metrics.base import MetricRegistry
 
 from .base import MetricBase
@@ -13,6 +15,7 @@
 from .organization_metrics import (
     InactiveOrganizationsMetric,
     OrganizationCountMetric,
+    OrganizationHierarchyMetric,
     OrganizationMembershipMetric,
     OrganizationOverviewMetric,
     OrganizationSizesMetric,
@@ -30,6 +33,7 @@
     "DatasetsWithoutResourcesMetric",
     "StaleDatasetsMetric",
     "OrganizationCountMetric",
+    "OrganizationHierarchyMetric",
     "OrganizationMembershipMetric",
     "OrganizationOverviewMetric",
     "OrganizationSizesMetric",
@@ -61,9 +65,12 @@ def register_metrics():
     MetricRegistry.register("cpu", CPUMetric)
     MetricRegistry.register("disk_usage", DiskUsageMetric)
 
+    if p.plugin_loaded("hierarchy_display"):
+        MetricRegistry.register("organization_hierarchy", OrganizationHierarchyMetric)
+
 
 def get_all_metrics() -> dict[str, type[MetricBase]]:
-    return {
+    metrics: dict[str, type[MetricBase]] = {
         "dataset_count": DatasetCountMetric,
         "datasets_by_org": DatasetsByOrganizationMetric,
         "dataset_creation_history": DatasetCreationHistoryMetric,
@@ -81,4 +88,6 @@ def get_all_metrics() -> dict[str, type[MetricBase]]:
         "memory": MemoryMetric,
         "cpu": CPUMetric,
         "disk_usage": DiskUsageMetric,
+        "organization_hierarchy": OrganizationHierarchyMetric,
     }
+    return metrics

ckanext/better_stats/metrics/__init__.py

@@ -11,6 +11,106 @@
 from ckanext.better_stats.metrics.base import MetricBase
 
 
+class OrganizationHierarchyMetric(MetricBase):
+    """Tree chart of organization parent-child relationships via ckanext-hierarchy.
+
+    This metric is only available if `ckanext-hierarchy` is installed and enabled.
+    """
+
+    supported_visualizations: ClassVar[list[const.VisualizationType]] = [
+        const.VisualizationType.CHART,
+    ]
+    default_visualization: ClassVar[const.VisualizationType] = const.VisualizationType.CHART
+    icon: ClassVar[str] = "fa-solid fa-sitemap"
+    supported_export_formats: ClassVar[list[str]] = ["image"]
+
+    def __init__(self) -> None:
+        super().__init__(
+            name="organization_hierarchy",
+            title=tk._("Organization Hierarchy"),
+            description=tk._("Tree view of organization parent-child relationships"),
+            order=14,
+            grid_size="full",
+        )
+
+    def get_data(self) -> list[dict[str, Any]]:
+        return tk.h.group_tree(type_="organization")
+
+    def _to_echarts_node(self, node: dict[str, Any]) -> dict[str, Any]:
+        name = node["name"]
+        url = tk.url_for("organization.read", id=name)
+        converted: dict[str, Any] = {
+            "name": node.get("title") or name or "Unknown",
+            "value": (f'<a href="{url}" target="_blank" style="color:inherit;">{tk._("View")} →</a>'),
+        }
+        children = node.get("children", [])
+
+        if children:
+            converted["children"] = [self._to_echarts_node(c) for c in children]
+
+        return converted
+
+    def get_chart_data(self) -> dict[str, Any]:
+        roots = self.get_data()
+
+        if not roots:
+            return {}
+
+        if len(roots) == 1:
+            tree_data = self._to_echarts_node(roots[0])
+        else:
+            tree_data = {
+                "name": tk._("Organizations"),
+                "children": [self._to_echarts_node(r) for r in roots],
+            }
+
+        return {
+            "tooltip": {
+                "trigger": "item",
+                "triggerOn": "mousemove",
+                "enterable": True,
+                "formatter": "{b}<br/>{c}",
+                "_htmlTooltip": True,
+            },
+            "series": [
+                {
+                    "type": "tree",
+                    "data": [tree_data],
+                    "top": "5%",
+                    "left": "5%",
+                    "bottom": "5%",
+                    "right": "5%",
+                    "symbolSize": 10,
+                    "lineStyle": {"width": 1},
+                    "label": {
+                        "position": "left",
+                        "verticalAlign": "middle",
+                        "align": "right",
+                        "fontSize": 13,
+                        "width": 160,
+                        "overflow": "truncate",
+                        "ellipsis": "…",
+                    },
+                    "leaves": {
+                        "label": {
+                            "position": "right",
+                            "verticalAlign": "middle",
+                            "align": "left",
+                            "width": 160,
+                            "overflow": "truncate",
+                            "ellipsis": "…",
+                        }
+                    },
+                    "emphasis": {"focus": "descendant"},
+                    "expandAndCollapse": False,
+                    "animationDuration": 350,
+                    "animationDurationUpdate": 350,
+                    "roam": True,
+                }
+            ],
+        }
+
+
 class OrganizationCountMetric(MetricBase):
     """Total number of active organizations with a monthly creation trend."""
 
@@ -59,7 +159,10 @@ def get_chart_data(self) -> dict[str, Any]:
         )
         return {
             "tooltip": {"trigger": "axis"},
-            "xAxis": {"type": "category", "data": [row.month.strftime("%Y-%m") for row in rows]},
+            "xAxis": {
+                "type": "category",
+                "data": [row.month.strftime("%Y-%m") for row in rows],
+            },
             "yAxis": {"type": "value", "minInterval": 1},
             "series": [{"type": "line", "data": [row.count for row in rows], "smooth": True}],
         }
@@ -254,7 +357,10 @@ def get_data(self) -> list[dict[str, Any]]:
         )
         return [
             {
-                "organization": {"label": row.title, "url": tk.url_for("organization.read", id=row.name)},
+                "organization": {
+                    "label": row.title,
+                    "url": tk.url_for("organization.read", id=row.name),
+                },
                 "datasets": row.datasets,
                 "resources": row.resources,
                 "members": row.members,
@@ -273,7 +379,10 @@ def get_table_data(self) -> dict[str, Any]:
             ],
             "rows": [
                 [
-                    {"text": item["organization"]["label"], "url": item["organization"]["url"]},
+                    {
+                        "text": item["organization"]["label"],
+                        "url": item["organization"]["url"],
+                    },
                     item["datasets"],
                     item["resources"],
                     item["members"],
@@ -401,7 +510,13 @@ def get_chart_data(self) -> dict[str, Any]:
             "series": [
                 {
                     "type": "treemap",
-                    "data": [{"name": item["organization"] or "Unknown", "value": item["count"]} for item in data],
+                    "data": [
+                        {
+                            "name": item["organization"] or "Unknown",
+                            "value": item["count"],
+                        }
+                        for item in data
+                    ],
                     "label": {"show": True, "formatter": "{b}"},
                     "itemStyle": {"borderColor": "#fff"},
                     "roam": False,
@@ -414,4 +529,4 @@ def get_table_data(self) -> dict[str, Any]:
         return {
             "headers": [tk._("Organization"), tk._("Datasets")],
             "rows": [[{"text": item["organization"], "url": item["url"]}, item["count"]] for item in data],
-        }
+    }

ckanext/better_stats/metrics/organization_metrics.py

@@ -24,7 +24,10 @@ def render_metric(metric_name: str) -> str:
         markdown += f"{desc}\n\n"
 
         if docstring:
-            markdown += f"```text\n{metric.__class__.__doc__}\n```\n\n"
+            markdown += "```\n"
+            for line in docstring.split("\n"):
+                markdown += f"{line.strip()}\n"
+            markdown += "```\n\n"
 
         markdown += "| | |\n"
         markdown += "|---|---|\n"

docs/main.py

@@ -11,3 +11,5 @@ These metrics provide insights into organization activity and structure within t
 {{ render_metric('inactive_organizations') }}
 
 {{ render_metric('organization_sizes') }}
+
+{{ render_metric('organization_hierarchy') }}

docs/metrics/organization.md

@@ -1,6 +1,6 @@
 [project]
 name = "ckanext-better-stats"
-version = "0.1.0"
+version = "0.2.0"
 description = "Flexible CKAN extension for defining and displaying custom metrics with support for caching, access control, and multiple output formats"
 readme = "README.md"
 authors = [