mumuki-laboratory 5.5.0 → 5.6.0

data/app/helpers/exercise_input_helper.rb

@@ -1,10 +1,10 @@
 module ExerciseInputHelper
   def render_exercise_input_layout(exercise)
-    render "layouts/exercise_inputs/layouts/#{exercise.layout}"
+    render "layouts/exercise_inputs/layouts/#{exercise.layout}", exercise: exercise
   end
 
   def render_exercise_input_form(exercise)
-    render "layouts/exercise_inputs/forms/#{exercise.class.name.underscore}_form"
+    render "layouts/exercise_inputs/forms/#{input_form_for(exercise)}_form", exercise: exercise
   end
 
   def render_exercise_input_editor(form, exercise)
@@ -15,14 +15,38 @@ module ExerciseInputHelper
     exercise.custom? ? 'mu-custom-editor-default-value' : 'default_content'
   end
 
+  def render_exercise_read_only_editor(exercise, content)
+    render "layouts/exercise_inputs/read_only_editors/#{exercise.editor}", exercise: exercise, content: content
+  end
+
+  def input_form_for(exercise)
+    if exercise&.input_kids?
+      'kids'
+    else
+      exercise.class.name.underscore
+    end
+  end
+
+  def should_render_exercise_tabs?(exercise, &block)
+    !exercise.hidden? && (exercise.queriable? || exercise.extra_visible? || block&.call)
+  end
+
   def should_render_problem_tabs?(exercise, user)
-    !exercise.hidden? && (exercise.queriable? || exercise.extra_visible? || exercise.has_messages_for?(user))
+    should_render_exercise_tabs?(exercise) { exercise.has_messages_for? user }
+  end
+
+  def should_render_read_only_exercise_tabs?(discussion)
+    should_render_exercise_tabs?(discussion.exercise) { discussion.has_submission? }
   end
 
   def should_render_message_input?(exercise, organization = Organization.current)
     exercise.is_a?(Problem) && !exercise.hidden? && organization.raise_hand_enabled?
   end
 
+  def should_render_need_help_dropdown?(assignment, organization = Organization.current)
+    !assignment.passed? && organization.ask_for_help_enabled?
+  end
+
   def render_submit_button(exercise)
     options = submit_button_options(exercise)
     text = t(options.t) if options.t.present?
@@ -34,9 +58,13 @@ module ExerciseInputHelper
        </#{options.tag}>}.html_safe
   end
 
-  def render_custom_editor(exercise)
+  def render_custom_editor(exercise, read_only=false)
     custom_editor_tag = "mu-#{exercise.language}-custom-editor"
-    "<#{custom_editor_tag}> </#{custom_editor_tag}>".html_safe
+    "<#{custom_editor_tag} #{custom_editor_read_only if read_only}> </#{custom_editor_tag}>".html_safe
+  end
+
+  def custom_editor_read_only
+    "read-only=true"
   end
 
   def input_kids?

data/app/helpers/icons_helper.rb

@@ -1,7 +1,7 @@
 module IconsHelper
   #FIXME refactor names
   def status_icon(status_like)
-    fa_icon *icon_for_status(status_like.to_mumuki_status)
+    fa_icon *icon_for_status(status_like.to_submission_status)
   end
 
   def fixed_fa_icon(name, options={})
@@ -19,8 +19,16 @@ module IconsHelper
 
   private
 
+  def status_fa_icon(status)
+    fa_icon(*icon_for_status(status))
+  end
+
   def exercise_status_fa_icon(exercise)
-    fa_icon(*icon_for_status(exercise.status_for(current_user)))
+    status_fa_icon(exercise.status_for(current_user))
+  end
+
+  def discussion_status_fa_icon(discussion)
+    status_fa_icon(discussion.status)
   end
 
   def icon_for_status(s)
@@ -28,8 +36,17 @@ module IconsHelper
     [iconized[:type], class: "text-#{iconized[:class]} status-icon"]
   end
 
+  def label_for_status(s)
+    iconized = s.iconize
+    %Q{
+      <span class="text-#{iconized[:class]} status-label">
+        #{fa_icon "#{iconized[:type]}"}
+        <span>#{t s}</span>
+      </span>
+    }.html_safe
+  end
+
   def icon_for_read(read)
     tag('i', class: "fa fa-envelope#{read ? '-o' : ''}")
   end
-
 end

data/app/helpers/messages_helper.rb

@@ -18,4 +18,8 @@ module MessagesHelper
   def read_messages_caption(assignment)
     assignment&.pending_messages? ? :read_messages : :exit
   end
+
+  def sender_class(message)
+    message.blank? || message.from_user?(current_user) ? 'self' : 'other'
+  end
 end

data/app/helpers/status_helper.rb

@@ -1,10 +1,10 @@
 module StatusHelper
   def class_for_status(s)
-    s.to_mumuki_status.iconize[:class].to_s
+    s.to_submission_status.iconize[:class].to_s
   end
 
   def icon_type_for_status(s)
