klmp200/Sith
1
0
Fork 0
mirror of https://github.com/ae-utbm/sith.git synced 2024-11-22 14:13:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

core: add test for Markdown syntax

Browse Source 
Signed-off-by: Skia <skia@libskia.so>
This commit is contained in:
Skia 2017-08-24 16:29:40 +02:00
parent 30f650ecce
commit 0d5595c683
8 changed files with 350 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -71,5 +71,13 @@ appropriate group fields, or the right method to check user permissions.
$ cloc --exclude-dir=doc,env . $ cloc --exclude-dir=doc,env .
``` ```
#### Updating doc/SYNTAX.md
If you make an update in the Markdown syntax parser, it's good to document
update the syntax reference page in `doc/SYNTAX.md`. But updating this file will
break the tests if you don't update the corresponding `doc/SYNTAX.html` file at
the same time.
To do that, simply run `./manage.py markdown > doc/SYNTAX.html`,
and the tests should pass again.

4
core/apps.py
View File

@ -22,6 +22,8 @@
# #
# #
import sys
from django.apps import AppConfig from django.apps import AppConfig
from django.core.signals import request_started from django.core.signals import request_started
@ -44,7 +46,7 @@ class SithConfig(AppConfig):
Club._memberships = {} Club._memberships = {}
Forum._club_memberships = {} Forum._club_memberships = {}
print("Connecting signals!") print("Connecting signals!", file=sys.stderr)
request_started.connect(clear_cached_groups, weak=False, dispatch_uid="clear_cached_groups") request_started.connect(clear_cached_groups, weak=False, dispatch_uid="clear_cached_groups")
request_started.connect(clear_cached_memberships, weak=False, dispatch_uid="clear_cached_memberships") request_started.connect(clear_cached_memberships, weak=False, dispatch_uid="clear_cached_memberships")
# TODO: there may be a need to add more cache clearing # TODO: there may be a need to add more cache clearing

37
core/management/commands/markdown.py Normal file
View File

@ -0,0 +1,37 @@
# -*- coding:utf-8 -*
#
# Copyright 2017
# - Skia <skia@libskia.so>
#
# Ce fichier fait partie du site de l'Association des Étudiants de l'UTBM,
# http://ae.utbm.fr.
#
# This program is free software; you can redistribute it and/or modify it under
# the terms of the GNU General Public License a published by the Free Software
# Foundation; either version 3 of the License, or (at your option) any later
# version.
#
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
# details.
#
# You should have received a copy of the GNU General Public License along with
# this program; if not, write to the Free Sofware Foundation, Inc., 59 Temple
# Place - Suite 330, Boston, MA 02111-1307, USA.
#
#
import os
from django.core.management.base import BaseCommand
from core.markdown import markdown
class Command(BaseCommand):
help = "Output the fully rendered doc/SYNTAX.md file"
def handle(self, *args, **options):
root_path = os.path.dirname(os.path.dirname(os.path.dirname(os.path.dirname(__file__))))
with open(os.path.join(root_path) + '/doc/SYNTAX.md', 'r') as md:
result = markdown(md.read())
print(result, end='')

43
core/markdown.py
View File

@ -22,6 +22,7 @@
# #
# #
import os
import re import re
from mistune import Renderer, InlineGrammar, InlineLexer, Markdown, escape, escape_link from mistune import Renderer, InlineGrammar, InlineLexer, Markdown, escape, escape_link
from django.core.urlresolvers import reverse from django.core.urlresolvers import reverse
@ -192,41 +193,7 @@ inline = SithInlineLexer(renderer)
markdown = Markdown(renderer, inline=inline) markdown = Markdown(renderer, inline=inline)
if __name__ == "__main__": if __name__ == "__main__":
print(markdown.inline.default_rules) root_path = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
print(markdown.inline.inline_html_rules) with open(os.path.join(root_path) + '/doc/SYNTAX.md', 'r') as md:
text = """ result = markdown(md.read())
## Basique print(result, end='')
* Mettre le texte en **gras** : `**texte**`
* Mettre le texte en *italique* : `*texte*`
* __Souligner__ le texte : `__texte__`
* ~~Barrer du texte~~ : `~~texte~~`
* Mettre ^du texte^ en ^exposant^ : `^mot` ou `^texte^`
* _Mettre du texte_ en _indice_ : `_mot` ou `_texte_`
* Pied de page [^en pied de page]
## Blocs de citations
Un bloc de citation se crée ainsi :
```
> Ceci est
> un bloc de
> citation
```
> Ceci est
> un bloc de
> citation
Il est possible d'intégrer de la syntaxe Markdown-AE dans un tel bloc.
Petit *test* _sur_ ^une^ **seule** ^ligne pour voir^
"""
print(markdown(text))

