class TestSeparations(unittest.TestCase):
list_format = lf.ListFormat(
lf.HeaderAndIndentFormatWithNumbering(contents_indent_spaces=1),
exactly_lib.util.textformat.structure.lists.Separations(
num_blank_lines_between_elements=2,
num_blank_lines_between_header_and_contents=1))
def test_empty_list(self):
items = []
formatter = formatter_with_page_width(10)
actual = formatter.format_header_value_list_according_to_format(
items, self.list_format)
self.assertEqual([], actual)
def test_singleton_list(self):
items = [header_only_item('header')]
formatter = formatter_with_page_width(10)
actual = formatter.format_header_value_list_according_to_format(
items, self.list_format)
self.assertEqual(['1. header'], actual)
def test_multi_element_list__no_content(self):
items = [header_only_item('header 1'), header_only_item('header 2')]
formatter = formatter_with_page_width(20)
actual = formatter.format_header_value_list_according_to_format(
items, self.list_format)
self.assertEqual(
['1. header 1', BLANK_LINE, BLANK_LINE, '2. header 2'], actual)
def test_item_with_content(self):
items = [item('header', [single_text_para('content')])]
formatter = formatter_with_page_width(10)
actual = formatter.format_header_value_list_according_to_format(
items, self.list_format)
self.assertEqual(['1. header', BLANK_LINE, ' content'], actual)
def test_singleton_list(self):
list_format = lf.ListFormat(
lf.HeaderAndIndentFormatWithNumbering(contents_indent_spaces=1),
NO_SEPARATIONS,
indent_str='')
items = [item('header', [single_text_para('2345678 abc def')])]
formatter = formatter_with_page_width(10)
actual = formatter.format_header_value_list_according_to_format(
items, list_format)
self.assertEqual(['1. header', ' 2345678', ' abc def'], actual)
def test_with_given_indent(self):
indent_str = '[INDENT]'
list_format = lf.ListFormat(
lf.HeaderAndIndentFormatPlain(contents_indent_spaces=4),
NO_SEPARATIONS,
indent_str=indent_str)
items = [item('header', [single_text_para('contents')])]
formatter = formatter_with_page_width(100)
actual = formatter.format_header_value_list_according_to_format(
items, list_format)
self.assertEqual(
[indent_str + 'header', indent_str + (4 * ' ') + 'contents'],
actual)
def test_varying_header_following_line_indent(self):
formatter = formatter_with_page_width(4)
items = [
header_only_item('h1 X'),
header_only_item('h2 Y'),
header_only_item('h3 Z')
]
list_format = lf.ListFormat(
HeaderFormatWithVaryingFollowingLineIndent(3),
NO_SEPARATIONS,
indent_str='')
actual = formatter.format_header_value_list_according_to_format(
items, list_format)
self.assertEqual(['**h1', ' X', '*h2', ' Y', '**h3', ' Z'], actual)
def test_without_content(self):
formatter = formatter_with_page_width(4)
current_indent_before = formatter.wrapper.current_indent
indent_stack_before = formatter.wrapper.saved_indents_stack.copy()
items = [header_only_item('h1 X'), header_only_item('h2 Y')]
list_format = lf.ListFormat(
HeaderFormatWithVaryingFollowingLineIndent(3), NO_SEPARATIONS)
formatter.format_header_value_list_according_to_format(
items, list_format)
self.assertEqual(current_indent_before,
formatter.wrapper.current_indent, 'Current indent')
self.assertEqual(indent_stack_before,
formatter.wrapper.saved_indents_stack,
'Saved indents stack')
def test_with_content(self):
list_format = lf.ListFormat(
lf.HeaderAndIndentFormatWithNumbering(contents_indent_spaces=1),
NO_SEPARATIONS)
items = [item('header', [single_text_para('2345678')])]
formatter = formatter_with_page_width(10)
current_indent_before = formatter.wrapper.current_indent
indent_stack_before = formatter.wrapper.saved_indents_stack.copy()
formatter.format_header_value_list_according_to_format(
items, list_format)
self.assertEqual(current_indent_before,
formatter.wrapper.current_indent, 'Current indent')
self.assertEqual(indent_stack_before,
formatter.wrapper.saved_indents_stack,
'Saved indents stack')
def test_with_resolved_indent(self):
format_indent_spaces = 2
indent_str = format_indent_spaces * ' '
list_format = lf.ListFormat(
lf.HeaderAndIndentFormatPlain(contents_indent_spaces=4),
NO_SEPARATIONS,
indent_str=indent_str)
items = [item('header', [single_text_para('contents')])]
the_list = sut.HeaderContentList(
items, lists.Format(lists.ListType.VARIABLE_LIST))
formatter = sut.Formatter(
CROSS_REF_TITLE_ONLY_TEXT_FORMATTER,
sut.Wrapper(page_width=100),
list_formats=lf.ListFormats(variable_list_format=list_format))
actual = formatter.format_header_content_list(the_list)
self.assertEqual(
[indent_str + 'header', indent_str + (4 * ' ') + 'contents'],
actual)
def test_multi_element_list(self):
list_format = lf.ListFormat(
lf.HeaderAndIndentFormatWithNumbering(contents_indent_spaces=1),
NO_SEPARATIONS,
indent_str='')
items = [
item('h1', [single_text_para('2345678')]),
item(
'h2',
[single_text_para('content 1'),
single_text_para('content 2')])
]
formatter = formatter_with_page_width(10)
actual = formatter.format_header_value_list_according_to_format(
items, list_format)
self.assertEqual([
'1. h1', ' 2345678', '2. h2', ' content 1', BLANK_LINE,
' content 2'
], actual)
def test_only_initial_paragraphs(self):
paragraph_item_formatter = paragraph_item.Formatter(
CROSS_REF_TITLE_ONLY_TEXT_FORMATTER,
paragraph_item.Wrapper(page_width=5),
num_item_separator_lines=1,
list_formats=lf.ListFormats(variable_list_format=lf.ListFormat(
lf.HeaderAndIndentFormatPlain(),
lists.Separations(0, 0),
indent_str='')))
formatter = sut.Formatter(paragraph_item_formatter)
section_contents = SectionContents([
single_text_para('12345 123 5'),
lists.HeaderContentList(
[header_only_item('12345 123')],
lists.Format(lists.ListType.VARIABLE_LIST),
)
], [])
actual = formatter.format_section_contents(section_contents)
self.assertEqual(['12345', '123 5', BLANK_LINE, '12345', '123'],
actual)
def test_with_custom_indent(self):
custom_indent_spaces = 5
custom_indent_str = custom_indent_spaces * ' '
content_indent_spaces = 4
content_indent_str = content_indent_spaces * ' '
list_format = lf.ListFormat(
lf.HeaderAndIndentFormatPlain(
contents_indent_spaces=content_indent_spaces),
NO_SEPARATIONS,
indent_str='should not be used since overridden by custom indent')
items = [item('header', [single_text_para('contents')])]
the_list = sut.HeaderContentList(
items,
lists.Format(lists.ListType.VARIABLE_LIST,
custom_indent_spaces=custom_indent_spaces))
formatter = sut.Formatter(
CROSS_REF_TITLE_ONLY_TEXT_FORMATTER,
sut.Wrapper(page_width=100),
list_formats=lf.ListFormats(variable_list_format=list_format))
actual = formatter.format_header_content_list(the_list)
self.assertEqual([
custom_indent_str + 'header',
custom_indent_str + content_indent_str + 'contents'
], actual)
class TestResolveListFormat(unittest.TestCase):
LIST_FORMATS = lf.ListFormats(
itemized_list_format=lf.ListFormat(
lf.HeaderAndIndentFormatWithMarker('*'),
NO_SEPARATIONS,
indent_str=''),
ordered_list_format=lf.ListFormat(
lf.HeaderAndIndentFormatWithNumbering(),
NO_SEPARATIONS,
indent_str=''),
variable_list_format=lf.ListFormat(lf.HeaderAndIndentFormatPlain(),
NO_SEPARATIONS,
indent_str=''))
def test_itemized_list(self):
items = [header_only_item('header')]
formatter = sut.Formatter(CROSS_REF_TITLE_ONLY_TEXT_FORMATTER,
sut.Wrapper(page_width=100),
list_formats=self.LIST_FORMATS)
actual = formatter.format_header_content_list(
lists.HeaderContentList(items,
lists.Format(
lists.ListType.ITEMIZED_LIST)))
self.assertEqual(['* header'], actual)
def test_ordered_list(self):
items = [header_only_item('header')]
formatter = sut.Formatter(CROSS_REF_TITLE_ONLY_TEXT_FORMATTER,
sut.Wrapper(page_width=100),
list_formats=self.LIST_FORMATS)
actual = formatter.format_header_content_list(
lists.HeaderContentList(items,
lists.Format(lists.ListType.ORDERED_LIST)))
self.assertEqual(['1. header'], actual)
def test_variable_list(self):
items = [header_only_item('header')]
formatter = sut.Formatter(CROSS_REF_TITLE_ONLY_TEXT_FORMATTER,
sut.Wrapper(page_width=100),
list_formats=self.LIST_FORMATS)
actual = formatter.format_header_content_list(
lists.HeaderContentList(items,
lists.Format(
lists.ListType.VARIABLE_LIST)))
self.assertEqual(['header'], actual)
def custom_indent(self):
formatter = sut.Formatter(CROSS_REF_TITLE_ONLY_TEXT_FORMATTER,
sut.Wrapper(page_width=100),
list_formats=self.LIST_FORMATS)
actual = formatter.resolve_list_format(
lists.Format(lists.ListType.VARIABLE_LIST,
custom_indent_spaces=10))
self.assertEqual(10 * ' ', actual.indent_str)
def custom_separation(self):
custom_separations = lists.Separations(10, 20)
formatter = sut.Formatter(CROSS_REF_TITLE_ONLY_TEXT_FORMATTER,
sut.Wrapper(page_width=100),
list_formats=self.LIST_FORMATS)
actual = formatter.resolve_list_format(
lists.Format(lists.ListType.VARIABLE_LIST,
custom_separations=custom_separations))
self.assertIs(custom_separations, actual.separations)
ret_val = unittest.TestSuite()
ret_val.addTest(unittest.makeSuite(TestHeaderOnlyListItemsWithNoLineWraps))
ret_val.addTest(unittest.makeSuite(TestHeaderOnlyListItemsWithLineWraps))
ret_val.addTest(unittest.makeSuite(TestContentFormatting))
ret_val.addTest(unittest.makeSuite(TestThatIdentationIsNotModified))
ret_val.addTest(unittest.makeSuite(TestResolveListFormat))
ret_val.addTest(unittest.makeSuite(TestWholeListIndent))
return ret_val
NO_SEPARATIONS = lists.Separations(
num_blank_lines_between_elements=0,
num_blank_lines_between_header_and_contents=0)
list_formatter_with_no_blank_lines = lf.ListFormat(
lf.HeaderAndIndentFormatWithNumbering(contents_indent_spaces=3),
NO_SEPARATIONS,
indent_str='')
class TestHeaderOnlyListItemsWithNoLineWraps(unittest.TestCase):
def test_empty_list(self):
items = []
formatter = formatter_with_page_width(10)
actual = formatter.format_header_value_list_according_to_format(
items, list_formatter_with_no_blank_lines)
self.assertEqual([], actual)
def test_singleton_list(self):
items = [header_only_item('header')]
formatter = formatter_with_page_width(10)
actual = formatter.format_header_value_list_according_to_format(