mumuki-domain 7.4.1 → 7.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68dc581849f150d3c0a958f3a1df2b25b4959b3ee71a595364cf2ac7533fbd25
-  data.tar.gz: dc6a6e467c80e08d035ccc70c7ace81ffdabb41088564350220f76706738332a
+  metadata.gz: 9983a4a1b2d29d329606c4ccfe991bd979a5717a8562678316e143638857622b
+  data.tar.gz: 3115a2b010be3a7536bb835e36751595d510cfbc009093d6ac77c08e973de5e8
 SHA512:
-  metadata.gz: d852df438a75e07817d1b01769559faf0a68b7c892a4423b7ee0a97a04153439388904b544a19562597015c2f613596a8236d87205aedaf86304d9141f7992ea
-  data.tar.gz: aeb1db5771206c8de35da5e9d03395f5029ce7dcec4d5b643d65365f4d1ef01e5159ffc66038bc056300bc9f9f103549ff029bcbb7b22c08fc2b47270b7aecb8
+  metadata.gz: 46cb4964c07e81cb2568d10a96cc83ca3ab29417abc3012ea7898dfd0712e375ec4a37f7852bd827725e73a94dcc153766948c06cc91e2f1b8f3d91629fcb2d4
+  data.tar.gz: 97bc43d01513919f1a3ec4b053261c7f43590399710f3ba0c7ce026daa243547e0bda2a17508372d5ef5a33fa1b36b9c06e90f31a2fe5adb2faed791a22b2933

data/app/models/assignment.rb

@@ -168,7 +168,7 @@ class Assignment < Progress
                     language: {only: [:name]}},
                 },
                 exercise: {only: [:name, :number]},
