Review `base` application

Remove unnecessar comments
Refactor small pieces of code
Add `tests.py` for Markdown -> HTML conversio
This commit is contained in:
Fred Pauchet 2020-10-20 11:27:08 +02:00
parent 76306d0e79
commit 75c234be4b
2 changed files with 24 additions and 11 deletions

View File

@ -1,8 +1,13 @@
"""Ensemble des classes d'utilité publique :-)"""
from django.db import models
import markdown
class Markdownizable(models.Model):
"""Classe abstraite ajoutant un champ `information`, convertible de .md -> .html."""
class Meta:
abstract = True
@ -14,14 +19,6 @@ class Markdownizable(models.Model):
)
def to_markdown(self):
"""
Convertit le commentaire associé au `skill` en (Github-flavored) Markdown.
"""
# parser = CommonMark.DocParser()
# ast = parser.parse(self.information)
html = markdown.markdown(self.information)
return html
# return CommonMark.HTMLRenderer().render(ast)
"""Convertit le champ `information` en (Github-flavored) Markdown."""
return markdown.markdown(self.information)

16
src/base/tests.py Normal file
View File

@ -0,0 +1,16 @@
"""Tests associés à la conversion de contenu Markdown en HTML."""
from django.test import TestCase
from .models import Markdownizable
class TestMarkdownizable(TestCase):
"""Vérifie les fonctionnalités associées à la classe Markdownizable.
"""
def test_to_markdown(self):
"""Vérifie qu'un contenu Markdown est correctement convertit en HTML."""
m = Markdownizable(information="# Title")
self.assertEqual(m.to_markdown(), "<h1>Title</h1>")