excused assignments backend

closes CNVS-17549
closes CNVS-17553

Test plan:
  * excuse and unexcuse assignments from the api
  * student grades should be correct

Change-Id: Id8e0fa9edb404bdf65bff0bfc4c79c6f33e8a7e4
Reviewed-on: https://gerrit.instructure.com/53409
Tested-by: Jenkins
Reviewed-by: Josh Simpson <jsimpson@instructure.com>
QA-Review: Adrian Foong <afoong@instructure.com>
Product-Review: Cameron Matheson <cameron@instructure.com>

Author: cmatheson

app/coffeescripts/grade_calculator.coffee

@@ -10,7 +10,7 @@ define [
     [trueList, falseList]
 
   class GradeCalculator
-    # each submission needs fields: score, points_possible, assignment_id, assignment_group_id
+    # each submission needs fields: score, points_possible, assignment_id, assignment_group_id, excused
     #   to represent assignments that the student hasn't submitted, pass a
     #   submission with score == null
     #
@@ -62,6 +62,9 @@ define [
           s = assignment_id: assignmentId, score: null
         submissions.push dummySubmissions...
 
+      # filter out excused assignments
+      submissions = _(submissions).filter (s) -> not s.excused
+
       submissionsByAssignment = arrayToObj submissions, "assignment_id"
 
       submissionData = _(submissions).map (s) =>

app/controllers/submissions_api_controller.rb

@@ -132,6 +132,11 @@
 #           "description": "Whether the assignment is visible to the user who submitted the assignment. Submissions where `assignment_visible` is false no longer count towards the student's grade and the assignment can no longer be accessed by the student. `assignment_visible` becomes false for submissions that do not have a grade and whose assignment is no longer assigned to the student's section.",
 #           "example": true,
 #           "type": "boolean"
+#         },
+#         "excused": {
+#           "description": "Whether the assignment is excused.  Excused assignments have no impact on a user's grade.",
+#           "example": true,
+#           "type": "boolean"
 #         }
 #       }
 #     }
@@ -536,6 +541,8 @@ def create_file
   #   a posted_grade in the "points" or "percentage" format is sent, the grade
   #   will only be accepted if the grade equals one of those two values.
   #
+  # @argument submission[excuse] [Boolean]
+  #   Sets the "excused" status of an assignment.
   #
   # @argument rubric_assessment [RubricAssessment]
   #   Assign a rubric assessment to this assignment submission. The
@@ -593,8 +600,9 @@ def update
       submission = { :grader => @current_user }
       if params[:submission].is_a?(Hash)
         submission[:grade] = params[:submission].delete(:posted_grade)
+        submission[:excuse] = params[:submission].delete(:excuse)
       end
-      if submission[:grade]
+      if submission[:grade] || submission[:excuse]
         @submissions = @assignment.grade_student(@user, submission)
         @submission = @submissions.first
       else

app/models/assignment.rb

@@ -855,7 +855,8 @@ def submitted_count
       (submittable_type? || submission_types == "discussion_topic") &&
       context.grants_right?(user, session, :participate_as_student) &&
       !locked_for?(user) &&
-      visible_to_user?(user)
+      visible_to_user?(user) &&
+      !excused_for?(user)
     }
     can :submit and can :attach_submission_comment_files
 
@@ -976,6 +977,8 @@ def grade_student(original_student, opts={})
     group_comment = Canvas::Plugin.value_to_boolean(opts.delete(:group_comment))
     group, students = group_students(original_student)
     grader = opts.delete :grader
+    grade = opts.delete :grade
+    score = opts.delete :score
     comment = {
       :comment => (opts.delete :comment),
       :attachments => (opts.delete :comment_attachments),
@@ -986,22 +989,36 @@ def grade_student(original_student, opts={})
     }
     comment[:group_comment_id] = CanvasSlug.generate_securish_uuid if group_comment && group
     submissions = []
+
+    if opts.key? :excuse
+      opts[:excused] = Canvas::Plugin.value_to_boolean(opts.delete(:excuse))
+    end
+
+    grade_group_students = !grade_group_students_individually && !opts.key?(:excused)
+
     find_or_create_submissions(students) do |submission|
       submission_updated = false
       submission.skip_grade_calc = opts[:skip_grade_calc]
       student = submission.user
-      if student == original_student || !grade_group_students_individually
+      if student == original_student || grade_group_students
         previously_graded = submission.grade.present?
         next if previously_graded && dont_overwrite_grade
+
+        did_grade = false
         submission.attributes = opts
         submission.assignment_id = self.id
         submission.user_id = student.id
         submission.grader_id = grader.try(:id)
-        if !opts[:grade] || opts[:grade] == ""
+
+        if grade.present? || score.present?
+          submission.grade = grade
+          submission.score = score
+          submission.excused = false
+        else
           submission.score = nil
           submission.grade = nil
         end
-        did_grade = false
+
         if submission.grade
           did_grade = true
           submission.score = self.grade_to_score(submission.grade)
@@ -1943,6 +1960,11 @@ def unpublish
     self.save
   end
 
+  def excused_for?(user)
+    s = submissions.where(user_id: user.id).first_or_initialize
+    s.excused?
+  end
+
   # simply versioned models are always marked new_record, but for our purposes
   # they are not new. this ensures that assignment override caching works as
   # intended for versioned assignments

app/models/submission.rb

@@ -246,7 +246,7 @@ def new_version_needed?
   end
 
   def update_final_score
-    if score_changed?
+    if score_changed? || excused_changed?
       if skip_grade_calc
         Rails.logger.info "GRADES: NOT recomputing scores for submission #{global_id} because skip_grade_calc was set"
       else
@@ -1030,8 +1030,15 @@ def missing?
     end
     alias_method :missing, :missing?
 
+    # QUESTIONS ABOUT EXCUSED:
+    #   * what happens for group assignments? excuse individually
+    #     * can't excuse for group assignments in speedgrader 1.0
+    #     * TODO make sure Assignment#representatives is updated accordingly
+    #
+    # QUESTIONS FOR ME:
+    #   * are we messing up graded / not graded counts???
     def graded?
-      !!self.score && self.workflow_state == 'graded'
+      excused? || (!!score && workflow_state == 'graded')
     end
   end
   include Tardiness
@@ -1127,6 +1134,16 @@ def attach_screenshot(attachment)
     self.save!
   end
 
+  def excused=(excused)
+    if excused
+      self[:excused] = true
+      self.grade = nil
+      self.score = nil
+    else
+      self[:excused] = false
+    end
+  end
+
   def comments_for(user)
     grants_right?(user, :read_grade)? submission_comments : visible_submission_comments
   end
@@ -1145,7 +1162,7 @@ def update_participation
     return if assignment.deleted? || assignment.muted?
     return unless self.user_id
 
-    if score_changed? || grade_changed?
+    if score_changed? || grade_changed? || excused_changed?
       ContentParticipation.create_or_update({
         :content => self,
         :user => self.user,

db/migrate/20150416231745_add_excused_to_submissions.rb

@@ -0,0 +1,7 @@
+class AddExcusedToSubmissions < ActiveRecord::Migration
+  tag :predeploy
+
+  def change
+    add_column :submissions, :excused, :boolean
+  end
+end

lib/api/v1/submission.rb

@@ -90,9 +90,9 @@ def submission_json(submission, assignment, user, session, context = nil, includ
     hash
   end
 
-  SUBMISSION_JSON_FIELDS = %w(id user_id url score grade attempt submission_type submitted_at body assignment_id graded_at grade_matches_current_submission grader_id workflow_state).freeze
+  SUBMISSION_JSON_FIELDS = %w(id user_id url score grade excused attempt submission_type submitted_at body assignment_id graded_at grade_matches_current_submission grader_id workflow_state).freeze
   SUBMISSION_JSON_METHODS = %w(late).freeze
-  SUBMISSION_OTHER_FIELDS = %w(attachments discussion_entries)
+  SUBMISSION_OTHER_FIELDS = %w(attachments discussion_entries).freeze
 
   def submission_attempt_json(attempt, assignment, user, session, version_idx = nil, context = nil)
     context ||= assignment.context

lib/grade_calculator.rb

@@ -56,7 +56,7 @@ def compute_scores
         except(:order, :select).
         for_user(@user_ids).
         where(assignment_id: @assignments.map(&:id)).
-        select("submissions.id, user_id, assignment_id, score")
+        select("submissions.id, user_id, assignment_id, score, excused")
     submissions_by_user = @submissions.group_by(&:user_id)
 
     scores = []
@@ -147,13 +147,16 @@ def create_group_sums(submissions, user_id, ignore_ungraded=true)
         s = nil if @ignore_muted && a.muted?
 
         {
-          :assignment => a,
-          :submission => s,
-          :score => s && s.score,
-          :total => a.points_possible || 0,
+          assignment: a,
+          submission: s,
+          score: s && s.score,
+          total: a.points_possible || 0,
+          excused: s && s.excused?,
         }
       end
+
       group_submissions.reject! { |s| s[:score].nil? } if ignore_ungraded
+      group_submissions.reject! { |s| s[:excused] }
       group_submissions.each { |s| s[:score] ||= 0 }
 
       logged_submissions = group_submissions.map { |s| loggable_submission(s) }

spec/apis/v1/gradebook_history_api_spec.rb

@@ -142,19 +142,6 @@
       @submission4 = @assignment2.submit_homework(@student1)
     end
 
-    it 'should return submission version API objects' do
-      @submission4.update_attributes!(:graded_at => 24.hours.ago, :grader_id => @other_grader.id, :score => 70)
-
-      json = api_call_as_user(@teacher, :get, "/api/v1/courses/#{@course.id}/gradebook_history/feed.json", {
-        :controller => 'gradebook_history_api',
-        :action => 'feed',
-        :format => 'json',
-        :course_id => @course.id.to_s
-      }).first
-
-      expect(json.keys.sort).to eq ["assignment_id", "assignment_name", "attempt", "body", "current_grade", "current_graded_at", "current_grader", "grade", "grade_matches_current_submission", "graded_at", "grader", "grader_id", "id", "late", "preview_url", "score", "submission_type", "submitted_at", "url", "user_id", "user_name", "workflow_state"]
-    end
-
     it 'should return all applicable versions' do
       @submission1.update_attributes!(:graded_at => Time.zone.now, :grader_id => @grader.id, :score => 100)
       @submission2.update_attributes!(:graded_at => Time.zone.now, :grader_id => @super_grader.id, :score => 90)

spec/apis/v1/stream_items_api_spec.rb

@@ -281,6 +281,7 @@
       'created_at' => StreamItem.last.created_at.as_json,
       'updated_at' => StreamItem.last.updated_at.as_json,
       'grade' => '12',
+      'excused' => false,
       'grader_id' => @teacher.id,
       'graded_at' => @sub.graded_at.as_json,
       'score' => 12,
@@ -386,6 +387,7 @@
       'created_at' => StreamItem.last.created_at.as_json,
       'updated_at' => StreamItem.last.updated_at.as_json,
       'grade' => nil,
+      'excused' => nil,
       'grader_id' => nil,
       'graded_at' => nil,
       'score' => nil,

spec/apis/v1/submissions_api_spec.rb

@@ -58,6 +58,7 @@ def submit_homework(assignment, student, opts = {:body => "test!"})
       "preview_url" => "http://www.example.com/courses/#{@course.id}/assignments/#{@assignment.id}/submissions/#{student.id}?preview=1",
       "user_id"=>student.id,
       "grade"=>nil,
+      "excused" => nil,
       "grader_id"=>nil,
       "body"=>nil,
       "submitted_at"=>nil,
@@ -604,6 +605,7 @@ def submission_with_comment
     expect(json).to eq({
         "id"=>sub1.id,
         "grade"=>"A-",
+        "excused" => sub1.excused,
         "grader_id"=>@teacher.id,
         "graded_at"=>sub1.graded_at.as_json,
         "body"=>"test!",
@@ -769,6 +771,7 @@ def submission_with_comment
     res =
       [{"id"=>sub1.id,
         "grade"=>"A-",
+        "excused" => sub1.excused,
         "grader_id"=>@teacher.id,
         "graded_at"=>sub1.graded_at.as_json,
         "body"=>"test!",
@@ -799,6 +802,7 @@ def submission_with_comment
         "submission_history"=>
          [{"id"=>sub1.id,
            "grade"=>nil,
+           "excused" => nil,
            "grader_id"=>nil,
            "graded_at"=>nil,
            "body"=>"test!",
@@ -815,6 +819,7 @@ def submission_with_comment
            "late"=>false},
           {"id"=>sub1.id,
            "grade"=>nil,
+           "excused" => nil,
            "grader_id"=>nil,
            "graded_at"=>nil,
            "assignment_id" => a1.id,
@@ -837,6 +842,7 @@ def submission_with_comment
            "late"=>false},
           {"id"=>sub1.id,
            "grade"=>"A-",
+           "excused" => false,
            "grader_id"=>@teacher.id,
            "graded_at"=>sub1.graded_at.as_json,
            "assignment_id" => a1.id,
@@ -910,6 +916,7 @@ def submission_with_comment
         "late"=>false},
        {"id"=>sub2.id,
         "grade"=>"F",
+        "excused" => sub2.excused,
         "grader_id"=>@teacher.id,
         "graded_at"=>sub2.graded_at.as_json,
         "assignment_id" => a1.id,
@@ -920,6 +927,7 @@ def submission_with_comment
         "submission_history"=>
          [{"id"=>sub2.id,
            "grade"=>"F",
+           "excused" => nil,
            "grader_id"=>@teacher.id,
            "graded_at"=>sub2.graded_at.as_json,
            "assignment_id" => a1.id,
@@ -1830,24 +1838,57 @@ def call_to_submissions_show(opts={})
     end
   end
 
-  it "should allow grading an uncreated submission" do
-    student = user(:active_all => true)
-    course_with_teacher(:active_all => true)
-    @course.enroll_student(student).accept!
-    a1 = @course.assignments.create!(:title => 'assignment1', :grading_type => 'letter_grade', :points_possible => 15)
+  describe '#update' do
+    before :once do
+      student_in_course(:active_all => true)
+      teacher_in_course(:active_all => true)
+      @assignment = @course.assignments.create!(:title => 'assignment1', :grading_type => 'letter_grade', :points_possible => 15)
 
-    json = api_call(:put,
-          "/api/v1/courses/#{@course.id}/assignments/#{a1.id}/submissions/#{student.id}.json",
-          { :controller => 'submissions_api', :action => 'update',
-            :format => 'json', :course_id => @course.id.to_s,
-            :assignment_id => a1.id.to_s, :user_id => student.id.to_s },
-          { :submission => { :posted_grade => 'B' } })
+    end
 
-    expect(Submission.count).to eq 1
-    @submission = Submission.first
+    it "should allow grading an uncreated submission" do
+      json = api_call(:put,
+            "/api/v1/courses/#{@course.id}/assignments/#{@assignment.id}/submissions/#{@student.id}.json",
+            { :controller => 'submissions_api', :action => 'update',
+              :format => 'json', :course_id => @course.id.to_s,
+              :assignment_id => @assignment.id.to_s, :user_id => @student.id.to_s },
+            { :submission => { :posted_grade => 'B' } })
 
-    expect(json['grade']).to eq 'B'
-    expect(json['score']).to eq 12.9
+      expect(Submission.count).to eq 1
+      @submission = Submission.first
+
+      expect(json['grade']).to eq 'B'
+      expect(json['score']).to eq 12.9
+    end
+
+    it "can excuse assignments" do
+      json = api_call(:put,
+            "/api/v1/courses/#{@course.id}/assignments/#{@assignment.id}/submissions/#{@student.id}.json",
+            { :controller => 'submissions_api', :action => 'update',
+              :format => 'json', :course_id => @course.id.to_s,
+              :assignment_id => @assignment.id.to_s, :user_id => @student.id.to_s },
+            { :submission => { excuse: "1" } })
+
+      submission = @assignment.submission_for_student(@student)
+      expect(submission).to be_excused
+      expect(json['excused']).to eq true
+    end
+
+    it "can unexcuse assignments" do
+      @assignment.grade_student(@student, excuse: true)
+      submission = @assignment.submission_for_student(@student)
+      expect(submission).to be_excused
+
+      json = api_call(:put,
+            "/api/v1/courses/#{@course.id}/assignments/#{@assignment.id}/submissions/#{@student.id}.json",
+            { :controller => 'submissions_api', :action => 'update',
+              :format => 'json', :course_id => @course.id.to_s,
+              :assignment_id => @assignment.id.to_s, :user_id => @student.id.to_s },
+            { :submission => { excuse: "0" } })
+
+      expect(submission.reload).not_to be_excused
+      expect(json['excused']).to eq false
+    end
   end
 
   it "should allow posting grade by sis id" do