renderer: Clean up obsolete code
Removing now unused code from markup_renderer.
This commit is contained in:
parent
2ca27901e3
commit
55b3018fc2
3 changed files with 1 additions and 85 deletions
|
|
@ -51,18 +51,10 @@ class MarkupRenderer(object):
|
|||
RST_PAT = re.compile(r'\.re?st$', re.IGNORECASE)
|
||||
PLAIN_PAT = re.compile(r'^readme$', re.IGNORECASE)
|
||||
|
||||
# list of readme files to search in file tree and display in summary
|
||||
# attached weights defines the search order lower is first
|
||||
ALL_READMES = [
|
||||
('readme', 0), ('README', 0), ('Readme', 0),
|
||||
('doc/readme', 1), ('doc/README', 1), ('doc/Readme', 1),
|
||||
('Docs/readme', 2), ('Docs/README', 2), ('Docs/Readme', 2),
|
||||
('DOCS/readme', 2), ('DOCS/README', 2), ('DOCS/Readme', 2),
|
||||
('docs/readme', 2), ('docs/README', 2), ('docs/Readme', 2),
|
||||
]
|
||||
# extension together with weights. Lower is first means we control how
|
||||
# extensions are attached to readme names with those.
|
||||
PLAIN_EXTS = [
|
||||
# prefer no extension
|
||||
('', 0), # special case that renders READMES names without extension
|
||||
('.text', 2), ('.TEXT', 2),
|
||||
('.txt', 3), ('.TXT', 3)
|
||||
|
|
@ -80,8 +72,6 @@ class MarkupRenderer(object):
|
|||
('.markdown', 4), ('.MARKDOWN', 4)
|
||||
]
|
||||
|
||||
ALL_EXTS = PLAIN_EXTS + MARKDOWN_EXTS + RST_EXTS
|
||||
|
||||
def _detect_renderer(self, source, filename=None):
|
||||
"""
|
||||
runs detection of what renderer should be used for generating html
|
||||
|
|
@ -124,29 +114,6 @@ class MarkupRenderer(object):
|
|||
|
||||
return None
|
||||
|
||||
@classmethod
|
||||
def generate_readmes(cls, all_readmes, extensions):
|
||||
combined = itertools.product(all_readmes, extensions)
|
||||
# sort by filename weight(y[0][1]) + extensions weight(y[1][1])
|
||||
prioritized_readmes = sorted(combined, key=lambda y: y[0][1] + y[1][1])
|
||||
# filename, extension
|
||||
return [''.join([x[0][0], x[1][0]]) for x in prioritized_readmes]
|
||||
|
||||
def pick_readme_order(self, default_renderer):
|
||||
|
||||
if default_renderer == 'markdown':
|
||||
markdown = self.generate_readmes(self.ALL_READMES, self.MARKDOWN_EXTS)
|
||||
readme_order = markdown + self.generate_readmes(
|
||||
self.ALL_READMES, self.RST_EXTS + self.PLAIN_EXTS)
|
||||
elif default_renderer == 'rst':
|
||||
markdown = self.generate_readmes(self.ALL_READMES, self.RST_EXTS)
|
||||
readme_order = markdown + self.generate_readmes(
|
||||
self.ALL_READMES, self.MARKDOWN_EXTS + self.PLAIN_EXTS)
|
||||
else:
|
||||
readme_order = self.generate_readmes(self.ALL_READMES, self.ALL_EXTS)
|
||||
|
||||
return readme_order
|
||||
|
||||
def render(self, source, filename=None):
|
||||
"""
|
||||
Renders a given filename using detected renderer
|
||||
|
|
|
|||
|
|
@ -1037,23 +1037,6 @@ class ReadmeFinder:
|
|||
|
||||
return sorted(paths, key=priority_and_path)
|
||||
|
||||
def search_old(self, commit):
|
||||
"""
|
||||
Try to find a readme in the given `commit`.
|
||||
"""
|
||||
renderer = MarkupRenderer()
|
||||
for f in renderer.pick_readme_order(self._default_renderer):
|
||||
log.debug("Trying README %s", f)
|
||||
try:
|
||||
node = commit.get_node(f)
|
||||
except NodeDoesNotExistError:
|
||||
continue
|
||||
|
||||
if not node.is_file():
|
||||
continue
|
||||
|
||||
return f
|
||||
|
||||
|
||||
class ReadmeMatch:
|
||||
|
||||
|
|
|
|||
|
|
@ -177,37 +177,3 @@ Auto status change to |new_status|
|
|||
renderer = RstTemplateRenderer()
|
||||
rendered = renderer.render('auto_status_change.mako', **params)
|
||||
assert expected == rendered
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"readmes, exts, order",
|
||||
[
|
||||
([], [], []),
|
||||
|
||||
([('readme1', 0), ('text1', 1)], [('.ext', 0), ('.txt', 1)],
|
||||
['readme1.ext', 'readme1.txt', 'text1.ext', 'text1.txt']),
|
||||
|
||||
([('readme2', 0), ('text2', 1)], [('.ext', 2), ('.txt', 1)],
|
||||
['readme2.txt', 'readme2.ext', 'text2.txt', 'text2.ext']),
|
||||
|
||||
([('readme3', 0), ('text3', 1)], [('.XXX', 1)],
|
||||
['readme3.XXX', 'text3.XXX']),
|
||||
])
|
||||
def test_generate_readmes(readmes, exts, order):
|
||||
assert order == MarkupRenderer.generate_readmes(readmes, exts)
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"renderer, expected_order",
|
||||
[
|
||||
('plain', ['readme', 'README', 'Readme']),
|
||||
('text', ['readme', 'README', 'Readme']),
|
||||
('markdown', MarkupRenderer.generate_readmes(
|
||||
MarkupRenderer.ALL_READMES, MarkupRenderer.MARKDOWN_EXTS)),
|
||||
('rst', MarkupRenderer.generate_readmes(
|
||||
MarkupRenderer.ALL_READMES, MarkupRenderer.RST_EXTS)),
|
||||
])
|
||||
def test_order_of_readme_generation(renderer, expected_order):
|
||||
mkd_renderer = MarkupRenderer()
|
||||
assert expected_order == mkd_renderer.pick_readme_order(
|
||||
renderer)[:len(expected_order)]
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue