mumuki-domain 7.8.0 → 7.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14a6d0b035451e69ddc77479e3f32854ecae51ca0a3c6bc3031f8d68a4b7fcdd
-  data.tar.gz: a1dbea618e7a152e55417174cecf35a0338a464cd199b02114d524c65c7c23c5
+  metadata.gz: 1182f3c80cde421e92bb67ae1a57313bd3a52bbafbb8d0e8cf0a5696dd067ebc
+  data.tar.gz: 6a6ba4ecaf5f0c7d2dd8b10a9900141ae7cccc527c32e6b55484636ac7c1e117
 SHA512:
-  metadata.gz: d3e2039abf83cd21c0ef3d6b33bcfcef54db1dc7df1eb91fb771ab218076b484b34a4a7c034a1e945d5ab3f84e739fdffbdba05999e2bb1878430af4698e4678
-  data.tar.gz: 1cc3cb4565b4999bfac4f351fffb0d937c28db74c93e26a94267332b9c15ca8812f0bce4c19e2298169a957d008546bde95442a2ca7d798f9912b2bd3c9c39e8
+  metadata.gz: 6e0ab0481ab8cd37417f7d94d18cd73e7f4fb270ff28db3a7ef29f089dde509b34191bf235c1a3945af411c886a3629f3957424a840ff8b6cdbcf71e7fa7d819
+  data.tar.gz: fa2f135124d5d4159e9766e28a71b4fee6ee1a3290c22d37f2230153382e9256e3d15663d6d55af22f7aa9ac65750360b3da10056f0e17f565ca78a8064978a3

data/app/models/assignment.rb

@@ -1,6 +1,7 @@
 class Assignment < Progress
   include Contextualization
   include WithMessages
+  include Gamified
 
   markdown_on :extra_preview
 
@@ -41,6 +42,8 @@ class Assignment < Progress
   alias_method :parent_content, :guide
   alias_method :user, :submitter
 
+  after_initialize :set_default_top_submission_status
+  before_save :award_experience_points!, :update_top_submission!, if: :submission_status_changed?
   after_save :dirty_parent_by_submission!, if: :completion_changed?
   before_validation :set_current_organization!, unless: :organization
 
@@ -49,6 +52,10 @@ class Assignment < Progress
     self.organization = Organization.current
   end
 
+  def set_default_top_submission_status
+    self.top_submission_status ||= 0
+  end
+
   def completion_changed?
     completed_before_last_save? != completed?
   end
@@ -161,7 +168,10 @@ class Assignment < Progress
   end
 
   def to_resource_h
