Add a default songbook configuration

patacrep/data/templates/default_songbook.sb.yml

@@ -1,46 +1,51 @@
-content:
-
 book: 
   lang: en
-  datadir: 
   encoding: utf-8
   pictures: yes
 
 chords: # Options relatives aux accords
-  diagramreminder: ENUM[important, none, all] (anciennement importantdiagramonly)
+  show: yes
-  diagrampage: BOOLEAN Montrer la page d'accords
+  diagramreminder: all
-  repeatchords: BOOLEAN
+  diagrampage: yes
-  lilypond: BOOLEAN
+  repeatchords: yes
-  instruments: ENUM[guitar, ukulele]
+  lilypond: yes
-  show: BOOLEAN (anciennement booktype=chorded ou booktype=lyrics)
+  instruments: guitar
-  notation: ENUM[alphascale, solfedge]
+  notation: alphascale
 
 authors: # Comment sont analysés les auteurs
-  separators: LISTE
+  separators:
-  ignore: LISTE
+  - To
-  by: LISTE
+  - Do
+  ignore:
+  - To
+  - Do
+  by:
+  - To
+  - Do
 
 titles: # Comment sont analysés les titres
-  prefix: LISTE
+  prefix:
+  - To
+  - Do
 
 template: # Des choses spécifiques au template
   file: STRING
-  latex: # Des choses spécifiques au LaTeX
+  # latex: # Des choses spécifiques au LaTeX
-    classoptions: STRING
+  #   classoptions: STRING
 
-  # Peut dépendre fortement du template
+  # # Peut dépendre fortement du template
-  color: # Des couleurs
+  # color: # Des couleurs
-    songnumber: STRING
+  #   songnumber: STRING
-    notebg: STRING
+  #   notebg: STRING
-    indexbg: STRING
+  #   indexbg: STRING
 
-  titlepage: #Configuration de la page de garde
+  # titlepage: #Configuration de la page de garde
-    title: STRING
+  #   title: STRING
-    author: STRING
+  #   author: STRING
-    subtitle: STRING
+  #   subtitle: STRING
-    version: STRING
+  #   version: STRING
-    url: STRING
+  #   url: STRING
-    email: STRING
+  #   email: STRING
-    picture: STRING
+  #   picture: STRING
-    picturecopyright: STRING
+  #   picturecopyright: STRING
-    footer: STRING
+  #   footer: STRING

patacrep/data/templates/songbook_schema.yml

@@ -1,9 +1,10 @@
 type: //rec
 optional:
   content: //str
+required:
   book:
     type: //rec
-    optional:
+    required:
       encoding: //str
       lang: //str
       pictures: //bool
@@ -12,7 +13,7 @@ optional:
         contents: //str
   chords:
     type: //rec
-    optional:
+    required:
       show: //bool
       diagrampage: //bool
       repeatchords: //bool
@@ -43,41 +44,54 @@ optional:
   authors:
     _description: "Comment sont analysés les auteurs"
     type: //rec
-    optional:
+    required:
       separators:
-        type: //arr
+        type: //any
-        contents: //str
+        of:
+          - type: //arr
+            contents: //str
+          - type: //nil
       ignore:
-        type: //arr
+        type: //any
-        contents: //str
+        of:
+          - type: //arr
+            contents: //str
+          - type: //nil
       by:
-        type: //arr
+        type: //any
-        contents: //str
+        of:
+          - type: //arr
+            contents: //str
+          - type: //nil
   titles:
     _description: "Comment sont analysés les titres"
     type: //rec
-    optional:
+    required:
       prefix:
-        type: //arr
+        type: //any
-        contents: //str
+        of:
+          - type: //arr
+            contents: //str
+          - type: //nil
   template:
     _description: "Des choses spécifiques au template"
     type: //rec
-    optional:
+    required:
       file: //str
+    optional:
       latex:
         type: //rec
-        optional:
+        required:
           classoptions: //str
       color:
         type: //rec
-        optional:
+        required:
           songnumber: //str
           notebg: //str
           indexbg: //str
       titlepage:
         type: //rec
-        optional:
+        required:
           title: //str
           author: //str
           subtitle: //str

patacrep/songbook/__main__.py

@@ -9,9 +9,9 @@ import sys
 import yaml
 
 from patacrep.build import SongbookBuilder, DEFAULT_STEPS
-from patacrep.utils import yesno
+from patacrep.utils import yesno, DictOfDict
 from patacrep import __version__
-from patacrep import errors
+from patacrep import errors, pkg_datapath
 import patacrep.encoding
 
 # Logging configuration
@@ -133,39 +133,49 @@ def main():
 
     basename = os.path.basename(songbook_path)[:-3]
 
+    # Load the default songbook config
+    default_songbook_path = pkg_datapath('templates', 'default_songbook.sb.yml')
+    with patacrep.encoding.open_read(default_songbook_path) as default_songbook_file:
+        default_songbook = DictOfDict(yaml.load(default_songbook_file))
+
+    # Load the user songbook config
     try:
         with patacrep.encoding.open_read(songbook_path) as songbook_file:
-            songbook = yaml.load(songbook_file)
+            user_songbook = yaml.load(songbook_file)
-        if 'encoding' in songbook:
+        if 'encoding' in user_songbook:
             with patacrep.encoding.open_read(
                 songbook_path,
-                encoding=songbook['encoding']
+                encoding=user_songbook['encoding']
                 ) as songbook_file:
-                songbook = yaml.load(songbook_file)
+                user_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))
         sys.exit(1)
 
+    # Merge the default and user configs
+    default_songbook.update(user_songbook)
+    songbook = dict(default_songbook)
+
     # Gathering datadirs
     datadirs = []
     if options.datadir:
         # Command line options
         datadirs += [item[0] for item in options.datadir]
-    if 'datadir' in songbook:
+    if 'book' in songbook and 'datadir' in songbook['book']:
-        if isinstance(songbook['datadir'], str):
+        if isinstance(songbook['book']['datadir'], str):
-            songbook['datadir'] = [songbook['datadir']]
+            songbook['book']['datadir'] = [songbook['book']['datadir']]
         datadirs += [
             os.path.join(
                 os.path.dirname(os.path.abspath(songbook_path)),
                 path
                 )
-            for path in songbook['datadir']
+            for path in songbook['book']['datadir']
             ]
     # Default value
     datadirs.append(os.path.dirname(os.path.abspath(songbook_path)))
 
-    songbook['datadir'] = datadirs
+    songbook['book']['datadir'] = datadirs
     songbook['_cache'] = options.cache[0]
 
     try: