Cleanup assessment / course config files

[damianhxy]

Description

• remove unused methods assessmentInitialize and installProblems
• remove unused course hook gradebookMessage
• remove dead code from default assessment config file, add documentation

Motivation and Context

To improve the level of documentation regarding assessment hooks, and remove dead code.

Closes #2085 Partially addresses #1926, although the online documentation should eventually be updated

How Has This Been Tested?

• Import the following lab, which uses the new assessment config file format: randomlab.tar.zip
• Make a submission (any .c file), ensure autograding works and all problems exist
• Reload config file without any issues

For completeness

• successfully create a new assessment from scratch
• successfully reload the config file of an existing assessment (with the old config file format)

Types of changes

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

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

The listOptions hook should be revisited at some point, see explanation in #1926. gradebook message is currently rendered using a raw tag, might want to sanitize

[coderabbitai[bot]]

Walkthrough

## Walkthrough The changes primarily focus on removing deprecated features and methods related to assessment and course configuration handling within the application. This cleanup includes eliminating outdated hooks and functions that are no longer in use or have been replaced by more efficient mechanisms. The restructuring and comment updates aim to enhance clarity in the configuration files and ensure alignment with the current operational requirements of the system. ## Changes | File Path | Change Summary | |-------------------------------------|--------------------------------------------------------------------------------| | `app/controllers/.../assessments_controller.rb` | Removed deprecated functions and refactored assessment initialization logic. | | `app/models/assessment.rb` | Removed code for replacing placeholders in config files. | | `lib/AssessmentBase.rb` | Added comments about the file being unused but kept for compatibility. | | `lib/__defaultAssessment.rb` | Removed deprecated method and added detailed comments. | | `lib/__defaultCourse.rb` | Removed the `gradebookMessage` function. | | `lib/tasks/autolab.rake` | Removed code for replacing placeholders in config file generation. | ## Assessment against linked issues | Objective | Addressed | Explanation | |---------------------------------------------------------------------------------------------------------------|-----------|-------------| | Removal of `assessmentInitialize` and `installProblems` due to deprecation (#2085) | ✅ | | | Update default assessment template to not include deprecated hooks (#2085) | ✅ | | | Removal of `gradebookMessage` from course config file as it's not a valid hook (#2085) | ✅ | | | Ensure the assessment config file does not rely on deprecated methods for defining problems (#2085) | ✅ | | | Clarification and cleanup of configuration file handling and hooks to prevent confusion (#2085) | ✅ | |

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

---

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 .` - `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](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - 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](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.