byceps/byceps

"""
byceps.util.templatefilters
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Provide and register custom template filters.

:Copyright: 2014-2024 Jochen Kupperschmidt
:License: Revised BSD (see `LICENSE` file for details)
"""

from flask_babel import gettext
from jinja2 import pass_eval_context, Undefined
from jinja2.filters import do_trim
from markupsafe import escape, Markup
from moneyed import Money

from .l10n import format_money


@pass_eval_context
def dim(eval_ctx, value):
    """Render value in a way so that it looks dimmed."""
    dimmed = _dim(value)
    return _wrap_markup_on_autoescape(eval_ctx, dimmed)


def _dim(value):
    return f'<span class="dimmed">{escape(value)}</span>'


@pass_eval_context
def fallback(eval_ctx, value, fallback=None):
    if not isinstance(value, Undefined) and value:
        result = do_trim(value)

        if eval_ctx.autoescape:
            result = escape(result)
    else:
        if fallback is None:
            fallback = gettext('not specified')

        if eval_ctx.autoescape:
            fallback = escape(fallback)

        result = _dim(fallback)

    return _wrap_markup_on_autoescape(eval_ctx, result)


def _wrap_markup_on_autoescape(eval_ctx, value):
    return Markup(value) if eval_ctx.autoescape else value


def moneyformat(money: Money) -> str:
    """Format monetary value with amount and currency."""
    return format_money(money)


def register(app):
    """Make functions available as template filters."""
    functions = [
        dim,
        fallback,
        moneyformat,
    ]

    for f in functions:
        app.add_template_filter(f)