Add shortanswer directive

renaming of journal from acbart

Author: bnmnetp

CONTRIBUTING.md

@@ -26,4 +26,7 @@ Provide an example
 ------------------
 
 The folder ``runestone/common/project_template/_sources`` folder is a great place to add a file
-that demonstrates your new feature or component in action.
+that demonstrates your new feature or component in action.
+
+In fact you should provide two examples whenever possible to demonstrate that you can have 
+multiple instances of your component on a single web page.

runestone/shortanswer/__init__.py

@@ -0,0 +1 @@
+from .shortanswer import *

runestone/shortanswer/css/shortanswer.css

@@ -0,0 +1,39 @@
+
+
+/**
+ * If the divid is in the localStorage, then assume it was put there in a panic
+ * Check against the server to find which is more recent, and use that.
+ *
+ */
+function loadJournal(directive_id) {
+    directiveRemoteCommand('get_journal_entry', directive_id, {},
+                      function(data) {
+                        var solution = $('#'+directive_id+'_solution');
+                        solution.text(data.solution);
+                        if (storage.has(directive_id)) {
+                            if (storage.is_new(directive_id, data.timestamp)) {
+                                storage.remove(directive_id);
+                            } else {
+                                solution.text(storage.get(directive_id));
+                                submitJournal(directive_id);
+                            }
+                        }
+                      },
+                      function(data) {
+                        console.log(data.message);
+                      });
+}
+
+function submitJournal(directive_id) {
+    var value = $('#'+directive_id+'_solution').val();
+    storage.set(directive_id, value);
+    directiveRemoteCommand('set_journal_entry',  directive_id, {'solution': value},
+                      function(data) {
+                        storage.remove(directive_id);
+                      },
+                      function(data) {
+                        console.log(data.message);
+                      });
+}
+
+

runestone/shortanswer/js/shortanswer.js

@@ -0,0 +1,116 @@
+# Copyright (C) 2011  Bradley N. Miller
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# 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__ = 'acbart'
+
+import os
+
+from docutils import nodes
+from docutils.parsers.rst import directives
+from docutils.parsers.rst import Directive
+from runestone.assess import Assessment
+
+def setup(app):
+    app.add_directive('shortanswer', JournalDirective)
+
+    app.add_node(JournalNode, html=(visit_journal_node, depart_journal_node))
+
+    app.add_javascript('shortanswer.js')
+    app.add_stylesheet('shortanswer.css')
+
+
+TEXT = """
+<div id='%(divid)s' class='journal alert alert-%(optional)s'>
+    <form id='%(divid)s_journal' name='%(divid)s_journal' action="">
+        <div class='directive-status-icon'><img src='../../images/spinner10.gif'/></div>
+        <fieldset>
+            <legend>Journal</legend>
+            <div class='journal-question'>%(qnum)s: %(content)s</div>
+            <div id='%(divid)s_journal_input'>
+                <div class='journal-options'>
+                    <label class='radio-inline'>
+                        <textarea id='%(divid)s_solution' class="form-control" style="display:inline; width: 530px;"
+                                  rows='4' cols='50'></textarea>
+                    </label>
+                </div><br />
+                Instructor's Feedback:
+                <div class='journal-options' style='padding-left:20px'>
+                    <div class='bg-info form-control' style='width:530px; background-color: #eee; font-style:italic'
+                         id='%(divid)s_feedback'>
+                        There is no feedback yet.
+                    </div>
+                </div><br />
+            </div>
+        </fieldset>
+    </form>
+    <div id='%(divid)s_results'></div>
+    <script type='text/javascript'>
+        // check if the user has already answered this journal
+        $(function() {
+            loadJournal('%(divid)s');
+            $('#%(divid)s_solution').on('keyup input propertychange paste change', function() {
+                addDelay('%(divid)s', function() {
+                    submitJournal('%(divid)s');
+                });
+            });
+        });
+    </script>
+</div>
+"""
+
+class JournalNode(nodes.General, nodes.Element):
+    def __init__(self, options):
+        super(JournalNode, self).__init__()
+        self.journalnode_components = options
+
+def visit_journal_node(self, node):
+    div_id = node.journalnode_components['divid']
+    back, subchapter = os.path.split(os.path.splitext(node.source.lower())[0])
+    back, chapter = os.path.split(back)
+    content = ''
+    components = dict(node.journalnode_components)
+    components.update({'divid': div_id,
+                       'subchapter': subchapter,
+                       'chapter': chapter})
+    res = TEXT % components
+    self.body.append(res)
+
+def depart_journal_node(self,node):
+    pass
+
+
+class JournalDirective(Assessment):
+    required_arguments = 1  # the div id
+    optional_arguments = 0
+    final_argument_whitespace = True
+    has_content = True
+    option_spec = {'optional': directives.flag}
+
+    node_class = JournalNode
+
+    def run(self):
+        # Raise an error if the directive does not have contents.        
+        
+        self.assert_has_content()
+        
+        self.options['optional'] = 'success' if 'optional' in self.options else 'warning'
+        self.options['divid'] = self.arguments[0]
+        self.options['content'] = "<p>".join(self.content)
+        self.options['qnum'] = self.getNumber()
+        journal_node = JournalNode(self.options)
+
+        return [journal_node]
+
+