mumuki-laboratory 7.7.4 → 7.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40346e6aba6ab0a380ef19ac5303e05c8241268ca69e254bc7f1ecac00763add
-  data.tar.gz: 5d25b2e9ed280d92ffc882a6ad4146efe57949b0fcbe222d23f34e0be0858e8d
+  metadata.gz: 59c8677983391000fb921b297d3b1fcce6563868cd63d9b82d75fc64a6a72ab7
+  data.tar.gz: ddb14c573abf4be08e652ea95234ce8c47bc0fd3c8cee1f749125c5626aa2dd7
 SHA512:
-  metadata.gz: f5cef47d4a3808cd92b4e13b062a747de1d4dfd2dd5955606d74490cbc415d94410e422f57a21acffff0beacc7b8d3345efe1382028e12213117b88b7ec4d454
-  data.tar.gz: e3c8ef0d05ad1f784bc4941ab8dcc4031ff2c710d8085dd609eccd0b564198355a66ca9bf6989bc5bc8d5db89059607f0337f5b939e418edef7bdd1b4a75a43b
+  metadata.gz: 1fc6ed061566bdb62bce63ea60ee285a489eaeaa6f8ba357ec579b37d4e366008cd4b1347f33a229a290cf344b6e84e64d7cd0e5df2870044ff30476d5d66403
+  data.tar.gz: 59bafbcbf9a6b6feb47b33cf1c37cec4c67ee6c7ca2ad25419977fc51ec4a8e42f58b444373063fa9b9e19505fb111be4b2640a8583da127b96d250700578a33

data/README.md

@@ -141,9 +141,53 @@ bundle exec rspec
 > it and add it to your path
 
 ```bash
-bundle exec rake teaspoon
+MOZ_HEADLESS=1 bundle exec rake teaspoon
 ```
 
+## Running `eslint`
+
+```bash
+yarn run lint
+```
+
+## Using a local runner
+
+Sometimes you will need to check `laboratory` against a local runner. Run the following code in you `rails console`:
+
+```ruby
+require 'mumuki/domain/seed'
+
+# import a new language
+Mumuki::Domain::Seed.languages_syncer.locate_and_import!  Language, 'http://localhost:9292'
+
+# update an existing language object
+Mumuki::Domain::Seed.languages_syncer.import!  Mumukit::Sync.key(Language, 'http://localhost:9292'), language
+```
+
+## Using a remote content
+
+Likewise, you will sometimes require a guide that is not locally available. Run the following code in `rails console`:
+
+```ruby
+require 'mumuki/domain/seed'
+
+# import a new guide
+Mumuki::Domain::Seed.contents_syncer.locate_and_import!  Guide, slug)
+
+# update an existing guide object
+Mumuki::Domain::Seed.contents_syncer.import!  Mumukit::Sync.key(Guide, slug), guide
+```
+
+After that you will probably to add it somewhere. The easiest way is to create a complement of `central`:
+
+```ruby
+o = Organization.central
+o.book.complements << Guide.locate!(slug).as_complement_of(o.book)
+o.reindex_usages!
+```
+
+Now you will be able to visit that guide at `http://localhost:3000/central/guides/#{slug}`
+
 ## JavaScript API Docs
 
 In order to be customized by runners, Laboratory exposes the following selectors and methods
@@ -208,6 +252,10 @@ which are granted to be safe and stable.
   * `SpeechBubbleRenderer`
   * `renderSpeechBubbleResultItem`
 * `mumuki.locale`
+* `mumuki.exercise`
+   * `id`: the `id` of the currently loaded exercise, if any
+   * `layout`: the `layout` of the currently loaded exercise, if any
+* `mumuki.incognitoUser`: whether the current user is an incognito user
 * `mumuki.MultipleScenarios`
   * `scenarios`
   * `currentScenarioIndex`
@@ -258,6 +306,38 @@ which are granted to be safe and stable.
 2. Laboratory Kids Layout Initialization
 3. Runner Editor HTML
 
+## Generic event system
+
+Laboartory provides the `mumuki.events` object, which acts as minimal, generic event system, which is mostly designed for third party components built on top of laboratory and runners. It does nothing by default.
+
+This API has two parts: consumers API and producers API.
+
+```javascript
+// ======
+// producer
+// ======
+
+// you need to call this method in order to enable registration of event handlers
+// otherwise, it will  be ignored
+mumuki.events.enable('myEvent');
+
+// fire the event, with an optional event object as payload
+mumuki.events.fire('myEvent', aPlainOldObject);
+
+// clear all the registered event handlers
+mumuki.events.clear('myEvent');
+
+// ========
+// consumer
+// ========
+
+// register an event handler
+mumuki.events.on('myEvent', (anEventObject) => {
+  // do stuff
+});
+```
+
+
 ## Custom editors
 
 Mumuki provides several editor types: code editors, multiple choice, file upload, and so on.
