mumuki-laboratory 8.0.0 → 8.2.0

data/app/controllers/assets_controller.rb

@@ -3,6 +3,7 @@ class AssetsController < ApplicationController
   protect_from_forgery except: [:theme_stylesheet, :extension_javascript]
   skip_before_action :authorize_if_private!
   skip_before_action :validate_user_profile!
+  skip_before_action :validate_accepted_role_terms!
   skip_before_action :validate_active_organization!
 
   def theme_stylesheet

data/app/controllers/book_discussions_controller.rb

@@ -2,7 +2,7 @@ class BookDiscussionsController < DiscussionsController
   def terms
     @forum_terms ||= Term.forum_related_terms
   end
-  
+
   private
 
   def set_debatable

data/app/controllers/chapters_controller.rb

@@ -2,6 +2,7 @@ require 'addressable/uri'
 
 class ChaptersController < ApplicationController
   include Mumuki::Laboratory::Controllers::Content
+  include Mumuki::Laboratory::Controllers::ImmersiveNavigation
 
   def show
   end

data/app/controllers/concerns/with_user_discussion_validation.rb

@@ -2,12 +2,18 @@ module WithUserDiscussionValidation
   extend ActiveSupport::Concern
 
   included do
+    # users are not allowed to access discussions during exams
+    before_action :validate_not_blocked_in_forum!
     # discussions are not enabled for all organizations nor all users
     before_action :validate_user_can_discuss!
   end
 
   private
 
+  def validate_not_blocked_in_forum!
+    raise Mumuki::Domain::BlockedForumError if current_user&.currently_in_exam?
+  end
+
   def validate_user_can_discuss!
     raise Mumuki::Domain::NotFoundError unless current_user&.can_discuss_here?
   end

data/app/controllers/discussions_controller.rb

@@ -1,8 +1,6 @@
 class DiscussionsController < ApplicationController
   include Mumuki::Laboratory::Controllers::Content
   include WithUserDiscussionValidation
-  # users are not allowed to access discussions during exams
-  before_action :validate_not_in_exam!
 
   before_action :set_debatable, except: [:subscription]
   before_action :authenticate!, only: [:update, :create]
@@ -46,6 +44,10 @@ class DiscussionsController < ApplicationController
 
   private
 
+  def default_immersive_path_for(context)
+    context.forum_enabled? ? discussions_path : root_path
+  end
+
   def current_content_discussions
     @debatable.discussions_in_organization
   end
@@ -70,8 +72,4 @@ class DiscussionsController < ApplicationController
   def discussion_filter_params
     @filter_params ||= params.permit(Discussion.permitted_query_params)
   end
-
-  def validate_not_in_exam!
-    raise Mumuki::Domain::BlockedForumError if current_user&.currently_in_exam?
-  end
 end

data/app/controllers/exercises_controller.rb

@@ -1,6 +1,7 @@
 class ExercisesController < ApplicationController
   include Mumuki::Laboratory::Controllers::Content
   include Mumuki::Laboratory::Controllers::ExerciseSeed
+  include Mumuki::Laboratory::Controllers::ImmersiveNavigation
 
   before_action :set_guide!, only: :show
   before_action :set_assignment!, only: :show, if: :current_user?

data/app/controllers/guides_controller.rb

@@ -1,4 +1,6 @@
 class GuidesController < ApplicationController
+  include Mumuki::Laboratory::Controllers::ImmersiveNavigation
+
   def show
     redirect_to_usage Guide.find_by!(id: params[:id])
   end

data/app/controllers/invitations_controller.rb

@@ -6,6 +6,7 @@ class InvitationsController < ApplicationController
   before_action :set_user!
 
   skip_before_action :validate_user_profile!
+  skip_before_action :validate_accepted_role_terms!
   skip_before_action :authorize_if_private!
   skip_before_action :validate_active_organization!
 

data/app/controllers/lessons_controller.rb

@@ -1,4 +1,5 @@
 class LessonsController < GuideContainerController
