Updated new course error message UI

coder6583 commented 3 months ago

Description

Removed large error message from top of the page
Added required attribute to text field
Added error text under the input field for invalid name

Motivation and Context

Issue #1713 It is easy for the user to input an invalid course name, but the error messages are unclear on why the name is invalid. The error message is also too large, and it is not a very intuitive UI.

How Has This Been Tested?

Before: After:

Gives suggested name for invalid name under the corresponding input field.

Error popup when field is not entered.

Tested with different invalid names that include spaces and special characters.

Types of changes

[x] New feature (non-breaking change which adds functionality)

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

Other issues / help required

If unsure, feel free to submit first and we'll help you along.

Summary by CodeRabbit

New Features
- Introduced inline error handling and messages for course creation form fields.
- Added a custom validation method for course names with suggestions for correction.
- Enhanced form fields with required validations and specific attributes for better usability.
Bug Fixes
- Removed duplicate style declarations and redundant newlines in form builder.
Style
- Updated styles for error messages to be more visible and user-friendly.
Refactor
- Simplified error state handling in forms for a cleaner user experience.
- Refactored course name validation to improve reliability and user guidance.
Database Changes
- Adjusted database schema for better precision, data integrity, and added a new starred field to mark importance.

coderabbitai[bot] commented 3 months ago

Walkthrough

## Walkthrough This update focuses on improving the user interface and experience related to form error handling and validation in a web application. It includes enhancing error message display, refactoring validation logic for clarity, enforcing stricter validation rules on form fields, optimizing database schema for performance, and simplifying form error state handling in the application configuration. ## Changes | File Path | Change Summary | |-----------------------------------------------------|--------------------------------------------------------------------------------------------------| | `app/assets/stylesheets/style.css.scss` | Updated styles for error messages and removed duplicate styles. | | `app/form_builders/form_builder_with_date_time_input.rb` | Improved error handling in forms, including a new method for error text display. | | `app/models/course.rb` | Refactored name validation with a custom method for better error feedback. | | `app/views/courses/_create_new_course.html.erb` | Enhanced form fields for course creation with inline error messages and required field markers. | | `db/schema.rb` | Made data type and precision adjustments, added constraints and a new field. | | `config/application.rb` | Simplified form control error state handling customization. | ## Possibly related issues - **autolab/Autolab#1713**: The changes in this PR enhance error message visibility and presentation, which directly addresses the issue's objective to improve the UI around error messages in course creation.

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](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code 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 testing code 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 testing code.` - `@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. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - 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/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

jlge commented 3 months ago

This error message should probably be changed to something along the lines of "Course creation failed. Please review the fields below" or "Please check all fields and try again."

autolab / Autolab