mumuki-domain 6.7.2 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e24945e78e243ddb96ddee6a26d03b3153269eb10d3a88cb8a8e8c351bd33c4
-  data.tar.gz: 5bdc4f8615625d4970a557be4ae10057cc1174eaae506a2ed59e1d77e433e325
+  metadata.gz: dd3eb525947de7658551f36161b8f937d6d9e192b02c9f9a60f72e5170a612f4
+  data.tar.gz: 1c2a08701b38e3aa25ce125739359500a727582c3d42ddf2f4ad7b3df537df36
 SHA512:
-  metadata.gz: cbaaa6db817031fc9cd233636501bc0f012a3d810510e62a29d6fdce06013c3bee5c92e46930951d5108bb95cade1314366930550bf7ba3830aaa54e8cb03354
-  data.tar.gz: c7cb9c09c05c01db817d57cc5abda3524a2a69e783335a9d752795f5b16a94cedc14b09d35304b2869799324cb6bbfc6903e9075aea9491f95719ed987c84564
+  metadata.gz: 9cae5a11974987b65a5231351c7e2e51c6c05d9d11071f98a3ecf34fb5aadb909093d3fb2d1340e7d8ba78c778baf2504e74985d741b49d7c985652d848def3e
+  data.tar.gz: 6e39bad09b6c1c4fe9afc57ddf8d77407253d9fe6e5c38fde08223d02c8d10710357b011b8009d553fadf1d106b4798247e9f09d5310dbf8f85e98e5c237dfb0

data/README.md

@@ -43,7 +43,7 @@ _as defined in `Language#to_resource_h`_
   theme
 ```
 
-_as defined in `Mumukit::Platform::Organization::Helpers#to_resource_h`_
+_as defined in `Mumuki::Domain::Helpers::Organization#to_resource_h`_
 
 ### `User`
 
@@ -57,7 +57,7 @@ _as defined in `Mumukit::Platform::Organization::Helpers#to_resource_h`_
   permissions
 ```
 
-_as defined in `Mumukit::Platform::User::Helpers#to_resource_h`_
+_as defined in `Mumuki::Domain::Helpers::User#to_resource_h`_
 
 ### `Course`
 
@@ -70,7 +70,7 @@ _as defined in `Mumukit::Platform::User::Helpers#to_resource_h`_
   description
 ```
 
-_as defined in `Mumukit::Platform::Course::Helpers#to_resource_h`_
+_as defined in `Mumuki::Domain::Helpers::Course#to_resource_h`_
 
 ## Content Hashes
 

data/app/models/application_record.rb

@@ -109,6 +109,17 @@ class ApplicationRecord < ActiveRecord::Base
     end
   end
 
+  ## Partially implements resource-hash protocol, by
+  ## defining `to_resource_h` and helper methods `resource_fields` and `slice_resource_h`
+  ## using the given fields
+  def self.resource_fields(*fields)
+    include Mumuki::Domain::Syncable::WithResourceFields
+
+    define_singleton_method :resource_fields do
+      fields
+    end
+  end
+
   private
 
   def raise_foreign_key_error!

data/app/models/assignment.rb

@@ -12,6 +12,7 @@ class Assignment < ApplicationRecord
            primary_key: :submission_id,
            dependent: :destroy
 
+  belongs_to :organization
   belongs_to :submitter, class_name: 'User'
 
   validates_presence_of :exercise, :submitter
@@ -126,7 +127,7 @@ class Assignment < ApplicationRecord
   end
 
   def to_resource_h
-    as_json(except: [:exercise_id, :submission_id, :id, :submitter_id, :solution, :created_at, :updated_at, :submission_status],
+    as_json(except: [:exercise_id, :submission_id, :organization_id, :id, :submitter_id, :solution, :created_at, :updated_at, :submission_status],
               include: {
                 guide: {
                   only: [:slug, :name],
@@ -189,6 +190,11 @@ class Assignment < ApplicationRecord
     exercise.files_for(current_content)
   end
 
+  def save!(*)
+    self.organization = Organization.current
+    super
+  end
+
   private
 
   def update_submissions_count!

data/app/models/concerns/with_assignments.rb

@@ -18,7 +18,7 @@ module WithAssignments
     messages_for(user).present?
   end
 
-  def find_assignment_for(user)
+  def find_assignment_for(user, _organization)
     assignments.find_by(submitter: user)
   end
 
@@ -26,7 +26,7 @@ module WithAssignments
     assignment_for(user).status if user
   end
 
-  def assignment_for(user)
-    find_assignment_for(user) || user.assignments.build(exercise: self)
+  def assignment_for(user, organization: Organization.current)
+    find_assignment_for(user, organization) || user.assignments.build(exercise: self, organization: organization)
   end
 end

data/app/models/content.rb

@@ -1,7 +1,7 @@
 class Content < ApplicationRecord
   self.abstract_class = true
 
-  include Syncable
+  include Mumuki::Domain::Syncable
   include WithDescription
   include WithLocale
   include WithSlug

data/app/models/course.rb

@@ -1,6 +1,6 @@
 class Course < ApplicationRecord
-  include Syncable
-  include Mumukit::Platform::Course::Helpers
+  include Mumuki::Domain::Syncable
+  include Mumuki::Domain::Helpers::Course
 
   validates_presence_of :slug, :shifts, :code, :days, :period, :description, :organization_id
   validates_uniqueness_of :slug
@@ -10,12 +10,14 @@ class Course < ApplicationRecord
 
   alias_attribute :name, :code
 
+  resource_fields :slug, :shifts, :code, :days, :period, :description
+
   def current_invitation
     invitations.where('expiration_date > ?', Time.now).take
   end
 
   def import_from_resource_h!(resource_h)
-    update! Mumukit::Platform::Course::Helpers.slice_resource_h(resource_h)
+    update! self.class.slice_resource_h(resource_h)
   end
 
   def slug=(slug)

data/app/models/exercise.rb

@@ -111,6 +111,8 @@ class Exercise < ApplicationRecord
     choice_values.index(value)
   end
 
+  # Keep this list up to date with
+  # Mumukit::Sync::Store::Github::Schema::Exercise
   def to_resource_h
     language_resource_h = language.to_embedded_resource_h if language != guide.language
     as_json(only: %i(name layout editor corollary teacher_info manual_evaluation locale

data/app/models/guide.rb

@@ -14,10 +14,10 @@ class Guide < Content
 
   enum type: [:learning, :practice]
 
-  def clear_progress!(user)
+  def clear_progress!(user, organization)
     transaction do
       exercises.each do |exercise|
-        exercise.find_assignment_for(user)&.destroy!
+        exercise.find_assignment_for(user, organization)&.destroy!
       end
     end
   end
@@ -86,6 +86,8 @@ class Guide < Content
     reload
   end
 
+  # Keep this list up to date with
+  # Mumukit::Sync::Store::Github::Schema::Guide
   def to_resource_h
     as_json(only: %i(beta type id_format private expectations corollary teacher_info sources learn_more authors collaborators extra settings))
       .symbolize_keys

data/app/models/invitation.rb

@@ -1,5 +1,5 @@
 class Invitation < ApplicationRecord
-  include Syncable
+  include Mumuki::Domain::Syncable
 
   belongs_to :course
   validates_uniqueness_of :code

data/app/models/language.rb

@@ -1,6 +1,6 @@
 class Language < ApplicationRecord
   include WithCaseInsensitiveSearch
-  include Syncable
+  include Mumuki::Domain::Syncable
 
   enum output_content_type: [:plain, :html, :markdown]
 
@@ -8,6 +8,33 @@ class Language < ApplicationRecord
 
   validates :name, presence: true, uniqueness: {case_sensitive: false}
 
+  # This list must kept up to date with
+  # Mumukit::Sync::Store::Thesaurus::InfoConverter
+  resource_fields :comment_type,
+                  :devicon,
+                  :editor_css_urls,
+                  :editor_html_urls,
+                  :editor_js_urls,
+                  :editor_shows_loading_content,
+                  :extension,
+                  :feedback,
+                  :highlight_mode,
+                  :layout_css_urls,
+                  :layout_html_urls,
+                  :layout_js_urls,
+                  :layout_shows_loading_content,
+                  :multifile,
+                  :name,
+                  :output_content_type,
+                  :prompt,
+                  :queriable,
+                  :runner_url,
+                  :stateful_console,
+                  :test_extension,
+                  :test_template,
+                  :triable,
+                  :visible_success_output
+
   markdown_on :description
 
   delegate :run_tests!, :run_query!, :run_try!, to: :bridge
@@ -64,13 +91,6 @@ class Language < ApplicationRecord
     as_json(only: [:name, :extension, :test_extension]).symbolize_keys
   end
 
-  def to_resource_h
-    as_json(only: %i(comment_type devicon editor_css_urls editor_html_urls editor_js_urls
-                    extension feedback highlight_mode layout_css_urls layout_html_urls
-                    layout_js_urls multifile name output_content_type prompt queriable runner_url
-                    stateful_console test_extension test_template triable visible_success_output)).symbolize_keys
-  end
-
   private
 
   # TODO we should use Mumukit::Directives::Pipeline

data/app/models/organization.rb

@@ -1,10 +1,12 @@
 class Organization < ApplicationRecord
-  include Syncable
-  include Mumukit::Platform::Organization::Helpers
+  include Mumuki::Domain::Syncable
+  include Mumuki::Domain::Helpers::Organization
 
-  serialize :profile, Mumukit::Platform::Organization::Profile
-  serialize :settings, Mumukit::Platform::Organization::Settings
-  serialize :theme, Mumukit::Platform::Organization::Theme
+  include Mumukit::Login::OrganizationHelpers
+
+  serialize :profile, Mumuki::Domain::Organization::Profile
+  serialize :settings, Mumuki::Domain::Organization::Settings
+  serialize :theme, Mumuki::Domain::Organization::Theme
 
   markdown_on :description
 
@@ -16,7 +18,7 @@ class Organization < ApplicationRecord
   validates_presence_of :contact_email, :locale
   validates :name, uniqueness: true,
                    presence: true,
-                   format: { with: Mumukit::Platform::Organization::Helpers.anchored_valid_name_regex }
+                   format: { with: Mumukit::Platform::Organization.anchored_valid_name_regex }
   validates :locale, inclusion: { in: Mumukit::Platform::Locale.supported }
 
   after_create :reindex_usages!
@@ -28,6 +30,8 @@ class Organization < ApplicationRecord
   has_many :exams
   has_many :courses
 
+  resource_fields :name, :book, :profile, :settings, :theme
+
   defaults do
     self.class.base.try do |base|
       self.theme         = base.theme    if theme.empty?
@@ -113,11 +117,15 @@ class Organization < ApplicationRecord
   end
 
   def import_from_resource_h!(resource_h)
-    attrs = Mumukit::Platform::Organization::Helpers.slice_resource_h resource_h
+    attrs = self.class.slice_resource_h resource_h
     attrs[:book] = Book.locate! attrs[:book]
     update! attrs
   end
 
+  def to_resource_h
+    super.merge(book: book.slug)
+  end
+
   private
 
   def ensure_consistent_public_login

data/app/models/user.rb

@@ -1,10 +1,10 @@
 class User < ApplicationRecord
-  include Syncable
+  include Mumuki::Domain::Syncable
   include WithProfile,
           WithUserNavigation,
           WithReminders,
           WithDiscussionCreation,
-          Mumukit::Platform::User::Helpers
+          Mumuki::Domain::Helpers::User
 
   serialize :permissions, Mumukit::Auth::Permissions
 
@@ -31,9 +31,13 @@ class User < ApplicationRecord
 
   after_initialize :init
 
+  enum gender: %i(female male other)
+
   before_validation :set_uid!
   validates :uid, presence: true
 
+  resource_fields :uid, :social_id, :image_url, :email, :permissions, *profile_fields
+
   def last_lesson
     last_guide.try(:lesson)
   end
@@ -98,7 +102,7 @@ class User < ApplicationRecord
   end
 
   def import_from_resource_h!(json)
-    update! Mumukit::Platform::User::Helpers.slice_resource_h json
+    update! self.class.slice_resource_h json
   end
 
   def unsubscribe_from_reminders!

data/db/migrate/20170621222902_introduce_settings_and_themes.rb

@@ -5,7 +5,7 @@ class IntroduceSettingsAndThemes < ActiveRecord::Migration[4.2]
     add_column :organizations, :profile, :text, default: "{}", null: false
 
     Organization.all.each do |organization|
-      organization.profile = Mumukit::Platform::Organization::Profile.new(
+      organization.profile = Mumuki::Domain::Organization::Profile.new(
         logo_url: organization[:logo_url],
         locale: organization[:locale],
         description: organization[:description],
@@ -13,12 +13,12 @@ class IntroduceSettingsAndThemes < ActiveRecord::Migration[4.2]
         terms_of_service: organization[:terms_of_service],
         community_link: organization[:community_link]
       )
-      organization.settings = Mumukit::Platform::Organization::Settings.new(
+      organization.settings = Mumuki::Domain::Organization::Settings.new(
         login_methods: organization[:login_methods],
         raise_hand_enabled: organization[:raise_hand_enabled],
         public: organization[:public]
       )
-      organization.theme = Mumukit::Platform::Organization::Theme.new(
+      organization.theme = Mumuki::Domain::Organization::Theme.new(
         theme_stylesheet_url: organization[:theme_stylesheet_url],
         extension_javascript_url: organization[:extension_javascript_url]
       )

data/db/migrate/20190530173142_add_organization_to_assignment.rb

@@ -0,0 +1,5 @@
+class AddOrganizationToAssignment < ActiveRecord::Migration[5.1]
+  def change
+    add_reference :assignments, :organization, index: true
+  end
+end

data/db/migrate/20190702003600_add_loading_flags_to_language.rb

@@ -0,0 +1,6 @@
+class AddLoadingFlagsToLanguage < ActiveRecord::Migration[5.1]
+  def change
+    add_column :languages, :layout_shows_loading_content, :boolean
+    add_column :languages, :editor_shows_loading_content, :boolean
+  end
+end

data/db/migrate/20190702182407_add_new_profile_fields.rb

@@ -0,0 +1,6 @@
+class AddNewProfileFields < ActiveRecord::Migration[5.1]
+  def change
+    add_column :users, :birthdate, :date
+    add_column :users, :gender, :integer
+  end
+end

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

@@ -0,0 +1,17 @@
+#TODO move to mumukit-core
+class Module
+  def ensure_defined!(selector)
+    # FIXME pass additional false flag in ruby 2.6
+    raise "method #{selector} was not previously defined here" unless method_defined?(selector)
+  end
+
+  def ensure_undefined!(selector)
+    # FIXME pass additional false flag in ruby 2.6
+    raise "method #{selector} was previously defined here" if method_defined?(selector)
+  end
+
+  def define_once(selector, *args, &block)
+    ensure_undefined! selector
+    define_method selector, *args, &block
+  end
+end

data/lib/mumuki/domain/extensions.rb

@@ -1,2 +1,3 @@
 require_relative './extensions/string'
 require_relative './extensions/array'
+require_relative './extensions/module'

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

@@ -3,5 +3,6 @@ FactoryBot.define do
     status { :pending }
     exercise
     submitter { create(:user) }
+    organization { Organization.current }
   end
 end

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

@@ -9,10 +9,8 @@ FactoryBot.define do
     book
   end
 
-  factory :base, parent: :organization do
-    public { true }
-    name { 'base' }
-    login_methods { Mumukit::Login::Settings.login_methods }
+  factory :private_organization, parent: :organization do
+    name { 'the-private-org' }
   end
 
   factory :public_organization, parent: :organization do
@@ -21,7 +19,20 @@ FactoryBot.define do
     login_methods { Mumukit::Login::Settings.login_methods }
   end
 
-  factory :private_organization, parent: :organization do
-    name { 'the-private-org' }
+  factory :base, parent: :public_organization do
+    name { 'base' }
+  end
+
+  factory :test_organization, parent: :public_organization do
+    name { 'test' }
+    book { create(:book, name: 'test', slug: 'mumuki/mumuki-the-book') }
+  end
+
+  factory :another_test_organization, parent: :test_organization, traits: [:skip_unique_name_validation] do
+    book { create(:book, name: 'another-test', slug: 'mumuki/mumuki-another-book') }
+  end
+
+  trait :skip_unique_name_validation do
+    to_create { |instance| instance.save(validate: false) }
   end
 end

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

@@ -4,5 +4,7 @@ FactoryBot.define do
     uid { email }
     first_name { Faker::Name.first_name }
     last_name { Faker::Name.last_name }
+    gender { 1 }
+    birthdate { Date.today }
   end
 end

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

@@ -0,0 +1,13 @@
+module Mumuki::Domain::Helpers::Course
+  include Mumukit::Platform::Notifiable
+
+  def platform_class_name
+    :Course
+  end
+
+  ## API Exposure
+
+  def to_param
+    slug
+  end
+end

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

@@ -0,0 +1,72 @@
+module Mumuki::Domain::Helpers::Organization
+  extend ActiveSupport::Concern
+  include Mumukit::Platform::Notifiable
+
+  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::Profile.accessors, :locale_json, to: :profile
+  end
+
+  def platform_class_name
+    :Organization
+  end
+
+  def slug
+    Mumukit::Auth::Slug.join_s name
+  end
+
+  def central?
+    name == 'central'
+  end
+
+  def test?
+    name == 'test'
+  end
+
+  def base?
+    name == 'base'
+  end
+
+  def switch!
+    Mumukit::Platform::Organization.switch! self
+  end
+
+  def to_s
+    name
+  end
+
+  def url_for(path)
+    Mumukit::Platform.application.organic_url_for(name, path)
+  end
+
+  def url
+    url_for '/'
+  end
+
+  def domain
+    Mumukit::Platform.application.organic_domain(name)
+  end
+
+  ## API Exposure
+
+  def to_param
+    name
+  end
+
+  ## Resource Hash
+
+  module ClassMethods
+    def current
+      Mumukit::Platform::Organization.current
+    end
+
+    def parse(json)
+      json
+        .slice(:name)
+        .merge(theme: Mumuki::Domain::Organization::Theme.parse(json[:theme]))
+        .merge(settings: Mumuki::Domain::Organization::Settings.parse(json[:settings]))
+        .merge(profile: Mumuki::Domain::Organization::Profile.parse(json[:profile]))
+    end
+  end
+end

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

@@ -0,0 +1,109 @@
+module Mumuki::Domain::Helpers::User
+  extend ActiveSupport::Concern
+  include Mumukit::Auth::Roles
+  include Mumukit::Platform::Notifiable
+
+  ## Permissions
+
+  delegate :has_role?,
+           :add_permission!,
+           :remove_permission!,
+           :has_permission?,
+           :has_permission_delegation?,
+           :protect!,
+           :protect_delegation!,
+           :protect_permissions_assignment!,
+           to: :permissions
+
+  def platform_class_name
+    :User
+  end
+
+  def merge_permissions!(new_permissions)
+    self.permissions = permissions.merge(new_permissions)
+  end
+
+  (Mumukit::Auth::Roles::ROLES - [:writer, :editor, :owner] + [:discusser]).each do |role|
+    role_of = "#{role}_of?"
+    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
+    end
+
+    # Tells whether this user has #{role} permissions in
+    # the current organization
+    define_method role_here do
+      send role_of, Mumukit::Platform::Organization.current
+    end
+  end
+
+  # Tells whether this user has forum discusser permissions in
+  # the given organization
+  def discusser_of?(organization)
+    has_permission? organization.forum_discussions_minimal_role, organization.slug
+  end
+
+  (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
+    end
+  end
+
+  ## Profile
+
+  def full_name
+    "#{first_name} #{last_name}"
+  end
+
+  alias_method :name, :full_name
+
+  def profile_completed?
+    self.class.profile_fields.map { |it| self[it] }.all? &:present?
+  end
+
+  def to_s
+    "#{full_name} <#{email}> [#{uid}]"
+  end
+
+  ## Accesible organizations
+
+  def student_granted_organizations
+    permissions.student_granted_organizations.map do |org|
+      Mumukit::Platform::Organization.find_by_name!(org) rescue nil
+    end.compact
+  end
+
+  def has_student_granted_organizations?
+    student_granted_organizations.present?
+  end
+
+  def main_organization
+    student_granted_organizations.first
+  end
+
+  def has_main_organization?
+    student_granted_organizations.length == 1
+  end
+
+  def has_immersive_main_organization?
+    !!main_organization.try(&:immersive?)
+  end
+
+  ## API Exposure
+
+  def to_param
+    uid
+  end
+
+  class_methods do
+    def profile_fields
+      [:first_name, :last_name, :gender, :birthdate]
+    end
+  end
+end

data/lib/mumuki/domain/helpers.rb

@@ -0,0 +1,8 @@
+module Mumuki::Domain
+  module Helpers
+  end
+end
+
+require_relative './helpers/organization'
+require_relative './helpers/user'
+require_relative './helpers/course'

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

@@ -0,0 +1,39 @@
+class Mumuki::Domain::Organization::Profile < Mumukit::Platform::Model
+  LOCALES = Mumukit::Platform::Locale::SPECS
+
+  model_attr_accessor :logo_url,
+                      :banner_url,
+                      :favicon_url,
+                      :breadcrumb_image_url,
+                      :open_graph_image_url,
+                      :locale,
+                      :description,
+                      :contact_email,
+                      :terms_of_service,
+                      :community_link,
+                      :errors_explanations
+
+  def locale_json
+    locale_h.to_json
+  end
+
+  def locale_h
+    Mumukit::Platform::Locale::SPECS[locale]
+  end
+
+  def logo_url
+    @logo_url ||= 'https://mumuki.io/logo-alt-large.png' # Best image size: 350x75
+  end
+
+  def banner_url
+    @banner_url || logo_url  # Best image size: 350x75
+  end
+
+  def favicon_url
+    @favicon_url ||= '/favicon.ico'  # Best image size: 16x16, 32x32 or 48x48
+  end
+
+  def open_graph_image_url
+    @open_graph_image_url ||= Mumukit::Platform.application.url_for("logo-alt.png")  # Best image size: 256x256
+  end
+end

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

@@ -0,0 +1,27 @@
+class Mumuki::Domain::Organization::Settings < Mumukit::Platform::Model
+  include Mumukit::Login::LoginSettingsHelpers
+
+  model_attr_accessor :login_methods,
+                      :login_provider,
+                      :login_provider_settings,
+                      :forum_discussions_minimal_role,
+                      :raise_hand_enabled?,
+                      :feedback_suggestions_enabled?,
+                      :public?,
+                      :embeddable?,
+                      :immersive?,
+                      :forum_enabled?,
+                      :report_issue_enabled?
+
+  def private?
+    !public?
+  end
+
+  def login_methods
+    @login_methods ||= ['user_pass']
+  end
+
+  def forum_discussions_minimal_role
+    (@forum_discussions_minimal_role || 'student').to_sym
+  end
+end

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

@@ -0,0 +1,4 @@
+class Mumuki::Domain::Organization::Theme < Mumukit::Platform::Model
+  model_attr_accessor :theme_stylesheet,
+                      :extension_javascript
+end

data/lib/mumuki/domain/organization.rb

@@ -0,0 +1,8 @@
+module Mumuki::Domain
+  module Organization
+  end
+end
+
+require_relative './organization/settings'
+require_relative './organization/profile'
+require_relative './organization/theme'

data/lib/mumuki/domain/stores/bibliotheca_store.rb

@@ -0,0 +1,29 @@
+module Mumukit::Sync::Store
+
+  ## This Store enables importing content
+  ## from Bibliotheca API
+  class Bibliotheca < Mumukit::Sync::Store::Base
+    include Mumukit::Sync::Store::WithWrappedLanguage
+    include Mumukit::Sync::Store::WithFilteredId
+
+    def initialize(bibliotheca_bridge)
+      @bibliotheca_bridge = bibliotheca_bridge
+    end
+
+    def sync_keys
+      %w(guide topic book).flat_map do |kind|
+        @bibliotheca_bridge
+          .send(kind.as_variable_name.pluralize)
+          .map { |it| Mumukit::Sync.key kind, it['slug']  }
+      end
+    end
+
+    def do_read(sync_key)
+      @bibliotheca_bridge.send(sync_key.kind.as_variable_name, sync_key.id)
+    end
+
+    def write_resource!(*)
+      Mumukit::Sync::Store.read_only!
+    end
+  end
+end

data/lib/mumuki/domain/stores/exercise_schema.rb

@@ -0,0 +1,37 @@
+module Mumukit::Sync::Store::Github::Schema::Exercise
+  extend Mumukit::Sync::Store::Github::Schema
+
+  def self.fields_schema
+    [
+      {name: :id, kind: :special},
+      {name: :name, kind: :special},
+
+      {name: :tags, kind: :metadata, reverse: :tag_list, transform: with { |it| it.to_a }},
+      {name: :layout, kind: :metadata},
+      {name: :editor, kind: :metadata},
+
+      {name: :type, kind: :metadata},
+      {name: :extra_visible, kind: :metadata},
+      {name: :language, kind: :metadata, transform: name },
+      {name: :teacher_info, kind: :metadata},
+      {name: :manual_evaluation, kind: :metadata},
+      {name: :choices, kind: :metadata},
+
+      {name: :expectations,     kind: :file, extension: 'yml', transform: yaml_list('expectations')},
+      {name: :assistance_rules, kind: :file, extension: 'yml', transform: yaml_list('rules')},
+      {name: :randomizations,   kind: :file, extension: 'yml', transform: yaml_hash},
+
+      {name: :goal, kind: :metadata},
+      {name: :test, kind: :file, extension: :test},
+      {name: :extra, kind: :file, extension: :code},
+      {name: :default, kind: :file, extension: :code, reverse: :default_content},
+
+      {name: :description, kind: :file, extension: 'md', required: true},
+      {name: :hint, kind: :file, extension: 'md'},
+      {name: :corollary, kind: :file, extension: 'md'},
+      {name: :initial_state, kind: :file, extension: 'md'},
+      {name: :final_state, kind: :file, extension: 'md'},
+      {name: :free_form_editor_source, kind: :file, extension: 'html'}
+    ]
+  end
+end

data/lib/mumuki/domain/stores/guide_schema.rb

@@ -0,0 +1,34 @@
+module Mumukit::Sync::Store::Github::Schema::Guide
+  extend Mumukit::Sync::Store::Github::Schema
+
+  def self.fields_schema
+    [
+      {name: :exercises, kind: :special},
+      {name: :id, kind: :special},
+      {name: :slug, kind: :special},
+
+      {name: :name, kind: :metadata},
+      {name: :locale, kind: :metadata},
+      {name: :type, kind: :metadata},
+      {name: :beta, kind: :metadata},
+      {name: :teacher_info, kind: :metadata},
+      {name: :language, kind: :metadata, transform: name },
+      {name: :id_format, kind: :metadata},
+      {name: :order, kind: :metadata, transform: with { |it| it.map { |e| e[:id] } }, reverse: :exercises},
+      {name: :private, kind: :metadata},
+
+      {name: :expectations, kind: :file, extension: 'yml', transform: yaml_list('expectations')},
+      {name: :description, kind: :file, extension: 'md', required: true},
+      {name: :corollary, kind: :file, extension: 'md'},
+      {name: :sources, kind: :file, extension: 'md'},
+      {name: :learn_more, kind: :file, extension: 'md'},
+      {name: :extra, kind: :file, extension: :code},
+      {name: :AUTHORS, kind: :file, extension: 'txt', reverse: :authors},
+      {name: :COLLABORATORS, kind: :file, extension: 'txt', reverse: :collaborators}
+    ]
+  end
+
+  def self.fixed_file_patterns
+    %w(LICENSE.txt README.md COPYRIGHT.txt meta.yml *_*/*)
+  end
+end

data/lib/mumuki/domain/stores/thesaurus_store.rb

@@ -0,0 +1,79 @@
+module Mumukit::Sync::Store
+
+  ## This Store enables importing languages
+  ## from Thesaurus API
+  class Thesaurus < Mumukit::Sync::Store::Base
+    def initialize(thesaurus_bridge)
+      @thesaurus_bridge = thesaurus_bridge
+    end
+
+    def sync_keys
+      @thesaurus_bridge.runners.map { |it| Mumukit::Sync.key(:language, it) }
+    end
+
+    def do_read(sync_key)
+      return unless sync_key.kind.like? :language
+      transform_after_read(sync_key.id, Mumukit::Bridge::Runner.new(sync_key.id).info)
+    end
+
+    def transform_after_read(runner_url, info)
+      Mumukit::Sync::Store::Thesaurus::InfoConverter.new(runner_url, info).call
+    end
+
+    def write_resource!(*)
+      Mumukit::Sync::Store.read_only!
+    end
+
+    class InfoConverter
+      def initialize(runner_url, info)
+        @runner_url = runner_url
+        @info = info
+      end
+
+      def call
+        {
+          name:                         @info['name'],
+          comment_type:                 @info['comment_type'],
+          runner_url:                   @runner_url,
+          output_content_type:          @info['output_content_type'],
+          prompt:                       (@info.dig('language', 'prompt') || 'ム') + ' ',
+          extension:                    @info.dig('language', 'extension'),
+          highlight_mode:               @info.dig('language', 'ace_mode'),
+          visible_success_output:       @info.dig('language', 'graphic').present?,
+          devicon:                      @info.dig('language', 'icon', 'name'),
+          triable:                      @info.dig('features', 'try').present?,
+          feedback:                     @info.dig('features', 'feedback').present?,
+          queriable:                    @info.dig('features', 'query').present?,
+          stateful_console:             @info.dig('features', 'stateful').present?,
+          multifile:                    @info.dig('features', 'multifile').present?,
+          test_extension:               @info.dig('test_framework', 'test_extension'),
+          test_template:                @info.dig('test_framework', 'template'),
+          layout_js_urls:               get_assets_for(:layout, 'js'),
+          layout_html_urls:             get_assets_for(:layout, 'html'),
+          layout_css_urls:              get_assets_for(:layout, 'css'),
+          editor_js_urls:               get_assets_for(:editor, 'js'),
+          editor_html_urls:             get_assets_for(:editor, 'html'),
+          editor_css_urls:              get_assets_for(:editor, 'css'),
+          layout_shows_loading_content: shows_loading_content_for?(:layout),
+          editor_shows_loading_content: shows_loading_content_for?(:editor)
+        }
+      end
+
+      def get_assets_for(kind, content_type)
+        absolutize(get_asset_field(kind, content_type) || [])
+      end
+
+      def get_asset_field(kind, field)
+        @info.dig("#{kind}_assets_urls", field)
+      end
+
+      def absolutize(urls)
+        urls.map { |url| "#{@runner_url}/#{url}"}
+      end
+
+      def shows_loading_content_for?(kind)
+        get_asset_field(kind, 'shows_loading_content').present?
+      end
+    end
+  end
+end

data/lib/mumuki/domain/stores.rb

@@ -0,0 +1,4 @@
+require_relative './stores/thesaurus_store'
+require_relative './stores/bibliotheca_store'
+require_relative './stores/guide_schema'
+require_relative './stores/exercise_schema'

data/lib/mumuki/domain/syncable/with_resource_fields.rb

@@ -0,0 +1,18 @@
+module Mumuki::Domain::Syncable
+  ## Syncable objects that also declare
+  ## a `resource_fields` method can define `resource_h`
+  ## and `self.slice_resource_h` based on it.
+  module WithResourceFields
+    extend ActiveSupport::Concern
+
+    def to_resource_h
+      self.class.resource_fields.map { |it| [it, send(it)] }.to_h.compact
+    end
+
+    class_methods do
+      def slice_resource_h(resource_h)
+        resource_h.slice(*resource_fields)
+      end
+    end
+  end
+end

data/{app/models/concerns → lib/mumuki/domain}/syncable.rb

@@ -2,7 +2,7 @@
 # be treated as `Mumukit::Sync` resources
 #
 # `Syncable` objects also get `Mumukit::Platform::Notifiable` by free
-module Syncable
+module Mumuki::Domain::Syncable
   extend ActiveSupport::Concern
   include Mumukit::Platform::Notifiable
 
@@ -87,3 +87,5 @@ module Syncable
     end
   end
 end
+
+require_relative './syncable/with_resource_fields'

data/lib/mumuki/domain/version.rb

@@ -1,5 +1,5 @@
 module Mumuki
   module Domain
-    VERSION = '6.7.2'
+    VERSION = '7.0.0'
   end
 end

data/lib/mumuki/domain.rb

@@ -11,6 +11,7 @@ require 'mumukit/inspection'
 require 'mumukit/platform'
 require 'mumukit/randomizer'
 require 'mumukit/sync'
+require 'mumukit/login'
 
 I18n.load_translations_path File.join(__dir__, 'domain', 'locales', '**', '*.yml')
 
@@ -30,6 +31,10 @@ require_relative './domain/status'
 require_relative './domain/exceptions'
 require_relative './domain/file'
 require_relative './domain/extensions'
+require_relative './domain/organization'
+require_relative './domain/helpers'
+require_relative './domain/syncable'
+require_relative './domain/stores'
 
 class Mumukit::Assistant
   def self.valid?(rules)
@@ -48,3 +53,8 @@ class Mumukit::Randomizer
     !!parse(randomizations) rescue false
   end
 end
+
+Mumukit::Sync::Store::Github.configure do |config|
+  config.guide_schema = Mumukit::Sync::Store::Github::Schema::Guide
+  config.exercise_schema = Mumukit::Sync::Store::Github::Schema::Exercise
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mumuki-domain
 version: !ruby/object:Gem::Version
-  version: 6.7.2
+  version: 7.0.0
 platform: ruby
 authors:
 - Franco Leonardo Bulgarelli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-28 00:00:00.000000000 Z
+date: 2019-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: mumukit-content-type
   requirement: !ruby/object:Gem::Requirement
@@ -142,28 +142,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: mumukit-sync
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -184,14 +184,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
 description: Mumuki Platform's Domain Model
 email:
 - franco@mumuki.org
@@ -221,7 +221,6 @@ files:
 - app/models/concerns/submittable/solvable.rb
 - app/models/concerns/submittable/submittable.rb
 - app/models/concerns/submittable/triable.rb
-- app/models/concerns/syncable.rb
 - app/models/concerns/with_assignments.rb
 - app/models/concerns/with_case_insensitive_search.rb
 - app/models/concerns/with_description.rb
@@ -538,6 +537,9 @@ files:
 - db/migrate/20190326152631_add_settings_to_content.rb
 - db/migrate/20190404181724_add_organization_to_discussion.rb
 - db/migrate/20190506180102_add_multifile_to_languages.rb
+- db/migrate/20190530173142_add_organization_to_assignment.rb
+- db/migrate/20190702003600_add_loading_flags_to_language.rb
+- db/migrate/20190702182407_add_new_profile_fields.rb
 - lib/mumuki/domain.rb
 - lib/mumuki/domain/engine.rb
 - lib/mumuki/domain/evaluation.rb
@@ -551,6 +553,7 @@ files:
 - lib/mumuki/domain/exceptions/unauthorized_error.rb
 - lib/mumuki/domain/extensions.rb
 - lib/mumuki/domain/extensions/array.rb
+- lib/mumuki/domain/extensions/module.rb
 - lib/mumuki/domain/extensions/string.rb
 - lib/mumuki/domain/factories.rb
 - lib/mumuki/domain/factories/api_client_factory.rb
@@ -572,12 +575,20 @@ files:
 - lib/mumuki/domain/factories/usage_factory.rb
 - lib/mumuki/domain/factories/user_factory.rb
 - lib/mumuki/domain/file.rb
+- lib/mumuki/domain/helpers.rb
+- lib/mumuki/domain/helpers/course.rb
+- lib/mumuki/domain/helpers/organization.rb
+- lib/mumuki/domain/helpers/user.rb
 - lib/mumuki/domain/locales/activerecord/en.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.yml
 - lib/mumuki/domain/locales/console_submission/pt.yml
+- lib/mumuki/domain/organization.rb
+- lib/mumuki/domain/organization/profile.rb
+- lib/mumuki/domain/organization/settings.rb
+- lib/mumuki/domain/organization/theme.rb
 - lib/mumuki/domain/seed.rb
 - lib/mumuki/domain/status.rb
 - lib/mumuki/domain/status/discussion/closed.rb
@@ -594,6 +605,11 @@ files:
 - lib/mumuki/domain/status/submission/pending.rb
 - lib/mumuki/domain/status/submission/running.rb
 - lib/mumuki/domain/status/submission/submission.rb
+- lib/mumuki/domain/stores.rb
+- lib/mumuki/domain/stores/bibliotheca_store.rb
+- lib/mumuki/domain/stores/exercise_schema.rb
+- lib/mumuki/domain/stores/guide_schema.rb
+- lib/mumuki/domain/stores/thesaurus_store.rb
 - lib/mumuki/domain/submission.rb
 - lib/mumuki/domain/submission/base.rb
 - lib/mumuki/domain/submission/confirmation.rb
@@ -603,6 +619,8 @@ files:
 - lib/mumuki/domain/submission/question.rb
 - lib/mumuki/domain/submission/solution.rb
 - lib/mumuki/domain/submission/try.rb
+- lib/mumuki/domain/syncable.rb
+- lib/mumuki/domain/syncable/with_resource_fields.rb
 - lib/mumuki/domain/version.rb
 homepage: https://mumuki.org
 licenses:
@@ -623,7 +641,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Mumuki Platform's Domain Model