Merge pull request #194 from uccser/issue/193

Clear IDs only when requested.

Author: haydenjackson01

docs/source/usage.rst

@@ -116,6 +116,15 @@ The following attributes are available:
           []
       }
 
+(Optional) Step 5: Clearing Saved Data
+=======================================
+
+Lastly there is some data that is saved between conversions such as ``required_files`` and unique ids used in the ``glossary`` and for ``headings``. This can be cleared by using the following method:
+
+  .. code-block:: python
+
+    converter.clear_saved_data()
+
 Configuring Verto converter after creation
 ===============================================
 
@@ -155,7 +164,7 @@ Full list of package methods
 =======================================
 
 .. autoclass:: verto.Verto()
-  :members: __init__, convert, update_processors, processor_defaults, update_templates, clear_templates
+  :members: __init__, convert, update_processors, processor_defaults, update_templates, clear_templates, clear_saved_data
 
 .. autoclass:: verto.Verto.VertoResult()
 
@@ -170,3 +179,11 @@ Full list of package methods
   .. attribute:: required_files
 
     A dictionary of files encountered in a Verto conversion. The dictionary has a string for the file type as the key (for example: ``image``) and a set of all file paths encountered as the value (for example: ``{'image/face.png', 'image/logo.png`}``).
+
+  .. attribute:: heading_tree
+
+     A tuple of namedtuples which describes the tree of headings, as generated by our heading processor. Each namedtuple contains a title (string), title_slug (string), level (integer) and children (tuple of nodes).
+
+  .. attribute:: required_glossary_terms
+
+     A dictionary of terms to a list of tuples containing reference text and link IDs.

verto/Verto.py

@@ -66,7 +66,7 @@ def convert(self, text):
         Returns:
             A VertoResult object.
         '''
-        self.verto_extension.clear_saved_data()
+        self.verto_extension.clear_document_data()
         html_string = self.converter.convert(text)
         result = VertoResult(
             html_string=html_string,
@@ -77,6 +77,12 @@ def convert(self, text):
         )
         return result
 
+    def clear_saved_data(self):
+        '''Clears data that is saved between documents. This should be
+        called between conversions on unrelated documents.
+        '''
+        self.verto_extension.clear_saved_data()
+
     def update_templates(self, html_templates):
         '''Update the template dictionary with the given dictionary
         of templates, while leaving all other HTML templates (including

verto/VertoExtension.py

@@ -56,15 +56,14 @@ def __init__(self, processors=[], html_templates={}, extensions=[], *args, **kwa
             extensions: A list of extra extensions for compatibility.
         '''
         super().__init__(*args, **kwargs)
-        self.required_files = defaultdict(set)
-        self.title = None
         self.jinja_templates = self.loadJinjaTemplates(html_templates)
         self.processor_info = self.loadProcessorInfo()
         self.processors = processors
+        self.title = None
+        self.heading_tree = None
         self.custom_slugify = UniqueSlugify()
         self.glossary_terms = defaultdict(list)
-        self.heading_tree = None
-
+        self.required_files = defaultdict(set)
         self.compatibility = []
         for extension in extensions:
             if isinstance(extension, utils.string_type):
@@ -114,13 +113,18 @@ def update_processors(processors, markdown_processors):
                 processor = ScratchCompatibilityPreprocessor(self, md)
                 md.preprocessors.add('scratch-compatibility', processor, '<fenced_code_block')
 
+    def clear_document_data(self):
+        '''Clears information stored for a specific document.
+        '''
+        self.title = None
+        self.heading_tree = None
+
     def clear_saved_data(self):
         '''Clears stored information from processors, should be called
-        between runs.
+        between runs on unrelated documents.
         '''
-        self.title = None
         self.custom_slugify.clear()
-        self.heading_tree = None
+        self.glossary_terms.clear()
         for key in self.required_files.keys():
             self.required_files[key].clear()
 

verto/processors/HeadingBlockProcessor.py

@@ -52,7 +52,6 @@ def run(self, parent, blocks):
         '''
         block = blocks.pop(0)
         match = self.pattern.search(block)
-        assert match is not None  # If this is true how did we test successfully
 
         before = block[:match.start()]
         after = block[match.end():]
@@ -91,6 +90,7 @@ def add_to_heading_tree(self, heading, heading_slug, level):
             level: the level of the heading
         '''
         if self.get_ext_tree() is None:  # We are likely on a new file
+            self.roots = []
             self.current_node = None
 
         # Who is our parent node

verto/tests/ConfigurationTest.py

@@ -129,15 +129,108 @@ def test_multiple_calls(self):
             )
         ]
 
+        verto = Verto()
         for filename, expected_result in test_cases:
-            verto = Verto()
             test_string = self.read_test_file(self.test_name, filename)
             verto_result = verto.convert(test_string)
 
             self.assertEqual(verto_result.title, expected_result.title)
             self.assertEqual(verto_result.required_files, expected_result.required_files)
             self.assertTupleEqual(verto_result.heading_tree, expected_result.heading_tree)
             self.assertDictEqual(verto_result.required_glossary_terms, expected_result.required_glossary_terms)
+            verto.clear_saved_data()
+
+    def test_multiple_calls_without_clearing(self):
+        '''Tests that if the verto extension is not cleared that
+        information such as required_files and slugs are persistant.
+        '''
+        filename = 'all_processors.md'
+        other_filename = 'otherfile.md'
+        expected_result = VertoResult(
+                                html_string=self.read_test_file(self.test_name, 'all_processors_expected.html', strip=True),
+                                title='Example Title',
+                                required_files={
+                                    'interactives': {
+                                        'binary-cards'
+                                    },
+                                    'images': set(),
+                                    'page_scripts': set(),
+                                    'scratch_images': {
+                                        ScratchImageMetaData(
+                                            hash='a0f8fcad796864abfacac8bda6e0719813833fd1fca348700abbd040557c1576',
+                                            text='when flag clicked\nclear\nforever\npen down\nif <<mouse down?> and <touching [mouse-pointer v]?>> then\nswitch costume to [button v]\nelse\nadd (x position) to [list v]\nend\nmove (foo) steps\nturn ccw (9) degrees'
+                                        ),
+                                    }
+                                },
+                                heading_tree=(HeadingNode(
+                                        title='Example Title',
+                                        title_slug='example-title',
+                                        level=1,
+                                        children=(),
+                                    ),
+                                    HeadingNode(
+                                        title='Example Title 2',
+                                        title_slug='example-title-2',
+                                        level=1,
+                                        children=()
+                                    ),
+                                ),
+                                required_glossary_terms={
+                                    'algorithm': []
+                                }
+                            )
+        expected_otherfile_result = VertoResult(
+                                html_string=self.read_test_file(self.test_name, 'otherfile_expected.html', strip=True),
+                                title='Example Title',
+                                required_files={
+                                    'interactives': {
+                                        'binary-cards'
+                                    },
+                                    'images': {
+                                        'pixel-diamond.png'
+                                    },
+                                    'page_scripts': set(),
+                                    'scratch_images': {
+                                        ScratchImageMetaData(
+                                            hash='a0f8fcad796864abfacac8bda6e0719813833fd1fca348700abbd040557c1576',
+                                            text='when flag clicked\nclear\nforever\npen down\nif <<mouse down?> and <touching [mouse-pointer v]?>> then\nswitch costume to [button v]\nelse\nadd (x position) to [list v]\nend\nmove (foo) steps\nturn ccw (9) degrees'
+                                        ),
+                                        ScratchImageMetaData(
+                                            hash='b78bff524e54a18116e1e898a93e360827f874a8b0b508e1edc47d21516495ad',
+                                            text='never\ngoing\nto\ngive\nyou\nup'
+                                        ),
+                                    }
+                                },
+                                heading_tree=(HeadingNode(
+                                        title='Example Title',
+                                        title_slug='example-title-3',
+                                        level=1,
+                                        children=(),
+                                    ),
+                                ),
+                                required_glossary_terms={
+                                    'algorithm': []
+                                }
+                            )
+
+        verto = Verto()
+        # First file
+        test_string = self.read_test_file(self.test_name, filename)
+        verto_result = verto.convert(test_string)
+
+        self.assertEqual(verto_result.title, expected_result.title)
+        self.assertEqual(verto_result.required_files, expected_result.required_files)
+        self.assertTupleEqual(verto_result.heading_tree, expected_result.heading_tree)
+        self.assertDictEqual(verto_result.required_glossary_terms, expected_result.required_glossary_terms)
+
+        # Another file
+        test_string = self.read_test_file(self.test_name, other_filename)
+        verto_result = verto.convert(test_string)
+
+        self.assertEqual(verto_result.title, expected_otherfile_result.title)
+        self.assertEqual(verto_result.required_files, expected_otherfile_result.required_files)
+        self.assertTupleEqual(verto_result.heading_tree, expected_otherfile_result.heading_tree)
+        self.assertDictEqual(verto_result.required_glossary_terms, expected_otherfile_result.required_glossary_terms)
 
     def test_custom_processors_and_custom_templates_on_creation(self):
         '''Checks if custom processors and custom templates work

verto/tests/assets/configuration/otherfile.md

@@ -0,0 +1,11 @@
+# Example Title
+
+{image file-path="pixel-diamond.png" alt="A diamond shape made out of pixels"}
+
+    scratch
+    never
+    going
+    to
+    give
+    you
+    up

verto/tests/assets/configuration/otherfile_expected.html

@@ -0,0 +1,11 @@
+<h1 id="example-title">
+<span class="section_number">
+{{ chapter.number }}.
+</span>
+Example Title
+</h1>
+<div>
+<img alt="A diamond shape made out of pixels" class="" src="{% static 'pixel-diamond.png' %}" />
+</div>
+<object data="{% static 'scratch-blocks-b78bff524e54a18116e1e898a93e360827f874a8b0b508e1edc47d21516495ad.svg' %}" type="image/svg+xml">
+</object>