Merge branch 'xmlconvert'

Author: bnmnetp

requirements-dev.in

@@ -9,4 +9,5 @@ pyvirtualdisplay
 pytest
 pylint
 readme-renderer>24
-myst_parser
+myst_parser
+json2xml

requirements-dev.txt

@@ -22,14 +22,17 @@ babel==2.9.1
     # via sphinx
 bleach==4.1.0
     # via readme-renderer
-certifi==2021.10.8
+certifi==2021.5.30
     # via
+    #   json2xml
     #   requests
     #   urllib3
 cffi==1.15.0
     # via cryptography
-charset-normalizer==2.0.12
-    # via requests
+charset-normalizer==2.0.6
+    # via
+    #   json2xml
+    #   requests
 click==8.0.4
     # via
     #   -r requirements.in
@@ -44,6 +47,8 @@ cryptography==36.0.2
     # via
     #   pyopenssl
     #   urllib3
+defusedxml==0.7.1
+    # via json2xml
 dill==0.3.4
     # via pylint
 docutils==0.17.1
@@ -54,8 +59,9 @@ docutils==0.17.1
     #   sphinx
 h11==0.13.0
     # via wsproto
-idna==3.3
+idna==3.2
     # via
+    #   json2xml
     #   requests
     #   trio
     #   urllib3
@@ -75,6 +81,8 @@ jinja2==3.0.3
     #   -r requirements.in
     #   myst-parser
     #   sphinx
+json2xml==3.16.0
+    # via -r requirements-dev.in
 keyring==23.5.0
     # via twine
 lazy-object-proxy==1.7.1
@@ -145,8 +153,9 @@ readme-renderer==34.0
     # via
     #   -r requirements-dev.in
     #   twine
-requests==2.27.1
+requests==2.26.0
     # via
+    #   json2xml
     #   requests-toolbelt
     #   sphinx
     #   twine
@@ -208,8 +217,9 @@ typing-extensions==4.1.1
     #   astroid
     #   myst-parser
     #   pylint
-urllib3[secure,socks]==1.26.9
+urllib3[secure,socks]==1.26.7
     # via
+    #   json2xml
     #   requests
     #   selenium
     #   twine
@@ -223,6 +233,8 @@ wrapt==1.14.0
     # via astroid
 wsproto==1.1.0
     # via trio-websocket
+xmltodict==0.12.0
+    # via json2xml
 zipp==3.7.0
     # via importlib-metadata
 

runestone/__main__.py

@@ -324,8 +324,9 @@ def rs2ptx(course, sourcedir, outdir):
     del os.environ["DBURL"]
     try:
         import pavement
-    except:
+    except Exception as e:
         click.echo("Could not read pavement.py file, aborting")
+        click.echo(f"Details: {e}")
         sys.exit(1)
 
     if not course:

runestone/activecode/activecode.py

@@ -47,7 +47,7 @@ def setup(app):
     app.add_role("textfield", textfield_role)
     app.add_config_value(
         "activecode_div_class",
-        "runestone explainer ac_section alert alert-warning",
+        "runestone explainer ac_section",
         "html",
     )
     app.add_config_value("activecode_hide_load_history", False, "html")
@@ -60,18 +60,30 @@ def setup(app):
     app.connect("env-purge-doc", purge_activecodes)
 
 
-XML_START = """
-<listing xml:id="{divid}">
-    <caption>{caption}</caption>
-    <program xml:id="{divid}_editor" interactive='yes' language="{language}">
+XML_EX_START = """
+<exercise xml:id="{divid}">
+    <statement>
+"""
+
+XML_EX_END = """
+    </statement>
+    <program xml:id="{divid}_editor" interactive='activecode' language="{language}">
         <input>
-        {initialcode}
+{initialcode}
         </input>
     </program>
-</listing>
+</exercise>
+"""
 
+XML_LISTING_START = """
+    <program xml:id="{divid}" interactive='activecode' language="{language}">
+        <input>
+{initialcode}
+        </input>
+    </program>
 """
 
+
 TEMPLATE_START = """
 <div class="%(divclass)s %(optclass)s">
 <div data-component="activecode" id=%(divid)s data-question_label="%(question_label)s">
