Add setext heading

src/synthale/markdown.py

@@ -0,0 +1,19 @@
+"""This module contains functions to generate markdown elements."""
+
+
+def setext_heading(text, level):
+    """Return an setext heading.
+
+    `text` is the text to include in the heading. Leading and trailing
+    whitespace is trimmed from `text`. If `level` is the number `1`, a first
+    level (h1) heading is returned. If `level` is the number `2` (or anything
+    else), a second level (h2) heading is returned.
+
+    See https://github.github.com/gfm/#setext-heading for more information.
+    """
+    if level == 1:
+        hchar = '='
+    else:
+        hchar = '-'
+
+    return '{}\n{}'.format(text.strip(), hchar * len(text.strip()))

src/synthale/recipes.py

@@ -6,6 +6,8 @@ import sys
 
 import pybeerxml
 
+from synthale import markdown
+
 
 class MarkdownRecipe:
     """A recipe in markdown form."""
@@ -36,7 +38,7 @@ class MarkdownRecipe:
     @property
     def markdown(self):
         """Return generated markdown for the recipe."""
-        return ''
+        return markdown.setext_heading(self.recipe.name, 1)
 
 
 def load_file(path):

tests/test_markdown.py

@@ -0,0 +1,14 @@
+"""Contains tests for the synthale.markdown module."""
+import pytest
+
+from synthale import markdown
+
+
+@pytest.mark.parametrize('text,level,expected', [
+    ('test', 1, 'test\n===='),
+    ('foobar', 2, 'foobar\n------'),
+    (' test ', None, 'test\n----')
+])
+def test_setext_heading(text, level, expected):
+    """Test for valid setext headings from setext_heading function."""
+    assert markdown.setext_heading(text, level) == expected

tests/test_recipes.py

@@ -36,5 +36,7 @@ def test_markdown_recipe_filename():
 
 def test_markdown_recipe_markdown():
     """Validate the generated markdown."""
-    recipe = MarkdownRecipe(None)
+    xml_recipe = pybeerxml.Recipe()
-    assert recipe.markdown == ''
+    xml_recipe.name = 'Foobar'
+    recipe = MarkdownRecipe(xml_recipe)
+    assert recipe.markdown == 'Foobar\n======'