+  include Mumuki::Laboratory::Controllers::ImmersiveNavigation
 
   private
 

data/app/controllers/login_controller.rb

@@ -3,6 +3,7 @@ class LoginController < ApplicationController
 
   skip_before_action :verify_authenticity_token, if: lambda { Rails.env.development? }
   skip_before_action :validate_user_profile!
+  skip_before_action :validate_accepted_role_terms!
   skip_before_action :validate_active_organization!
 
   private

data/app/controllers/users_controller.rb

@@ -3,6 +3,7 @@ class UsersController < ApplicationController
 
   before_action :authenticate!, except: :terms
   before_action :set_user!
+  skip_before_action :validate_accepted_role_terms!
 
   def show
     @messages = current_user.messages.to_a
@@ -12,7 +13,14 @@ class UsersController < ApplicationController
   def update
     current_user.update_and_notify! user_params
     current_user.accept_profile_terms!
-    redirect_to user_path, notice: I18n.t(:user_data_updated)
+    flash.notice = I18n.t(:user_data_updated)
+    redirect_after! :profile_completion, fallback_location: user_path
+  end
+
+  def accept_profile_terms
+    current_user.accept_profile_terms!
+    flash.notice = I18n.t(:terms_accepted)
+    redirect_after! :terms_acceptance, fallback_location: root_path
   end
 
   def terms

data/app/helpers/assignment_result_helper.rb

@@ -15,7 +15,7 @@ module AssignmentResultHelper
 
   def render_community_link
     if community_link?
-      link_to fa_icon(:facebook, text: I18n.t(:ask_community), class: 'fa-fw'), community_link, target: '_blank'
+      link_to fa_icon('facebook-f', type: :brand, text: I18n.t(:ask_community), class: 'fa-fw'), community_link, target: '_blank'
     end
   end
 

data/app/helpers/assistance_box_helper.rb

@@ -1,9 +1,11 @@
 module AssistanceBoxHelper
   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
+    %Q{<div class="mu-tips-box">
+      #{Mumukit::Assistant::Narrator.random.compose_explanation_html assignment.tips}
+    </div>}.html_safe
+  end
+
+  def should_display_assistance_box?(assignment)
+    assignment.tips.present? && !assignment.solved?
   end
 end

data/app/helpers/discussions_helper.rb

@@ -67,8 +67,8 @@ module DiscussionsHelper
   def discussion_messages_icon(discussion)
     %Q{
       <span class="discussion-icon fa-stack fa-xs">
-        <i class="fa fa-comment-o fa-stack-2x"></i>
-        <i class="fa fa-stack-1x">#{discussion.validated_messages_count}</i>
+        <i class="far fa-comment fa-stack-2x"></i>
+        <i class="fas fa-stack-1x">#{discussion.validated_messages_count}</i>
       </span>
     }.html_safe
   end
@@ -77,8 +77,8 @@ module DiscussionsHelper
     if discussion.upvotes_count > 0
       %Q{
         <span class="discussion-icon fa-stack fa-xs">
-          <i class="fa fa-star-o fa-stack-2x"></i>
-          <i class="fa fa-stack-1x">#{discussion.upvotes_count}</i>
+          <i class="far fa-star fa-stack-2x"></i>
+          <i class="fas fa-stack-1x">#{discussion.upvotes_count}</i>
         </span>
       }.html_safe
     end

data/app/helpers/editor_tabs_helper.rb

@@ -14,7 +14,7 @@ module EditorTabsHelper
   def messages_tab(exercise, organization = Organization.current)
     "<li id='messages-tab' role='presentation'>
         <a data-target='#messages' tabindex='0' aria-controls='console' role='tab' data-toggle='tab' class='editor-tab'>
-          #{fa_icon 'comments-o'} #{t :messages }
+          #{fa_icon 'comments', type: :regular} #{t :messages }
         </a>
      </li>".html_safe if organization.raise_hand_enabled? && exercise.has_messages_for?(current_user)
   end

