IPython/nbconvert/filters/tests/test_ansi.py

"""
Module with tests for ansi filters
"""

#-----------------------------------------------------------------------------
# Copyright (c) 2013, the IPython Development Team.
#
# Distributed under the terms of the Modified BSD License.
#
# The full license is in the file COPYING.txt, distributed with this software.
#-----------------------------------------------------------------------------

#-----------------------------------------------------------------------------
# Imports
#-----------------------------------------------------------------------------

from IPython.utils.coloransi import TermColors

from ...tests.base import TestsBase
from ..ansi import strip_ansi, ansi2html, ansi2latex


#-----------------------------------------------------------------------------
# Class
#-----------------------------------------------------------------------------

class TestAnsi(TestsBase):
    """Contains test functions for ansi.py"""


    def test_strip_ansi(self):
        """
        strip_ansi test
        """
        correct_outputs = {
            '%s%s%s' % (TermColors.Green, TermColors.White, TermColors.Red)  : '',
            'hello%s' % TermColors.Blue: 'hello',
            'he%s%sllo' % (TermColors.Yellow, TermColors.Cyan) : 'hello',
            '%shello' % TermColors.Blue : 'hello',
            '{0}h{0}e{0}l{0}l{0}o{0}'.format(TermColors.Red) : 'hello',
            'hel%slo' % TermColors.Green : 'hello',
            'hello' : 'hello'}

        for inval, outval in correct_outputs.items():
            yield self._try_strip_ansi, inval, outval


    def _try_strip_ansi(self, inval, outval):
        assert outval == strip_ansi(inval)


    def test_ansi2html(self):
        """
        ansi2html test
        """
        correct_outputs = {
            '%s' % (TermColors.Red)  : '<span class="ansired"></span>',
            'hello%s' % TermColors.Blue: 'hello<span class="ansiblue"></span>',
            'he%s%sllo' % (TermColors.Green, TermColors.Cyan) : 'he<span class="ansigreen"></span><span class="ansicyan">llo</span>',
            '%shello' % TermColors.Yellow : '<span class="ansiyellow">hello</span>',
            '{0}h{0}e{0}l{0}l{0}o{0}'.format(TermColors.White) : '<span class="ansigrey">h</span><span class="ansigrey">e</span><span class="ansigrey">l</span><span class="ansigrey">l</span><span class="ansigrey">o</span><span class="ansigrey"></span>',
            'hel%slo' % TermColors.Green : 'hel<span class="ansigreen">lo</span>',
            'hello' : 'hello'}

        for inval, outval in correct_outputs.items():
            yield self._try_ansi2html, inval, outval


    def _try_ansi2html(self, inval, outval):
        self.fuzzy_compare(outval, ansi2html(inval))


    def test_ansi2latex(self):
        """
        ansi2latex test
        """
        correct_outputs = {
            '%s' % (TermColors.Red)  : r'\red{}',
            'hello%s' % TermColors.Blue: r'hello\blue{}',
            'he%s%sllo' % (TermColors.Green, TermColors.Cyan) : r'he\green{}\cyan{llo}',
            '%shello' % TermColors.Yellow : r'\yellow{hello}',
            '{0}h{0}e{0}l{0}l{0}o{0}'.format(TermColors.White) : r'\white{h}\white{e}\white{l}\white{l}\white{o}\white{}',
            'hel%slo' % TermColors.Green : r'hel\green{lo}',
            'hello' : 'hello'}

        for inval, outval in correct_outputs.items():
            yield self._try_ansi2latex, inval, outval


    def _try_ansi2latex(self, inval, outval):
        self.fuzzy_compare(outval, ansi2latex(inval), case_sensitive=True)