feat(gradebook): weighted view with per-tab weights and exclude flag (pr3 of 3)

app/controllers/components/course/gradebook_component.rb

@@ -7,6 +7,12 @@ def self.display_name
   end
 
   def sidebar_items
+    main_sidebar_items + settings_sidebar_items
+  end
+
+  private
+
+  def main_sidebar_items
     return [] unless can?(:read_gradebook, current_course)
 
     [
@@ -20,4 +26,17 @@ def sidebar_items
       }
     ]
   end
+
+  def settings_sidebar_items
+    return [] unless can?(:manage_gradebook_settings, current_course)
+
+    [
+      {
+        key: self.class.key,
+        type: :settings,
+        weight: 14,
+        path: course_admin_gradebook_path(current_course)
+      }
+    ]
+  end
 end

app/controllers/course/admin/gradebook_settings_controller.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+class Course::Admin::GradebookSettingsController < Course::Admin::Controller
+  def edit
+    respond_to(&:json)
+  end
+
+  def update
+    if @settings.update(gradebook_settings_params) && current_course.save
+      render 'edit'
+    else
+      render json: { errors: @settings.errors }, status: :bad_request
+    end
+  end
+
+  private
+
+  def gradebook_settings_params
+    params.require(:settings_gradebook_component).permit(:weighted_view_enabled)
+  end
+
+  def component
+    current_component_host[:course_gradebook_component]
+  end
+
+  def authorize_admin
+    authorize! :manage_gradebook_settings, current_course
+  end
+end

app/controllers/course/gradebook_controller.rb

@@ -5,6 +5,7 @@ class Course::GradebookController < Course::ComponentController
   def index
     respond_to do |format|
       format.json do
+        @weighted_view_enabled = @settings.weighted_view_enabled
         @published_assessments = fetch_published_assessments
         @categories, @tabs = fetch_categories_and_tabs
         @students = fetch_students
@@ -18,12 +19,53 @@ def index
     end
   end
 
+  def update_weights
+    authorize! :manage_gradebook_weights, current_course
+    updates = update_weights_params[:weights].map { |entry| parse_weight_entry(entry) }
+    Course::Assessment::Tab.update_gradebook_weights(course: current_course, updates: updates)
+    render json: { weights: serialize_weight_updates(updates) }
+  rescue ActiveRecord::RecordInvalid, ActiveRecord::RecordNotFound => e
+    render json: { errors: { base: e.message } }, status: :unprocessable_entity
+  end
+
   private
 
   def authorize_read_gradebook!
     authorize! :read_gradebook, current_course
   end
 
+  def parse_weight_entry(entry)
+    {
+      tab_id: entry[:tabId].to_i,
+      weight: entry[:weight].to_f,
+      weight_mode: entry[:weightMode] || 'equal',
+      excluded_assessment_ids: (entry[:excludedAssessmentIds] || []).map(&:to_i),
+      assessment_weights: (entry[:assessmentWeights] || []).map do |aw|
+        { assessment_id: aw[:assessmentId].to_i, weight: aw[:weight].to_f }
+      end
+    }
+  end
+
+  def update_weights_params
+    params.permit(
+      weights: [:tabId, :weight, :weightMode,
+                excludedAssessmentIds: [], assessmentWeights: [:assessmentId, :weight]]
+    )
+  end
+
+  def serialize_weight_updates(updates)
+    updates.map do |u|
+      entry = { tabId: u[:tab_id], weight: u[:weight], weightMode: u[:weight_mode].to_s,
+                excludedAssessmentIds: u[:excluded_assessment_ids] }
+      if u[:weight_mode].to_s == 'custom'
+        entry[:assessmentWeights] = u[:assessment_weights].map do |aw|
+          { assessmentId: aw[:assessment_id], weight: aw[:weight] }
+        end
+      end
+      entry
+    end
+  end
+
   def component
     current_component_host[:course_gradebook_component]
   end
@@ -36,7 +78,8 @@ def fetch_categories_and_tabs
   def fetch_students
     current_course.levels.to_a
     current_course.course_users.students.without_phantom_users.
