Comments feature for grading

lib/cadet/assessments/answer.ex

@@ -16,6 +16,7 @@ defmodule Cadet.Assessments.Answer do
     field(:adjustment, :integer, default: 0)
     field(:xp, :integer, default: 0)
     field(:xp_adjustment, :integer, default: 0)
+    field(:comments, :string)
     field(:autograding_status, AutogradingStatus, default: :none)
     field(:autograding_results, {:array, :map}, default: [])
     field(:answer, :map)
@@ -30,7 +31,7 @@ defmodule Cadet.Assessments.Answer do
   end
 
   @required_fields ~w(answer submission_id question_id type)a
-  @optional_fields ~w(xp xp_adjustment grade adjustment grader_id)a
+  @optional_fields ~w(xp xp_adjustment grade adjustment grader_id comments)a
 
   def changeset(answer, params) do
     answer
@@ -49,7 +50,16 @@ defmodule Cadet.Assessments.Answer do
     answer
     |> cast(
       params,
-      ~w(grader_id xp xp_adjustment grade adjustment autograding_results autograding_status)a
+      ~w(
+        grader_id
+        xp
+        xp_adjustment
+        grade
+        adjustment
+        autograding_results
+        autograding_status
+        comments
+      )a
     )
     |> add_belongs_to_id_from_model(:grader, params)
     |> foreign_key_constraint(:grader_id)

lib/cadet/assessments/assessments.ex

@@ -482,7 +482,8 @@ defmodule Cadet.Assessments do
                    xp_adjustment: 0,
                    autograding_status: :none,
                    autograding_results: [],
-                   grader_id: nil
+                   grader_id: nil,
+                   comments: nil
                  })
                  |> Repo.update()}
             end

lib/cadet_web/controllers/assessments_controller.ex

@@ -213,6 +213,7 @@ defmodule CadetWeb.AssessmentsController do
 
             xp(:integer, "Final XP given to this question. Only provided for students.")
             grade(:integer, "Final grade given to this question. Only provided for students.")
+            comments(:string, "String of comments given for a student's answer", required: false)
 
             maxGrade(
               :integer,

lib/cadet_web/controllers/grading_controller.ex

@@ -285,6 +285,7 @@ defmodule CadetWeb.GradingController do
             xpAdjustment(:integer, "xp adjustment given")
             grader(Schema.ref(:GraderInfo))
             gradedAt(:string, "Last graded at", format: "date-time", required: false)
+            comments(:string, "Comments given by grader")
           end
         end,
       Grading:

lib/cadet_web/views/assessments_helpers.ex

@@ -85,7 +85,8 @@ defmodule CadetWeb.AssessmentsHelpers do
       xp: &((&1.xp || 0) + (&1.xp_adjustment || 0)),
       grade: &((&1.grade || 0) + (&1.adjustment || 0)),
       autogradingStatus: :autograding_status,
-      autogradingResults: build_results(%{results: answer.autograding_results})
+      autogradingResults: build_results(%{results: answer.autograding_results}),
+      comments: :comments
     })
   end
 

lib/cadet_web/views/grading_view.ex

@@ -72,7 +72,8 @@ defmodule CadetWeb.GradingView do
       adjustment: :adjustment,
       roomId: :room_id,
       xp: :xp,
-      xpAdjustment: :xp_adjustment
+      xpAdjustment: :xp_adjustment,
+      comments: :comments
     })
   end
 end

priv/repo/migrations/20190729154942_restore_comments.exs

@@ -0,0 +1,9 @@
+defmodule Cadet.Repo.Migrations.RestoreComments do
+  use Ecto.Migration
+
+  def change do
+    alter table(:answers) do
+      add(:comments, :text, null: true)
+    end
+  end
+end

test/cadet_web/controllers/assessments_controller_test.exs

@@ -302,6 +302,7 @@ defmodule CadetWeb.AssessmentsControllerTest do
             |> Enum.map(&Map.delete(&1, "gradedAt"))
             |> Enum.map(&Map.delete(&1, "autogradingResults"))
             |> Enum.map(&Map.delete(&1, "autogradingStatus"))
+            |> Enum.map(&Map.delete(&1, "comments"))
 
           assert expected_questions == resp_questions
         end

test/cadet_web/controllers/grading_controller_test.exs

@@ -295,7 +295,8 @@ defmodule CadetWeb.GradingControllerTest do
                     "name" => grader.name,
                     "id" => grader.id
                   },
-                  "gradedAt" => format_datetime(&1.updated_at)
+                  "gradedAt" => format_datetime(&1.updated_at),
+                  "comments" => &1.comments
                 },
                 "student" => %{
                   "name" => &1.submission.student.name,
@@ -342,7 +343,8 @@ defmodule CadetWeb.GradingControllerTest do
                     "name" => grader.name,
                     "id" => grader.id
                   },
-                  "gradedAt" => format_datetime(&1.updated_at)
+                  "gradedAt" => format_datetime(&1.updated_at),
+                  "comments" => &1.comments
                 },
                 "student" => %{
                   "name" => &1.submission.student.name,
@@ -414,7 +416,8 @@ defmodule CadetWeb.GradingControllerTest do
                     "name" => grader.name,
                     "id" => grader.id
                   },
-                  "gradedAt" => format_datetime(&1.updated_at)
+                  "gradedAt" => format_datetime(&1.updated_at),
+                  "comments" => &1.comments
                 },
                 "student" => %{
                   "name" => &1.submission.student.name,
@@ -461,7 +464,8 @@ defmodule CadetWeb.GradingControllerTest do
                     "name" => grader.name,
                     "id" => grader.id
                   },
-                  "gradedAt" => format_datetime(&1.updated_at)
+                  "gradedAt" => format_datetime(&1.updated_at),
+                  "comments" => &1.comments
                 },
                 "student" => %{
                   "name" => &1.submission.student.name,
@@ -614,6 +618,7 @@ defmodule CadetWeb.GradingControllerTest do
       assert answer_db.xp_adjustment == 0
       assert answer_db.grade == 0
       assert answer_db.adjustment == 0
+      assert answer_db.comments == nil
     end
 
     @tag authenticate: :staff
@@ -931,7 +936,8 @@ defmodule CadetWeb.GradingControllerTest do
                     "name" => grader.name,
                     "id" => grader.id
                   },
-                  "gradedAt" => format_datetime(&1.updated_at)
+                  "gradedAt" => format_datetime(&1.updated_at),
+                  "comments" => &1.comments
                 },
                 "student" => %{
                   "name" => &1.submission.student.name,
@@ -978,7 +984,8 @@ defmodule CadetWeb.GradingControllerTest do
                     "name" => grader.name,
                     "id" => grader.id
                   },
-                  "gradedAt" => format_datetime(&1.updated_at)
+                  "gradedAt" => format_datetime(&1.updated_at),
+                  "comments" => &1.comments
                 },
                 "student" => %{
                   "name" => &1.submission.student.name,

test/factories/assessments/answer_factory.ex

@@ -11,7 +11,8 @@ defmodule Cadet.Assessments.AnswerFactory do
         %Answer{
           answer: %{},
           autograding_status: :none,
-          room_id: Faker.Code.issn()
+          room_id: Faker.Code.issn(),
+          comments: Faker.Food.dish()
         }
       end