Merge pull request #4998 from dodona-edu/feat/add-draft-flag

Add draft flag to activities

app/assets/stylesheets/models/activities.css.scss

@@ -8,6 +8,10 @@
     color: var(--d-on-surface-muted);
   }
 
+  .activity-title .mdi::before {
+    vertical-align: bottom;
+  }
+
   th.type-icon,
   td.type-icon {
     width: 18px;

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(TRUE)
 #
 
 require 'pathname'
@@ -80,6 +81,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'
@@ -322,12 +324,15 @@ def accessible?(user, course)
       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

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(TRUE)
 #
 
 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(TRUE)
 #
 
 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,9 @@ def read?
 
   def permitted_attributes
     if update?
-      %i[access name_nl name_en]
+      permitted_attributes = %i[access name_nl name_en]
+      permitted_attributes << :draft if record.draft?
+      permitted_attributes
     else
       []
     end

app/views/activities/_activities_table.html.erb

@@ -25,11 +25,8 @@
     <% local_assigns[:activities].each do |activity| %>
       <tr>
         <td class='status-icon'>
-          <% if user_signed_in? %>
-            <% if current_user.repository_admin?(activity.repository) || current_user.course_admin?(@course) %>
-              <%= render partial: 'activities/repository_status', locals: {activity: activity, series: local_assigns[:series]} %>
-            <% end %>
-            <%= render partial: 'activities/user_status_icon', locals: {activity: activity, series: local_assigns[:series], user: user} %>
+          <% if user_signed_in? && (current_user.repository_admin?(activity.repository) || current_user.course_admin?(@course)) %>
+            <%= render partial: 'activities/repository_status', locals: {activity: activity, series: local_assigns[:series]} %>
           <% end %>
         </td>
 
@@ -38,7 +35,10 @@
         </td>
 
         <td class="link">
-          <span class="ellipsis-overflow" title="<%= activity.name %>">
+          <span class="ellipsis-overflow activity-title" title="<%= activity.name %>">
+            <% if user_signed_in? %>
+              <%= render partial: 'activities/user_status_icon', locals: {activity: activity, series: local_assigns[:series], user: user} %>
+            <% end %>
             <% if activity.accessible?(current_user, @course) %>
               <%= link_to activity.name, get_activity_path.call(activity) %>
             <% elsif activity.access_public? %>

app/views/activities/_draft_notice.html.erb

@@ -0,0 +1,14 @@
+<% if @activity.draft? %>
+  <div class="alert alert-warning">
+    <i class="mdi mdi-file-document-edit-outline"></i>
+    <%= t "activities.show.alert_draft_html" %>
+    <% 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 %>

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">
@@ -32,13 +28,10 @@
   </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/_series_activities_add_table.html.erb

@@ -29,9 +29,7 @@
         <% end %>
       </td>
       <td class="status-icon">
-        <%= raw "<i class='mdi mdi-eye-off mdi-18' title='#{t("activities.index.private")}'></i>" if activity.access_private? %>
-        <%= raw "<i class='mdi mdi-delete mdi-18' title='#{t("activities.index.removed")}'></i>" if activity.removed? %>
-        <%= raw "<i class='mdi mdi-alert-circle mdi-18' title='#{t("activities.index.invalid")}'></i>" if activity.not_valid? %>
+        <%= render partial: 'activities/repository_status', locals: { activity: activity } %>
         <%= activity_icon(activity) %>
       </td>
       <td class="link">

app/views/activities/edit.html.erb

@@ -1,6 +1,7 @@
 <%= render 'navbar_links' %>
 <div class="row">
   <div class="col-md-10 offset-md-1 col-12">
+    <%= render partial: 'draft_notice' %>
     <div class="card">
       <div class="card-title card-title-colored">
         <h2 class="card-title-text">

app/views/activities/info.html.erb

@@ -9,6 +9,7 @@
 %>
 <div class="row">
   <div class="col-lg-10 offset-lg-1 col-12">
+    <%= render partial: 'draft_notice' %>
     <div class="alert alert-info">
       <% if @activity.exercise? && @activity.solutions.any? %>
         <%= t '.visibility_solution_warning' %>

app/views/activities/show.html.erb

@@ -26,6 +26,8 @@
   next_tooltip_actionable = next_activity ? t('.navigation.next_actionable') : t('.navigation.back_to_course_actionable')
 end %>
 
+<%= render partial: 'draft_notice' %>
+
 <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

@@ -67,6 +67,7 @@ en:
         mine: "My activities"
         featured: "Featured activities"
         all: "All activities"
+      draft-notice: "This activity is a draft and thus not visible for students."
     show:
       code: Code
       handin: Hand in
@@ -97,6 +98,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_html: This activity is a <a href="https://docs.dodona.be/en/faq/activities/#what-is-a-draft-activity" target="_blank">draft</a> and thus not visible for students.
+      alert_draft_edit: Publish activity.
     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

@@ -67,6 +67,7 @@ nl:
         mine: "Mijn activiteiten"
         featured: "Uitgelichte activiteiten"
         all: "Alle activiteiten"
+      draft-notice: "Deze activiteit is nog een concept. Ze is niet zichtbaar voor studenten."
     show:
       code: Code
       handin: Indienen
@@ -97,6 +98,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_html: Deze oefening is nog een <a href="https://docs.dodona.be/nl/faq/activities/#wat-is-een-conceptactiviteit" target="_blank">concept</a>. Ze is niet zichtbaar voor studenten.
+      alert_draft_edit: Deze oefening publiceren.
     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: Ongepubliceerde oefeningen
+      all-draft-exercises: Alle ongepubliceerde oefeningen
     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/migrate/20231026075353_make_draft_default_true.rb

@@ -0,0 +1,5 @@
+class MakeDraftDefaultTrue < ActiveRecord::Migration[7.1]
+  def change
+    change_column_default :activities, :draft, from: false, to: true
+  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.1].define(version: 2023_10_26_075353) 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: true
     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

db/seeds.rb

@@ -293,8 +293,11 @@ def fill_series_with_realistic_submissions(s)
   RepositoryAdmin.create(repository: activity_repo, user: zeus)
   RepositoryAdmin.create(repository: big_activity_repo, user: zeus)
 
-  contents_list = ContentPage.all.to_a
-  exercises_list = Exercise.all.to_a
+  # remove draft status from all activities except the first 5
+  Activity.where.not(id: Activity.first(5)).update_all(draft: false)
+
+  contents_list = ContentPage.where(draft: false).to_a
+  exercises_list = Exercise.where(draft: false).all.to_a
 
   puts "Add series, content pages, exercises, read states and submissions to courses (#{Time.now - start})"