Merge branch 'master' into errors

examples/example-all.yaml.sb

@@ -0,0 +1,17 @@
+bookoptions: 
+  - "diagram"
+  - "repeatchords"
+  - "lilypond"
+  - "pictures"
+booktype: "chorded"
+datadir: "."
+template: "patacrep.tex"
+lang: "fr"
+encoding: "utf8"
+authwords: 
+  sep: 
+    - "and"
+    - "et"
+content: 
+  - 
+    - "sorted"

patacrep/__init__.py

@@ -1,10 +1,11 @@
 """Global variables."""
 
-from pkg_resources import resource_filename
 import os
+import sys
+
+from pkg_resources import resource_filename
 
 # Check Python version
-import sys
 if sys.version_info < (3, 3):
     print("ERROR: Your Python version is too old. Please use a Python version > 3.3.")
     sys.exit(1)

patacrep/build.py

@@ -11,7 +11,7 @@ from subprocess import Popen, PIPE, call, check_call
 from patacrep import authors, content, errors, files
 from patacrep.index import process_sxd
 from patacrep.templates import TexBookRenderer
-from patacrep.songs import DataSubpath
+from patacrep.songs import DataSubpath, DEFAULT_CONFIG
 
 LOGGER = logging.getLogger(__name__)
 EOL = "\n"
@@ -27,14 +27,6 @@ GENERATED_EXTENSIONS = [
     "_title.sbx",
     "_title.sxd",
     ]
-DEFAULT_CONFIG = {
-    'template': "default.tex",
-    'lang': 'en',
-    'content': [],
-    'titleprefixwords': [],
-    'encoding': None,
-    'datadir': [],
-    }
 
 
 
@@ -49,6 +41,7 @@ class Songbook:
 
     def __init__(self, raw_songbook, basename):
         self._raw_config = raw_songbook
+        self.config = raw_songbook
         self.basename = basename
         self._errors = list()
         self._config = dict()
@@ -142,6 +135,10 @@ class Songbook:
                 continue
             yield from item.iter_errors()
 
+    def requires_lilypond(self):
+        """Tell if lilypond is part of the bookoptions"""
+        return 'lilypond' in self.config.get('bookoptions', [])
+
 def _log_pipe(pipe):
     """Log content from `pipe`."""
     while 1:
@@ -243,9 +240,23 @@ class SongbookBuilder:
                 stderr=PIPE,
                 universal_newlines=True,
                 )
-        except Exception as error:
+        except FileNotFoundError as error:
             raise errors.ExecutableNotFound(compiler)
 
+        # Test if lilypond compiler is accessible
+        if self.songbook.requires_lilypond():
+            lilypond_compiler = 'lilypond'
+            try:
+                check_call(
+                    [lilypond_compiler, "--version"],
+                    stdin=PIPE,
+                    stdout=PIPE,
+                    stderr=PIPE,
+                    universal_newlines=True,
+                    )
+            except FileNotFoundError as error:
+                raise errors.ExecutableNotFound(lilypond_compiler)
+
         # Perform compilation
         try:
             process = Popen(

patacrep/content/__init__.py

@@ -66,12 +66,13 @@ More documentation in the docstring of ContentItem.
 """
 
 import glob
-import jinja2
 import logging
 import os
 import re
 import sys
 
+import jinja2
+
 from patacrep import files
 from patacrep.errors import SharedError
 
@@ -123,7 +124,7 @@ class ContentItem:
 class ContentError(SharedError):
     """Error in a content plugin."""
     def __init__(self, keyword=None, message=None):
-        super(ContentError, self).__init__()
+        super().__init__()
         self.keyword = keyword
         self.message = message
 
@@ -217,14 +218,12 @@ def process_content(content, config=None):
     """
     contentlist = ContentList()
     plugins = config.get('_content_plugins', {})
-    keyword_re = re.compile(r'^ *(?P<keyword>\w*) *(\((?P<argument>.*)\))? *$')
+    keyword_re = re.compile(r'^ *(?P<keyword>[\w\*]*) *(\((?P<argument>.*)\))? *$')
     if not content:
         content = [["song"]]
     for elem in content:
         if isinstance(elem, str):
             elem = ["song", elem]
-        if len(content) == 0:
-            content = ["song"]
         try:
             match = keyword_re.match(elem[0]).groupdict()
         except AttributeError:

patacrep/content/cwd.py

@@ -25,8 +25,7 @@ def parse(keyword, config, argument, contentlist):
     old_songdir = config['_songdir']
     config['_songdir'] = (
         [DataSubpath(".", argument)] +
-        [path.clone().join(argument) for path in config['_songdir']] +
-        config['_songdir']
+        [path.clone().join(argument) for path in config['_songdir']]
         )
     processed_content = process_content(contentlist, config)
     config['_songdir'] = old_songdir

patacrep/content/section.py

@@ -37,8 +37,8 @@ def parse(keyword, argument, contentlist, config):
       their starred versions "part*", "chapter*", ... , "subparagraph*"): the
       section to use;
     - argument: unused;