@@ -97,12 +109,21 @@ class ActivecodeNode(nodes.General, nodes.Element, RunestoneIdNode):
 
 
 def visit_ac_xml(self, node):
-    res = XML_START.format(**node["runestone_options"])
-    self.output.append(res)
+    if node["runestone_options"]["has_problem_statement"]:
+        res = XML_EX_START.format(**node["runestone_options"])
+        self.output.append(res)
+    else:
+        node["runestone_options"]["initialcode"] = node["runestone_options"]["initialcode"].replace(
+            "<", "&lt;").replace(">", "&gt;")
 
 
 def depart_ac_xml(self, node):
-    pass
+    if node["runestone_options"]["has_problem_statement"]:
+        res = XML_EX_END.format(**node["runestone_options"])
+        self.output.append(res)
+    else:
+        res = XML_LISTING_START.format(**node["runestone_options"])
+        self.output.append(res)
 
 # self for these functions is an instance of the writer class.  For example
 # in html, self is sphinx.writers.html.SmartyPantsHTMLTranslator
@@ -252,7 +273,13 @@ def run(self):
         else:
             source = "\n"
 
-        self.explain_text = explain_text or ["Not an Exercise"]
+        if explain_text:
+            self.options["has_problem_statement"] = True
+            self.explain_text = explain_text
+        else:
+            self.options["has_problem_statement"] = False
+            self.explain_text = ["Not an Exercise"]
+
         addQuestionToDB(self)
 
         self.options["initialcode"] = source

runestone/activecode/css/activecode.css

@@ -61,7 +61,12 @@
     position: initial;
 }
 
+.unittest-results {
+    margin-left: 20px;
+}
+
 .ac_output {
+    margin-top: 10px;
     display: none;
     background-color: inherit;
 }
@@ -79,7 +84,7 @@
 }
 
 .ac_question {
-    background-color: rgb(224, 236, 217);
+    background-color: var(--questionBgColor);
     padding-left: 10px;
     padding-top: 10px;
     margin: 5px;
@@ -114,6 +119,11 @@
     padding: 3px;
 }
 