-                submitter: {only: [:email, :image_url, :social_id, :uid], methods: [:name]}}).
+                submitter: {only: [:email, :social_id, :uid], methods: [:name, :profile_picture]}}).
       deep_merge(
         'organization' => Organization.current.name,
         'sid' => submission_id,

data/app/models/avatar.rb

@@ -0,0 +1,5 @@
+class Avatar < ApplicationRecord
+  def self.sample
+    Avatar.order('RANDOM()').first
+  end
+end

data/app/models/book.rb

@@ -62,4 +62,17 @@ class Book < Content
   def structural_parent
     nil
   end
+
+  ## progressive display
+
+  def enabled_chapters_in(workspace)
+    workspace.enabled_containers(chapters)
+  end
+
+  # experimental API - it may change in the future.
+  # This method assumes no gaps in the sequences are introduced
+  # by enabled_chapters_in
+  def chapter_visibilities_in(workspace)
+    chapters.zip(enabled_chapters_in(workspace)).map { |chapter, enabled| [chapter, !enabled.nil?] }
+  end
 end

data/app/models/concerns/{with_content.rb → container.rb}

@@ -1,4 +1,4 @@
-module WithContent
+module Container
   extend ActiveSupport::Concern
 
   included do

data/app/models/concerns/contextualization.rb

@@ -35,12 +35,34 @@ module Contextualization
     end
   end
 
+  # deprecated: this method does hidden assumptions about the UI not wanting
+  # non-empty titles to not be displayed. Also it incorrectly uses the term `visual` instead of `visible`
   def single_visual_result?
-    test_results.size == 1 && test_results.first[:title].blank? && visible_success_output?
+    warn 'use single_visible_test_result? instead'
+    single_visible_test_result? && first_test_result[:title].blank?
   end
 
+  # deprecated: this method does not validate nor depends on any `visible` condition
+  # Also, it incorrectly uses the term `visual` instead of `visible`
   def single_visual_result_html
-    output_content_type.to_html test_results.first[:result]
+    warn 'use first_test_result_html intead'
+    first_test_result_html
+  end
+
+  def single_visible_test_result?
+    test_results.size == 1 && visible_success_output?
+  end
+
+  def first_test_result
+    test_results.first
+  end
+
+  def first_test_result_html
+    test_result_html first_test_result
+  end
+
+  def test_result_html(test_result)
+    output_content_type.to_html test_result[:result]
   end
 
   def results_body_hidden?
@@ -76,6 +98,7 @@ module Contextualization
   end
 
   def humanized_expectation_results
+    warn "Don't use humanized_expectation_results. Use affable_expectation_results, which also handles markdown and sanitization"
     visible_expectation_results.map do |it|
       {
         result: it[:result],
@@ -83,4 +106,32 @@ module Contextualization
       }
     end
   end
+
+  ####################
+  ## Affable results
+  ####################
+
+  def affable_expectation_results
+    visible_expectation_results.map do |it|
+      {
+        result: it[:result],
+        explanation: Mulang::Expectation.parse(it).translate(inspection_keywords).affable
+      }
+    end
+  end
+
+  def affable_tips
+    tips.map(&:affable)
+  end
+
+  def affable_test_results
+    test_results.to_a.map do |it|
+      { summary: it.dig(:summary, :message).affable }
+        .compact
+        .merge(
+          title: it[:title].affable,
+          result: it[:result].sanitized,
+          status: it[:status])
+    end
+  end
 end

data/app/models/concerns/disabling.rb

@@ -0,0 +1,37 @@
+# The disposable module is a soft-delete helper that:
+#
+#  * adds `disable!` method that set a `disabled_at` attribute and then _buries_ the object
+#  * adds a `bury!`  hook method that allows further modification when disabling
+#  * aliases `destroy!` and `destroy` to `disable!`, but still keeps `delete` and friends
+#
+module Disabling
+  extend ActiveSupport::Concern
+
+  def disable!
+    transaction do
+      update_attribute :disabled_at, Time.current
+      bury!
+    end
+  end
+
+  def disabled?
+    disabled_at.present?
+  end
+
+  def enabled?
+    !disabled?
+  end
+
+  # override to perform additional
+  # post-disable actions
+  def bury!
+  end
+
+  def ensure_enabled!
+    raise Mumuki::Domain::DisabledError if disabled?
+  end
+
+  alias_method :destroy!,  :disable!
+  alias_method :destroy,   :disable!
+end
+

data/app/models/concerns/guide_container.rb

@@ -1,6 +1,6 @@
 module GuideContainer
   extend ActiveSupport::Concern
-  include WithContent
+  include Container
 
   included do
     associated_content :guide

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

@@ -1,6 +1,6 @@
 module Solvable
-  def submit_solution!(user, attributes={})
-    assignment, _ = find_assignment_and_submit! user, attributes[:content].to_mumuki_solution(language)
+  def submit_solution!(user, submission_attributes={})
+    assignment, _ = find_assignment_and_submit! user, solution_for(submission_attributes)
     try_solve_discussions(user) if assignment.solved?
     assignment
   end
@@ -8,6 +8,12 @@ module Solvable
   def run_tests!(params)
     language.run_tests!(params.merge(locale: locale, expectations: expectations, custom_expectations: custom_expectations))
   end
+
+  def solution_for(submission_attributes)
+    submission_attributes[:content]
+      .to_mumuki_solution(language)
+      .with_client_result(submission_attributes[:client_result])
+  end
 end
 
 class NilClass

data/app/models/concerns/topic_container.rb

@@ -1,6 +1,6 @@
 module TopicContainer
   extend ActiveSupport::Concern
-  include WithContent
+  include Container
 
   included do
     associated_content :topic

data/app/models/concerns/with_discussions.rb

@@ -7,11 +7,7 @@ module WithDiscussions
   end
 
   def discuss!(user, discussion, organization = Organization.current)
-    discussion.merge!(initiator_id: user.id, organization: organization)
-    discussion.merge!(submission: submission_for(user)) if submission_for(user).present?
-    created_discussion = discussions.create discussion
-    user.subscribe_to! created_discussion
-    created_discussion
+    new_discussion_for(user, discussion, organization).tap &:save!
   end
 
   def submission_for(_)
@@ -21,4 +17,11 @@ module WithDiscussions
   def try_solve_discussions(user)
     discussions.where(initiator: user).map(&:try_solve!)
   end
+
+  def new_discussion_for(user, discussion_h = {}, organization = Organization.current)
+    discussion_h.merge!(initiator_id: user.id, organization: organization)
+    discussion_h.merge!(submission: submission_for(user)) if submission_for(user).present?
+    discussions.new discussion_h
+  end
+
 end

data/app/models/concerns/with_editor.rb

@@ -19,7 +19,7 @@ module WithEditor
       struct id: "content_choice_#{index}",
              index: index,
              value: choice,
-             text: Mumukit::ContentType::Markdown.to_html(choice_text(choice))
+             text: choice_text(choice).markdownified
     end
   end
 

data/app/models/concerns/with_layout.rb

@@ -2,6 +2,10 @@ module WithLayout
   extend ActiveSupport::Concern
 
   included do
-    enum layout: [:input_right, :input_bottom, :input_kids]
+    enum layout: [:input_right, :input_bottom, :input_primary, :input_kindergarten]
+  end
+
+  def input_kids?
+    input_primary? || input_kindergarten?
   end
 end

data/app/models/concerns/with_progress.rb

@@ -19,6 +19,10 @@ module WithProgress
     self
   end
 
+  def completed_for?(user, organization)
+    progress_for(user, organization).completed?
+  end
+
   private
 
   def structural_children_changed?(old_structural_children)

data/app/models/concerns/with_scoped_queries.rb

@@ -16,8 +16,8 @@ module WithScopedQueries
   end
 
   class_methods do
-    def query_methods
-      queriable_attributes.keys
+    def query_methods(excluded_methods)
+      queriable_attributes.keys - excluded_methods.to_a
     end
 
     def scoped_query_module(method)
@@ -28,19 +28,19 @@ module WithScopedQueries
       queriable_attributes.values.flatten
     end
 
-    def actual_params(params, excluded_param)
-      params.reject { |it| it == excluded_param.to_s }
+    def actual_params(params, excluded_params)
+      params.except(*excluded_params)
     end
 
-    def scoped_query_by(params, excluded_param=nil)
-      query_methods.inject(all) do |scope, method|
-        valid_params = valid_params_for(method, params, excluded_param)
+    def scoped_query_by(params, **options)
+      query_methods(options[:excluded_methods]).inject(all) do |scope, method|
+        valid_params = valid_params_for(method, params, options[:excluded_params])
         scoped_query_module(method).query_by valid_params, scope, self
       end
     end
 
-    def valid_params_for(method, params, excluded_param)
-      actual_params = actual_params(params, excluded_param)
+    def valid_params_for(method, params, excluded_params)
+      actual_params = actual_params(params, excluded_params)
       actual_params.permit queriable_attributes[method]
     end
   end

data/app/models/concerns/with_scoped_queries/page.rb

@@ -1,7 +1,7 @@
 module WithScopedQueries::Page
   def self.query_by(params, current_scope, _)
     page_param = params[:page] || 1
-    current_scope.page(page_param)
+    current_scope.page(page_param).per(10)
   end
 
   def self.add_queriable_attributes_to(klass, _)

data/app/models/concerns/with_scoped_queries/sort.rb

@@ -34,13 +34,18 @@ module WithScopedQueries::Sort
   end
 
   class_methods do
+    def opposite(direction)
+      dir = direction.to_s.downcase.to_sym
+      [:asc, :desc].find { |it| it != dir }
+    end
+
     def sorting_filters
       sorting_fields.product([:asc, :desc]).map do |it|
         "#{it.first}_#{it.second}"
       end
     end
 
-    def sorting_params_allowed?(sort_param, direction_param=nil)
+    def sorting_params_allowed?(sort_param, direction_param = nil)
       sorting_fields.include?(sort_param.to_sym) && [:asc, :desc].include?(direction_param&.to_sym)
     end
   end

data/app/models/course.rb

@@ -1,6 +1,7 @@
 class Course < ApplicationRecord
   include Mumuki::Domain::Syncable
   include Mumuki::Domain::Helpers::Course
+  include Mumuki::Domain::Area
 
   validates_presence_of :slug, :shifts, :code, :days, :period, :description, :organization_id
   validates_uniqueness_of :slug
@@ -13,7 +14,7 @@ class Course < ApplicationRecord
   resource_fields :slug, :shifts, :code, :days, :period, :description
 
   def current_invitation
-    invitations.where('expiration_date > ?', Time.now).take
+    invitations.where('expiration_date > ?', Time.now).first
   end
 
   def import_from_resource_h!(resource_h)
@@ -21,10 +22,8 @@ class Course < ApplicationRecord
   end
 
   def slug=(slug)
-    s = Mumukit::Auth::Slug.parse(slug)
-
-    self[:slug] = slug
-    self[:code] = s.course
+    s = slug.to_mumukit_slug
+    self[:slug] = slug.to_s
     self[:organization_id] = Organization.locate!(s.organization).id
   end
 
@@ -41,11 +40,23 @@ class Course < ApplicationRecord
   end
 
   def generate_invitation!(expiration_date)
-    invitation = invitations.build expiration_date: expiration_date, course: self
-    invitation.save_and_notify!
+    invitations.create expiration_date: expiration_date, course: self
+    current_invitation
   end
 
   def self.sync_key_id_field
     :slug
   end
+
+  def to_organization
+    organization
+  end
+
+  def to_s
+    slug.to_s
+  end
+
+  def self.allowed_for(user, organization = Organization.current)
+    where(organization: organization).select { |course| user.teacher_of? course.slug }
+  end
 end

data/app/models/discussion.rb

@@ -4,25 +4,29 @@ class Discussion < ApplicationRecord
   belongs_to :item, polymorphic: true
   has_many :messages, -> { order(:created_at) }, dependent: :destroy
   belongs_to :initiator, class_name: 'User'
+  belongs_to :last_moderator_access_by, class_name: 'User', optional: true
   belongs_to :exercise, foreign_type: :exercise, foreign_key: 'item_id'
   belongs_to :organization
   has_many :subscriptions
   has_many :upvotes
 
   scope :by_language, -> (language) { includes(:exercise).joins(exercise: :language).where(languages: {name: language}) }
+  scope :order_by_responses_count, -> (direction) { reorder(validated_messages_count: direction, messages_count: opposite(direction)) }
+  scope :by_requires_moderator_response, -> (boolean) { where(requires_moderator_response: boolean.to_boolean) }
 
-  before_save :capitalize_title
-  validates_presence_of :title
+  after_create :subscribe_initiator!
 
   markdown_on :description
 
-  sortable :created_at, :upvotes_count, default: :created_at_desc
-  filterable :status, :language
+  sortable :responses_count, :upvotes_count, :created_at, default: :created_at_desc
+  filterable :status, :language, :requires_moderator_response
   pageable
 
   delegate :language, to: :item
   delegate :to_discussion_status, to: :status
 
+  MODERATOR_REVIEW_AVERAGE_TIME = 10.minutes
+
   scope :for_user, -> (user) do
     if user.try(:moderator_here?)
       all
@@ -37,10 +41,6 @@ class Discussion < ApplicationRecord
     end
   end
 
-  def capitalize_title
-    title.capitalize!
-  end
-
   def used_in?(organization)
     organization == self.organization
   end
@@ -66,7 +66,7 @@ class Discussion < ApplicationRecord
   end
 
   def friendly
-    title
+    initiator.name
   end
 
   def subscription_for(user)
@@ -125,14 +125,52 @@ class Discussion < ApplicationRecord
     responses_count > 0
   end
 
+  def subscribe_initiator!
+    initiator.subscribe_to! self
+  end
+
   def extra_preview_html
     # FIXME this is buggy, because the extra
     # may have changed since the submission of this discussion
     exercise.assignment_for(initiator).extra_preview_html
   end
 
+  def update_counters!
+    messages_query = messages_by_updated_at
+    validated_messages = messages_query.select &:validated?
+    requires_moderator_response = messages_query.find { |it| it.validated? || it.question? }&.from_initiator?
+    update! messages_count: messages_query.count,
+            validated_messages_count: validated_messages.count,
+            requires_moderator_response: requires_moderator_response
+  end
+
+  def update_last_moderator_access!(user)
+    unless last_moderator_access_visible_for?(user)
+      update! last_moderator_access_at: Time.now,
+              last_moderator_access_by: user
+    end
+  end
+
+  def being_accessed_by_moderator?
+    last_moderator_access_at.present? && last_moderator_access_at > Time.now - MODERATOR_REVIEW_AVERAGE_TIME
+  end
+
+  def last_moderator_access_visible_for?(user)
+    show_last_moderator_access_for?(user) && being_accessed_by_moderator?
+  end
+
+  def show_last_moderator_access_for?(user)
+    user&.moderator_here? && last_moderator_access_by != user
+  end
+
   def self.debatable_for(klazz, params)
     debatable_id = params[:"#{klazz.underscore}_id"]
     klazz.constantize.find(debatable_id)
   end
+
+  private
+
+  def messages_by_updated_at(direction = :desc)
+    messages.reorder(updated_at: direction)
+  end
 end