search

PalisadoesFoundation / talawa

Community Organization Management Software. Click on the link below to see our documentation.
https://docs.talawa.io/
GNU General Public License v3.0
339 stars 465 forks source link

Event Agenda Management(GSoC) #2591

Closed Dante291 closed 1 month ago

Dante291 commented 1 month ago

What kind of change does this PR introduce?

Feature for agenda management for events.

Issue Number:

Fixes #2577

Did you add tests for your changes?

Yes

Snapshots/Videos:

https://github.com/user-attachments/assets/bf2fdb3e-b247-45dd-9cda-ba3553452812

If relevant, did you update the documentation?

Summary

Does this PR introduce a breaking change?

Yes

Other information

Have you read the contributing guide?

Yes

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The pull request introduces significant enhancements to the event agenda management functionality in the application. Key changes include the addition of new models, view models, and services for handling agenda items, as well as updates to the GitHub Actions workflow for pull requests. New UI components for creating and editing agenda items have been added, along with corresponding tests to ensure functionality. The modifications also include improved GraphQL operations for fetching and managing agenda-related data.

Changes

File Path Change Summary
.github/workflows/pull-request.yml Modified workflow to include line counting and branch checks; updated commands for line count.
lib/locator.dart Added import and registration for EditAgendaItemViewModel.
lib/models/events/event_agenda_category.dart Introduced AgendaCategory class with properties and JSON parsing method.
lib/models/events/event_agenda_item.dart Created EventAgendaItem class with properties, enumeration, and JSON parsing method.
lib/services/event_service.dart Updated GraphQL operations and added methods for managing agenda items.
lib/services/image_service.dart Removed logging of Base64 string in convertToBase64 method.
lib/utils/event_queries.dart Added methods for agenda item operations (fetch, create, update, delete).
lib/view_model/after_auth_view_models/event_view_models/edit_agenda_view_model.dart Introduced EditAgendaItemViewModel for managing agenda item state and behavior.
lib/view_model/after_auth_view_models/event_view_models/event_info_view_model.dart Expanded functionality to include agenda item management.
lib/views/after_auth_screens/events/create_agenda_item_page.dart Created UI for creating new agenda items.
lib/views/after_auth_screens/events/edit_agenda_item_page.dart Created UI for editing existing agenda items.
lib/views/after_auth_screens/events/event_info_page.dart Updated to conditionally display tabs based on user role.
lib/views/after_auth_screens/events/manage_agenda_items_screen.dart Created UI for managing agenda items.
lib/widgets/agenda_item_tile.dart Introduced ExpandableAgendaItemTile widget for displaying agenda items.
test/helpers/test_helpers.dart Updated to include EditAgendaItemViewModel for testing.
test/helpers/test_helpers.mocks.dart Added mock methods for agenda item operations in MockEventService.
test/helpers/test_locator.dart Updated to register EditAgendaItemViewModel.
test/model_tests/events/event_agenda_category_test.dart Added tests for AgendaCategory model.
test/model_tests/events/event_agenda_item_test.dart Added tests for EventAgendaItem model.
test/service_tests/event_service_test.dart Added tests for new agenda item methods in EventService.
test/utils/event_queries_test.dart Added tests for new methods in EventQueries.
test/view_model_tests/after_auth_view_model_tests/event_view_model_tests/edit_agenda_view_model_test.dart Added tests for EditAgendaItemViewModel.
test/view_model_tests/after_auth_view_model_tests/event_view_model_tests/event_info_view_model_test.dart Added tests for agenda item management in EventInfoViewModel.
test/views/after_auth_screens/events/create_agenda_item_page_test.dart Added widget tests for CreateAgendaItemPage.
test/views/after_auth_screens/events/edit_agenda_item_page_test.dart Added widget tests for EditAgendaItemPage.
test/views/after_auth_screens/events/manage_agenda_items_screen_test.dart Added widget tests for ManageAgendaScreen.
test/widget_tests/after_auth_screens/events/event_info_page_test.dart Added test for agenda section visibility in EventInfoPage.
test/widget_tests/widgets/agenda_item_tile_test.dart Added widget tests for ExpandableAgendaItemTile.
test/views/helpers/test_locator.dart Removed unused helper file.

Assessment against linked issues

Objective Addressed Explanation
Implement agenda management functionality ✅

Possibly related PRs

Suggested reviewers

Poem

In the garden of events, we hop and play,
New agendas bloom, brightening the day.
With models and views, our work is complete,
Editing and creating, oh, what a treat!
So gather your carrots, let’s celebrate cheer,
For the magic of coding is finally here! 🐰✨

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 , 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. ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
github-actions[bot] commented 1 month ago

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

:dart: 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.

codecov[bot] commented 1 month ago

Codecov Report

Attention: Patch coverage is 82.46445% with 111 lines in your changes missing coverage. Please review.

Project coverage is 95.47%. Comparing base (67ce8e0) to head (f0c296e). Report is 2 commits behind head on develop.

Files with missing lines Patch % Lines
...r_auth_screens/events/create_agenda_item_page.dart 75.72% 42 Missing :warning:
...ter_auth_screens/events/edit_agenda_item_page.dart 81.64% 29 Missing :warning:
lib/widgets/agenda_item_tile.dart 59.64% 23 Missing :warning:
...uth_screens/events/manage_agenda_items_screen.dart 75.60% 10 Missing :warning:
...dels/event_view_models/edit_agenda_view_model.dart 95.45% 3 Missing :warning:
lib/services/event_service.dart 90.00% 2 Missing :warning:
...odels/event_view_models/event_info_view_model.dart 97.29% 2 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## develop #2591 +/- ## =========================================== - Coverage 96.42% 95.47% -0.95% =========================================== Files 180 187 +7 Lines 9233 9884 +651 =========================================== + Hits 8903 9437 +534 - Misses 330 447 +117 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

Dante291 commented 1 month ago

@palisadoes This is ready to get merged