mumuki-laboratory 9.11.0 → 9.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b34448fea9940dfe1784874284974ae37cce2df2b56277e2eb1afdff93cab092
-  data.tar.gz: 14cafb4c1d57a5ecf4569c3de18a8ab35f2b0d7030dcd3f0c925945d3f9f2200
+  metadata.gz: 81fd1285c7db44af533a878ee10b6388976451e1d9b493c5aabf5db6516855bd
+  data.tar.gz: b76dcfb86b425f80fa31e2683561d897c7e047fb7ff538319317c1cee40a327c
 SHA512:
-  metadata.gz: f8796a932c0f10ffd127de92b75d21cae746aae645e57a1a8c40e714c139ef9cd5b833cacd7e1c2259ca298ea8a076d1248c7891aacb49f69066a85bd37cbfce
-  data.tar.gz: 77ebd8d9a64a7eb2767e35a67befe8cf9f96346e4df97a92b23ad805c71c275252d1965744193d8c9b16d7f7b555323fd7d38b6176bacf32511944dd3296b3a0
+  metadata.gz: 9d583004159cc6bc0d88e318b3b0da5c9363b61a2b57f228f25f9ee19a016acb518f420b70015254367b2dd930b1887ae1ef61332cd349982251a1ecce995199
+  data.tar.gz: fec344b55bec29c42ca6b8017b7500ec08e0209aaf7649391890268adcc6f626077cb91040bfb2f391a38fe0a67e7af266b93fa0ccb28b6e01c2f9a5ebe9076b

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

@@ -13,7 +13,9 @@
  * @typedef {{
   *  status: SubmissionStatus,
   *  class_for_progress_list_item?: string,
-  *  guide_finished_by_solution?: boolean
+  *  guide_finished_by_solution?: boolean,
+  *  title_html?: string,
+  *  in_gamified_context?: boolean
   * }} SubmissionResult
   */
 
