Add draft flag to activities

app/controllers/activities_controller.rb

@@ -25,6 +25,7 @@ class ActivitiesController < ApplicationController
   has_scope :by_description_languages, as: 'description_languages', type: :array
   has_scope :by_judge, as: 'judge_id'
   has_scope :by_popularities, as: 'popularity', type: :array
+  has_scope :is_draft, as: 'draft', type: :boolean
 
   has_scope :repository_scope, as: 'tab' do |controller, scope, value|
     course = Series.find(controller.params[:id]).course if controller.params[:id]

app/controllers/pages_controller.rb

@@ -22,6 +22,8 @@ def home
       @homepage_series = courses.map { |c| c.homepage_series(current_user, 0) }.flatten.sort_by(&:deadline)
 
       @jump_back_in = current_user.jump_back_in
+
+      @draft_exercises = current_user.draft_exercises.reorder(updated_at: :desc) if current_user.a_repository_admin?
     else
       set_metrics
       respond_to do |format|

app/models/activity.rb

@@ -22,6 +22,7 @@
 #  description_nl_present  :boolean          default(FALSE)
 #  description_en_present  :boolean          default(FALSE)
 #  series_count            :integer          default(0), not null
+#  draft                   :boolean          default(FALSE)
 #
 
 require 'pathname'
@@ -66,6 +67,7 @@ class Activity < ApplicationRecord
   before_create :generate_repository_token,
                 if: ->(ex) { ex.repository_token.nil? }
   before_create :generate_access_token
+  before_create :activate_draft_mode
   before_update :update_config
 
   scope :content_pages, -> { where(type: ContentPage.name) }
@@ -80,6 +82,7 @@ class Activity < ApplicationRecord
   scope :by_programming_language, ->(programming_language) { includes(:programming_language).where(programming_languages: { name: programming_language }) }
   scope :by_type, ->(type) { where(type: type) }
   scope :by_judge, ->(judge) { where(judge_id: judge) }
