Module control.cust.reviewentry_record

Expand source code 
from config import Config as C, Names as N
from control.html import HtmlElements as H
from control.utils import pick as G, E, DOT
from control.record import Record

CW = C.web

MESSAGES = CW.messages
Qu = H.icon(CW.unknown[N.user], asChar=True)


class ReviewEntryR(Record):
    """Logic for reviewEntry records.

    Review entry records have a customised title,
    showing when the entry was made and by whom.

    There is also a `compact` method to present these records, just the title and
    the comments entered by the reviewer.

    !!! hint
        If the `reviewEntry` record is not part of the workflow, the behaviour
        of this class falls back to the base class `control.record.Record`.
    """

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)

    def title(self, *args, **kwargs):
        uid = self.uid
        record = self.record

        markup = kwargs.get("markup", True)
        creatorId = G(record, N.creator)
        creator = self.field(N.creator).wrapBare(markup=markup)
        youRep = f""" ({N.you})""" if creatorId == uid else E

        lastModified = G(record, N.modified)
        lastModifiedRep = (
            self.field(N.modified).value[-1].rsplit(DOT, maxsplit=1)[0]
            if lastModified
            else ("not modified" if markup is None else Qu)
        )
        return (
            H.span(f"""{lastModifiedRep}{creator}{youRep}""", cls="rentrytitle")
            if markup
            else f"""{lastModifiedRep}{creator}{youRep}"""
        )

    def bodyCompact(self, **kwargs):
        perm = self.perm

        theTitle = self.title()
        comments = (
            """<!-- begin review comment -->"""
            + H.div(
                self.field(N.comments).wrap(withLabel=False, asEdit=G(perm, N.isEdit)),
            )
            + """<!-- end review comment -->"""
        )

        return H.div([theTitle, comments], cls="reviewentry")

Classes

class ReviewEntryR (*args, **kwargs)

Logic for reviewEntry records.

Review entry records have a customised title, showing when the entry was made and by whom.

There is also a compact method to present these records, just the title and the comments entered by the reviewer.

Hint

If the reviewEntry record is not part of the workflow, the behaviour of this class falls back to the base class Record.

Initialization

Store the incoming information.

A number of properties will be inherited from the table object that spawns a record object.

Parameters

tableObj : object
See below.
eid, record, withDetails, readonly, bodyMethod
See Table.record()
Expand source code 
class ReviewEntryR(Record):
    """Logic for reviewEntry records.

    Review entry records have a customised title,
    showing when the entry was made and by whom.

    There is also a `compact` method to present these records, just the title and
    the comments entered by the reviewer.

    !!! hint
        If the `reviewEntry` record is not part of the workflow, the behaviour
        of this class falls back to the base class `control.record.Record`.
    """

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)

    def title(self, *args, **kwargs):
        uid = self.uid
        record = self.record

        markup = kwargs.get("markup", True)
        creatorId = G(record, N.creator)
        creator = self.field(N.creator).wrapBare(markup=markup)
        youRep = f""" ({N.you})""" if creatorId == uid else E

        lastModified = G(record, N.modified)
        lastModifiedRep = (
            self.field(N.modified).value[-1].rsplit(DOT, maxsplit=1)[0]
            if lastModified
            else ("not modified" if markup is None else Qu)
        )
        return (
            H.span(f"""{lastModifiedRep}{creator}{youRep}""", cls="rentrytitle")
            if markup
            else f"""{lastModifiedRep}{creator}{youRep}"""
        )

    def bodyCompact(self, **kwargs):
        perm = self.perm

        theTitle = self.title()
        comments = (
            """<!-- begin review comment -->"""
            + H.div(
                self.field(N.comments).wrap(withLabel=False, asEdit=G(perm, N.isEdit)),
            )
            + """<!-- end review comment -->"""
        )

        return H.div([theTitle, comments], cls="reviewentry")

Ancestors

Methods

def bodyCompact(self, **kwargs)
Expand source code 
def bodyCompact(self, **kwargs):
    perm = self.perm

    theTitle = self.title()
    comments = (
        """<!-- begin review comment -->"""
        + H.div(
            self.field(N.comments).wrap(withLabel=False, asEdit=G(perm, N.isEdit)),
        )
        + """<!-- end review comment -->"""
    )

    return H.div([theTitle, comments], cls="reviewentry")

Inherited members