-    s.to_mumuki_status.iconize[:type].to_s
+    s.to_submission_status.iconize[:type].to_s
   end
 
   def class_for_exercise(exercise)

data/app/models/assignment.rb

@@ -1,5 +1,5 @@
 class Assignment < ApplicationRecord
-  include WithStatus
+  include Contextualization
   include WithMessages
 
   belongs_to :exercise
@@ -10,14 +10,9 @@ class Assignment < ApplicationRecord
 
   validates_presence_of :exercise, :submitter
 
-  [:expectation_results, :test_results, :query_results].each do |field|
-    serialize field
-    define_method(field) { self[field]&.map { |it| it.symbolize_keys } }
-  end
+  delegate :language, :name, to: :exercise
 
-  delegate :language, :name, :visible_success_output?, to: :exercise
-  delegate :output_content_type, to: :language
-  delegate :should_retry?, to: :status
+  alias_attribute :status, :submission_status
 
   scope :by_exercise_ids, -> (exercise_ids) {
     where(exercise_id: exercise_ids) if exercise_ids
@@ -27,48 +22,10 @@ class Assignment < ApplicationRecord
     joins(:submitter).where('users.name' => usernames) if usernames
   }
 
-  def queries_with_results
-    queries.zip(query_results).map do |query, result|
-      {query: query, status: result&.dig(:status).defaulting(:pending), result: result&.dig(:result)}
-    end
-  end
-
   def evaluate_manually!(teacher_evaluation)
     update! status: teacher_evaluation[:status], manual_evaluation_comment: teacher_evaluation[:manual_evaluation]
   end
 
-  def single_visual_result?
-    test_results.size == 1 && test_results.first[:title].blank? && visible_success_output?
-  end
-
-  def single_visual_result_html
-    output_content_type.to_html test_results.first[:result]
-  end
-
-  def results_visible?
-    (visible_success_output? || should_retry?) && !exercise.choices?
-  end
-
-  def result_preview
-    result.truncate(100) if should_retry?
-  end
-
-  def result_html
-    output_content_type.to_html(result)
-  end
-
-  def feedback_html
-    output_content_type.to_html(feedback)
-  end
-
-  def expectation_results_visible?
-    visible_expectation_results.present?
-  end
-
-  def visible_expectation_results
-    StatusRenderingVerbosity.visible_expectation_results(status, expectation_results || [])
-  end
-
   def persist_submission!(submission)
     transaction do
       messages.destroy_all
@@ -107,6 +64,32 @@ class Assignment < ApplicationRecord
     exercise.extra_for submitter
   end
 
+  def run_update!
+    running!
+    begin
+      update! yield
+    rescue => e
+      errored! e.message
+      raise e
+    end
+  end
+
+  def passed!
+    update! submission_status: :passed
+  end
+
+  def running!
+    update! submission_status: :running,
+            result: nil,
+            test_results: nil,
+            expectation_results: [],
+            manual_evaluation_comment: nil
+  end
+
+  def errored!(message)
+    update! result: message, submission_status: :errored
+  end
+
   %w(query try tests).each do |key|
     name = "run_#{key}!"
     define_method(name) { |params| exercise.send name, params.merge(extra: extra) }
@@ -114,7 +97,7 @@ class Assignment < ApplicationRecord
 
   def as_platform_json
     navigable_parent = exercise.navigable_parent
