Merge branch 'master' of github.com:RunestoneInteractive/RunestoneComponents into merging

Author: zihan21206

runestone/__main__.py

@@ -1,6 +1,8 @@
 # *********
 # |docname|
 # *********
+
+from runestone import cmap
 import sys
 import os
 import shutil
@@ -9,6 +11,7 @@
 import click
 import pathlib
 import re
+import subprocess
 from paver.easy import sh
 from pkg_resources import resource_string, resource_filename, require
 from .pretext.chapter_pop import manifest_data_to_db
@@ -191,10 +194,14 @@ def build(all, wd):
     paver_main(args=myargs)
 
 
-@cli.command()
+@cli.command(short_help="preview the book in a minimal server (NO API support)")
 @click.option("--port", default=8000, help="port for server to listen on")
 @click.option("--listen", default="", help="address for server to listen on")
-def serve(port, listen):
+def preview(port, listen):
+    _preview(port, listen)
+
+
+def _preview(port, listen):
     click.echo("Note: this is a minimal static server without templates or a database.")
     click.echo("For many use cases this is fine.")
     click.echo(
@@ -246,6 +253,15 @@ def serve(port, listen):
     httpd.serve_forever()
 
 
+# configure preview as an alias for serve
+@cli.command(short_help="Deprecated - use preview")
+@click.option("--port", default=8000, help="port for server to listen on")
+@click.option("--listen", default="", help="address for server to listen on")
+def serve(port, listen):
+    click.echo("The serve command is deprecated, use runestone preview")
+    _preview(port, listen)
+
+
 @cli.command()
 @click.option("--dest", default="", help="destination for deploy")
 def deploy(dest):
@@ -286,7 +302,58 @@ def deploy(dest):
         sh("rsync -rav --delete {} {}".format(pavement.serving_dir, dest))
 
 
-from runestone import cmap
+@cli.command(short_help="Run sphinx build to convert RST to PreTeXt")
+@click.option("--course", default=None, help="Unique name of the book")
+@click.option("--sourcedir", default="_sources", help="Where is the source Luke?")
+@click.option("--outdir", default="build", help="Where is the source Luke?")
+def rs2ptx(course, sourcedir, outdir):
+    """
+    Assemble and run a sphinx command similar to the following:
+
+    .. code-block:: bash
+
+        sphinx-build -b xml -d ./build/overview/doctrees -c . -Acourse_id=overview -Alogin_required=false -Aappname=runestone -Aloglevel=10 -Acourse_url=https://runestone.academy -Adynamic_pages=True -Ause_services=true -Abasecourse=overview -Apython3=true -Adownloads_enabled=true -Aallow_pairs=false -Aenable_chatcodes=false -Arunestone_version=5.7.1 -Abuild_info=unknown . ./build/xml
+
+    This command demonstrates a step toward independence from paver and the pavement.py file.
+    This is kind of moot in a future where we rely on pretext to be the authoring language. But it **would**
+    be easy to move the key variables and template_args from pavement.py to conf.py  and update the build
+    command to work like this...
+    """
+    os.chdir(findProjectRoot())
+    sys.path.insert(0, os.getcwd())
+    del os.environ["DBURL"]
+    try:
+        import pavement
+    except:
+        click.echo("Could not read pavement.py file, aborting")
+        sys.exit(1)
+
+    if not course:
+        if pavement.project_name:
+            course = pavement.project_name
+        else:
+            course = click.prompt("Name of Course ", default="rsbook")
+
+    if pavement.template_args:
+        tdict = pavement.template_args
+    else:
+        tdict = {"course_id": course}
+
+    cmd_start = ["sphinx-build", "-E", "-b", "xml",
+                 "-d", f"./build/{course}/doctrees", "-c", "."]
+    tplate_val = [f"-A{key}={val}" for key, val in tdict.items()]
+    cmd_end = [f"{sourcedir}", f"./{outdir}/xml"]
+    cmd = " ".join(cmd_start + tplate_val + cmd_end)
+    click.echo(cmd)
+    try:
+        cp = subprocess.run(
+            cmd , shell=True, check=True
+        )
+    except subprocess.CalledProcessError as e:
+        click.echo(f"{e.stderr or ''}{e.stdout or ''}")
+        raise
+
+    # TODO: Run the xsltproc command after a successful runestone convert
 
 
 @cli.command(short_help="type runestone doc directive to get help on directive")

runestone/activecode/activecode.py

@@ -53,12 +53,25 @@ def setup(app):
     app.add_config_value("activecode_hide_load_history", False, "html")
     app.add_config_value("wasm_uri", "/_static", "html")
 
-    app.add_node(ActivcodeNode, html=(visit_ac_node, depart_ac_node))
+    app.add_node(ActivecodeNode, html=(visit_ac_html, depart_ac_html),
+                 xml=(visit_ac_xml, depart_ac_xml))
 
     app.connect("doctree-resolved", process_activcode_nodes)
     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}">
