bitranox/rst_include

# STDLIB

# OWN
import pathlib3x as pathlib

# PROJ
try:
    # for pytest
    from . import lib_assemble_block
    from . import lib_classes
    from .lib_classes import Block, SourceLine
    from . import lib_get_include_options
    from . import lib_include_file
    from . import lib_test_compare_results
except ImportError:                                 # pragma: no cover
    # for local doctest in pycharm
    import lib_assemble_block                       # type: ignore # pragma: no cover
    import lib_classes                              # type: ignore # pragma: no cover
    from lib_classes import Block, SourceLine       # type: ignore # pragma: no cover
    import lib_get_include_options                  # type: ignore # pragma: no cover
    import lib_include_file                         # type: ignore # pragma: no cover
    import lib_test_compare_results                 # type: ignore # pragma: no cover


def run_template_tests() -> None:
    """
    >>> run_template_tests()

    """
    l_path_source_files = [get_path_test_dir() / 'test1_no_includes_template.rst',
                           get_path_test_dir() / 'test2_include_samedir_template.rst',
                           get_path_test_dir() / 'test3_include_subdir_template.rst',
                           get_path_test_dir() / 'test4_include_nocode_template.rst']

    for path_source_file in l_path_source_files:
        path_result_file = pathlib.Path(str(path_source_file).replace('template', 'result'))
        path_expected_file = pathlib.Path(str(path_source_file).replace('template', 'expected'))
        rst_file = lib_classes.RstFile(source=path_source_file, target=path_result_file)
        lib_assemble_block.create_rst_file_from_template(rst_file)
        assert lib_test_compare_results.compare_results_equal(expected_file=path_expected_file, result_file=path_result_file)
        path_result_file.unlink()


def run_template_tests_not_supported() -> None:
    """
    >>> run_template_tests_not_supported()

    """
    l_path_source_files = [get_path_test_dir() / 'test5_not_supported_template.rst']

    for path_source_file in l_path_source_files:
        path_result_file = pathlib.Path(str(path_source_file).replace('template', 'result'))
        path_expected_file = pathlib.Path(str(path_source_file).replace('template', 'expected'))
        rst_file = lib_classes.RstFile(source=path_source_file, target=path_result_file)
        lib_assemble_block.create_rst_file_from_template(rst_file)
        assert lib_test_compare_results.compare_results_equal(expected_file=path_expected_file, result_file=path_result_file)
        path_result_file.unlink()


def read_include_file_2() -> Block:
    block = get_test_block_include2_ok()
    lib_get_include_options.get_include_options(block)
    lib_include_file.read_include_file(block)
    return block


def get_test_block_ok() -> Block:
    path_source_file = get_path_test_dir() / 'README.template.rst'
    block = Block(path_source_file)
    block.l_source_lines = [SourceLine(line_number=47100, content='.. include:: include1.py'),
                            SourceLine(line_number=47101, content='    :code: python'),
                            SourceLine(line_number=47102, content='    :encoding: utf-8'),
                            SourceLine(line_number=47103, content='    :start-line: 10'),
                            SourceLine(line_number=47104, content='    :end-line: 25'),
                            SourceLine(line_number=47105, content='    :start-after: # start-marker'),
                            SourceLine(line_number=47106, content='    :end-before: # end-marker'),
                            SourceLine(line_number=47107, content='    :pass-through1:'),
                            SourceLine(line_number=47108, content='    :pass-through2: value2'),
                            SourceLine(line_number=47209, content='    '),
                            SourceLine(line_number=47210, content=''),
                            SourceLine(line_number=47211, content='    :no-option:'),
                            SourceLine(line_number=47212, content=''),
                            SourceLine(line_number=47213, content='additional content1'),
                            SourceLine(line_number=47214, content='additional content2'),
                            SourceLine(line_number=47215, content='additional content3'),
                            SourceLine(line_number=47216, content='additional content4'),
                            SourceLine(line_number=47217, content='additional content5'),
                            SourceLine(line_number=47218, content='')]
    return block


def get_test_block_include2_ok() -> Block:
    block = get_test_block_ok()
    block.l_source_lines[0].content = '.. include:: include2.py'
    block.l_source_lines[3].content = '    :start-line: 6'
    block.l_source_lines[4].content = '    :end-line: 25'
    return block


def get_test_block_no_include_filename() -> Block:
    block = get_test_block_ok()
    block.l_source_lines[0].content = '.. include:: '
    return block


def get_test_block_include_filename_not_existing() -> Block:
    block = get_test_block_ok()
    block.l_source_lines[0].content = '.. include:: not_existing.file'
    return block


def get_test_block_code_not_set() -> Block:
    block = get_test_block_ok()
    block.l_source_lines.pop(1)
    return block


def get_test_block_code_invalid() -> Block:
    block = get_test_block_ok()
    block.l_source_lines[1].content = '    :code: '
    return block


def get_test_block_encoding_not_set() -> Block:
    block = get_test_block_ok()
    block.l_source_lines.pop(2)
    return block


def get_test_block_encoding_invalid() -> Block:
    block = get_test_block_ok()
    block.l_source_lines[2].content = '    :encoding: '
    return block


def get_test_block_start_line_not_set() -> Block:
    block = get_test_block_ok()
    block.l_source_lines.pop(3)
    return block


def get_test_block_start_line_invalid() -> Block:
    block = get_test_block_ok()
    block.l_source_lines[3].content = '    :start-line: '
    return block


def get_test_block_start_line_not_integer() -> Block:
    block = get_test_block_ok()
    block.l_source_lines[3].content = '    :start-line: not_integer'
    return block


def get_test_block_end_line_not_set() -> Block:
    block = get_test_block_ok()
    block.l_source_lines.pop(4)
    return block


def get_test_block_end_line_invalid() -> Block:
    block = get_test_block_ok()
    block.l_source_lines[4].content = '    :end-line: '
    return block


def get_test_block_end_line_not_integer() -> Block:
    block = get_test_block_ok()
    block.l_source_lines[4].content = '    :end-line: not_integer'
    return block


def get_test_block_start_after_not_set() -> Block:
    block = get_test_block_ok()
    block.l_source_lines.pop(5)
    return block


def get_test_block_start_after_invalid() -> Block:
    block = get_test_block_ok()
    block.l_source_lines[5].content = '    :start-after: '
    return block


def get_test_block_end_before_not_set() -> Block:
    block = get_test_block_ok()
    block.l_source_lines.pop(6)
    return block


def get_test_block_end_before_invalid() -> Block:
    block = get_test_block_ok()
    block.l_source_lines[6].content = '    :end-before: '
    return block


def get_path_test_dir() -> pathlib.Path:
    """
    >>> assert str(get_path_test_dir()).endswith('tests')
    """
    test_dir = pathlib.Path(__file__).absolute().parent.parent.parent / 'tests'
    return pathlib.Path(test_dir)