data/app/helpers/gamification_helper.rb

@@ -0,0 +1,5 @@
+module GamificationHelper
+  def in_gamified_context?
+    Organization.current.gamification_enabled?
+  end
+end

data/app/helpers/icons_helper.rb

@@ -58,6 +58,6 @@ module IconsHelper
   end
 
   def icon_for_read(read)
-    tag('i', class: "fa fa-envelope#{read ? '-o' : ''}")
+    tag('i', class: "fa#{read ? 'r' : 's'} fa-envelope")
   end
 end

data/app/helpers/links_helper.rb

@@ -52,11 +52,11 @@ module LinksHelper
   end
 
   def link_to_profile_terms
-    link_to t(:terms_and_conditions).downcase, user_terms_path, target: '_blank'
+    link_to t(:terms_and_conditions), terms_user_path, target: '_blank'
   end
 
   def link_to_forum_terms
-    link_to t(:forum_terms).downcase, discussions_terms_path, target: '_blank'
+    link_to t(:forum_terms), discussions_terms_path, target: '_blank'
   end
 
   def turbolinks_enable_for(exercise)
@@ -80,7 +80,7 @@ module LinksHelper
     return unless current_user&.writer?
 
     url = yield
-    link_to fixed_fa_icon(:pencil), url, class: "mu-content-toolbar-item", target: "_blank", title: t(:edit)
+    link_to fixed_fa_icon('pencil-alt'), url, class: "mu-content-toolbar-item", target: "_blank", title: t(:edit)
   end
 
   def url_for_bibliotheca_guide(guide)

data/app/helpers/menu_bar_helper.rb

@@ -18,7 +18,7 @@ module MenuBarHelper
   end
 
   def link_to_profile
-    li_tag menu_item('user-o', :profile, user_path)
+    menu_item('user', :profile, user_path)
   end
 
   def link_to_classroom
@@ -35,6 +35,10 @@ module MenuBarHelper
     menu_item icon, app_name, url
   end
 
+  def logout_link
+    li_tag menu_item('sign-out-alt', :sign_out, logout_path(origin: url_for))
+  end
+
   def menu_item(icon, name, url)
     link_to fixed_fa_icon(icon, text: t(name)), url, role: 'menuitem', tabindex: '-1'
   end

data/app/helpers/overlapped_buttons_helper.rb

@@ -1,4 +1,8 @@
 module OverlappedButtonsHelper
+  def expand_icon
+    overlapped_button_icon :fullscreen, :expand, " (F11)"
+  end
+
   def restart_icon
     overlapped_button_icon :restart, :undo
   end
@@ -11,7 +15,7 @@ module OverlappedButtonsHelper
     link_to restart_icon, guide_progress_path(guide), class: 'mu-content-toolbar-item mu-restart-guide', data: {confirm: t(:confirm_restart)}, method: :delete
   end
 
-  def overlapped_button_icon(key, icon)
-    fa_icon(icon, title: t(key), class: 'fa-fw', role: 'button', 'aria-label': t(key))
+  def overlapped_button_icon(key, icon, extra_title='')
+    fa_icon(icon, title: t(key) + extra_title, class: 'fa-fw', role: 'button', 'aria-label': t(key), 'data-placement': 'left')
   end
 end

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

@@ -26,7 +26,7 @@
 
       <% unless enabled  %>
         <div class="text-center mu-lock">
-          <i class="fa fa-lock fa-5x"></i>
+          <i class="fas fa-lock fa-5x"></i>
           <p><%= t :locked_content %></p>
         </div>
       <% end %>
@@ -36,7 +36,7 @@
     <h2><%= t(:exams) %></h2>
     <% @exams.each_with_index do |it, index| %>
       <div class="chapter">
-        <h3> <%= t(:exam_number, number: index) %> <%= link_to_path_element it, mode: :plain %></h3>
+        <h3> <%= index + 1 %>. <%= link_to_path_element it, mode: :plain %></h3>
 
         <div class="text-box">
           <%= it.guide.description_teaser_html %>

data/app/views/discussions/_message.html.erb

@@ -17,11 +17,11 @@
               </a>
               <% if message.from_initiator? %>
                 <a class="discussion-message-not-actually-a-question <%= 'selected' if message.not_actually_a_question? %>" onclick="mumuki.Forum.discussionMessageToggleNotActuallyAQuestion('<%= question_discussion_message_url(@discussion, message) %>', $(this))">
-                  <%= fa_icon('question-circle-o', class: 'fa-xs') %>
+                  <%= fa_icon('question-circle', type: 'regular', class: 'fa-xs') %>
                 </a>
               <% end %>
             <% end %>
-            <%= link_to fa_icon('trash-o'), discussion_message_path(@discussion, message), method: :delete, data: { confirm: t(:are_you_sure, action: t(:destroy_message)) } %>
+            <%= link_to fa_icon('trash-alt', type: :regular), discussion_message_path(@discussion, message), method: :delete, data: { confirm: t(:are_you_sure, action: t(:destroy_message)) } %>
           <% end %>
           <% if should_show_approved_for?(current_user, message) %>
             <span class="discussion-message-approved selected">

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

@@ -0,0 +1,13 @@
+<% if should_display_assistance_box? assignment %>
+  <hr>
+  <%= assistance_box assignment %>
+  <a data-toggle="collapse" href="#assistance-details-section" class="example-see-more">
+    <%= t :view_details %>
+  </a>
+  <div id="assistance-details-section" class="<%= 'collapse' if should_display_assistance_box?(assignment) %> in results-item">
+    <hr>
+    <%= yield %>
+  </div>
+<% else %>
+  <%= yield %>
+<% end %>

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

@@ -1,4 +1,13 @@
 <div class="<%= "bs-callout bs-callout-#{icon_class_for contextualization.submission_status}" %>">
   <%= render partial: 'exercise_solutions/results_title', locals: {contextualization: contextualization} %>
+
+  <% if in_gamified_context? %>
+    <div id="mu-exp-earned-message" class="hidden">
+      <span><%= t(:you_earned) %></span>
+      <strong><span id="mu-exp-points"></span></strong>
+      <span><%= t(:exp_points) %></span>
+    </div>
+  <% end %>
+
   <%= yield %>
 </div>

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

@@ -0,0 +1,11 @@
+<div>
+  <h3 class="text-center">
+    <%= t :level_up %>
+  </h3>
+  <div class="text-center mu-level">
+    <i class="fas fa-star fa-fw fa-4x"></i>
+    <span class="mu-level-number"></span>
+    <p></p>
+    <p id="mu-solve-more-exercises"> <%= (t :solve_more_exercises_to_level_up).html_safe %></p>
+  </div>
+</div>

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

@@ -11,24 +11,26 @@
   <%= render layout: 'exercise_solutions/contextualization_results_container', locals: {contextualization: assignment} do %>
     <%= manual_evaluation_comment assignment %>
     <% unless assignment.manual_evaluation_comment? %>
-      <%= render partial: 'exercise_solutions/contextualization_results_body', locals: {contextualization: assignment} %>
-      <% if should_render_need_help_dropdown?(assignment) %>
-        <div class="notify-problem-box">
-          <div class="dropdown">
-            <%= link_to fa_icon(:'question-circle', text: t(:need_help)), "", {'data-toggle': 'dropdown'} %>
-            <ul class="dropdown-menu" aria-labelledby="helpDropdown">
-              <li>
-                <%= read_discussions_link(@exercise) %>
-              </li>
-              <li>
-                <%= render_community_link %>
-              </li>
-              <li>
-                <%= report_bug_link(assignment) %>
-              </li>
-            </ul>
+      <%= render layout: 'exercise_solutions/assistant_rules_box', locals: {assignment: assignment } do %>
+        <%= render partial: 'exercise_solutions/contextualization_results_body', locals: {contextualization: assignment} %>
+        <% if should_render_need_help_dropdown?(assignment) %>
+          <div class="notify-problem-box">
+            <div class="dropdown">
+              <%= link_to fa_icon(:'question-circle', text: t(:need_help)), "", {'data-toggle': 'dropdown'} %>
+              <ul class="dropdown-menu" aria-labelledby="helpDropdown">
+                <li>
+                  <%= read_discussions_link(@exercise) %>
+                </li>
+                <li>
+                  <%= render_community_link %>
+                </li>
+                <li>
+                  <%= report_bug_link(assignment) %>
+                </li>
+              </ul>
+            </div>
           </div>
