disable SRGB's assignment editing for past grading periods

Fixes CNVS-22398

CNVS-22398 was previously fixed with c428f832, however,
that commit created issues in Continious Integration, with
failures which only happened when the tests were run in
parallel. c428f832 was reverted in f566717.

This commit differs from the c428f832 by avoiding
using fakeENV to manage creating an ENV for testing
purposes. The function isInPastGradingPeriodAndNotAdmin
is not as well tested as it was in c428f832, but this is
preferable to having intermittent spec failures in CI.

Test Plan:

1. As an admin, create an account-level grading period
    which ends in the past.
2. Create an assignment that is due within that grading
    period.
3. As a teacher, go to Gradebook, click on the grades for
    that assignment.
4. Observe that they are not editable.
5. Navigate to Individual View. Select the past grading
    period.
6. Select the assignment and a student in the Content
    Selection section.
7. Verify that you are unable to edit this grade.
8. Click "Submission Details."
9. Verify that you are unable to edit this grade.

Change-Id: I381c3d3c78f00eabc7a685ef3a0e8fea0f886ac2
Reviewed-on: https://gerrit.instructure.com/65417
Tested-by: Jenkins
Reviewed-by: Derek Bender <djbender@instructure.com>
QA-Review: Jason Carter <jcarter@instructure.com>
Product-Review: Christi Wruck

Author: Strand McCutchen

app/coffeescripts/SubmissionDetailsDialog.coffee

