todonotifier.models

  1"""This module defines the standard models used in the application.
  2
  3Standard format for todo item is as follows.
  4todo has to be in capital letters
  5Format: TODO [YYYY-MM-DD] @user_name inline_msg
  6Date format must be YYYY-MM-DD
  7Only one todo item is allowed per line. If more than one is in one line, the first one
  8is considered as todo item and the rest are considered as message.
  9No. of spaces between todo, date, user, message is NOT important.
 10"""
 11
 12from datetime import datetime
 13from typing import TypeVar
 14
 15from dateutil import parser
 16
 17from todonotifier.constants import DEFAULT_COMPLETION_DATE
 18
 19T = TypeVar("T")
 20
 21
 22class USER:
 23    def __init__(self, user_name: str) -> None:
 24        """Initializer for class `USER`
 25
 26        Args:
 27            user_name (str): User name
 28        """
 29        self._user_name = user_name
 30
 31    @property
 32    def user_name(self) -> str:
 33        """Getter for `user_name`
 34
 35        Returns:
 36            str: Returns username
 37        """
 38        return self._user_name
 39
 40    def __str__(self) -> str:
 41        """Defines str representation of `USER` class object
 42
 43        Returns:
 44            str: Returns string representation of the class object
 45        """
 46        return f"User: {repr(self)} user_name: {self.user_name}"
 47
 48
 49class POSITION:
 50    def __init__(self, line_no: int) -> None:
 51        """Initializer for position of a text in file
 52
 53        Args:
 54            line_no (int): Shows line_no no. of the text
 55        """
 56        self._line_no = line_no
 57
 58    @property
 59    def line_no(self) -> int:
 60        """Getter for `line_no`
 61
 62        Returns:
 63            int: Integer representing the line_no no. in respective module
 64        """
 65        return self._line_no
 66
 67    def __str__(self) -> str:
 68        """Defines str representation of `POSITION` class object
 69
 70        Returns:
 71            str: Returns string representation of the class object
 72        """
 73        return f"Position: {repr(self)} line_no: {self.line_no}"
 74
 75
 76class TODO:
 77    def __init__(
 78        self,
 79        msg: str,
 80        user: USER,
 81        completion_date_str: str,
 82        module: str,
 83        position: POSITION,
 84    ) -> None:
 85        """Initializer for `todo.upper()` class
 86
 87        Args:
 88            msg (str): Inline message in the todo
 89            user (USER): User in the todo item
 90            completion_date_str (str): Date by which the respective `todo` item is supposed to be completed
 91            module (str): Module in which todo item is present
 92            position (POSITION): Represents the position of the respective todo
 93
 94        Raises:
 95            InvalidDateFormatException: Raised if the `completion_date_str` is not valid or doesn't conform to expected format of "YYYY-MM-DD"
 96        """
 97        self._msg = msg
 98        self._user = user
 99        try:
100            self._completion_date = parser.parse(completion_date_str).date()
101        except Exception:
102            self._completion_date = parser.parse(DEFAULT_COMPLETION_DATE).date()
103        self._module = module
104        self._position = position
105
106    @property
107    def msg(self) -> str:
108        """Getter for `msg`
109
110        Returns:
111            str: Message of todo item
112        """
113        return self._msg
114
115    @property
116    def user(self) -> USER:
117        """Getter for `user`
118
119        Returns:
120            USER: user object of the respective todo item
121        """
122        return self._user
123
124    @property
125    def completion_date(self) -> datetime.date:
126        """Getter for `datetime` representation of `completion_date_str`
127
128        Returns:
129            datetime: datetime object representing `completion_date_str`
130        """
131        return self._completion_date
132
133    @property
134    def module(self) -> str:
135        """Getter for `module`
136
137        Returns:
138            str: Module name/address of the respective todo item
139        """
140        return self._module
141
142    @property
143    def position(self) -> POSITION:
144        """Getter for `position`
145
146        Returns:
147            POSITION: Position of respective todo item in code
148        """
149        return self._position
150
151    def __str__(self) -> str:
152        """str representation of `todo` object
153
154        Returns:
155            str: String representation of the respective todo object
156        """
157        return f"""TODO: {repr(self)} msg: {self.msg} user: {str(self.user)} completion date: {self.completion_date} module: {self.module} position: {str(self.position)}"""  # noqa