mumuki-domain 6.0.0

data/app/models/invitation.rb

@@ -0,0 +1,36 @@
+class Invitation < ApplicationRecord
+  def self.find_by_code(code)
+    Invitation
+      .where(code: code)
+      .where(Invitation.arel_table[:expiration_date].gt(Time.now))
+      .take!
+  rescue RangeError
+    raise RecordNotFound.new('The invitation does not exist or it has expired')
+  end
+
+  def self.import_from_resource_h!(json)
+    Invitation.create! json
+  end
+
+  def organization
+    Organization.find_by! name: course.to_mumukit_slug.organization
+  end
+
+  def navigable_name
+    I18n.t(:invitation_for, course: course_name)
+  end
+
+  def navigation_end?
+    true
+  end
+
+  def to_param
+    code
+  end
+
+  private
+
+  def course_name
+    course.to_mumukit_slug.course
+  end
+end

data/app/models/language.rb

@@ -0,0 +1,114 @@
+class Language < ApplicationRecord
+  include WithCaseInsensitiveSearch
+
+  enum output_content_type: [:plain, :html, :markdown]
+
+  validates_presence_of :runner_url, :output_content_type
+
+  validates :name, presence: true, uniqueness: {case_sensitive: false}
+
+  markdown_on :description
+
+  delegate :run_tests!, :run_query!, :run_try!, to: :bridge
+
+  def bridge
+    Mumukit::Bridge::Runner.new(runner_url)
+  end
+
+  def highlight_mode
+    self[:highlight_mode] || name
+  end
+
+  def output_content_type
+    Mumukit::ContentType.for(self[:output_content_type])
+  end
+
+  def to_s
+    name
+  end
+
+  def self.for_name(name)
+    find_by_ignore_case!(:name, name) if name
+  end
+
+  def devicon
+    self[:devicon] || name.downcase
+  end
+
+  def sync_key
+    Mumukit::Sync.key :language, runner_url
+  end
+
+  def import_from_resource_h!(json)
+    assign_attributes json.slice(:name,
+                                 :comment_type,
+                                 :output_content_type,
+                                 :prompt,
+                                 :extension,
+                                 :highlight_mode,
+                                 :visible_success_output,
+                                 :devicon,
+                                 :triable,
+                                 :queriable,
+                                 :stateful_console,
+                                 :layout_js_urls,
+                                 :layout_html_urls,
+                                 :layout_css_urls,
+                                 :editor_js_urls,
+                                 :editor_html_urls,
+                                 :editor_css_urls,
+                                 :test_template)
+    save!
+  end
+
+  def directives_sections
+    new_directive Mumukit::Directives::Sections
+  end
+
+
+  def assets_urls_for(kind, content_type)
+    send "#{kind}_#{content_type}_urls"
+  end
+
+  # TODO this should be a Mumukit::Directives::Directive
+  # and be part of a pipeline
+  def interpolate_references_for(assignment, field)
+    interpolate(field, assignment.submitter.interpolations, lambda { |content| replace_content_reference(assignment, content) })
+  end
+
+  def self.locate_resource(runner_url)
+    find_or_initialize_by(runner_url: runner_url).tap { |it| it.save(validate: false) }
+  end
+
+  def to_embedded_resource_h
+    as_json(only: [:name, :extension, :test_extension]).symbolize_keys
+  end
+
+  private
+
+  # TODO we should use Mumukit::Directives::Pipeline
+  def interpolate(interpolee, *interpolations)
+    interpolations.inject(interpolee) { |content, interpolation| directives_interpolations.interpolate(content, interpolation).first }
+  end
+
+  def directives_interpolations
+    new_directive Mumukit::Directives::Interpolations
+  end
+
+  def replace_content_reference(assignment, interpolee)
+    case interpolee
+    when /previousContent|previousSolution/
+      assignment.current_content_at(-1)
+    when /(solution|content)\[(-?\d*)\]/
+      assignment.current_content_at($2.to_i)
+    end
+  end
+
+  def new_directive(directive_type)
+    directive_type.new.tap { |it| it.comment_type = directives_comment_type }
+  end
+
+  def directives_comment_type
+    Mumukit::Directives::CommentType.parse comment_type
+  end
+end

data/app/models/lesson.rb

