byceps.services.global_setting.service

Complexity

Total Complexity

9

Size/Duplication

Total Lines	84
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

7 Functions

Rating	Name	Duplication	Size	Complexity
A	find_setting_value()	0	10	2
A	get_settings()	0	5	1
A	create_or_update_setting()	0	11	1
A	_db_entity_to_global_setting()	0	4	1
A	find_setting()	0	8	2
A	create_setting()	0	8	1
A	remove_setting()	0	9	1

"""
byceps.services.global_setting.service
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

:Copyright: 2006-2020 Jochen Kupperschmidt
:License: Modified BSD, see LICENSE for details.
"""

from typing import Optional, Set

from ...database import db, upsert

from .models import Setting as DbSetting
from .transfer.models import GlobalSetting


def create_setting(name: str, value: str) -> GlobalSetting:
    """Create a global setting."""
    setting = DbSetting(name, value)

    db.session.add(setting)
    db.session.commit()

    return _db_entity_to_global_setting(setting)


def create_or_update_setting(name: str, value: str) -> GlobalSetting:
    """Create or update a global setting, depending on whether it
    already exists or not.
    """
    table = DbSetting.__table__
    identifier = {'name': name }
    replacement = {'value': value}

    upsert(table, identifier, replacement)

    return find_setting(name)


def remove_setting(name: str) -> None:
    """Remove the global setting with that name.

    Do nothing if no global setting with that name exists.
    """
    db.session.query(DbSetting) \
        .filter_by(name=name) \
        .delete()
    db.session.commit()


def find_setting(name: str) -> Optional[GlobalSetting]:
    """Return the global setting with that name, or `None` if not found."""
    setting = DbSetting.query.get(name)

    if setting is None:
        return None

    return _db_entity_to_global_setting(setting)


def find_setting_value(name: str) -> Optional[str]:
    """Return the value of the global setting with that name, or `None`
    if not found.
    """
    setting = find_setting(name)

    if setting is None:
        return None

    return setting.value


def get_settings() -> Set[GlobalSetting]:
    """Return all global settings."""
    settings = DbSetting.query.all()

    return {_db_entity_to_global_setting(setting) for setting in settings}


def _db_entity_to_global_setting(setting: DbSetting) -> GlobalSetting:
    return GlobalSetting(
        setting.name,
        setting.value,
    )