Merge pull request #208 from patacrep/numbering_plugin

Numbering plugin

patacrep/content/setcounter.py

@@ -0,0 +1,48 @@
+"""Allows to set an arbitrary value to any LaTeX counter (like `songnum`)."""
+
+from patacrep.content import ContentItem, ContentList, validate_parser_argument
+
+class CounterSetter(ContentItem):
+    """Set a counter."""
+    # pylint: disable=too-few-public-methods
+
+    def __init__(self, name, value):
+        self.name = name
+        self.value = value
+
+    def render(self, __context):
+        """Set the value of the counter."""
+        return r'\setcounter{{{}}}{{{}}}'.format(self.name, self.value)
+
+#pylint: disable=unused-argument
+@validate_parser_argument("""
+type: //any
+of:
+  - //nil
+  - //int
+  - type: //rec
+    optional:
+      name: //str
+      value: //int
+""")
+def parse(keyword, argument, config):
+    """Parse the counter setter.
+
+    Arguments:
+    - nothing
+        reset the "songnum" counter to 1
+    - an int
+        reset the "songnum" counter to this value
+    - a dict:
+        - name ("songnum"): the counter to set;
+        - value: value to set the counter to;
+    """
+    if argument is None:
+        argument = {}
+    if isinstance(argument, int):
+        argument = {'value': argument}
+    name = argument.get('name', 'songnum')
+    value = argument.get('value', 1)
+    return ContentList([CounterSetter(name, value)])
+
+CONTENT_PLUGINS = {'setcounter': parse}

patacrep/data/latex/patacrep.sty

@@ -443,4 +443,21 @@
 \def\@void[#1]{}
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+% Prevent numbering reset on new 'songs' environment
+\newcounter{tempsongnum}
+
+\let\oldsongs\songs
+\let\endoldsongs\endsongs
+
+\renewenvironment{songs}[1]{%
+    \setcounter{tempsongnum}{\thesongnum}%
+    \oldsongs{#1}%
+    \setcounter{songnum}{\thetempsongnum}%
+}{%
+    \endoldsongs\ignorespacesafterend%
+}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
 \endinput

test/test_content/setcounter.control

@@ -0,0 +1,4 @@
+- setcounter{songnum}{101}
+- setcounter{songnum}{1}
+- setcounter{songnum}{5}
+- setcounter{counter_name}{-1}

test/test_content/setcounter.source

@@ -0,0 +1,7 @@
+- setcounter: 
+    value: 101
+- setcounter: 
+- setcounter: 5 
+- setcounter: 
+    name: counter_name
+    value: -1

test/test_content/test_content.py

@@ -10,7 +10,7 @@ import yaml
 from pkg_resources import resource_filename
 
 from patacrep import content, files
-from patacrep.content import song, section, songsection, tex
+from patacrep.content import song, section, setcounter, songsection, tex
 from patacrep.songbook import prepare_songbook
 
 from .. import logging_reduced
@@ -76,15 +76,18 @@ class FileTest(unittest.TestCase, metaclass=dynamic.DynamicTest):
     @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):
+        latex_command_classes = (
+            section.Section,
+            songsection.SongSection,
+            setcounter.CounterSetter,
+            )
+        if isinstance(elem, latex_command_classes):
             return elem.render(None)[1:]
 
-        elif isinstance(elem, songsection.SongSection):
-            return elem.render(None)[1:]
+        elif 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, tex.LaTeX):
             return files.path2posix(elem.filename)

test/test_songbook/content.tex.control

@@ -122,6 +122,9 @@ guitar,
 
 \songsection{Test of song section}
 
+
+\setcounter{songnum}{101}
+
 \begin{songs}{titleidx,authidx}
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %% content_datadir/content/song.csg

test/test_songbook/content.yaml

@@ -11,6 +11,7 @@ content:
   - section: Test of section
   - sort:
   - songsection: Test of song section
+  - setcounter: 101
   - cwd:
       # relative to yaml songfile
       path: content_datadir/content