@@ -0,0 +1,25 @@
+class Lesson < ApplicationRecord
+  include WithNumber
+  include FriendlyName
+
+  include GuideContainer
+
+  belongs_to :topic
+  belongs_to :guide
+
+  include ParentNavigation, SiblingsNavigation
+
+  alias_method :chapter, :navigable_parent
+
+  def used_in?(organization)
+    guide.usage_in_organization(organization) == self
+  end
+
+  def pending_siblings_for(user)
+    topic.pending_lessons(user)
+  end
+
+  def structural_parent
+    topic
+  end
+end

data/app/models/message.rb

@@ -0,0 +1,68 @@
+class Message < ApplicationRecord
+
+  belongs_to :discussion, optional: true
+  belongs_to :assignment, foreign_key: :submission_id, primary_key: :submission_id, optional: true
+  has_one :exercise, through: :assignment
+
+  validates_presence_of :content, :sender
+  validates_presence_of :submission_id, :unless => :discussion_id?
+  markdown_on :content
+
+  def notify!
+    Mumukit::Nuntius.notify! 'student-messages', to_resource_h
+  end
+
+  def from_initiator?
+    sender_user == discussion&.initiator
+  end
+
+  def from_user?(user)
+    sender_user == user
+  end
+
+  def sender_user
+    User.find_by(uid: sender)
+  end
+
+  def authorized?(user)
+    from_user?(user) || user&.moderator?
+  end
+
+  def authorize!(user)
+    raise Mumukit::Auth::UnauthorizedAccessError unless authorized?(user)
+  end
+
+  def to_resource_h
+    as_json(except: [:id, :type, :discussion_id, :approved],
+            include: {exercise: {only: [:bibliotheca_id]}})
+      .merge(organization: Organization.current.name)
+  end
+
+  def read!
+    update! read: true
+  end
+
+  def toggle_approved!
+    toggle! :approved
+  end
+
+  def self.parse_json(json)
+    message = json.delete 'message'
+    json
+      .except('uid', 'exercise_id')
+      .merge(message)
+  end
+
+  def self.read_all!
+    update_all read: true
+  end
+
+  def self.import_from_resource_h!(json)
+    message_data = parse_json json
+    Organization.find_by!(name: message_data.delete('organization')).switch!
+
+    if message_data['submission_id'].present?
+      Assignment.find_by(submission_id: message_data.delete('submission_id'))&.receive_answer! message_data
+    end
+  end
+end

data/app/models/organization.rb

@@ -0,0 +1,118 @@
+class Organization < ApplicationRecord
+  include Mumukit::Platform::Organization::Helpers
+
+  serialize :profile, Mumukit::Platform::Organization::Profile
+  serialize :settings, Mumukit::Platform::Organization::Settings
+  serialize :theme, Mumukit::Platform::Organization::Theme
+
+  validate :ensure_consistent_public_login
+
+  belongs_to :book
+  has_many :usages
+
+  validates_presence_of :contact_email, :locale
+  validates :name, uniqueness: true,
+                   presence: true,
+                   format: { with: Mumukit::Platform::Organization::Helpers.anchored_valid_name_regex }
+  validates :locale, inclusion: { in: Mumukit::Platform::Locale.supported }
+
+  after_create :reindex_usages!
+  after_update :reindex_usages!, if: lambda { |user| user.saved_change_to_book_id? }
+
+  has_many :guides, through: 'usages', source: 'item', source_type: 'Guide'
+  has_many :exercises, through: :guides
+  has_many :assignments, through: :exercises
+  has_many :exams
+  has_many :courses
+
+  defaults do
+    self.class.base.try do |base|
+      self.theme         = base.theme    if theme.empty?
+      self.settings      = base.settings if settings.empty?
+      self.contact_email ||= base.contact_email
+      self.book          ||= base.book
+      self.locale        ||= base.locale
+    end
+  end
+
+  def in_path?(item)
+    usages.exists?(item: item) || usages.exists?(parent_item: item)
+  end
+
+  def notify_recent_assignments!(date)
+    notify_assignments! assignments.where('assignments.updated_at > ?', date)
+  end
+
+  def notify_assignments_by!(submitter)
+    notify_assignments! assignments.where(submitter_id: submitter.id)
+  end
+
+  def silent?
+    test?
+  end
+
+  def reindex_usages!
+    transaction do
+      drop_usage_indices!
+      book.index_usage! self
+      exams.each { |exam| exam.index_usage! self }
+    end
+    reload
+  end
+
+  def drop_usage_indices!
+    usages.destroy_all
+  end
+
+  def index_usage_of!(item, parent)
+    Usage.create! organization: self, item: item, parent_item: parent
+  end
+
+  def accessible_exams_for(user)
+    exams.select { |exam| exam.accessible_for?(user) }
+  end
+
+  def has_login_method?(login_method)
+    self.login_methods.include? login_method.to_s
+  end
+
+  def explain_error(code, advice)
+    errors_explanations.try { |it| it[code.to_s] } || I18n.t(advice)
+  end
+
+  def self.accessible_as(user, role)
+    all.select { |it| it.public? || user.has_permission?(role, it.slug) }
+  end
+
+  def title_suffix
+    central? ? '' : " - #{book.name}"
+  end
+
+  def site_name
+    central? ? 'mumuki' : name
+  end
+
+  def ask_for_help_enabled?
+    report_issue_enabled? || community_link.present? || forum_enabled?
+  end
+
+  private
+
+  def ensure_consistent_public_login
+    errors.add(:base, :consistent_public_login) if settings.customized_login_methods? && public?
+  end
+
+  def notify_assignments!(assignments)
+    assignments.each { |assignment| assignment.notify! }
+  end
+
+  class << self
+    def central
+      find_by name: 'central'
+    end
+
+    def base
+      find_by name: 'base'
+    end
+  end
+end