@@ -369,14 +449,14 @@ contents. There are two different approaches:
 
 ```javascript
 // simplest method - you can register just one
-mumuki.submission.registerContentSyncer(() => {
+mumuki.editors.registerContentSyncer(() => {
   // ... write here your custom component content...
   $('#mu-custom-editor-value').val(/* ... */);
 });
 
 // alternate method
 // you can register many sources
-mumuki.CustomEditor.addSource({
+mumuki.editors.addCustomSource({
   getContent() {
     return { name: "solution[content]", value: /* ... */ } ;
   }

data/Rakefile

@@ -27,8 +27,14 @@ require 'rspec/core/rake_task'
 desc "Run all specs in spec directory (excluding plugin specs)"
 RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
 
+desc "Force development environment, required by javascript specs"
+task :development do
+  ENV['RACK_ENV'] = 'development'
+  ENV['RAILS_ENV'] = 'development'
+end
+
 desc "Run the javascript specs"
-task :teaspoon => "app:teaspoon"
+task teaspoon: [:development, "app:teaspoon"]
 
 task default: :spec
 

data/app/assets/javascripts/mumuki_laboratory/application/alias-modes.js

@@ -1,4 +1,4 @@
-mumuki.load(function () {
+mumuki.load(() => {
 
   function CodeMirrorAlias(alias, current) {
     CodeMirror.defineMIME(alias, CodeMirror.mimeModes[current]);

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

@@ -1,60 +1,41 @@
 /**
- * @typedef {{status: string, test_results: [{status: string, title: string}]}} ClientResult
+ * @typedef {"errored"|"failed"|"passed_with_warnings"|"passed"|"pending"|"aborted"} SubmissionStatus
  */
 
 /**
- * @typedef {{solution: object, client_result?: ClientResult}} Submission
+ * @typedef {{
+ *  status: SubmissionStatus,
+ *  test_results: [{status: SubmissionStatus, title: string}]
+ * }} SubmissionClientResult
  */
 
-var mumuki = mumuki || {};
-
-(function (mumuki) {
-  var lastSubmission = {};
-
-  function Laboratory(exerciseId){
-    this.exerciseId = exerciseId;
-  }
-
-  function asString(json){
-    return JSON.stringify(json);
-  }
-
-  function sameAsLastSolution(newSolution){
-    return asString(lastSubmission.content) === asString(newSolution);
-  }
-
-  function lastSubmissionFinishedSuccessfully(){
-    return lastSubmission.result && lastSubmission.result.status !== 'aborted';
-  }
-
-  function sendNewSolution(submission){
-    var token = new mumuki.CsrfToken();
-    var request = token.newRequest({
-      type: 'POST',
-      url: window.location.origin + window.location.pathname + '/solutions' + window.location.search,
-      data: submission
-    });
-
-    return $.ajax(request).then(preRenderResult).done(function (result) {
-      lastSubmission = { content: {solution: submission.solution}, result: result };
-    });
-  }
+/**
+ * @typedef {{
+  *  status: SubmissionStatus,
+  *  class_for_progress_list_item?: string,
+  *  guide_finished_by_solution?: boolean
+  * }} SubmissionResult
+  */
 
+/**
+ * @typedef {object} Solution
+ */
 
-  /**
-   * Pre-renders some html parts of submission UI
-   * */
-  function preRenderResult(result) {
-    result.class_for_progress_list_item = mumuki.renderers.progressListItemClassForStatus(result.status, true)
-    return result;
-  }
+/**
+ * @typedef {{
+ *  "solution[content]"?:string,
+ *  solution?: Solution,
+ *  client_result?: SubmissionClientResult
+ * }} Submission
+ */
 
-  mumuki.load(function () {
-    lastSubmission = {};
-  });
+/**
+ * @typedef {{submission?: Submission, result?: SubmissionResult}} SubmissionAndResult
+ */
 
-  Laboratory.prototype = {
+mumuki.bridge = (() => {
 
+  class Laboratory {
     // ==========
     // Public API
     // ==========
@@ -65,9 +46,9 @@ var mumuki = mumuki || {};
      *
      * @param {object} content the content object
      * */
-    runTests: function(content) {
+    runTests(content) {
       return this._submitSolution({ solution: content });
-    },
+    }
 
     // ===========
     // Private API
@@ -77,18 +58,46 @@ var mumuki = mumuki || {};
      * Sends a solution object
      *
      * @param {Submission} submission the submission object
+     * @returns {JQuery.Promise<SubmissionResult>}
      */
-    _submitSolution: function (submission) {
-      if(lastSubmissionFinishedSuccessfully() && sameAsLastSolution(submission)){
-        return $.Deferred().resolve(lastSubmission.result);
+    _submitSolution(submission) {
+      const lastSubmission = mumuki.SubmissionsStore.getSubmissionResultFor(mumuki.exercise.id, submission);
+      if (lastSubmission) {
+        return $.Deferred().resolve(lastSubmission);
       } else {
-        return sendNewSolution(submission);
+        return this._sendNewSolution(submission).done((result) => {
+          mumuki.SubmissionsStore.setSubmissionResultFor(mumuki.exercise.id, {submission, result});
+        });
       }
     }
-  };
 
-  mumuki.bridge = {
-    Laboratory: Laboratory
-  };
+    /**
+     * @param {Submission} submission the submission object
+     * @returns {JQuery.Promise<SubmissionResult>}
+     */
+    _sendNewSolution(submission){
+      var token = new mumuki.CsrfToken();
+      var request = token.newRequest({
+        type: 'POST',
+        url: window.location.origin + window.location.pathname + '/solutions' + window.location.search,
+        data: submission
+      });
+      return $.ajax(request).then((result) => this._preRenderResult(result));
+    }
+
+    /**
+     * Pre-renders some html parts of submission UI, adding them to the given result
+     *
+     * @param {SubmissionResult} result
+     * @returns {SubmissionResult}
+     */
+    _preRenderResult(result) {
+      result.class_for_progress_list_item = mumuki.renderers.progressListItemClassForStatus(result.status, true)
+      return result;
+    }
+  }
 
-}(mumuki));
+  return {
+    Laboratory
+  };
+})();

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

@@ -1,12 +1,4 @@
-var mumuki = mumuki || {};
-
-(function (mumuki) {
-
-  function CodeMirrorBuilder(textarea) {
-    this.textarea = textarea;
-    this.$textarea = $(textarea);
-  }
-
+(() => {
   function submit() {
     $('body').removeClass('fullscreen');
     $('.editor-resize .fa-stack-1x').removeClass('fa-compress').addClass('fa-expand');
@@ -29,8 +21,13 @@ var mumuki = mumuki || {};
     autoRefresh: true
   };
 
-  CodeMirrorBuilder.prototype = {
-    setupEditor: function () {
+  class CodeMirrorBuilder {
+    constructor(textarea) {
+      this.textarea = textarea;
+      this.$textarea = $(textarea);
+    }
+
+    setupEditor() {
       this.editor = this.createEditor({
         lineNumbers: true,
         extraKeys: {
@@ -47,8 +44,9 @@ var mumuki = mumuki || {};
       });
 
       return this;
-    },
-    setupSimpleEditor: function () {
+    }
+
+    setupSimpleEditor() {
       this.editor = this.createEditor({
         mode: 'text',
         extraKeys: {
@@ -61,8 +59,9 @@ var mumuki = mumuki || {};
       });
 
       return this;
-    },
-    setupReadOnlyEditor: function () {
+    }
+
+    setupReadOnlyEditor() {
       this.editor = this.createEditor({
         readOnly: true,
         cursorBlinkRate: -1, //Hides the cursor
@@ -70,8 +69,9 @@ var mumuki = mumuki || {};
       });
 
       return this;
-    },
-    setupLanguage: function (language) {
+    }
+
+    setupLanguage(language) {
       var highlightMode = language || this.$textarea.data('editor-language');
       if (highlightMode === 'dynamic') {
         mumuki.page.dynamicEditors.push(this.editor);
@@ -81,20 +81,23 @@ var mumuki = mumuki || {};
       }
 
       return this;
-    },
-    setupMinLines: function (minLines) {
+    }
+
+    setupMinLines(minLines) {
       this.editor.setOption('minLines', minLines);
 
       return this;
-    },
-    build: function () {
+    }
+
+    build() {
       return this.editor;
-    },
-    createEditor: function (customOptions) {
+    }
+
+    createEditor(customOptions) {
       return CodeMirror.fromTextArea(this.textarea, Object.assign({}, codeMirrorDefaults, customOptions));
     }
-  };
+  }
 
   mumuki.editor = mumuki.editor || {};
   mumuki.editor.CodeMirrorBuilder = CodeMirrorBuilder;
-}(mumuki));
+})();

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

@@ -1,6 +1,9 @@
-var mumuki = mumuki || {};
+mumuki.editor = mumuki.editor || {};
+mumuki.page = mumuki.page || {};
+mumuki.page.dynamicEditors = [];
+mumuki.page.editors = [];
 
-(function (mumuki) {
+(() => {
   function createCodeMirrors() {
     return $(".editor").map(function (index, textarea) {
       var $textarea = $("#solution_content");
@@ -68,21 +71,16 @@ 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;
 
-  mumuki.page = mumuki.page || {};
-  mumuki.page.dynamicEditors = [];
-  mumuki.page.editors = [];
 
-
-  mumuki.load(function () {
+  mumuki.load(() => {
     mumuki.page.editors = createCodeMirrors();
-    mumuki.submission.registerContentSyncer(mumuki.editor.syncContent);
+    mumuki.editors.registerContentSyncer(mumuki.editor.syncContent);
     updateCodeMirrorLanguage();
     onSelectUpdateCodeMirror();
 
@@ -101,4 +99,4 @@ var mumuki = mumuki || {};
     });
   });
 
-}(mumuki));
+})();

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

@@ -1,5 +1,5 @@
-mumuki.load(function () {
-  $('.btn-confirmation').on('click change', function (evt) {
+mumuki.load(() => {
+  $('.btn-confirmation').on('click change', function (_evt) {
     var token = new mumuki.CsrfToken();
 
     $.ajax(token.newRequest({