12
core/tests.py
View File

@ -22,11 +22,14 @@
# #
# #
import os
from django.test import Client, TestCase from django.test import Client, TestCase
from django.core.urlresolvers import reverse from django.core.urlresolvers import reverse
from django.core.management import call_command from django.core.management import call_command
from core.models import User, Group, Page from core.models import User, Group, Page
from core.markdown import markdown
""" """
to run these tests : to run these tests :
@ -185,6 +188,15 @@ class UserRegistrationTest(TestCase):
self.assertTrue(response.status_code == 200) self.assertTrue(response.status_code == 200)
self.assertTrue("""<p>Votre nom d\\'utilisateur et votre mot de passe ne correspondent pas. Merci de r\\xc3\\xa9essayer.</p>""" in str(response.content)) self.assertTrue("""<p>Votre nom d\\'utilisateur et votre mot de passe ne correspondent pas. Merci de r\\xc3\\xa9essayer.</p>""" in str(response.content))
class MarkdownTest(TestCase):
def test_full_markdown_syntax(self):
root_path = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
with open(os.path.join(root_path) + '/doc/SYNTAX.md', 'r') as md_file:
md = md_file.read()
with open(os.path.join(root_path) + '/doc/SYNTAX.html', 'r') as html_file:
html = html_file.read()
result = markdown(md)
self.assertTrue(result == html)
class PageHandlingTest(TestCase): class PageHandlingTest(TestCase):
def setUp(self): def setUp(self):

206
doc/SYNTAX.html Normal file
View File

