mumuki-domain 7.4.1 → 7.7.0

data/app/models/exam.rb

@@ -1,19 +1,28 @@
 class Exam < ApplicationRecord
+
   include GuideContainer
   include FriendlyName
-
-  validates_presence_of :start_time, :end_time
+  include TerminalNavigation
 
   belongs_to :organization
+  belongs_to :course, optional: true
 
   has_many :authorizations, class_name: 'ExamAuthorization', dependent: :destroy
   has_many :users, through: :authorizations
 
+  enum passing_criterion_type: [:none, :percentage, :passed_exercises], _prefix: :passing_criterion
+
+  validates_presence_of :start_time, :end_time
+  validates_numericality_of :max_problem_submissions, :max_choice_submissions, greater_than_or_equal_to: 1, allow_nil: true
+
+  before_save :set_default_criterion_type!
+  before_save :ensure_valid_passing_criterion!
+
+  before_create :set_classroom_id!
+
   after_destroy { |record| Usage.destroy_usages_for record }
   after_create :reindex_usages!
 
-  include TerminalNavigation
-
   def used_in?(organization)
     organization == self.organization
   end
@@ -116,10 +125,41 @@ class Exam < ApplicationRecord
     index_usage! organization
   end
 
+  def attempts_left_for(assignment)
+    max_attempts_for(assignment.exercise) - (assignment.attempts_count || 0)
+  end
+
+  def limited_for?(exercise)
+    max_attempts_for(exercise).present?
+  end
+
+  def results_hidden_for?(exercise)
+    exercise.choice? && results_hidden_for_choices?
+  end
+
+  def resettable?
+    false
+  end
+
+  def set_classroom_id!
+    self.classroom_id ||= SecureRandom.hex(8)
+  end
+
+  def passing_criterion
+    @passing_criterion ||= Exam::PassingCriterion.parse(passing_criterion_type, passing_criterion_value)
+  end
+
+  def ensure_valid_passing_criterion!
+    passing_criterion.ensure_valid!
+  end
+
+  def set_default_criterion_type!
+    self.passing_criterion_type ||= :none
+  end
+
   def self.import_from_resource_h!(json)
     exam_data = json.with_indifferent_access
-    organization = Organization.locate! exam_data[:organization]
-    organization.switch!
+    Organization.locate!(exam_data[:organization].to_s).switch!
     adapt_json_values exam_data
     remove_previous_version exam_data[:eid], exam_data[:guide_id]
     exam = where(classroom_id: exam_data[:eid]).update_or_create!(whitelist_attributes(exam_data))
@@ -141,8 +181,13 @@ class Exam < ApplicationRecord
   def self.adapt_json_values(exam)
     exam[:guide_id] = Guide.locate!(exam[:slug]).id
     exam[:organization_id] = Organization.current.id
+    exam[:course_id] = Course.locate!(exam[:course].to_s).id
     exam[:users] = User.where(uid: exam[:uids])
-    [:start_time, :end_time].each { |param| exam[param] = exam[param].to_time }
+    exam[:start_time] = exam[:start_time].to_time
+    exam[:end_time] = exam[:end_time].to_time
+    exam[:classroom_id] = exam[:eid] if exam[:eid].present?
+    exam[:passing_criterion_type] = exam.dig(:passing_criterion, :type)
+    exam[:passing_criterion_value] = exam.dig(:passing_criterion, :value)
   end
 
   def self.remove_previous_version(eid, guide_id)
@@ -153,25 +198,10 @@ class Exam < ApplicationRecord
     end
   end
 
-  def attempts_left_for(assignment)
-    max_attempts_for(assignment.exercise) - (assignment.attempts_count || 0)
-  end
-
-  def limited_for?(exercise)
-    max_attempts_for(exercise).present?
-  end
-
-  def results_hidden_for?(exercise)
-    exercise.choice? && results_hidden_for_choices?
-  end
-
-  def resettable?
-    false
-  end
-
   private
 
   def max_attempts_for(exercise)
     exercise.choice? ? max_choice_submissions : max_problem_submissions
   end
+
 end

data/app/models/exam/passing_criterion.rb

@@ -0,0 +1,53 @@
+class Exam::PassingCriterion
+
+  attr_reader :value
+
+  def initialize(value)
+    @value = value
+  end
+
+  def type
+    self.class.name.demodulize.underscore
+  end
+
+  def as_json
+    {type: type, value: value}
+  end
+
+  def ensure_valid!
+    raise "Invalid criterion value #{value} for #{type}" unless valid_passing_grade?
+  end
+
+  def self.parse(type, value)
+    parse_criterion_type(type, value)
+  end
+
+  def self.parse_criterion_type(type, value)
+    "Exam::PassingCriterion::#{type.camelize}".constantize.new(value)
+  rescue
+    raise "Invalid criterion type #{type}"
+  end
+
+end
+
+class Exam::PassingCriterion::None < Exam::PassingCriterion
+  def initialize(_)
+    @value = nil
+  end
+
+  def valid_passing_grade?
+    !value
+  end
+end
+
+class Exam::PassingCriterion::Percentage < Exam::PassingCriterion
+  def valid_passing_grade?
+    value.between? 0, 100
+  end
+end
+
+class Exam::PassingCriterion::PassedExercises < Exam::PassingCriterion
+  def valid_passing_grade?
+    value >= 0
+  end
+end