+        <input>
+        {initialcode}
+        </input>
+    </program>
+</listing>
+
+"""
+
 TEMPLATE_START = """
 <div class="%(divclass)s">
 <div data-component="activecode" id=%(divid)s data-question_label="%(question_label)s">
@@ -79,51 +92,49 @@ def setup(app):
 """
 
 
-class ActivcodeNode(nodes.General, nodes.Element, RunestoneIdNode):
-    def __init__(self, content, **kwargs):
-        """
+class ActivecodeNode(nodes.General, nodes.Element, RunestoneIdNode):
+    pass
+
+
+def visit_ac_xml(self, node):
+    res = XML_START.format(**node["runestone_options"])
+    self.output.append(res)
 
-        Arguments:
-        - `self`:
-        - `content`:
-        """
-        super(ActivcodeNode, self).__init__(name=content["name"], **kwargs)
-        self.runestone_options = content
 
+def depart_ac_xml(self, node):
+    pass
 
 # self for these functions is an instance of the writer class.  For example
 # in html, self is sphinx.writers.html.SmartyPantsHTMLTranslator
 # The node that is passed as a parameter is an instance of our node class.
-def visit_ac_node(self, node):
-    # print self.settings.env.activecodecounter
 
-    # todo:  handle above in node.runestone_options
-    # todo handle  'hidecode' not in node.runestone_options:
-    # todo:  handle if 'gradebutton' in node.runestone_options: res += GRADES
 
-    node.delimiter = "_start__{}_".format(node.runestone_options["divid"])
+def visit_ac_html(self, node):
+    # print self.settings.env.activecodecounter
+
+    node["delimiter"] = "_start__{}_".format(node["runestone_options"]["divid"])
 
-    self.body.append(node.delimiter)
+    self.body.append(node["delimiter"])
 
-    res = TEMPLATE_START % node.runestone_options
+    res = TEMPLATE_START % node["runestone_options"]
     self.body.append(res)
 
 
-def depart_ac_node(self, node):
+def depart_ac_html(self, node):
     """This is called at the start of processing an activecode node.  If activecode had recursive nodes
