Use common code between draft and not for combining top line and rendered

src/towncrier/_builder.py

@@ -224,14 +224,14 @@ def render_issue(issue_format, issue):
 def render_fragments(
     template,
     issue_format,
-    top_line,
     fragments,
     definitions,
     underlines,
     wrap,
     versiondata,
     top_underline="=",
     all_bullets=False,
+    render_title=True,
 ):
     """
     Render the fragments into a news file.
@@ -289,7 +289,7 @@ def get_indent(text):
         return u""
 
     res = jinja_template.render(
-        top_line=top_line,
+        render_title=render_title,
         sections=data,
         definitions=definitions,
         underlines=underlines,

src/towncrier/build.py

@@ -141,30 +141,49 @@ def __main(
         top_line = config["title_format"].format(
             name=project_name, version=project_version, project_date=project_date
         )
+        render_title_with_fragments = False
+        render_title_separately = True
+    elif config["title_format"] is False:
+        # This is an odd check but since we support both "" and False with
+        # different effects we have to do something a bit abnormal here.
+        top_line = ""
+        render_title_separately = False
+        render_title_with_fragments = False
     else:
         top_line = ""
+        render_title_separately = False
+        render_title_with_fragments = True
 
     rendered = render_fragments(
         # The 0th underline is used for the top line
         template,
         config["issue_format"],
-        top_line,
         fragments,
         definitions,
         config["underlines"][1:],
         config["wrap"],
         {"name": project_name, "version": project_version, "date": project_date},
         top_underline=config["underlines"][0],
         all_bullets=config["all_bullets"],
+        render_title=render_title_with_fragments,
     )
 
+    if render_title_separately:
+        content = "\n".join([
+            top_line,
+            config["underlines"][0] * len(top_line),
+            rendered,
+        ])
+    else:
+        content = rendered
+
     if draft:
         click.echo(
             "Draft only -- nothing has been written.\n"
             "What is seen below is what would be written.\n",
             err=to_err,
         )
-        click.echo(rendered)
+        click.echo(content)
     else:
         click.echo("Writing to newsfile...", err=to_err)
         start_string = config["start_string"]
@@ -181,7 +200,7 @@ def __main(
             news_file,
             start_string,
             top_line,
-            rendered,
+            content,
             single_file=config["single_file"],
         )
 

src/towncrier/newsfragments/105.bugfix.rst

@@ -0,0 +1 @@
+The extra newline between the title and rendered content when using ``--draft`` is no longer inserted.

src/towncrier/templates/default.rst

@@ -1,13 +1,12 @@
-{% if top_line %}
-{{ top_line }}
-{{ top_underline * ((top_line)|length)}}
-{% elif versiondata.name %}
+{% if render_title %}
+{% if versiondata.name %}
 {{ versiondata.name }} {{ versiondata.version }} ({{ versiondata.date }})
 {{ top_underline * ((versiondata.name + versiondata.version + versiondata.date)|length + 4)}}
 {% else %}
 {{ versiondata.version }} ({{ versiondata.date }})
 {{ top_underline * ((versiondata.version + versiondata.date)|length + 3)}}
 {% endif %}
+{% endif %}
 {% for section, _ in sections.items() %}
 {% set underline = underlines[0] %}{% if section %}{{section}}
 {{ underline * section|length }}{% set underline = underlines[1] %}

src/towncrier/templates/hr-between-versions.rst

@@ -1,10 +1,12 @@
+{% if render_title %}
 {% if versiondata.name %}
 {{ versiondata.name }} {{ versiondata.version }} ({{ versiondata.date }})
 {{ top_underline * ((versiondata.name + versiondata.version + versiondata.date)|length + 4)}}
 {% else %}
 {{ versiondata.version }} ({{ versiondata.date }})
 {{ top_underline * ((versiondata.version + versiondata.date)|length + 3)}}
 {% endif %}
+{% endif %}
 {% for section, _ in sections.items() %}
 {% set underline = underlines[0] %}{% if section %}{{section}}
 {{ underline * section|length }}{% set underline = underlines[1] %}

src/towncrier/templates/single-file-no-bullets.rst

@@ -1,10 +1,12 @@
+{% if render_title %}
 {% if versiondata.name %}
 {{ versiondata.name }} {{ versiondata.version }} ({{ versiondata.date }})
 {{ top_underline * ((versiondata.name + versiondata.version + versiondata.date)|length + 4)}}
 {% else %}
 {{ versiondata.version }} ({{ versiondata.date }})
 {{ top_underline * ((versiondata.version + versiondata.date)|length + 3)}}
 {% endif %}
+{% endif %}
 {% for section, _ in sections.items() %}
 {% set underline = underlines[0] %}{% if section %}{{section}}
 {{ underline * section|length }}{% set underline = underlines[1] %}

src/towncrier/test/test_build.py

@@ -740,12 +740,25 @@ def test_title_format_false(self):
                     [tool.towncrier]
                     package = "foo"
                     title_format = false
+                    template = "template.rst"
                 """))
             os.mkdir("foo")
             os.mkdir("foo/newsfragments")