-    as_json(except: %i(exercise_id submission_id organization_id id submitter_id solution created_at updated_at submission_status submitted_at parent_id),
+    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)
+
+    as_json(except: excluded_fields,
               include: {
                 guide: {
                   only: [:slug, :name],
@@ -224,6 +234,10 @@ class Assignment < Progress
     exercise.files_for(current_content)
   end
 
+  def update_top_submission!
+    self.top_submission_status = submission_status unless submission_status.improved_by?(top_submission_status)
+  end
+
   private
 
   def update_submissions_count!

data/app/models/avatar.rb

@@ -1,5 +1,11 @@
 class Avatar < ApplicationRecord
+  include WithTargetAudience
+
+  def self.sample_for(user)
+    with_current_audience_for(user).sample
+  end
+
   def self.sample
-    Avatar.order('RANDOM()').first
+    order('RANDOM()').first
   end
 end

data/app/models/concerns/contextualization.rb

@@ -16,6 +16,7 @@ module Contextualization
   end
 
   included do
+    serialize :top_submission_status, Mumuki::Domain::Status::Submission
     serialize :submission_status, Mumuki::Domain::Status::Submission
     validates_presence_of :submission_status
 

data/app/models/concerns/gamified.rb

@@ -0,0 +1,15 @@
+module Gamified
+  def award_experience_points!
+    points = net_experience
+
+    if points > 0
+      stats = UserStats.stats_for(submitter)
+      stats.add_exp!(points)
+      stats.save!
+    end
+  end
+
+  def net_experience
+    submission_status.exp_given - top_submission_status.exp_given
+  end
+end

data/app/models/concerns/with_reminders.rb

@@ -9,7 +9,7 @@ module WithReminders
   end
 
   def remind!
-    build_reminder.deliver
+    build_reminder.deliver_now
     update! last_reminded_date: Time.now
   end
 

data/app/models/concerns/with_target_audience.rb

@@ -0,0 +1,13 @@
+module WithTargetAudience
+  extend ActiveSupport::Concern
+
+  included do
+    enum target_audience: [:grown_ups, :kids]
+  end
+
+  class_methods do
+    def with_current_audience_for(user)
+      where(target_audience: user.current_audience)
+    end
+  end
+end

data/app/models/organization.rb

@@ -5,6 +5,8 @@ class Organization < ApplicationRecord
 
   include Mumukit::Login::OrganizationHelpers
 
+  include WithTargetAudience
+
   serialize :profile, Mumuki::Domain::Organization::Profile
   serialize :settings, Mumuki::Domain::Organization::Settings
   serialize :theme, Mumuki::Domain::Organization::Theme
@@ -128,6 +130,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

@@ -30,16 +30,15 @@ class User < ApplicationRecord
 
   has_many :exams, through: :exam_authorizations
 
-  after_initialize :init
-
   enum gender: %i(female male other unspecified)
-
   belongs_to :avatar, optional: true
 
   before_validation :set_uid!
   validates :uid, presence: true
 
   after_save :welcome_to_new_organizations!, if: :gained_access_to_new_orga?
+  after_initialize :init
+  PLACEHOLDER_IMAGE_URL = 'user_shape.png'.freeze
 
   resource_fields :uid, :social_id, :email, :permissions, :verified_first_name, :verified_last_name, *profile_fields
 
@@ -147,10 +146,14 @@ class User < ApplicationRecord
     exams.any? { |e| e.in_progress_for? self }
   end
 
-  def profile_picture
+  def custom_profile_picture
     avatar&.image_url || image_url
   end
 
+  def profile_picture
+    custom_profile_picture || placeholder_image_url
+  end
+
   def bury!
     # TODO change avatar
     update! self.class.buried_profile.merge(accepts_reminders: false, gender: nil, birthdate: nil)
@@ -187,6 +190,10 @@ class User < ApplicationRecord
     can_discuss_in? Organization.current
   end
 
+  def can_access_teacher_info_in?(organization)
+    teacher_of?(organization) || organization.teacher_training?
+  end
+
   def name_initials
     name.split.map(&:first).map(&:capitalize).join(' ')
   end
@@ -215,11 +222,25 @@ class User < ApplicationRecord
     false
   end
 
+  def current_audience
+    current_organic_context&.target_audience
+  end
+
+  def placeholder_image_url
+    PLACEHOLDER_IMAGE_URL
+  end
+
+  def age
+    if birthdate.present?
+      @age ||= Time.now.round_years_since(birthdate.to_time)
+    end
+  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?
+      UserMailer.welcome_email(self, organization).deliver_now rescue nil if organization.greet_new_users?
     end
   end
 
@@ -240,7 +261,10 @@ class User < ApplicationRecord
   end
 
   def init
-    self.avatar = Avatar.sample unless profile_picture.present?
+    if custom_profile_picture.blank?
+      self.avatar = Avatar.sample_for(self)
+      save if persisted?
+    end
   end
 
   def self.sync_key_id_field
@@ -265,4 +289,12 @@ 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/app/models/user_stats.rb

@@ -0,0 +1,16 @@
+class UserStats < ApplicationRecord
+  belongs_to :organization
+  belongs_to :user
+
+  def self.stats_for(user)
+    UserStats.find_or_initialize_by(user: user, organization: Organization.current)
+  end
+
+  def self.exp_for(user)
+    self.stats_for(user).exp
+  end
+
+  def add_exp!(points)
+    self.exp += points
+  end
+end

data/db/migrate/20200616160640_create_user_stats.rb

@@ -0,0 +1,10 @@
+class CreateUserStats < ActiveRecord::Migration[5.1]
+  def change
+    create_table :user_stats do |t|
+      t.integer :exp, default: 0
+
+      t.references :user, index: true
+      t.references :organization, index: true
+    end
+  end
+end

data/db/migrate/20200617142217_add_top_submission_status_to_assignments.rb

@@ -0,0 +1,5 @@
+class AddTopSubmissionStatusToAssignments < ActiveRecord::Migration[5.1]
+  def change
+    add_column :assignments, :top_submission_status, :integer
+  end
+end

data/db/migrate/20200717143830_add_target_audience_to_organizations_and_avatars.rb

@@ -0,0 +1,6 @@
+class AddTargetAudienceToOrganizationsAndAvatars < ActiveRecord::Migration[5.1]
+  def change
+    add_column :organizations, :target_audience, :integer, default: 0
+    add_column :avatars, :target_audience, :integer, default: 0
+  end
+end

data/lib/mumuki/domain/extensions.rb

@@ -2,3 +2,4 @@ require_relative './extensions/string'
 require_relative './extensions/array'
 require_relative './extensions/module'
 require_relative './extensions/hash'
+require_relative './extensions/time'

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

@@ -0,0 +1,5 @@
+class Time
+  def round_years_since(another_time)
+    (self.to_s(:number).to_i - another_time.to_s(:number).to_i) / 10e9.to_i
+  end
+end

data/lib/mumuki/domain/factories.rb

@@ -1,5 +1,6 @@
 require_relative './factories/api_client_factory'
 require_relative './factories/assignments_factory'
+require_relative './factories/avatar_factory'
 require_relative './factories/book_factory'
 require_relative './factories/chapter_factory'
 require_relative './factories/complement_factory'
@@ -15,4 +16,4 @@ 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/usage_factory'

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

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

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

@@ -6,6 +6,5 @@ FactoryBot.define do
     last_name { Faker::Name.last_name }
     gender { 1 }
     birthdate { Date.today }
-    avatar { Avatar.new image_url: 'user_shape.png' }
   end
 end

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

@@ -66,6 +66,10 @@ module Mumuki::Domain::Helpers::Organization
       Mumukit::Platform::Organization.current
     end
 
+    def current?
+      Mumukit::Platform::Organization.current?
+    end
+
     def parse(json)
       json
         .slice(:name)

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

@@ -13,6 +13,8 @@ module Mumuki::Domain::Helpers::User
            :protect!,
            :protect_delegation!,
            :protect_permissions_assignment!,
+           :student_granted_organizations,
+           :any_granted_organizations,
            to: :permissions
 
   def platform_class_name
@@ -71,12 +73,10 @@ module Mumuki::Domain::Helpers::User
     "#{full_name} <#{email}> [#{uid}]"
   end
 
-  ## Accesible organizations
+  ## Accessible organizations
 
-  def student_granted_organizations
-    permissions.student_granted_organizations.map do |org|
-      Mumukit::Platform::Organization.find_by_name!(org) rescue nil
-    end.compact
+  revamp_accessor :any_granted_organizations, :student_granted_organizations do |_, _, result|
+    result.map { |org| Mumukit::Platform::Organization.find_by_name!(org) rescue nil }.compact
   end
 
   def has_student_granted_organizations?
@@ -84,11 +84,7 @@ module Mumuki::Domain::Helpers::User
   end
 
   def main_organization
-    student_granted_organizations.first
-  end
-
-  def has_main_organization?
-    student_granted_organizations.length == 1
+    student_granted_organizations.first || any_granted_organizations.first
   end
 
   def has_immersive_main_organization?

data/lib/mumuki/domain/incognito.rb

@@ -40,6 +40,14 @@ module Mumuki::Domain
       false
     end
 
+    def can_discuss_in?(*)
+      false
+    end
+
+    def can_access_teacher_info_in?(*)
+      false
+    end
+
     # ========
     # Visiting
     # ========
@@ -88,6 +96,10 @@ module Mumuki::Domain
       raise "unknown attribute #{key}"
     end
 
+    def new_record?
+      false
+    end
+
     def self.primary_key
       'id'
     end
@@ -105,7 +117,6 @@ module Mumuki::Domain
       assignment.assign_attributes results
       results
     end
-
   end
 
   Incognito = IncognitoClass.new

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

@@ -0,0 +1,59 @@
+---
+es-CL:
+  activerecord:
+    attributes:
+      exercise:
+        description: Descripción
+        extra: Biblioteca
+        hint: Ayudas
+        language: Lenguaje
+        locale: Idioma
+        tag_list: Etiquetas
+        title: Título
+      guide:
+        description: Descripción
+        github_repository: Repositorio Github
+        language: Lenguaje
+        locale: Idioma
+        name: Nombre
+      submission:
+        content: Contenido
+    errors:
+      models:
+        guide:
+          attributes:
+            base:
+              in_use: 'La guía aún está siendo utilizada en la organización %{organization}'
+        topic:
+          attributes:
+            base:
+              in_use: 'El tema aún está siendo utilizado en la organización %{organization}'
+        exercise:
+          attributes:
+            randomizations:
+              invalid_format: 'formato inválido'
+            own_expectations:
+              invalid_format: 'formato inválido'
+            assistance_rules:
+              invalid_format: 'formato inválido'
+            name:
+              invalid_format: 'no debe contener /'
+            base:
+              evaluation_criteria_required:  'Tienes que proveer tests y/o expectativas'
+        organization:
+          attributes:
+            base:
+              consistent_public_login: 'Una organización pública no puede restringir los métodos de login'
+              invalid_activity_range: 'La fecha de inhabilitación no puede ser anterior a la de inicio del recorrido'
+    models:
+      exercise:
+        one: Ejercicio
+        other: Ejercicios
+      chapter:
+        one: Capítulo
+        other: Capítulos
+      guide: Guía
+      language: Lenguaje
+      submission:
+        one: Solución
+        other: Soluciones

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

@@ -0,0 +1,3 @@
+es-CL:
+  console_submission:
+    try_again: ¡Ups! Algo salió mal en mumuki. Reinicia el ejercicio, espera unos segundos y vuelve a intentar.

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

@@ -12,7 +12,8 @@ class Mumuki::Domain::Organization::Profile < Mumukit::Platform::Model
                       :terms_of_service,
                       :community_link,
                       :errors_explanations,
-                      :welcome_email_template
+                      :welcome_email_template,
+                      :welcome_email_sender
 
   def locale_json
     locale_h.to_json

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

@@ -8,6 +8,7 @@ class Mumuki::Domain::Organization::Settings < Mumukit::Platform::Model
                       :forum_enabled?,
                       :forum_only_for_trusted?,
                       :gamification_enabled?,
+                      :greet_new_users?,
                       :immersive?,
                       :in_preparation_until,
                       :login_methods,
@@ -16,7 +17,7 @@ class Mumuki::Domain::Organization::Settings < Mumukit::Platform::Model
                       :public?,
                       :raise_hand_enabled?,
                       :report_issue_enabled?,
-                      :greet_new_users?
+                      :teacher_training?
 
   def private?
     !public?
@@ -30,11 +31,19 @@ class Mumuki::Domain::Organization::Settings < Mumukit::Platform::Model
     (@forum_discussions_minimal_role || 'student').to_sym
   end
 
+  def disabled_from=(disabled_from)
+    @disabled_from = disabled_from&.to_time
+  end
+
+  def in_preparation_until=(in_preparation_until)
+    @in_preparation_until = in_preparation_until&.to_time
+  end
+
   def disabled?
-    disabled_from.present? && disabled_from.to_datetime < DateTime.now
+    disabled_from.present? && disabled_from < Time.now
   end
 
   def in_preparation?
-    in_preparation_until.present? && in_preparation_until.to_datetime > DateTime.now
+    in_preparation_until.present? && in_preparation_until > Time.now
   end
 end

data/lib/mumuki/domain/status/submission/passed.rb

@@ -8,4 +8,8 @@ module Mumuki::Domain::Status::Submission::Passed
   def self.iconize
     {class: :success, type: 'check-circle'}
   end
+
+  def self.exp_given
+    100
+  end
 end

data/lib/mumuki/domain/status/submission/passed_with_warnings.rb

@@ -12,4 +12,8 @@ module Mumuki::Domain::Status::Submission::PassedWithWarnings
   def self.iconize
     {class: :warning, type: 'exclamation-circle'}
   end
+
+  def self.exp_given
+    50
+  end
 end

data/lib/mumuki/domain/status/submission/skipped.rb

@@ -8,4 +8,8 @@ module Mumuki::Domain::Status::Submission::Skipped
   def self.iconize
     {class: :success, type: 'check-circle'}
   end
+
+  def self.exp_given
+    100
+  end
 end

data/lib/mumuki/domain/status/submission/submission.rb

@@ -42,4 +42,12 @@ module Mumuki::Domain::Status::Submission
   def solved?
     passed? || skipped?
   end
+
+  def improved_by?(status)
+    self.exp_given < status.exp_given
+  end
+
+  def exp_given
+    0
+  end
 end

data/lib/mumuki/domain/version.rb

@@ -1,5 +1,5 @@
 module Mumuki
   module Domain
-    VERSION = '7.8.0'
+    VERSION = '7.10.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mumuki-domain
 version: !ruby/object:Gem::Version
-  version: 7.8.0
+  version: 7.10.0
 platform: ruby
 authors:
 - Franco Leonardo Bulgarelli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-28 00:00:00.000000000 Z
+date: 2020-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: mumukit-sync
   requirement: !ruby/object:Gem::Requirement
@@ -256,6 +256,7 @@ files:
 - app/models/concerns/contextualization.rb
 - app/models/concerns/disabling.rb
 - app/models/concerns/friendly_name.rb
+- app/models/concerns/gamified.rb
 - app/models/concerns/guide_container.rb
 - app/models/concerns/navigation/parent_navigation.rb
 - app/models/concerns/navigation/siblings_navigation.rb
@@ -292,6 +293,7 @@ files:
 - app/models/concerns/with_scoped_queries/page.rb
 - app/models/concerns/with_scoped_queries/sort.rb
 - app/models/concerns/with_slug.rb
+- app/models/concerns/with_target_audience.rb
 - app/models/concerns/with_usages.rb
 - app/models/concerns/with_user_navigation.rb
 - app/models/content.rb
@@ -322,6 +324,7 @@ files:
 - app/models/upvote.rb
 - app/models/usage.rb
 - app/models/user.rb
+- app/models/user_stats.rb
 - app/models/with_stats.rb
 - db/migrate/20141120231135_create_exercises.rb
 - db/migrate/20141120231735_create_submissions.rb
@@ -608,7 +611,10 @@ files:
 - db/migrate/20200601203033_add_course_to_exam.rb
 - db/migrate/20200605161350_add_passing_criterions_to_exam.rb
 - db/migrate/20200608132959_add_progressive_display_lookahead_to_organizations.rb
+- db/migrate/20200616160640_create_user_stats.rb
+- db/migrate/20200617142217_add_top_submission_status_to_assignments.rb
 - db/migrate/20200702165503_add_messages_count_to_discussion.rb
+- db/migrate/20200717143830_add_target_audience_to_organizations_and_avatars.rb
 - db/migrate/20200728162727_add_not_actually_a_question_field_to_messages.rb
 - db/migrate/20200728163038_add_requires_moderator_response_to_discussions.rb
 - db/migrate/20200730221001_add_trusted_for_forum_to_user.rb
@@ -634,9 +640,11 @@ files:
 - lib/mumuki/domain/extensions/hash.rb
 - lib/mumuki/domain/extensions/module.rb
 - lib/mumuki/domain/extensions/string.rb
+- lib/mumuki/domain/extensions/time.rb
 - lib/mumuki/domain/factories.rb
 - lib/mumuki/domain/factories/api_client_factory.rb
 - lib/mumuki/domain/factories/assignments_factory.rb
+- lib/mumuki/domain/factories/avatar_factory.rb
 - lib/mumuki/domain/factories/book_factory.rb
 - lib/mumuki/domain/factories/chapter_factory.rb
 - lib/mumuki/domain/factories/complement_factory.rb
@@ -660,9 +668,11 @@ files:
 - lib/mumuki/domain/helpers/user.rb
 - lib/mumuki/domain/incognito.rb
 - lib/mumuki/domain/locales/activerecord/en.yml
+- lib/mumuki/domain/locales/activerecord/es-CL.yml
 - lib/mumuki/domain/locales/activerecord/es.yml
 - lib/mumuki/domain/locales/activerecord/pt.yml
 - lib/mumuki/domain/locales/console_submission/en.yml
+- 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/organization.rb