Bug Fix: Nested Parsing for short answer Qs

Author: runestonetest

runestone/shortanswer/shortanswer.py

@@ -13,45 +13,71 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-__author__ = 'isaiahmayerchak'
-#acbart did most of this code, I mostly just changed the template
+__author__ = "isaiahmayerchak"
+# acbart did most of this code, I mostly just changed the template
 
 from docutils import nodes
 from docutils.parsers.rst import directives
 from runestone.assess import Assessment
 from runestone.server.componentdb import addQuestionToDB, addHTMLToDB
 from runestone.common.runestonedirective import RunestoneDirective, RunestoneNode
 
+
 def setup(app):
-    app.add_directive('shortanswer', JournalDirective)
+    app.add_directive("shortanswer", JournalDirective)
     app.add_node(JournalNode, html=(visit_journal_node, depart_journal_node))
-    app.add_autoversioned_javascript('shortanswer.js')
-    app.add_autoversioned_javascript('timed_shortanswer.js')
-    app.add_config_value('shortanswer_div_class', 'journal alert alert-warning', 'html')
-    app.add_config_value('shortanswer_optional_div_class', 'journal alert alert-success', 'html')
+    app.add_autoversioned_javascript("shortanswer.js")
+    app.add_autoversioned_javascript("timed_shortanswer.js")
+    app.add_config_value("shortanswer_div_class", "journal alert alert-warning", "html")
+    app.add_config_value(
+        "shortanswer_optional_div_class", "journal alert alert-success", "html"
+    )
+
 
-TEXT = """
+TEXT_START = """
 <div class="runestone">
-<p data-component="shortanswer" class="%(divclass)s" id=%(divid)s %(optional)s>%(qnumber)s: %(content)s</p>
+<div data-component="shortanswer" class="%(divclass)s" id=%(divid)s %(optional)s>
+"""
+
+TEXT_END = """
 </div>
+</div> <!-- end of runestone div -->
 """
 
+
 class JournalNode(nodes.General, nodes.Element, RunestoneNode):
     def __init__(self, options, **kwargs):
         super(JournalNode, self).__init__(**kwargs)
         self.journalnode_components = options
 
+
 def visit_journal_node(self, node):
-    div_id = node.journalnode_components['divid']
+    div_id = node.journalnode_components["divid"]
     components = dict(node.journalnode_components)
-    components.update({'divid': div_id})
-    res = TEXT % components
-    addHTMLToDB(div_id, components['basecourse'], res)
+    components.update({"divid": div_id})
+
+    node.delimiter = "_start__{}_".format(node.journalnode_components["divid"])
+    self.body.append(node.delimiter)
+
+    res = TEXT_START % components
 
     self.body.append(res)
 
-def depart_journal_node(self,node):
-    pass
+
+def depart_journal_node(self, node):
+
+    components = dict(node.journalnode_components)
+
+    res = TEXT_END % components
+    self.body.append(res)
+
+    addHTMLToDB(
+        node.journalnode_components["divid"],
+        components["basecourse"],
+        "".join(self.body[self.body.index(node.delimiter) + 1 :]),
+    )
+
+    self.body.remove(node.delimiter)
 
 
 class JournalDirective(Assessment):
@@ -62,16 +88,17 @@ class JournalDirective(Assessment):
    text of the question goes here
 
 
-config values (conf.py): 
+config values (conf.py):
 
 - shortanswer_div_class - custom CSS class of the component's outermost div
     """
+
     required_arguments = 1  # the div id
     optional_arguments = 0
     final_argument_whitespace = True
     has_content = True
     option_spec = Assessment.option_spec.copy()
-    option_spec.update({'optional': directives.flag})
+    option_spec.update({"optional": directives.flag})
 
     node_class = JournalNode
 
@@ -81,15 +108,21 @@ def run(self):
         # Raise an error if the directive does not have contents.
         self.assert_has_content()
 
-        self.options['optional'] = 'data-optional' if 'optional' in self.options else ''
-        self.options['content'] = "<p>".join(self.content)
+        self.options["optional"] = "data-optional" if "optional" in self.options else ""
+
         journal_node = JournalNode(self.options, rawsource=self.block_text)
-        journal_node.source, journal_node.line = self.state_machine.get_source_and_line(self.lineno)
+        journal_node.source, journal_node.line = self.state_machine.get_source_and_line(
+            self.lineno
+        )
+
+        self.updateContent()
+
+        self.state.nested_parse(self.content, self.content_offset, journal_node)
 
         env = self.state.document.settings.env
-        if self.options['optional']:
-            self.options['divclass'] = env.config.shortanswer_optional_div_class
+        if self.options["optional"]:
+            self.options["divclass"] = env.config.shortanswer_optional_div_class
         else:
-            self.options['divclass'] = env.config.shortanswer_div_class
+            self.options["divclass"] = env.config.shortanswer_div_class
 
         return [journal_node]

runestone/shortanswer/test/_sources/Figures/LutherBellPic.jpg

@@ -21,3 +21,16 @@ Short Answer
    :optional:
 
    What are the colors in the rainbow?
+
+
+.. shortanswer:: question2
+   :optional:
+
+   What are the colors in the rainbow?
+   What is meaning of :math:`\pi r^2`
+   How about an image?
+
+   .. image:: Figures/LutherBellPic.jpg
+      :width: 200
+
+   This is the famous Luther Bell!