data/app/models/exercise.rb

@@ -132,7 +132,7 @@ class Exercise < ApplicationRecord
       .merge(settings: self[:settings])
       .merge(RANDOMIZED_FIELDS.map { |it| [it, self[it]] }.to_h)
       .symbolize_keys
-      .tap { |it| it.markdownify!(:hint, :corollary, :description, :teacher_info) if options[:markdownified] }
+      .tap { |it| it.markdownified!(:hint, :corollary, :description, :teacher_info) if options[:markdownified] }
   end
 
   def reset!
@@ -166,7 +166,7 @@ class Exercise < ApplicationRecord
   end
 
   def description_context
-    Mumukit::ContentType::Markdown.to_html splitted_description.first
+    splitted_description.first.markdownified
   end
 
   def splitted_description
@@ -174,7 +174,7 @@ class Exercise < ApplicationRecord
   end
 
   def description_task
-    Mumukit::ContentType::Markdown.to_html splitted_description.drop(1).join("\n")
+    splitted_description.drop(1).join("\n").markdownified
   end
 
   def custom?

data/app/models/exercise/challenge.rb

@@ -20,6 +20,6 @@ class Challenge < Exercise
 
   def defaults
     super
-    self.layout = self.class.default_layout
+    self.layout ||= self.class.default_layout
   end
 end

data/app/models/exercise/problem.rb

@@ -45,6 +45,12 @@ class Problem < QueriableChallenge
     own_expectations.present? || own_custom_expectations.present?
   end
 
+  # Sets the layout. This method accepts input_kids as a synonym of input_primary
+  # for historical reasons
+  def layout=(layout)
+    self[:layout] = layout.like?(:input_kids) ? :input_primary : layout
+  end
+
   private
 
   def ensure_evaluation_criteria

data/app/models/exercise/reading.rb

@@ -11,6 +11,10 @@ class Reading < Exercise
     false
   end
 
+  def layout=(layout)
+    raise 'can not set a layout different to input_bottom on readings' unless layout.like? :input_bottom
+  end
+
   def queriable?
     false
   end

data/app/models/guide.rb

@@ -104,7 +104,7 @@ class Guide < Content
       .merge(super)
       .merge(exercises: exercises.map { |it| it.to_resource_h(options) })
       .merge(language: language.to_embedded_resource_h)
-      .tap { |it| it.markdownify!(:corollary, :description, :teacher_info) if options[:markdownified] }
+      .tap { |it| it.markdownified!(:corollary, :description, :teacher_info) if options[:markdownified] }
   end
 
   def to_markdownified_resource_h

data/app/models/invitation.rb

@@ -2,12 +2,18 @@ class Invitation < ApplicationRecord
   include Mumuki::Domain::Syncable
 
   belongs_to :course
+
+  validate :ensure_not_expired, on: :create
   validates_uniqueness_of :code
 
   defaults do
     self.code ||= self.class.generate_code
   end
 
+  def ensure_not_expired
+    errors.add(:base, :invitation_expired) if expired?
+  end
+
   def import_from_resource_h!(json)
     update! json.merge(course: Course.locate!(json[:course]))
   end
@@ -25,7 +31,7 @@ class Invitation < ApplicationRecord
   end
 
   def to_resource_h
-    { code: code, course: course_slug, expiration_date: expiration_date }
+    {code: code, course: course_slug, expiration_date: expiration_date}
   end
 
   def navigation_end?

data/app/models/message.rb

@@ -6,6 +6,10 @@ class Message < ApplicationRecord
 
   validates_presence_of :content, :sender
   validates_presence_of :submission_id, :unless => :discussion_id?
+
+  after_save :update_counters_cache!
+  after_destroy :update_counters_cache!
+
   markdown_on :content
 
   def notify!
@@ -16,6 +20,10 @@ class Message < ApplicationRecord
     sender_user == discussion&.initiator
   end
 
+  def from_moderator?
+    sender_user.moderator_here?
+  end
+
   def from_user?(user)
     sender_user == user
   end
@@ -33,9 +41,9 @@ class Message < ApplicationRecord
   end
 
   def to_resource_h
