Create basic UI for saving an annotation

app/assets/javascripts/code_listing/annotation.ts

@@ -34,6 +34,10 @@ export abstract class Annotation {
         // Do nothing.
     }
 
+    protected save(): void {
+        // Do nothing.
+    }
+
     public get global(): boolean {
         return this.line === null;
     }
@@ -81,16 +85,27 @@ export abstract class Annotation {
 
         // Update button.
         if (this.modifiable) {
-            const link = document.createElement("a");
-            link.addEventListener("click", () => this.edit());
-            link.classList.add("btn", "btn-icon", "annotation-control-button", "annotation-edit");
-            link.title = this.editTitle;
+            const edit_link = document.createElement("a");
+            edit_link.addEventListener("click", () => this.edit());
+            edit_link.classList.add("btn", "btn-icon", "annotation-control-button", "annotation-edit");
+            edit_link.title = this.editTitle;
 
-            const icon = document.createElement("i");
-            icon.classList.add("mdi", "mdi-pencil");
-            link.appendChild(icon);
+            const edit_icon = document.createElement("i");
+            edit_icon.classList.add("mdi", "mdi-pencil");
+            edit_link.appendChild(edit_icon);
 
-            header.appendChild(link);
+            header.appendChild(edit_link);
+
+            const save_link = document.createElement("a");
+            save_link.addEventListener("click", () => this.save());
+            save_link.classList.add("btn", "btn-icon", "annotation-control-button", "annotation-edit");
+            save_link.title = this.saveTitle;
+
+            const save_icon = document.createElement("i");
+            save_icon.classList.add("mdi", "mdi-content-save");
+            save_link.appendChild(save_icon);
+
+            header.appendChild(save_link);
         }
 
         if (this.transitionable("answered")) {
@@ -196,6 +211,10 @@ export abstract class Annotation {
         return "";
     }
 
+    protected get saveTitle(): string {
+        return "";
+    }
+
     protected get hasNotice(): boolean {
         return false;
     }

app/assets/javascripts/code_listing/user_annotation.ts

@@ -84,6 +84,16 @@ export class UserAnnotation extends Annotation {
         this.__html.querySelector(".annotation-text").replaceWith(editor);
     }
 
+    protected save(): void {
+        const modal = new bootstrap.Modal(document.getElementById("save-annotation"));
+        const fromField = document.getElementById("save-annotation-from");
+        const textField = document.getElementById("save-annotation-text")
+
+        fromField.value = this.id;
+        textField.value = this.__rawText;
+        modal.show();
+    }
+
     protected get meta(): string {
         const timestamp = I18n.l("time.formats.annotation", this.createdAt);
         const user = this.user.name;
@@ -136,4 +146,8 @@ export class UserAnnotation extends Annotation {
     protected get editTitle(): string {
         return I18n.t("js.user_annotation.edit");
     }
+
+    protected get saveTitle(): string {
+        return I18n.t("js.user_annotation.save")
+    }
 }

app/controllers/saved_annotations_controller.rb

@@ -0,0 +1,46 @@
+class SavedAnnotationsController < ApplicationController
+  before_action :set_saved_annotation, only: %i[show update destroy]
+
+  def index
+    authorize SavedAnnotation
+    @saved_annotations = apply_scopes(policy_scope(SavedAnnotation.all))
+  end
+
+  def show; end
+
+  def create
+    annotation = Annotation.find(params[:from])
+    authorize annotation, :show?
+    @saved_annotation = SavedAnnotation.new(permitted_attributes(SavedAnnotation).merge({ user: current_user, course: annotation.course, exercise: annotation.submission.exercise }))
+    authorize @saved_annotation
+    respond_to do |format|
+      if @saved_annotation.save
+        annotation.update(saved_annotation: @saved_annotation)
+        format.json { render :show, status: :created, location: @saved_annotation }
+      else
+        format.json { render json: @saved_annotation.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  def update
+    respond_to do |format|
+      if @saved_annotation.update(args)
+        format.json { render :show, status: :ok, location: @saved_annotation }
+      else
+        format.json { render json: @saved_annotation.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  def destroy
+    @saved_annotation.destroy
+  end
+
+  private
+
+  def set_saved_annotation
+    @saved_annotation = SavedAnnotation.find(params[:id])
+    authorize @saved_annotation
+  end
+end

app/models/annotation.rb

@@ -2,18 +2,19 @@
 #
 # Table name: annotations
 #
-#  id                 :bigint           not null, primary key
-#  line_nr            :integer
-#  submission_id      :integer
-#  user_id            :integer
-#  annotation_text    :text(16777215)
-#  created_at         :datetime         not null
-#  updated_at         :datetime         not null
-#  evaluation_id      :bigint
-#  type               :string(255)      default("Annotation"), not null
-#  question_state     :integer
-#  last_updated_by_id :integer          not null
-#  course_id          :integer          not null
+#  id                  :bigint           not null, primary key
+#  line_nr             :integer
+#  submission_id       :integer
+#  user_id             :integer
+#  annotation_text     :text(16777215)
+#  created_at          :datetime         not null
+#  updated_at          :datetime         not null
+#  evaluation_id       :bigint
+#  type                :string(255)      default("Annotation"), not null
+#  question_state      :integer
+#  last_updated_by_id  :integer          not null
+#  course_id           :integer          not null
+#  saved_annotation_id :bigint
 #
 class Annotation < ApplicationRecord
   include ApplicationHelper
@@ -22,6 +23,7 @@ class Annotation < ApplicationRecord
   belongs_to :submission
   belongs_to :user
   belongs_to :evaluation, optional: true
+  belongs_to :saved_annotation, optional: true
   belongs_to :last_updated_by, class_name: 'User'
 
   validates :annotation_text, presence: true, length: { minimum: 1, maximum: 10_000 }

app/models/provider/surf.rb

@@ -1,3 +1,24 @@
+# == Schema Information
+#
+# Table name: providers
+#
+#  id                :bigint           not null, primary key
+#  type              :string(255)      default("Provider::Saml"), not null
+#  institution_id    :bigint           not null
+#  identifier        :string(255)
+#  certificate       :text(16777215)
+#  entity_id         :string(255)
+#  slo_url           :string(255)
+#  sso_url           :string(255)
+#  created_at        :datetime         not null
+#  updated_at        :datetime         not null
+#  mode              :integer          default("prefer"), not null
+#  active            :boolean          default(TRUE)
+#  authorization_uri :string(255)
+#  client_id         :string(255)
+#  issuer            :string(255)
+#  jwks_uri          :string(255)
+#
 class Provider::Surf < Provider
   validates :certificate, :entity_id, :sso_url, :slo_url, absence: true
   validates :authorization_uri, :client_id, :issuer, :jwks_uri, absence: true

app/models/question.rb

@@ -2,18 +2,19 @@
 #
 # Table name: annotations
 #
-#  id                 :bigint           not null, primary key
-#  line_nr            :integer
-#  submission_id      :integer
-#  user_id            :integer
-#  annotation_text    :text(16777215)
-#  created_at         :datetime         not null
-#  updated_at         :datetime         not null
-#  evaluation_id      :bigint
-#  type               :string(255)      default("Annotation"), not null
-#  question_state     :integer
-#  last_updated_by_id :integer          not null
-#  course_id          :integer          not null
+#  id                  :bigint           not null, primary key
+#  line_nr             :integer
+#  submission_id       :integer
+#  user_id             :integer
+#  annotation_text     :text(16777215)
+#  created_at          :datetime         not null
+#  updated_at          :datetime         not null
+#  evaluation_id       :bigint
+#  type                :string(255)      default("Annotation"), not null
+#  question_state      :integer
+#  last_updated_by_id  :integer          not null
+#  course_id           :integer          not null
+#  saved_annotation_id :bigint
 #
 class Question < Annotation
   after_commit :clear_transition

app/models/saved_annotation.rb

@@ -0,0 +1,23 @@
+# == Schema Information
+#
+# Table name: saved_annotations
+#
+#  id              :bigint           not null, primary key
+#  title           :string(255)      not null
+#  annotation_text :text(16777215)
+#  user_id         :integer          not null
+#  exercise_id     :integer          not null
+#  course_id       :integer          not null
+#  created_at      :datetime         not null
+#  updated_at      :datetime         not null
+#
+class SavedAnnotation < ApplicationRecord
+  validates :title, presence: true
+  validates :annotation_text, presence: true
+
+  belongs_to :user
+  belongs_to :exercise
+  belongs_to :course
+
+  has_many :annotations, dependent: :nullify
+end

app/policies/saved_annotation_policy.rb

@@ -0,0 +1,37 @@
+class SavedAnnotationPolicy < ApplicationPolicy
+  class Scope < ApplicationPolicy::Scope
+    def resolve
+      if user&.zeus?
+        scope.all
+      elsif user
+        scope.where(user_id: user.id)
+      else
+        scope.none
+      end
+    end
+  end
+
+  def index?
+    user&.a_course_admin?
+  end
+
+  def create?
+    record.course_id.present? && user&.course_admin?(record.course)
+  end
+
+  def show?
+    record.user_id == user.id
+  end
+
+  def update?
+    record.user_id == user.id
+  end
+
+  def destroy?
+    record.user_id == user.id
+  end
+
+  def permitted_attributes
+    %i[title annotation_text]
+  end
+end

app/views/feedbacks/show.html.erb

@@ -73,6 +73,7 @@
           </div>
         </div>
         <% if @feedback.submission.present? %>
+          <%= render 'saved_annotations/modal' %>
           <div class="code-table" data-submission-id="<%= @feedback.submission.id %>">
             <%= @feedback.submission.judge.renderer.new(@feedback.submission, current_user).parse %>
           </div>

app/views/saved_annotations/_form.html.erb

@@ -0,0 +1,12 @@
+<%= form_for(model, html: { class: 'form' }) do |f| %>
+  <%= hidden_field_tag 'from', nil, id: "save-annotation-from" %>
+  <div class="field form-group row">
+    <%= f.label :title, class: "col-sm-4 col-form-label" %>
+    <div class="col-sm-8"><%= f.text_field :title, required: true, class: "form-control" %></div>
+  </div>
+  <div class="field form-group row">
+    <%= f.label :annotation_text, class: "col-sm-4 col-form-label" %>
+    <div class="col-sm-8"><%= f.text_area :annotation_text, required: true, class: "form-control", rows: "4", id: "save-annotation-text" %></div>
+    <span class="help-block offset-sm-4 col-sm-8"><%= t ".annotation_text-help_html" %></span>
+  </div>
+<% end %>

app/views/saved_annotations/_modal.html.erb

@@ -0,0 +1,16 @@
+<div class="modal fade" id="save-annotation" tabindex="-1" role="dialog">
+  <div class="modal-dialog" role="document">
+    <div class="modal-content">
+      <div class="modal-header">
+        <h4 class="modal-title"><%= t ".title" %></h4>
+        <button type="button" class="btn-close" data-bs-dismiss="modal"></button>
+      </div>
+      <div class="modal-body">
+        <%= render 'saved_annotations/form', model: SavedAnnotation.new %>
+      </div>
+      <div class="modal-footer">
+        <button id="save-annotation-submit" type="button" class="btn btn-primary btn-text"><%= t ".save" %></button>
+      </div>
+    </div>
+  </div>
+</div>

app/views/submissions/_description.html.erb

@@ -90,6 +90,7 @@
 <% end %>
 
 <% unless submission.queued? or submission.running? %>
+  <%= render 'saved_annotations/modal' %>
   <%= submission.judge.renderer.new(submission, current_user).parse %>
 <% end %>
 

config/locales/js/en.yml

@@ -142,6 +142,7 @@ en:
       cancel: 'Cancel'
       delete: 'Delete'
       edit: 'Edit comment'
+      save: 'Save comment'
       help: 'Press Shift + Enter to send. <a href="https://docs.dodona.be/en/references/exercise-description/#markdown" target="_blank">Markdown</a> is supported.'
       fields:
         annotation_text: 'Comment'

config/locales/js/nl.yml

@@ -142,7 +142,8 @@ nl:
       cancel: 'Annuleren'
       delete: 'Verwijderen'
       edit: 'Opmerking bewerken'
-      help: 'Druk Shift + Enter om te verzenden. <a href="https://docs.dodona.be/nl/references/exercise-description/#markdown" target="_blank">Markdown</a>  wordt ondersteund.'
+      save: 'Opmerking opslaan'
+      help: 'Druk Shift + Enter om te verzenden. <a href="https://docs.dodona.be/nl/references/exercise-description/#markdown" target="_blank">Markdown</a> wordt ondersteund.'
       fields:
         annotation_text: 'Opmerking'
       delete_confirm: 'Ben je zeker dat je deze opmerking wil verwijderen?'

config/locales/views/saved_annotations/en.yml

@@ -0,0 +1,7 @@
+en:
+  saved_annotations:
+    form:
+      annotation_text-help_html: '<a href="https://docs.dodona.be/en/references/exercise-description/#markdown" target="_blank">Markdown</a> is supported.'
+    modal:
+      save: "Save"
+      title: "Save comment for re-use"

config/locales/views/saved_annotations/nl.yml

@@ -0,0 +1,7 @@
+nl:
+  saved_annotations:
+    form:
+      annotation_text-help_html: '<a href="https://docs.dodona.be/nl/references/exercise-description/#markdown" target="_blank">Markdown</a> wordt ondersteund.'
+    modal:
+      save: "Opslaan"
+      title: "Opmerking opslaan om later te hergebruiken"

config/routes.rb

@@ -171,6 +171,8 @@
 
     resources :annotations, only: %i[index show create update destroy]
 
+    resources :saved_annotations, only: %i[index show create update destroy]
+
     get 'questions', to: 'annotations#question_index'
 
     resources :submissions, only: %i[index show create edit] do

db/migrate/20220502130036_create_saved_annotations.rb

@@ -0,0 +1,17 @@
+class CreateSavedAnnotations < ActiveRecord::Migration[7.0]
+  def change
+    create_table :saved_annotations do |t|
+      t.string :title, null: false
+      t.text :annotation_text, size: :medium
+      t.integer :user_id, foreign_key: true, type: :integer, null: false
+      t.references :exercise, foreign_key: { to_table: :activities }, type: :integer, null: false
+      t.references :course, foreign_key: true, type: :integer, null: false
+
+      t.timestamps
+    end
+
+    change_table :annotations do |t|
+      t.references :saved_annotation, foreign_key: true
+    end
+  end
+end