Venue Management for Event Plugin (GSoC)

[Dante291]

What kind of change does this PR introduce?

This PR introduces a new feature for venue management within the event management application. It adds basic CRUD capabilities to manage venue information, including name, capacity, description, and image URL.

Issue Number:

Fixes #2522

Did you add tests for your changes?

Yes

Snapshots/Videos:

Screenrecorder-2024-07-10-19-12-20-821.1.mp4

If relevant, did you update the documentation?

Yes

Does this PR introduce a breaking change?

Yes

Have you read the contributing guide?

Yes

Summary by CodeRabbit

• New Features

  • Added a venue selection feature when creating events.
  • Introduced a VenueBottomSheet widget for selecting venues from a list.
  • Added VenueCard widget to display venue details with selection highlighting.

• Enhancements

  • Improved event creation by integrating venue selection using modal bottom sheets.
  • Enhanced organization management with the ability to fetch and display venues linked to an organization.

[coderabbitai]

Warning

Review failed

The pull request is closed.

Walkthrough

The recent changes introduce a venue management system to the event plugin, allowing users to manage venue details, such as ID, capacity, description, image URL, name, and organization ID. This includes the addition of a Venue class, GraphQL queries for retrieving venue lists, functionality in the CreateEventViewModel to fetch venues, and UI components for venue selection and display. These modifications enhance event planning and booking features for organizations.

Changes

Files/ Paths	Change Summary
lib/models/events/event_venue.dart	Introduced Venue class with properties id, capacity, description, imageUrl, name, organizationId, a constructor, and method Venue.fromJson().
lib/utils/queries.dart	Added function venueListQuery() for generating GraphQL query to retrieve venue lists within an organization.
lib/view_model/after_auth_view_models/.../create_event_view_model.dart	Added methods fetchVenues() to CreateEventViewModel to fetch list of venues, and imported necessary dependencies.
lib/views/after_auth_screens/events/create_event_page.dart	Added venue selection feature including imports for EventVenue and GraphqlConfig, and introduced selectedVenue in _CreateEventPageState.
lib/views/after_auth_screens/events/venue_bottom_sheet.dart	Introduced VenueBottomSheet widget for displaying list of venues, enabling search and selection functionality.
lib/widgets/venue_card.dart	Enhanced VenueCard class with additional functionality for venue selection and display, including constructor parameter isSelected, methods to fetch venue details, and layout build

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CreateEventPage
    participant CreateEventViewModel
    participant GraphQLServer

    User ->> CreateEventPage: Select "Venue" option
    CreateEventPage ->> CreateEventViewModel: fetchVenues()
    CreateEventViewModel ->> GraphQLServer: venueListQuery()
    GraphQLServer -->> CreateEventViewModel: List of venues
    CreateEventViewModel -->> CreateEventPage: List of venues
    CreateEventPage ->> VenueBottomSheet: Display venues
    User ->> VenueBottomSheet: Search and Select venue
    VenueBottomSheet -->> CreateEventPage: Selected venue
    CreateEventPage -->> User: Display selected venue

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Basic CRUD capabilities to add, update, view, and delete venue information including details (2522)	❓	The PR focuses on viewing and selecting venues, but does not mention add, update, or delete.
Comprehensive venue management feature to enhance event planning and booking system (2522)	✅
Import necessary dependencies and ensure proper functionality of fetching and displaying venues (2522)	✅

Poem

In fields of code where bytes do bloom,
Venues rise from digital womb.
Events now find a proper stage,
With fetched data on the page.
A rabbit's joy, venues grand,
Events unfold, as planned!
🌟🏟️

---

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
• Mastodon
• Reddit
• LinkedIn

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

[github-actions]

Our Pull Request Approval Process

We have these basic policies to make the approval process smoother for our volunteer team.

Testing Your Code

Please make sure your code passes all tests. Our test code coverage system will fail if either of these two conditions occur:

1. The overall code coverage drops below the target threshold of the repository
2. Any file in the pull request has code coverage levels below the repository threshold

The process helps maintain the overall reliability of the code base and is a prerequisite for getting your PR approved. Assigned reviewers regularly review the PR queue and tend to focus on PRs that are passing.

Reviewers

Do not assign reviewers. Our Queue Monitors will review your PR and assign them.
When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

1. comments in this PR or
2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

1. arbitrators of future discussions with other contributors about the validity of your changes
2. point of contact for evaluating the validity of your work
3. person who verifies matching issues by others that should be closed.
4. person who gives general guidance in fixing your tests

Other

🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.