-    as_json(except: [:id, :type, :discussion_id, :approved],
+    as_json(except: [:id, :type, :discussion_id, :approved, :not_actually_a_question],
             include: {exercise: {only: [:bibliotheca_id]}})
-      .merge(organization: Organization.current.name)
+        .merge(organization: Organization.current.name)
   end
 
   def read!
@@ -46,11 +54,27 @@ class Message < ApplicationRecord
     toggle! :approved
   end
 
+  def toggle_not_actually_a_question!
+    toggle! :not_actually_a_question
+  end
+
+  def validated?
+    approved? || from_moderator?
+  end
+
+  def update_counters_cache!
+    discussion&.update_counters!
+  end
+
+  def question?
+    from_initiator? && !not_actually_a_question?
+  end
+
   def self.parse_json(json)
     message = json.delete 'message'
     json
-      .except('uid', 'exercise_id')
-      .merge(message)
+        .except('uid', 'exercise_id')
+        .merge(message)
   end
 
   def self.read_all!

data/app/models/organization.rb

@@ -1,6 +1,7 @@
 class Organization < ApplicationRecord
   include Mumuki::Domain::Syncable
   include Mumuki::Domain::Helpers::Organization
+  include Mumuki::Domain::Area
 
   include Mumukit::Login::OrganizationHelpers
 
@@ -11,6 +12,7 @@ class Organization < ApplicationRecord
   markdown_on :description
 
   validate :ensure_consistent_public_login
+  validate :ensure_valid_activity_range
 
   belongs_to :book
   has_many :usages
@@ -126,12 +128,26 @@ class Organization < ApplicationRecord
     super.merge(book: book.slug)
   end
 
+  def to_organization
+    self
+  end
+
+  def enable_progressive_display!(lookahead: 1)
+    update! progressive_display_lookahead: lookahead
+  end
+
   private
 
   def ensure_consistent_public_login
     errors.add(:base, :consistent_public_login) if settings.customized_login_methods? && public?
   end
 
+  def ensure_valid_activity_range
+    if in_preparation_until.present? && disabled_from.present?
+      errors.add(:base, :invalid_activity_range) if in_preparation_until.to_datetime >= disabled_from.to_datetime
+    end
+  end
+
   def notify_assignments!(assignments)
     assignments.each { |assignment| assignment.notify! }
   end

data/app/models/user.rb

@@ -4,6 +4,7 @@ class User < ApplicationRecord
           WithUserNavigation,
           WithReminders,
           WithDiscussionCreation,
+          Disabling,
           Mumuki::Domain::Helpers::User
 
   serialize :permissions, Mumukit::Auth::Permissions
@@ -31,12 +32,14 @@ class User < ApplicationRecord
 
   after_initialize :init
 
-  enum gender: %i(female male other)
+  enum gender: %i(female male other unspecified)
+
+  belongs_to :avatar, optional: true
 
   before_validation :set_uid!
   validates :uid, presence: true
 
-  resource_fields :uid, :social_id, :image_url, :email, :permissions, :verified_first_name, :verified_last_name, *profile_fields
+  resource_fields :uid, :social_id, :email, :permissions, :verified_first_name, :verified_last_name, *profile_fields
 
   def last_lesson
     last_guide.try(:lesson)
@@ -105,6 +108,10 @@ class User < ApplicationRecord
     update! self.class.slice_resource_h json
   end
 
+  def to_resource_h
+    super.merge(image_url: profile_picture)
+  end
+
   def verify_name!
     self.verified_first_name ||= first_name
     self.verified_last_name ||= last_name
@@ -138,6 +145,34 @@ class User < ApplicationRecord
     exams.any? { |e| e.in_progress_for? self }
   end
 
+  def profile_picture
+    avatar&.image_url || image_url
+  end
+
+  def bury!
+    # TODO change avatar
+    update! self.class.buried_profile.merge(accepts_reminders: false, gender: nil, birthdate: nil)
+  end
+
+  # Takes a didactic - ordered - sequence of content containers
+  # and returns those that have been completed
+  def completed_containers(sequence, organization)
+    sequence.take_while { |it| it.content.completed_for?(self, organization) }
+  end
+
+  # Like `completed_containers`, returns a slice of the completed containers
+  # in the sequence, but adding a configurable number of trailing, non-completed contaienrs
+  def completed_containers_with_lookahead(sequence, organization, lookahead: 1)
+    raise 'invalid lookahead' if lookahead < 1
+
+    count = completed_containers(sequence, organization).size
+    sequence[0..count + lookahead - 1]
+  end
+
+  def name_initials
+    name.split.map(&:first).map(&:capitalize).join(' ')
+  end
+
   private
 
   def set_uid!
@@ -145,7 +180,7 @@ class User < ApplicationRecord
   end
 
   def init
-    self.image_url ||= "user_shape.png"
+    self.avatar = Avatar.sample unless profile_picture.present?
   end
 
   def self.sync_key_id_field
@@ -160,4 +195,14 @@ class User < ApplicationRecord
     user[:uid] ||= user[:email]
     where(uid: user[:uid]).first_or_create(user)
   end
+
+  # Call this method once as part of application initialization
+  # in order to enable user profile override as part of disabling process
+  def self.configure_buried_profile!(profile)
+    @buried_profile = profile
+  end
+
+  def self.buried_profile
+    (@buried_profile || {}).slice(:first_name, :last_name, :email)
+  end
 end