Source code for superdjango.ui.context_processors

__author__ = "Shawn Davis <shawn@superdjango.com>"
__maintainer__ = "Shawn Davis <shawn@superdjango.com>"
__version__ = "0.3.0-d"

# Imports

from ..constants import FILTER, LIST, LOCATION, ORIENTATION, PAGINATION, SIZE, VERB
from ..options.interfaces import site

# Exports

__all__ = (
    "constants",
    "menu_items",
)

# Processors


def constants(request):
    """Include SuperDjango UI constants to the context.

    :param request: The current HTTP request instance.

    :rtype: dict

    """
    return {
        'FILTER': FILTER,
        'LIST': LIST,
        'LOCATION': LOCATION,
        'ORIENTATION': ORIENTATION,
        'PAGINATION': PAGINATION,
        'SIZE': SIZE,
        'VERB': VERB
    }


def menu_items(request):
    """Add SuperDjango UI menus to the context.

    :param request: The current HTTP request instance.

    :rtype: dict

    .. note::
        This context processor assumes you are either using ``superdjango.ui.apps.AutoConfig`` or that menus are
        registered manually with ``site.register()``.

    """

    context = dict()
    menus = site.get_menus(request)
    for location in menus.keys():
        context[location] = menus[location]

    return context