Merge pull request #105 from gvwilson/analytics

[rnaseq-cwl-training.git] / bin / lesson_check.py

diff --git a/bin/lesson_check.py b/bin/lesson_check.py
index ace8de6943c9a5552827f68952ed2d2eda0a72fc..311687e92ac851ba3c5c5af2720ce45d03490902 100755 (executable)
--- a/bin/lesson_check.py
+++ b/bin/lesson_check.py
@@ -47,6 +47,9 @@ P_TRAILING_WHITESPACE = re.compile(r'\s+$')
 # Pattern to match figure references in HTML.
 P_FIGURE_REFS = re.compile(r'<img[^>]+src="([^"]+)"[^>]*>')
 
+# Pattern to match internally-defined Markdown links.
+P_INTERNALLY_DEFINED_LINK = re.compile(r'\[[^\]]+\]\[[^\]]+\]')
+
 # What kinds of blockquotes are allowed?
 KNOWN_BLOCKQUOTES = {
     'callout',
@@ -152,6 +155,10 @@ def check_config(reporter, source_dir):
     reporter.check_field(config_file, 'configuration', config, 'title')
     reporter.check_field(config_file, 'configuration', config, 'email')
 
+    reporter.check({'values': {'root': '..'}} in config.get('defaults', []),
+                   'configuration',
+                   '"root" not set to ".." in configuration')
+
 
 def read_all_markdown(source_dir, parser):
     """Read source files, returning
@@ -274,6 +281,7 @@ class CheckBase(object):
         self.check_trailing_whitespace()
         self.check_blockquote_classes()
         self.check_codeblock_classes()
+        self.check_defined_link_references()
 
 
     def check_metadata(self):
@@ -331,6 +339,26 @@ class CheckBase(object):
                                 cls)
 
 
+    def check_defined_link_references(self):
+        """Check that defined links resolve in the file.
+
+        Internally-defined links match the pattern [text][label].  If
+        the label contains '{{...}}', it is hopefully a references to
+        a configuration value - we should check that, but don't right
+        now.
+        """
+
+        result = set()
+        for node in self.find_all(self.doc, {'type' : 'text'}):
+            for match in P_INTERNALLY_DEFINED_LINK.findall(node['value']):
+                if '{{' not in match:
+                    result.add(match)
+        self.reporter.check(not result,
+                            self.filename,
+                            'Internally-defined links may be missing definitions: {0}',
+                            ', '.join(sorted(result)))
+
+
     def find_all(self, node, pattern, accum=None):
         """Find all matches for a pattern."""
 
@@ -400,6 +428,12 @@ class CheckIndex(CheckBase):
         super(CheckIndex, self).__init__(args, filename, metadata, metadata_len, text, lines, doc)
         self.layout = 'lesson'
 
+    def check_metadata(self):
+        super(CheckIndex, self).check_metadata()
+        self.reporter.check(self.metadata.get('root', '') == '.',
+                            self.filename,
+                            'Root not set to "."')
+
 
 class CheckEpisode(CheckBase):
     """Check an episode page."""