+.CodeMirror {
+    border: solid 2px;
+    margin-bottom: 10px;
+}
+
 .ac_sql_result {
     background-color: lightgrey;
     padding: 10px;

runestone/activecode/js/activecode.js

@@ -151,7 +151,6 @@ export class ActiveCode extends RunestoneBase {
         this.outerDiv = document.createElement("div");
         var linkdiv = document.createElement("div");
         linkdiv.id = this.divid.replace(/_/g, "-").toLowerCase(); // :ref: changes _ to - so add this as a target
-        $(this.outerDiv).addClass("ac_section alert alert-warning");
         var codeDiv = document.createElement("div");
         $(codeDiv).addClass("ac_code_div col-md-12");
         this.codeDiv = codeDiv;

runestone/clickableArea/clickable.py

@@ -24,14 +24,16 @@
     maybeAddToAssignment,
 )
 from runestone.common.runestonedirective import RunestoneIdDirective, RunestoneIdNode
+from runestone.common.xmlcommon import write_substitute, substitute_visitor, substitute_departure
 
 
 def setup(app):
     app.add_directive("clickablearea", ClickableArea)
 
-    app.add_node(ClickableAreaNode, html=(visit_ca_html, depart_ca_html))
+    app.add_node(ClickableAreaNode, html=(visit_ca_html, depart_ca_html),
+                 xml=(visit_ca_xml, depart_ca_xml))
 
-    app.add_config_value("clickable_div_class", "runestone alert alert-warning", "html")
+    app.add_config_value("clickable_div_class", "", "html")
 
 
 TEMPLATE = """
@@ -44,6 +46,11 @@ def setup(app):
 </div>
 """
 
+XML_START = """
+<exercise xml:id="{divid}">
+    <statement><p>{question}</p></statement>
+"""
+
 
 class ClickableAreaNode(nodes.General, nodes.Element, RunestoneIdNode):
     pass
@@ -95,6 +102,29 @@ def depart_ca_html(self, node):
     self.body.remove(node["delimiter"])
 
 
+def visit_ca_xml(self, node):
+    res = XML_START.format(**node["runestone_options"])
+    if node["runestone_options"].get("feedback", None):
+        res += "<feedback><p>{feedback}</p></feedback>\n".format(
+            **node["runestone_options"])
+    res += "<areas>\n"
+    if "iscode" in node["runestone_options"]:
+        # The case where iscode is not in options makes no sense and probably does not exist in
+        # any runestone books
+        for row in node["runestone_options"]["raw_source"]:
+            row = row.replace("\n", "")
+            row = row.replace(":click-correct:", "<area correct='yes'>")
+            row = row.replace(":click-incorrect:", "<area>")
+            row = row.replace(":endclick", "</area>")
+            row = "<cline>" + row + "</cline>\n"
+            res += row
+    self.output.append(res)
+
+
+def depart_ca_xml(self, node):
+    self.output.append("</areas></exercise>")
+
+
 class ClickableArea(RunestoneIdDirective):
     """
 .. clickablearea:: identifier
@@ -157,6 +187,7 @@ def run(self):
             source = source.replace(":endclick:", "</span>")
             source = "<pre>" + source + "</pre>"
             self.options["clickcode"] = source
+            self.options["raw_source"] = self.content
         else:
             self.options["clickcode"] = ""
         clickNode = ClickableAreaNode()

runestone/codelens/visualizer.py

@@ -29,9 +29,10 @@
 def setup(app):
     app.add_directive("codelens", Codelens)
 
-    app.add_config_value("codelens_div_class", "alert alert-warning cd_section", "html")
+    app.add_config_value("codelens_div_class", "cd_section", "html")
     app.add_config_value("trace_url", "http://tracer.runestone.academy:5000", "html")
-    app.add_node(CodeLensNode, html=(visit_codelens_html, depart_codelens_html))
+    app.add_node(CodeLensNode, html=(visit_codelens_html, depart_codelens_html),
+                 xml=(visit_codelens_xml, depart_codelens_xml))
 
 
 #  data-tracefile="pytutor-embed-demo/java.json"
@@ -60,11 +61,30 @@ def setup(app):
 </div>
 """
 
+PTX_TEMPLATE = """
+<program xml:id="{divid} interactive="codelens" language="{language}>
+    <input>
+{source}
+    </input>
+</program>
+"""
+
 
 class CodeLensNode(nodes.General, nodes.Element, RunestoneIdNode):
     pass
 
 
+def visit_codelens_xml(self, node):
+    html = VIS
+    if "caption" not in node["runestone_options"]:
+        node["runestone_options"]["caption"] = node["runestone_options"]["question_label"]
+    if "tracedata" in node["runestone_options"]:
+        node["runestone_options"]["tracedata"] = node["runestone_options"]["tracedata"].replace(
+            "<", "&lt;").replace(">", "&gt;")
+
+    res = PTX_TEMPLATE.format(**node["runestone_options"])
+
+
 def visit_codelens_html(self, node):
     html = VIS
     if "caption" not in node["runestone_options"]:
@@ -85,6 +105,10 @@ def depart_codelens_html(self, node):
     pass
 
 
+def depart_codelens_xml(self, node):
+    pass
+
+
 # Some documentation to help the author.
 # Here's and example of a single stack frame.
 # you might ask a qestion about the value of a global variable
@@ -183,7 +207,7 @@ def js_var_finalizer(input_code, output_trace):
             source = "\n".join(self.content)
         else:
             source = "\n"
-
+        self.options["source"] = source.replace("<", "&lt;")
         CUMULATIVE_MODE = False
         self.JS_VARNAME = self.options["divid"] + "_trace"
         env = self.state.document.settings.env