@ -0,0 +1,206 @@
<p>Cette page vise à documenter la syntaxe <em>Markdown</em> utilisée sur le site.</p>
<h1>Markdown-AE Documentation</h1>
<p>Le Markdown le plus standard se trouve documenté ici:
<a href="https://daringfireball.net/projects/markdown/syntax">https://daringfireball.net/projects/markdown/syntax</a> .<br>
Si cette page n'est pas exhaustive vis à vis de la syntaxe du site AE,
elle a au moins le mérite de bien documenter le Markdown original.</p>
<p>Le réel parseur du site AE est une version tunée de <a href="https://github.com/lepture/mistune">mistune</a>.<br>
Les plus aventureux pourront aller lire ses <a href="https://github.com/lepture/mistune/blob/master/tests/fixtures">tests</a>
afin d'en connaître la syntaxe le plus finement possible.<br>
En pratique, cette page devrait déjà résumer une bonne partie.</p>
<h2>Basique</h2>
<ul>
<li><p>Mettre le texte en <strong>gras</strong> : <code>**texte**</code></p>
</li>
<li><p>Mettre le texte en <em>italique</em> : <code>*texte*</code></p>
</li>
<li><p><u>Souligner</u> le texte : <code>__texte__</code></p>
</li>
<li><p><del>Barrer du texte</del> : <code>~~texte~~</code></p>
</li>
<li><p>On peut bien sûr tout <del><strong><em><u>combiner</u></em></strong></del> : <code>~~***__texte__***~~</code></p>
</li>
<li><p><sup>Mettre du texte</sup> en exposant : <code>&lt;sup&gt;texte&lt;/sup&gt;</code></p>
</li>
<li><p><sub>Mettre du texte</sub> en indice : <code>&lt;sub&gt;texte&lt;/sub&gt;</code></p>
</li>
</ul>
<h2>Liens</h2>
<ul>
<li>Les liens simples sont détectés automatiquement : <code>http://www.site.com</code></li>
</ul>
<p><a href="http://www.site.com">http://www.site.com</a></p>
<ul>
<li>Il est possible de nommer son lien : <code>[nom du lien](http://www.site.com)</code></li>
</ul>
<p><a href="http://www.site.com">nom du lien</a></p>
<ul>
<li>Les liens peuvent être internes au site de l'AE, on peut dès lors éviter d'entrer
l'adresse complète d'une page : <code>[nom du lien](page://nomDeLaPage)</code></li>
</ul>
<p><a href="/page/nomDeLaPage/">nom du lien</a></p>
<ul>
<li>On peut également utiliser une image pour les liens :
<code>[nom du lien]![images/imageDuSiteAE.png](/chemin/vers/image.png titre optionnel)(options)</code></li>
</ul>
<p>[nom du lien]<img src="/chemin/vers/image.png titre optionnel" alt="images/imageDuSiteAE.png">(options)</p>
<h2>Titres</h2>
<ul>
<li>Plusieurs niveaux de titres sont possibles</li>
</ul>
<pre><code># Titre de niveau 1
## Titre de niveau 2
### Titre de niveau 3
etc...
</code></pre>
<h1>Titre de niveau 1</h1>
<h2>Titre de niveau 2</h2>
<h3>Titre de niveau 3</h3>
<p>Si le titre de votre section commence par un tilde (~) alors le texte sous la section est
affiché par défaut caché et il est consultable grace à un bouton +/-</p>
<h2>~Test</h2>
<h2>Paragraphes et sauts de ligne</h2>
<p>Un nouveau paragraphe se fait avec deux retours à la ligne.</p>
<p>Un saut de ligne se force avec au moins deux espaces en fin de ligne.</p>
<h2>Listes</h2>
<p>Il est possible de créer des listes :</p>
<ul>
<li>ordonnées :</li>
</ul>
<pre><code>1. élément
2. élément
3. élément
</code></pre>
<ol>
<li>élément</li>
<li>élément</li>
<li>élément</li>
</ol>
<p>Vous pouvez marquer plus simplement comme suit, les numéros se faisant tout seuls:</p>
<pre><code>1. élément
1. élément
1. élément
</code></pre>
<ol>
<li>élément</li>
<li>élément</li>
<li>élément</li>
</ol>
<ul>
<li>non ordonnées :</li>
</ul>
<pre><code> * élément
* élément
* élément
</code></pre>
<ul>
<li>élément</li>
<li>élément</li>
<li>élément</li>
</ul>
<h2>Tableaux</h2>
<p>Un tableau est obtenu en respectant la syntaxe suivante :</p>
<pre><code>| Titre | Titre2 | Titre3 |
|-------|--------|--------|
| test | test | test |
| test | test | test |
</code></pre>
<table>
<thead><tr>
<th>Titre</th>
<th>Titre2</th>
<th>Titre3</th>
</tr>
</thead>
<tbody>
<tr>
<td>test</td>
<td>test</td>
<td>test</td>
</tr>
<tr>
<td>test</td>
<td>test</td>
<td>test</td>
</tr>
</tbody>
</table>
<p>L'alignement dans les cellules est géré comme suit, avec les ':' sur la ligne en dessous du titre:</p>
<pre><code>| Titre | Titre2 | Titre3 |
|:-------|:------:|-------:|
| gauche | centre | droite |
</code></pre>
<table>
<thead><tr>
<th style="text-align:left">Titre</th>
<th style="text-align:center">Titre2</th>
<th style="text-align:right">Titre3</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left">gauche</td>
<td style="text-align:center">centre</td>
<td style="text-align:right">droite</td>
</tr>
</tbody>
</table>
<h2>Images et contenus</h2>
<p>Une image est insérée ainsi : <code>![texte alternatif](/chemin/vers/image.png "titre optionnel")</code>
<img src="/static/core/img/logo.png" alt="texte alternatif" title="titre optionnel"></p>
<p>On peut lui spécifier ses dimensions de plusieurs manières:</p>
<pre><code>![image à 50%](/static/core/img/logo.png?50% "Image à 50%")
![image de 350 pixels de large](/static/core/img/logo.png?350 "Image de 350 pixels")
![image de 350x100 pixels](/static/core/img/logo.png?350x100 "Image de 350x100 pixels")
</code></pre>
<p><img src="/static/core/img/logo.png" alt="image à 50%" title="Image à 50%" style="width: 50%; "><br>
Image à 50% de la largeur de la page.</p>
<p><img src="/static/core/img/logo.png" alt="image de 350 pixels de large" title="Image de 350 pixels" style="width: 350px; "><br>
Image de 350 pixels de large.</p>
<p><img src="/static/core/img/logo.png" alt="image de 350x100 pixels" title="Image de 350x100 pixels" style="width: 350px; height: 100px; "><br>
Image de 350x100 pixels.</p>
<p>( devrait pouvoir détecter si vidéo ou non )</p>
<h2>Blocs de citations</h2>
<p>Un bloc de citation se crée ainsi :</p>
<pre><code>&gt; Ceci est
&gt; un bloc de
&gt; citation
</code></pre>
<blockquote><p>Ceci est
un bloc de
citation</p>
</blockquote>
<p>Il est possible d'intégrer de la syntaxe Markdown-AE dans un tel bloc.</p>
<h2>Note de bas de page</h2>
<p>On les créer comme ça<sup class="footnote-ref" id="fnref-key"><a href="#fn-key" rel="footnote">1</a></sup>:</p>
<h2>échapper des caractères</h2>
<ul>
<li>Il est possible d'ignorer un caractère spécial en l'échappant à l'aide d'un \</li>
<li>L'échappement de blocs de codes complet se fera à l'aide de balises &lt;nosyntax&gt;&lt;/nosyntax&gt;</li>
</ul>
<h2>Autres ( hérité de l'ancien wiki )</h2>
<ul>
<li>Une ligne peut être crée avec une ligne contenant 4 tirets ( - ).</li>
<li>Une barre de progression est crée ainsi :<blockquote><p>[[[70]]]</p>
</blockquote>
</li>
<li>Notes en pied de page :<blockquote><p>((note))</p>
</blockquote>
</li>
</ul>
<div class="footnotes">
<hr>
<ol><li id="fn-key"><p>ceci est le contenu de ma clef</p>
<pre><code>Je fais une note[^clef].
[^clef]: je note ensuite ou je veux le contenu de ma clef qui apparaîtra quand même en bas
</code></pre>
<p>Vous pouvez utiliser des numéros pour nommer vos clef si vous avez la flemme.</p>
<pre><code>Note plus complexe[^1]
[^1]:
je peux même faire des blocks
sur plusieurs lignes, comme d'habitude!
</code></pre><p><a href="#fnref-key" rev="footnote">&#8617;</a></p></li>
</ol>
</div>

83
doc/SYNTAX.md
View File

@ -2,6 +2,15 @@ Cette page vise à documenter la syntaxe *Markdown* utilisée sur le site.
# Markdown-AE Documentation # Markdown-AE Documentation
Le Markdown le plus standard se trouve documenté ici:
https://daringfireball.net/projects/markdown/syntax .
Si cette page n'est pas exhaustive vis à vis de la syntaxe du site AE,
elle a au moins le mérite de bien documenter le Markdown original.
Le réel parseur du site AE est une version tunée de [mistune](https://github.com/lepture/mistune).
Les plus aventureux pourront aller lire ses [tests](https://github.com/lepture/mistune/blob/master/tests/fixtures)
afin d'en connaître la syntaxe le plus finement possible.
En pratique, cette page devrait déjà résumer une bonne partie.
## Basique ## Basique
@ -13,10 +22,11 @@ Cette page vise à documenter la syntaxe *Markdown* utilisée sur le site.
* ~~Barrer du texte~~ : `~~texte~~` * ~~Barrer du texte~~ : `~~texte~~`
* ^Mettre du texte^ en ^exposant : `^mot` ou `^texte^` * On peut bien sûr tout ~~***__combiner__***~~ : `~~***__texte__***~~`
* _Mettre du texte_ en _indice : `_mot` ou `_texte_` * <sup>Mettre du texte</sup> en exposant : `<sup>texte</sup>`
* <sub>Mettre du texte</sub> en indice : `<sub>texte</sub>`
## Liens ## Liens
@ -30,9 +40,9 @@ http://www.site.com
[nom du lien](http://www.site.com) [nom du lien](http://www.site.com)
* Les liens peuvent être internes au site de l'AE, on peut dès lors éviter d'entrer * Les liens peuvent être internes au site de l'AE, on peut dès lors éviter d'entrer
l'adresse complète d'une page : `[nom du lien](article://nomDeLaPage)` l'adresse complète d'une page : `[nom du lien](page://nomDeLaPage)`
[nom du lien](article://nomDeLaPage) [nom du lien](page://nomDeLaPage)
* On peut également utiliser une image pour les liens : * On peut également utiliser une image pour les liens :
`[nom du lien]![images/imageDuSiteAE.png](/chemin/vers/image.png titre optionnel)(options)` `[nom du lien]![images/imageDuSiteAE.png](/chemin/vers/image.png titre optionnel)(options)`
@ -58,6 +68,14 @@ etc...
Si le titre de votre section commence par un tilde (~) alors le texte sous la section est Si le titre de votre section commence par un tilde (~) alors le texte sous la section est
affiché par défaut caché et il est consultable grace à un bouton +/- affiché par défaut caché et il est consultable grace à un bouton +/-
## ~Test
## Paragraphes et sauts de ligne
Un nouveau paragraphe se fait avec deux retours à la ligne.
Un saut de ligne se force avec au moins deux espaces en fin de ligne.
## Listes ## Listes
@ -81,7 +99,13 @@ Vous pouvez marquer plus simplement comme suit, les numéros se faisant tout seu
1. élément 1. élément
``` ```
1. élément
1. élément
1. élément
* non ordonnées : * non ordonnées :
``` ```
* élément * élément
* élément * élément
@ -94,7 +118,7 @@ Vous pouvez marquer plus simplement comme suit, les numéros se faisant tout seu
## Tableaux ## Tableaux
Un tableau est obtenu en respectant la syntax suivante : Un tableau est obtenu en respectant la syntaxe suivante :
``` ```
| Titre | Titre2 | Titre3 | | Titre | Titre2 | Titre3 |
@ -107,25 +131,42 @@ Un tableau est obtenu en respectant la syntax suivante :
| test | test | test | | test | test | test |
| test | test | test | | test | test | test |
L'alignement dans les cellules est géré en mettant des espaces à droite ou a gauche des chaines de caractères contenues dans chaque case. L'alignement dans les cellules est géré comme suit, avec les ':' sur la ligne en dessous du titre:
``` ```
| Titre | Titre2 | Titre3 | | Titre | Titre2 | Titre3 |
|-------|--------|--------| |:-------|:------:|-------:|
| gauche | centre | droite | | gauche | centre | droite |
``` ```
| Titre | Titre2 | Titre3 | | Titre | Titre2 | Titre3 |
|-------|--------|--------| |:-------|:------:|-------:|
| gauche | centre | droite | | gauche | centre | droite |
## Images et contenus ## Images et contenus
Une image est insérée ainsi : `![texte alternatif](/chemin/vers/image.png "titre optionnel")(options)` Une image est insérée ainsi : `![texte alternatif](/chemin/vers/image.png "titre optionnel")`
![texte alternatif](/static/core/img/logo.png "titre optionnel")(options) ![texte alternatif](/static/core/img/logo.png "titre optionnel")
On peut lui spécifier ses dimensions de plusieurs manières:
```
![image à 50%](/static/core/img/logo.png?50% "Image à 50%")
![image de 350 pixels de large](/static/core/img/logo.png?350 "Image de 350 pixels")
![image de 350x100 pixels](/static/core/img/logo.png?350x100 "Image de 350x100 pixels")
```
![image à 50%](/static/core/img/logo.png?50% "Image à 50%")
Image à 50% de la largeur de la page.
![image de 350 pixels de large](/static/core/img/logo.png?350 "Image de 350 pixels")
Image de 350 pixels de large.
![image de 350x100 pixels](/static/core/img/logo.png?350x100 "Image de 350x100 pixels")
Image de 350x100 pixels.
( devrait pouvoir détecter si vidéo ou non ) ( devrait pouvoir détecter si vidéo ou non )
( TODO : parametres )
## Blocs de citations ## Blocs de citations
@ -142,7 +183,26 @@ Un bloc de citation se crée ainsi :
Il est possible d'intégrer de la syntaxe Markdown-AE dans un tel bloc. Il est possible d'intégrer de la syntaxe Markdown-AE dans un tel bloc.
## Note de bas de page
On les créer comme ça[^key]:
[^key]: ceci est le contenu de ma clef
```
Je fais une note[^clef].
[^clef]: je note ensuite ou je veux le contenu de ma clef qui apparaîtra quand même en bas
```
Vous pouvez utiliser des numéros pour nommer vos clef si vous avez la flemme.
```
Note plus complexe[^1]
[^1]:
je peux même faire des blocks
sur plusieurs lignes, comme d'habitude!
```
## échapper des caractères ## échapper des caractères
@ -160,3 +220,4 @@ Il est possible d'intégrer de la syntaxe Markdown-AE dans un tel bloc.
> ((note)) > ((note))

5
sith/settings.py
View File

@ -36,6 +36,7 @@ https://docs.djangoproject.com/en/1.8/ref/settings/
# Build paths inside the project like this: os.path.join(BASE_DIR, ...) # Build paths inside the project like this: os.path.join(BASE_DIR, ...)
import os import os
import sys
import binascii import binascii
from django.utils.translation import ugettext_lazy as _ from django.utils.translation import ugettext_lazy as _
@ -569,9 +570,9 @@ SITH_MAILING_FETCH_KEY = 'IloveMails'
try: try:
from .settings_custom import * from .settings_custom import *
print("Custom settings imported") print("Custom settings imported", file=sys.stderr)
except: except:
print("Custom settings failed") print("Custom settings failed", file=sys.stderr)
if DEBUG: if DEBUG:
INSTALLED_APPS += ("debug_toolbar",) INSTALLED_APPS += ("debug_toolbar",)