-      calculated(:experience_points).includes(:user).to_a
+      calculated(:experience_points).includes(:user).to_a.
+      sort_by { |cu| cu.user.name }
   end
 
   def fetch_published_assessments

app/models/components/course/gradebook_ability_component.rb

@@ -4,6 +4,8 @@ module Course::GradebookAbilityComponent
 
   def define_permissions
     can :read_gradebook, Course, id: course.id if course_user&.staff?
+    can :manage_gradebook_weights, Course, id: course.id if course_user&.manager_or_owner?
+    can :manage_gradebook_settings, Course, id: course.id if course_user&.manager_or_owner?
     super
   end
 end

app/models/course/assessment.rb

@@ -29,6 +29,7 @@ class Course::Assessment < ApplicationRecord
   validates :creator, presence: true
   validates :updater, presence: true
   validates :tab, presence: true
+  validates :gradebook_weight, numericality: { greater_than_or_equal_to: 0 }, allow_nil: true
   validates :ssid_folder_id, uniqueness: { if: :ssid_folder_id_changed? }, allow_nil: true
 
   belongs_to :tab, inverse_of: :assessments

app/models/course/assessment/submission.rb

@@ -331,15 +331,15 @@ def self.grade_summary(student_ids:, assessment_ids:)
 
     find_by_sql(
       sanitize_sql_array([<<-SQL.squish, student_ids, assessment_ids])
-        SELECT cas.creator_id AS student_id, cas.assessment_id,
-               SUM(caa.grade) AS grade
+        SELECT cas.id AS submission_id, cas.creator_id AS student_id,
+               cas.assessment_id, SUM(caa.grade) AS grade
         FROM course_assessment_submissions cas
         JOIN course_assessment_answers caa ON caa.submission_id = cas.id
         WHERE cas.creator_id IN (?)
           AND cas.assessment_id IN (?)
           AND cas.workflow_state IN ('graded', 'published')
           AND caa.current_answer = TRUE
-        GROUP BY cas.creator_id, cas.assessment_id
+        GROUP BY cas.id, cas.creator_id, cas.assessment_id
       SQL
     )
   end

app/models/course/assessment/tab.rb

@@ -2,12 +2,18 @@
 class Course::Assessment::Tab < ApplicationRecord
   validates :title, length: { maximum: 255 }, presence: true
   validates :weight, numericality: { only_integer: true }, presence: true
+  validates :gradebook_weight,
+            numericality: { greater_than_or_equal_to: 0,
+                            less_than_or_equal_to: 100 },
+            presence: true
   validates :creator, presence: true
   validates :updater, presence: true
   validates :category, presence: true
 
   belongs_to :category, class_name: 'Course::Assessment::Category', inverse_of: :tabs
   has_many :assessments, class_name: 'Course::Assessment', dependent: :destroy, inverse_of: :tab
+
+  enum :weight_mode, { equal: 0, custom: 1 }
   has_many :folders, class_name: 'Course::Material::Folder', through: :assessments,
                      inverse_of: nil
 
@@ -24,6 +30,72 @@ class Course::Assessment::Tab < ApplicationRecord
       select('(array_agg(title))[0:3]')
   end)
 
+  # Bulk-updates gradebook weights, weight modes, and per-assessment weights for a set
+  # of tabs belonging to the given course.
+  # Raises ActiveRecord::RecordNotFound if any tab_id or assessment_id is unknown.
+  # Raises ActiveRecord::RecordInvalid if validation fails or, for custom tabs, the
+  # assessment weights do not sum (at 2dp) to the tab total; the transaction is rolled back.
+  #
+  # @param course [Course]
+  # @param updates [Array<Hash>] each { tab_id:, weight:, weight_mode:,
+  #   excluded_assessment_ids: [Integer], assessment_weights: [{ assessment_id:, weight: }] }
+  def self.update_gradebook_weights(course:, updates:)
+    course_tab_ids = course.assessment_tabs.pluck(:id).to_set
+    updates.each { |e| raise ActiveRecord::RecordNotFound unless course_tab_ids.include?(e[:tab_id]) }
+
+    tabs_by_id = where(id: updates.map { |e| e[:tab_id] }).includes(:assessments).index_by(&:id)
+
+    transaction { updates.each { |entry| apply_gradebook_weight_entry(tabs_by_id, entry) } }
+  end
+
+  # @api private
+  def self.apply_gradebook_weight_entry(tabs_by_id, entry)
+    tab = tabs_by_id[entry[:tab_id]]
+    mode = (entry[:weight_mode] || 'equal').to_s
+    tab.update!(gradebook_weight: entry[:weight], weight_mode: mode)
+
+    excluded_ids = entry[:excluded_assessment_ids] || []
+    apply_assessment_exclusions(tab, excluded_ids)
+
+    if mode == 'custom'
+      apply_custom_assessment_weights(tab, entry, excluded_ids.to_set)
+    else
+      tab.assessments.update_all(gradebook_weight: nil)
+    end
+  end
+  private_class_method :apply_gradebook_weight_entry
+
+  # @api private
+  # Membership is applied in both modes: excluded ids -> true, the rest of the tab -> false.
+  def self.apply_assessment_exclusions(tab, excluded_ids)
+    tab.assessments.where(id: excluded_ids).update_all(gradebook_excluded: true) if excluded_ids.any?
+    tab.assessments.where.not(id: excluded_ids).update_all(gradebook_excluded: false)
+  end
+  private_class_method :apply_assessment_exclusions
+
+  # @api private
+  def self.apply_custom_assessment_weights(tab, entry, excluded_ids) # rubocop:disable Metrics/AbcSize
+    assessments_by_id = tab.assessments.index_by(&:id)
+    included_sum = 0
+    included_any = false
+    (entry[:assessment_weights] || []).each do |aw|
+      assessment = assessments_by_id[aw[:assessment_id]]
+      raise ActiveRecord::RecordNotFound if assessment.nil?
+
+      assessment.update!(gradebook_weight: aw[:weight])
+      next if excluded_ids.include?(aw[:assessment_id])
+
+      included_sum += aw[:weight]
+      included_any = true
+    end
+    return unless included_any
+    return unless (included_sum * 100).round != (entry[:weight] * 100).round
+
+    tab.errors.add(:base, :custom_weights_mismatch)
+    raise ActiveRecord::RecordInvalid, tab
+  end
+  private_class_method :apply_custom_assessment_weights
+
   # Returns a boolean value indicating if there are other tabs
   # besides this one remaining in its category.
   #

app/models/course/settings/gradebook_component.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+class Course::Settings::GradebookComponent < Course::Settings::Component
+  # Returns whether weighted view is enabled (disabled by default).
+  #
+  # @return [Boolean] Setting on whether weighted view is enabled.
+  def weighted_view_enabled
+    ActiveRecord::Type::Boolean.new.cast(settings.weighted_view_enabled) || false
+  end
+
+  # Enable or disable the weighted view.
+  #
+  # @param [Boolean|Integer|String] value Setting on whether weighted view is enabled.
+  def weighted_view_enabled=(value)
+    settings.weighted_view_enabled = ActiveRecord::Type::Boolean.new.cast(value)
+  end
+end

app/views/course/admin/gradebook_settings/edit.json.jbuilder

@@ -0,0 +1,2 @@
+# frozen_string_literal: true
+json.weightedViewEnabled @settings.weighted_view_enabled

app/views/course/gradebook/index.json.jbuilder

@@ -1,4 +1,7 @@
 # frozen_string_literal: true
+json.weightedViewEnabled @weighted_view_enabled
+json.canManageWeights can?(:manage_gradebook_weights, current_course)
+
 json.categories @categories do |cat|
   json.id cat.id
   json.title cat.title
@@ -8,13 +11,19 @@ json.tabs @tabs do |tab|
   json.id tab.id
   json.title tab.title
   json.categoryId tab.category_id
