Validate that a blog post has the minimum required fields.

handroll · Jul 21, 2015 · 73565fc · 73565fc
1 parent 238587b
commit 73565fc
Show file tree

Hide file tree

Showing 3 changed files with 53 additions and 5 deletions.
diff --git a/handroll/extensions/blog.py b/handroll/extensions/blog.py
@@ -81,7 +81,7 @@ def on_frontmatter_loaded(self, source_file, frontmatter):
         """Record any new blog posts."""
         if not self._is_post(frontmatter):
             return
-        # TODO: Validate that the post has the required fields.
+        self._validate_post(source_file, frontmatter)
         post = BlogPost(
             date=frontmatter['date'],
             source_file=source_file,
@@ -114,6 +114,20 @@ def _is_post(self, frontmatter):
                   '{blog_value}').format(blog_value=is_post))
         return is_post
 
+    def _validate_post(self, source_file, frontmatter):
+        """Validate that the post contains all the required fields."""
+        required = set([
+            'date',
+            'title',
+        ])
+        fields = set(frontmatter.keys())
+        missing = required - fields
+        if missing:
+            raise AbortError(_(
+                'The blog post, {filename}, '
+                'is missing required fields: {missing_fields}'.format(
+                    filename=source_file, missing_fields=', '.join(missing))))
+
     def _generate_atom_feed(self, director, blog_posts):
         """Generate the atom feed."""
         logger.info(_('Generating Atom XML feed ...'))

diff --git a/handroll/locale/handroll.pot b/handroll/locale/handroll.pot
@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: handroll 1.6\n"
 "Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
-"POT-Creation-Date: 2015-07-13 20:29-0400\n"
+"POT-Creation-Date: 2015-07-21 11:36-0400\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
@@ -171,15 +171,19 @@ msgstr ""
 msgid "Invalid blog frontmatter (expects True or False): {blog_value}"
 msgstr ""
 
-#: handroll/extensions/blog.py:119
+#: handroll/extensions/blog.py:129
+msgid "The blog post, {filename}, is missing required fields: {missing_fields}"
+msgstr ""
+
+#: handroll/extensions/blog.py:133
 msgid "Generating Atom XML feed ..."
 msgstr ""
 
-#: handroll/extensions/blog.py:127
+#: handroll/extensions/blog.py:141
 msgid "Generating blog list page ..."
 msgstr ""
 
-#: handroll/extensions/blog.py:144
+#: handroll/extensions/blog.py:158
 msgid "The blog extension requires the {option} option."
 msgstr ""
 

diff --git a/handroll/tests/test_blog_extension.py b/handroll/tests/test_blog_extension.py
@@ -319,6 +319,36 @@ def test_same_post_does_not_signal_generation(self):
         extension.on_frontmatter_loaded('thundercats.md', frontmatter)
         self.assertFalse(extension._should_generate)
 
+    def test_post_requires_date(self):
+        extension = self._make_preprocessed_one()
+        frontmatter = self._make_blog_post_frontmatter()
+        del frontmatter['date']
+        try:
+            extension.on_frontmatter_loaded('thundercats.md', frontmatter)
+            self.fail()
+        except AbortError as ae:
+            self.assertTrue('date' in str(ae))
+
+    def test_post_requires_title(self):
+        extension = self._make_preprocessed_one()
+        frontmatter = self._make_blog_post_frontmatter()
+        del frontmatter['title']
+        try:
+            extension.on_frontmatter_loaded('thundercats.md', frontmatter)
+            self.fail()
+        except AbortError as ae:
+            self.assertTrue('title' in str(ae))
+
+    def test_post_requires_error_includes_post_filename(self):
+        extension = self._make_preprocessed_one()
+        frontmatter = self._make_blog_post_frontmatter()
+        del frontmatter['title']
+        try:
+            extension.on_frontmatter_loaded('thundercats.md', frontmatter)
+            self.fail()
+        except AbortError as ae:
+            self.assertTrue('thundercats.md' in str(ae))
+
 
 class TestBlogBuilder(TestCase):