mumuki-laboratory 7.3.0 → 7.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34a309d23781b16429c67d4898ec3522ea8cc921c5980a8be22d8c10d29aa74b
-  data.tar.gz: ea53886235870295a9821b84ef509f6a2b50cb20411c4eef368e9a0cd5851bf8
+  metadata.gz: df24c3f8b39eefd6008a045943cc58656920835a5e6b0f45b08653404e710ba0
+  data.tar.gz: 746a6eae36dff89eacc230c06373f385186c949b64c311176d16180e4299e676
 SHA512:
-  metadata.gz: fa4ac32fd357aae1f45a1e999d49d0d7aca17f3eb183930725cd49bf9c9f86f71c9fd7da25b63313900e98511b27477d8a5b49dc4857487ac3e29a9a7f4b33e0
-  data.tar.gz: 3cf087f36868a799843bfdc651501ab70489cc2671e62c96b2f19578bbe5c07e1db46a00dda4972400db9f1ec3c1c4d438733a1139318282a107f6f567789bd8
+  metadata.gz: 4af6a62459053087a8ee3fbfb9ed6f22020a1582a2c881955a0ec33b24ca9b0e18bd303d4a10ebac8766da507c2fe53f5b6c890b98126d033741fc39e058bdad
+  data.tar.gz: 57b0fe7c7338f7364a163cfcd7d278ddeb47d771ee43053507fd9c81da47ef08a19234af22fead4d0d4c73f10b9889b0ce695a61e331f8e0b0ad2c96d01da977

data/README.md

@@ -178,6 +178,12 @@ which are granted to be safe and stable.
 
 * `mumuki.bridge.Laboratory`
   * `.runTests`
+* `mumuki.editor`
+  * `formatContent`
+  * `reset`
+  * `toggleFullscreen`
+* `mumuki.elipsis`
+  * `replaceHtml`
 * `mumuki.kids`
   * `registerBlocksAreaScaler`
   * `registerStateScaler`
@@ -185,6 +191,9 @@ which are granted to be safe and stable.
   * `scaleBlocksArea`
   * `scaleState`
   * `showResult`
+* `mumuki.renderers`
+  * `SpeechBubbleRenderer`
+  * `renderSpeechBubbleResultItem`
 * `mumuki.locale`
 * `mumuki.MultipleScenarios`
   * `scenarios`
@@ -200,22 +209,29 @@ which are granted to be safe and stable.
 
 ### Bridge Response Format
 
-```json
+```javascript
 {
-  "status": "failed",
-  "guide_finished_by_solution": false,
-  "class_for_progress_list_item":"progress-list-item text-center danger active",
-  "html":"...",
-  "title_html":"...",
-  "button_html":"...",
-  "expectations_html":"...",
-  "remaining_attempts_html":null,
-  "test_results":[
-      {
-        "title":null,
-        "status":"failed",
-        "result":"..."
-      }
+  "status": "passed|passed_with_warnings|failed",
+  "guide_finished_by_solution": "boolean",
+  "class_for_progress_list_item": "string",
+  "html": "string",
+  "remaining_attempts_html": "string" ,
+  "title_html": "string",                         // kids-only
+  "button_html": "string",                        // kids-only
+  "expectations": [                               // kids-only
+    {
+      "status": "passed|failed",
+      "explanation": "string"
+    }
+  ],
+  "tips": [ "string" ],                           // kids-only
+  "test_results": [                               // kids-only
+    {
+      "title": "string",
+      "status": "passed|failed",
+      "result": "string",
+      "summary": "string"
+    }
   ]
 }
 ```
@@ -463,7 +479,7 @@ POST /organization/:id/courses/
 
 ```json
 {
-   "name":"....",
+   "name": "....",
 }
 ```
 
@@ -539,7 +555,7 @@ Sample response body:
 ```json
 {
   "organizations": [
-    { "name": "academy", "contact_email": "a@a.com", "locale": "es-AR", "login_methods": ["facebook"], "books": ["libro"], "public": true, "logo_url":"http://..." },
+    { "name": "academy", "contact_email": "a@a.com", "locale": "es-AR", "login_methods": ["facebook"], "books": ["libro"], "public": true, "logo_url": "http://..." },
     { "name": "alcal", "contact_email": "b@b.com", "locale": "en-US", "login_methods": ["facebook", "github"], "books": ["book"], "public": false }
   ]
 }
@@ -555,7 +571,7 @@ get /organizations/:name
 Sample response body:
 
 ```json
-{ "name": "academy", "contact_email": "a@a.com", "locale": "es-AR", "login_methods": ["facebook"], "books": ["libro"], "public": true, "logo_url":"http://..." }
+{ "name": "academy", "contact_email": "a@a.com", "locale": "es-AR", "login_methods": ["facebook"], "books": ["libro"], "public": true, "logo_url": "http://..." }
 ```
 **Minimal permission**: `janitor` of the organization.
 

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

@@ -23,6 +23,14 @@ var mumuki = mumuki || {};
     })
   }
 
