produce MANIFEST_hidden.yml

The LTI tool needs to know about hidden items so they can be picked.

The MANIFEST_hidden.yml includes all hidden items and is not included in
the zip file of the package.

chirun/cli.py

@@ -48,6 +48,7 @@ def __init__(self, args):
         self.build_dir = (Path(args.build_path) if args.build_path is not None else (self.root_dir / 'build')).resolve()
 
         self.hidden_paths = []  # A list of directories containing hidden items, filled in by process.FindHiddenItemsProcess.
+        self.hidden_files = [Path('MANIFEST_hidden.json')]
 
         if args.veryverbose:
             args.verbose = True
@@ -353,13 +354,20 @@ def package_zip(self):
         if zipfile_name is None:
             return
 
-        with zipfile.ZipFile(self.build_dir / zipfile_name, mode='w') as zf:
+        zipfile_path = self.build_dir / zipfile_name
+
+        if zipfile_path.exists():
+            zipfile_path.unlink()
+
+        with zipfile.ZipFile(zipfile_path, mode='w') as zf:
             for d, dirs, files in os.walk(str(self.build_dir)):
                 if any(Path(d).is_relative_to(self.build_dir / p) for p in self.hidden_paths):
                     continue
                 for f in files:
                     p = self.build_dir.parent / d / f
                     fname = p.relative_to(self.build_dir)
+                    if fname in self.hidden_files:
+                        continue
                     if fname == zipfile_name:
                         continue
                     zf.write(p, fname)
@@ -414,12 +422,19 @@ def remove_hidden(items):
                     item['content'] = remove_hidden(item['content'])
             return items
 
+        del manifest['args']
+        del manifest['static_dir']
+
         manifest.update({
-            'structure': remove_hidden([item.content_tree() for item in self.structure]),
             'zipfile': str(self.get_zipfile_name()),
+            'structure': [item.content_tree() for item in self.structure],
+        })
+
+        hidden_manifest = copy.deepcopy(manifest)
+
+        manifest.update({
+            'structure': remove_hidden(manifest['structure']),
         })
-        del manifest['args']
-        del manifest['static_dir']
 
         manifest_path = self.build_dir / 'MANIFEST.yml'
 
@@ -429,6 +444,9 @@ def remove_hidden(items):
         with open(manifest_path.with_suffix('.json'), 'w') as f:
             json.dump(manifest, f)
 
+        with open(self.build_dir / 'MANIFEST_hidden.json', 'w') as f:
+            json.dump(hidden_manifest, f)
+
 
     def build_with_theme(self, theme):
         """

chirun/latex.py

@@ -108,7 +108,7 @@ def toc_from_aux(self, splitlevel):
         return self.toc
 
     def read_aux_file(self, filename, splitlevel):
-        """
+        r"""
             Read a .aux file and save any table of contents entries found in it.
 
             A TOC entry looks like::

unittests/__init__.py

@@ -85,6 +85,11 @@ def get_manifest(self):
         with open(self.build_dir / 'MANIFEST.json') as fp:
             return json.load(fp)
 
+    @functools.cache
+    def get_hidden_manifest(self):
+        with open(self.build_dir / 'MANIFEST_hidden.json') as fp:
+            return json.load(fp)
+
 class ExpectCrashTest(ChirunCompilationTest):
     r"""
         A test case which expects Chirun to quit with an error.

unittests/basic.py

@@ -49,9 +49,16 @@ def test_metadata(self):
     def test_structure(self):
         manifest = self.get_manifest()
 
-        self.assertEqual(len(manifest['structure']), 3, msg="There are two items in the structure.")
+        self.assertEqual(len(manifest['structure']), 3, msg="There are two items in the structure as well as the introduction.")
         self.assertEqual([x['type'] for x in manifest['structure']], ['introduction', 'chapter', 'chapter'], msg="There is an introduction and two chapters.")
 
+    def test_hidden_structure(self):
+        manifest = self.get_hidden_manifest()
+
+        self.assertEqual(len(manifest['structure']), 4, msg="There are three items in the structure as well as the introduction.")
+        self.assertEqual([x['type'] for x in manifest['structure']], ['introduction', 'chapter', 'chapter', 'chapter'], msg="There is an introduction and three chapters.")
+        self.assertTrue(manifest['structure'][3]['is_hidden'], "The third chapter is hidden.")
+
     def test_empty_links(self):
         """
             Check that all links on the introduction page contain readable text.

unittests/basic/config.yml

@@ -16,3 +16,7 @@ structure:
   - type: chapter
     title: "Basic markdown document"
     source: test.md
+  - type: chapter
+    title: "Basic hidden markdown document"
+    source: test.md
+    is_hidden: true

unittests/structure.py

@@ -128,6 +128,8 @@ def test_zipfile(self):
                 p = Path(dirpath, filename).relative_to(self.build_dir)
                 if p.suffix == '.zip':
                     continue
+                if p.name == 'MANIFEST_hidden.json':
+                    continue
                 disk_filenames.append(str(p))
 
         self.assertEqual(set(disk_filenames), set(zip_filenames))