flaskbb/tests/unit/utils/test_helpers.py

#-*- coding: utf-8 -*-
import datetime
from flaskbb.utils.helpers import slugify, forum_is_unread, topic_is_unread, \
    crop_title, render_markup, is_online, format_date, format_quote
from flaskbb.utils.settings import flaskbb_config
from flaskbb.forum.models import Forum


def test_slugify():
    """Test the slugify helper method."""
    assert slugify(u'Hello world') == u'hello-world'

    assert slugify(u'¿Cómo está?') == u'como-esta'


def test_forum_is_unread(guest, user, forum, topic, forumsread):
    """Test the forum is unread function."""

    # for a guest
    assert not forum_is_unread(None, None, guest)

    # for a logged in user without a forumsread
    assert forum_is_unread(forum, None, user)

    # same, just with forumsread
    assert forum_is_unread(forum, forumsread, user)

    # lets mark the forum as read
    # but before we have to add an read entry in forumsread and topicsread
    topic.update_read(user, topic.forum, forumsread)

    time_read = datetime.datetime.utcnow() - datetime.timedelta(hours=1)
    forumsread.cleared = time_read  # lets cheat here a bit :P
    forumsread.last_read = datetime.datetime.utcnow()
    forumsread.save()
    assert not forum_is_unread(forum, forumsread, user)

    # read tracker is disabled
    flaskbb_config["TRACKER_LENGTH"] = 0
    assert not forum_is_unread(forum, forumsread, user)

    # no topics in this forum
    topic.delete()
    forum = Forum.query.filter_by(id=forum.id).first()
    flaskbb_config["TRACKER_LENGTH"] = 1  # activate the tracker again
    assert forum.topic_count == 0
    assert not forum_is_unread(forum, None, user)


def test_topic_is_unread(guest, user, forum, topic, topicsread, forumsread):
    # test guest
    assert not topic_is_unread(None, None, guest)

    # compare topicsread.last_read with topic.last_post.date_created
    assert topic_is_unread(topic, topicsread, user, forumsread)

    # TopicsRead is none and the forum has never been marked as read
    assert topic_is_unread(topic, topicsread=None, user=user, forumsread=forumsread)

    # lets mark the forum as read
    forumsread.cleared = datetime.datetime.utcnow()
    forumsread.last_read = datetime.datetime.utcnow()
    forumsread.save()
    assert not topic_is_unread(topic, topicsread=None, user=user, forumsread=forumsread)

    # disabled tracker
    flaskbb_config["TRACKER_LENGTH"] = 0
    assert not topic_is_unread(topic, None, user, None)

    # post is older than tracker length
    time_posted = datetime.datetime.utcnow() - datetime.timedelta(days=2)
    flaskbb_config["TRACKER_LENGTH"] = 1
    topic.last_post.date_created = time_posted
    topic.save()
    assert not topic_is_unread(topic, None, user, None)


def test_crop_title(default_settings):
    short_title = "Short title"
    long_title = "This is just a test title which is too long."

    assert crop_title(short_title) == short_title
    assert crop_title(long_title) == "This is just a..."


def test_render_markup(default_settings):
    markdown = "**Bold**"
    bbcode = "[b]Bold[/b]"
    no_markup = "Bold"

    flaskbb_config["MARKUP_TYPE"] = "markdown"
    assert render_markup(markdown) == "<p><strong>Bold</strong></p>\n"

    flaskbb_config["MARKUP_TYPE"] = "bbcode"
    assert render_markup(bbcode) == "<strong>Bold</strong>"

    flaskbb_config["MARKUP_TYPE"] = "text"
    assert render_markup(no_markup) == "Bold"


def test_is_online(default_settings, user):
    assert is_online(user)


def test_format_date():
    date = datetime.date(2015, 02, 15)
    time = datetime.datetime.combine(date, datetime.datetime.min.time())
    assert format_date(time) == "2015-02-15"


def test_format_quote(topic):
    expected_bbcode = "[b][url=http://localhost:5000/user/test_normal]test_normal[/url] wrote:[/b][quote]Test Content Normal[/quote]\n"
    expected_markdown = "**[test_normal](http://localhost:5000/user/test_normal) wrote:**\n> Test Content Normal\n"

    flaskbb_config["MARKUP_TYPE"] = "bbcode"
    assert format_quote(topic.first_post) == expected_bbcode

    flaskbb_config["MARKUP_TYPE"] = "markdown"
    assert format_quote(topic.first_post) == expected_markdown