+  function formatContent() {
+    mumuki.page.editors.each(function (_, editor) {
+      editor.setSelection({line: 0, ch: 0}, {line: editor.lineCount()})
+      editor.indentSelection("smart")
+      editor.setSelection({line: 0})
+    });
+  }
+
   function toggleFullscreen() {
     $('body').toggleClass('fullscreen');
     $('.editor-resize .fa-stack-1x').toggleClass('fa-expand').toggleClass('fa-compress');
@@ -61,7 +69,9 @@ var mumuki = mumuki || {};
   }
 
   mumuki.editor = mumuki.editor || {};
+  mumuki.editor.reset = resetEditor;
   mumuki.editor.toggleFullscreen = toggleFullscreen;
+  mumuki.editor.formatContent = formatContent;
   mumuki.editor.indentWithSpaces = indentWithSpaces;
   mumuki.editor.syncContent = syncContent;
 
@@ -81,6 +91,9 @@ var mumuki = mumuki || {};
     $('.editor-resize').click(function () {
       toggleFullscreen();
     });
+    $('.editor-format').click(function (){
+      formatContent();
+    });
   });
 
 }(mumuki));

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

@@ -0,0 +1,31 @@
+// This module defines three client-side-only special sections, and allows them to be replaced
+// by adding the `mu-elipsis` class, or by calling `mumuki.elipsis()`:
+//
+// * <elipsis-for-student@ ...code... @elipsis-for-student>                     : replaces code with an elipsis
+// * <hidden-for-student@ ...code... @hidden-for-student>                       : completely hides code
+// * <description-for-student[...text...]@ ...code... @description-for-student> : replaces code a message sourrounded by elipsis
+//
+//
+// This module assumes the strings are already markdown-like escaped code strings, not plain code
+(function (mumuki) {
+
+  function elipsis(code) {
+    return code
+      .replace(/&lt;elipsis-for-student@[\s\S]*?@elipsis-for-student&gt;/g, ' ... ')
+      .replace(/&lt;hidden-for-student@[\s\S]*?@hidden-for-student&gt;/g, '')
+      .replace(/&lt;description-for-student\[([^\]]*)\]@[\s\S]*?@description-for-student&gt;/g, ' ... $1 ... ');
+  }
+
+  mumuki.elipsis = elipsis;
+  mumuki.elipsis.replaceHtml = () => {
+    let $elipsis = $('.mu-elipsis');
+    $elipsis.each((it, e) =>  {
+      let $e = $(e);
+      $e.html(mumuki.elipsis($e.html()));
+    })
+  };
+
+  mumuki.load(() => {
+    mumuki.elipsis.replaceHtml();
+  });
+})(mumuki);

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

@@ -0,0 +1,17 @@
+var mumuki = mumuki || {};
+
+(function (mumuki) {
+  // 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) {
+    const interval = setInterval.apply(this, [intervalFunction, milliseconds]);
+
+    // Using one to avoid calling clearInterval on every page chance.
+    $(document).one('turbolinks:before-cache turbolinks:before-render', function () {
+      clearInterval(interval);
+    });
+
+    return interval;
+  }.bind(this);
+
+}(mumuki));

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

