diff --git a/.jshintrc b/.jshintrc index 5950318e8..84c4059c0 100644 --- a/.jshintrc +++ b/.jshintrc @@ -7,7 +7,7 @@ "allVisualizers", "console" ], - "esversion": 6, + "esversion": 8, "quotmark": true, "strict": "implied", "sub": true, diff --git a/index.rst b/index.rst index 29ee51628..4aa8134d4 100644 --- a/index.rst +++ b/index.rst @@ -3,6 +3,8 @@ Runestone Components ******************** This site documents the working of the Runestone Components. See the `Runestone Interactive Overview `_ or the `Runestone instructor's guide `_. +Demo linking to the Runestone Server docs: :ref:`assignments/grades_report endpoint`. + Getting started =============== diff --git a/runestone/activecode/js/activecode.js b/runestone/activecode/js/activecode.js index bf60c122b..278213ac1 100755 --- a/runestone/activecode/js/activecode.js +++ b/runestone/activecode/js/activecode.js @@ -470,8 +470,8 @@ export class ActiveCode extends RunestoneBase { if (!didAgree) { didAgree = confirm( "Pair Programming should only be used with the consent of your instructor." + - "Your partner must be a registered member of the class and have agreed to pair with you." + - "By clicking OK you certify that both of these conditions have been met." + "Your partner must be a registered member of the class and have agreed to pair with you." + + "By clicking OK you certify that both of these conditions have been met." ); if (didAgree) { localStorage.setItem("partnerAgree", "true"); @@ -514,13 +514,13 @@ export class ActiveCode extends RunestoneBase { $(butt).attr( "href", "http://" + - chatcodesServer + - "/new?" + - $.param({ - topic: window.location.host + "-" + this.divid, - code: this.editor.getValue(), - lang: "Python", - }) + chatcodesServer + + "/new?" + + $.param({ + topic: window.location.host + "-" + this.divid, + code: this.editor.getValue(), + lang: "Python", + }) ); this.chatButton = butt; chatBar.appendChild(butt); @@ -554,6 +554,8 @@ export class ActiveCode extends RunestoneBase { $(this.runButton).text($.i18n("msg_activecode_save_run")); } + // _`addHistoryScrubber` + // --------------------- // Activecode -- If the code has not changed wrt the scrubber position value then don't save the code or reposition the scrubber // -- still call runlog, but add a parameter to not save the code // add an initial load history button @@ -574,7 +576,7 @@ export class ActiveCode extends RunestoneBase { // If this is timed and already taken we should restore history info this.renderScrubber(); } else { - let request = new Request(eBookConfig.ajaxURL + "gethist.json", { + let request = new Request("/assessment/gethist", { method: "POST", headers: this.jsonHeaders, body: JSON.stringify(reqData), @@ -582,6 +584,10 @@ export class ActiveCode extends RunestoneBase { try { response = await fetch(request); let data = await response.json(); + if (!response.ok) { + throw new Error(`Failed to get the history data: ${data.detail}`); + } + data = data.detail; if (data.history !== undefined) { this.history = this.history.concat(data.history); for (let t in data.timestamps) { @@ -591,7 +597,7 @@ export class ActiveCode extends RunestoneBase { } } } catch (e) { - console.log("unable to fetch history"); + console.log(`unable to fetch history: ${e}`); } this.renderScrubber(pos_last); } @@ -907,7 +913,7 @@ export class ActiveCode extends RunestoneBase { }); } - toggleEditorVisibility() {} + toggleEditorVisibility() { } addErrorMessage(err) { // Add the error message @@ -1045,7 +1051,7 @@ Yet another is that there is an internal error. The internal error message is: var xl = eval(x); xl = xl.map(pyStr); x = xl.join(" "); - } catch (err) {} + } catch (err) { } } } $(this.output).css("visibility", "visible"); @@ -1149,7 +1155,7 @@ Yet another is that there is an internal error. The internal error message is: if ( this.historyScrubber && this.history[$(this.historyScrubber).slider("value")] != - this.editor.getValue() + this.editor.getValue() ) { saveCode = "True"; this.history.push(this.editor.getValue()); @@ -1186,7 +1192,7 @@ Yet another is that there is an internal error. The internal error message is: this.logRunEvent({ div_id: this.divid, code: this.editor.getValue(), - lang: this.language, + language: this.language, errinfo: this.errinfo, to_save: this.saveCode, prefix: this.pretext, diff --git a/runestone/activecode/js/activecode_sql.js b/runestone/activecode/js/activecode_sql.js index 43777d850..d0befa1c5 100644 --- a/runestone/activecode/js/activecode_sql.js +++ b/runestone/activecode/js/activecode_sql.js @@ -238,7 +238,7 @@ export default class SQLActiveCode extends ActiveCode { this.logRunEvent({ div_id: this.divid, code: this.editor.getValue(), - lang: this.language, + language: this.language, errinfo: this.results[this.results.length - 1].status, to_save: this.saveCode, prefix: this.pretext, @@ -292,9 +292,8 @@ export default class SQLActiveCode extends ActiveCode { } 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}%`; + result += `You passed ${this.passed} out of ${this.passed + this.failed + } tests for ${pct}%`; this.unit_results = `percent:${pct}:passed:${this.passed}:failed:${this.failed}`; return result; } diff --git a/runestone/clickableArea/js/clickable.js b/runestone/clickableArea/js/clickable.js index 9329fe901..3a0b19327 100644 --- a/runestone/clickableArea/js/clickable.js +++ b/runestone/clickableArea/js/clickable.js @@ -400,9 +400,11 @@ export default class ClickableArea extends RunestoneBase { } logCurrentAnswer() { + const answer = this.givenIndexArray.join(";"); this.logBookEvent({ event: "clickableArea", - act: this.givenIndexArray.join(";"), + answer: answer, + act: answer, div_id: this.divid, correct: this.correct ? "T" : "F", }); diff --git a/runestone/common/css/runestone-custom-sphinx-bootstrap.css b/runestone/common/css/runestone-custom-sphinx-bootstrap.css index a5b65f95f..a8c5f80a4 100644 --- a/runestone/common/css/runestone-custom-sphinx-bootstrap.css +++ b/runestone/common/css/runestone-custom-sphinx-bootstrap.css @@ -863,7 +863,7 @@ ul.dropdown-menu.globaltoc { /* Style lp textareas. */ -textarea#lp-result { +textarea.lp-result { width: 100%; height: 10em; font-family: monospace; diff --git a/runestone/common/js/bookfuncs.js b/runestone/common/js/bookfuncs.js index 977c4f775..3a887c841 100644 --- a/runestone/common/js/bookfuncs.js +++ b/runestone/common/js/bookfuncs.js @@ -105,8 +105,7 @@ function addReadingList() { }); } else { l = $("
", { - text: - "This page is not part of the last reading assignment you visited.", + text: "This page is not part of the last reading assignment you visited.", }); } $("#main-content").append(l); @@ -206,12 +205,26 @@ class PageProgressBar { export var pageProgressTracker = {}; -function handlePageSetup() { +async function handlePageSetup() { var mess; - if (eBookConfig.useRunestoneServices) { - jQuery.get(eBookConfig.ajaxURL + "set_tz_offset", { - timezoneoffset: new Date().getTimezoneOffset() / 60, - }); + let headers = new Headers({ + "Content-type": "application/json; charset=utf-8", + Accept: "application/json", + }); + let data = { timezoneoffset: new Date().getTimezoneOffset() / 60 }; + let request = new Request("/logger/set_tz_offset", { + method: "POST", + body: JSON.stringify(data), + headers: headers, + }); + try { + let response = await fetch(request); + if (!response.ok) { + console.error(`Failed to set timezone! ${response.statusText}`); + } + data = await response.json(); + } catch (e) { + console.error(`Error setting timezone ${e}`); } if (eBookConfig.isLoggedIn) { diff --git a/runestone/common/js/runestonebase.js b/runestone/common/js/runestonebase.js index 619e8474e..2d9b2e23b 100644 --- a/runestone/common/js/runestonebase.js +++ b/runestone/common/js/runestonebase.js @@ -20,7 +20,9 @@ import { pageProgressTracker } from "./bookfuncs.js"; export default class RunestoneBase { constructor(opts) { - this.component_ready_promise = new Promise(resolve => this._component_ready_resolve_fn = resolve) + this.component_ready_promise = new Promise( + (resolve) => (this._component_ready_resolve_fn = resolve) + ); this.optional = false; if (opts) { this.sid = opts.sid; @@ -57,7 +59,7 @@ export default class RunestoneBase { // is to look for doAssignment in the URL and then grab // the assignment name from the heading. if (location.href.indexOf("doAssignment") >= 0) { - this.timedWrapper = $("h1#assignment_name").text() + this.timedWrapper = $("h1#assignment_name").text(); } else { this.timedWrapper = null; } @@ -72,24 +74,22 @@ export default class RunestoneBase { }); } - // .. _logBookEvent: - // - // logBookEvent - // ------------ + // _`logBookEvent` + //---------------- // This function sends the provided ``eventInfo`` to the `hsblog endpoint` of the server. Awaiting this function returns either ``undefined`` (if Runestone services are not available) or the data returned by the server as a JavaScript object (already JSON-decoded). async logBookEvent(eventInfo) { if (this.graderactive) { return; } let post_return; - eventInfo.course = eBookConfig.course; + eventInfo.course_name = eBookConfig.course; eventInfo.clientLoginStatus = eBookConfig.isLoggedIn; eventInfo.timezoneoffset = new Date().getTimezoneOffset() / 60; if (this.percent) { eventInfo.percent = this.percent; } if (eBookConfig.useRunestoneServices && eBookConfig.logLevel > 0) { - let request = new Request(eBookConfig.ajaxURL + "hsblog", { + let request = new Request("/logger/bookevent", { method: "POST", headers: this.jsonHeaders, body: JSON.stringify(eventInfo), @@ -97,12 +97,17 @@ export default class RunestoneBase { try { let response = await fetch(request); if (!response.ok) { - throw new Error("Failed to save the log entry"); + let detail = await response.json(); + console.error(detail); + throw new Error(`Failed to save the log entry ${detail}`); + } else { + post_return = response.json(); } - post_return = response.json(); } catch (e) { if (this.isTimed) { - alert(`Error: Your action was not saved! The error was ${e}`); + alert( + `Error: Your action was not saved! The error was ${e}` + ); } console.log(`Error: ${e}`); } @@ -120,10 +125,8 @@ export default class RunestoneBase { return post_return; } - // .. _logRunEvent: - // - // logRunEvent - // ----------- + // -`logRunEvent` + //--------------- // This function sends the provided ``eventInfo`` to the `runlog endpoint`. When awaited, this function returns the data (decoded from JSON) the server sent back. async logRunEvent(eventInfo) { let post_promise = "done"; @@ -137,7 +140,7 @@ export default class RunestoneBase { eventInfo.save_code = "True"; } if (eBookConfig.useRunestoneServices && eBookConfig.logLevel > 0) { - let request = new Request(eBookConfig.ajaxURL + "runlog.json", { + let request = new Request("/logger/runlog", { method: "POST", headers: this.jsonHeaders, body: JSON.stringify(eventInfo), @@ -192,19 +195,23 @@ export default class RunestoneBase { data.sid = this.sid; } if (!eBookConfig.practice_mode && this.assessmentTaken) { - let request = new Request( - eBookConfig.ajaxURL + "getAssessResults", - { - method: "POST", - body: JSON.stringify(data), - headers: this.jsonHeaders, - } - ); + let request = new Request("/assessment/results", { + method: "POST", + body: JSON.stringify(data), + headers: this.jsonHeaders, + }); try { let response = await fetch(request); - data = await response.json(); - this.repopulateFromStorage(data); - this.csresolver("server"); + if (response.ok) { + data = await response.json(); + data = data.detail; + this.repopulateFromStorage(data); + this.csresolver("server"); + } else { + alert( + `HTTP Error getting results: ${response.statusText}` + ); + } } catch (err) { try { this.checkLocalStorage(); @@ -252,7 +259,7 @@ export default class RunestoneBase { */ repopulateFromStorage(data) { // decide whether to use the server's answer (if there is one) or to load from storage - if (data !== null && this.shouldUseServer(data)) { + if (data !== null && data !== "no data" && this.shouldUseServer(data)) { this.restoreAnswers(data); this.setLocalStorage(data); } else { diff --git a/runestone/common/js/user-highlights.js b/runestone/common/js/user-highlights.js index 68d73283a..4be2cdba5 100644 --- a/runestone/common/js/user-highlights.js +++ b/runestone/common/js/user-highlights.js @@ -25,13 +25,13 @@ function getCompletions() { var data = { lastPageUrl: currentPathname }; jQuery .ajax({ - url: eBookConfig.ajaxURL + "getCompletionStatus", + url: "/logger/getCompletionStatus", data: data, async: false, }) .done(function (data) { if (data != "None") { - var completionData = $.parseJSON(data); + var completionData = data.detail; var completionClass, completionMsg; if (completionData[0].completionStatus == 1) { completionClass = "buttonConfirmCompletion"; @@ -43,10 +43,10 @@ function getCompletions() { } $("#main-content").append( '
" + completionClass + + '" id="completionButton">' + + completionMsg + + "
" ); } }); @@ -57,8 +57,8 @@ function showLastPositionBanner() { if (typeof lastPositionVal !== "undefined") { $("body").append( '' + parseInt(lastPositionVal) + + 'px;"/>' ); $("html, body").animate({ scrollTop: parseInt(lastPositionVal) }, 1000); } @@ -122,6 +122,9 @@ function addNavigationAndCompletionButtons() { } else { completionFlag = 1; } + // Make sure we mark this page as visited regardless of how flakey + // the onunload handlers become. + processPageState(completionFlag); $("#completionButton").on("click", function () { if ($(this).hasClass("buttonAskCompletion")) { $(this) @@ -158,17 +161,19 @@ function addNavigationAndCompletionButtons() { }); } +// _ decorateTableOfContents +// ------------------------- function decorateTableOfContents() { if ( window.location.href.toLowerCase().indexOf("toc.html") != -1 || window.location.href.toLowerCase().indexOf("index.html") != -1 ) { - jQuery.get(eBookConfig.ajaxURL + "getAllCompletionStatus", function ( + jQuery.get("/logger/getAllCompletionStatus", function ( data ) { var subChapterList; if (data != "None") { - subChapterList = $.parseJSON(data); + subChapterList = data.detail; var allSubChapterURLs = $("#main-content div li a"); $.each(subChapterList, function (index, item) { @@ -183,8 +188,8 @@ function decorateTableOfContents() { .addClass("completed") .append( '- Completed this topic on ' + - item.endDate + - "" + item.endDate + + "" ) .children() .first() @@ -205,8 +210,8 @@ function decorateTableOfContents() { .addClass("active") .append( 'Last read this topic on ' + - item.endDate + - "" + item.endDate + + "" ) .children() .first() @@ -229,25 +234,25 @@ function decorateTableOfContents() { } }); var data = { course: eBookConfig.course }; - jQuery.get(eBookConfig.ajaxURL + "getlastpage", data, function (data) { + jQuery.get("/logger/getlastpage", data, function (data) { var lastPageData; if (data != "None") { - lastPageData = $.parseJSON(data); - if (lastPageData[0].lastPageChapter != null) { + lastPageData = data.detail; + if (lastPageData.lastPageChapter != null) { $("#continue-reading") .show() .html( '
You were Last Reading: ' + - lastPageData[0].lastPageChapter + - (lastPageData[0].lastPageSubchapter - ? " > " + - lastPageData[0].lastPageSubchapter - : "") + - ' Continue Reading
' + lastPageData.lastPageChapter + + (lastPageData.lastPageSubchapter + ? " > " + + lastPageData.lastPageSubchapter + : "") + + ' Continue Reading' ); } } @@ -265,6 +270,8 @@ function enableCompletions() { // call enable user highlights after login $(document).bind("runestone:login", enableCompletions); +// _ processPageState +// ------------------------- function processPageState(completionFlag) { /*Log last page visited*/ var currentPathname = window.location.pathname; @@ -285,8 +292,11 @@ function processPageState(completionFlag) { console.log(e); }); jQuery.ajax({ - url: eBookConfig.ajaxURL + "updatelastpage", - data: data, + url: "/logger/updatelastpage", + contentType: "application/json; charset=utf-8", + dataType: "json", + data: JSON.stringify(data), + method: "POST", async: true, }); } diff --git a/runestone/common/project_template/_templates/plugin_layouts/sphinx_bootstrap/layout.html b/runestone/common/project_template/_templates/plugin_layouts/sphinx_bootstrap/layout.html index 77d19456b..0dadc54ff 100644 --- a/runestone/common/project_template/_templates/plugin_layouts/sphinx_bootstrap/layout.html +++ b/runestone/common/project_template/_templates/plugin_layouts/sphinx_bootstrap/layout.html @@ -1,7 +1,7 @@ {% extends "basic/layout.html" %} {% if dynamic_pages == 'True' %} - {% set appname = '{{ =request.application }}' %} + {% set appname = '{{ request.application }}' %} {% endif %} @@ -41,7 +41,7 @@ {% if dynamic_pages == 'True' %} {% raw %} - {{ =course_name }} + {{ course_name }} {% endraw %} {% else %} {% if course_title -%}{{ course_title|e }}{%- else -%}{{ course_id|e }}{%- endif -%} @@ -234,18 +234,18 @@ {% raw %} eBookConfig.useRunestoneServices = true; eBookConfig.host = ''; - eBookConfig.app = eBookConfig.host + '/' + '{{= request.application }}'; - eBookConfig.course = '{{= course_name }}'; - eBookConfig.basecourse = '{{= base_course }}'; - eBookConfig.isLoggedIn = {{= is_logged_in}}; - eBookConfig.email = '{{= user_email }}'; - eBookConfig.isInstructor = {{= is_instructor }}; - eBookConfig.username = '{{= user_id}}'; - eBookConfig.readings = {{= readings}}; - eBookConfig.activities = {{= XML(activity_info) }} - eBookConfig.downloadsEnabled = {{=downloads_enabled}}; - eBookConfig.allow_pairs = {{=allow_pairs}} - eBookConfig.enableCompareMe = {{=enable_compare_me }}; + eBookConfig.app = eBookConfig.host + '/' + '{{ request.application }}'; + eBookConfig.course = '{{ course_name }}'; + eBookConfig.basecourse = '{{ base_course }}'; + eBookConfig.isLoggedIn = {{ is_logged_in}}; + eBookConfig.email = '{{ user_email }}'; + eBookConfig.isInstructor = {{ is_instructor }}; + eBookConfig.username = '{{ user_id}}'; + eBookConfig.readings = {{ readings}}; + eBookConfig.activities = {{ activity_info }} + eBookConfig.downloadsEnabled = {{downloads_enabled}}; + eBookConfig.allow_pairs = {{allow_pairs}} + eBookConfig.enableCompareMe = {{enable_compare_me}}; {% endraw %} {% else %} eBookConfig.useRunestoneServices = {% if use_services == 'true' -%}true{%- else -%}false{%- endif -%}; @@ -274,9 +274,9 @@ {% if dynamic_pages == 'True' %} {% raw %} - {{ if response.serve_ad and settings.adsenseid: }} - - {{ pass }} + {% if settings.serve_ad and settings.adsenseid %} + + {% endif %} {% endraw %} {% endif %} @@ -299,16 +299,16 @@ {% if dynamic_pages == 'True' %} {% raw %} - {{ if settings.num_banners > 0 and settings.show_rs_banner: }} + {% if settings.num_banners > 0 and settings.show_rs_banner %}
- + Please Support Runestone
- {{ pass }} + {% endif %} {% endraw %} {% endif %} @@ -359,10 +359,10 @@ {% if dynamic_pages == 'True' %} {% raw %} - {{ if request.application == 'runestone':}} + {% if request.application == 'runestone' %} - {{ pass }} + {% endif %} {% endraw %} {% if minimal_outside_links != 'True' %} diff --git a/runestone/common/project_template/_templates/plugin_layouts/sphinx_bootstrap/subchaptoc.html b/runestone/common/project_template/_templates/plugin_layouts/sphinx_bootstrap/subchaptoc.html index 5f0c3639d..145058256 100644 --- a/runestone/common/project_template/_templates/plugin_layouts/sphinx_bootstrap/subchaptoc.html +++ b/runestone/common/project_template/_templates/plugin_layouts/sphinx_bootstrap/subchaptoc.html @@ -1,14 +1,19 @@ - +
  • - This Chapter -
      - {% raw %} - {{ for row in subchapter_list: }} -
    • {{= row['title']}}
      • - {{ pass }} - {% endraw %} -
    + This Chapter +
      + {% raw %} {% for row in subchapter_list %} +
    • + {{ row['title']}} +
      • + {% endfor %} {% endraw %} +
    • diff --git a/runestone/dragndrop/js/dragndrop.js b/runestone/dragndrop/js/dragndrop.js index 54fdd4ed4..a179bac18 100644 --- a/runestone/dragndrop/js/dragndrop.js +++ b/runestone/dragndrop/js/dragndrop.js @@ -403,7 +403,7 @@ export default class DragNDrop extends RunestoneBase { event: "dragNdrop", act: answer, answer: answer, - minHeight: this.minheight, + min_height: this.minheight, div_id: this.divid, correct: this.correct, correctNum: this.correctNum, @@ -454,7 +454,7 @@ export default class DragNDrop extends RunestoneBase { restoreAnswers(data) { // Restore answers from storage retrieval done in RunestoneBase this.hasStoredDropzones = true; - this.minheight = data.minHeight; + this.minheight = data.min_height; this.pregnantIndexArray = data.answer.split(";"); this.finishSettingUp(); } @@ -471,7 +471,7 @@ export default class DragNDrop extends RunestoneBase { this.hasStoredDropzones = true; try { storedObj = JSON.parse(ex); - this.minheight = storedObj.minHeight; + this.minheight = storedObj.min_height; } catch (err) { // error while parsing; likely due to bad value stored in storage console.log(err.message); @@ -488,7 +488,7 @@ export default class DragNDrop extends RunestoneBase { event: "dragNdrop", act: answer, answer: answer, - minHeight: this.minheight, + min_height: this.minheight, div_id: this.divid, correct: storedObj.correct, }); @@ -522,7 +522,7 @@ export default class DragNDrop extends RunestoneBase { var correct = data.correct; var storageObj = { answer: this.pregnantIndexArray.join(";"), - minHeight: this.minheight, + min_height: this.minheight, timestamp: timeStamp, correct: correct, }; diff --git a/runestone/fitb/fitb.py b/runestone/fitb/fitb.py index 1112d00d3..8aabd609c 100644 --- a/runestone/fitb/fitb.py +++ b/runestone/fitb/fitb.py @@ -141,6 +141,7 @@ class FillInTheBlank(RunestoneIdDirective): option_spec = RunestoneIdDirective.option_spec.copy() option_spec.update( { + "dynamic": directives.unchanged, "casei": directives.flag, # case insensitive matching } ) @@ -180,8 +181,17 @@ def run(self): self.updateContent() - self.state.nested_parse(self.content, self.content_offset, fitbNode) + # Process dynamic problem content. env = self.state.document.settings.env + dynamic = self.options.get("dynamic") + if dynamic: + # Make sure we're server-side. + if not env.config.runestone_server_side_grading: + raise self.error("Dynamic problems require server-side grading.") + # Add in a header to set up the RNG. + fitbNode.template_start = "{{{{ random = get_random({})\n exec({}) }}}}\n".format(repr(self.options["divid"]), repr(dynamic)) + fitbNode.template_start + + self.state.nested_parse(self.content, self.content_offset, fitbNode) self.options["divclass"] = env.config.fitb_div_class # Expected _`structure`, with assigned variable names and transformations made: @@ -211,17 +221,21 @@ def run(self): # self.feedbackArray = [ # [ # blankArray # { # blankFeedbackDict: feedback 1 - # "regex" : feedback_field_name # (An answer, as a regex; - # "regexFlags" : "x" # "i" if ``:casei:`` was specified, otherwise "".) OR - # "number" : [min, max] # a range of correct numeric answers. - # "feedback": feedback_field_body (after being rendered as HTML) # Provides feedback for this answer. + # "regex" : feedback_field_name, # (An answer, as a regex; + # "regexFlags" : "x", # "i" if ``:casei:`` was specified, otherwise "".) OR + # "number" : [min, max], # a range of correct numeric answers OR + # "solution_code" : source_code, # (For dynamic problems -- the dynamically-computed answer. + # "dynamic_code" : source_code, # The first blank also contains setup code.) + # "feedback": feedback_field_body, (after being rendered as HTML) # Provides feedback for this answer. # }, # { # Feedback 2 # Same as above. # } # ], # [ # Blank 2, same as above. - # ] + # ], + # ..., + # [dynamic_source] # For dynamic problems only. # ] # # ...and a transformed node structure: @@ -263,47 +277,54 @@ def run(self): feedback_field_name = feedback_field[0] assert isinstance(feedback_field_name, nodes.field_name) feedback_field_name_raw = feedback_field_name.rawsource - # See if this is a number, optinonally followed by a tolerance. - try: - # Parse the number. In Python 3 syntax, this would be ``str_num, *list_tol = feedback_field_name_raw.split()``. - tmp = feedback_field_name_raw.split() - str_num = tmp[0] - list_tol = tmp[1:] - num = ast.literal_eval(str_num) - assert isinstance(num, Number) - # If no tolerance is given, use a tolarance of 0. - if len(list_tol) == 0: - tol = 0 - else: - assert len(list_tol) == 1 - tol = ast.literal_eval(list_tol[0]) - assert isinstance(tol, Number) - # We have the number and a tolerance. Save that. - blankFeedbackDict = {"number": [num - tol, num + tol]} - except (SyntaxError, ValueError, AssertionError): - # We can't parse this as a number, so assume it's a regex. - regex = ( - # The given regex must match the entire string, from the beginning (which may be preceded by whitespaces) ... - r"^\s*" - + - # ... to the contents (where a single space in the provided pattern is treated as one or more whitespaces in the student's answer) ... - feedback_field_name.rawsource.replace(" ", r"\s+") - # ... to the end (also with optional spaces). - + r"\s*$" - ) - blankFeedbackDict = { - "regex": regex, - "regexFlags": "i" if "casei" in self.options else "", - } - # Test out the regex to make sure it compiles without an error. + # Simply store the solution code for a dynamic problem. + if dynamic: + blankFeedbackDict = {"solution_code": feedback_field_name_raw} + # For the first blank, also include the dynamic source code. + if not blankArray: + blankFeedbackDict["dynamic_code"] = dynamic + else: + # See if this is a number, optionally followed by a tolerance. try: - re.compile(regex) - except Exception as ex: - raise self.error( - 'Error when compiling regex "{}": {}.'.format( - regex, str(ex) - ) + # Parse the number. In Python 3 syntax, this would be ``str_num, *list_tol = feedback_field_name_raw.split()``. + tmp = feedback_field_name_raw.split() + str_num = tmp[0] + list_tol = tmp[1:] + num = ast.literal_eval(str_num) + assert isinstance(num, Number) + # If no tolerance is given, use a tolerance of 0. + if len(list_tol) == 0: + tol = 0 + else: + assert len(list_tol) == 1 + tol = ast.literal_eval(list_tol[0]) + assert isinstance(tol, Number) + # We have the number and a tolerance. Save that. + blankFeedbackDict = {"number": [num - tol, num + tol]} + except (SyntaxError, ValueError, AssertionError): + # We can't parse this as a number, so assume it's a regex. + regex = ( + # The given regex must match the entire string, from the beginning (which may be preceded by whitespaces) ... + r"^\s*" + + + # ... to the contents (where a single space in the provided pattern is treated as one or more whitespaces in the student's answer) ... + feedback_field_name.rawsource.replace(" ", r"\s+") + # ... to the end (also with optional spaces). + + r"\s*$" ) + blankFeedbackDict = { + "regex": regex, + "regexFlags": "i" if "casei" in self.options else "", + } + # Test out the regex to make sure it compiles without an error. + try: + re.compile(regex) + except Exception as ex: + raise self.error( + 'Error when compiling regex "{}": {}.'.format( + regex, str(ex) + ) + ) blankArray.append(blankFeedbackDict) feedback_field_body = feedback_field[1] diff --git a/runestone/fitb/js/fitb.js b/runestone/fitb/js/fitb.js index df280139e..6cb5dca1e 100644 --- a/runestone/fitb/js/fitb.js +++ b/runestone/fitb/js/fitb.js @@ -217,6 +217,7 @@ export default class FITB extends RunestoneBase { correct: this.correct ? "T" : "F", div_id: this.divid, }); + data = data.detail; if (!this.feedbackArray) { // On success, update the feedback from the server's grade. this.setLocalStorage({ @@ -229,7 +230,7 @@ export default class FITB extends RunestoneBase { this.renderFeedback(); } return data; -} + } /*============================== === Evaluation of answer and === @@ -341,19 +342,20 @@ export default class FITB extends RunestoneBase { enableCompareButton() { this.compareButton.disabled = false; } + // _`compareFITBAnswers` compareFITBAnswers() { var data = {}; data.div_id = this.divid; data.course = eBookConfig.course; jQuery.get( - eBookConfig.ajaxURL + "gettop10Answers", + "/assessment/gettop10Answers", data, this.compareFITB ); } compareFITB(data, status, whatever) { - var answers = eval(data)[0]; - var misc = eval(data)[1]; + var answers = data.detail.res; + var misc = data.detail.miscdata; var body = ""; body += ""; for (var row in answers) { @@ -365,12 +367,6 @@ export default class FITB extends RunestoneBase { " times"; } body += "
    AnswerCount
    "; - if (misc["yourpct"] !== "unavailable") { - body += - "

    You have " + - misc["yourpct"] + - "% correct for all questions

    "; - } var html = "
    " + "
    " + diff --git a/runestone/lp/js/lp.js b/runestone/lp/js/lp.js index 60358767b..1575f78dc 100644 --- a/runestone/lp/js/lp.js +++ b/runestone/lp/js/lp.js @@ -48,9 +48,9 @@ class LP extends RunestoneBase { this.containerDiv = this.element; this.divid = this.element.id; // Store the DOM element (the textarea) where compile results will be displayed. - this.resultElement = $(this.element).siblings("textarea"); - // Store the DOM element (a span) where feedback will be displayed. - this.feedbackElement = $(this.element).siblings("div"); + this.resultElement = $(this.element).siblings(".lp-result"); + // Store the DOM element (a div) where feedback will be displayed. + this.feedbackElement = $(this.element).siblings(".lp-feedback").children("div"); // Use a nice editor. let that = this; this.textAreas = []; @@ -78,13 +78,62 @@ class LP extends RunestoneBase { this.checkServer("lp_build", true); } + // Data structures: + // + // Format of data stored locally and on the server*:: + // + // - answer: JSON-encoded string containing { + // code_snippets: [ + // str, snippet 1, ... + // ], + // (optional) resultString: str, output from build. + // } + // - correct: (optional) float, a percentage from 0 to 100. + // - timestamp: date/time in UTC. + // + // Format of data sent to the server*:: + // + // - answer: JSON-encoded string containing only the code_snippets + // array, not resultString. There's no point in sending the + // previous resultString, since the server will compute a new + // one. + // - event: "lp_build" + // - act: "", since the useinfo table requires it. It's not + // otherwise used. + // - path: str, giving the relative path to this web page. Used + // to find the source code which produced this page in order + // to do snippet replacement. + // - div_id: str, the div_id of this component. + // + // Format of data received from the server:: + // + // If there was an error: + // - errors: [ + // str, error message 1, ... + // ] + // + // Otherwise: + // - answer: JSON-encoded string containing { + // resultString: str, output from build. + // Note that the code_snippets aren't sent back, to save + // bandwidth. + // } + // - correct: float, a percentage from 0 to 100. + // - timestamp: str, the server's timestamp. + // + // * For simplicity, I omitted the common fields (course, etc.) and discussed only fields unique to this component. + async onSaveAndRun(_eventObject) { + // Prevent multiple click while the build is running. + $(this.element).attr("disabled", true); $(this.resultElement).val("Building..."); $(this.feedbackElement).text("").attr(""); // Since the Save and run button was clicked, we assume the code snippets have been changed; therefore, don't store ``correct`` or ``answer.resultString`` because they are out of date. - let answer = { code_snippets: this.textareasToData() }; + // + // Store the answer as a string, since this is what goes in to / comes out from the database. We have to translate this back to a data structure when restoring from the db or local storage. + let code_snippets = this.textareasToData(); this.setLocalStorage({ - answer: answer, + answer: JSON.stringify({code_snippets: code_snippets}), timestamp: new Date(), }); // Store the answer that the server returns, which includes additional data (correct/incorrect, feedback from the build, etc.). @@ -92,8 +141,9 @@ class LP extends RunestoneBase { try { serverAnswer = await this.logBookEvent({ event: "lp_build", - // All values must be strings, or the resulting values on the server side come out confused. - answer: JSON.stringify(answer), + answer: JSON.stringify(code_snippets), + // This is required by useinfo, but not used. + act: "", // Find the relative path to this web page. Slice off the leading ``/``. path: window.location.href .replace(eBookConfig.app, "") @@ -105,13 +155,19 @@ class LP extends RunestoneBase { .val(`Error contacting server: {err}.`) .attr("class", "alert alert-danger"); return; + } finally { + // Always re-enable the button after the server responds. + $(this.element).attr("disabled", false); } + serverAnswer = serverAnswer.detail; // The server doesn't return the ``code_snippets``, for efficiency. Include those. If an error was returned, note that there is no ``answer`` yet. if (!("answer" in serverAnswer)) { - serverAnswer["answer"] = {}; + serverAnswer.answer = {}; } - serverAnswer["answer"]["code_snippets"] = this.textareasToData(); + serverAnswer.answer.code_snippets = code_snippets; this.displayAnswer(serverAnswer); + // JSON-encode the answer for storage. + serverAnswer.answer = JSON.stringify(serverAnswer.answer); this.setLocalStorage(serverAnswer); } @@ -142,6 +198,7 @@ class LP extends RunestoneBase { $(this.resultElement).scrollTop(this.resultElement[0].scrollHeight); } } + // Store the contents of each textarea into an array of strings. textareasToData() { return $.map(this.textAreas, function (obj, index) { @@ -149,6 +206,7 @@ class LP extends RunestoneBase { return obj.getValue(); }); } + // Store an array of strings in ``data.code_snippets`` into each textarea. dataToTextareas(data) { // Find all code snippet textareas. @@ -157,11 +215,15 @@ class LP extends RunestoneBase { value.setValue((data.answer.code_snippets || "")[index] || ""); }); } + // Restore answers from storage retrieval done in RunestoneBase. restoreAnswers(data) { + // We store the answer as a JSON-encoded string in the db / local storage. Restore the actual data structure from it. + data.answer = JSON.parse(data.answer); this.dataToTextareas(data); this.displayAnswer(data); } + checkLocalStorage() { // Loads previous answers from local storage if they exist. var storedData; @@ -181,6 +243,7 @@ class LP extends RunestoneBase { } } } + setLocalStorage(data) { localStorage.setItem(this.localStorageKey(), JSON.stringify(data)); } @@ -192,7 +255,7 @@ class LP extends RunestoneBase { $(document).bind("runestone:login-complete", function () { $("[data-component=lp_build]").each(function (index) { try { - LPList[this.id] = new LP({ + window.LPList[this.id] = new LP({ orig: this, useRunestoneServices: eBookConfig.useRunestoneServices, }); diff --git a/runestone/lp/lp.py b/runestone/lp/lp.py index bba8b9fbf..89cd6a2f7 100644 --- a/runestone/lp/lp.py +++ b/runestone/lp/lp.py @@ -164,9 +164,9 @@ def depart_lp_node(self, node): {}
    - +
    -
    +
    """.format( "".join(self.body), node.runestone_options["language"], id_ ) diff --git a/runestone/mchoice/js/mchoice.js b/runestone/mchoice/js/mchoice.js index a3a5f522b..9d88b44d3 100644 --- a/runestone/mchoice/js/mchoice.js +++ b/runestone/mchoice/js/mchoice.js @@ -571,7 +571,7 @@ export default class MultipleChoice extends RunestoneBase { return res; } compareModal(data, status, whatever) { - var datadict = JSON.parse(data)[0]; + var datadict = data.detail; var answers = datadict.answerDict; var misc = datadict.misc; var kl = Object.keys(answers).sort(); @@ -625,12 +625,13 @@ export default class MultipleChoice extends RunestoneBase { var el = $(html); el.modal(); } + // _`compareAnswers` compareAnswers() { var data = {}; data.div_id = this.divid; - data.course = eBookConfig.course; + data.course_name = eBookConfig.course; jQuery.get( - eBookConfig.ajaxURL + "getaggregateresults", + "/assessment/getaggregateresults", data, this.compareModal.bind(this) ); diff --git a/runestone/poll/js/poll.js b/runestone/poll/js/poll.js index 319991bb0..9c185d83f 100644 --- a/runestone/poll/js/poll.js +++ b/runestone/poll/js/poll.js @@ -148,21 +148,20 @@ export default class Poll extends RunestoneBase { data.div_id = this.divid; data.course = eBookConfig.course; jQuery.get( - eBookConfig.ajaxURL + "getpollresults", + "/assessment/getpollresults", data, this.showPollResults ); } } - showPollResults(data) { + showPollResults(results) { //displays the results returned by the server - var results = eval(data); - var total = results[0]; - var opt_list = results[1]; - var count_list = results[2]; - var div_id = results[3]; - var my_vote = results[4]; - // resture current users vote + results = results.detail; + var total = results["total"]; + var optCounts = results["opt_counts"] + var div_id = results["div_id"]; + var my_vote = results["my_vote"]; + // restore current users vote if (my_vote > -1) { this.optsArray[my_vote].checked = "checked"; } @@ -180,8 +179,8 @@ export default class Poll extends RunestoneBase { for (var i = 0; i < this.optionList.length; i++) { var count; var percent; - if (count_list[i]) { - count = count_list[i]; + if (optCounts[i] > 0) { + count = optCounts[i] percent = (count / total) * 100; } else { count = 0; @@ -215,7 +214,7 @@ export default class Poll extends RunestoneBase { } this.indicate_component_ready(); } - disableOptions() {} + disableOptions() { } checkPollStorage() { //checks the localstorage to see if the poll has been completed already var _this = this; @@ -226,7 +225,7 @@ export default class Poll extends RunestoneBase { data.div_id = this.divid; data.course = eBookConfig.course; jQuery.get( - eBookConfig.ajaxURL + "getpollresults", + "/assessment/getpollresults", data, this.showPollResults.bind(this) ).fail(this.indicate_component_ready.bind(this)); diff --git a/runestone/selectquestion/js/selectone.js b/runestone/selectquestion/js/selectone.js index 3ef525bf9..f6b7473fa 100644 --- a/runestone/selectquestion/js/selectone.js +++ b/runestone/selectquestion/js/selectone.js @@ -91,13 +91,14 @@ export default class SelectOne extends RunestoneBase { let opts = this.origOpts; let selectorId = this.selector_id; console.log("getting question source"); - let request = new Request("/runestone/ajax/get_question_source", { + let request = new Request("/assessment/get_question_source", { method: "POST", headers: this.jsonHeaders, body: JSON.stringify(data), }); let response = await fetch(request); let htmlsrc = await response.json(); + htmlsrc = htmlsrc.detail; if (htmlsrc.indexOf("No preview") >= 0) { alert( `Error: Not able to find a question for ${selectorId} based on the criteria` @@ -139,8 +140,8 @@ export default class SelectOne extends RunestoneBase { if (!document.getElementById("component-preview")) { toggleUI += '
    ' + - '
    ' + - '
    ' + + '
    ' + + '
    ' + '
    '; } // dropdown menu containing the question options @@ -163,10 +164,10 @@ export default class SelectOne extends RunestoneBase { 'data-component="' )[1]; switch ( - toggleQuestionSubstring.slice( - 0, - toggleQuestionSubstring.indexOf('"') - ) + toggleQuestionSubstring.slice( + 0, + toggleQuestionSubstring.indexOf('"') + ) ) { case "activecode": toggleQuestionType = "Active Write Code"; @@ -201,14 +202,14 @@ export default class SelectOne extends RunestoneBase { } else { toggleUI += toggleQuestionType + - " - " + - toggleQuestions[i]; + " - " + + toggleQuestions[i]; } } else { toggleUI += toggleQuestionType + - " - " + - toggleQuestions[i]; + " - " + + toggleQuestions[i]; } if ((i == 0) && (data.toggleOptions.includes("lock"))) { toggleUI += " (only this question will be graded)"; @@ -339,6 +340,7 @@ export default class SelectOne extends RunestoneBase { } // on clicking "Select this Problem" button, close preview panel, replace current question in assignments page with selected question, and send request to update grading database + // _ `toggleSet` async toggleSet(parentID, selectedQuestion, htmlsrc, toggleQuestionTypes) { var selectorId = parentID + "-toggleSelectedQuestion"; var toggleQuestionSelect = document.getElementById(parentID).getElementsByTagName("select")[0]; @@ -348,10 +350,10 @@ export default class SelectOne extends RunestoneBase { useRunestoneServices: true, }); let request = new Request( - "/runestone/ajax/update_selected_question?metaid=" + - parentID + - "&selected=" + - selectedQuestion, + "/assessment/set_selected_question?metaid=" + + parentID + + "&selected=" + + selectedQuestion, {} ); await fetch(request); @@ -378,13 +380,13 @@ export default class SelectOne extends RunestoneBase { currentParsonsClass = currentParsons[p].classList[2]; if (currentParsonsClass) { if (currentParsonsClass.includes("indent")) { - indentCount = parseInt(indentCount) + parseInt(currentParsonsClass.slice(6,currentParsonsClass.length)); + indentCount = parseInt(indentCount) + parseInt(currentParsonsClass.slice(6, currentParsonsClass.length)); } } // for Parsons answer spaces with vertical lines that allow student to define their own line indentation currentBlockIndent = currentParsons[p].parentElement.parentElement.style.left; if (currentBlockIndent) { - indentCount = parseInt(indentCount) + parseInt(currentBlockIndent.slice(0,currentBlockIndent.indexOf("px")) / 30); + indentCount = parseInt(indentCount) + parseInt(currentBlockIndent.slice(0, currentBlockIndent.indexOf("px")) / 30); } for (var d = 0; d < indentCount; d++) { indent += " "; diff --git a/runestone/server/componentdb.py b/runestone/server/componentdb.py index 4ce690175..3ca7c27be 100644 --- a/runestone/server/componentdb.py +++ b/runestone/server/componentdb.py @@ -128,7 +128,9 @@ def setup(app): logger.info("Connecting to DB") try: dburl = get_dburl() - engine = create_engine(dburl, client_encoding="utf8", convert_unicode=True) + # SQLite doesn't support ``client_encoding``, while PostgreSQL does. + encoding = dict(client_encoding="utf8") if dburl.startswith("postgresql") else {} + engine = create_engine(dburl, convert_unicode=True, **encoding) Session = sessionmaker() engine.connect() Session.configure(bind=engine) @@ -339,6 +341,7 @@ def addQuestionToDB(self): practice=practice, topic=topics, from_source=from_source, + review_flag='F', optional=optional, description=et, **meta_opts, @@ -388,6 +391,7 @@ def addQuestionToDB(self): question_name=id_, ) sess.execute(ins) + sess.commit() def addQNumberToDB(app, node, qnumber): @@ -585,7 +589,6 @@ def addAssignmentToDB( return course_id = getCourseID(course_name) - last_changed = datetime.now() sel = select([assignments]).where( and_(assignments.c.name == name, assignments.c.course == course_id) ) @@ -624,6 +627,7 @@ def addAssignmentToDB( visible=visible, time_limit=time_limit, from_source="T", + released="F", ) res = sess.execute(ins) a_id = res.inserted_primary_key[0] diff --git a/runestone/shortanswer/js/shortanswer.js b/runestone/shortanswer/js/shortanswer.js index e011c9aac..aaeaab245 100644 --- a/runestone/shortanswer/js/shortanswer.js +++ b/runestone/shortanswer/js/shortanswer.js @@ -152,6 +152,7 @@ export default class ShortAnswer extends RunestoneBase { this.logBookEvent({ event: "shortanswer", act: value, + answer: value, div_id: this.divid, }); } diff --git a/runestone/timed/js/timed.js b/runestone/timed/js/timed.js index f5ae73402..3143d99ea 100644 --- a/runestone/timed/js/timed.js +++ b/runestone/timed/js/timed.js @@ -110,7 +110,7 @@ export default class Timed extends RunestoneBase { console.log(sendInfo); if (eBookConfig.useRunestoneServices) { let request = new Request( - eBookConfig.ajaxURL + "tookTimedAssessment", + "/assessment/tookTimedAssessment", { method: "POST", headers: this.jsonHeaders, @@ -119,6 +119,7 @@ export default class Timed extends RunestoneBase { ); let response = await fetch(request); let data = await response.json(); + data = data.detail; this.taken = data.tookAssessment; this.assessmentTaken = this.taken; if (!this.taken) { @@ -997,6 +998,8 @@ export default class Timed extends RunestoneBase { }); localStorage.setItem(this.localStorageKey(), storageObj); } + // _`timed exam endpoint parameters` + //---------------------------------- logScore() { this.logBookEvent({ event: "timedExam", diff --git a/setup.py b/setup.py index afe459016..72bbb9521 100644 --- a/setup.py +++ b/setup.py @@ -10,7 +10,7 @@ with open("requirements.txt", "r", encoding="utf-8") as fh: dependencies = [l.strip() for l in fh] -VERSION = "5.6.1" +VERSION = "6.0.0dev" # These pre-install hooks are useful to make sure any pre-requisite # programs that are not pip installable are in place. diff --git a/webpack.index.js b/webpack.index.js index 7e380f54e..35216a3f3 100644 --- a/webpack.index.js +++ b/webpack.index.js @@ -38,6 +38,7 @@ import "./runestone/common/project_template/_templates/plugin_layouts/sphinx_boo import "./runestone/common/css/runestone-custom-sphinx-bootstrap.css"; // Misc +import "./runestone/common/js/bookfuncs.js"; import "./runestone/common/js/user-highlights.js"; // These belong in dynamic imports for the obvious component; however, these components don't include a ``data-component`` attribute. @@ -95,7 +96,7 @@ export function runestone_auto_import() { $("[data-component]").map( // Extract the value of the data-component attribute. (index, element) => $(element).attr("data-component") - // Switch from a jQuery object back to an array, passing that to the Set constructor. + // Switch from a jQuery object back to an array, passing that to the Set constructor. ).get() );