vladris / tinkerer / 116

pending completion

Build # 116

Build Type

Pull #58

travis-ci

Committed by

dhellmann

Commit Message

<a href="https://github.com/vladris/tinkerer/commit/026e7fb35">Fix flake8 errors and enable in travis

Clean up whitespace, extra imports, redefined symbols,
and other errors and warnings reported by flake8.

Add flake8 to the commands run by travis.

Change-Id: I</a><a class="double-link" href="https://github.com/vladris/tinkerer/commit/d3bdea24c">d3bdea24c</a>

Pull Request Pull Request #58: Fix flake8 errors and enable in travis

Run Details

46 of 46 new or added lines in 14 files covered. (100.0%)

717 of 747 relevant lines covered (95.98%)

2.87 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

96.77

/tinkerer/master.py

'''
    master
    ~~~~~~

    Handles updating the master document.

    :copyright: Copyright 2011-2014 by Vlad Riscutia and contributors (see
    CONTRIBUTORS file)
    :license: FreeBSD, see LICENSE file
'''
from tinkerer import paths


def read_master():
    '''
    Reads master file into a list.
    '''
    with open(paths.master_file, "r") as f:
        return f.readlines()


def write_master(lines):
    '''
    Overwrites master file with given lines.
    '''
    with open(paths.master_file, "w") as f:
        f.writelines(lines)


def prepend_doc(docname):
    '''
    Inserts document at the top of the TOC.
    '''
    lines = read_master()

    # find maxdepth directive
    line_no = 0
    for line_no, line in enumerate(lines):
        if "maxdepth" in line:
            break

    # insert docname after it with 3 space alignment
    lines.insert(line_no + 2, "   %s\n" % docname)

    write_master(lines)


def append_doc(docname):
    '''
    Appends document at the end of the TOC.
    '''
    lines = read_master()

    # find second blank line after maxdepth directive
    blank, line_no = 0, 0
    for line_no, line in enumerate(read_master()):
        if blank == 3:
            break
        if "maxdepth" in line:
            blank = 1
        if blank and line == "\n":
            blank += 1

    lines.insert(line_no, "   %s\n" % docname)

    write_master(lines)


def exists_doc(docname):
    '''
    Return true if document in TOC.
    '''
    return ("   %s\n" % docname) in read_master()


def remove_doc(docname):
    '''
    Removes document from the TOC.
    '''
    # rewrite file filtering line containing docname
    write_master(filter(
        lambda line: line != "   %s\n" % docname,
        read_master())
    )

1	'''
2	master
3	~~~~~~
4
5	Handles updating the master document.
6
7	:copyright: Copyright 2011-2014 by Vlad Riscutia and contributors (see
8	CONTRIBUTORS file)
9	:license: FreeBSD, see LICENSE file
10	'''
11	from tinkerer import paths	3✔
12
13
14	def read_master():	3✔
15	'''
16	Reads master file into a list.
17	'''
18	with open(paths.master_file, "r") as f:	3✔
19	return f.readlines()	3✔
20
21
22	def write_master(lines):	3✔
23	'''
24	Overwrites master file with given lines.
25	'''
26	with open(paths.master_file, "w") as f:	3✔
27	f.writelines(lines)	3✔
28
29
30	def prepend_doc(docname):	3✔
31	'''
32	Inserts document at the top of the TOC.
33	'''
34	lines = read_master()	3✔
35
36	# find maxdepth directive
37	line_no = 0	3✔
38	for line_no, line in enumerate(lines):	3✔
39	if "maxdepth" in line:	3✔
40	break	3✔
41
42	# insert docname after it with 3 space alignment
43	lines.insert(line_no + 2, " %s\n" % docname)	3✔
44
45	write_master(lines)	3✔
46
47
48	def append_doc(docname):	3✔
49	'''
50	Appends document at the end of the TOC.
51	'''
52	lines = read_master()	3✔
53
54	# find second blank line after maxdepth directive
55	blank, line_no = 0, 0	3✔
56	for line_no, line in enumerate(read_master()):	3✔
57	if blank == 3:	3✔
58	break	×
59	if "maxdepth" in line:	3✔
60	blank = 1	3✔
61	if blank and line == "\n":	3✔
62	blank += 1	3✔
63
64	lines.insert(line_no, " %s\n" % docname)	3✔
65
66	write_master(lines)	3✔
67
68
69	def exists_doc(docname):	3✔
70	'''
71	Return true if document in TOC.
72	'''
73	return (" %s\n" % docname) in read_master()	3✔
74
75
76	def remove_doc(docname):	3✔
77	'''
78	Removes document from the TOC.
79	'''
80	# rewrite file filtering line containing docname
81	write_master(filter(	3✔
82	lambda line: line != " %s\n" % docname,
83	read_master())
84	)

vladris / tinkerer / 116

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous