mumuki-laboratory 7.5.0

data/app/controllers/guide_container_controller.rb

@@ -0,0 +1,21 @@
+class GuideContainerController < ApplicationController
+  include Mumuki::Laboratory::Controllers::Content
+
+  before_action :set_guide
+
+  def show
+    if current_user?
+      @stats = subject.stats_for(current_user)
+      @next_exercise = subject.next_exercise(current_user)
+    else
+      @next_exercise = subject.first_exercise
+    end
+  end
+
+  private
+
+  def set_guide
+    raise Mumuki::Domain::NotFoundError if subject.nil?
+    @guide = subject.guide
+  end
+end

data/app/controllers/guide_progress_controller.rb

@@ -0,0 +1,18 @@
+class GuideProgressController < ApplicationController
+  before_action :check_resettable!, only: :destroy
+
+  def destroy
+    guide.clear_progress! current_user
+    redirect_back fallback_location: url_for(guide)
+  end
+
+  private
+
+  def check_resettable!
+    raise Mumuki::Domain::ForbiddenError unless guide.resettable?
+  end
+
+  def guide
+    @guide ||= Guide.find(params[:guide_id])
+  end
+end

data/app/controllers/guides_controller.rb

@@ -0,0 +1,9 @@
+class GuidesController < ApplicationController
+  def show
+    redirect_to_usage Guide.find_by!(id: params[:id])
+  end
+
+  def show_transparently
+    redirect_to_usage Guide.find_transparently!(params)
+  end
+end

data/app/controllers/invitations_controller.rb

@@ -0,0 +1,40 @@
+class InvitationsController < ApplicationController
+  include WithUserParams
+
+  before_action :authenticate!
+  before_action :set_invitation!
+  before_action :set_user!
+
+  skip_before_action :validate_user_profile!
+  skip_before_action :authorize_if_private!
+
+  def show
+    redirect_to_organization! if current_user.student_of? @invitation.course
+  end
+
+  def join
+    current_user.accept_invitation! @invitation
+    current_user.update! user_params
+    current_user.notify!
+    redirect_to_organization!
+  end
+
+  private
+
+  def redirect_to_organization!
+    redirect_to Mumukit::Platform.laboratory.organic_url(@organization)
+  end
+
+  def permissible_params
+    super + [:email, :name]
+  end
+
+  def set_invitation!
+    @invitation = Invitation.locate!(params[:code]).unexpired
+    @organization = @invitation.organization
+  end
+
+  def set_user!
+    @user = current_user
+  end
+end

data/app/controllers/lessons_controller.rb

@@ -0,0 +1,8 @@
+class LessonsController < GuideContainerController
+
+  private
+
+  def subject
+    @lesson ||= Lesson.find_by(id: params[:id])
+  end
+end

data/app/controllers/login_controller.rb

@@ -0,0 +1,16 @@
+class LoginController < ApplicationController
+  Mumukit::Login.configure_login_controller! self
+
+  skip_before_action :verify_authenticity_token, if: lambda { Rails.env.development? }
+  skip_before_action :validate_user_profile!
+
+  private
+
+  def organization_name
+    params[:organization] || super
+  end
+
+  def login_failure!
+    redirect_to root_path, alert: request.params['message']
+  end
+end

data/app/controllers/messages_controller.rb

@@ -0,0 +1,32 @@
+class MessagesController < AjaxController
+  before_action :set_exercise!, only: [:create, :read_messages]
+
+  def index
+    render json: {has_messages: has_messages?, messages_count: messages_count}
+  end
+
+  def read_messages
+    @exercise.messages_for(current_user).read_all!
+    index
+  end
+
+  def create
+    @exercise.submit_question! current_user, message_params
+    redirect_to @exercise
+  end
+
+  def errors
+    render 'messages/errors', layout: false
+  end
+
+  private
+
+  def set_exercise!
+    exercise_id = params.dig(:message, :exercise_id) || params[:exercise_id]
+    @exercise = Exercise.find(exercise_id)
+  end
+
+  def message_params
+    params.require(:message).permit(:content)
+  end
+end

data/app/controllers/topics_controller.rb

@@ -0,0 +1,5 @@
+class TopicsController < ApplicationController
+  def show_transparently
+    redirect_to_usage Topic.find_transparently!(params)
+  end
+end

data/app/controllers/users_controller.rb

@@ -0,0 +1,32 @@
+class UsersController < ApplicationController
+  include WithUserParams
+
+  before_action :authenticate!
+  before_action :set_user!
+
+  def show
+    @messages = current_user.messages.to_a
+    @watched_discussions = current_user.watched_discussions_in_organization
+  end
+
+  def update
+    current_user.update_and_notify! user_params
+    redirect_to root_path, notice: I18n.t(:user_data_updated)
+  end
+
+  def unsubscribe
+    user_id = User.unsubscription_verifier.verify(params[:id])
+    User.find(user_id).unsubscribe_from_reminders!
+
+    redirect_to root_path, notice: t(:unsubscribed_successfully)
+  end
+
+  private
+
+  def validate_user_profile!
+  end
+
+  def set_user!
+    @user = current_user
+  end
+end

data/app/helpers/application_helper.rb

@@ -0,0 +1,41 @@
+module ApplicationHelper
+  include WithStudentPathNavigation
+
+  # html-escapes an string even if it is html-safe
+  def html_rescape(html)
+    html_escape html.to_str
+  end
+
+  def profile_picture
+    image_tag(current_user.profile_picture, height: 40, class: 'img-circle', onError: "this.onerror = null; this.src = '#{image_url('user_shape.png')}'")
+  end
+
+  def paginate(object, options={})
+    "<div class=\"text-center\">#{super(object, {theme: 'twitter-bootstrap-3'}.merge(options))}</div>".html_safe
+  end
+
+  def last_box_class(trailing_boxes)
+    trailing_boxes ? '' : 'mu-last-box'
+  end
+
+  def corollary_box(with_corollary, trailing_boxes = false)
+    if with_corollary.corollary.present?
+      %Q{
+        <div class="#{last_box_class trailing_boxes}">
+          <p>#{with_corollary.corollary_html}</p>
+        </div>
+      }.html_safe
+    end
+  end
+
+  def chapter_finished(chapter)
+    t :chapter_finished_html, chapter: link_to_path_element(chapter) if chapter
+  end
+
+  def span_toggle(hidden_text, active_text, active)
+    %Q{
+      <span class="#{'hidden' if active}">#{hidden_text}</span>
+      <span class="#{'hidden' unless active}">#{active_text}</span>
+    }.html_safe
+  end
+end

data/app/helpers/assets_helper.rb

@@ -0,0 +1,24 @@
+module AssetsHelper
+  def assets_include_tags
+    %Q{
+      <meta name="turbolinks-cache-control" content="no-cache">
+      #{laboratory_assets_include_tags}
+      #{organization_assets_include_tags}
+    }.html_safe
+  end
+
+  def laboratory_assets_include_tags
+    %Q{
+      #{stylesheet_link_tag 'mumuki_laboratory/application', media: 'all', 'data-turbolinks-track': 'reload'}
+      #{javascript_include_tag 'mumuki_laboratory/application.js', 'data-turbolinks-track': 'reload'}
+    }
+  end
+
+  def organization_assets_include_tags
+    %Q{
+      <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">
+      <script type="text/javascript" src="#{extension_javascript_url}" defer data-turbolinks-track="reload"></script>
+    }
+  end
+end

data/app/helpers/assignment_result_helper.rb

@@ -0,0 +1,47 @@
+module AssignmentResultHelper
+  def solution_download_link(assignment)
+    link_to fa_icon(:download, text: t(:download)),
+            solution_octet_data(assignment),
+            download: solution_filename(assignment) if assignment.exercise.upload?
+  end
+
+  def community_link
+    Organization.current.community_link
+  end
+
+  def community_link?
+    community_link.present?
+  end
+
+  def render_community_link
+    if community_link?
+      link_to fa_icon(:facebook, text: I18n.t(:ask_community), class: 'fa-fw'), community_link, target: '_blank'
+    end
+  end
+
+  def report_bug_link(assignment, organization=Organization.current)
+    if organization.report_issue_enabled?
+      mail_to organization.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'
+    end
+  end
+
+  def manual_evaluation_comment(assignment)
+    if assignment.manual_evaluation_comment?
+      Mumukit::ContentType::Markdown.to_html assignment.manual_evaluation_comment
+    end
+  end
+
+  private
+
+  def solution_octet_data(assignment)
+    "data:application/octet-stream,#{URI.encode assignment.solution}"
+  end
+
+  def solution_filename(assignment)
+    "solution.#{assignment.extension}"
+  end
+end

data/app/helpers/assistance_box_helper.rb

@@ -0,0 +1,9 @@
+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
+  end
+end

data/app/helpers/authors_helper.rb

@@ -0,0 +1,10 @@
+module AuthorsHelper
+
+  def attribution_caption(guide)
+    if guide.collaborators.present?
+      t(:authoring_note_with_collaborators_html, authors: guide.authors, collaborators: "https://raw.githubusercontent.com/#{guide.slug}/master/COLLABORATORS.txt")
+    else
+      t(:authoring_note_html, authors: guide.authors)
+    end
+  end
+end

data/app/helpers/breadcrumbs_helper.rb

@@ -0,0 +1,59 @@
+module BreadcrumbsHelper
+  include DiscussionsHelper
+
+  def breadcrumbs(e, extra=nil)
+    breadcrumbs0(e.navigable_name, e, extra, 'last')
+  end
+
+  def header_breadcrumbs(link_for_organization: true)
+    "#{home_breadcrumb} #{organization_breadcrumb(has_link: link_for_organization)}".html_safe
+  end
+
+  def home_breadcrumb
+    home = "<i class='da da-mumuki' aria-label=#{t(:home)}></i>".html_safe
+    breadcrumb_item_for_linkable home, mu_home_path, 'brand'
+  end
+
+  def mu_home_path
+    root_path
+  end
+
+  def breadcrumb_item_class(clazz)
+    "class='mu-breadcrumb-list-item #{clazz}'"
+  end
+
+  def breadcrumb_list_item(item, clazz='')
+    "<li #{breadcrumb_item_class(clazz)}>#{h item}</li>".html_safe
+  end
+
+  def breadcrumb_item_for_linkable(e, link_path, clazz='')
+    breadcrumb_list_item link_to(e, link_path), clazz
+  end
+
+  def breadcrumbs_for_discussion(discussion, e)
+    discussions_breadcrumb = breadcrumbs_for_linkable(e, link_to(t(:discussions), item_discussions_path(e)))
+    discussion_item = breadcrumb_list_item(breadcrumb_name_for(discussion), 'last')
+
+    discussions_breadcrumb + discussion_item
+  end
+
+  def breadcrumb_name_for(discussion)
+    discussion.friendly.truncate_words(4)
+  end
+
+  private
+
+  def breadcrumbs_for_linkable(e, extra=nil, last='')
+    breadcrumbs0(link_to_path_element(e), e, extra, last)
+  end
+
+  def breadcrumbs0(base, e, extra, last)
+    return "#{breadcrumbs_for_linkable(e)} #{breadcrumb_list_item(extra, last)}".html_safe if extra
+
+    if e.navigation_end?
+      "#{header_breadcrumbs} #{breadcrumb_list_item(base, last)}".html_safe
+    else
+      "#{breadcrumbs_for_linkable(e.navigable_parent)} #{breadcrumb_list_item(base, last)}".html_safe
+    end
+  end
+end

data/app/helpers/choices_helper.rb

@@ -0,0 +1,5 @@
+module ChoicesHelper
+  def checked?(choice, content)
+    content.split(':').include? choice.index.to_s
+  end
+end

data/app/helpers/concerns/with_student_path_navigation.rb

@@ -0,0 +1,19 @@
+module WithStudentPathNavigation
+  def next_button(navigable)
+    return unless navigable
+    ContinueNavigation.new(self).button(navigable) || RevisitNavigation.new(self).button(navigable) || FinishNavigation.new(self).button(navigable)
+    #TODO Refactor this
+  end
+
+  def next_lesson_button(guide)
+    next_button(guide.lesson) || chapter_finished(guide.chapter)
+  end
+
+  def next_exercise_button(exercise)
+    next_button(exercise) || next_button(exercise.guide.lesson)
+  end
+
+  def close_modal_button
+    %Q{<button class="btn btn-success btn-block mu-close-modal">#{t :keep_learning}</button>}.html_safe
+  end
+end

data/app/helpers/concerns/with_student_path_navigation/continue_navigation.rb

@@ -0,0 +1,23 @@
+module WithStudentPathNavigation
+  class ContinueNavigation < Navigation
+    def right
+      true
+    end
+
+    def icon
+      'chevron-right'
+    end
+
+    def key
+      :navigation_continue
+    end
+
+    def clazz
+      'btn btn-success btn-block'
+    end
+
+    def sibling_for(navigable)
+      navigable.next_for(current_user)
+    end
+  end
+end