search

elimu-ai / webapp

🖥 Web application for hosting Android applications and educational content
https://hin.elimu.ai
MIT License
30 stars 55 forks source link

feat(web3): export impact percentages to csv #1757

Closed nya-elimu closed 1 month ago

nya-elimu commented 1 month ago

Calculates the percentage impact per contributor.

close https://github.com/elimu-ai/web3-wiki/issues/41

coderabbitai[bot] commented 1 month ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The changes introduce a new feature in the web application, allowing users to export contributor data and their impact percentages to a CSV file. A new controller class handles HTTP requests to generate and download the CSV file, while the front-end includes a button to trigger this export, providing a better user experience.

Changes

Files/Paths Change Summary
src/main/java/ai/elimu/web/content/contributor/ContributorCsvExportController.java Introduced a new controller class that handles HTTP requests for exporting contributor data to CSV. It fetches data from DAOs, calculates impact percentages, and writes the CSV content to the HTTP response output stream.
src/main/webapp/WEB-INF/jsp/content/contributor/list.jsp Added an export to CSV button with associated JavaScript functionality to display a toast message when clicked, providing a direct export option for contributor data in CSV format.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Browser
    participant WebServer as Web Server
    participant CtrDao as ContributorDao
    participant LtrCtrDao as LetterContributionEventDao
    participant NumCtrDao as NumberContributionEventDao
    participant StbCtrDao as StoryBookContributionEventDao
    participant WrdCtrDao as WordContributionEventDao

    User->>Browser: Clicks on 'Export to CSV' button
    Browser->>WebServer: HTTP GET /content/contributor/list/contributors.csv
    WebServer->>CtrDao: Fetch contributor data
    WebServer->>LtrCtrDao: Fetch letter contribution events
    WebServer->>NumCtrDao: Fetch number contribution events
    WebServer->>StbCtrDao: Fetch storybook contribution events
    WebServer->>WrdCtrDao: Fetch word contribution events
    WebServer: Calculate impact percentages
    WebServer: Generate CSV content
    WebServer->>Browser: Send CSV file
    Browser->>User: Prompts download dialog

Assessment against linked issues

Objective Addressed Explanation
Export CSV with contributors and impact percentages (#41) ✅

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.
codecov[bot] commented 1 month ago

Codecov Report

Attention: Patch coverage is 3.84615% with 50 lines in your changes missing coverage. Please review.

Project coverage is 15.18%. Comparing base (36f0a01) to head (e623452).

Files Patch % Lines
...nt/contributor/ContributorCsvExportController.java 3.84% 50 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #1757 +/- ## ============================================ - Coverage 15.25% 15.18% -0.08% - Complexity 449 450 +1 ============================================ Files 248 249 +1 Lines 7582 7634 +52 Branches 799 801 +2 ============================================ + Hits 1157 1159 +2 - Misses 6375 6425 +50 Partials 50 50 ```

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