+  if @weighted_view_enabled
+    json.gradebookWeight tab.gradebook_weight&.to_f
+    json.weightMode tab.weight_mode
+  end
 end
 
 json.assessments @published_assessments do |assessment|
   json.id assessment.id
   json.title assessment.title
   json.tabId assessment.tab_id
   json.maxGrade @assessment_max_grades[assessment.id] || 0
+  json.gradebookWeight assessment.gradebook_weight&.to_f if @weighted_view_enabled
+  json.gradebookExcluded assessment.gradebook_excluded if @weighted_view_enabled
 end
 
 json.students @students do |course_user|
@@ -27,6 +36,7 @@ json.students @students do |course_user|
 end
 
 json.submissions @submissions do |sub|
+  json.submissionId sub.submission_id
   json.studentId sub.student_id
   json.assessmentId sub.assessment_id
   json.grade sub.grade&.to_f

client/app/__test__/mocks/localeMock.js

@@ -0,0 +1,2 @@
+// File used for jest moduleNameMapper - empty locale messages for tests
+module.exports = {};

client/app/__test__/setup.js

@@ -65,3 +65,15 @@ jest.mock('react-router-dom', () => ({
   useNavigate: jest.fn(),
   unstable_usePrompt: jest.fn(),
 }));
+
+// Replace I18nProvider with a synchronous stub so tests using test-utils
+// don't stall on async locale loading.
+jest.mock('lib/components/wrappers/I18nProvider', () => {
+  const { IntlProvider } = require('react-intl');
+  const SyncI18nProvider = ({ children }) => (
+    <IntlProvider defaultLocale="en" locale="en" messages={{}}>
+      {children}
+    </IntlProvider>
+  );
+  return { __esModule: true, default: SyncI18nProvider };
+});

client/app/api/course/Admin/Gradebook.ts

@@ -0,0 +1,23 @@
+import { AxiosResponse } from 'axios';
+import {
+  GradebookSettingsData,
+  GradebookSettingsPostData,
+} from 'types/course/admin/gradebook';
+
+import BaseAdminAPI from './Base';
+
+export default class GradebookAdminAPI extends BaseAdminAPI {
+  override get urlPrefix(): string {
+    return `${super.urlPrefix}/gradebook`;
+  }
+
+  index(): Promise<AxiosResponse<GradebookSettingsData>> {
+    return this.client.get(this.urlPrefix);
+  }
+
+  update(
+    data: GradebookSettingsPostData,
+  ): Promise<AxiosResponse<GradebookSettingsData>> {
+    return this.client.patch(this.urlPrefix, data);
+  }
+}

client/app/api/course/Admin/index.ts

@@ -6,6 +6,7 @@ import CommentsAdminAPI from './Comments';
 import ComponentsAdminAPI from './Components';
 import CourseAdminAPI from './Course';
 import ForumsAdminAPI from './Forums';
+import GradebookAdminAPI from './Gradebook';
 import LeaderboardAdminAPI from './Leaderboard';
 import LessonPlanSettingsAPI from './LessonPlan';
 import MaterialsAdminAPI from './Materials';
@@ -28,6 +29,7 @@ const AdminAPI = {
   lessonPlan: new LessonPlanSettingsAPI(),
   materials: new MaterialsAdminAPI(),
   forums: new ForumsAdminAPI(),
+  gradebook: new GradebookAdminAPI(),
   videos: new VideosAdminAPI(),
   notifications: new NotificationsSettingsAPI(),
   codaveri: new CodaveriAdminAPI(),

client/app/api/course/Gradebook.ts

@@ -1,4 +1,4 @@
-import { GradebookData } from 'types/course/gradebook';
+import { GradebookData, UpdateWeightsPayload } from 'types/course/gradebook';
 
 import { APIResponse } from 'api/types';
 
@@ -12,4 +12,10 @@ export default class GradebookAPI extends BaseCourseAPI {
   index(): APIResponse<GradebookData> {
     return this.client.get(this.#urlPrefix);
   }
+
+  updateWeights(
+    payload: UpdateWeightsPayload,
+  ): APIResponse<UpdateWeightsPayload> {
+    return this.client.patch(`${this.#urlPrefix}/weights`, payload);
+  }
 }