mumuki-domain 7.4.1 → 7.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68dc581849f150d3c0a958f3a1df2b25b4959b3ee71a595364cf2ac7533fbd25
-  data.tar.gz: dc6a6e467c80e08d035ccc70c7ace81ffdabb41088564350220f76706738332a
+  metadata.gz: 4e4bc7628cef1eb1a3d8ed748fc2fd8c49830ffd9814058360aa324aa6bcde35
+  data.tar.gz: c32ffaac2a2cef4a4e7f71ded9c4f81f233db86f55a1a0d7a67bdda0792c9489
 SHA512:
-  metadata.gz: d852df438a75e07817d1b01769559faf0a68b7c892a4423b7ee0a97a04153439388904b544a19562597015c2f613596a8236d87205aedaf86304d9141f7992ea
-  data.tar.gz: aeb1db5771206c8de35da5e9d03395f5029ce7dcec4d5b643d65365f4d1ef01e5159ffc66038bc056300bc9f9f103549ff029bcbb7b22c08fc2b47270b7aecb8
+  metadata.gz: ce2e45ade3b54b53eec50718f7e42ef1f6cc51d9aa39706651c3cbd6e9d156b043c300d9d19e333e4ecf5955b5d2e915fe4aa0162830983e92d37892bca5f952
+  data.tar.gz: f3b7a44f946871521a943efbccd3d3d24594cfda1eb2493f6be706ab65738ca90334da2b3c1c5521a9936ad9a58c2856bb132c2e71dd0a440a72ed9914832dd1

data/app/models/assignment.rb

@@ -168,7 +168,7 @@ class Assignment < Progress
                     language: {only: [:name]}},
                 },
                 exercise: {only: [:name, :number]},