-    - contentlist: a list of one or two strings, which are the names (short
-      and long) of the section;
+    - contentlist: a list of one or two strings, which are the names (long
+      and short) of the section;
     - config: configuration dictionary of the current songbook.
     """
     try:

patacrep/content/song.py

@@ -1,11 +1,12 @@
 """Plugin to include songs to the songbook."""
 
 import glob
-import jinja2
 import logging
 import os
 import textwrap
 
+import jinja2
+
 from patacrep.content import process_content
 from patacrep.content import ContentError, ContentItem, ContentList
 from patacrep import files, errors
@@ -83,6 +84,8 @@ def parse(keyword, argument, contentlist, config):
             if not os.path.isdir(songdir.datadir):
                 continue
             with files.chdir(songdir.datadir):
+                # Starting with Python 3.5 glob can be recursive: **/*.csg for instance
+                # for filename in glob.iglob(os.path.join(songdir.subpath, elem), recursive=True):
                 for filename in glob.iglob(os.path.join(songdir.subpath, elem)):
                     LOGGER.debug('Parsing file "{}"…'.format(filename))
                     extension = filename.split(".")[-1]

patacrep/content/sorted.py

@@ -9,8 +9,9 @@ import logging
 import unidecode
 
 from patacrep import files
-from patacrep.content import ContentError, ContentList
-from patacrep.content.song import OnlySongsError, process_songs
+from patacrep.content import ContentError, ContentList, EmptyContentList
+from patacrep.content import process_content
+from patacrep.content.song import OnlySongsError
 
 LOGGER = logging.getLogger(__name__)
 
@@ -83,9 +84,9 @@ def parse(keyword, config, argument, contentlist):
     else:
         sort = DEFAULT_SORT
     try:
-        songlist = process_songs(contentlist, config)
+        songlist = process_content(contentlist, config)
     except OnlySongsError as error:
-        return EmptyContentError(errors=[ContentError(keyword, (
+        return EmptyContentList(errors=[ContentError(keyword, (
             "Content list of this keyword can be only songs (or content "
             "that result into songs), and the following are not:" +
             str(error.not_songs)

patacrep/errors.py

@@ -11,7 +11,7 @@ class SBFileError(SongbookError):
     """Error during songbook file decoding"""
 
     def __init__(self, message=None):
-        super(SBFileError, self).__init__()
+        super().__init__()
         self.message = message
 
     def __str__(self):
@@ -21,7 +21,7 @@ class TemplateError(SongbookError):
     """Error during template generation"""
 
     def __init__(self, original, message=None):
-        super(TemplateError, self).__init__()
+        super().__init__()
         self.original = original
         self.message = message
 
@@ -35,7 +35,7 @@ class ExecutableNotFound(SongbookError):
     """Couldn't find a LaTeX executable."""
 
     def __init__(self, executable):
