Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Functionality to Remove Test Cases, Inputs, and Outputs in Test Bench Panel #383

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Darshan808
Copy link
Contributor

@Darshan808 Darshan808 commented Oct 1, 2024

This PR implements the ability to delete test cases, inputs, and outputs in the test bench panel of CircuitVerse's Vue Simulator. Previously, there was no option to remove a mistakenly added test case or input/output, which could disrupt the test setup. This functionality now allows users to clean up their test bench more efficiently. Additionally, a minor typo correction was made, changing "bandwidth" to "bitwidth" in the UI.

Changes

  • Added three new functions:
    • deleteTestFromGroup: Allows users to delete test cases from groups.
    • deleteInput: Enables removal of unnecessary input fields.
    • deleteOutput: Provides functionality to delete output fields.
  • UI update to include buttons for deleting test cases, inputs, and outputs.
  • Typo fix: "bandwidth" corrected to "bitwidth."

Screenshots

Before

Screenshot from 2024-10-01 22-51-29

After

Screenshot from 2024-10-01 22-51-00

Summary by CodeRabbit

  • New Features

    • Enhanced user interface for managing test inputs and outputs.
    • Users can now delete individual inputs and outputs.
    • Introduced functionality to delete tests from specific groups.
  • Improvements

    • Updated button styles for better visual representation.
    • Clarified labeling by changing "Bandwidth" to "Bitwidth."

Copy link
Contributor

coderabbitai bot commented Oct 1, 2024

Walkthrough

The changes involve enhancements to the TestBenchCreator.vue component, focusing on user interface improvements and new functionalities for managing test inputs and outputs. Key updates include the renaming of "Bandwidth" to "Bitwidth," the introduction of methods to delete individual inputs and outputs, and the ability to remove tests from specific groups, ensuring that associated data structures are updated accordingly.

Changes

File Change Summary
src/components/Panels/TestBenchPanel/TestBenchCreator.vue Updated button styles, renamed label from "Bandwidth" to "Bitwidth," added methods for deleting inputs, outputs, and tests from groups.

Poem

In the meadow where tests do play,
A rabbit hops, brightening the day.
With buttons that shine and labels anew,
Inputs and outputs, we bid adieu!
Deleting with ease, oh what a delight,
In the TestBench, everything feels right! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 51766f2 and 948a20e.

📒 Files selected for processing (1)
  • src/components/Panels/TestBenchPanel/TestBenchCreator.vue (7 hunks)
🔇 Additional comments (9)
src/components/Panels/TestBenchPanel/TestBenchCreator.vue (9)

31-31: UI Enhancement: Updated button class for consistency

The class name change from .plusBtn to .plusMinusBtn suggests a visual update to accommodate both add and delete functionalities. This change improves UI consistency.

Also applies to: 34-34


45-45: New Feature: Added delete buttons for inputs and outputs

These new delete buttons align with the PR objectives, allowing users to remove individual inputs and outputs. This enhancement improves the flexibility of test case management.

Also applies to: 52-52


58-58: Terminology Correction: "Bandwidth" to "Bitwidth"

The label change from "Bandwidth" to "Bitwidth" is a correct terminology update. This improves clarity and accuracy in the context of digital circuit testing.


82-82: New Feature: Added delete button for test cases within groups

This new delete button allows users to remove individual test cases from a group, aligning with the PR objectives and enhancing the test bench management capabilities.


279-287: New Feature: Implementation of deleteTestFromGroup function

This function correctly implements the deletion of a test case from a specific group by removing the corresponding input and output values. It aligns with the PR objectives and enhances the test bench management capabilities.


312-322: New Feature: Implementation of deleteInput function

The deleteInput function properly handles the removal of an input, including updating the data structures and preventing the deletion of the last input. This implementation aligns with the PR objectives and includes appropriate error handling.


339-349: New Feature: Implementation of deleteOutput function

Similar to the deleteInput function, deleteOutput correctly handles the removal of an output, including data structure updates and prevention of deleting the last output. This implementation is consistent with the PR objectives and includes proper error handling.


Line range hint 543-550: UI Enhancement: Styling for new add/delete buttons

The new .plusMinusBtn CSS class provides consistent styling for the add and delete buttons. This ensures visual harmony with the existing UI elements and improves the overall user experience.


Line range hint 1-594: Summary: Successful implementation of test case, input, and output deletion functionality

The changes in this file successfully implement the functionality to remove test cases, inputs, and outputs in the test bench panel, as outlined in the PR objectives. The implementation is consistent, follows Vue.js best practices, and includes appropriate error handling. The UI updates enhance usability and maintain visual consistency. Overall, this is a well-executed feature addition that improves the user experience in managing test benches.


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
🪧 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

netlify bot commented Oct 1, 2024

Deploy Preview for circuitverse ready!

Name Link
🔨 Latest commit 948a20e
🔍 Latest deploy log https://app.netlify.com/sites/circuitverse/deploys/66fc2e3bcd5fe8000862f029
😎 Deploy Preview https://deploy-preview-383--circuitverse.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@Darshan808
Copy link
Contributor Author

@tanmoysrt
Is it possible to merge this PR under 'hacktoberfest-accepted' label ? If yes, I would greatly appreciate it.

@Darshan808
Copy link
Contributor Author

@Prerna-0202
Could you please review this PR ?

@Darshan808
Copy link
Contributor Author

@gr455
Could this PR be reviewed please ?
Also i would really appreciate if you could label it as hacktoberfest-accepted.

@gr455 gr455 added the hacktoberfest-accepted PRs that count towards the Hacktoberfest label Oct 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hacktoberfest-accepted PRs that count towards the Hacktoberfest
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants