mumuki-laboratory 5.3.0 → 5.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2274f31d946435025a018f54c3a83f962a6574d675e1e060712bdc9e78d5c281
-  data.tar.gz: 0a86aa34f9ee2422f41ac9062498f3d925740562a33e3eb5e6bc57239897a8d0
+  metadata.gz: f2a576c10df838214910df546c5ba3aca918fc08275df1b39be0191c419a1d28
+  data.tar.gz: e87e69c8d7a253d16b0694413db2618c37bf6de828bc72e9270fc371b4560631
 SHA512:
-  metadata.gz: 4a73e4420c07b9ee520922d3f1ffcfa5425abc7e5f8fa3bf8311a95664b7b3e50f44faf3f7ab9b4730fcd37cde58332eaa0d9f2dbec7f4e485283212c307361d
-  data.tar.gz: 68e1afc05bf48733ec13e5d1451e35beaf8c7d862197b4f7efe0dabd9ec31001c9afb6ef8c153b415f4cad00c400b8de64fbc960509b929afd189eeb07e0b920
+  metadata.gz: c8a8b571044afdd28d6a59957b0bd51ec6b92197429cd5c36e2221842d65cd65ef44c3e7b8727dafd66c8437fde9e774d3fc39e8e130b31a44ff92910224a472
+  data.tar.gz: 936bf126f56fcdc664c28ec9a52ea6d7cf426b347e15e1c31d32e9b07809454f9da5692dbb88a4a8dcd7b2b1b632b2c55a0eb19f76ed041227c9dbf186784b44

data/README.md

@@ -56,11 +56,16 @@ cd mumuki-laboratory
 > We need to create a PostgreSQL role - AKA a user - who will be used by Laboratory to create and access the database
 
 ```bash
-# create db user
+# create db user for linux users
 sudo -u postgres psql <<EOF
   create role mumuki with createdb login password 'mumuki';
 EOF
 
+# create db user for mac users
+psql postgres
+#once inside postgres server
+create role mumuki with createdb login password 'mumuki';
+
 # create schema and initial development data
 ./devinit
 ```

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

