hiro/releases
1
0
Fork 0
mirror of https://github.com/vale981/releases synced 2025-03-05 09:41:42 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Test proving and impl fixing re #56

Browse source 
When no link options are set, regular text is spat out instead.
This commit is contained in:
Jeff Forcier 2016-07-25 17:22:39 -07:00
parent 2e4a8a9a9f
commit 76c3d31749
2 changed files with 39 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
releases/__init__.py
View file

@ -73,19 +73,30 @@ def issues_role(name, rawtext, text, lineno, inliner, options={}, content=[]):
# Lol @ access back to Sphinx
config = inliner.document.settings.env.app.config
if issue_no not in ('-', '0'):
ref = None
if config.releases_issue_uri:
# TODO: deal with % vs .format()
ref = config.releases_issue_uri % issue_no
elif config.releases_github_path:
ref = "https://github.com/{0}/issues/{1}".format(
config.releases_github_path, issue_no)
link = nodes.reference(rawtext, '#' + issue_no, refuri=ref, **options)
# Only generate a reference/link if we were able to make a URI
if ref:
identifier = nodes.reference(
rawtext, '#' + issue_no, refuri=ref, **options
)
# Otherwise, just make it regular text
else:
identifier = nodes.raw(
rawtext=rawtext, text='#' + issue_no, format='html',
**options
)
else:
link = None
identifier = None
issue_no = None # So it doesn't gum up dupe detection later
# Additional 'new-style changelog' stuff
if name in ISSUE_TYPES:
nodelist = issue_nodelist(name, link)
nodelist = issue_nodelist(name, identifier)
spec = None
keyword = None
# TODO: sanity checks re: e.g. >2 parts, >1 instance of keywords, >1
@ -112,7 +123,7 @@ def issues_role(name, rawtext, text, lineno, inliner, options={}, content=[]):
return [node], []
# Return old style info for 'issue' for older changelog entries
else:
return [link], []
return [identifier], []
def release_nodes(text, slug, date, config):
@ -120,13 +131,18 @@ def release_nodes(text, slug, date, config):
# title and give it these HTML attributes during render time) so...fuckit.
# We were already doing fully raw elements elsewhere anyway. And who cares
# about a PDF of a changelog? :x
uri = None
if config.releases_release_uri:
# TODO: % vs .format()
uri = config.releases_release_uri % slug
elif config.releases_github_path:
uri = "https://github.com/{0}/tree/{1}".format(
config.releases_github_path, slug)
link = '<a class="reference external" href="{0}">{1}</a>'.format(uri, text)
# Only construct link tag if user actually configured release URIs somehow
if uri:
link = '<a class="reference external" href="{0}">{1}</a>'.format(uri, text)
else:
link = text
datespan = ''
if date:
datespan = ' <span style="font-size: 75%;">{0}</span>'.format(date)

18
tests/presentation.py
View file

@ -96,6 +96,24 @@ class presentation(Spec):
}
self._test_link(kwargs, 'release', 'explicit_release_1.0.2')
def completely_blank_uri_settings_does_not_asplode(self):
kwargs = {
'release_uri': None,
'issue_uri': None,
'github_path': None,
}
# Get nodes for direct inspection
nodes = self._test_link(kwargs, 'release', None)
# Ensure release entry still displays release version.
# (These are curently constructed as raw text nodes so no other great
# way to test this. Meh.)
text = nodes[0][0][0].astext()
assert '>1.0.2 <span' in text
# Ensure issues still display issue number. (Ditto.)
text = nodes[0][1][0][0].astext()
assert '>Bug</span>] #15:' in text
def _assert_prefix(self, entries, expectation):
assert expectation in self._generate(*entries)[0][0][0]