Display submission version in gradebook

[damianhxy]

Summary

Summary generated by Reviewpad on 13 Nov 23 01:39 UTC

This pull request includes the following changes:

• In the gradebook.js file:
  • Updated the class tip to tooltipped in the if block at line 63.
  • Removed the headerCssClass property from the loop at lines 70-73.
  • Added a new section for initializing tooltips using M.Tooltip.init at lines 86-93.
• In the instructor_gradebook.scss file:
  • Removed the CSS rules for #gradebook .slick-cell.assessment_final_score and #gradebook .slick-header-column.assessment_final_score at lines 174-183.
• In the gradebook_helper.rb file:
  • Added a width property for the columns array elements at lines 38, 45, and 53.
  • Added a new columns array element for the Version column at lines 48-52.
  • Added the #{asmt.name}_version field to the csv_header method at line 137.
  • Added the aud.latest_submission.version to the gradebook_rows method at line 101.
  • Added the cell["version"] to the gradebook_csv method at line 159.
• In the grade_matrix.rb file:
  • Added the version key to the info hash in the summarize method at line 126.
• In the user.rb file:
  • Removed debug log statements at lines 145-147.

Description

• Display version number on gradebook
• Remove redundant assessment_final_score style (it was never used, since we were overwriting headerCssClass with tip)
• Remove use of tip class, which has no purpose (toolTip is sufficient)
• Fix tooltips for cells by directly using materialize's init method (it was being overwritten by jquery-ui)
• Add version number to CSV export
• Increase gradebook width

Motivation and Context

Allow instructors to easily see number of submissions made by students for each assessment in gradebook.

Fix display of tooltips

Add version number to CSV export

Increase width

Before

After

Closes #1727
Closes #1745

How Has This Been Tested?

See #1917

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

• I have run rubocop and erblint for style check. If you haven't, run overcommit --install && overcommit --sign to use pre-commit hook for linting
• My change requires a change to the documentation, which is located at Autolab Docs
• I have updated the documentation accordingly, included in this PR

[coderabbitai]

Walkthrough

<details>
<summary>Walkthrough</summary>

# Walkthrough

The changes primarily focus on enhancing the gradebook functionality in the application. This includes the addition of a new "Version" column in the gradebook display and CSV export, adjustments to column widths, and updates to tooltip initialization. Additionally, redundant code and debug log statements have been removed, and styling rules have been updated.

# Changes

| File Path | Change Summary |
| --- | --- |
| `app/assets/javascripts/gradebook.js` | Removed the assignment of "headerCssClass" in a loop, replaced tooltip initialization using Materialize library, and improved integration with tooltip functionality. |
| `app/assets/stylesheets/instructor_gradebook.scss` | Removed styling rules for `#gradebook .slick-cell.assessment_final_score` and `#gradebook .slick-header-column.assessment_final_score`. Added a new styling rule for `#gradebook .slick-cell.computed` to set the color to `#999`. |
| `app/helpers/gradebook_helper.rb` | Added a new "Version" column to the gradebook display and CSV export. Adjusted the width of existing columns. |
| `app/models/user.rb` | Removed debug log statements from the `roster_create` method. |
| `app/models/grade_matrix.rb` | Introduced a new line to extract the version from the latest submission of the given `aud` object. |

# Assessment against linked issues (Beta)

| Objective | Addressed | Explanation |
| --- | --- | --- |
| Gradebook tooltip for symbol meanings | ✅ | The changes include updates to tooltip initialization, enhancing user experience by providing explanations for symbols. |

</details>

---

Tips

Chat with CodeRabbit Bot (@coderabbitai)

• If you reply to a review comment from CodeRabbit, the bot will automatically respond.
• To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
• Note: Review comments are made on code diffs or files, not on the PR overview.
• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

[20wildmanj]

Verified that tooltips now appear, version number is included in gradebook, and export includes version number. LGTM