data/app/models/stats.rb

@@ -0,0 +1,24 @@
+class Stats
+  include ActiveModel::Model
+
+  attr_accessor :passed, :passed_with_warnings, :failed, :pending
+
+  def submitted
+    passed + passed_with_warnings + failed
+  end
+
+  def done?
+    failed + pending == 0
+  end
+
+  def started?
+    submitted > 0
+  end
+
+  def self.from_statuses(statuses)
+    Stats.new(statuses.inject({passed: 0, passed_with_warnings: 0, failed: 0, pending: 0}) do |accum, status|
+      accum[status.group.to_sym] += 1
+      accum
+    end)
+  end
+end

data/app/models/subscription.rb

@@ -0,0 +1,12 @@
+class Subscription < ApplicationRecord
+  belongs_to :user
+  belongs_to :discussion
+
+  def unread!
+    update! read: false
+  end
+
+  def read!
+    update! read: true
+  end
+end

data/app/models/topic.rb

@@ -0,0 +1,60 @@
+class Topic < Content
+  numbered :lessons
+  aggregate_of :lessons
+
+  has_many :lessons, -> { order(number: :asc) }, dependent: :delete_all
+
+  has_many :guides, -> { order('lessons.number') }, through: :lessons
+  has_many :exercises, -> { order('exercises.number') }, through: :guides
+
+  markdown_on :appendix
+
+  def pending_lessons(user)
+    guides.
+        joins('left join public.exercises exercises
+                on exercises.guide_id = guides.id').
+        joins("left join public.assignments assignments
+                on assignments.exercise_id = exercises.id
+                and assignments.submitter_id = #{user.id}
+                and assignments.submission_status = #{Mumuki::Domain::Status::Submission::Passed.to_i}").
+        where('assignments.id is null').
+        group('public.guides.id', 'lessons.number').map(&:lesson)
+  end
+
+  def first_lesson
+    lessons.first
+  end
+
+  def import_from_resource_h!(resource_h)
+    self.assign_attributes resource_h.except(:lessons, :id, :description, :teacher_info)
+    self.description = resource_h[:description].squeeze(' ')
+    rebuild! resource_h[:lessons].to_a.map { |it| lesson_for(it) }
+    Organization.all.each { |org| org.reindex_usages! }
+  end
+
+  def to_resource_h
+    super.merge(appendix: appendix, lessons: lessons.map(&:slug)).compact
+  end
+
+  def as_chapter_of(book)
+    book.chapters.find_by(topic_id: id) || Chapter.new(topic: self, book: book)
+  end
+
+  ## Forking
+
+  def fork_to!(organization, syncer)
+    rebased_dup(organization).tap do |dup|
+      dup.lessons = lessons.map { |lesson| lesson.guide.fork_to!(organization, syncer).as_lesson_of(self) }
+      dup.save!
+      syncer.export! dup
+    end
+  end
+
+  private
+
+  def lesson_for(slug)
+    Guide.find_by!(slug: slug).as_lesson_of(self)
+  rescue ActiveRecord::RecordNotFound
+    raise "Guide for slug #{slug} could not be found"
+  end
+end