-        super(ExecutableNotFound, self).__init__(
+        super().__init__(
             (
                 """Could not find the following executable: {executable}"""
                 ).format(executable=executable)
@@ -45,7 +45,7 @@ class StepError(SongbookError):
     """Error during execution of one compilation step."""
 
     def __init__(self, message):
-        super(StepError, self).__init__()
+        super().__init__()
         self.message = message
 
     def __str__(self):
@@ -55,7 +55,7 @@ class LatexCompilationError(StepError):
     """Error during LaTeX compilation."""
 
     def __init__(self, basename):
-        super(LatexCompilationError, self).__init__(
+        super().__init__(
             (
                 """Error while LaTeX compilation of "{basename}.tex" """
                 """(see {basename}.log for more information)."""
@@ -66,7 +66,7 @@ class StepCommandError(StepError):
     """Error during custom command compilation."""
 
     def __init__(self, command, code):
-        super(StepCommandError, self).__init__((
+        super().__init__((
             """Error while running custom command "{command}": got return"""
             " code {code}."
             ).format(command=command, code=code))
@@ -76,7 +76,7 @@ class CleaningError(SongbookError):
     """Error during cleaning of LaTeX auxiliary files."""
 
     def __init__(self, filename, exception):
-        super(CleaningError, self).__init__()
+        super().__init__()
         self.filename = filename
         self.exception = exception
 
@@ -90,7 +90,7 @@ class UnknownStep(StepError):
     """Unknown compilation step."""
 
     def __init__(self, step):
-        super(UnknownStep, self).__init__(
+        super().__init__(
             """Compilation step "{step}" unknown.""".format(step=step)
         )
 

patacrep/index.py

@@ -6,8 +6,8 @@ from a file generated by the latex compilation of the songbook (.sxd).
 """
 
 import locale
-import unidecode
 import re
+import unidecode
 
 from patacrep import authors
 from patacrep import encoding
@@ -77,7 +77,7 @@ class Index:
 
     def add_keyword(self, key, word):
         """Add 'word' to self.keywords[key]."""
-        if not key in self.keywords:
+        if key not in self.keywords:
             self.keywords[key] = []
         self.keywords[key].append(word)
 
@@ -101,9 +101,9 @@ class Index:
         similar method with processing.
         """
         first = self.get_first_letter(key[0])
-        if not first in self.data:
+        if first not in self.data:
             self.data[first] = dict()
-        if not key in self.data[first]:
+        if key not in self.data[first]:
             self.data[first][key] = {
                 'sortingkey': [
                     unidecode.unidecode(tex2plain(item)).lower()

patacrep/latex/lexer.py

@@ -60,7 +60,7 @@ class SimpleLexer:
     # Define a rule so we can track line numbers
     @staticmethod
     def t_endofline(token):
-        r'\n+'
+        r'(\r?\n)+'
         token.lexer.lineno += len(token.value)
 
     @staticmethod

patacrep/latex/syntax.py

@@ -130,9 +130,12 @@ class LatexParser(Parser):
     def p_dictionary(symbols):
         """dictionary : identifier EQUAL braces dictionary_next
                       | identifier EQUAL error dictionary_next
+                      | empty
         """
         symbols[0] = {}
-        if isinstance(symbols[3], ast.Expression):
+        if len(symbols) == 2:
+            pass
+        elif isinstance(symbols[3], ast.Expression):
             symbols[0][symbols[1]] = symbols[3]
             symbols[0].update(symbols[4])
         else:

patacrep/songbook/__main__.py

@@ -1,12 +1,12 @@
 """Command line tool to compile songbooks using the songbook library."""
 
 import argparse
-import json
 import locale
 import logging
 import os.path
 import textwrap
 import sys
+import yaml
 
 from patacrep.build import SongbookBuilder, DEFAULT_STEPS
 from patacrep.utils import yesno
@@ -135,13 +135,13 @@ def main():
 
     try:
         with patacrep.encoding.open_read(songbook_path) as songbook_file:
-            songbook = json.load(songbook_file)
+            songbook = yaml.load(songbook_file)
         if 'encoding' in songbook:
             with patacrep.encoding.open_read(
                 songbook_path,
                 encoding=songbook['encoding']
                 ) as songbook_file:
-                songbook = json.load(songbook_file)
+                songbook = yaml.load(songbook_file)
     except Exception as error: # pylint: disable=broad-except
         LOGGER.error(error)
         LOGGER.error("Error while loading file '{}'.".format(songbook_path))

patacrep/songs/__init__.py

@@ -14,6 +14,15 @@ from patacrep.songs import errors as song_errors
 
 LOGGER = logging.getLogger(__name__)
 
+DEFAULT_CONFIG = {
+    'template': "default.tex",
+    'lang': 'en',
+    'content': [],
+    'titleprefixwords': [],
+    'encoding': None,
+    'datadir': [],
+    }
+
 def cached_name(datadir, filename):
     """Return the filename of the cache version of the file."""
     fullpath = os.path.abspath(os.path.join(datadir, '.cache', filename))
@@ -95,7 +104,10 @@ class Song:
         "_version",
         ]
 
-    def __init__(self, subpath, config, *, datadir=None):
+    def __init__(self, subpath, config=None, *, datadir=None):
+        if config is None:
+            config = DEFAULT_CONFIG.copy()
+
         if datadir is None:
             self.datadir = ""
             # Only songs in datadirs may be cached

patacrep/songs/chordpro/__init__.py

@@ -1,11 +1,12 @@
 """Chordpro parser"""
 
-from jinja2 import Environment, FileSystemLoader, contextfunction, ChoiceLoader
-import jinja2
 import logging
 import operator
 import os
 
+from jinja2 import Environment, FileSystemLoader, contextfunction, ChoiceLoader
+import jinja2
+
 from patacrep import encoding, files, pkg_datapath
 from patacrep.songs import Song
 from patacrep.songs.chordpro.syntax import parse_song

patacrep/songs/chordpro/syntax.py

@@ -2,11 +2,11 @@
 
 import functools
 import logging
-import ply.yacc as yacc
 import re
 
+import ply.yacc as yacc
+
 from patacrep.content import ContentError
-from patacrep.songs import errors
 from patacrep.songs.chordpro import ast
 from patacrep.songs.chordpro.lexer import tokens, ChordProLexer
 from patacrep.songs.syntax import Parser

patacrep/songs/convert/__main__.py

@@ -8,7 +8,7 @@ import logging
 import sys
 
 from patacrep import files
-from patacrep.build import DEFAULT_CONFIG
+from patacrep.songs import DEFAULT_CONFIG
 from patacrep.utils import yesno
 
 LOGGER = logging.getLogger(__name__)

patacrep/templates.py

@@ -1,11 +1,12 @@
 """Template for .tex generation settings and utilities"""
 
+import re
+import json
+
 from jinja2 import Environment, FileSystemLoader, ChoiceLoader, \
         TemplateNotFound, nodes
 from jinja2.ext import Extension
 from jinja2.meta import find_referenced_templates as find_templates
-import re
-import json
 
 from patacrep import errors, files
 from patacrep.latex import lang2babel

setup.py

@@ -34,7 +34,7 @@ setup(
     packages=find_packages(exclude=["test*"]),
     license="GPLv2 or any later version",
     install_requires=[
-        "unidecode", "jinja2", "ply",
+        "unidecode", "jinja2", "ply", "pyyaml",
         ],
     entry_points={
         'console_scripts': [

test/__init__.py

@@ -9,11 +9,15 @@ import unittest
 import patacrep
 
 @contextlib.contextmanager
-def disable_logging():
-    """Context locally disabling logging."""
-    logging.disable(logging.CRITICAL)
+def logging_reduced(module_name=None, level=logging.CRITICAL):
+    """Temporarly reduce the logging level of a specific module or globally if None
+    """
+    logger = logging.getLogger(module_name)
+    old_level = logger.getEffectiveLevel()
+
+    logger.setLevel(level)
     yield
-    logging.disable(logging.NOTSET)
+    logger.setLevel(old_level)
 
 def suite():
     """Return a :class:`TestSuite` object, testing all module :mod:`patacrep`.

test/test_compilation/datadir.sb

@@ -1,7 +0,0 @@
-{
-"bookoptions" : [
-    "pictures"
-  ],
-"datadir": ["datadir_datadir", "datadir_datadir2"],
-"lang": "en"
-}

test/test_compilation/languages.sb

@@ -1,3 +0,0 @@
-{
-"datadir": ["languages_datadir"]
-}

test/test_compilation/syntax.sb

@@ -1,4 +0,0 @@
-{
-"datadir": ["syntax_datadir"],
-"lang": "en"
-}

test/test_compilation/unicode.sb

@@ -1,4 +0,0 @@
-{
-"datadir": ["unicode_datadir"],
-"lang": "en"
-}

test/test_content/cwd.control

@@ -0,0 +1 @@
+["subdir/chordpro.csg"]

test/test_content/cwd.source

@@ -0,0 +1 @@
+[["cwd(subdir)"]]

test/test_content/cwd_list.control

@@ -0,0 +1 @@
+["subdir/chordpro.csg", "exsong.sg"]

test/test_content/cwd_list.source

@@ -0,0 +1 @@
+[["cwd(subdir)", "exsong.sg", "intersong.is", "jsonlist.json", "texfile.tex", "texsong.tsg", "chordpro.csg", "subdir/chordpro.csg"], "exsong.sg"]

test/test_content/datadir/songs/chordpro.csg

@@ -0,0 +1,51 @@
+{lang : en}
+{columns :  2}
+{ title : Greensleeves}
+{subtitle: Test of the chordpro format}
+{artist: Traditionnel}
+{artist: Prénom Nom}
+{cover : traditionnel.jpg }
+{album :Angleterre}
+
+{partition : greensleeves.ly}
+
+
+A[Am]las, my love, ye [G]do me wrong
+To [Am]cast me oft dis[E]curteously
+And [Am]I have loved [G]you so long
+De[Am]lighting [E]in your [Am]companie
+
+{start_of_chorus}
+   [C]Greensleeves was [G]all my joy
+   [Am]Greensleeves was [E]my delight
+   [C]Greensleeves was my [G]heart of gold
+   And [Am]who but [E]Ladie [Am]Greensleeves
+{end_of_chorus}
+
+I [Am]have been ready [G]at your hand
+To [Am]grant what ever [E]you would crave
+I [Am]have both waged [G]life and land
+Your [Am]love and [E]good will [Am]for to have
+
+I [Am]bought thee kerchers [G]to thy head
+That [Am]were wrought fine and [E]gallantly
+I [Am]kept thee both at [G]boord and bed
+Which [Am]cost my [E]purse well [Am]favouredly
+
+I [Am]bought thee peticotes [G]of the best
+The [Am]cloth so fine as [E]fine might be
+I [Am]gave thee jewels [G]for thy chest
+And [Am]all this [E]cost I [Am]spent on thee
+
+{c:test of comment}
+
+{gc: test of guitar comment}
+
+{image: traditionnel.jpg}
+
+Thy [Am]smock of silke, both [G]faire and white
+With [Am]gold embrodered [E]gorgeously
+Thy [Am]peticote of [G]sendall right
+And [Am]this I [E]bought thee [Am]gladly
+
+

test/test_content/datadir/songs/custom_list.json

@@ -0,0 +1 @@
+["exsong.sg", "chordpro.csg", "subdir/chordpro.csg"]

test/test_content/datadir/songs/intersong.is

@@ -0,0 +1,6 @@
+\selectlanguage{french}
+\sortassong{}[by={QQ}]
+\begin{intersong}
+
+Lorem ipsum
+\end{intersong}

test/test_content/datadir/songs/subdir/chordpro.csg

@@ -0,0 +1,51 @@
+{lang : en}
+{columns :  2}
+{ title : Greensleeves}
+{subtitle: Test of the chordpro format}
+{artist: Traditionnel}
+{artist: Prénom Nom}
+{cover : traditionnel.jpg }
+{album :Angleterre}
+
+{partition : greensleeves.ly}
+
+
+A[Am]las, my love, ye [G]do me wrong
+To [Am]cast me oft dis[E]curteously
+And [Am]I have loved [G]you so long
+De[Am]lighting [E]in your [Am]companie
+
+{start_of_chorus}
+   [C]Greensleeves was [G]all my joy
+   [Am]Greensleeves was [E]my delight
+   [C]Greensleeves was my [G]heart of gold
+   And [Am]who but [E]Ladie [Am]Greensleeves
+{end_of_chorus}
+
+I [Am]have been ready [G]at your hand
+To [Am]grant what ever [E]you would crave
+I [Am]have both waged [G]life and land
+Your [Am]love and [E]good will [Am]for to have
+
+I [Am]bought thee kerchers [G]to thy head
+That [Am]were wrought fine and [E]gallantly
+I [Am]kept thee both at [G]boord and bed
+Which [Am]cost my [E]purse well [Am]favouredly
+
+I [Am]bought thee peticotes [G]of the best
+The [Am]cloth so fine as [E]fine might be
+I [Am]gave thee jewels [G]for thy chest
+And [Am]all this [E]cost I [Am]spent on thee
+
+{c:test of comment}
+
+{gc: test of guitar comment}
+
+{image: traditionnel.jpg}
+
+Thy [Am]smock of silke, both [G]faire and white
+With [Am]gold embrodered [E]gorgeously
+Thy [Am]peticote of [G]sendall right
+And [Am]this I [E]bought thee [Am]gladly
+
+

test/test_content/datadir/songs/texfile.tex

@@ -0,0 +1,70 @@
+\selectlanguage{french}
+\songcolumns{2}
+\beginsong{Chevaliers de la table ronde}
+  [by={Traditionnel},cover={traditionnel},album={France}]
+
+  \cover
+  \gtab{C}{X32010}
+  \gtab{G7}{320001}
+  \gtab{F}{1:022100}
+
+  \begin{verse}
+    Cheva\[C]liers de la Table Ronde
+    Goûtons \[G7]voir si le vin est \[C]bon
+    \rep{2}
+  \end{verse}
+
+  \begin{chorus}
+    Goûtons \[F]voir, \echo{oui, oui, oui}
+    Goûtons \[C]voir, \echo{non, non, non}
+    Goûtons \[G7]voir si le vin est bon
+    \rep{2}
+  \end{chorus}
+
+  \begin{verse}
+    S'il est bon, s'il est agréable
+    J'en boirai jusqu'à mon plaisir
+  \end{verse}
+
+  \begin{verse}
+    J'en boirai cinq à six bouteilles
+    Et encore, ce n'est pas beaucoup
+  \end{verse}
+
+  \begin{verse}
+    Si je meurs, je veux qu'on m'enterre
+    Dans une cave où il y a du bon vin
+  \end{verse}
+
+  \begin{verse}
+    Les deux pieds contre la muraille
+    Et la tête sous le robinet
+  \end{verse}
+
+  \begin{verse}
+    Et les quatre plus grands ivrognes
+    Porteront les quatre coins du drap
+  \end{verse}
+
+  \begin{verse}
+    Pour donner le discours d'usage
+    On prendra le bistrot du coin
+  \end{verse}
+
+  \begin{verse}
+    Et si le tonneau se débouche
+    J'en boirai jusqu'à mon plaisir
+  \end{verse}
+
+  \begin{verse}
+    Et s'il en reste quelques gouttes
+    Ce sera pour nous rafraîchir
+  \end{verse}
+
+  \begin{verse}
+    Sur ma tombe, je veux qu'on inscrive
+    \emph{Ici gît le roi des buveurs}
+  \end{verse}
+
+\endsong
+

test/test_content/datadir/songs/texsong.tsg

@@ -0,0 +1,70 @@
+\selectlanguage{french}
+\songcolumns{2}
+\beginsong{Chevaliers de la table ronde}
+  [by={Traditionnel},cover={traditionnel},album={France}]
+
+  \cover
+  \gtab{C}{X32010}
+  \gtab{G7}{320001}
+  \gtab{F}{1:022100}
+
+  \begin{verse}
+    Cheva\[C]liers de la Table Ronde
+    Goûtons \[G7]voir si le vin est \[C]bon
+    \rep{2}
+  \end{verse}
+
+  \begin{chorus}
+    Goûtons \[F]voir, \echo{oui, oui, oui}
+    Goûtons \[C]voir, \echo{non, non, non}
+    Goûtons \[G7]voir si le vin est bon
+    \rep{2}
+  \end{chorus}
+
+  \begin{verse}
+    S'il est bon, s'il est agréable
+    J'en boirai jusqu'à mon plaisir
+  \end{verse}
+
+  \begin{verse}
+    J'en boirai cinq à six bouteilles
+    Et encore, ce n'est pas beaucoup
+  \end{verse}
+
+  \begin{verse}
+    Si je meurs, je veux qu'on m'enterre
+    Dans une cave où il y a du bon vin
+  \end{verse}
+
+  \begin{verse}
+    Les deux pieds contre la muraille
+    Et la tête sous le robinet
+  \end{verse}
+
+  \begin{verse}
+    Et les quatre plus grands ivrognes
+    Porteront les quatre coins du drap
+  \end{verse}
+
+  \begin{verse}
+    Pour donner le discours d'usage
+    On prendra le bistrot du coin
+  \end{verse}
+
+  \begin{verse}
+    Et si le tonneau se débouche
+    J'en boirai jusqu'à mon plaisir
+  \end{verse}
+
+  \begin{verse}
+    Et s'il en reste quelques gouttes
+    Ce sera pour nous rafraîchir
+  \end{verse}
+
+  \begin{verse}
+    Sur ma tombe, je veux qu'on inscrive
+    \emph{Ici gît le roi des buveurs}
+  \end{verse}
+
+\endsong
+

test/test_content/glob.control

@@ -0,0 +1 @@
+["chordpro.csg"]

test/test_content/glob.source

@@ -0,0 +1 @@
+["*.csg"]

test/test_content/include.control

@@ -0,0 +1 @@
+["exsong.sg", "chordpro.csg", "subdir/chordpro.csg"]

test/test_content/include.source

@@ -0,0 +1 @@
+[["include" , "custom_list.json"]]

test/test_content/sections.control

@@ -0,0 +1 @@
+["section:Traditional", "exsong.sg", "section:Example", "texsong.tsg", "chordpro.csg", "exsong.sg"]

test/test_content/sections.source

@@ -0,0 +1,6 @@
+[["section", "Traditional"],
+                "exsong.sg",
+                ["section", "Example"],
+                "texsong.tsg",
+                "chordpro.csg",
+                "exsong.sg"]

test/test_content/sections_short.control

@@ -0,0 +1 @@
+["section:(tradi)Traditional", "exsong.sg", "section*:Example", "texsong.tsg", "chordpro.csg", "exsong.sg"]

test/test_content/sections_short.source

@@ -0,0 +1,6 @@
+[["section", "Traditional", "tradi"],
+                "exsong.sg",
+                ["section*", "Example"],
+                "texsong.tsg",
+                "chordpro.csg",
+                "exsong.sg"]

test/test_content/songs.control

@@ -0,0 +1 @@
+["exsong.sg", "texsong.tsg", "chordpro.csg", "subdir/chordpro.csg"]

test/test_content/songs.source

@@ -0,0 +1 @@
+["exsong.sg", "intersong.is", "jsonlist.json", "texfile.tex", "texsong.tsg", "chordpro.csg", "subdir/chordpro.csg"]

test/test_content/songsection.control

@@ -0,0 +1 @@
+["songsection:Traditional", "exsong.sg", "songchapter:English", "texsong.tsg", "chordpro.csg", "exsong.sg"]

test/test_content/songsection.source

@@ -0,0 +1,6 @@
+[["songsection", "Traditional"],
+                "exsong.sg",
+                ["songchapter", "English"],
+                "texsong.tsg",
+                "chordpro.csg",
+                "exsong.sg"]

test/test_content/sorted.control

@@ -0,0 +1 @@
+["chordpro.csg", "exsong.sg", "subdir/chordpro.csg", "texsong.tsg"]

test/test_content/sorted.source

@@ -0,0 +1 @@
+[["sorted(fullpath)"]]

test/test_content/test_content.py

@@ -0,0 +1,118 @@
+"""Tests for the content plugins."""
+
+# pylint: disable=too-few-public-methods
+
+import glob
+import os
+import unittest
+import json
+
+from patacrep.songs import DataSubpath, DEFAULT_CONFIG
+from patacrep import content, files
+from patacrep.content import song, section, songsection, tex
+
+from .. import logging_reduced
+from .. import dynamic # pylint: disable=unused-import
+
+class FileTest(unittest.TestCase, metaclass=dynamic.DynamicTest):
+    """Test of the content plugins.
+
+    For any given `foo.source`, it parses the content as a json "content"
+    argument of a .sb file.
+    It controls that the generated file list is equal to the one in `foo.control`.
+    """
+
+    maxDiff = None
+    config = None
+
+    @classmethod
+    def setUpClass(cls):
+        cls._generate_config()
+
+    @classmethod
+    def _iter_testmethods(cls):
+        """Iterate over dynamically generated test methods"""
+        for source in sorted(glob.glob(os.path.join(
+                os.path.dirname(__file__),
+                '*.source',
+            ))):
+            base = source[:-len(".source")]
+            yield (
+                "test_content_{}".format(os.path.basename(base)),
+                cls._create_content_test(base),
+                )
+
+    @classmethod
+    def _create_content_test(cls, base):
+        """Return a function that `base.source` produces the correct file list"""
+
+        def test_content(self):
+            """Test that `base.source` produces the correct file list"""
+            sourcename = "{}.source".format(base)
+            with open(sourcename, mode="r", encoding="utf8") as sourcefile:
+                sbcontent = json.load(sourcefile)
+
+            with logging_reduced('patacrep.content.song'):
+                expandedlist = content.process_content(sbcontent, cls.config.copy())
+            sourcelist = [cls._clean_path(elem) for elem in expandedlist]
+
+            controlname = "{}.control".format(base)
+            if not os.path.exists(controlname):
+                raise Exception("Missing control:" + str(sourcelist).replace("'", '"'))
+            with open(controlname, mode="r", encoding="utf8") as controlfile:
+                controllist = json.load(controlfile)
+
+            self.assertEqual(controllist, sourcelist)
+
+        test_content.__doc__ = (
+            "Test that '{base}.source' produces the correct file list"""
+            ).format(base=os.path.basename(base))
+        return test_content
+
+    @classmethod
+    def _clean_path(cls, elem):
+        """Shorten the path relative to the `songs` directory"""
+        if isinstance(elem, song.SongRenderer):
+            songpath = os.path.join(os.path.dirname(__file__), 'datadir', 'songs')
+            return files.path2posix(files.relpath(elem.song.fullpath, songpath))
+
+        elif isinstance(elem, section.Section):
+            if elem.short is None:
+                return "{}:{}".format(elem.keyword, elem.name)
+            else:
+                return "{}:({}){}".format(elem.keyword, elem.short, elem.name)
+
+        elif isinstance(elem, songsection.SongSection):
+            return "{}:{}".format(elem.keyword, elem.name)
+
+        elif isinstance(elem, tex.LaTeX):
+            return files.path2posix(elem.filename)
+
+        else:
+            raise Exception(elem)
+
+    @classmethod
+    def _generate_config(cls):
+        """Generate the config to process the content"""
+
+        config = DEFAULT_CONFIG.copy()
+
+        datadirpaths = [os.path.join(os.path.dirname(__file__), 'datadir')]
+
+        config['datadir'] = datadirpaths
+
+        config['_songdir'] = [
+            DataSubpath(path, 'songs')
+            for path in datadirpaths
+            ]
+        config['_content_plugins'] = files.load_plugins(
+            datadirs=datadirpaths,
+            root_modules=['content'],
+            keyword='CONTENT_PLUGINS',
+            )
+        config['_song_plugins'] = files.load_plugins(
+            datadirs=datadirpaths,
+            root_modules=['songs'],
+            keyword='SONG_RENDERERS',
+            )['tsg']
+        cls.config = config

test/test_content/tex.control

@@ -0,0 +1 @@
+["test/test_content/datadir/songs/texfile.tex"]

test/test_content/tex.source

@@ -0,0 +1 @@
+[["tex", "texfile.tex", "chordpro.csg"]]