mumuki-domain 7.5.1 → 7.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ef144a131abd81dec63a202e154365daa60a369f157f3dacd86fae7b6b078c7
-  data.tar.gz: f3b58dde606295d1e3c5edc5c901259bfff933570927e66fb112c58f062fcc7d
+  metadata.gz: 40391bc2dcc0ab54965e1d82a289c8960dac3f68cf4c8fb2a3d097e774b899b4
+  data.tar.gz: 205ce356bcc3365491551226eaa2b076ae58d7ac1255fb51294424b419ea4ffb
 SHA512:
-  metadata.gz: c6d190e5ebdb654e7be93ddd9b5b3938e67fc334d8dfe0ac769aa62cb44ec8e8acc1fefde7a5418a0b9fc01f07d2956ab5464025e0b7cf953d1c983a1c6a942c
-  data.tar.gz: 647aa6b8fbd360d2cc5a306dcc58ad148316aa5c6ed3a893fe08e11462e732075d9775dc6c038f9dca03c7dac3ad2236f81f74b05a06473fa93f3ea53331a953
+  metadata.gz: 3741ef7ad7daf3f6cfc2d829d8fbf336512e4ec719257734d2e3bcc0b960081a6c50bdc3f31e2c82dc59abbc1d2d1719ab68ace80ec8c7ff1a908613b1123409
+  data.tar.gz: cf4e192e33fcdd94f68398f074715b22088169d50b88acc9d1aa0457bb15850a8288f2280ecbcf5aec874dd8c85f01c952a430762113fe5a383c19816bcbb5c2

data/app/models/book.rb

@@ -62,4 +62,17 @@ class Book < Content
   def structural_parent
     nil
   end
+
+  ## progressive display
+
+  def enabled_chapters_in(workspace)
+    workspace.enabled_containers(chapters)
+  end
+
+  # experimental API - it may change in the future.
+  # This method assumes no gaps in the sequences are introduced
+  # by enabled_chapters_in
+  def chapter_visibilities_in(workspace)
+    chapters.zip(enabled_chapters_in(workspace)).map { |chapter, enabled| [chapter, !enabled.nil?] }
+  end
 end

data/app/models/concerns/{with_content.rb → container.rb}

@@ -1,4 +1,4 @@
-module WithContent
+module Container
   extend ActiveSupport::Concern
 
   included do

data/app/models/concerns/guide_container.rb

@@ -1,6 +1,6 @@
 module GuideContainer
   extend ActiveSupport::Concern
-  include WithContent
+  include Container
 
   included do
     associated_content :guide

data/app/models/concerns/topic_container.rb

@@ -1,6 +1,6 @@
 module TopicContainer
   extend ActiveSupport::Concern
-  include WithContent
+  include Container
 
   included do
     associated_content :topic

data/app/models/concerns/with_progress.rb

@@ -19,6 +19,10 @@ module WithProgress
     self
   end
 
+  def completed_for?(user, organization)
+    progress_for(user, organization).completed?
+  end
+
   private
 
   def structural_children_changed?(old_structural_children)

data/app/models/course.rb

@@ -1,6 +1,7 @@
 class Course < ApplicationRecord
   include Mumuki::Domain::Syncable
   include Mumuki::Domain::Helpers::Course
+  include Mumuki::Domain::Area
 
   validates_presence_of :slug, :shifts, :code, :days, :period, :description, :organization_id
   validates_uniqueness_of :slug
@@ -48,4 +49,8 @@ class Course < ApplicationRecord
   def self.sync_key_id_field
     :slug
   end
+
+  def to_organization
+    organization
+  end
 end

data/app/models/organization.rb

@@ -1,6 +1,7 @@
 class Organization < ApplicationRecord
   include Mumuki::Domain::Syncable
   include Mumuki::Domain::Helpers::Organization
+  include Mumuki::Domain::Area
 
   include Mumukit::Login::OrganizationHelpers
 
@@ -11,6 +12,7 @@ class Organization < ApplicationRecord
   markdown_on :description
 
   validate :ensure_consistent_public_login
+  validate :ensure_valid_activity_range
 
   belongs_to :book
   has_many :usages
@@ -126,12 +128,26 @@ class Organization < ApplicationRecord
     super.merge(book: book.slug)
   end
 
+  def to_organization
+    self
+  end
+
+  def enable_progressive_display!(lookahead: 1)
+    update! progressive_display_lookahead: lookahead
+  end
+
   private
 
   def ensure_consistent_public_login
     errors.add(:base, :consistent_public_login) if settings.customized_login_methods? && public?
   end
 
+  def ensure_valid_activity_range
+    if in_preparation_until.present? && disabled_from.present?
+      errors.add(:base, :invalid_activity_range) if in_preparation_until.to_datetime >= disabled_from.to_datetime
+    end
+  end
+
   def notify_assignments!(assignments)
     assignments.each { |assignment| assignment.notify! }
   end

data/app/models/user.rb