-            # Towncrier ignores .rst extension
-            with open("foo/newsfragments/124.feature.rst", "w") as f:
-                f.write("Extends levitation")
+            with open("template.rst", "w") as f:
+                f.write(dedent("""\
+                    Here's a hardcoded title added by the template
+                    ==============================================
+                    {% for section in sections %}
+                    {% set underline = "-" %}
+                    {% for category, val in definitions.items() if category in sections[section] %}
+
+                    {% for text, values in sections[section][category]|dictsort(by='value') %}
+                    - {{ text }}
+
+                    {% endfor %}
+                    {% endfor %}
+                    {% endfor %}
+                """))
 
             result = runner.invoke(
                 _main,
@@ -767,13 +780,8 @@ def test_title_format_false(self):
             Draft only -- nothing has been written.
             What is seen below is what would be written.
 
-            FooBarBaz 7.8.9 (20-01-2001)
-            ============================
-
-            Features
-            --------
-
-            - Extends levitation (#124)
+            Here's a hardcoded title added by the template
+            ==============================================
 
         """)
 
@@ -836,3 +844,65 @@ def test_start_string(self):
         """)
 
         self.assertEqual(expected_output, output)
+
+    def test_with_topline_and_template_and_draft(self):
+        """
+        Spacing is proper when drafting with a topline and a template.
+        """
+        runner = CliRunner()
+
+        with runner.isolated_filesystem():
+            with open("pyproject.toml", "w") as f:
+                f.write(dedent("""\
+                    [tool.towncrier]
+                    title_format = "{version} - {project_date}"
+                    template = "template.rst"
+
+                      [[tool.towncrier.type]]
+                      directory = "feature"
+                      name = ""
+                      showcontent = true
+                """))
+            os.mkdir("newsfragments")
+            with open("newsfragments/123.feature", "w") as f:
+                f.write("Adds levitation")
+            with open("template.rst", "w") as f:
+                f.write(dedent("""\
+                    {% for section in sections %}
+                    {% set underline = "-" %}
+                    {% for category, val in definitions.items() if category in sections[section] %}
+
+                    {% for text, values in sections[section][category]|dictsort(by='value') %}
+                    - {{ text }}
+
+                    {% endfor %}
+                    {% endfor %}
+                    {% endfor %}
+                """))
+
+            result = runner.invoke(
+                _main,
+                [
+                    "--version=7.8.9",
+                    "--name=foo",
+                    "--date=20-01-2001",
+                    "--draft",
+                ],
+            )
+
+        expected_output = dedent("""\
+            Loading template...
+            Finding news fragments...
+            Rendering news fragments...
+            Draft only -- nothing has been written.
+            What is seen below is what would be written.
+
+            7.8.9 - 20-01-2001
+            ==================
+
+            - Adds levitation
+
+        """)
+
+        self.assertEqual(0, result.exit_code, result.output)
+        self.assertEqual(expected_output, result.output)

src/towncrier/test/test_format.py

@@ -3,8 +3,6 @@
 
 from __future__ import absolute_import, division
 
-from textwrap import dedent
-
 import pkg_resources
 
 from twisted.trial.unittest import TestCase
@@ -131,7 +129,6 @@ def test_basic(self):
         output = render_fragments(
             template,
             None,
-            "",
             fragments,
             definitions,
             ["-", "~"],
@@ -176,7 +173,6 @@ def test_basic(self):
         output = render_fragments(
             template,
             None,
-            "",
             fragments,
             definitions,
             ["*", "^"],
@@ -222,7 +218,6 @@ def test_issue_format(self):
         output = render_fragments(
             template,
             u"xx{issue}",
-            "",
             fragments,
             definitions,
             ["-", "~"],
@@ -281,7 +276,6 @@ def test_line_wrapping(self):
         output = render_fragments(
             template,
             None,
-            "",
             fragments,
             definitions,
             ["-", "~"],
@@ -333,38 +327,10 @@ def test_line_wrapping_disabled(self):
         output = render_fragments(
             template,
             None,
-            "",
             fragments,
             definitions,
             ["-", "~"],
             wrap=False,
             versiondata={"name": "MyProject", "version": "1.0", "date": "never"},
         )
         self.assertEqual(output, expected_output)
-
-    def test_title_format_specified(self):
-        """
-        Title format replaces default top line rendering.
-        """
-        template = pkg_resources.resource_string(
-            "towncrier", "templates/default.rst"
-        ).decode("utf8")
-
-        fragments = split_fragments(fragments={}, definitions=OrderedDict())
-        output = render_fragments(
-            template=template,
-            issue_format=None,
-            top_line="A custom top line",
-            fragments=fragments,
-            definitions=OrderedDict(),
-            underlines=["-", "~"],
-            wrap=False,
-            versiondata={"name": "MyProject", "version": "1.0", "date": "never"},
-        )
-
-        expected_output = dedent(u"""\
-        A custom top line
-        =================
-        """)
-
-        self.assertEqual(expected_output, output)

src/towncrier/test/test_write.py

@@ -99,7 +99,6 @@ def test_append_at_top(self):
             render_fragments(
                 template,
                 None,
-                "",
                 fragments,
                 definitions,
                 ["-", "~"],
@@ -214,7 +213,6 @@ def test_append_at_top_with_hint(self):
             render_fragments(
                 template,
                 None,
-                "",
                 fragments,
                 definitions,
                 ["-", "~"],
@@ -246,7 +244,6 @@ def test_multiple_file_no_start_string(self):
         content = render_fragments(
             template=template,
             issue_format=None,
-            top_line="",
             fragments=fragments,
             definitions=definitions,
             underlines=["-", "~"],