santosh-narvekar commented 1 month ago

Description

The changes I have made makes the code more efficient to read as I have refactored the search Input for every Page and it is such that it will make it easy to add search Inputs to future pages.

Type of change

A global search Input was added that will take in 3 props : the data , the function and the searchBy terms respectively , it makes it easy to handle everything at one place and code becomes more refactored and easy to include the same component in the future.

Please delete options that are not relevant.

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

Test Required (Yes / No) Yes

If Yes then How Has This Been Tested? passing different inputs to search component

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

[ ] Test A : checked for proper book section search by giving inputs that matches title and description only.
[ ] Test B : checked for proper dsa section search by giving inputs that matches only data_structure and title only.

Test Configuration:

Platform: (Linux/Windows/Mac) Windows
Architecture: (x86/x64/Arm/Amd) x64

Checklist:

[ ] My code follows the style guidelines of this project
[ ] I have performed a self-review of my own code
[ ] My changes generate no new warnings
[ ] I have added tests that prove my fix is effective or that my feature works
[ ] New and existing unit tests pass locally with my changes
[ ] Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

New Features
- Introduced a new SearchInput component for improved search functionality across various sections (Books, DevTools, DSAs, Lessons).
- Enhanced search capabilities allow filtering by specific fields (e.g., title, description) for better user experience.
Refactor
- Refactored existing components (Books, DevTools, DSAs, Lessons) to remove local search state and logic, delegating responsibilities to the new SearchInput component.
Bug Fixes
- Improved usability and performance of the search feature through modular design.

vercel[bot] commented 1 month ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
rustcrab	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 28, 2024 2:33pm

coderabbitai[bot] commented 1 month ago

[!WARNING]

Rate limit exceeded

@santyy123 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 6 minutes and 12 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](https://coderabbit.ai/docs/faq) for further information.

Commits
Files that changed from the base of the PR and between 3b601c59f15c1a089b33be29d4b42b3ddfa9c912 and 9fdd4c642bb323c6b6426be52da11ef5de2c7530.

Walkthrough

The recent changes refactor the search functionality across multiple components by introducing a new SearchInput component. This modular design encapsulates the search logic, allowing the Books, DevTools, DSAPage, and Lessons components to focus on rendering while delegating input handling and filtering to SearchInput. This enhances code maintainability, reusability, and separation of concerns throughout the application.

Changes

Files	Change Summary
`src/app/books/page.tsx`, `src/app/devtools/page.tsx`, `src/app/dsas/page.tsx`, `src/app/lessons/page.tsx`	Refactored search functionality into `SearchInput` component, removing local state management and input handling from each.
`src/components/SearchInput.tsx`	Introduced new `SearchInput` component for searching through datasets, managing local state and filtering logic.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SearchInput
    participant Books
    participant DevTools
    participant DSAPage
    participant Lessons

    User->>SearchInput: Input search term
    SearchInput->>SearchInput: Update filtered results
    SearchInput->>Books: Set filtered books
    SearchInput->>DevTools: Set filtered tools
    SearchInput->>DSAPage: Set filtered DSAs
    SearchInput->>Lessons: Set filtered lessons

🐰 In a world of books and tools so bright,
I found a way to search with delight!
With SearchInput now taking the stage,
My code is cleaner, all the rage!
Let's hop along and cheer with glee,
For modular magic, just wait and see! 🎉

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.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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](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.

FrancescoXX / rustcrab

added search input for every page #146