-    as_json(except: [:exercise_id, :submission_id, :id, :submitter_id, :solution, :created_at, :updated_at],
+    as_json(except: [:exercise_id, :submission_id, :id, :submitter_id, :solution, :created_at, :updated_at, :submission_status],
               include: {
                 guide: {
                   only: [:slug, :name],
@@ -129,6 +112,7 @@ class Assignment < ApplicationRecord
         'sid' => submission_id,
         'created_at' => updated_at,
         'content' => solution,
+        'status' => submission_status,
         'exercise' => {
           'eid' => exercise.bibliotheca_id
         },

data/app/models/book.rb

@@ -5,6 +5,9 @@ class Book < Content
   has_many :chapters, -> { order(number: :asc) }, dependent: :delete_all
   has_many :complements, dependent: :delete_all
 
+  has_many :exercises, through: :chapters
+  has_many :discussions, through: :exercises
+
   delegate :first_lesson, to: :first_chapter
 
   def to_s

data/app/models/chapter.rb

@@ -9,6 +9,8 @@ class Chapter < ApplicationRecord
   belongs_to :book, optional: true
   belongs_to :topic
 
+  has_many :exercises, through: :topic
+
   include SiblingsNavigation
   include TerminalNavigation
 

data/app/models/concerns/contextualization.rb

@@ -0,0 +1,85 @@
+module Contextualization
+  extend ActiveSupport::Concern
+
+  class_methods do
+
+    private
+
+    def submission_mapping
+      class_attrs = Submission.mapping_attributes.map { |it| submission_fields_overrides[it] || it }
+      class_attrs.zip Submission.mapping_attributes
+    end
+
+    def submission_fields_overrides
+      { status: :submission_status }
+    end
+  end
+
+  included do
+    serialize :submission_status, Mumuki::Laboratory::Status::Submission
+    validates_presence_of :submission_status
+
+    [:expectation_results, :test_results, :query_results].each do |field|
+      serialize field
+      define_method(field) { self[field]&.map { |it| it.symbolize_keys } }
+    end
+
+    composed_of :submission, mapping: submission_mapping, constructor: :from_attributes
+
+    delegate :visible_success_output?, to: :exercise
+    delegate :output_content_type, to: :language
+    delegate :should_retry?, :to_submission_status, :passed?, :aborted?, to: :submission_status
+    delegate :inspection_keywords, to: :exercise
+  end
+
+  def queries_with_results
+    queries.zip(query_results).map do |query, result|
+      {query: query, status: result&.dig(:status).defaulting(:pending), result: result&.dig(:result)}
+    end
+  end
+
+  def single_visual_result?
+    test_results.size == 1 && test_results.first[:title].blank? && visible_success_output?
+  end
+
+  def single_visual_result_html
+    output_content_type.to_html test_results.first[:result]
+  end
+
+  def results_visible?
+    (visible_success_output? || should_retry?) && !exercise.choices?
+  end
+
+  def result_preview
+    result.truncate(100) if should_retry?
+  end
+
+  def result_html
+    output_content_type.to_html(result)
+  end
+
+  def feedback_html
+    output_content_type.to_html(feedback)
+  end
+
+  def failed_expectation_results
+    (expectation_results || []).select { |it| it[:result].failed? }
+  end
+
+  def expectation_results_visible?
+    failed_expectation_results.present?
+  end
+
+  def visible_expectation_results
+    exercise.input_kids? ? failed_expectation_results.first(1) : failed_expectation_results
+  end
+
+  def humanized_expectation_results
+    visible_expectation_results.map do |it|
+      {
+        result: it[:result],
+        explanation: Mumukit::Inspection::Expectation.parse(it).translate(inspection_keywords)
+      }
+    end
+  end
+end

data/app/models/concerns/submittable/solvable.rb

@@ -1,6 +1,7 @@
 module Solvable
   def submit_solution!(user, attributes={})
     assignment, _ = find_assignment_and_submit! user, attributes[:content].to_mumuki_solution(language)
+    try_solve_discussions(user) if assignment.passed?
     assignment
   end
 

data/app/models/concerns/with_assignments.rb

@@ -60,7 +60,7 @@ module WithAssignments
   end
 
   def status_for(user)
-    assignment_for(user).defaulting(Mumuki::Laboratory::Status::Unknown, &:status) if user
+    assignment_for(user).defaulting(Mumuki::Laboratory::Status::Submission::Unknown, &:status) if user
   end
 
   def last_submission_date_for(user)

data/app/models/concerns/with_discussion_creation.rb

@@ -0,0 +1,9 @@
+module WithDiscussionCreation
+  extend ActiveSupport::Concern
+
+  included do
+    has_many :discussions, foreign_key: 'initiator_id'
+    include WithDiscussionCreation::Subscription
+    include WithDiscussionCreation::Upvote
+  end
+end

data/app/models/concerns/with_discussion_creation/subscription.rb

@@ -0,0 +1,33 @@
+module WithDiscussionCreation::Subscription
+  extend ActiveSupport::Concern
+
+  included do
+    has_many :discussions, foreign_key: 'initiator_id'
+    has_many :subscriptions
+    has_many :watched_discussions, through: :subscriptions, source: :discussion
+  end
+
+  def subscribed_to?(discussion)
+    discussion.subscription_for(self).present?
+  end
+
+  def subscribe_to!(discussion)
+    watched_discussions << discussion
+  end
+
+  def unsubscribe_to!(discussion)
+    watched_discussions.delete(discussion)
+  end
+
+  def toggle_subscription!(discussion)
+    if subscribed_to?(discussion)
+      unsubscribe_to!(discussion)
+    else
+      subscribe_to!(discussion)
+    end
+  end
+
+  def unread_discussions
+    subscriptions.where(read: false).map(&:discussion)
+  end
+end

data/app/models/concerns/with_discussion_creation/upvote.rb

@@ -0,0 +1,28 @@
+module WithDiscussionCreation::Upvote
+  extend ActiveSupport::Concern
+
+  included do
+    has_many :upvotes
+    has_many :upvoted_discussions, through: :upvotes, source: :discussion
+  end
+
+  def upvoted?(discussion)
+    discussion.upvote_for(self).present?
+  end
+
+  def upvote!(discussion)
+    upvoted_discussions << discussion
+  end
+
+  def undo_upvote!(discussion)
+    upvoted_discussions.delete(discussion)
+  end
+
+  def toggle_upvote!(discussion)
+    if upvoted?(discussion)
+      undo_upvote!(discussion)
+    else
+      upvote!(discussion)
+    end
+  end
+end