IncompleteTasksFilter

Complexity

Total Complexity

2

Size/Duplication

Total Lines	11
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	isMatch()	0	2	1
A	__init__()	0	2	1

import re
from datetime import date, datetime, timedelta


class BaseFilter(object):
    """
    The abstract base class for different kind of task-list filters.

    """

    def __init__(self, text):
        """
        Initialize a new BaseFilter objects.

        The required text argument (str) becomes the "text" instance attribute
        of the object.

        """
        self.text = text

    def __hash__(self):
        return hash(self.text)

    def __str__(self):
        return "Filter:{}".format(self.__class__.__name__)

    __repr__ = __str__

    def isMatch(self, task):
        """
        Determine whether the supplied task (arg 'task') satisfies the filter.

        In this base class, the test always returns True.

        """
        return True

    def __eq__(self, other):
        """
        Evaluates objects as equal if their type and self.text attr are the same.

        """
        if not other:
            return False
        if type(other) == type(self):
            return self.text == other.text
        return False


class AllTasksFilter(BaseFilter):
    """
    Task list filter that returns all tasks.

    """

    def __init__(self):
        BaseFilter.__init__(self, 'All')


class IncompleteTasksFilter(BaseFilter):
    """
    Task list filter that removes any completed tasks.

    """

    def __init__(self):
        BaseFilter.__init__(self, 'Incomplete')

    def isMatch(self, task):
        return not task.is_complete


class UncategorizedTasksFilter(BaseFilter):
    """
    Task list filter permitting incomplete tasks without project or context.

    """

    def __init__(self):
        BaseFilter.__init__(self, 'Uncategorized')

    def isMatch(self, task):
        return (not task.contexts) and (not task.projects)


class CompleteTasksFilter(BaseFilter):
    """
    Task list filter that removes any uncompleted tasks from the list.

    """

    def __init__(self):
        BaseFilter.__init__(self, 'Complete')

    def isMatch(self, task):
        return task.is_complete


class ContextFilter(BaseFilter):
    """
    Task list filter allowing only incomplete tasks with the selected context.

    """

    def __init__(self, context):
        BaseFilter.__init__(self, context)

    def isMatch(self, task):
        return self.text in task.contexts


class ProjectFilter(BaseFilter):
    """
    Task list filter allowing only incomplete tasks with the selected project.

    """

    def __init__(self, project):
        BaseFilter.__init__(self, project)

    def isMatch(self, task):
        return self.text in task.projects


class DueFilter(BaseFilter):
    """
    Due list filter for ranges

    """

    def __init__(self, dueRange):
        BaseFilter.__init__(self, dueRange)

    def isMatch(self, task):
        return self.text in task.dueRanges


class DueTodayFilter(BaseFilter):
    """
    Task list filter allowing only incomplete tasks that are due today.

    """

    def __init__(self):
        BaseFilter.__init__(self, "Today")

    def isMatch(self, task):
        if (not task.due):
            return False
        else:
            self.due_date = task.due
            today = datetime.combine(date.today(), datetime.min.time())
            return self.due_date == today


class DueTomorrowFilter(BaseFilter):
    """
    Task list filter allowing only incomplete tasks that are due tomorrow.

    """

    def __init__(self):
        BaseFilter.__init__(self, "Tomorrow")

    def isMatch(self, task):
        if not task.due:
            return False
        else:
            due_date = task.due
            today = datetime.combine(date.today(), datetime.min.time())
            return today < due_date <= today + timedelta(days=1)


class DueThisWeekFilter(BaseFilter):
    """
    Task list filter allowing only incomplete tasks that are due this week.

    """

    def __init__(self):
        BaseFilter.__init__(self, "This week")

    def isMatch(self, task):
        if not task.due:
            return False
        else:
            due_date = task.due
            today = datetime.combine(date.today(), datetime.min.time())
            return today <= due_date <= today + timedelta((6 - today.weekday()) % 7)


class DueThisMonthFilter(BaseFilter):
    """
    Task list filter allowing only incomplete tasks that are due this month.

    """

    def __init__(self):
        BaseFilter.__init__(self, "This month")

    def isMatch(self, task):
        if not task.due:
            return False
        else:
            due_date = task.due
            today = datetime.combine(date.today(), datetime.min.time())
            if today.month == 12:
                last_day_of_month = today.replace(day=31)
            else:
                last_day_of_month = today.replace(month=today.month + 1, day=1) - timedelta(days=1)
            return today <= due_date <= last_day_of_month


class DueOverdueFilter(BaseFilter):
    """
    Task list filter allowing only incomplete tasks that are overdue.

    """

    def __init__(self):
        BaseFilter.__init__(self, "Overdue")

    def isMatch(self, task):
        if not task.due:
            return False
        else:
            due_date = task.due
            today = datetime.combine(date.today(), datetime.min.time())
            return due_date < today


class HasProjectsFilter(BaseFilter):
    """
    Task list filter allowing only incomplete tasks with the selected project.

    """

    def __init__(self):
        BaseFilter.__init__(self, 'Projects')

    def isMatch(self, task):
        return task.projects