@@ -21,6 +21,18 @@ define [
       else
         null
 
+      isInPastGradingPeriodAndNotAdmin = ((assignment) ->
+        return false unless ENV.GRADEBOOK_OPTIONS.multiple_grading_periods_enabled
+        return false unless ENV.GRADEBOOK_OPTIONS.latest_end_date_of_admin_created_grading_periods_in_the_past
+
+        return false unless ENV.current_user_roles
+        return false unless typeof ENV.current_user_roles.find == 'function'
+        return false if ENV.current_user_roles.find (elem) -> elem == 'admin'
+
+        latest_end_date = new Date(ENV.GRADEBOOK_OPTIONS.latest_end_date_of_admin_created_grading_periods_in_the_past)
+        assignment.due_at <= latest_end_date
+      )(@assignment)
+
       @url = @options.change_grade_url.replace(":assignment", @assignment.id).replace(":submission", @student.id)
       @submission = $.extend {}, @student["assignment_#{@assignment.id}"],
         label: "student_grading_#{@assignment.id}"
@@ -30,6 +42,7 @@ define [
         loading: true
         showPointsPossible: (@assignment.points_possible || @assignment.points_possible == '0') && @assignment.grading_type != "gpa_scale"
         shouldShowExcusedOption: true
+        isInPastGradingPeriodAndNotAdmin: isInPastGradingPeriodAndNotAdmin
       @submission["assignment_grading_type_is_#{@assignment.grading_type}"] = true
       @submission.grade = "EX" if @submission.excused
       @$el = $('<div class="use-css-transitions-for-show-hide" style="padding:0;"/>')
@@ -91,4 +104,4 @@ define [
       @scrollCommentsToBottom()
 
     @open: (assignment, student, options) ->
-      new SubmissionDetailsDialog(assignment, student, options).open()
+      new SubmissionDetailsDialog(assignment, student, options, ENV).open()

app/coffeescripts/ember/screenreader_gradebook/components/grading_cell_component.coffee

@@ -17,6 +17,15 @@ define [
     isPercent: Ember.computed.equal('assignment.grading_type', 'percent')
     isLetterGrade: Ember.computed.equal('assignment.grading_type', 'letter_grade')
     isPassFail: Ember.computed.equal('assignment.grading_type', 'pass_fail')
+    isInPastGradingPeriodAndNotAdmin: ( ->
+      return false unless ENV.GRADEBOOK_OPTIONS.multiple_grading_periods_enabled
+      return false unless ENV.GRADEBOOK_OPTIONS.latest_end_date_of_admin_created_grading_periods_in_the_past
+      return false if ENV.current_user_roles.contains("admin")
+
+      latest_end_date = new Date(ENV.GRADEBOOK_OPTIONS.latest_end_date_of_admin_created_grading_periods_in_the_past)
+
+      @assignment.due_at <= latest_end_date
+    ).property('assignment')
     nilPointsPossible: Ember.computed.none('assignment.points_possible')
     isGpaScale: Ember.computed.equal('assignment.grading_type', 'gpa_scale')
 

app/coffeescripts/ember/screenreader_gradebook/templates/components/grading-cell.hbs

@@ -6,7 +6,13 @@
     value=value
   }}
 {{ else }}
-  {{input value=value id=input-id type="text"}}
+  {{
+    input
+    value=value
+    id=input-id
+    type="text"
+    disabled=isInPastGradingPeriodAndNotAdmin
+  }}
 {{/if}}
 {{outOfText}}
 
@@ -19,6 +25,7 @@
       id="submission-excused"
       name="submission-excused"
       checked=excused
+      disabled=isInPastGradingPeriodAndNotAdmin
     }}
     {{#t}}Excuse This Assignment for the Selected Student{{/t}}
   </label>

app/coffeescripts/gradebook2/Gradebook.coffee

@@ -193,7 +193,7 @@ define [
       closedAdminGradingPeriods = @getClosedAdminGradingPeriods()
 
       if closedAdminGradingPeriods.length > 0
-        assignments = @getAssignmentsInClosedGradingPeriods(closedAdminGradingPeriods)
+        assignments = @getAssignmentsInClosedGradingPeriods()
         @disabledAssignments = assignments.map (a) ->
           a.id
 
@@ -221,10 +221,8 @@ define [
       else
         ENV.GRADEBOOK_OPTIONS.current_grading_period_id
 
-    getAssignmentsInClosedGradingPeriods: (gradingPeriods) ->
-      latestEndDate = new Date(gradingPeriods[0]?.end_date)
-      for gradingPeriod in gradingPeriods
-        latestEndDate = new Date(gradingPeriod.end_date) if latestEndDate < new Date(gradingPeriod.end_date)
+    getAssignmentsInClosedGradingPeriods: () ->
+      latestEndDate = new Date(ENV.GRADEBOOK_OPTIONS.latest_end_date_of_admin_created_grading_periods_in_the_past)
       #return assignments whose end date is within the latest closed's end date
       _.select @assignments, (a) =>
         @assignmentIsDueBeforeEndDate(a, latestEndDate)

app/controllers/gradebooks_controller.rb

@@ -53,7 +53,7 @@ def grade_summary
         gp_id = nil
         if multiple_grading_periods?
           set_current_grading_period
-          @grading_periods = get_active_grading_periods
+          @grading_periods = active_grading_periods
           gp_id = @current_grading_period_id unless view_all_grading_periods?
         end
 
@@ -250,14 +250,26 @@ def view_all_grading_periods?
     @current_grading_period_id == 0
   end
 
-  def get_active_grading_periods
-    GradingPeriod.for(@context).map do |gp|
+  def active_grading_periods
+    @active_grading_periods ||= GradingPeriod.for(@context).map do |gp|
       json = gp.as_json(only: [:id, :title, :start_date, :end_date], permissions: {user: @current_user})
       json[:grading_period][:is_last] = gp.last?
       json[:grading_period]
     end
   end
 
+  def latest_end_date_of_admin_created_grading_periods_in_the_past
+    periods = active_grading_periods.select do |period|
+      # false if current user is an admin
+      admin_created = period["permissions"]["manage"] == false
+      in_the_past = period["end_date"] <= Time.zone.now
+
+      admin_created && in_the_past
+    end
+    periods.map { |period| period["end_date"] }.compact.sort.last
+  end
+  private :latest_end_date_of_admin_created_grading_periods_in_the_past
+
   def set_js_env
     @gradebook_is_editable = @context.grants_right?(@current_user, session, :manage_grades)
     per_page = Setting.get('api_max_per_page', '50').to_i
@@ -299,7 +311,8 @@ def set_js_env
       :speed_grader_enabled => @context.allows_speed_grader?,
       :differentiated_assignments_enabled => @context.feature_enabled?(:differentiated_assignments),
       :multiple_grading_periods_enabled => multiple_grading_periods?,
-      :active_grading_periods => get_active_grading_periods,
+      :active_grading_periods => active_grading_periods,
+      :latest_end_date_of_admin_created_grading_periods_in_the_past => latest_end_date_of_admin_created_grading_periods_in_the_past,
       :current_grading_period_id => @current_grading_period_id,
       :outcome_gradebook_enabled => @context.feature_enabled?(:outcome_gradebook),
       :custom_columns_url => api_v1_course_custom_gradebook_columns_url(@context),

app/views/jst/_grading_box.handlebars

@@ -4,7 +4,9 @@
           class="grading_value grading_box"
           id="student_grading_{{assignment.id}}"
           aria-labelledby="default_grade_points"
-          aria-describedby="default_grade_description"/>
+          aria-describedby="default_grade_description"
+          {{ disabledIf isInPastGradingPeriodAndNotAdmin }}
+          />
 {{/if}}
 {{#if assignment_grading_type_is_percent}}
   <span name="{{inputName}}" class="grading_box" id="student_grading_{{assignment.id}}">
@@ -14,7 +16,9 @@
             value="{{ grade }}"
             class="grading_value"
             aria-labelledby="default_grade_points"
-            aria-describedby="default_grade_description"/>
+            aria-describedby="default_grade_description"
+            {{ disabledIf isInPastGradingPeriodAndNotAdmin }}
+            />
   </span>
 {{/if}}
 {{#if assignment_grading_type_is_letter_grade}}
@@ -24,7 +28,9 @@
           class="grading_value grading_box score_value"
           id="student_grading_{{assignment.id}}"
           aria-labelledby="default_grade_points"
-          aria-describedby="default_grade_description"/>
+          aria-describedby="default_grade_description"
+          {{ disabledIf isInPastGradingPeriodAndNotAdmin }}
+          />
 {{/if}}
 {{#if assignment_grading_type_is_gpa_scale}}
   <input  name="{{inputName}}"
@@ -33,10 +39,16 @@
           class="grading_value grading_box score_value"
           id="student_grading_{{assignment.id}}"
           aria-labelledby="default_grade_points"
-          aria-describedby="default_grade_description"/>
+          aria-describedby="default_grade_description"
+          {{ disabledIf isInPastGradingPeriodAndNotAdmin }}
+          />
 {{/if}}
 {{#if assignment_grading_type_is_pass_fail}}
-  <select name="{{inputName}}" class="grading_value grading_box pass_fail" id="student_grading_{{assignment.id}} %>">
+  <select name="{{inputName}}"
+          class="grading_value grading_box pass_fail"
+          id="student_grading_{{assignment.id}}"
+          {{ disabledIf isInPastGradingPeriodAndNotAdmin }}
+          >
     <option value="">---</option>
     <option value="complete" {{selectedIf grade "complete"}}>{{#t "#gradebooks.grades.complete"}}Complete{{/t}}</option>
     <option value="incomplete" {{selectedIf grade "incomplete"}}>{{#t "#gradebooks.grades.incomplete"}}Incomplete{{/t}}</option>

spec/coffeescripts/gradebook/SubmissionDetailsDialogSpec.coffee

@@ -2,28 +2,38 @@ define [
   'jquery'
   'compiled/models/Assignment'
   'compiled/SubmissionDetailsDialog'
+  'underscore'
   'jst/SubmissionDetailsDialog'
-], ($, Assignment, SubmissionDetailsDialog) ->
+], ($, Assignment, SubmissionDetailsDialog, _) ->
 
   module 'SubmissionDetailsDialog',
-
     setup: ->
+      defaults =
+        current_user_roles: [ "teacher" ]
+        GRADEBOOK_OPTIONS:
+          multiple_grading_periods_enabled: true
+          latest_end_date_of_admin_created_grading_periods_in_the_past: 'Thu Jul 30 2015 00:00:00 GMT-0700 (PDT)'
+      @previousWindowENV = window.ENV
+
+      _.extend(window.ENV, defaults)
+
       @assignment = new Assignment(id: 1)
       @user       = { assignment_1: {}, id: 1, name: 'Test student' }
       @options    = { speed_grader_enabled: true, change_grade_url: 'magic' }
 
     teardown: ->
+      window.ENV = @previousWindowENV
       $('.submission_details_dialog').remove()
 
   test 'speed_grader_enabled sets speedgrader url', ->
-    dialog = new SubmissionDetailsDialog(@assignment, @user, speed_grader_enabled: true, change_grade_url: ':assignment/:student')
+    dialog = new SubmissionDetailsDialog(@assignment, @user, {speed_grader_enabled: true, change_grade_url: ':assignment/:student'})
     ok dialog.submission.speedGraderUrl
     dialog.open()
 
     equal dialog.dialog.find('.more-details-link').length, 1
 
   test 'speed_grader_enabled as false does not set speedgrader url', ->
-    dialog = new SubmissionDetailsDialog(@assignment, @user, speed_grader_enabled: false, change_grade_url: ':assignment/:student')
+    dialog = new SubmissionDetailsDialog(@assignment, @user, { speed_grader_enabled: false, change_grade_url: ':assignment/:student' })
     equal dialog.submission.speedGraderUrl, null
     dialog.open()
 
@@ -40,33 +50,53 @@ define [
   module '_submission_detail',
 
     setup: ->
+      defaults =
+        current_user_roles: [ "teacher" ]
+        GRADEBOOK_OPTIONS:
+          multiple_grading_periods_enabled: true
+          latest_end_date_of_admin_created_grading_periods_in_the_past: 'Thu Jul 30 2015 00:00:00 GMT-0700 (PDT)'
+      @previousWindowENV = window.ENV
+
+      _.extend(window.ENV, defaults)
+
       @assignment = new Assignment(id: 1)
       @options    = { speed_grader_enabled: true, change_grade_url: 'magic'}
 
     teardown: ->
+      window.ENV = @previousWindowENV
       $('.submission_details_dialog').remove()
 
   test 'partial correctly makes url field if submission type is url', ->
     @user       = { assignment_1: { submission_history: [{ submission_type: "online_url", url: "www.cnn.com" }] }, id: 1, name: 'Test student' }
-    dialog = new SubmissionDetailsDialog(@assignment, @user, speed_grader_enabled: true, change_grade_url: ':assignment/:student')
+    dialog = new SubmissionDetailsDialog(@assignment, @user, {speed_grader_enabled: true, change_grade_url: ':assignment/:student'})
     dialog.open()
 
     equal dialog.dialog.find('.url-submission').length, 1
 
   test 'partial correctly makes attachment fields if submission included attachments', ->
     @user       = { assignment_1: { submission_history: [{ submission_type: "online_url", attachments: [{},{},{}] }] }, id: 1, name: 'Test student' }
-    dialog = new SubmissionDetailsDialog(@assignment, @user, speed_grader_enabled: true, change_grade_url: ':assignment/:student')
+    dialog = new SubmissionDetailsDialog(@assignment, @user, {speed_grader_enabled: true, change_grade_url: ':assignment/:student'})
     dialog.open()
 
     equal dialog.dialog.find('.submisison-attachment').length, 3
 
   module '_grading_box',
 
     setup: ->
+      defaults =
+        current_user_roles: [ "teacher" ]
+        GRADEBOOK_OPTIONS:
+          multiple_grading_periods_enabled: true
+          latest_end_date_of_admin_created_grading_periods_in_the_past: 'Thu Jul 30 2015 00:00:00 GMT-0700 (PDT)'
+      @previousWindowENV = window.ENV
+
+      _.extend(window.ENV, defaults)
+
       @assignment = new Assignment(id: 1, name: 'Test assignment', due_at: "2014-04-14T00:00:00Z")
       @user       = { assignment_1: { submitted_at: "2014-04-20T00:00:00Z" }, id: 1, name: 'Test student' }
       @options    = { speed_grader_enabled: false, change_grade_url: ':assignment/:student' }
     teardown: ->
+      window.ENV = @previousWindowENV
       $('.submission_details_dialog').remove()
 
   test "displays the grade as 'EX' if the submission is excused", ->