@@ -154,6 +154,21 @@ class User < ApplicationRecord
     update! self.class.buried_profile.merge(accepts_reminders: false, gender: nil, birthdate: nil)
   end
 
+  # Takes a didactic - ordered - sequence of content containers
+  # and returns those that have been completed
+  def completed_containers(sequence, organization)
+    sequence.take_while { |it| it.content.completed_for?(self, organization) }
+  end
+
+  # Like `completed_containers`, returns a slice of the completed containers
+  # in the sequence, but adding a configurable number of trailing, non-completed contaienrs
+  def completed_containers_with_lookahead(sequence, organization, lookahead: 1)
+    raise 'invalid lookahead' if lookahead < 1
+
+    count = completed_containers(sequence, organization).size
+    sequence[0..count + lookahead - 1]
+  end
+
   private
 
   def set_uid!

data/db/migrate/20200608132959_add_progressive_display_lookahead_to_organizations.rb

@@ -0,0 +1,5 @@
+class AddProgressiveDisplayLookaheadToOrganizations < ActiveRecord::Migration[5.1]
+  def change
+    add_column :organizations, :progressive_display_lookahead, :integer
+  end
+end

data/lib/mumuki/domain.rb

@@ -25,6 +25,7 @@ Mumukit::Platform.configure do |config|
   config.organization_class_name = 'Organization'
 end
 
+require_relative './domain/area'
 require_relative './domain/evaluation'
 require_relative './domain/submission'
 require_relative './domain/status'
@@ -32,6 +33,7 @@ require_relative './domain/exceptions'
 require_relative './domain/file'
 require_relative './domain/extensions'
 require_relative './domain/organization'
+require_relative './domain/workspace'
 require_relative './domain/helpers'
 require_relative './domain/syncable'
 require_relative './domain/store'

data/lib/mumuki/domain/area.rb

@@ -0,0 +1,13 @@
+module Mumuki::Domain::Area
+  extend ActiveSupport::Concern
+
+  def to_mumukit_grant
+    slug.to_mumukit_grant
+  end
+
+  def to_mumukit_slug
+    slug
+  end
+
+  required :to_organization
+end

data/lib/mumuki/domain/exceptions.rb

@@ -4,3 +4,5 @@ require_relative './exceptions/not_found_error'
 require_relative './exceptions/unauthorized_error'
 require_relative './exceptions/disabled_error'
 require_relative './exceptions/blocked_forum_error'
+require_relative './exceptions/unprepared_organization_error'
+require_relative './exceptions/disabled_organization_error'

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

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

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

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

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

@@ -4,7 +4,7 @@ module Mumuki::Domain::Helpers::Organization
 
   included do
     delegate *Mumuki::Domain::Organization::Theme.accessors, to: :theme
-    delegate *Mumuki::Domain::Organization::Settings.accessors, :private?, :login_settings, to: :settings
+    delegate *Mumuki::Domain::Organization::Settings.accessors, :private?, :login_settings, :in_preparation?, :disabled?, to: :settings
     delegate *Mumuki::Domain::Organization::Profile.accessors, :locale_json, to: :profile
   end
 
@@ -48,6 +48,11 @@ module Mumuki::Domain::Helpers::Organization
     Mumukit::Platform.application.organic_domain(name)
   end
 
+  def validate_active!
+    raise Mumuki::Domain::DisabledOrganizationError if disabled?
+    raise Mumuki::Domain::UnpreparedOrganizationError if in_preparation?
+  end
+
   ## API Exposure
 
   def to_param

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

@@ -28,9 +28,9 @@ module Mumuki::Domain::Helpers::User
     role_here = "#{role}_here?"
 
     # Tells whether this user has #{role} permissions in
-    # the given organization
-    define_method role_of do |organization|
-      has_permission? role, organization.slug
+    # the given `slug_like`
+    define_method role_of do |slug_like|
+      has_permission? role, slug_like.to_mumukit_slug
     end
 
     # Tells whether this user has #{role} permissions in
@@ -49,9 +49,9 @@ module Mumuki::Domain::Helpers::User
   (Mumukit::Auth::Roles::ROLES - [:owner]).each do |role|
 
     # Assignes the #{role} role to this user
-    # for the given slug
-    define_method "make_#{role}_of!" do |slug|
-      add_permission! role, slug
+    # for the given `grant_like`
+    define_method "make_#{role}_of!" do |grant_like|
+      add_permission! role, grant_like.to_mumukit_grant
     end
   end
 

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

@@ -27,3 +27,4 @@ en:
           attributes:
             base:
               consistent_public_login: 'A public organization can not restrict login methods'
+              invalid_activity_range: 'The organization activity range are not valid'

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

@@ -44,6 +44,7 @@ es:
           attributes:
             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'
     models:
       exercise:
         one: Ejercicio

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

@@ -27,3 +27,4 @@ pt:
           attributes:
             base:
               consistent_public_login: 'Uma organização pública não pode restringir métodos de login'
+              invalid_activity_range: 'O intervalo de atividades da organização não é válido'

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

