search

EotvosCollegium / mars

Unified IT System of the Eötvös József College for Advanced Studies.
https://uran.eotvos.elte.hu
MIT License
2 stars 15 forks source link

Reservable items (rooms and washing machines) #623

Closed viktorcsimma closed 2 months ago

viktorcsimma commented 3 months ago

As in the title. It supports:

Known issues:

Thanks to everyone at the course for helping:)

coderabbitai[bot] commented 3 months ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough ## Walkthrough The recent changes implement a comprehensive reservation management system, introducing the `ReservationController` and `ReservableItemController` for handling reservations and reservable items, respectively. A new configuration variable, `ROOM_RESERVATION_OPEN`, has been added to manage room reservation permissions based on user roles. Additionally, a Mailable class for reporting faults and an email template for notifying users about reservation statuses have been created. These modifications enhance the application's functionality and user interaction. ## Changes | Files | Change Summary | |-----------------------------------------|--------------------------------------------------------------------------------------------------------------------------| | **app/Http/Controllers** | New `ReservationController` and `ReservableItemController` for managing reservations and items, including CRUD operations. | | **app/Mail/Reservations** | New `ReportReservableItemFault` Mailable class for notifying staff about faulty items; new `reservation_affected` email template for reservation status notifications. | | **resources/views** | New Blade templates for displaying reservation details and managing item statuses, including `edit.blade.php` and `show.blade.php`. | | **.env.example** | Addition of `ROOM_RESERVATION_OPEN` configuration variable for controlling room reservation permissions. | | **tests/Feature** | New `ReservationTest.php` file containing tests for various reservation functionalities and user roles. | | **resources/views/layouts** | Modifications to `navbar.blade.php` for reorganising navigation items related to reservations and faults. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant User participant Web participant ReservationController participant Database participant Mail User->>Web: Request to create a reservation Web->>ReservationController: Call store(Request) ReservationController->>Database: Validate and save reservation Database-->>ReservationController: Confirmation ReservationController->>Mail: Send reservation confirmation email ``` ```mermaid sequenceDiagram participant Admin participant Web participant ReservationController participant Database participant Mail Admin->>Web: Request to delete a reservation Web->>ReservationController: Call delete(Reservation) ReservationController->>Database: Remove reservation Database-->>ReservationController: Confirmation ReservationController->>Mail: Send deletion notification email ``` ```mermaid sequenceDiagram participant User participant Web participant Mail User->>Web: Report item fault Web->>Mail: Send notification about faulty item Mail-->>User: Confirmation of report ```

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 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. ### 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.
kdmnk commented 2 months ago

Hi! Sorry, I can take a quick look again tomorrow morning. I know you want to merge soon so we'll see

viktorcsimma commented 2 months ago

@kdmnk thank you:)

viktorcsimma commented 2 months ago

Thank you so much:) I have applied almost all of the things you have suggested. I have not tried interfaces for ReservationController though; I think I will do so when redesigning the architecture later (which I should).

What do you think, can we proceed with the merge? I would try it on staging then.