mumuki-domain 7.6.1 → 7.8.1

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/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

@@ -42,7 +42,7 @@ class Guide < Content
   end
 
   def next_exercise(user)
-    pending_exercises(user).order('public.exercises.number asc').first
+    user.next_exercise_at(self)
   end
 
   # TODO: Make use of pending_siblings logic

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

@@ -18,6 +18,7 @@ class Organization < ApplicationRecord
   has_many :usages
 
   validates_presence_of :contact_email, :locale
+  validates_presence_of :welcome_email_template, if: :greet_new_users?
   validates :name, uniqueness: true,
                    presence: true,
                    format: { with: Mumukit::Platform::Organization.anchored_valid_name_regex }
@@ -105,17 +106,8 @@ class Organization < ApplicationRecord
   # ask for help in this organization
   #
   # Warning: this method does not strictly check user's permission
-  def ask_for_help_enabled?(user = nil)
-    report_issue_enabled? || community_link.present? || can_create_discussions?(user)
-  end
-
-  # Tells if the given user can
-  # create discussion in this organization
-  #
-  # This is true only when this organization has a forum and the user
-  # has the discusser pseudo-permission
-  def can_create_discussions?(user = nil)
-    forum_enabled? && (!user || user.discusser_of?(self))
+  def ask_for_help_enabled?(user)
+    report_issue_enabled? || community_link.present? || user.can_discuss_in?(self)
   end
 
   def import_from_resource_h!(resource_h)
@@ -136,6 +128,10 @@ class Organization < ApplicationRecord
     update! progressive_display_lookahead: lookahead
   end
 
+  def display_name
+    name.gsub(/\W/, ' ').titleize
+  end
+
   private
 
   def ensure_consistent_public_login

data/app/models/user.rb

@@ -39,6 +39,8 @@ class User < ApplicationRecord
   before_validation :set_uid!
   validates :uid, presence: true
 
+  after_save :welcome_to_new_organizations!, if: :gained_access_to_new_orga?
+
   resource_fields :uid, :social_id, :email, :permissions, :verified_first_name, :verified_last_name, *profile_fields
 
   def last_lesson
@@ -169,8 +171,70 @@ class User < ApplicationRecord
     sequence[0..count + lookahead - 1]
   end
 
+  # Tells if the given user can discuss in an organization
+  #
+  # This is true only when this organization has the forum enabled and the user
+  # has the discusser pseudo-permission and the discusser is trusted
+  def can_discuss_in?(organization)
+    organization.forum_enabled? && discusser_of?(organization) && trusted_as_discusser_in?(organization)
+  end
+
+  def trusted_as_discusser_in?(organization)
+    trusted_for_forum? || !organization.forum_only_for_trusted?
+  end
+
+  def can_discuss_here?
+    can_discuss_in? Organization.current
+  end
+
+  def name_initials
+    name.split.map(&:first).map(&:capitalize).join(' ')
+  end
+
+  def progress_at(content, organization)
+    Indicator.find_or_initialize_by(user: self, organization: organization, content: content)
+  end
+
+  def build_assignment(exercise, organization)
+    assignments.build(exercise: exercise, organization: organization)
+  end
+
+  def pending_siblings_at(content)
+    content.pending_siblings_for(self)
+  end
+
+  def next_exercise_at(guide)
+    guide.pending_exercises(self).order('public.exercises.number asc').first
+  end
+
+  def run_submission!(submission, assignment, evaluation)
+    submission.run! assignment, evaluation
+  end
+
+  def incognito?
+    false
+  end
+
   private
 
+  def welcome_to_new_organizations!
+    new_accessible_organizations.each do |organization|
+      UserMailer.welcome_email(self, organization).deliver_later if organization.greet_new_users?
+    end
+  end
+
+  def gained_access_to_new_orga?
+    new_accessible_organizations.present?
+  end
+
+  def new_accessible_organizations
+    return [] unless saved_change_to_permissions?
+
+    old, new = saved_change_to_permissions
+    new_organizations = (new.any_granted_organizations - old.any_granted_organizations).to_a
+    Organization.where(name: new_organizations)
+  end
+
   def set_uid!
     self.uid ||= email
   end

data/db/migrate/20200601203033_add_course_to_exam.rb

@@ -0,0 +1,5 @@
+class AddCourseToExam < ActiveRecord::Migration[5.1]
+  def change
+    add_reference :exams, :course
+  end
+end

data/db/migrate/20200605161350_add_passing_criterions_to_exam.rb

@@ -0,0 +1,6 @@
+class AddPassingCriterionsToExam < ActiveRecord::Migration[5.1]
+  def change
+    add_column :exams, :passing_criterion_type, :integer, default: 0
+    add_column :exams, :passing_criterion_value, :integer
+  end
+end

data/db/migrate/20200702165503_add_messages_count_to_discussion.rb

@@ -0,0 +1,6 @@
+class AddMessagesCountToDiscussion < ActiveRecord::Migration[5.1]
+  def change
+    add_column :discussions, :messages_count, :integer, default: 0
+    add_column :discussions, :validated_messages_count, :integer, default: 0
+  end
+end

data/db/migrate/20200728162727_add_not_actually_a_question_field_to_messages.rb

@@ -0,0 +1,5 @@
+class AddNotActuallyAQuestionFieldToMessages < ActiveRecord::Migration[5.1]
+  def change
+    add_column :messages, :not_actually_a_question, :boolean, default: false
+  end
+end