-        </div>
+        <% end %>
       <% end %>
     <% end %>
     <%= solution_download_link assignment %>
@@ -36,8 +38,6 @@
 
   <% if assignment.passed? %>
     <%= corollary_box @exercise %>
-  <% else %>
-    <%= assistance_box assignment %>
   <% end %>
 <% end %>
 

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

@@ -1,3 +1,8 @@
 <h4 class="text-<%= icon_class_for(contextualization.submission_status) %>">
   <strong><%= fa_icon icon_type_for(contextualization.submission_status) %> <%= t_contextualization_status contextualization %></strong>
+  <% if in_gamified_context? %>
+    <strong><small class="text-success">
+      <span class="mu-experience"></span>
+    </small></strong>
+  <% end %>
 </h4>

data/app/views/exercises/_exercise_assignment.html.erb

@@ -6,7 +6,7 @@
     <div class="hint-box <%= 'hidden' if exercise.hint.blank? %>">
       <% if exercise.hint.present? %>
         <a data-toggle="collapse" href="#hint-section" class="text-info">
-          <%= fa_icon 'lightbulb-o' %> <%= t :need_a_hint %>
+          <%= fa_icon 'lightbulb', type: :regular %> <%= t :need_a_hint %>
         </a>
 
         <div id="hint-section" class="collapse">

data/app/views/exercises/_read_only.html.erb

@@ -36,7 +36,7 @@
           <% end %>
           <% if @discussion.solved? %>
             <a class="discussion-upvote" onclick="mumuki.Forum.discussionUpvote('<%= upvote_discussion_url(@discussion) %>')">
-              <%= fa_icon('thumbs-o-up', class: 'fa-xs') %>
+              <%= fa_icon('thumbs-up', type: :regular, class: 'fa-xs') %>
               <%= span_toggle t(:upvote), t(:undo_upvote), current_user.upvoted?(@discussion), class: 'hidden-sm hidden-xs' %>
             </a>
           <% end %>

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

@@ -48,11 +48,10 @@
 <%= hidden_field_tag "mu-exercise-id", @exercise.id %>
 <%= hidden_field_tag "mu-exercise-layout", @exercise.layout %>
 <%= hidden_field_tag "mu-exercise-settings", @exercise.settings.to_json %>
-<%= hidden_field_tag "mu-current-exp", UserStats.exp_for(@current_user) %>
 
 <div style="display: none" id="processing-template">
   <div class="bs-callout bs-callout-info">
-    <h4><i class="fa fa-refresh fa-spin"></i> <strong><%= t :processing_your_solution %></strong></h4>
+    <h4><i class="fas fa-sync-alt fa-spin"></i> <strong><%= t :processing_your_solution %></strong></h4>
     <%= t :refresh_or_wait %>
   </div>
 </div>
@@ -62,6 +61,10 @@
     <%= render partial: 'layouts/exercise_skipped' %>
   <% end %>
 
+  <% if in_gamified_context? %>
+    <%= render partial: 'layouts/modals/level_up' %>
+  <% end %>
+
   <%= render partial: 'layouts/modals/guide_corollary', locals: {guide: @guide} %>
   <%= render partial: 'layouts/modals/new_message', locals: {exercise: @exercise} if should_render_message_input?(@exercise) %>
 <% end if current_user? %>