Merge branch 'master' into data

patacrep/data/templates/songs/chordpro/latex/content_verse

@@ -6,7 +6,7 @@
 \ifchorded
 \begin{verse*}
   (* for line in content.lines *)
-    \musicnote {\nolyrics (( render(line) ))}
+    \musicnote {\nolyrics (( render(line)|replace("#", "{\shrp}") ))}
   (* endfor *)
 \end{verse*}
 \fi

patacrep/songbook/__main__.py

@@ -9,6 +9,7 @@ import textwrap
 import sys
 
 from patacrep.build import SongbookBuilder, DEFAULT_STEPS
+from patacrep.utils import yesno
 from patacrep import __version__
 from patacrep import errors
 import patacrep.encoding
@@ -37,6 +38,16 @@ class VerboseAction(argparse.Action):
     def __call__(self, *_args, **_kwargs):
         LOGGER.setLevel(logging.DEBUG)
 
+def yesno_type(string):
+    """Interpret argument as a "yes" or a "no".
+
+    Raise `argparse.ArgumentTypeError` if string cannot be analysed.
+    """
+    try:
+        return yesno(string)
+    except ValueError as error:
+        raise argparse.ArgumentTypeError(str(error))
+
 def argument_parser(args):
     """Parse arguments"""
     parser = argparse.ArgumentParser(
@@ -68,6 +79,15 @@ def argument_parser(args):
         """)
         )
 
+    parser.add_argument(
+        '--cache', '-c', nargs=1,
+        help=textwrap.dedent("""\
+                Enable song cache.
+        """),
+        type=yesno_type,
+        default=[True],
+        )
+
     parser.add_argument(
         '--steps', '-s', nargs=1, type=str,
         action=ParseStepsAction,
@@ -107,7 +127,7 @@ def main():
 
     options = argument_parser(sys.argv[1:])
 
-    songbook_path = options.book[0]
+    songbook_path = options.book[-1]
     if os.path.exists(songbook_path + ".sb") and not os.path.exists(songbook_path):
         songbook_path += ".sb"
 
@@ -147,6 +167,7 @@ def main():
     datadirs.append(os.path.dirname(os.path.abspath(songbook_path)))
 
     songbook['datadir'] = datadirs
+    songbook['_cache'] = options.cache[0]
 
     try:
         sb_builder = SongbookBuilder(songbook, basename)

patacrep/songs/__init__.py

@@ -104,7 +104,7 @@ class Song:
         self.encoding = config["encoding"]
         self.config = config
 
-        if datadir:
+        if self.datadir and self.config['_cache']:
             # Only songs in datadirs are cached
             self._filehash = hashlib.md5(
                 open(self.fullpath, 'rb').read()
@@ -155,7 +155,7 @@ class Song:
 
     def _write_cache(self):
         """If relevant, write a dumbed down version of self to the cache."""
-        if self.datadir:
+        if self.datadir and self.config['_cache']:
             cached = {}
             for attribute in self.cached_attributes:
                 cached[attribute] = getattr(self, attribute)

patacrep/songs/convert/__main__.py

@@ -7,24 +7,21 @@ import os
 import logging
 import sys
 
-from patacrep.build import DEFAULT_CONFIG
 from patacrep import files
+from patacrep.build import DEFAULT_CONFIG
+from patacrep.utils import yesno
 
 LOGGER = logging.getLogger(__name__)
 
 def __usage():
     return "python3 -m patacrep.songs.convert INPUTFORMAT OUTPUTFORMAT FILES"
 
-def yesno(prompt):
-    while True:
-        answer = input("{} [yn] ".format(prompt))
-        if answer.strip().lower() == "y":
-            return True
-        if answer.strip().lower() == "n":
-            return False
-
 def confirm(destname):
-    return yesno("File '{}' already exist. Overwrite?".format(destname))
+    while True
+        try:
+            return yesno(input("File '{}' already exist. Overwrite? [yn] ".format(destname)))
+        except ValueError:
+            continue
 
 if __name__ == "__main__":
     if len(sys.argv) < 4:

patacrep/utils.py

@@ -59,3 +59,19 @@ class DictOfDict(UserDict):
                 DictOfDict._update(left[key], right[key])
             else:
                 left[key] = right[key]
+
+def yesno(string):
+    """Interpret string argument as a boolean.
+
+    May raise `ValueError` if argument cannot be interpreted.
+    """
+    yes_strings = ["y", "yes", "true", "1"]
+    no_strings = ["n", "no", "false", "0"]
+    if string.lower() in yes_strings:
+        return True
+    if string.lower() in no_strings:
+        return False
+    raise ValueError("'{}' is supposed to be one of {}.".format(
+        string,
+        ", ".join(["'{}'".format(string) for string in yes_strings + no_strings]),
+        ))

test/test_chordpro/nolyrics.tex

@@ -14,7 +14,7 @@
 
 \ifchorded
 \begin{verse*}
-    \musicnote {\nolyrics \[A B#]}
+    \musicnote {\nolyrics \[A B{\shrp}]}
 \end{verse*}
 \fi
 

test/test_compilation/syntax.sb

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

test/test_compilation/syntax.tex.control

@@ -0,0 +1,116 @@
+
+
+
+
+
+
+%% Automatically generated document.
+%% You may edit this file but all changes will be overwritten.
+%% If you want to change this document, have a look at
+%% the templating system.
+%%
+%% Generated using Songbook <http://www.patacrep.com>
+
+\makeatletter
+\def\input@path{ %
+        {@TEST_FOLDER@/syntax_datadir/latex/} %
+        {@TEST_FOLDER@/latex/} %
+        {@DATA_FOLDER@/latex/} %
+}
+\makeatother
+
+\documentclass[
+    ]{article}
+
+\usepackage[
+    chorded,
+diagram,
+pictures,
+guitar,
+    ]{patacrep}
+
+\usepackage{lmodern}
+
+
+\PassOptionsToPackage{english}{babel}
+\usepackage[english]{babel}
+\lang{english}
+
+\usepackage{graphicx}
+\graphicspath{ %
+        {@TEST_FOLDER@/syntax_datadir/} %
+        {@TEST_FOLDER@/} %
+        {@DATA_FOLDER@/} %
+}
+
+
+\makeatletter
+\@ifpackageloaded{hyperref}{}{
+   \usepackage{url}
+   \newcommand{\phantomsection}{}
+   \newcommand{\hyperlink}[2]{#2}
+   \newcommand{\href}[2]{\expandafter\url\expandafter{#1}}
+}
+\makeatother
+
+
+\usepackage{chords}
+
+\title{Guitar songbook}
+\author{The Patacrep Team}
+
+\newindex{titleidx}{syntax_title}
+\newauthorindex{authidx}{syntax_auth}
+
+
+\notenamesout{A}{B}{C}{D}{E}{F}{G}
+
+
+\begin{document}
+
+\maketitle
+
+
+\showindex{\songindexname}{titleidx}
+\showindex{\authorindexname}{authidx}
+
+% list of chords
+\ifchorded
+  \ifdiagram
+     \phantomsection
+     \addcontentsline{toc}{section}{\chordlistname}
+     \chords
+  \fi
+\fi
+
+\phantomsection
+\addcontentsline{toc}{section}{\songlistname}
+
+\begin{songs}{titleidx,authidx}
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% songs/./musicnote.sgc
+
+\selectlanguage{english}
+
+\beginsong{Song with Sharp in musicnote}[
+  by={
+  },
+]
+
+
+
+
+\ifchorded
+\begin{verse*}
+    \musicnote {\nolyrics \[Am C{\shrp}m]}
+\end{verse*}
+\fi
+
+\endsong
+
+\end{songs}
+
+
+
+
+\end{document}

test/test_compilation/syntax_datadir/songs/musicnote.sgc

@@ -0,0 +1,4 @@
+{title : Song with Sharp in musicnote}
+{lang: en}
+
+[Am C#m]

test/test_compilation/test_compilation.py

@@ -9,7 +9,6 @@ import sys
 import subprocess
 import unittest
 
-from patacrep.encoding import open_read
 from patacrep.files import path2posix
 
 from .. import dynamic # pylint: disable=unused-import
@@ -38,15 +37,12 @@ class FileTest(unittest.TestCase, metaclass=dynamic.DynamicTest):
                 '*.sb',
             ))):
             base = songbook[:-len(".sb")]
-            control = "{}.tex.control".format(base)
-            if not os.path.exists(control):
-                continue
             yield (
-                "test_generation_{}".format(os.path.basename(base)),
+                "test_latex_generation_{}".format(os.path.basename(base)),
                 cls._create_generation_test(base),
                 )
             yield (
-                "test_compilation_{}".format(os.path.basename(base)),
+                "test_pdf_compilation_{}".format(os.path.basename(base)),
                 cls._create_compilation_test(base),
                 )
 
@@ -63,9 +59,12 @@ class FileTest(unittest.TestCase, metaclass=dynamic.DynamicTest):
 
             # Check generated tex
             control = "{}.tex.control".format(base)
+            if not os.path.exists(control):
+                raise unittest.SkipTest('No control file for {}'.format(songbook))
+
             tex = "{}.tex".format(base)
-            with open_read(control) as expectfile:
+            with open(control, mode="r", encoding="utf8") as expectfile:
-                with open_read(tex) as latexfile:
+                with open(tex, mode="r", encoding="utf8") as latexfile:
                     expected = expectfile.read().strip()
                     expected = expected.replace(
                         "@TEST_FOLDER@",
@@ -112,7 +111,7 @@ class FileTest(unittest.TestCase, metaclass=dynamic.DynamicTest):
     @staticmethod
     def compile_songbook(songbook, steps=None):
         """Compile songbook, and return the command return code."""
-        command = [sys.executable, '-m', 'patacrep.songbook', songbook]
+        command = [sys.executable, '-m', 'patacrep.songbook', '--cache=no', songbook, '-v']
         if steps:
             command.extend(['--steps', steps])