data/db/migrate/20200728163038_add_requires_moderator_response_to_discussions.rb

@@ -0,0 +1,5 @@
+class AddRequiresModeratorResponseToDiscussions < ActiveRecord::Migration[5.1]
+  def change
+    add_column :discussions, :requires_moderator_response, :boolean, default: true
+  end
+end

data/db/migrate/20200730221001_add_trusted_for_forum_to_user.rb

@@ -0,0 +1,5 @@
+class AddTrustedForForumToUser < ActiveRecord::Migration[5.1]
+  def change
+    add_column :users, :trusted_for_forum, :boolean
+  end
+end

data/db/migrate/20200731081757_add_last_moderator_access_fields_to_discussion.rb

@@ -0,0 +1,6 @@
+class AddLastModeratorAccessFieldsToDiscussion < ActiveRecord::Migration[5.1]
+  def change
+    add_column :discussions, :last_moderator_access_by_id, :string
+    add_column :discussions, :last_moderator_access_at, :datetime
+  end
+end

data/db/migrate/20200804191643_add_incognito_mode_enabled_to_organization.rb

@@ -0,0 +1,5 @@
+class AddIncognitoModeEnabledToOrganization < ActiveRecord::Migration[5.1]
+  def change
+    add_column :organizations, :incognito_mode_enabled, :boolean
+  end
+end

data/lib/mumuki/domain.rb

@@ -26,6 +26,7 @@ Mumukit::Platform.configure do |config|
 end
 
 require_relative './domain/area'
+require_relative './domain/incognito'
 require_relative './domain/evaluation'
 require_relative './domain/submission'
 require_relative './domain/status'

data/lib/mumuki/domain/factories/course_factory.rb

@@ -2,8 +2,10 @@ FactoryBot.define do
   factory :course do
     period { '2016' }
     shifts { %w(morning) }
+    code { "k1234-#{SecureRandom.uuid}" }
     days { %w(monday wednesday) }
     description { 'test' }
     organization_id { 1 }
+    slug { "#{Organization.current.name}/#{period}-#{code}" }
   end
 end

data/lib/mumuki/domain/factories/discussion_factory.rb

@@ -1,7 +1,7 @@
 FactoryBot.define do
   factory :discussion do
-    title { 'A discussion' }
-    description { 'A discussion description' }
+    title { Faker::Lorem.sentence(word_count: 2) }
+    description { Faker::Lorem.sentence(word_count: 5) }
     initiator { create(:user) }
     item { create(:exercise) }
     organization { Organization.current rescue nil }

data/lib/mumuki/domain/factories/exam_factory.rb

@@ -3,6 +3,7 @@ FactoryBot.define do
   factory :exam, traits: [:guide_container] do
     duration { Faker::Number.between(from: 10, to:60).minutes }
     organization { Organization.current }
+    course { create(:course) }
     start_time { 5.minutes.ago }
     end_time { 10.minutes.since }
   end

data/lib/mumuki/domain/factories/message_factory.rb

@@ -1,11 +1,6 @@
 FactoryBot.define do
 
   factory :message do
-    exercise_id { Faker::Internet.number(2) }
-    assignment
-    submission_id { assignment.id }
-    sender { Faker::Internet.email }
-    type { 'success' }
-    content { Faker::Lorem.sentence(3) }
+    content { Faker::Lorem.sentence(word_count: 3) }
   end
 end

data/lib/mumuki/domain/incognito.rb

@@ -0,0 +1,112 @@
+module Mumuki::Domain
+  class IncognitoClass
+
+    def incognito?
+      true
+    end
+
+    # ============
+    # Permissions
+    # ============
+
+    def ensure_enabled!
+    end
+
+    def has_student_granted_organizations?
+      false
+    end
+
+    def teacher_here?
+      false
+    end
+
+    def teacher_of?(*)
+      false
+    end
+
+    def profile_completed?
+      true
+    end
+
+    def writer?
+      false
+    end
+
+    def moderator_here?
+      false
+    end
+
+    def can_discuss_here?
+      false
+    end
+
+    # ========
+    # Visiting
+    # ========
+
+    def visit!(*)
+    end
+
+    # ========
+    # Progress
+    # ========
+
+    def next_exercise_at(guide)
+      guide.exercises.first
+    end
+
+    # def completed_containers_with_lookahead(*)
+    #   raise 'Unsupported operation. Userless mode and progressive display modes are incompatible'
+    # end
+
+    def progress_at(content, organization)
+      Indicator.new content: content, organization: organization
+    end
+
+    def build_assignment(exercise, organization)
+      Assignment.new exercise: exercise, organization: organization, submitter: self
+    end
+
+    def pending_siblings_at(content)
+      []
+    end
+
+    # ============
+    # ActiveRecord
+    # ============
+
+    def id
+      '<incognito>'
+    end
+
+    def is_a?(other)
+      other.is_a?(Class) && other.name == 'User' || super
+    end
+
+    def _read_attribute(key)
+      return id if key == 'id'
+      raise "unknown attribute #{key}"
+    end
+
+    def self.primary_key
+      'id'
+    end
+
+    # ==========
+    # Evaluation
+    # ==========
+
+    def interpolations
+      []
+    end
+
+    def run_submission!(submission, assignment, evaluation)
+      results = submission.dry_run! assignment, evaluation
+      assignment.assign_attributes results
+      results
+    end
+
+  end
+
+  Incognito = IncognitoClass.new
+end