@@ -169,28 +169,17 @@ mumuki.load(function () {
       $bubble.find('.mu-kids-character-speech-bubble-failed').hide();
       $bubble.find('.mu-kids-discussion-link').remove();
       Object.keys(mumuki.kids.resultAction).forEach($bubble.removeClass.bind($bubble));
-      mumuki.kids._getOverlay().hide();
+      mumuki.kids._getOverlay().hide()
     },
 
     _showMessageOnCharacterBubble: function (data) {
-      var $bubble = mumuki.kids._getCharacterBubble();
-      $bubble.find('.mu-kids-character-speech-bubble-tabs').hide();
-      $bubble.find('.mu-kids-character-speech-bubble-normal').hide();
-      $bubble.find('.mu-kids-character-speech-bubble-failed').show().html(data.title_html);
-      $bubble.addClass(data.status);
-      if (data.status === 'passed_with_warnings') {
-        $bubble.find('.mu-kids-character-speech-bubble-failed').append(data.expectations_html);
-      }
-      if (this._shouldDisplayDiscussionsLink(data.status)) {
-        $bubble.append(discussionsLinkHtml);
-      }
+      const renderer = new mumuki.renderers.SpeechBubbleRenderer(mumuki.kids._getCharacterBubble());
+      renderer.setDiscussionsLinkHtml(discussionsLinkHtml);
+      renderer.setResponseData(data);
+      renderer.render();
       mumuki.kids._getOverlay().show();
     },
 
-    _shouldDisplayDiscussionsLink: function (status) {
-      return ['failed', 'passed_with_warnings'].some(it => it === status);
-    },
-
     _showOnSuccessPopup: function (data) {
       mumuki.kids._updateSubmissionResult(data.html);
       mumuki.presenterCharacter.playAnimation('success_l', mumuki.kids._getCharacterImage());
@@ -313,7 +302,7 @@ mumuki.load(function () {
     });
 
     if (paragraphCount > 1) {
-      nextSpeechBlinking = setInterval(() => $nextSpeech.fadeTo('slow', 0.1).fadeTo('slow', 1.0), 1000);
+      nextSpeechBlinking = mumuki.setInterval(() => $nextSpeech.fadeTo('slow', 0.1).fadeTo('slow', 1.0), 1000);
     }
 
     $nextSpeech.click(showNextParagraph);

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

@@ -45,7 +45,7 @@ mumuki.load(function () {
       });
     },
     setMessagesInterval: function () {
-      setInterval(Chat.getMessages, 60000);
+      mumuki.setInterval(Chat.getMessages, 60000);
     },
     submitMessagesForm: function (url, readUrl, errorUrl) {
       var $container = $('.mu-view-messages');

data/app/assets/javascripts/mumuki_laboratory/application/speech-bubble-renderer.js

@@ -0,0 +1,99 @@
+((mumuki)=> {
+
+  function renderSpeechBubbleResultItem(item) {
+    return `
+        <div class="results-item">
+          <ul class="results-list">
+            <li>${item}</li>
+          </ul>
+        </div>`;
+  }
+
+  // A mumuki.renderers.SpeechBubbleRenderer allows to configure a kids speech bubble
+  // with the data of a test response from bridge
+  class SpeechBubbleRenderer {
+    constructor($bubble) {
+      this.$bubble = $bubble;
+      this.$failedArea = $bubble.find('.mu-kids-character-speech-bubble-failed');
+    }
+
+    _chooseResultItem() {
+      if (this._responseStatus() !== 'passed' && this._hasTips()) {
+        this._appendFirstTip()
+      } else if (this._responseStatus() === 'failed') {
+        this._appendFirstFailedTestResultSummary();
+      } else if (this._responseStatus() === 'passed_with_warnings') {
+        this._appendFirstExpectationResult();
+      }
+    }
+
+    _appendFirstFailedTestResultSummary() {
+      const failedTestResult = this._failedTestResults()[0]
+      if (failedTestResult && failedTestResult.summary) {
+        this._appendResultItem(mumuki.renderers.renderSpeechBubbleResultItem(failedTestResult.summary));
+      }
+    }
+
+    _appendFirstExpectationResult() {
+      this._appendResultItem(mumuki.renderers.renderSpeechBubbleResultItem(this.responseData.expectations[0].explanation));
+    }
+
+    _appendFirstTip() {
+      this._appendResultItem(mumuki.renderers.renderSpeechBubbleResultItem(this.responseData.tips[0]));
+    }
+
+    _appendResultItem(item) {
+      this._addClass('with-result-item');
+      this.$failedArea.append(item);
+    }
+
+    _addClass(klass) {
+      this.$bubble.addClass(klass);
+    }
+
+    _appendDiscussionsLinkHtml() {
+      if (this._shouldDisplayDiscussionsLink()) {
+        this.$bubble.append(this.discussionsLinkHtml);
+      }
+    }
+
+    _shouldDisplayDiscussionsLink() {
+      return ['failed', 'passed_with_warnings'].some(it => it === this._responseStatus());
+    }
+
+    _responseStatus() {
+      return this.responseData.status;
+    }
+
+    _hasTips() {
+      return this.responseData.tips && this.responseData.tips.length
+    }
+
+    _failedTestResults() {
+      return this.responseData.test_results.filter((it) => it.status === 'failed');
+    }
+
+    setDiscussionsLinkHtml(discussionsLinkHtml) {
+      this.discussionsLinkHtml = discussionsLinkHtml;
+    }
+
+    setResponseData(responseData) {
+      this.responseData = responseData;
+    }
+
+    // Entry point of the renderer. It just updates the UI, not returning anything
+    // Configure the renderer with `setDiscussionsLinkHtml` and `setResponseData` first.
+    render() {
+      this.$bubble.find('.mu-kids-character-speech-bubble-tabs').hide();
+      this.$bubble.find('.mu-kids-character-speech-bubble-normal').hide();
+      this.$failedArea.show().html(this.responseData.title_html);
+      this._addClass(this._responseStatus());
+      this._chooseResultItem();
+      this._appendDiscussionsLinkHtml();
+    }
+  }
+
+  mumuki.renderers = mumuki.renderers || {};
+  mumuki.renderers.SpeechBubbleRenderer = SpeechBubbleRenderer;
+  mumuki.renderers.renderSpeechBubbleResultItem = renderSpeechBubbleResultItem;
+})(mumuki)

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

@@ -8,7 +8,7 @@ var mumuki = mumuki || {};
     var duration = moment.duration(diffTime, 'milliseconds');
     var intervalDuration = 1000;
 
-    var interval = setInterval(function () {
+    var interval = mumuki.setInterval(function () {
       duration = moment.utc(duration - intervalDuration);
       if(duration.valueOf() <= 0) {
         clearInterval(interval);

data/app/assets/stylesheets/mumuki_laboratory/application/modules/_editor.scss

@@ -13,25 +13,6 @@ $multifile-inactive-tab-border-color: #ECF0F1;
   max-height: none;
 }
 
-.submission-reset {
-  padding: 5px;
-  cursor: pointer;
-}
-
-.editor-resize {
-  position: absolute;
-  padding: 5px;
-  cursor: pointer;
-  z-index: 10;
-  top: 0;
-  right: 0;
-  font-size: 0.5em;
-  &.multiple-files {
-    top: 43px;
-  }
-}
-
-
 body:not(.fullscreen) {
   .CodeMirror-wrap,
   .CodeMirror-scroll {
@@ -69,10 +50,6 @@ body.fullscreen {
       overflow-y: scroll;
       overflow-x: auto;
     }
-    .submission-reset,
-    .editor-resize {
-      margin-right: 15px;
-    }
   }
 }
 

data/app/assets/stylesheets/mumuki_laboratory/application/modules/_exercise_results.scss

@@ -10,6 +10,9 @@
 ul.results-list {
   list-style-type: none;
   padding-left: 10px;
+  li:first-letter {
+    text-transform: capitalize
+  }
 }
 
 .results-list pre {
@@ -27,3 +30,11 @@ ul.results-list {
     color: white;
   }
 }
+
+.mu-single-test-result {
+  .error-text, /* backward compatibility with gobstones runner */
+  .mu-test-result-header {
+    display: block;
+    line-height: 25px;
+  }
+}

data/app/assets/stylesheets/mumuki_laboratory/application/modules/_kids.scss

@@ -154,7 +154,7 @@ $kids-speech-tabs-width: 40px;
         }
       }
 
-      &.passed_with_warnings {
+      &.with-result-item {
         padding-top: 5px;
         padding-bottom: 5px;
 

data/app/assets/stylesheets/mumuki_laboratory/application/modules/_overlap.scss

@@ -5,6 +5,25 @@
 .mu-overlapped {
   z-index: 10;
   position: absolute;
-  bottom: 0;
+  top: 0;
   right: 0;
-}
+  display: flex;
+  flex-direction: column;
+  a {
+    cursor: pointer;
+    padding: 5px;
+  }
+  &.multiple-files {
+    top: 43px;
+  }
+}
+
+.editor-resize {
+  font-size: 0.5em;
+}
+
+body.fullscreen {
+  .mu-overlapped a {
+    margin-right: 15px;
+  }
+}