@@ -40,19 +40,18 @@ mumuki.load(function () {
 
   var $speechParagraphs;
   var currentParagraphIndex = 0;
-  var $prevSpeech = $('.mu-kids-character-speech-bubble > .mu-kids-prev-speech').hide();
-  var $nextSpeech = $('.mu-kids-character-speech-bubble > .mu-kids-next-speech');
+  var $prevSpeech = $('.mu-kids-character-speech-bubble-normal > .mu-kids-prev-speech').hide();
+  var $nextSpeech = $('.mu-kids-character-speech-bubble-normal > .mu-kids-next-speech');
+  var $speechTabs = $('.mu-kids-character-speech-bubble-tabs > li:not(.separator)');
+  var $bubble = $('.mu-kids-character-speech-bubble').children('.mu-kids-character-speech-bubble-normal');
+  var $texts = $bubble.children('.description, .hint');
 
   updateSpeechParagraphs();
-
   function updateSpeechParagraphs() {
-    $speechParagraphs = $('.mu-kids-character-speech-bubble > p');
+    $speechParagraphs = $('.mu-kids-character-speech-bubble > .mu-kids-character-speech-bubble-normal > div.' + getSelectedTabName() + ' > p');
+    showParagraph(0);
   }
 
-  var $speechTabs = $('.mu-kids-character-speech-bubble-tabs > li:not(.separator)');
-  var $bubble = $('.mu-kids-character-speech-bubble').children('.mu-kids-character-speech-bubble-normal');
-  var $texts = $bubble.children('.description, .hint');
-
   $speechTabs.each(function (i) {
     var $tab = $($speechTabs[i]);
     $tab.click(function () {
@@ -60,12 +59,12 @@ mumuki.load(function () {
       $tab.addClass('active');
       $texts.hide();
       $bubble.children('.' + $tab.data('target')).show();
+      $bubble.scroll(0);
+      hideCurrentParagraph();
       updateSpeechParagraphs();
     })
   });
 
-  if ($speechParagraphs.length <= 1) $nextSpeech.hide();
-
   $nextSpeech.click(function () {
     hideCurrentParagraph();
     showNextParagraph();
@@ -75,22 +74,50 @@ mumuki.load(function () {
     showPrevParagraph();
   });
 
+  function getSelectedTabName() {
+    return $speechTabs.filter(".active").data('target');
+  }
+
   function hideCurrentParagraph() {
     $($speechParagraphs[currentParagraphIndex]).hide();
   }
 
   function showPrevParagraph() {
-    $nextSpeech.show();
-    $($speechParagraphs[--currentParagraphIndex]).show();
-    if (currentParagraphIndex === 0) $prevSpeech.hide();
+    showParagraph(currentParagraphIndex - 1);
   }
 
   function showNextParagraph() {
-    $prevSpeech.show();
-    $($speechParagraphs[++currentParagraphIndex]).show();
-    if ($speechParagraphs.length - 1 === currentParagraphIndex) $nextSpeech.hide();
+    showParagraph(currentParagraphIndex + 1);
   }
 
+  function showParagraph(index) {
+    $($speechParagraphs[index]).show();
+    setVisibility($prevSpeech, index !== 0);
+    setVisibility($nextSpeech, index !== $speechParagraphs.length - 1);
+
+    currentParagraphIndex = index;
+  }
+
+  function setVisibility(element, isVisible) {
+    if (isVisible) element.show(); else element.hide();
+  }
+
+  function autoScrollBubble(toBottom) {
+    var SCROLL_TIME = 1000;
+    var PAUSE_TIME = 2000;
+
+    setTimeout(function () {
+      $bubble.animate({scrollTop: toBottom ? $bubble.height() : 0}, {
+        duration: SCROLL_TIME,
+        complete: function () {
+          autoScrollBubble(!toBottom);
+        }
+      });
+    }, PAUSE_TIME);
+  }
+
+  autoScrollBubble();
+
   mumuki.kids = {
 
     getResultsModal: function () {
@@ -145,6 +172,9 @@ mumuki.load(function () {
       $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);
+      }
       mumuki.kids.getOverlay().show();
     },
 
@@ -213,7 +243,7 @@ mumuki.load(function () {
   };
 
   mumuki.kids.resultAction.passed = mumuki.kids._showOnSuccessPopup;
-  mumuki.kids.resultAction.passed_with_warnings = mumuki.kids._showOnSuccessPopup;
+  mumuki.kids.resultAction.passed_with_warnings = mumuki.kids._showOnCharacterBubble;
 
   mumuki.kids.resultAction.aborted = mumuki.kids._showOnFailurePopup;
 

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

@@ -104,6 +104,16 @@ $kids-speech-tabs-width: 40px;
       height: 100%;
     }
     .mu-kids-character-speech-bubble {
+
+      &.passed_with_warnings {
+        padding-top: 5px;
+        padding-bottom: 5px;
+
+        .results-list {
+          margin-top: -10px;
+        }
+      }
+
       ul {
         margin: 0;
       }
@@ -117,6 +127,16 @@ $kids-speech-tabs-width: 40px;
           cursor: pointer;
         }
       }
+      div.mu-kids-character-speech-bubble-normal {
+        width: 100%;
+        height: 100%;
+        overflow: hidden;
+      }
+      div.mu-kids-character-speech-bubble-failed {
+        width: 100%;
+        height: 100%;
+        overflow: hidden;
+      }
       ul.mu-kids-character-speech-bubble-tabs {
         display: flex;
         flex-direction: column;

data/app/assets/stylesheets/application.scss

@@ -2,7 +2,7 @@ $icon-font-path: '../assets/bootstrap/';
 $fa-font-path: '../assets';
 $da-font-path: '../assets';
 
-@import "mumuki-styles.scss";
+@import "scss/mumuki-styles";
 @import "codemirror/codemirror.min";
 @import "codemirror/show-hint.min";
 @import "application/vendor";

data/app/controllers/invitations_controller.rb

@@ -7,7 +7,7 @@ class InvitationsController < ApplicationController
   end
 
   def join
-    current_user.make_student_of! @invitation.course
+    current_user.accept_invitation! @invitation
     current_user.update! user_params
     current_user.notify!
     redirect_to_organization!
@@ -20,7 +20,7 @@ class InvitationsController < ApplicationController
   private
 
   def redirect_to_organization!
-    redirect_to Mumukit::Platform.laboratory.organic_url @organization
+    redirect_to Mumukit::Platform.laboratory.organic_url(@organization)
   end
 
   def user_params

data/app/helpers/application_helper.rb

@@ -6,10 +6,12 @@ module ApplicationHelper
   end
 
   def page_title(subject)
+    name = "Mumuki#{Organization.current.title_suffix}"
+
     if subject && !subject.new_record?
-      "#{subject.friendly} - Mumuki"
+      "#{subject.friendly} - #{name}"
     else
-      "Mumuki - #{t :mumuki_catchphrase}"
+      "#{name} - #{t :mumuki_catchphrase}"
     end
   end
 
@@ -27,6 +29,14 @@ module ApplicationHelper
     end
   end
 
+  def assistance_box(assignment)
+    if assignment.tips.present?
+      %Q{<div class="mu-tips-box">
+        #{Mumukit::Assistant::Narrator.random.compose_explanation_html assignment.tips}
+      </div>}.html_safe
+    end
+  end
+
   def chapter_finished(chapter)
     t :chapter_finished_html, chapter: link_to_path_element(chapter) if chapter
   end

data/app/mailers/user_mailer.rb

@@ -1,15 +1,24 @@
 class UserMailer < ApplicationMailer
 
   def we_miss_you_reminder(user, cycles)
+    send_reminder! user, t(:we_miss_you), "#{cycles.ordinalize}_reminder"
+  end
+
+  def no_submissions_reminder(user)
+    send_reminder! user, t(:start_using_mumuki), "no_submissions_reminder"
+  end
+
+  private
+
+  def send_reminder!(user, subject, template_name)
     @user = user
     @unsubscribe_code = User.unsubscription_verifier.generate(user.id)
     @organization = user.last_organization
 
     I18n.with_locale(@organization.locale) do
       mail to: user.email,
-           subject: t(:we_miss_you),
-           template_name: "#{cycles.ordinalize}_reminder"
+           subject: subject,
+           template_name: template_name
     end
   end
-
 end

data/app/models/assignment.rb

@@ -140,6 +140,14 @@ class Assignment < ApplicationRecord
         }})
   end
 
+  def tips
+    @tips ||= exercise.assist_with(self)
+  end
+
+  def increment_attemps!
+    self.attemps_count += 1 unless passed?
+  end
+
   private
 
   def update_submissions_count!

data/app/models/concerns/assistable.rb

@@ -0,0 +1,17 @@
+module Assistable
+  extend ActiveSupport::Concern
+
+  included do
+    serialize :assistance_rules, Array
+  end
+
+  def assistant
+    Mumukit::Assistant.parse(assistance_rules)
+  end
+
+  def assist_with(assignment)
+    # not strictly necessary, but avoid going through
+    # all the assistence process when there are no rules
+    assistance_rules.blank? ? [] : assistant.assist_with(assignment)
+  end
+end

data/app/models/concerns/with_expectations.rb

@@ -2,7 +2,7 @@ module WithExpectations
   extend ActiveSupport::Concern
 
   included do
-    serialize :expectations
+    serialize :expectations, Array
   end
 
   def expectations_yaml
@@ -16,8 +16,4 @@ module WithExpectations
   def expectations=(expectations)
     self[:expectations] = expectations.map(&:stringify_keys)
   end
-
-  def expectations
-    self[:expectations] || []
-  end
 end

data/app/models/concerns/with_reminders.rb

@@ -1,28 +1,72 @@
 module WithReminders
+  extend ActiveSupport::Concern
 
   def build_reminder
-    UserMailer.new.we_miss_you_reminder(self, cycles_since(last_submission_date))
+    mailer = UserMailer.new
+    last_submission_date.nil? ?
+      mailer.no_submissions_reminder(self) :
+      mailer.we_miss_you_reminder(self, cycles_since(last_submission_date))
   end
 
-  def send_reminder!
+  def remind!
     build_reminder.deliver
-    update! last_reminded: Time.now
+    update! last_reminded_date: Time.now
+  end
+
+  def should_remind?
+    reminder_due? && (has_no_submissions? || has_no_recent_submission?)
   end
 
+  # Try to send a reminder, by acquiring a database lock for update
+  # the aproppriate record. This object can't be updated as long as
+  # the reminder is being sent.
+  #
+  # This method is aimed to be sent across multiple servers or processed concurrently
+  # and still not send duplicate mails
+  def try_remind_with_lock!
+    # Some notes:
+    #
+    # * nowait is a postgre specific option and may not work with other databases
+    # * nowait will raise an exception if the lock can not be acquired
+    # * we are using a double check lock pattern to reduce lock acquisition
+    with_lock('for update nowait') do
+      reload
+      remind! if should_remind?
+    end if should_remind?
+  rescue
+    nil
+  end
+
+  private
+
   def cycles_since(time)
-    ((Date.current - time.to_date) / Rails.configuration.reminder_frequency).to_i
+    ((Date.current - time.to_date) / self.class.reminder_frequency).to_i
   end
 
-  def remider_due?
+  def reminder_due?
     last_reminded_date.nil? || cycles_since(last_reminded_date) >= 1
   end
 
-  def should_send_reminder?
-    remider_due? && cycles_since(last_submission_date).between?(1, 3)
+  def can_still_remind?(date)
+    cycles_since(date).between?(1, 3)
   end
 
-  def remind!
-    send_reminder! if should_send_reminder?
+  def has_no_submissions?
+    last_submission_date.nil? && can_still_remind?(created_at)
+  end
+
+  def has_no_recent_submission?
+    !last_submission_date.nil? && can_still_remind?(last_submission_date)
   end
 
+  module ClassMethods
+    def remindable
+      where('accepts_reminders and (last_submission_date < ? or last_submission_date is null)', reminder_frequency.days.ago)
+    end
+
+    # The frequency of reminders, expressed in days
+    def reminder_frequency
+      Rails.configuration.reminder_frequency
+    end
+  end
 end

data/app/models/concerns/with_slug.rb

@@ -8,7 +8,7 @@ module WithSlug
   end
 
   def import!
-    import_from_json! Mumukit::Bridge::Bibliotheca.new(Mumukit::Platform.bibliotheca_api.url).send(self.class.name.underscore, slug)
+    import_from_json! Mumukit::Platform.bibliotheca_bridge.send(self.class.name.underscore, slug)
   end
 
   def slug_parts

data/app/models/concerns/with_status.rb

@@ -11,7 +11,7 @@ module WithStatus
   end
 
   def aborted?
-    status == :aborted
+    status.aborted?
   end
 
   def run_update!

data/app/models/exercise.rb

@@ -4,7 +4,8 @@ class Exercise < ApplicationRecord
   include WithNumber,
           WithAssignments,
           FriendlyName,
-          WithLanguage
+          WithLanguage,
+          Assistable
 
   include Submittable,
           Questionable
@@ -13,7 +14,6 @@ class Exercise < ApplicationRecord
           ParentNavigation
 
   belongs_to :guide
-
   defaults { self.submissions_count = 0 }
 
   validates_presence_of :submissions_count,

data/app/models/organization.rb

@@ -84,6 +84,14 @@ class Organization < ApplicationRecord
     all.select { |it| it.public? || user.has_permission?(role, it.slug) }
   end
 
+  def title_suffix
+    central? ? '' : " - #{book.name}"
+  end
+
+  def site_name
+    central? ? 'mumuki' : name
+  end
+
   private
 
   def ensure_consistent_public_login

data/app/models/submission/submission.rb

@@ -31,7 +31,9 @@ class Submission
   end
 
   def save_results!(results, assignment)
-    assignment.update! results
+    assignment.assign_attributes results
+    assignment.increment_attemps!
+    assignment.save! results
   end
 
   def notify_results!(results, assignment)

data/app/models/user.rb

@@ -76,6 +76,10 @@ class User < ApplicationRecord
     end
   end
 
+  def accept_invitation!(invitation)
+    make_student_of! invitation.course
+  end
+
   def copy_progress_to!(another)
     transaction do
       assignments.update_all(submitter_id: another.id)

data/app/views/book/show.html.erb

@@ -1,6 +1,6 @@
 <div class="col-md-offset-2 col-md-8">
   <div class="book-header <%= current_user? ? '' : 'logged' %>">
-    <h1>ム mumuki</h1>
+    <h1>ム mumuki<%= Organization.current.title_suffix %></h1>
 
     <img src="<%= Organization.current.banner_url %>" alt="<%= Organization.current.name %> - Mumuki">
     <h2><%= @book.name %></h2>

data/app/views/exercise_solutions/_expectations.html.erb

@@ -0,0 +1,7 @@
+<% expectation = assignment.visible_expectation_results.find { |it| it[:result].failed? } %>
+
+<% if expectation %>
+    <ul class="results-list">
+      <li><%= status_icon(expectation[:result]) %> <%= t_expectation expectation %></li>
+    </ul>
+<% end %>

data/app/views/exercise_solutions/_results.html.erb

@@ -25,7 +25,6 @@
             <% if render_feedback?(assignment) %>
                 <div class="results-item">
                   <strong><%= t :feedback %>:</strong>
-
                   <div>
                     <%= assignment.feedback_html %>
                   </div>
@@ -50,6 +49,7 @@
                   <%= mail_to contact_email,
                               fa_icon(:bug, text: t(:notify_problem_with_exercise), class: 'fa-fw'),
                               subject: t(:problem_with_exercise, title: @exercise.name),
+                              body: assignment_help_email_body(assignment),
                               class: 'warning' %>
                 </li>
                 <li>
@@ -63,6 +63,9 @@
   <%= solution_download_link assignment %>
 </div>
 
-<%= corollary_box @exercise unless assignment.should_retry? %>
-
+<% if assignment.should_retry? %>
+  <%= assistance_box assignment %>
+<% else %>
+  <%= corollary_box @exercise %>
+<% end %>
 <%= render partial: 'exercise_solutions/results_button', locals: {assignment: assignment} %>

data/app/views/layouts/_kids.html.erb

@@ -1,7 +1,5 @@
 <img src="/anim_amarillo.svg" alt="">
 <div class="mu-kids-character-speech-bubble">
-  <i class="mu-kids-prev-speech fa fa-fw fa-caret-up"></i>
-  <i class="mu-kids-next-speech fa fa-fw fa-caret-down"></i>
   <% if @exercise.hint? %>
       <ul class="mu-kids-character-speech-bubble-tabs">
         <li class="active" data-target="description" title="<%= t :task %>"><i class="fa fa-fw fa-file-text-o"></i>
@@ -11,8 +9,10 @@
       </ul>
   <% end %>
   <div class="mu-kids-character-speech-bubble-normal">
+    <i class="mu-kids-prev-speech fa fa-fw fa-caret-up"></i>
+    <i class="mu-kids-next-speech fa fa-fw fa-caret-down"></i>
     <div class="description"><%= @exercise.description_task %></div>
     <div class="hint" style="display: none"><%= @exercise.hint_html %></div>
   </div>
-  <div class="mu-kids-character-speech-bubble-failed" style="display: none"></div>
+  <div class="mu-kids-character-speech-bubble-failed <%= @assignment&.status %>" style="display: none"></div>
 </div>

data/app/views/layouts/application.html.erb

@@ -9,9 +9,9 @@
   <link rel="icon" type="image/x-icon" href="<%= Organization.current.favicon_url %>" data-turbolinks-track="reload">
   <link rel="stylesheet" type="text/css" href="<%= theme_stylesheet_url %>" data-turbolinks-track="reload">
 
-  <meta property="og:site_name" content="mumuki"/>
+  <meta property="og:site_name" content="<%= Organization.current.site_name %>" />
   <meta property="og:title" content="<%= page_title subject %>"/>
-  <meta property="og:description" content="<%= t :mumuki_short_description %>"/>
+  <meta property="og:description" content="<%= Organization.current.central? ? t(:mumuki_short_description) : Organization.current.description %>"/>
   <meta property="og:type" content="website"/>
   <meta property="og:image" content="<%= Organization.current.open_graph_image_url %>"/>
   <meta property="og:url" content="<%= request.original_url %>"/>
@@ -21,12 +21,11 @@
   <meta name="description" content="<%= t :mumuki_short_description %>"/>
   <%= stylesheet_link_tag 'application', media: 'all', 'data-turbolinks-track': 'reload' %>
   <%= csrf_meta_tags %>
-  <script type="text/javascript">
-    window.mumukiLocale = <%= raw Organization.current.locale_json %>;
-  </script>
   <%= javascript_include_tag 'application', 'data-turbolinks-track': 'reload' %>
   <script type="text/javascript" src="<%= extension_javascript_url %>" defer data-turbolinks-track="reload"></script>
   <script type="text/javascript">
+    window.mumukiLocale = <%= raw Organization.current.locale_json %>;
+    mumuki.locale = '<%= Organization.current.locale %>';
     moment.locale('<%= Organization.current.locale %>');
   </script>
   <%= login_form.header_html %>