Add autograde to spreadsheet

Author: Brad Miller

.jshintrc

@@ -0,0 +1,4 @@
+{
+    "esversion": 6
+
+}

runestone/spreadsheet/js/spreadsheet.js

@@ -1,19 +1,132 @@
 ssList = {};
 
-class SpreadSheet {
+class SpreadSheet extends RunestoneBase {
     constructor(opts) {
+        super(SpreadSheet);
         let orig = opts.orig;
         this.div_id = orig.id;
         this.sheet_id = `${this.div_id}_sheet`;
         this.data = eval(`${this.div_id}_data`);
+        this.autograde = $(orig).data("autograde");
+        this.suffix = window[`${this.div_id}_asserts`];
+        this.renderSheet();
 
-        this.renderSheet()
+        if (this.autograde) {
+            this.addAutoGradeButton();
+            this.addOutput();
+        }
     }
 
     renderSheet() {
-        let div = document.getElementById(this.sheet_id)
-        this.table = jexcel(div, {data:this.data})
+        let div = document.getElementById(this.sheet_id);
+        this.table = jexcel(div, {data:this.data});
     }
+
+    addAutoGradeButton() {
+        let div = document.getElementById(this.div_id);
+        var butt = document.createElement("button");
+        $(butt).text("Check");
+        $(butt).addClass("btn btn-success run-button");
+        div.appendChild(butt);
+        this.gradeButton = butt;
+        $(butt).click(this.doAutoGrade.bind(this));
+        $(butt).attr("type","button");
+    }
+
+    addOutput() {
+        this.output = document.createElement('pre');
+        this.output.id = this.divid+'_stdout';
+        $(this.output).css("visibility","hidden");
+        let div = document.getElementById(this.div_id);
+        div.appendChild(this.output);
+    }
+
+    doAutoGrade () {
+        let tests = this.suffix;
+        this.passed = 0;
+        this.failed = 0;
+        // Tests should be of the form
+        // assert row,col oper value for example
+        // assert 4,4 == 3
+        let result = "";
+        tests = tests.filter(function(s) {
+            return s.indexOf('assert') > -1;
+        });
+        for (let test of tests) {
+            let assert, loc, oper, expected;
+            [assert, loc, oper, expected] = test.split(/\s+/);
+            result += this.testOneAssert(loc, oper, expected);
+            result += "\n";
+        }
+        let pct = 100 * this.passed / (this.passed + this.failed);
+        pct = pct.toLocaleString(undefined, { maximumFractionDigits: 2});
+        result += `You passed ${this.passed} out of ${this.passed+this.failed} tests for ${pct}%`;
+        this.logBookEvent({event: 'unittest',
+                           div_id: this.divid,
+                           course: eBookConfig.course,
+                           act: `percent:${pct}:passed:${this.passed}:failed:${this.failed}`
+                        });
+        $(this.output).css("visibility","visible");
+        $(this.output).text(result);
+    }
+
+    testOneAssert(cell, oper, expected) {
+        let actual  = this.getCellDisplayValue(cell);
+        const operators = {
+            "==" : function (operand1, operand2) {
+                return operand1 == operand2;
+            },
+            "!=" : function (operand1, operand2) {
+                return operand1 != operand2;
+            },
+            ">" : function (operand1, operand2) {
+                return operand1 > operand2;
+            },
+            "<" : function (operand1, operand2) {
+                return operand1 > operand2;
+            }
+        };
+
+        let res = operators[oper](actual, expected);
+        let output = "";
+        if (res) {
+            output = `Pass: ${actual} ${oper} ${expected} in ${cell}`;
+            this.passed++;
+        } else {
+            output = `Failed ${actual} ${oper} ${expected} in cell ${cell}`;
+            this.failed++;
+        }
+        return output;
+    }
+
+
+
+    // If the cell contains a formula, this call will return the formula not the computed value
+    getCellSource(cell) {
+        return this.table.getValue(cell);
+    }
+
+    // If the cell contains a formula this call will return the computed value
+    getCellDisplayValue(cell) {
+        let parts = cell.match(/\$?([A-Z]+)\$?([0-9]+)/);
+        let x = this.columnToIndex(parts[1]);
+        let y = parts[2] - 1;
+        let res = this.table.el.querySelector(`[data-x="${x}"][data-y="${y}"]`);
+        return res.innerText;
+    }
+
+    columnToIndex(colName) {
+        // Convert the column name to a number A = 0 AA = 26 BA = 52, etc
+        let base = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
+        let result = 0;
+
+        for (let i = 0, j = colName.length - 1; i < colName.length; i += 1, j -= 1) {
+          result += Math.pow(base.length, j) * (base.indexOf(colName[i]) + 1);
+        }
+
+        return result - 1;
+      }
+
 }
 
 $(document).bind("runestone:login-complete", function () {
@@ -24,6 +137,6 @@ $(document).bind("runestone:login-complete", function () {
 });
 
 if (typeof component_factory === 'undefined') {
-    component_factory = {}
+    component_factory = {};
 }
-component_factory['spreadsheet'] = function(opts) { return new SpreadSheet(opts)}
+component_factory.spreadsheet = function(opts) { return new SpreadSheet(opts);};

runestone/spreadsheet/spreadsheet.py

@@ -15,7 +15,7 @@
 #
 __author__ = 'bmiller'
 
-
+import re
 from docutils import nodes
 from docutils.parsers.rst import directives
 from runestone.common.runestonedirective import RunestoneNode, RunestoneIdDirective, get_node_line
@@ -67,6 +67,7 @@ class SpreadSheet(RunestoneIdDirective):
         :colwidths: list of column widths
         :coltitles: list of column names
         :coltypes: list of column types
+        :mindimensions: mincols, minrows  -- minDimensions:[10,5]
 
         A1,B1,C1,D1...
         A2,B2,C2,D2...
@@ -89,6 +90,14 @@ def run(self):
 
         self.options['divid'] = self.arguments[0].strip()
 
+        if '====' in self.content:
+            idx = self.content.index('====')
+            suffix = self.content[idx+1:]
+            self.options['asserts'] = suffix
+            self.options['autograde'] = 'data-autograde="true"'
+        else:
+            self.options['autograde'] = ''
+
         if 'fromcsv' in self.options:
             self.content = self.body_from_csv(self.options['fromcsv'])
         else:
@@ -110,6 +119,8 @@ def run(self):
     def body_to_csv(self):
         csvlist = []
         for row in self.content:
+            if re.match(r'^\s*====', row):
+                break
             items = row.split(',')
             ilist = []
             for item in items:
@@ -143,12 +154,12 @@ def as_int_or_float(s):
 
 
 TEMPLATE = """
-<div id="{divid}" data-component="spreadsheet">
+<div id="{divid}" data-component="spreadsheet" class="runestone" {autograde}>
     <div id="{divid}_sheet"></div>
 
     <script>
-        {divid}_data = {data}
-
+        {divid}_data = {data};
+        {divid}_asserts = {asserts};
     </script>
 </div>
 """

runestone/spreadsheet/test/_sources/index.rst

@@ -23,3 +23,7 @@ SECTION 1: Spreadsheets
     Yahoo, 1994, 38.66
     ,,=sum(c1:c3)
 
+    ====
+    assert A3 == Yahoo
+    assert B3 == 1994
+