todoist-taskwarrior/tests/test_recur.py

""" Recur Tests

Tests parsing `recur` strings from Todoist `date_string`s
"""
import pytest
from todoist_taskwarrior import utils


def test_hourly():
    assert utils.parse_recur('every hour') == 'hourly'
    assert utils.parse_recur('every 1 hour') == 'hourly'
    assert utils.parse_recur('every 2 hour') == '2 hours'
    assert utils.parse_recur('every 2 hours') == '2 hours'
    assert utils.parse_recur('every 3 hour') == '3 hours'
    assert utils.parse_recur('every 3 hours') == '3 hours'


def test_every_n_days():
    assert utils.parse_recur('daily') == 'daily'
    assert utils.parse_recur('every day') == 'daily'
    assert utils.parse_recur('every 1 day') == 'daily'
    assert utils.parse_recur('every 1 days') == 'daily'
    assert utils.parse_recur('every other day') == '2 days'
    assert utils.parse_recur('every 3 day') == '3 days'
    assert utils.parse_recur('every 3 days') == '3 days'


def test_special():
    # Indicates daily at 9am - the time is saved in the `due` property
    assert utils.parse_recur('every morning') == 'daily'
    # Indicates daily at 7pm - the time is saved in the `due` property
    assert utils.parse_recur('every evening') == 'daily'

    # Weekdays
    assert utils.parse_recur('every weekday') == 'weekdays'
    assert utils.parse_recur('every workday') == 'weekdays'


def test_weekly():
    assert utils.parse_recur('every week') == 'weekly'
    assert utils.parse_recur('every 1 week') == 'weekly'
    assert utils.parse_recur('every 1 weeks') == 'weekly'
    assert utils.parse_recur('weekly') == 'weekly'
    assert utils.parse_recur('every 3 week') == '3 weeks'
    assert utils.parse_recur('every 3 weeks') == '3 weeks'


def test_monthly():
    assert utils.parse_recur('every month') == 'monthly'
    assert utils.parse_recur('every 1 month') == 'monthly'
    assert utils.parse_recur('every 1 months') == 'monthly'
    assert utils.parse_recur('monthly') == 'monthly'
    assert utils.parse_recur('every 2 months') == '2 months'

    # ordinal
    assert utils.parse_recur('every 2nd month') == '2 months'
    assert utils.parse_recur('every 3rd month') == '3 months'

DAYS_OF_WEEK = [
    # Monday
    'mo',
    'mon',
    'monday',

    # Tuesday
    'tu',
    'tue',
    'tues',
    'tuesday',

    # Wednesday
    'we',
    'wed',
    'weds',
    'wednesday',

    # Thursday
    'th',
    'thu',
    'thurs',
    'thursday',

    # Friday
    'fr',
    'fri',
    'friday',

    # Saturday
    'sa',
    'sat',
    'saturday',

    # Sunday
    'su',
    'sun',
    'sunday',
]


@pytest.mark.parametrize('dow', DAYS_OF_WEEK)
def test_every_dow_has_weekly_recurrence(dow):
    """ The actual day should be indicated in the `due` property, so here
        we just need to ensure that the recurrence is correct.
    """
    assert utils.parse_recur(f'ev {dow}') == 'weekly'
    assert utils.parse_recur(f'every {dow}') == 'weekly'


@pytest.mark.parametrize('ordinal', [
    ('2', 2),
    ('2nd', 2),
    ('3', 3),
    ('3rd', 3),
    ('4', 4),
    ('4th', 4),
])
@pytest.mark.parametrize('dow', DAYS_OF_WEEK)
def test_every_dow_ordinal_recurrence(ordinal, dow):
    ordinal, expected = ordinal
    assert utils.parse_recur(f'ev {ordinal} {dow}') == f'{expected} weeks'
    assert utils.parse_recur(f'every {ordinal} {dow}') == f'{expected} weeks'


def test_day_of_week_short_forms():
    assert utils.parse_recur('every mo') == 'weekly'
    assert utils.parse_recur('every mon') == 'weekly'

    assert utils.parse_recur('every tu') == 'weekly'
    assert utils.parse_recur('every tue') == 'weekly'
    assert utils.parse_recur('every tues') == 'weekly'

    assert utils.parse_recur('every we') == 'weekly'
    assert utils.parse_recur('every wed') == 'weekly'
    assert utils.parse_recur('every weds') == 'weekly'

    assert utils.parse_recur('every th') == 'weekly'
    assert utils.parse_recur('every thu') == 'weekly'
    assert utils.parse_recur('every thurs') == 'weekly'

    assert utils.parse_recur('every fr') == 'weekly'
    assert utils.parse_recur('every fri') == 'weekly'

    assert utils.parse_recur('every sa') == 'weekly'
    assert utils.parse_recur('every sat') == 'weekly'

    assert utils.parse_recur('every su') == 'weekly'
    assert utils.parse_recur('every sun') == 'weekly'


def test_day_of_month():
    """ The actual due date should be indicated by the `due` property, so here
    we just need to ensure a monthly recurrence.
    """
    assert utils.parse_recur('every 1st') == 'monthly'
    assert utils.parse_recur('every 2nd') == 'monthly'
    assert utils.parse_recur('every 3rd') == 'monthly'
    assert utils.parse_recur('every 4th') == 'monthly'
    assert utils.parse_recur('every 21st') == 'monthly'
    assert utils.parse_recur('every 22nd') == 'monthly'
    assert utils.parse_recur('every 23rd') == 'monthly'
    assert utils.parse_recur('every 24th') == 'monthly'
    assert utils.parse_recur('every last day') == 'monthly'


def test_annually():
    assert utils.parse_recur('every year') == 'yearly'
    assert utils.parse_recur('every 2 year') == '2 years'
    assert utils.parse_recur('every 2 years') == '2 years'


def test_unsupported():
    pass