-                submitter: {only: [:email, :image_url, :social_id, :uid], methods: [:name]}}).
+                submitter: {only: [:email, :social_id, :uid], methods: [:name, :profile_picture]}}).
       deep_merge(
         'organization' => Organization.current.name,
         'sid' => submission_id,

data/app/models/avatar.rb

@@ -0,0 +1,5 @@
+class Avatar < ApplicationRecord
+  def self.sample
+    Avatar.order('RANDOM()').first
+  end
+end

data/app/models/concerns/contextualization.rb

@@ -35,12 +35,34 @@ module Contextualization
     end
   end
 
+  # deprecated: this method does hidden assumptions about the UI not wanting
+  # non-empty titles to not be displayed. Also it incorrectly uses the term `visual` instead of `visible`
   def single_visual_result?
-    test_results.size == 1 && test_results.first[:title].blank? && visible_success_output?
+    warn 'use single_visible_test_result? instead'
+    single_visible_test_result? && first_test_result[:title].blank?
   end
 
+  # deprecated: this method does not validate nor depends on any `visible` condition
+  # Also, it incorrectly uses the term `visual` instead of `visible`
   def single_visual_result_html
-    output_content_type.to_html test_results.first[:result]
+    warn 'use first_test_result_html intead'
+    first_test_result_html
+  end
+
+  def single_visible_test_result?
+    test_results.size == 1 && visible_success_output?
+  end
+
+  def first_test_result
+    test_results.first
+  end
+
+  def first_test_result_html
+    test_result_html first_test_result
+  end
+
+  def test_result_html(test_result)
+    output_content_type.to_html test_result[:result]
   end
 
   def results_body_hidden?
@@ -76,6 +98,7 @@ module Contextualization
   end
 
   def humanized_expectation_results
+    warn "Don't use humanized_expectation_results. Use affable_expectation_results, which also handles markdown and sanitization"
     visible_expectation_results.map do |it|
       {
         result: it[:result],
@@ -83,4 +106,32 @@ module Contextualization
       }
     end
   end
+
+  ####################
+  ## Affable results
+  ####################
+
+  def affable_expectation_results
+    visible_expectation_results.map do |it|
+      {
+        result: it[:result],
+        explanation: Mulang::Expectation.parse(it).translate(inspection_keywords).affable
+      }
+    end
+  end
+
+  def affable_tips
+    tips.map(&:affable)
+  end
+
+  def affable_test_results
+    test_results.to_a.map do |it|
+      { summary: it.dig(:summary, :message).affable }
+        .compact
+        .merge(
+          title: it[:title].affable,
+          result: it[:result].sanitized,
+          status: it[:status])
+    end
+  end
 end

data/app/models/concerns/disabling.rb

@@ -0,0 +1,37 @@
+# The disposable module is a soft-delete helper that:
+#
+#  * adds `disable!` method that set a `disabled_at` attribute and then _buries_ the object
+#  * adds a `bury!`  hook method that allows further modification when disabling
+#  * aliases `destroy!` and `destroy` to `disable!`, but still keeps `delete` and friends
+#
+module Disabling
+  extend ActiveSupport::Concern
+
+  def disable!
+    transaction do
+      update_attribute :disabled_at, Time.current
+      bury!
+    end
+  end
+
+  def disabled?
+    disabled_at.present?
+  end
+
+  def enabled?
+    !disabled?
+  end
+
+  # override to perform additional
+  # post-disable actions
+  def bury!
+  end
+
+  def ensure_enabled!
+    raise Mumuki::Domain::DisabledError if disabled?
+  end
+
+  alias_method :destroy!,  :disable!
+  alias_method :destroy,   :disable!
+end
+

data/app/models/concerns/with_editor.rb

@@ -19,7 +19,7 @@ module WithEditor
       struct id: "content_choice_#{index}",
              index: index,
              value: choice,
-             text: Mumukit::ContentType::Markdown.to_html(choice_text(choice))
+             text: choice_text(choice).markdownified
     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/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/user.rb

@@ -4,6 +4,7 @@ class User < ApplicationRecord
           WithUserNavigation,
           WithReminders,
           WithDiscussionCreation,
+          Disabling,
           Mumuki::Domain::Helpers::User
 
   serialize :permissions, Mumukit::Auth::Permissions
@@ -33,10 +34,12 @@ class User < ApplicationRecord
 
   enum gender: %i(female male other)
 
+  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,15 @@ 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
+
   private
 
   def set_uid!
@@ -145,6 +161,9 @@ class User < ApplicationRecord
   end
 
   def init
+    # Temporarily keep using image_url until avatars are created
+    # self.avatar = Avatar.sample unless profile_picture.present?
+
     self.image_url ||= "user_shape.png"
   end
 
@@ -160,4 +179,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

data/db/migrate/20200508191543_create_avatars.rb

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

data/db/migrate/20200518135658_add_avatar_to_users.rb

@@ -0,0 +1,5 @@
+class AddAvatarToUsers < ActiveRecord::Migration[5.1]
+  def change
+    add_reference :users, :avatar, index: false
+  end
+end

data/db/migrate/20200527180729_add_disabled_at_to_users.rb

@@ -0,0 +1,6 @@
+class AddDisabledAtToUsers < ActiveRecord::Migration[5.1]
+  def change
+    add_column :users, :disabled_at, :datetime
+    add_index :users, :disabled_at
+  end
+end

data/lib/mumuki/domain/exceptions.rb

@@ -2,4 +2,5 @@ require_relative './exceptions/forbidden_error'
 require_relative './exceptions/gone_error'
 require_relative './exceptions/not_found_error'
 require_relative './exceptions/unauthorized_error'
+require_relative './exceptions/disabled_error'
 require_relative './exceptions/blocked_forum_error'

data/lib/mumuki/domain/exceptions/disabled_error.rb

@@ -0,0 +1,2 @@
+class Mumuki::Domain::DisabledError < StandardError
+end

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

@@ -1,5 +1,14 @@
 class Hash
-  def markdownify!(*keys)
-    keys.each { |it| self[it] = Mumukit::ContentType::Markdown.to_html(self[it]) }
+  def markdownify!(*keys, **options)
+    warn "Don't use markdownify. Use markdownified! instead"
+    markdownified! *keys, **options
+  end
+
+  def markdownified!(*keys, **options)
+    keys.each { |it| self[it] = self[it].markdownified(**options) }
+  end
+
+  def markdownified(*keys, **options)
+    map { |k, v| key.in?(keys) ? v.markdownified(options) : v }.to_h
   end
 end

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

@@ -27,3 +27,47 @@ class String
     File.extname(self).delete '.'
   end
 end
+
+
+# The nil-safe affable pipeline goes as follow:
+#
+# i18n > markdownified > sanitized > affable
+#
+# Where:
+#  * i18n: translates to current locale
+#  * markdownified: interpretes markdown in message and generates HTML
+#  * sanitized: sanitizes results HTML
+#  * affable: changes structure to hide low level details
+#
+# Other classes may polymorphically implement their own
+# markdownified, sanitized and affable methods with similar semantics
+# to extend this pipeline to non-strings
+class String
+
+  # Creates a humman representation - but not necessary UI - representation
+  # of this string by interpreting its markdown as a one-liner and sanitizing it
+  def affable
+    markdownified(one_liner: true).sanitized
+  end
+
+  # Interprets the markdown on this string, and converts it into HTML
+  def markdownified(**options)
+    Mumukit::ContentType::Markdown.to_html self, options
+  end
+
+  # Sanitizes this string, escaping unsafe HTML sequences
+  def sanitized
+    Mumukit::ContentType::Sanitizer.sanitize self
+  end
+end
+
+class NilClass
+  def affable
+  end
+
+  def markdownified(**options)
+  end
+
+  def sanitized
+  end
+end

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

@@ -1,7 +1,7 @@
 FactoryBot.define do
   factory :book do
-    name { Faker::Lorem.sentence(3) }
-    description { Faker::Lorem.sentence(30) }
+    name { Faker::Lorem.sentence(word_count: 3) }
+    description { Faker::Lorem.sentence(word_count: 30) }
     slug { "mumuki/mumuki-test-book-#{SecureRandom.uuid}" }
   end
 end

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

@@ -1,12 +1,12 @@
 FactoryBot.define do
 
   factory :chapter do
-    number { Faker::Number.between(1, 40) }
+    number { Faker::Number.between(from: 1, to: 40) }
     book { Organization.current.book rescue nil }
 
     transient do
       lessons { [] }
-      name { Faker::Lorem.sentence(3) }
+      name { Faker::Lorem.sentence(word_count: 3) }
       slug { "mumuki/mumuki-test-topic-#{SecureRandom.uuid}" }
     end
 

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

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

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

@@ -11,8 +11,8 @@ FactoryBot.define do
   trait :guide_container do
     transient do
       exercises { [] }
-      name { Faker::Lorem.sentence(3) }
-      description { Faker::Lorem.sentence(10) }
+      name { Faker::Lorem.sentence(word_count: 3) }
+      description { Faker::Lorem.sentence(word_count: 10) }
       language { create(:language) }
       slug { "mumuki/mumuki-test-lesson-#{SecureRandom.uuid}" }
     end

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

@@ -1,6 +1,6 @@
 FactoryBot.define do
   factory :invitation do
-    code { Faker::Lorem.sentence(6) }
+    code { Faker::Lorem.sentence(word_count: 6) }
     course { "foo/bar" }
     expiration_date { 5.minutes.since }
   end

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

@@ -1,8 +1,8 @@
 FactoryBot.define do
 
   factory :topic do
-    name { Faker::Lorem::sentence(3) }
-    description { Faker::Lorem.paragraph(2) }
+    name { Faker::Lorem::sentence(word_count: 3) }
+    description { Faker::Lorem.paragraph(sentence_count: 2) }
     slug { "mumuki/mumuki-sample-topic-#{SecureRandom.uuid}" }
     locale { :en }
   end

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

@@ -6,5 +6,6 @@ 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/user.rb

@@ -58,7 +58,7 @@ module Mumuki::Domain::Helpers::User
   ## Profile
 
   def full_name
-    "#{first_name} #{last_name}"
+    "#{first_name} #{last_name}".strip
   end
 
   alias_method :name, :full_name

data/lib/mumuki/domain/version.rb

@@ -1,5 +1,5 @@
 module Mumuki
   module Domain
-    VERSION = '7.4.1'
+    VERSION = '7.5.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mumuki-domain
 version: !ruby/object:Gem::Version
-  version: 7.4.1
+  version: 7.5.0
 platform: ruby
 authors:
 - Franco Leonardo Bulgarelli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-23 00:00:00.000000000 Z
+date: 2020-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: mumukit-content-type
   requirement: !ruby/object:Gem::Requirement
@@ -247,11 +247,13 @@ files:
 - app/models/api_client.rb
 - app/models/application_record.rb
 - app/models/assignment.rb
+- app/models/avatar.rb
 - app/models/book.rb
 - app/models/chapter.rb
 - app/models/complement.rb
 - app/models/concerns/assistable.rb
 - app/models/concerns/contextualization.rb
+- app/models/concerns/disabling.rb
 - app/models/concerns/friendly_name.rb
 - app/models/concerns/guide_container.rb
 - app/models/concerns/navigation/parent_navigation.rb
@@ -599,6 +601,9 @@ files:
 - db/migrate/20200127142401_add_private_to_topics_and_books.rb
 - db/migrate/20200213175736_add_verified_names_to_users.rb
 - db/migrate/20200312181842_add_results_hidden_for_choices_to_exam.rb
+- db/migrate/20200508191543_create_avatars.rb
+- db/migrate/20200518135658_add_avatar_to_users.rb
+- db/migrate/20200527180729_add_disabled_at_to_users.rb
 - lib/mumuki/domain.rb
 - lib/mumuki/domain/engine.rb
 - lib/mumuki/domain/evaluation.rb
@@ -606,6 +611,7 @@ files:
 - lib/mumuki/domain/evaluation/manual.rb
 - lib/mumuki/domain/exceptions.rb
 - lib/mumuki/domain/exceptions/blocked_forum_error.rb
+- lib/mumuki/domain/exceptions/disabled_error.rb
 - lib/mumuki/domain/exceptions/forbidden_error.rb
 - lib/mumuki/domain/exceptions/gone_error.rb
 - lib/mumuki/domain/exceptions/not_found_error.rb