set_current_terms_version.py

#!/usr/bin/env python

"""Set the current version of a terms of service document.

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

from typing import Dict, List, Optional

import click
from pick import pick

from byceps.services.terms import document_service as terms_document_service
from byceps.services.terms.dbmodels.version import Version
from byceps.services.terms.transfer.models import DocumentID, VersionID
from byceps.services.terms import document_service, version_service

from _util import call_with_app_context


def validate_document_id(ctx, param, value) -> DocumentID:
    document = terms_document_service.find_document(value)

    if not document:
        raise click.BadParameter(f'Unknown document ID "{value}".')

    return document.id


@click.command()
@click.argument('document_id', callback=validate_document_id)
def execute(document_id):
    versions = version_service.get_versions(document_id)
    document = document_service.find_document(document_id)

    versions_by_id = {v.id: v for v in versions}

    # Ask user which version to set as the current one.
    selected_version_id = _request_version_id(
        versions_by_id, document.current_version_id
    )

    # Set current version.
    document_service.set_current_version(document_id, selected_version_id)

    # Confirm update to user.
    selected_version_title = versions_by_id[selected_version_id].title
    click.secho(
        f'Current version for document ID "{document.id}" '
        f'was set to "{selected_version_title}".',
        fg='green',
    )


def _request_version_id(
    versions_by_id: Dict[VersionID, Version],
    current_version_id: Optional[VersionID],
) -> VersionID:
    version_ids = _get_version_ids_latest_first(versions_by_id)

    if not version_ids:
        raise click.BadParameter('No versions available to choose from.')

    def get_option_title(version_id):
        version = versions_by_id[version_id]
        created_at_str = version.created_at.strftime('%Y-%m-%d %H:%M:%S')

        return f'"{version.title}"\t\t{created_at_str}'

    if current_version_id is not None:
        current_version_option_index = version_ids.index(current_version_id)
    else:
        current_version_option_index = 0

    selection = pick(
        version_ids,
        title='Choose version to set as the current one:',
        options_map_func=get_option_title,
        default_index=current_version_option_index,
    )

    return selection[0]


def _get_version_ids_latest_first(
    versions_by_id: Dict[VersionID, Version]
) -> List[VersionID]:
    versions = versions_by_id.values()

    versions_latest_first = list(
        sorted(versions, key=lambda v: v.created_at, reverse=True)
    )

    return [v.id for v in versions_latest_first]


if __name__ == '__main__':
    call_with_app_context(execute)