mumuki-laboratory 7.7.6 → 7.8.0

data/app/assets/javascripts/mumuki_laboratory/application/csrf-token.js

@@ -1,18 +1,15 @@
-var mumuki = mumuki || {};
-(function (mumuki) {
-  function CsrfToken() {
-    this.value = $('meta[name="csrf-token"]').attr('content');
-  }
-
-  CsrfToken.prototype = {
-    newRequest: function (data) {
+mumuki.CsrfToken =  (() => {
+  class CsrfToken {
+    constructor() {
+      this.value = $('meta[name="csrf-token"]').attr('content');
+    }
+    newRequest(data) {
       var self = this;
       data.beforeSend = function (xhr) {
         xhr.setRequestHeader('X-CSRF-Token', self.value);
       };
       return data;
     }
-  };
-
-  mumuki.CsrfToken = CsrfToken;
-}(mumuki));
+  }
+  return CsrfToken;
+})();

data/app/assets/javascripts/mumuki_laboratory/application/custom-editor.js

@@ -6,11 +6,16 @@
  * @typedef {{getContent: () => EditorProperty}} CustomEditorSource
  */
 
-var mumuki = mumuki || {};
-
-(function (mumuki) {
+/**
+ * This module allows custom editors to register
+ * content sources that can not me mapped to standard selectors {@code mu-custom-editor-value},
+ * {@code mu-custom-editor-extra} and {@code mu-custom-editor-test}
+ *
+ * CustomEditor sources are cleared after page reload even when using turbolinks
+ */
+mumuki.CustomEditor = (() => {
 
-  var CustomEditor = {
+  const CustomEditor = {
     /**
      * @type {CustomEditorSource[]}
      */
@@ -50,14 +55,5 @@ var mumuki = mumuki || {};
     mumuki.CustomEditor.clearSources();
   });
 
-  /**
-   * This module allows custom editors to register
-   * content sources that can not me mapped to standard selectors {@code mu-custom-editor-value},
-   * {@code mu-custom-editor-extra} and {@code mu-custom-editor-test}
-   *
-   * CustomEditor sources are cleared after page reload even when using turbolinks
-   *
-   * @module mumuki.CustomEditor
-   */
-  mumuki.CustomEditor = CustomEditor;
-}(mumuki));
+  return CustomEditor;
+})();

data/app/assets/javascripts/mumuki_laboratory/application/discussions.js

@@ -1,6 +1,4 @@
-var mumuki = mumuki || {};
-
-mumuki.load(function () {
+mumuki.load(() => {
   var $subscriptionSpans = $('.discussion-subscription > span');
   var $upvoteSpans = $('.discussion-upvote > span');
 

data/app/assets/javascripts/mumuki_laboratory/application/editors.js

@@ -0,0 +1,104 @@
+/**
+ * This module allows to read and write the current editor's contents
+ * regardless if it is an standard editor or a custom editor
+ */
+mumuki.editors = {
+  /**
+   * @type {() => void}
+   */
+  _contentSyncer: null,
+
+  /**
+   * Updates the current editor's content
+   *
+   * @param {string} content
+   */
+  setContent(content) {
+    const $customEditor = $('#mu-custom-editor-value');
+    if ($customEditor.length) {
+      $customEditor.val(content);
+    } else {
+      mumuki.editor.setContent(content);
+    }
+  },
+
+
+  /**
+   * @returns {EditorProperty[]}
+   */
+  getContents() {
+    return mumuki.CustomEditor.hasSources ?
+      mumuki.CustomEditor.getContents() :
+      this.getStandardEditorContents();
+  },
+
+  /**
+   * Syncs and returns the content objects of the standard editor form
+   *
+   * This content object may include keys like {@code content},
+   * {@code content_extra} and {@code content_test}
+   *
+   * @returns {EditorProperty[]}
+   */
+  getStandardEditorContents() {
+    this._syncContent();
+    return $('.new_solution').serializeArray();
+  },
+
+  /**
+   * Answers a submission object with a key for each of the current
+   * editor sources.
+   *
+   * This method will use CustomEditor's sources if availble, or
+   * standard editor's content sources otherwise
+   *
+   * @returns {Submission}
+   */
+  getSubmission() {
+    let content = {};
+    let contents = this.getContents();
+    contents.forEach((it) => {
+      content[it.name] = it.value;
+    });
+    return content;
+  },
+
+  /**
+   * Copies current solution from it native rendering components
+   * to the appropriate submission form elements.
+   *
+   * Both editors and runners with a custom editor that don't register a source should
+   * register its own syncer function in order to {@link syncContent} work properly.
+   *
+   * @see registerContentSyncer
+   * @see CustomEditor#addSource
+   */
+  _syncContent() {
+    if (this._contentSyncer) {
+      this._contentSyncer();
+    }
+  },
+
+  /**
+   * Sets a content syncer, that will be used by {@link _syncContent}
+   * in ordet to dump solution into the submission form fields.
+   *
+   * Each editor should have its own syncer registered - otherwise previous or none may be used
+   * causing unpredicatble behaviours - or cleared by passing {@code null}.
+   *
+   * As a particular case, runners with custom editors that don't add sources using {@link CustomEditor#addSource}
+   * should set the {@code #mu-custom-editor-value} value within its syncer.
+   *
+   * @param {() => void} [syncer] the syncer, or null, if no sync'ing is needed
+   */
+  registerContentSyncer(syncer = null) {
+    this._contentSyncer = syncer;
+  },
+
+  /**
+   * @param {CustomEditorSource} source
+   */
+  addCustomSource(source) {
+    mumuki.CustomEditor.addSource(source)
+  }
+};

data/app/assets/javascripts/mumuki_laboratory/application/elipsis.js

@@ -7,7 +7,7 @@
 //
 //
 // This module assumes the strings are already markdown-like escaped code strings, not plain code
-(function (mumuki) {
+mumuki.elipsis = (() => {
 
   function elipsis(code) {
     return code
@@ -16,8 +16,7 @@
       .replace(/<description-for-student\[([^\]]*)\]@[\s\S]*?@description-for-student>/g, ' ... $1 ... ');
   }
 
-  mumuki.elipsis = elipsis;
-  mumuki.elipsis.replaceHtml = () => {
+  elipsis.replaceHtml = () => {
     let $elipsis = $('.mu-elipsis');
     $elipsis.each((it, e) =>  {
       let $e = $(e);
@@ -28,4 +27,6 @@
   mumuki.load(() => {
     mumuki.elipsis.replaceHtml();
   });
-})(mumuki);
+
+  return elipsis;
+})();

data/app/assets/javascripts/mumuki_laboratory/application/exercise.js

@@ -0,0 +1,32 @@
+mumuki.exercise = {
+  /**
+   * The current exercise's id
+   *
+   * @type {number}
+   * */
+  id: null,
+
+  /**
+   * The current exercise's layout
+   *
+   * @type {"input_right" | "input_bottom" | "input_primary" | "input_kindergarten"}
+   * */
+  layout: null,
+
+  /**
+   * Set global current exercise information
+   */
+  load() {
+    const $muExerciseId = $('#mu-exercise-id');
+    if ($muExerciseId.length) {
+      this.id = Number($muExerciseId.val());
+      // @ts-ignore
+      this.layout = $('#mu-exercise-layout').val();
+    } else {
+      this.id = null;
+      this.layout = null;
+    }
+  }
+}
+
+mumuki.load(() => mumuki.exercise.load())

data/app/assets/javascripts/mumuki_laboratory/application/inputs.js

@@ -1,12 +1,14 @@
-(() => {
+mumuki.onInputsReady = (() => {
   // Declares a `document.ready` handler that will be
   // activated only when there is at least one element that match
   // the given selector
-	mumuki.onInputsReady = (inputsSelector, callback) => {
+	function onInputsReady(inputsSelector, callback) {
 		$(document).ready((event) => {
 			if ($(inputsSelector).length === 0) return;
 
 			callback(event);
 		})
 	}
+
+	return onInputsReady;
 })();

data/app/assets/javascripts/mumuki_laboratory/application/interval.js

@@ -1,6 +1,4 @@
-var mumuki = mumuki || {};
-
-(function (mumuki) {
+(function () {
   // When using Turbolinks, intervals loaded inside <body> aren't destroyed on page changes
   // Use this function instead if you want the behaviour of a regular setInterval
   mumuki.setInterval = function (intervalFunction, milliseconds) {
@@ -14,4 +12,4 @@ var mumuki = mumuki || {};
     return interval;
   }.bind(this);
 
-}(mumuki));
+}());

data/app/assets/javascripts/mumuki_laboratory/application/kids.js

@@ -1,4 +1,4 @@
-mumuki.load(function () {
+mumuki.load(() => {
   let $bubble = $('.mu-kids-character-speech-bubble').children('.mu-kids-character-speech-bubble-normal');
 
   let availableTabs = ['.description', '.hint'];

data/app/assets/javascripts/mumuki_laboratory/application/load-analytics.js

@@ -1,4 +1,4 @@
-mumuki.load(function(){
+mumuki.load(() => {
   ga('create', 'UA-58353823-1', 'auto');
   ga('send', 'pageview');
 });

data/app/assets/javascripts/mumuki_laboratory/application/load-error-svg.js

@@ -1,4 +1,4 @@
-mumuki.load(function () {
+mumuki.load(() => {
   var error_svgs = ['403', '404', '500', 'timeout_1', 'timeout_2', 'timeout_3'];
 
   mumuki.errors = mumuki.errors || {};

data/app/assets/javascripts/mumuki_laboratory/application/messages.js

@@ -1,4 +1,4 @@
-mumuki.load(function () {
+mumuki.load(() => {
   var Chat = {
     $body: function () {
       return $('body')
@@ -61,7 +61,7 @@ mumuki.load(function () {
         Chat.readMessages(readUrl);
       }
 
-      function error(xhr) {
+      function error(_xhr) {
         Chat.tokenRequest({
           url: errorUrl,
           success: renderHTML,

data/app/assets/javascripts/mumuki_laboratory/application/multiple-choice.js

@@ -1,5 +1,5 @@
 mumuki.load(() => {
-	function dumpChoices(evt) {
+	function dumpChoices(_evt) {
 		var indexes = $('.solution-choice:checked').map(function () {
 			return $(this).data('index')
 		}).get().join(':');

data/app/assets/javascripts/mumuki_laboratory/application/multiple-scenarios.js

@@ -1,6 +1,4 @@
-var mumuki = mumuki || {};
-
-(function (mumuki) {
+mumuki.MultipleScenarios = (() => {
 
   const setControlVisibility = function ($control, visible) {
     visible ? $control.show() : $control.hide();
@@ -147,6 +145,5 @@ var mumuki = mumuki || {};
     }
   }
 
-  mumuki.MultipleScenarios = MultipleScenarios;
-
-}(mumuki));
+  return MultipleScenarios;
+})();

data/app/assets/javascripts/mumuki_laboratory/application/pin.js

@@ -1,12 +1,10 @@
-var mumuki = mumuki || {};
-
-(function (mumuki) {
+mumuki.pin = (() => {
   function smoothScrollToElement(domElement) {
     var SPEED = 1000;
     $('html, body').animate({scrollTop: domElement.offset().top}, SPEED);
   }
 
-  mumuki.pin = {
+  return {
     scroll: function () {
       var scrollPin = $('.scroll-pin');
       if (scrollPin.length) {
@@ -14,4 +12,4 @@ var mumuki = mumuki || {};
       }
     }
   }
-})(mumuki);
+})();

data/app/assets/javascripts/mumuki_laboratory/application/progress.js

@@ -1,13 +1,31 @@
-var mumuki = mumuki || {};
-
-(function (mumuki) {
-
+mumuki.progress = (() => {
   /**
    * Updates the current exercise progress indicator
+   *
+   * @param {SubmissionResult} data
    * */
-  mumuki.updateProgressBarAndShowModal = function (data) {
+  function updateProgressBarAndShowModal(data) {
     $('.progress-list-item.active').attr('class', data.class_for_progress_list_item);
     if(data.guide_finished_by_solution) $('#guide-done').modal();
+  }
+
+  /**
+   * Update all links in the progress bar with the given function
+   *
+   * @param {(anchor: JQuery) => string} f
+   */
+  function updateWholeProgressBar(f) {
+    $('.progress-list-item').each((_, it) => {
+      const $anchor = $(it);
+      $anchor.attr('class', f($anchor))
+    });
+  }
+
+  return {
+    updateProgressBarAndShowModal,
+    updateWholeProgressBar
   };
+})();
 
-})(mumuki);
+/** @deprecated use {@code mumuki.progress.updateProgressBarAndShowModal} instead */
+mumuki.updateProgressBarAndShowModal = mumuki.progress.updateProgressBarAndShowModal;

data/app/assets/javascripts/mumuki_laboratory/application/results-renderer.js

@@ -1,4 +1,6 @@
-(() => {
+mumuki.renderers = mumuki.renderers || {};
+mumuki.renderers.results = (() => {
+
 
   // ==========================
   // View function for building
@@ -6,7 +8,7 @@
   // ==========================
 
   /**
-   * @param {string} status
+   * @param {SubmissionStatus} status
    * @returns {string}
    */
   function iconForStatus(status) {
@@ -20,8 +22,7 @@
   }
 
   /**
-   *
-   * @param {string} status
+   * @param {SubmissionStatus} status
    * @returns {string}
    */
   function classForStatus(status) {
@@ -32,20 +33,28 @@
       case "passed":               return "success";
       case "pending":              return "muted";
     }
-  };
+  }
 
 
   /**
-   * @param {string} status
+   * @param {SubmissionStatus} status
    * @param {boolean} [active]
    * @returns {string}
    */
   function progressListItemClassForStatus(status, active = false) {
     return `progress-list-item text-center ${classForStatus(status)} ${active ? 'active' : ''}`;
-  };
+  }
 
-  mumuki.renderers = mumuki.renderers || {};
-  mumuki.renderers.classForStatus = classForStatus;
-  mumuki.renderers.iconForStatus = iconForStatus;
-  mumuki.renderers.progressListItemClassForStatus = progressListItemClassForStatus;
+  return {
+    classForStatus,
+    iconForStatus,
+    progressListItemClassForStatus
+  }
 })();
+
+/** @deprecated use {@code mumuki.renderers.results.classForStatus} instead */
+mumuki.renderers.classForStatus = mumuki.renderers.results.classForStatus;
+/** @deprecated use {@code mumuki.renderers.results.iconForStatus} instead */
+mumuki.renderers.iconForStatus = mumuki.renderers.results.iconForStatus;
+/** @deprecated use {@code mumuki.renderers.results.progressListItemClassForStatus} instead */
+mumuki.renderers.progressListItemClassForStatus = mumuki.renderers.results.progressListItemClassForStatus;