mumuki-domain 7.10.1 → 7.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 112a8510ab0705d0535f9728da759bebdf79b66b16767b074df66527eb824dc7
-  data.tar.gz: a4c7747e9351fdae0e76a71314d3293e64959d8eaa00f96f60f2895e3fbfe82d
+  metadata.gz: 17efbb5ea487285cf39720f0f3bcaab94641669a8f0ba83c78b8931c8ff949b2
+  data.tar.gz: a6213b8093643e8112ffc85609fbae72c871c343f9374e17ba024ee1b9eb73c3
 SHA512:
-  metadata.gz: fdbd7fd8d043a07d44d4daea0d8b7162f1852f469dfc69a03dd0464e250debe36dd0164758a6bdaaf3ebbdb8267b7807b70cc4a9a11fa31cdf48c309d0d3df72
-  data.tar.gz: bf865f34f9f7fb007556063d065c164ce4b5537d4848fa2a492e95c3844c779afdbd85b14f9ffcd393dd215f906cd56b552a92a2d88ba9515ed880fb13b591f8
+  metadata.gz: 821da987d9bc224d803554e8f44f54c200f5dcc9fd38ad90a793e5fb640ad946cf059276a534d8004a84386f2ef75fa448b666b4054049b48dbfb8e76bcce32e
+  data.tar.gz: 4b92ea6a719cd03dc2b3c9e338cdb470b86a22f9764b0dff4a61f9a5173bee1d389de9d7396cf55b78cf23d63222ecaca6be6ccf14e2cc83d7de0cabc57a090b

data/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.org/mumuki/mumuki-domain.svg?branch=master)](https://travis-ci.org/mumuki/mumuki-domain)
+[![Build Status](https://travis-ci.com/mumuki/mumuki-domain.svg?branch=master)](https://travis-ci.com/mumuki/mumuki-domain)
 [![Code Climate](https://codeclimate.com/github/mumuki/mumuki-domain/badges/gpa.svg)](https://codeclimate.com/github/mumuki/mumuki-domain)
 [![Test Coverage](https://codeclimate.com/github/mumuki/mumuki-domain/badges/coverage.svg)](https://codeclimate.com/github/mumuki/mumuki-domain)
 [![Issue Count](https://codeclimate.com/github/mumuki/mumuki-domain/badges/issue_count.svg)](https://codeclimate.com/github/mumuki/mumuki-domain)

data/app/models/application_record.rb

@@ -3,6 +3,16 @@ class ApplicationRecord < ActiveRecord::Base
 
   delegate :whitelist_attributes, to: :class
 
+  def self.teaser_on(*args)
+    args.each do |selector|
+      teaser_selector = "#{selector}_teaser"
+      define_method teaser_selector do
+        send(selector)&.markdown_paragraphs&.first
+      end
+      markdown_on teaser_selector, skip_sanitization: true
+    end
+  end
+
   def self.defaults(&block)
     after_initialize :defaults, if: :new_record?
     define_method :defaults, &block

data/app/models/assignment.rb

@@ -91,7 +91,14 @@ class Assignment < Progress
   end
 
   def notify!
-    Mumukit::Nuntius.notify! 'submissions', to_resource_h unless Organization.silenced?
+    unless Organization.silenced?
+      update_misplaced!(current_notification_contexts.size > 1)
+      Mumukit::Nuntius.notify! 'submissions', to_resource_h
+    end
+  end
+
+  def current_notification_contexts
+    [Organization.current, submitter.current_immersive_context_at(exercise)].uniq
   end
 
   def notify_to_accessible_organizations!
@@ -169,7 +176,7 @@ class Assignment < Progress
 
   def to_resource_h
     excluded_fields = %i(created_at exercise_id id organization_id parent_id solution submission_id
-                         submission_status submitted_at submitter_id top_submission_status updated_at)
+                         submission_status submitted_at submitter_id top_submission_status updated_at misplaced)
 
     as_json(except: excluded_fields,
               include: {
@@ -238,6 +245,10 @@ class Assignment < Progress
     self.top_submission_status = submission_status unless submission_status.improved_by?(top_submission_status)
   end
 
+  def update_misplaced!(value)
+    update! misplaced: value if value != misplaced?
+  end
+
   private
 
   def update_submissions_count!

data/app/models/avatar.rb

@@ -1,4 +1,6 @@
 class Avatar < ApplicationRecord
+  has_many :users, as: :avatar
+
   include WithTargetAudience
 
   def self.sample_for(user)

data/app/models/concerns/awardee.rb

@@ -0,0 +1,27 @@
+module Awardee
+  def acquired_medals(organization=Organization.current)
+    @acquired_medals ||= medals_for awarded_contents_in(organization)
+  end
+
+  def unacquired_medals(organization=Organization.current)
+    @unacquired_medals ||= medals_for unawarded_contents_in(organization)
+  end
+
+  private
+
+  def medals_for(content)
+    content.map(&:medal)
+  end
+
+  def awarded_contents_in(organization)
+    awardable_contents_in(organization).first
+  end
+
+  def unawarded_contents_in(organization)
+    awardable_contents_in(organization).second
+  end
+
+  def awardable_contents_in(organization)
+    @awardable_contents_in ||= organization.awardable_contents.partition { |c| c.once_completed_for? self, organization }
+  end
+end

data/app/models/concerns/contextualization.rb

@@ -51,7 +51,7 @@ module Contextualization
   end
 
   def single_visible_test_result?
-    test_results.size == 1 && visible_success_output?
+    test_results.single? && visible_success_output?
   end
 
   def first_test_result
@@ -131,8 +131,12 @@ module Contextualization
         .compact
         .merge(
           title: it[:title].affable,
-          result: it[:result].sanitized,
+          result: it[:result],
           status: it[:status])
     end
   end
+
+  def sanitized_affable_test_results
+    affable_test_results.each { |it| it[:result] = it[:result]&.sanitized }
+  end
 end

data/app/models/concerns/with_description.rb

@@ -2,11 +2,8 @@ module WithDescription
   extend ActiveSupport::Concern
 
   included do
-    markdown_on :description, :description_teaser, skip_sanitization: true
+    markdown_on :description, skip_sanitization: true
+    teaser_on :description
     validates_presence_of :description
   end
-
-  def description_teaser
-    description.markdown_paragraphs.first
-  end
 end

data/app/models/concerns/with_medal.rb

@@ -0,0 +1,7 @@
+module WithMedal
+  extend ActiveSupport::Concern
+
+  included do
+    belongs_to :medal, optional: true
+  end
+end

data/app/models/concerns/with_progress.rb

@@ -23,6 +23,10 @@ module WithProgress
     progress_for(user, organization).completed?
   end
 
+  def once_completed_for?(user, organization)
+    progress_for(user, organization).once_completed?
+  end
+
   private
 
   def structural_children_changed?(old_structural_children)

data/app/models/content.rb

@@ -4,10 +4,11 @@ class Content < ApplicationRecord
   include Mumuki::Domain::Syncable
   include WithDescription
   include WithLocale
-  include WithSlug
-  include WithUsages
+  include WithMedal
   include WithName
   include WithProgress
+  include WithSlug
+  include WithUsages
 
   def to_resource_h(*args)
     to_expanded_resource_h(*args).compact

data/app/models/discussion.rb

@@ -4,7 +4,10 @@ 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 :status_updated_by, class_name: 'User', optional: true
+
   belongs_to :exercise, foreign_type: :exercise, foreign_key: 'item_id'
   belongs_to :organization
   has_many :subscriptions
@@ -106,7 +109,11 @@ class Discussion < ApplicationRecord
   end
 
   def update_status!(status, user)
-    update!(status: status) if reachable_status_for?(user, status)
+    if reachable_status_for?(user, status)
+      update! status: status,
+              status_updated_by: user,
+              status_updated_at: Time.now
+    end
   end
 
   def has_messages?

data/app/models/indicator.rb

@@ -37,6 +37,7 @@ class Indicator < Progress
   def clean!
     self.dirty_by_submission = false
     self.dirty_by_content_change = false
+    self.once_completed ||= all_children_passed?
   end
 
   def refresh_children_count!
@@ -54,7 +55,15 @@ class Indicator < Progress
 
   def completed?
     rebuild!
-    children_passed_count == children_count
+    all_children_passed?
+  end
+
+  def once_completed?
+    self.once_completed || completed?
+  end
+
+  def self.delete_all_for!(content, organization)
+    where(content: content, organization: organization).delete_all
   end
 
   private
@@ -74,4 +83,8 @@ class Indicator < Progress
   def parent_content
     content.usage_in_organization(organization).structural_parent
   end
+
+  def all_children_passed?
+    children_passed_count == children_count
+  end
 end

data/app/models/medal.rb

@@ -0,0 +1,3 @@
+class Medal < ApplicationRecord
+  has_many :users, as: :avatar
+end

data/app/models/organization.rb

@@ -11,10 +11,12 @@ class Organization < ApplicationRecord
   serialize :settings, Mumuki::Domain::Organization::Settings
   serialize :theme, Mumuki::Domain::Organization::Theme
 
-  markdown_on :description
+  markdown_on :description, :display_description, :page_description
+  teaser_on :display_description
 
   validate :ensure_consistent_public_login
   validate :ensure_valid_activity_range
+  validate :ensure_not_immersive_and_immersible
 
   belongs_to :book
   has_many :usages
@@ -97,11 +99,13 @@ class Organization < ApplicationRecord
   end
 
   def title_suffix
-    central? ? '' : " - #{book.name}"
+    warn "Don't use title_suffix. Use page_name instead"
+    " - #{page_name}"
   end
 
   def site_name
-    central? ? 'mumuki' : name
+    warn "Don't use site_name. Use display_name instead"
+    name
   end
 
   # Tells if the given user can
@@ -130,12 +134,55 @@ class Organization < ApplicationRecord
     update! progressive_display_lookahead: lookahead
   end
 
+  def progressive_display_lookahead=(lookahead)
+    self[:progressive_display_lookahead] = lookahead.to_i.positive? ? lookahead : nil
+  end
+
+  # ==============
+  # Display fields
+  # ==============
+
   def display_name
-    name.try { |it| it.gsub(/\W/, ' ').titleize }
+    self[:display_name].presence || name.try { |it| it.gsub(/\W/, ' ').titleize }
+  end
+
+  def display_description
+    self[:display_description].presence || I18n.t('defaults.organization.display_description', name: name)
+  end
+
+  # ===========
+  # Page fields
+  # ===========
+
+  # Since an organization has a single book, both concepts may be merged
+  # when describing a site. In such contexts, wins_page?
+  # control whether the book or the organization header fields are
+  # more important
+
+  def page_name
+    wins_page? ? display_name : book.name
+  end
+
+  def page_description
+    wins_page? ? display_description : book.description
+  end
+
+  def all_contents
+    Usage.where(organization: self)
+         .group_by(&:item_type)
+         .flat_map { |item_type, item| item_type.constantize.where(id: item.map(&:item_id)) }
+  end
+
+  def awardable_contents
+    gamification_enabled? ? all_contents.select(&:medal_id) : []
   end
 
   private
 
+  def ensure_not_immersive_and_immersible
+    errors.add(:immersible, :cannot_be_immersive) if immersible? && immersive?
+  end
+
   def ensure_consistent_public_login
     errors.add(:base, :consistent_public_login) if settings.customized_login_methods? && public?
   end

data/app/models/usage.rb

@@ -8,6 +8,7 @@ class Usage < ApplicationRecord
 
   before_save :set_slug
   before_destroy :destroy_children_usages!
+  before_destroy :delete_associated_indicators!
 
   def self.destroy_all_where(query)
     where(query).destroy_all
@@ -27,6 +28,10 @@ class Usage < ApplicationRecord
 
   private
 
+  def delete_associated_indicators!
+    Indicator.delete_all_for!(item, organization)
+  end
+
   def set_slug
     self.slug = item.slug
   end

data/app/models/user.rb

@@ -4,6 +4,7 @@ class User < ApplicationRecord
           WithUserNavigation,
           WithReminders,
           WithDiscussionCreation,
+          Awardee,
           Disabling,
           Mumuki::Domain::Helpers::User
 
@@ -31,7 +32,7 @@ class User < ApplicationRecord
   has_many :exams, through: :exam_authorizations
 
   enum gender: %i(female male other unspecified)
-  belongs_to :avatar, optional: true
+  belongs_to :avatar, polymorphic: true, optional: true
 
   before_validation :set_uid!
   validates :uid, presence: true
@@ -236,6 +237,18 @@ class User < ApplicationRecord
     end
   end
 
+  def current_organic_context
+    Organization.current? ?  Organization.current : main_organization
+  end
+
+  def current_immersive_context_at(exercise)
+    if Organization.current?
+      immersive_organization_at(exercise) || Organization.current
+    else
+      main_organization
+    end
+  end
+
   private
 
   def welcome_to_new_organizations!
@@ -289,12 +302,4 @@ class User < ApplicationRecord
   def self.buried_profile
     (@buried_profile || {}).slice(:first_name, :last_name, :email)
   end
-
-  def current_organic_context
-    if Organization.current?
-      Organization.current
-    else
-      main_organization
-    end
-  end
 end

data/db/migrate/20200828152812_create_medals.rb

@@ -0,0 +1,8 @@
+class CreateMedals < ActiveRecord::Migration[5.1]
+  def change
+    create_table :medals do |t|
+      t.string :image_url
+      t.string :description
+    end
+  end
+end

data/db/migrate/20200828162829_add_medal_to_content.rb

@@ -0,0 +1,7 @@
+class AddMedalToContent < ActiveRecord::Migration[5.1]
+  def change
+    add_reference :books, :medal, index: false
+    add_reference :guides, :medal, index: false
+    add_reference :topics, :medal, index: false
+  end
+end

data/db/migrate/20200915123020_add_polymorphic_avatars_to_users.rb

@@ -0,0 +1,6 @@
+class AddPolymorphicAvatarsToUsers < ActiveRecord::Migration[5.1]
+  def change
+    add_column :users, :avatar_type, :string, default: 'Avatar'
+    add_index :users, [:avatar_type, :avatar_id]
+  end
+end

data/db/migrate/20200915131621_add_once_completed_to_indicators.rb

@@ -0,0 +1,5 @@
+class AddOnceCompletedToIndicators < ActiveRecord::Migration[5.1]
+  def change
+    add_column :indicators, :once_completed, :boolean
+  end
+end

data/db/migrate/20201009193949_add_status_updated_fields_to_discussion.rb

@@ -0,0 +1,6 @@
+class AddStatusUpdatedFieldsToDiscussion < ActiveRecord::Migration[5.1]
+  def change
+    add_reference :discussions, :status_updated_by, index: true
+    add_column :discussions, :status_updated_at, :datetime
+  end
+end

data/db/migrate/20201019191036_add_misplaced_flag_to_submission.rb

@@ -0,0 +1,5 @@
+class AddMisplacedFlagToSubmission < ActiveRecord::Migration[5.1]
+  def change
+    add_column :assignments, :misplaced, :boolean
+  end
+end

data/db/migrate/20201026222942_add_display_name_and_description_to_organizations.rb

@@ -0,0 +1,6 @@
+class AddDisplayNameAndDescriptionToOrganizations < ActiveRecord::Migration[5.1]
+  def change
+    add_column :organizations, :display_name, :text
+    add_column :organizations, :display_description, :text
+  end
+end

data/db/migrate/20201026225312_add_organization_wins_page_flag.rb

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

data/db/migrate/20201027134205_add_immersible_to_organization.rb

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

data/lib/mumuki/domain/extensions/array.rb

@@ -2,6 +2,19 @@ class Array
   def insert_last(element)
     self + [element]
   end
+
+  def single
+    first if single?
+  end
+
+  def single!
+    raise 'There is more than one element' unless single?
+    first
+  end
+
+  def single?
+    size == 1
+  end
 end
 
 class NilClass

data/lib/mumuki/domain/factories.rb

@@ -12,8 +12,9 @@ require_relative './factories/guide_factory'
 require_relative './factories/invitation_factory'
 require_relative './factories/lesson_factory'
 require_relative './factories/login_settings_factory'
+require_relative './factories/medal_factory'
 require_relative './factories/message_factory'
 require_relative './factories/organization_factory'
 require_relative './factories/topic_factory'
-require_relative './factories/user_factory'
 require_relative './factories/usage_factory'
+require_relative './factories/user_factory'

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

@@ -0,0 +1,6 @@
+FactoryBot.define do
+  factory :medal do
+    image_url { Faker::Internet.url }
+  end
+end
+

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

@@ -25,6 +25,7 @@ FactoryBot.define do
 
   factory :test_organization, parent: :public_organization do
     name { 'test' }
+    immersible { true }
     book { create(:book, name: 'test', slug: 'mumuki/mumuki-the-book') }
   end
 

data/lib/mumuki/domain/helpers/organization.rb

@@ -28,6 +28,10 @@ module Mumuki::Domain::Helpers::Organization
     name == 'base'
   end
 
+  def immersed_in?(other)
+    immersible? && other.immersive? && target_audience == other.target_audience
+  end
+
   def switch!
     Mumukit::Platform::Organization.switch! self
   end

data/lib/mumuki/domain/helpers/user.rb

@@ -87,8 +87,24 @@ module Mumuki::Domain::Helpers::User
     student_granted_organizations.first || any_granted_organizations.first
   end
 
+  # Deprecated: use `immersive_organization_at` which
+  # properly looks for a single immersive organization taking
+  # current organization and path into account
   def has_immersive_main_organization?
-    !!main_organization.try(&:immersive?)
+    main_organization.try(&:immersive?).present?
+  end
+
+  def immersive_organization_at(path_item, current = Organization.current)
+    immersive_organizations_at(path_item, current).single
+  end
+
+  def immersive_organizations_at(path_item, current = Organization.current)
+    return [] unless current.immersible?
+
+    usage_filter = path_item ? lambda { |it| path_item.used_in?(it) } : lambda { |_| true }
+    student_granted_organizations
+      .select { |it| current.immersed_in?(it) }
+      .select(&usage_filter)
   end
 
   ## API Exposure

data/lib/mumuki/domain/incognito.rb

@@ -48,6 +48,14 @@ module Mumuki::Domain
       false
     end
 
+    def current_immersive_context_at(_)
+      nil
+    end
+
+    def immersive_organizations_at(_)
+      []
+    end
+
     # ========
     # Visiting
     # ========

data/lib/mumuki/domain/locales/activerecord/en.yml

@@ -28,3 +28,5 @@ en:
             base:
               consistent_public_login: 'A public organization can not restrict login methods'
               invalid_activity_range: 'The organization activity range are not valid'
+            immersible:
+              cannot_be_immersive: 'An organization cannot be immersible and immersive at the same time'

data/lib/mumuki/domain/locales/activerecord/es.yml

@@ -45,6 +45,8 @@ es:
             base:
               consistent_public_login: 'Una organización pública no puede restringir los métodos de login'
               invalid_activity_range: 'La fecha de deshabilitación no puede ser anterior a la de inicio del recorrido'
+            immersible:
+              cannot_be_immersive: 'Una organización no puede ser inmersible e inmersiva a la vez'
     models:
       exercise:
         one: Ejercicio

data/lib/mumuki/domain/locales/defaults/en.yml

@@ -0,0 +1,4 @@
+en:
+  defaults:
+    organization:
+      display_description: "In this site you will find programming contents about %{name}"

data/lib/mumuki/domain/locales/defaults/es-CL.yml

@@ -0,0 +1,4 @@
+es-CL:
+  defaults:
+    organization:
+      display_description: "En este sitio encontrarás el contenido sobre programación de %{name}"

data/lib/mumuki/domain/locales/defaults/es.yml

@@ -0,0 +1,4 @@
+es:
+  defaults:
+    organization:
+      display_description: "En este sitio encontrarás el contenido sobre programación de %{name}"

data/lib/mumuki/domain/locales/defaults/pt.yml

@@ -0,0 +1,4 @@
+pt:
+  defaults:
+    organization:
+      display_description: "Neste site você encontrará conteúdos de programação sobre %{name}"

data/lib/mumuki/domain/version.rb

@@ -1,5 +1,5 @@
 module Mumuki
   module Domain
-    VERSION = '7.10.1'
+    VERSION = '7.11.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mumuki-domain
 version: !ruby/object:Gem::Version
-  version: 7.10.1
+  version: 7.11.0
 platform: ruby
 authors:
 - Franco Leonardo Bulgarelli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-05 00:00:00.000000000 Z
+date: 2020-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -252,6 +252,7 @@ files:
 - app/models/chapter.rb
 - app/models/complement.rb
 - app/models/concerns/assistable.rb
+- app/models/concerns/awardee.rb
 - app/models/concerns/container.rb
 - app/models/concerns/contextualization.rb
 - app/models/concerns/disabling.rb
@@ -281,6 +282,7 @@ files:
 - app/models/concerns/with_language.rb
 - app/models/concerns/with_layout.rb
 - app/models/concerns/with_locale.rb
+- app/models/concerns/with_medal.rb
 - app/models/concerns/with_messages.rb
 - app/models/concerns/with_name.rb
 - app/models/concerns/with_number.rb
@@ -315,6 +317,7 @@ files:
 - app/models/invitation.rb
 - app/models/language.rb
 - app/models/lesson.rb
+- app/models/medal.rb
 - app/models/message.rb
 - app/models/organization.rb
 - app/models/progress.rb
@@ -620,6 +623,15 @@ files:
 - db/migrate/20200730221001_add_trusted_for_forum_to_user.rb
 - db/migrate/20200731081757_add_last_moderator_access_fields_to_discussion.rb
 - db/migrate/20200804191643_add_incognito_mode_enabled_to_organization.rb
+- db/migrate/20200828152812_create_medals.rb
+- db/migrate/20200828162829_add_medal_to_content.rb
+- db/migrate/20200915123020_add_polymorphic_avatars_to_users.rb
+- db/migrate/20200915131621_add_once_completed_to_indicators.rb
+- db/migrate/20201009193949_add_status_updated_fields_to_discussion.rb
+- db/migrate/20201019191036_add_misplaced_flag_to_submission.rb
+- db/migrate/20201026222942_add_display_name_and_description_to_organizations.rb
+- db/migrate/20201026225312_add_organization_wins_page_flag.rb
+- db/migrate/20201027134205_add_immersible_to_organization.rb
 - lib/mumuki/domain.rb
 - lib/mumuki/domain/area.rb
 - lib/mumuki/domain/engine.rb
@@ -656,6 +668,7 @@ files:
 - lib/mumuki/domain/factories/invitation_factory.rb
 - lib/mumuki/domain/factories/lesson_factory.rb
 - lib/mumuki/domain/factories/login_settings_factory.rb
+- lib/mumuki/domain/factories/medal_factory.rb
 - lib/mumuki/domain/factories/message_factory.rb
 - lib/mumuki/domain/factories/organization_factory.rb
 - lib/mumuki/domain/factories/topic_factory.rb
@@ -675,6 +688,10 @@ files:
 - lib/mumuki/domain/locales/console_submission/es-CL.yml
 - lib/mumuki/domain/locales/console_submission/es.yml
 - lib/mumuki/domain/locales/console_submission/pt.yml
+- lib/mumuki/domain/locales/defaults/en.yml
+- lib/mumuki/domain/locales/defaults/es-CL.yml
+- lib/mumuki/domain/locales/defaults/es.yml
+- lib/mumuki/domain/locales/defaults/pt.yml
 - lib/mumuki/domain/organization.rb
 - lib/mumuki/domain/organization/profile.rb
 - lib/mumuki/domain/organization/settings.rb