Allow instructors to select favorite problems to prioritize when annotating assignments and grading

[jhs-panda]

Description

• Added column in "Problems" for "favorite" to depict boolean representing if the problem is favorite problem or not (default is false)
• Added checkbox in the Edit Assessments > Problems > (Edit Problem under Options) to select if problem should be listed first when adding annotations in grading
• When adding annotations in grading, the problem order presented first prioritize selecting "Favorite Problem?", then prioritize alphabetical order. Therefore, it is possible to select multiple problems to list at the beginning.

Screenshots: Added column for "Favorite Problem": Allow indicating if problem is "favorite" or not: See changes in favorite problems selected reflected: Favorite problems prioritized in ordering for grading:

Motivation and Context

In classes where part of grading involves making annotations on submissions as part of certain problems, TAs requested the ability to select certain problems that will show up at the top of the scroll bar to assign a problem to a certain annotation made in order to save time and effort. Resolves #2062.

How Has This Been Tested?

Test different variations of "favorite problems" selected and ensure prioritized annotation feature works for all of the variations.

Types of changes

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

Checklist:

• [x] 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

Other issues / help required

[coderabbitai[bot]]

[!WARNING]

Rate Limit Exceeded

@jhs-panda has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 2 minutes and 15 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between b116ea1cad680ea61be478be57d02947e21f0b1a and 474d20451d6fb4a55d0e56af522fcba353d403c5.

Walkthrough

The updates across various files in the project introduce the ability to mark problems as "starred," allowing for a more flexible and user-friendly approach to categorizing and accessing problems. This change facilitates instructors in designating default annotation problems, enhancing the overall usability of the system for grading and annotations. The modifications span from backend logic adjustments and database schema updates to frontend enhancements for a seamless user experience.

Changes

File Path	Change Summary
app/controllers/.../problems_controller.rb, app/controllers/problems_controller.rb, app/controllers/submissions_controller.rb, app/controllers/assessments_controller.rb	Added handling for the :starred attribute in problem-related actions.
app/views/assessments/_edit_problems.html.erb, app/views/problems/_fields.html.erb	Enhanced UI to include star toggling functionality and a checkbox for marking problems as starred.
app/assets/javascripts/annotations.js	Introduced JavaScript logic for managing starred problems in annotations.
db/migrate/20240210172734_add_default_problem_to_problems.rb, db/schema.rb	Added a starred boolean field to the problems table with a default value of false.
app/models/problem.rb, docs/api-interface.md	Updated model serialization and API documentation to include the starred attribute.
spec/controllers/assessments_controller_spec.rb	Updated fixture file name in a test case.

Assessment against linked issues

Objective	Addressed	Explanation
Allow instructors to define a default annotation problem (#2062)	✅	The introduction of the starred attribute enables instructors to mark specific problems as default for annotations, indirectly addressing the objective by providing a mechanism to prioritize problems.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit-tests for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit tests for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.