class HasContextsFilter(BaseFilter):
    """
    Task list filter allowing only tasks tagged with some project.

    """

    def __init__(self):
        BaseFilter.__init__(self, 'Contexts')

    def isMatch(self, task):
        return task.contexts


class HasPriorityFilter(BaseFilter):
    """
    Task list filter allowing only tasks with a priority set

    """

    def __init__(self):
        BaseFilter.__init__(self, 'Priorities')

    def isMatch(self, task):
        return task.priority


class HasDueDateFilter(BaseFilter):
    """
    Task list filter allowing only complete tasks with due date in due ranges.

    """

    def __init__(self):
        BaseFilter.__init__(self, 'DueRange')

    def isMatch(self, task):
        return task.due


class HasDueRangesFilter(BaseFilter):
    """
    Task list filter allowing only complete tasks with due date in due ranges.

    """

    def __init__(self):
        BaseFilter.__init__(self, 'DueRange')

    def isMatch(self, task):
        return task.dueRanges


class SimpleTextFilter(BaseFilter):
    r"""
    Task list filter allowing only tasks whose string matches a filter string.

    This filter allows for basic and/or/not conditions in the filter string.
    For the syntax see SimpleTextFilter.isMatch.

    User documentation:

    This filter can handle basic and/or/not conditions. The syntax is as
    follows:

    :AND   :   ',' or whitespace (' ')
    :OR    :   '|'
    :NOT   :   prefixed '~' or '!'

    These operators follow the following order of precedence: OR, AND, NOT.
    So, for example:

    :'work job1 | @home':                Either  (matches 'work'
                                                 AND 'job1')
                                        OR      (matches '@home')

    :'norweigan blue ~dead | !parrot':  Either  (matches 'norweigan'
                                                 AND 'blue'
                                                 AND does NOT match 'dead')
                                        OR      (does NOT match 'parrot')

    Terms match the beginning of words, so:

    - 'cleese' Does NOT match 'johncleese'

    Since the python re module is used, most of the escaped regex
    characters will also work when attached to one of the (comma- or space-
    delimited) strings. E.g.:

    - john\b will match 'john' but not 'johncleese'
    - 2014-\d\d-07 will match '2014-03-07' but not '2014-ja-07'

    - '(B)' will match '(B) nail its feet to the perch'.
    """

    def __init__(self, text):
        BaseFilter.__init__(self, text)
        self.re = SimpleTextFilter.compile(text)

    # Terms are split by "," " " or "|".  Retain only a "|" for the re.
    _splitter = re.compile(r'\s*(\|)\s*|[,\s]+()', re.U)
    # Escape anything that's not alphanumeric or a backslash
    _escaper = re.compile(r'(\\\Z|[^\w\\])', re.U)
    # Characters that negate a term
    _negates = ('!', '~')

    @staticmethod
    def _term2re(term):
        # Don't translate separators
        if term is None or term == '|' or term == '':
            return term or ''

        # Check for negated  term
        negate = term.startswith(SimpleTextFilter._negates)
        if negate:
            term = term[1:]

        # If the term is a word (starts with alpha), then only match beginnings of words
        beginning = r'\b' if re.match(r'\b', term) else r'\B'

        # Ignore special meaning of characters like "*", "+", "(", "[", etc.
        term = SimpleTextFilter._escaper.sub(r'\\\1', term)

        # Return a pattern that will match the beginning of a word or not,
        # anywhere in the string, without consuming any of the string.
        return r'^(?' + ('!' if negate else '=') + r'.*' + beginning + term + r')'

    @staticmethod
    def compile(searchString):
        r"""
        Return the user's searchString compiled to a regular expression.

        Example terms: @call +work (A) carrots
        Term may be prefixed with ! or ~ for negation.
        Terms may be combined with "," or " " (AND) or with "|" (OR).
        Terms only match the beginning of a word in the task.
        Terms are case-insensitive.
        Expressions may NOT be nested with parentheses.
        Only \-character special regular expression sets are allowed, everything else is escaped.
        """
        if not searchString:
            return None

        terms = SimpleTextFilter._splitter.split(searchString)
        terms = [SimpleTextFilter._term2re(term) for term in terms]

        return re.compile("".join(terms), re.I | re.U)

    def isMatch(self, task):
        """ Return a boolean based on whether the supplied task satisfies self.text. """
        return self.re.match(task.text) if self.re else True

    def __str__(self):
        return "SimpleTextFilter({})".format(self.text)


class FutureFilter(BaseFilter):
    def __init__(self):
        BaseFilter.__init__(self, 'Future')

    def isMatch(self, task):
        return not task.is_future


class PriorityFilter(BaseFilter):
    """
    Task list filter allowing only tasks with a certain priority

    """

    def __init__(self, priority):
        BaseFilter.__init__(self, priority)

    def isMatch(self, task):
        return self.text in task.priority


class VisibleFilter(BaseFilter):
    """
    Task list filter allowing only not hidden tasks

    """

    def __init__(self):
        BaseFilter.__init__(self, 'Visible')

    def isMatch(self, task):
        return not task.hidden