@@ -47,7 +49,13 @@
  */
 
 /**
- * @typedef {Contents & {client_result?: SubmissionClientResult}} Submission
+ * A submission, composed by:
+ *
+ *  * its actual contents
+ *  * the client results
+ *  * the _pristine flag, that tells whether the submission has been sent without previous results
+ *
+ * @typedef {Contents & {client_result?: SubmissionClientResult, _pristine: boolean}} Submission
  */
 
 /**
@@ -83,12 +91,12 @@ mumuki.bridge = (() => {
      */
     _submitSolution(submission) {
       const lastSubmission = mumuki.SubmissionsStore.getSubmissionResultFor(mumuki.exercise.id, submission);
-      if (lastSubmission) {
-        return $.Deferred().resolve(lastSubmission);
-      } else {
+      if (submission._pristine || !lastSubmission) {
         return this._sendNewSolution(submission).done((result) => {
           mumuki.SubmissionsStore.setSubmissionResultFor(mumuki.exercise.id, {submission, result});
         });
+      } else {
+        return $.Deferred().resolve(lastSubmission);
       }
     }
 
@@ -107,14 +115,12 @@ mumuki.bridge = (() => {
     }
 
     /**
-     * Pre-renders some html parts of submission UI, adding them to the given result
-     *
      * @param {SubmissionResult} result
      * @returns {SubmissionResult}
+     * @see mumuki.renderers.results.preRenderResult
      */
     _preRenderResult(result) {
-      result.class_for_progress_list_item = mumuki.renderers.results.progressListItemClassForStatus(result.status, true);
-      result.title_html = mumuki.renderers.results.translatedTitleHtml(result.status, result.in_gamified_context);
+      mumuki.renderers.results.preRenderResult(result);
       return result;
     }
   }

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

@@ -1,17 +1,19 @@
 mumuki.load(() => {
-  $('.btn-confirmation').on('click change', function (_evt) {
-    var token = new mumuki.CsrfToken();
+  $('.btn-confirmation').on('click change', function (_event) {
+    const token = new mumuki.CsrfToken();
+    const $element = $(this);
 
     $.ajax(token.newRequest({
       method: 'POST',
-      url: $(this).data('confirmation-url'),
+      url: $element.data('confirmation-url'),
       xhrFields: {withCredentials: true},
-      success: function(data){
-        mumuki.updateProgressBarAndShowModal(data);
+      success: function(result) {
+        result.status = "passed";
+        mumuki.renderers.results.preRenderResult(result)
+        mumuki.updateProgressBarAndShowModal(result);
+        window.location = $element.attr("href");
       }
     }));
-
-    return true;
+    return false;
   });
 });
-

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

@@ -55,12 +55,14 @@ mumuki.editors = {
    * @returns {Submission}
    */
   getSubmission() {
-    let content = {};
+    let submission = {
+      _pristine: $('.submission-results').children().length === 0
+    };
     let contents = this.getContents();
     contents.forEach((it) => {
-      content[it.name] = it.value;
+      submission[it.name] = it.value;
     });
-    return content;
+    return submission;
   },
 
   /**

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

@@ -2,11 +2,11 @@ mumuki.progress = (() => {
   /**
    * Updates the current exercise progress indicator
    *
-   * @param {SubmissionResult} data
+   * @param {SubmissionResult} result
    * */
-  function updateProgressBarAndShowModal(data) {
-    $('.progress-list-item.active').attr('class', data.class_for_progress_list_item);
-    if(data.guide_finished_by_solution) new bootstrap.Modal('#guide-done').show();
+  function updateProgressBarAndShowModal(result) {
+    $('.progress-list-item.active').attr('class', result.class_for_progress_list_item);
+    if(result.guide_finished_by_solution) new bootstrap.Modal('#guide-done').show();
   }
 
   /**

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

@@ -71,11 +71,22 @@ mumuki.renderers.results = (() => {
     return `progress-list-item text-center ${classForStatus(status)} ${active ? 'active' : ''}`;
   }
 
+  /**
+   * Pre-renders some html parts of submission UI, adding them to the given result
+   *
+   * @param {SubmissionResult} result
+   */
+  function preRenderResult(result) {
+    result.class_for_progress_list_item = progressListItemClassForStatus(result.status, true);
+    result.title_html = translatedTitleHtml(result.status, result.in_gamified_context);
+  }
+
   return {
     classForStatus,
     iconForStatus,
     progressListItemClassForStatus,
-    translatedTitleHtml
+    translatedTitleHtml,
+    preRenderResult
   };
 })();
 

data/app/assets/javascripts/mumuki_laboratory/application/submissions-store.js

@@ -89,8 +89,14 @@ mumuki.SubmissionsStore = (() => {
 
     // private API
 
-    _asString(object) {
-      return JSON.stringify(object);
+    /**
+     * Serializes the submission and result.
+     * Private attributes are ignored
+     */
+    _asString(submissionAndResult) {
+      return JSON.stringify(submissionAndResult, (key, value) => {
+        if (!key.startsWith("_")) return value
+      });
     }
 
     _keyFor(exerciseId) {

data/app/controllers/users_controller.rb

@@ -56,7 +56,7 @@ class UsersController < ApplicationController
   end
 
   def notifications
-    @notifications = @user.notifications.order(created_at: :desc).page(params[:page])
+    @notifications = @user.notifications_in_organization.order(created_at: :desc).page(params[:page])
   end
 
   def toggle_read

data/app/helpers/time_zone_helper.rb

@@ -0,0 +1,5 @@
+module TimeZoneHelper
+  def local_time(time, time_zone = Time.zone.name)
+    "#{l(time.in_time_zone(time_zone), format: :long)} (#{time_zone})"
+  end
+end

data/app/mailers/user_mailer.rb

@@ -1,6 +1,8 @@
 class UserMailer < ApplicationMailer
   include WithCertificateRender
 
+  helper :time_zone
+
   def welcome_email(user, organization)
     with_locale(user, organization) do
       organization_name = organization.display_name || t(:your_new_organization)

data/app/views/notifications/previews/_exam_authorization_request_updated.html.erb

@@ -1,2 +1,2 @@
 <% target = notification.target %>
-<%= notification_preview_item :book_open, :exam_authorization_request_updated, exam_authorizations_user_path, { description: target.exam_registration.description } %>
+<%= notification_preview_item :book_open, :exam_authorization_request_updated, exam_authorizations_user_path(notification.organization), { description: target.exam_registration.description } %>

data/app/views/user_mailer/_mail_template.erb

@@ -107,7 +107,7 @@
                           <tbody>
                           <tr>
                             <td align="center" valign="middle" class="muMailButtonContent" style="font-family: Helvetica; font-size: 18px; padding: 18px;">
-                              <a class="muMailButton " title=<%= button %> href=<%= url %> target="_blank" style="font-weight: bold;letter-spacing: -0.5px;line-height: 100%;text-align: center;text-decoration: none;color: #FFFFFF;"><%= button %></a>
+                              <a class="muMailButton" title="<%= button %>" href="<%= url %>" target="_blank" style="font-weight: bold;letter-spacing: -0.5px;line-height: 100%;text-align: center;text-decoration: none;color: #FFFFFF;"><%= button %></a>
                             </td>
                           </tr>
                           </tbody>

data/app/views/user_mailer/notifications/_exam_registration.html.erb

@@ -1,7 +1,7 @@
 <%= render partial: 'user_mailer/mail_template', locals: {
   title: t("mailer.title.exam_registration"),
   subtitle: t("mailer.subtitle.exam_registration"),
-  text: t("mailer.text.exam_registration", exam_registration_deadline: l(@notification.target.end_time, format: :long)),
+  text: t("mailer.text.exam_registration", exam_registration_deadline: local_time(@notification.target.end_time, @organization.time_zone)),
   button: t("mailer.button.exam_registration"),
   url: exam_registration_url(@organization, @notification.target)
 } %>

data/app/views/user_mailer/notifications/exam_authorization_request_updated/_approved.html.erb

@@ -1,7 +1,7 @@
 <%= render partial: 'user_mailer/mail_template', locals: {
   title: t(:congratulations),
   subtitle: t('mailer.subtitle.exam_authorization_request_approved'),
-  text: t('mailer.text.exam_authorization_request_approved', exam_start_date: l(@notification.target.exam.start_time, format: :long)),
+  text: t('mailer.text.exam_authorization_request_approved', exam_start_date: local_time(@notification.target.exam.start_time, @organization.time_zone)),
   button: t('mailer.button.exam_authorization_request_approved'),
   url: @organization.url
 } %>

data/app/views/users/manage_notifications.html.erb

@@ -9,7 +9,7 @@
         <h1><%= t(:manage_notifications) %></h1>
         <div class="mu-profile-actions d-none d-md-block">
           <a class="btn btn-secondary" href="<%= notifications_user_path %>">Cancelar</a>
-          <button type="submit" class="btn btn-complementary"><%= t :submit %></button>
+          <button type="submit" class="btn btn-complementary"><%= t :save %></button>
         </div>
       </div>
 

data/app/views/users/notifications.html.erb

@@ -32,7 +32,7 @@
           <% @notifications.each do |notification| %>
             <tr class="<%= background_for_notification notification %>" >
               <td class="col-md-1">
-                <%= link_to icon_for_read(notification.read?), "notifications/#{notification.id}/toggle_read", tooltip_options(:read).merge(method: :post, role: :button) %>
+                <%= link_to icon_for_read(notification.read?), "notifications/#{notification.id}/toggle_read", tooltip_options(:toggle_read).merge(method: :post, role: :button) %>
               </td>
               <td class="col-md-8 text-break">
                 <%= render partial: "notifications/#{notification.subject}", locals: { notification: notification } %>

data/lib/mumuki/laboratory.rb

@@ -59,3 +59,4 @@ require_relative './laboratory/version'
 require_relative './laboratory/extensions'
 require_relative './laboratory/controllers'
 require_relative './laboratory/engine'
+require_relative './laboratory/mailers/message_delivery'

data/lib/mumuki/laboratory/locales/en.yml

@@ -366,6 +366,7 @@ en:
   to_opened: Reopen
   to_pending_review: Mark as solved
   to_solved: Mark as solved
+  toggle_read: "Toggle read/unread"
   unauthorized_explanation: You have no permissions for this content. Maybe you logged in with another account.
   total: Total
   undo_upvote: Undo upvote

data/lib/mumuki/laboratory/locales/es-CL.yml

@@ -378,6 +378,7 @@ es-CL:
   to_opened: Reabrir
   to_pending_review: Resolver
   to_solved: Resolver
+  toggle_read: "Marcar como leído/no leído"
   unauthorized_explanation: ¡Ups! Esto es lo que se conoce como %{error}, es decir que no iniciaste sesión.
   total: Total
   uncategorized: No categorizado

data/lib/mumuki/laboratory/locales/es.yml

@@ -392,6 +392,7 @@ es:
   to_opened: Reabrir
   to_pending_review: Resolver
   to_solved: Resolver
+  toggle_read: "Marcar como leído/no leído"
   unauthorized_explanation: ¡Ups! Esto es lo que se conoce como %{error}, es decir que no iniciaste sesión.
   total: Total
   uncategorized: No categorizado

data/lib/mumuki/laboratory/locales/pt.yml

@@ -379,6 +379,7 @@ pt:
   to_opened: Reabrir
   to_pending_review: Marcar como resolvida
   to_solved: Marcar como resolvida
+  toggle_read: "Marcar como lido / não lido"
   unauthorized_explanation: Opa! Isso é o que é conhecido como %{error}, ou seja, você não fez logon.
   total: Total
   uncategorized: Não classificado

data/lib/mumuki/laboratory/mailers/message_delivery.rb

@@ -0,0 +1,15 @@
+class ActionMailer::MessageDelivery
+  def post!
+    if in_rake_task?
+      deliver_now
+    else
+      deliver_later
+    end
+  end
+
+  private
+
+  def in_rake_task?
+    defined? Rake.application
+  end
+end

data/lib/mumuki/laboratory/version.rb

@@ -1,5 +1,5 @@
 module Mumuki
   module Laboratory
-    VERSION = '9.11.0'
+    VERSION = '9.12.0'
   end
 end

data/spec/javascripts/editors-spec.js

@@ -33,7 +33,7 @@ describe('editors', () => {
       }
     });
 
-    expect(mumuki.editors.getSubmission()).toEqual({"solution[content]":"the custom solution"});
+    expect(mumuki.editors.getSubmission()).toEqual({"_pristine": true, "solution[content]":"the custom solution"});
   });
 
   it('reads the form if no sources', () => {
@@ -43,7 +43,24 @@ describe('editors', () => {
         <textarea class="form-control editor" name="solution[content]" id="solution_content">the solution</textarea>
       </div>
     </form>`);
-    expect(mumuki.editors.getSubmission()).toEqual({"solution[content]":"the solution"});
+    expect(mumuki.editors.getSubmission()).toEqual({"_pristine": true, "solution[content]":"the solution"});
+  });
+
+  it('reads the form when it is not the first submission', () => {
+    $('body').html(`
+    <form role="form" class="new_solution">
+      <div class="editor-code">
+        <textarea class="form-control editor" name="solution[content]" id="solution_content">the solution</textarea>
+      </div>
+    </form>
+    <div class=" submission-results">
+      <div class="bs-callout bs-callout-success">
+        <h4 class="text-success">
+          <strong><i class="fas fa-check-circle"></i> ¡Muy bien!</strong>
+        </h4>
+      </div>
+    </div>`);
+    expect(mumuki.editors.getSubmission()).toEqual({"_pristine": false, "solution[content]":"the solution"});
   });
 
   it('reads the form if no sources and exercise is multifile', () => {
@@ -63,6 +80,7 @@ describe('editors', () => {
       </div>
     </form>`);
     expect(mumuki.editors.getSubmission()).toEqual({
+      "_pristine": true,
       "solution[content[index.html]]": "some html",
       "solution[content[receta.css]]": "some css"
     });
@@ -70,6 +88,6 @@ describe('editors', () => {
 
   it('produces empty submission if no form nor sources', () => {
     $('body').html(``);
-    expect(mumuki.editors.getSubmission()).toEqual({});
+    expect(mumuki.editors.getSubmission()).toEqual({_pristine: true});
   });
 });

data/spec/javascripts/submissions-store-spec.js

@@ -18,6 +18,17 @@ describe("SubmissionsStore", () => {
       mumuki.SubmissionsStore.setSubmissionResultFor(1, passedEmptyProgramSubmissionAndResult);
       expect(mumuki.SubmissionsStore.getLastSubmissionAndResult(1)).toEqual(passedEmptyProgramSubmissionAndResult);
     });
+
+    it("answers the last submission result, ignoring pristiness", () => {
+      mumuki.SubmissionsStore.setSubmissionResultFor(1, {
+        submission: {
+          ...emptyProgramSubmission,
+          _pristine: true
+        },
+        result: passedSubmissionResult
+      });
+      expect(mumuki.SubmissionsStore.getLastSubmissionAndResult(1)).toEqual(passedEmptyProgramSubmissionAndResult);
+    });
   });
 
   describe('getLastSubmissionStatus', () => {

data/spec/mailers/previews/user_mailer_preview.rb

@@ -7,19 +7,64 @@ class UserMailerPreview < ActionMailer::Preview
   end
 
   def custom_content_plain_text_notification
-    UserMailer.notification notification
+    UserMailer.notification notification subject: :custom,
+                                         custom_content_plain_text: 'This is the text of the mail. Awesome!',
+                                         custom_title: 'This is the title!'
   end
 
   def custom_content_html_notification
-    UserMailer.notification notification(custom_content_html: 'This is <em>the text</em> of the mail. <strong>Awesome!</strong>')
+    UserMailer.notification notification subject: :custom,
+                                         custom_content_html: 'This is <em>the text</em> of the mail. <strong>Awesome!</strong>',
+                                         custom_title: 'This is the title!'
   end
 
   def certificate_preview
     UserMailer.certificate certificate
   end
 
+  def exam_registration_preview
+    notification = notification target: exam_registration, subject: :exam_registration
+
+    UserMailer.notification notification
+  end
+
+  def exam_authorization_request_approved
+    notification = notification target: exam_authorization_request('approved'), subject: :exam_authorization_request_updated
+
+    UserMailer.notification notification
+  end
+
+  def exam_authorization_request_rejected
+    notification = notification target: exam_authorization_request('rejected'), subject: :exam_authorization_request_updated
+
+    UserMailer.notification notification
+  end
+
   private
 
+  def exam_registration
+    ExamRegistration.new id: 1,
+                         organization: organization,
+                         description: 'Some test description',
+                         start_time: 5.minute.ago,
+                         end_time: 5.minutes.since
+
+  end
+
+  def exam_authorization_request(status)
+    ExamAuthorizationRequest.new id: 1,
+                                 user: user,
+                                 status: status,
+                                 exam: exam,
+                                 organization: organization
+  end
+
+  def exam
+    Exam.new organization: organization,
+             start_time: 5.minute.ago,
+             end_time: 5.minutes.since
+  end
+
   def user
     User.new uid: 'some_user@gmail.com',
              first_name: 'Some',
@@ -45,9 +90,6 @@ class UserMailerPreview < ActionMailer::Preview
 
   def notification(**hash)
     Notification.new({user: user,
-                     organization: organization,
-                     subject: :custom,
-                     custom_content_plain_text: 'This is the text of the mail. Awesome!',
-                     custom_title: 'This is the title!'}.merge hash)
+                     organization: organization}.merge hash)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mumuki-laboratory
 version: !ruby/object:Gem::Version
-  version: 9.11.0
+  version: 9.12.0
 platform: ruby
 authors:
 - Franco Bulgarelli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-06 00:00:00.000000000 Z
+date: 2021-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 9.11.0
+        version: 9.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 9.11.0
+        version: 9.12.0
 - !ruby/object:Gem::Dependency
   name: mumukit-bridge
   requirement: !ruby/object:Gem::Requirement
@@ -573,6 +573,7 @@ files:
 - app/helpers/progress_bar_helper.rb
 - app/helpers/progress_helper.rb
 - app/helpers/runner_assets_helper.rb
+- app/helpers/time_zone_helper.rb
 - app/helpers/toast_helper.rb
 - app/helpers/user_activity_helper.rb
 - app/helpers/user_discussions_helper.rb
@@ -772,6 +773,7 @@ files:
 - lib/mumuki/laboratory/locales/es.yml
 - lib/mumuki/laboratory/locales/pt.yml
 - lib/mumuki/laboratory/locales/views.es.yml
+- lib/mumuki/laboratory/mailers/message_delivery.rb
 - lib/mumuki/laboratory/version.rb
 - lib/tasks/assignments.rake
 - lib/tasks/events.rake