+  scope :is_draft, -> { where(draft: true) }
   scope :by_description_languages, lambda { |languages|
     by_language = all # allow chaining of scopes
     by_language = by_language.where(description_en_present: true) if languages.include? 'en'
@@ -298,6 +301,7 @@ def update_config
     c = config
     c.delete('visibility')
     c['access'] = access if defined?(access) && access != merged_config['access']
+    c['draft'] = draft if defined?(draft)
     c['description']['names']['nl'] = name_nl if name_nl.present? || c['description']['names']['nl'].present?
     c['description']['names']['en'] = name_en if name_en.present? || c['description']['names']['en'].present?
     c['internals'] = {}
@@ -316,19 +320,22 @@ def accessible?(user, course)
       if user&.course_admin? course
         return false unless course.activities.pluck(:id).include? id
       elsif user&.member_of? course
-        return false unless course.accessible_activities.pluck(:id).include? id
-      else
-        return false unless course.visible_activities.pluck(:id).include? id
+        return false if course.accessible_activities.pluck(:id).exclude?(id) || draft?
+      elsif course.visible_activities.pluck(:id).exclude?(id) || draft?
+        return false
       end
       return true if user&.zeus?
       return false unless access_public? \
           || repository.allowed_courses.pluck(:id).include?(course&.id)
-      return true if user&.member_of? course
+      return true if user&.course_admin? course
+      return false if draft?
+      return true if user&.member_of?(course)
       return false if course.moderated && access_private?
 
       course.open_for_user?(user)
     else
       return true if user&.repository_admin? repository
+      return false if draft?
 
       access_public?
     end
@@ -506,4 +513,8 @@ def unique_labels(hash)
     hash['labels'] = hash['labels'].uniq if hash.key? 'labels'
     hash
   end
+
+  def activate_draft_mode
+    self.draft = true
+  end
 end

app/models/content_page.rb

@@ -22,6 +22,7 @@
 #  description_nl_present  :boolean          default(FALSE)
 #  description_en_present  :boolean          default(FALSE)
 #  series_count            :integer          default(0), not null
+#  draft                   :boolean          default(FALSE)
 #
 
 class ContentPage < Activity

app/models/exercise.rb

@@ -22,6 +22,7 @@
 #  description_nl_present  :boolean          default(FALSE)
 #  description_en_present  :boolean          default(FALSE)
 #  series_count            :integer          default(0), not null
+#  draft                   :boolean          default(FALSE)
 #
 
 require 'pathname'

app/models/submission.rb

@@ -518,6 +518,7 @@ def update_fs
   end
 
   def report_if_internal_error
+    return if exercise&.draft?
     return unless status_changed? && send(:'internal error?')
 
     ExceptionNotifier.notify_exception(

app/models/user.rb

@@ -107,6 +107,13 @@ class User < ApplicationRecord
   has_many :repositories,
            through: :repository_admins,
            source: :repository
+  has_many :draft_exercises,
+           lambda {
+             where activities:
+                        { draft: true }
+           },
+           through: :repositories,
+           source: :exercises
 
   has_many :annotations, dependent: :restrict_with_error
   has_many :questions, dependent: :restrict_with_error

app/policies/activity_policy.rb

@@ -4,7 +4,7 @@ def resolve
       if user&.zeus?
         scope.all
       else
-        scope.where(access: :public, status: :ok).or(scope.where(repository: user&.repositories))
+        scope.where(access: :public, status: :ok, draft: false).or(scope.where(repository: user&.repositories))
       end
     end
   end
@@ -75,7 +75,7 @@ def read?
 
   def permitted_attributes
     if update?
-      %i[access name_nl name_en]
+      %i[access name_nl name_en draft]
     else
       []
     end

app/views/activities/_form.html.erb

@@ -1,7 +1,3 @@
-<% content_for :javascripts do %>
-  <% # TODO rename pack to activity %>
-  <% javascript_include_tag 'exercise' %>
-<% end %>
 <%= form_for(activity.becomes(Activity), :url => activity_scoped_path(activity: activity, course: @course, series: @series), :html => {:class => 'form-horizontal'}) do |f| %>
   <% if activity.errors.any? %>
    <div class="callout callout-danger" id="error_explanation">
@@ -30,15 +26,22 @@
     <div class="col-sm-6 col-12"><%= f.text_field :labels, class: 'form-control', disable: !f.permission?(:labels), value: activity.labels.map(&:name).join(','), placeholder: t(".labels") %></div>
     <span class="help-block offset-sm-3 col-sm-6 col-12"><%= t '.labels_delimiter' %></span>
   </div>
+  <div class="field form-group row">
+    <%= f.label :draft, t(".draft.title"), :class => "col-sm-3 col-12 col-form-label" %>
+    <div class="col-sm-6 col-12 pt-2">
+      <div class="form-check">
+        <%= f.check_box :draft, class: 'form-check-input' %>
+        <%= f.label :draft, t(".draft.toggle-label"), class: 'form-check-label' %>
+      </div>
+    </div>
+    <span class="help-block offset-sm-3 col-sm-6 col-12"><%= t '.draft.help' %></span>
+  </div>
   <div class="field form-group row">
     <label class="col-sm-3 col-12 col-form-label"><%= t ".edit_activity" %></label>
-    <div class="col-sm-6 col-12 form-control-static"><%= link_to t(".open_on_github"), activity.github_url, target: '_blank', rel: 'noopener' %></div>
+    <div class="col-sm-6 col-12 form-control-static pt-2"><%= link_to t(".open_on_github"), activity.github_url, target: '_blank', rel: 'noopener' %></div>
   </div>
   <div class="field form-group row">
     <label class="col-sm-3 col-12 col-form-label"><%= t ".info" %></label>
-    <div class="col-sm-6 col-12 form-control-static"><%= link_to t(".info_description"), info_activity_scoped_path(activity: @activity, course: @course, series: @series), rel: 'noopener' %></div>
+    <div class="col-sm-6 col-12 form-control-static pt-2"><%= link_to t(".info_description"), info_activity_scoped_path(activity: @activity, course: @course, series: @series), rel: 'noopener' %></div>
   </div>
 <% end %>
-<script>
-    dodona.initLabelsEdit(<%= raw render template: 'labels/index', formats: :json %>, <%= raw (activity.merged_dirconfig['labels'] || []).to_json %>);
-</script>

app/views/activities/_repository_status.html.erb

@@ -6,3 +6,6 @@
 <% elsif activity.not_valid? %>
   <i class="mdi mdi-alert-circle mdi-18" title="<%= t('activities.index.invalid') %>"></i>
 <% end %>
+<% if activity.draft? %>
+  <i class="mdi mdi-file-document-edit-outline mdi-18 colored-warning" title="<%= t('activities.index.draft-notice') %>"></i>
+<% end %>

app/views/activities/show.html.erb

@@ -27,6 +27,21 @@
   next_tooltip_actionable = next_activity ? t('.navigation.next_actionable') : t('.navigation.back_to_course_actionable')
 end %>
 
+<% if @activity.draft? %>
+  <div class="alert alert-warning">
+    <i class="mdi mdi-file-document-edit-outline"></i>
+    <%= t "activities.show.alert_draft" %>
+    <% if policy(@activity).edit? %>
+      <% edit_path = @series.present? ?
+                       course_series_activity_path(@series&.course, @series, @activity, {activity: {draft: false}}) :
+                       activity_path(@activity, {activity: {draft: false}})
+      %>
+      <%= link_to t("activities.show.alert_draft_edit"), edit_path, method: :put %>
+
+    <% end %>
+  </div>
+<% end %>
+
 <div class="row">
   <% if @activity.exercise? %>
     <div class="col-md-1 p-0">

app/views/pages/_user_card.html.erb

@@ -15,6 +15,27 @@
   </div>
 </div>
 
+<% if @draft_exercises.present? %>
+  <div class="card home-summary-card user">
+    <div class="card-supporting-text recents">
+      <h5><%= t ".draft-exercises" %></h5>
+      <% @draft_exercises.first(5).each do |exercise| %>
+        <p>
+          <%= link_to activity_submissions_path(exercise), class: 'btn-icon float-end' do %>
+            <i class="mdi mdi-chevron-right"></i>
+          <% end %>
+          <span class='float-start'><%= activity_icon exercise %></span>
+          <%= link_to exercise.name, activity_path(exercise), class: "course-link", title: exercise.name %>
+          <%= link_to exercise.repository.name, repository_path(exercise.repository), class: "small text-muted course-link", title: exercise.repository.name %>
+        </p>
+      <% end %>
+      <% if @draft_exercises.count > 5 %>
+        <%= link_to t(".all-draft-exercises") ,activities_path(draft: true) %>
+      <% end %>
+    </div>
+  </div>
+<% end %>
+
 <% deadlines = @homepage_series %>
 <% if deadlines.any? %>
   <div class="card home-summary-card user">

config/locales/views/activities/en.yml

@@ -27,6 +27,10 @@ en:
       labels: New label
       info: Information
       info_description: Go to the information page of this learning activity
+      draft:
+        title: "Draft"
+        toggle-label: "Put activity in draft mode."
+        help: "Draft mode provides better error logging for teachers and hides the activity from students. Draft mode is activated by default for new activities."
     index:
       title: Exercises
       exercise: Exercise
@@ -67,6 +71,7 @@ en:
         mine: "My activities"
         featured: "Featured activities"
         all: "All activities"
+      draft-notice: "This activity is in draft mode. It is not visible for students."
     show:
       code: Code
       handin: Hand in
@@ -97,6 +102,8 @@ en:
       preloaded_info: "We have preloaded your latest submission into the editor."
       preloaded_clear: Clear editor.
       preloaded_restore: Restore the initial code.
+      alert_draft: This activity is in draft mode. It is not visible for students.
+      alert_draft_edit: Disable draft mode.
     series_activities_add_table:
       course_added_to_usable: "Adding this exercise will allow this course to use all of the private exercises in this exercise's repository. Are you sure?"
     edit:

config/locales/views/activities/nl.yml

@@ -27,6 +27,10 @@ nl:
       labels: Nieuw label
       info: Informatie
       info_description: Ga naar de informatiepagina van deze leeractiviteit
+      draft:
+        title: "Ontwerp"
+        toggle-label: "Activeer de ontwerpmodus."
+        help: "Ontwerpmodus zorgt voor betere foutmeldingen voor leerkrachten en verbergt de activiteit voor studenten."
     index:
       title: Oefeningen
       exercise: Oefening
@@ -67,6 +71,7 @@ nl:
         mine: "Mijn activiteiten"
         featured: "Uitgelichte activiteiten"
         all: "Alle activiteiten"
+      draft-notice: "Deze activiteit is in ontwerpmodus. Ze is niet zichtbaar voor studenten."
     show:
       code: Code
       handin: Indienen
@@ -97,6 +102,8 @@ nl:
       preloaded_info: We hebben jouw laatste oplossing ingeladen in de editor.
       preloaded_clear: Maak de editor leeg.
       preloaded_restore: Zet de voorbeeldcode terug.
+      alert_draft: Deze activiteit is in ontwerpmodus. Ze is niet zichtbaar voor studenten.
+      alert_draft_edit: Ze de ontwerpmodus uit.
     series_activities_add_table:
       course_added_to_usable: "Deze oefening toevoegen zal deze cursus toegang geven tot alle privé oefeningen in de repository van deze oefening. Ben je zeker?"
     edit:

config/locales/views/pages/en.yml

@@ -101,6 +101,8 @@ en:
       submissions: Submissions
       correct-exercises: Correct exercises
       recent-exercises: Recent exercises
+      draft-exercises: Draft exercises
+      all-draft-exercises: All draft exercises
     getting_started_card:
       title: Hi there,
       text: It looks like you're new here. To get started, register for a course.

config/locales/views/pages/nl.yml

@@ -101,6 +101,8 @@ nl:
       submissions: Ingediende oplossingen
       correct-exercises: Correcte oefeningen
       recent-exercises: Recente oefeningen
+      draft-exercises: Oefeningen in ontwerpmodus
+      all-draft-exercises: Alle oefeningen in ontwerpmodus
     getting_started_card:
       title: Hallo,
       text: Welkom op Dodona! Registreer je voor een cursus om van start te gaan.

db/migrate/20230922115708_add_draft_to_activities.rb

@@ -0,0 +1,5 @@
+class AddDraftToActivities < ActiveRecord::Migration[7.0]
+  def change
+    add_column :activities, :draft, :boolean, default: false
+  end
+end

db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema[7.0].define(version: 2023_08_10_105908) do
+ActiveRecord::Schema[7.0].define(version: 2023_09_22_115708) do
   create_table "active_storage_attachments", charset: "utf8mb4", collation: "utf8mb4_unicode_ci", force: :cascade do |t|
     t.string "name", null: false
     t.string "record_type", null: false
@@ -59,6 +59,7 @@
     t.boolean "description_nl_present", default: false
     t.boolean "description_en_present", default: false
     t.integer "series_count", default: 0, null: false
+    t.boolean "draft", default: false
     t.index ["judge_id"], name: "index_activities_on_judge_id"
     t.index ["name_nl"], name: "index_activities_on_name_nl"
     t.index ["path", "repository_id"], name: "index_activities_on_path_and_repository_id", unique: true