badge.py

"""
This module should contain only the things relevant to the badge being computed
by shields.io
"""

from __future__ import annotations

import decimal
import json
import urllib.parse
from typing import Literal

import httpx


def get_badge_color(
    rate: decimal.Decimal,
    minimum_green: decimal.Decimal,
    minimum_orange: decimal.Decimal,
) -> str:
    if rate >= minimum_green:
        return "brightgreen"
    elif rate >= minimum_orange:
        return "orange"
    else:
        return "red"


def get_evolution_badge_color(
    delta: decimal.Decimal | int,
    up_is_good: bool = True,
    neutral_color: str = "lightgrey",
) -> str:
    if delta == 0:
        return neutral_color
    elif (delta > 0) is up_is_good:
        return "brightgreen"
    else:
        return "red"


def compute_badge_endpoint_data(
    line_rate: decimal.Decimal,
    color: str,
) -> str:
    badge = {
        "schemaVersion": 1,
        "label": "Coverage",
        "message": f"{int(line_rate)}%",
        "color": color,
    }

    return json.dumps(badge)


def compute_badge_image(
    line_rate: decimal.Decimal, color: str, http_session: httpx.Client
) -> str:
    return http_session.get(
        "https://img.shields.io/static/v1?"
        + urllib.parse.urlencode(
            {
                "label": "Coverage",
                "message": f"{int(line_rate)}%",
                "color": color,
            }
        )
    ).text


def get_static_badge_url(
    label: str,
    message: str,
    color: str,
    format: Literal["svg", "png"] = "png",
) -> str:
    if not color or not message:
        raise ValueError("color and message are required")
    code = "-".join(
        e.replace("_", "__").replace("-", "--") for e in (label, message, color) if e
    )
    return "https://img.shields.io/badge/" + urllib.parse.quote(f"{code}.{format}")


def get_endpoint_url(endpoint_url: str) -> str:
    return f"https://img.shields.io/endpoint?url={endpoint_url}"


def get_dynamic_url(endpoint_url: str) -> str:
    return "https://img.shields.io/badge/dynamic/json?" + urllib.parse.urlencode(
        {
            "color": "brightgreen",
            "label": "coverage",
            "query": "$.message",
            "url": endpoint_url,
        }
    )