@@ -11,7 +11,9 @@ class Mumuki::Domain::Organization::Settings < Mumukit::Platform::Model
                       :embeddable?,
                       :immersive?,
                       :forum_enabled?,
-                      :report_issue_enabled?
+                      :report_issue_enabled?,
+                      :disabled_from,
+                      :in_preparation_until
 
   def private?
     !public?
@@ -24,4 +26,12 @@ class Mumuki::Domain::Organization::Settings < Mumukit::Platform::Model
   def forum_discussions_minimal_role
     (@forum_discussions_minimal_role || 'student').to_sym
   end
+
+  def disabled?
+    disabled_from.present? && disabled_from.to_datetime < DateTime.now
+  end
+
+  def in_preparation?
+    in_preparation_until.present? && in_preparation_until.to_datetime > DateTime.now
+  end
 end

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

@@ -41,4 +41,8 @@ module Mumuki::Domain::Status::Discussion
   def allowed_statuses_for(user, discussion)
     STATUSES.select { |it| it.allowed_for?(user, discussion) }
   end
+
+  def as_json(_options={})
+    to_s
+  end
 end

data/lib/mumuki/domain/version.rb

@@ -1,5 +1,5 @@
 module Mumuki
   module Domain
-    VERSION = '7.5.1'
+    VERSION = '7.6.0'
   end
 end

data/lib/mumuki/domain/workspace.rb

@@ -0,0 +1,38 @@
+class Mumuki::Domain::Workspace
+  attr_accessor :user, :area
+
+  # area is a organization-like or course-like object
+  # that can be converted into slugs, has content and access-rules information
+  def initialize(user, area)
+    @user = user
+    @area = area
+  end
+
+  def annonymous?
+    user.nil?
+  end
+
+  def teacher?
+    user.teacher_of? area
+  end
+
+  # Takes a didactic sequence of containers and retuns the enabled containers
+  # for this user in this workspace.
+  #
+  # This method does not check the user is actually member of the area,
+  # you should check that before sending this message
+  #
+  def enabled_containers(sequence)
+    return sequence if annonymous? || teacher?
+
+    # TODO refactor when introducing access rules
+    if area.progressive_display_lookahead
+      user.completed_containers_with_lookahead(
+        sequence,
+        area.to_organization,
+        lookahead: area.progressive_display_lookahead)
+    else
+      sequence
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mumuki-domain
 version: !ruby/object:Gem::Version
-  version: 7.5.1
+  version: 7.6.0
 platform: ruby
 authors:
 - Franco Leonardo Bulgarelli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-05 00:00:00.000000000 Z
+date: 2020-06-15 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/container.rb
 - app/models/concerns/contextualization.rb
 - app/models/concerns/disabling.rb
 - app/models/concerns/friendly_name.rb
@@ -268,7 +269,6 @@ files:
 - app/models/concerns/topic_container.rb
 - app/models/concerns/with_assignments.rb
 - app/models/concerns/with_case_insensitive_search.rb
-- app/models/concerns/with_content.rb
 - app/models/concerns/with_description.rb
 - app/models/concerns/with_discussion_creation.rb
 - app/models/concerns/with_discussion_creation/subscription.rb
@@ -604,7 +604,9 @@ files:
 - db/migrate/20200508191543_create_avatars.rb
 - db/migrate/20200518135658_add_avatar_to_users.rb
 - db/migrate/20200527180729_add_disabled_at_to_users.rb
+- db/migrate/20200608132959_add_progressive_display_lookahead_to_organizations.rb
 - lib/mumuki/domain.rb
+- lib/mumuki/domain/area.rb
 - lib/mumuki/domain/engine.rb
 - lib/mumuki/domain/evaluation.rb
 - lib/mumuki/domain/evaluation/automated.rb
@@ -612,10 +614,12 @@ files:
 - lib/mumuki/domain/exceptions.rb
 - lib/mumuki/domain/exceptions/blocked_forum_error.rb
 - lib/mumuki/domain/exceptions/disabled_error.rb
+- lib/mumuki/domain/exceptions/disabled_organization_error.rb
 - lib/mumuki/domain/exceptions/forbidden_error.rb
 - lib/mumuki/domain/exceptions/gone_error.rb
 - lib/mumuki/domain/exceptions/not_found_error.rb
 - lib/mumuki/domain/exceptions/unauthorized_error.rb
+- lib/mumuki/domain/exceptions/unprepared_organization_error.rb
 - lib/mumuki/domain/extensions.rb
 - lib/mumuki/domain/extensions/array.rb
 - lib/mumuki/domain/extensions/hash.rb
@@ -690,6 +694,7 @@ files:
 - lib/mumuki/domain/syncable.rb
 - lib/mumuki/domain/syncable/with_resource_fields.rb
 - lib/mumuki/domain/version.rb
+- lib/mumuki/domain/workspace.rb
 homepage: https://mumuki.org
 licenses:
 - AGPL-3.0