-    etc and did not want to do all of the processing in visit_ac_node any finishing touches could be
+    etc and did not want to do all of the processing in visit_ac_html any finishing touches could be
     added here.
     """
-    res = TEMPLATE_END % node.runestone_options
+    res = TEMPLATE_END % node["runestone_options"]
     self.body.append(res)
 
     addHTMLToDB(
-        node.runestone_options["divid"],
-        node.runestone_options["basecourse"],
-        "".join(self.body[self.body.index(node.delimiter) + 1 :]),
+        node["runestone_options"]["divid"],
+        node["runestone_options"]["basecourse"],
+        "".join(self.body[self.body.index(node["delimiter"]) + 1 :]),
     )
 
-    self.body.remove(node.delimiter)
+    self.body.remove(node["delimiter"])
 
 
 def process_activcode_nodes(app, env, docname):
@@ -448,8 +459,10 @@ def run(self):
                     "This should only affect the grading interface. Everything else should be fine."
                 )
 
-        acnode = ActivcodeNode(self.options, rawsource=self.block_text)
-        acnode.source, acnode.line = self.state_machine.get_source_and_line(self.lineno)
+        acnode = ActivecodeNode()
+        acnode["runestone_options"] = self.options
+        acnode["source"], acnode["line"] = self.state_machine.get_source_and_line(
+            self.lineno)
         self.add_name(acnode)  # make this divid available as a target for :ref:
 
         maybeAddToAssignment(self)

runestone/assignment/__init__.py

@@ -36,7 +36,7 @@
 
 def setup(app):
     app.add_directive("assignment", Assignment)
-    app.add_node(AssignmentNode, html=(visit_a_node, depart_a_node))
+    app.add_node(AssignmentNode, html=(visit_a_html, depart_a_html))
 
     app.connect("doctree-resolved", process_nodes)
     app.connect("env-purge-doc", purge)
@@ -54,13 +54,13 @@ def __init__(self, content, **kwargs):
         self.a_components = content
 
 
-def visit_a_node(self, node):
+def visit_a_html(self, node):
     pass
 
 
-def depart_a_node(self, node):
-    question_ids = node.a_components["question_ids"]
-    basecourse = node.a_components["basecourse"]
+def depart_a_html(self, node):
+    question_ids = node["a_components"]["question_ids"]
+    basecourse = node["a_components"]["basecourse"]
     for q_id in question_ids:
         src = get_HTML_from_DB(q_id, basecourse)
         if src:

runestone/blockly/blockly.py

@@ -33,7 +33,7 @@
 def setup(app):
     app.add_directive("blockly", Blockly)
 
-    app.add_node(BlocklyNode, html=(visit_block_node, depart_block_node))
+    app.add_node(BlocklyNode, html=(visit_block_html, depart_block_html))
 
     app.connect("doctree-resolved", process_activcode_nodes)
     app.connect("env-purge-doc", purge_activecodes)
@@ -154,10 +154,12 @@ def __init__(self, content, **kwargs):
 # self for these functions is an instance of the writer class.  For example
 # in html, self is sphinx.writers.html.SmartyPantsHTMLTranslator
 # The node that is passed as a parameter is an instance of our node class.
-def visit_block_node(self, node):
-    res = START % (node.runestone_options)
+
+
+def visit_block_html(self, node):
+    res = START % (node["runestone_options"])
     res += CTRL_START
-    for ctrl in node.runestone_options["controls"]:
+    for ctrl in node["runestone_options"]["controls"]:
         if ctrl == "variables":
             res += '<category name="Variables" custom="VARIABLE"></category>'
         elif ctrl == "":
@@ -169,11 +171,11 @@ def visit_block_node(self, node):
         else:
             res += '<block type="%s"></block>\n' % (ctrl)
     res += CTRL_END
-    res += END % (node.runestone_options)
+    res += END % (node["runestone_options"])
     path = os.path.join(
-        node.runestone_options["blocklyHomePrefix"],
+        node["runestone_options"]["blocklyHomePrefix"],
         "_static",
-        node.runestone_options["divid"] + ".html",
+        node["runestone_options"]["divid"] + ".html",
     )
     final = (
         '<iframe class="blk-iframe" seamless src="%s" width="600" '
@@ -185,9 +187,9 @@ def visit_block_node(self, node):
     self.body.append(final)
 
 
-def depart_block_node(self, node):
+def depart_block_html(self, node):
     """ This is called at the start of processing an activecode node.  If activecode had recursive nodes
-        etc and did not want to do all of the processing in visit_ac_node any finishing touches could be
+        etc and did not want to do all of the processing in visit_ac_html any finishing touches could be
         added here.
     """
     pass

runestone/cellbotics/__init__.py

@@ -31,7 +31,7 @@ class BlePairNode(nodes.General, nodes.Element):
     pass
 
 
-def visit_ble_pair_node(self, node):
+def visit_ble_pair_html(self, node):
     self.body.append(
         '<div data-component="ble">\n'
         '   <script>runestone_import("ble");</script>\n'
@@ -41,7 +41,7 @@ def visit_ble_pair_node(self, node):
     )
 
 
-def depart_ble_pair_node(self, node):
+def depart_ble_pair_html(self, node):
     pass
 
 
@@ -57,5 +57,5 @@ def run(self):
 
 def setup(app):
     # Add the Pair button directive.
-    app.add_node(BlePairNode, html=(visit_ble_pair_node, depart_ble_pair_node))
+    app.add_node(BlePairNode, html=(visit_ble_pair_html, depart_ble_pair_html))
     app.add_directive('ble-pair-button', BlePairDirective)