search

elimu-ai / webapp

đź–Ą Web application for hosting Android applications and educational content
https://hin.elimu.ai
MIT License
30 stars 57 forks source link

build(mvn): spotless maven plugin #1729

Closed jo-elimu closed 2 months ago

jo-elimu commented 3 months ago

closes #1728

codecov[bot] commented 3 months ago

Codecov Report

Attention: Patch coverage is 2.45902% with 119 lines in your changes missing coverage. Please review.

Project coverage is 15.15%. Comparing base (835482e) to head (97aed9b). Report is 12 commits behind head on main.

Files Patch % Lines
.../content/multimedia/audio/AudioEditController.java 0.00% 6 Missing :warning:
.../content/multimedia/image/ImageEditController.java 0.00% 6 Missing :warning:
.../content/multimedia/video/VideoEditController.java 0.00% 6 Missing :warning:
...on_version/ApplicationVersionCreateController.java 0.00% 4 Missing :warning:
...i/elimu/web/content/emoji/EmojiEditController.java 0.00% 4 Missing :warning:
...ontent/multimedia/audio/AudioCreateController.java 0.00% 4 Missing :warning:
...ontent/multimedia/image/ImageCreateController.java 0.00% 4 Missing :warning:
...ontent/multimedia/video/VideoCreateController.java 0.00% 4 Missing :warning:
...t/storybook/StoryBookCreateFromEPubController.java 0.00% 4 Missing :warning:
.../web/context/EnvironmentContextLoaderListener.java 0.00% 3 Missing :warning:
... and 53 more
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #1729 +/- ## ========================================= Coverage 15.15% 15.15% Complexity 456 456 ========================================= Files 250 250 Lines 7676 7676 Branches 801 801 ========================================= Hits 1163 1163 Misses 6463 6463 Partials 50 50 ```

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

jo-elimu commented 2 months ago

@Souvik-Cyclic I added a note to the PR template that you created earlier.

coderabbitai[bot] commented 2 months ago

Walkthrough

The changes encompass the configuration of the spotless-maven-plugin to enforce consistent code formatting across the project. The plugin is integrated into the Maven build process, enhancing the documentation for pull requests with guidance on running format checks. Additionally, minor formatting adjustments were made throughout various Java classes and test files, focusing on whitespace and indentation without altering functionality.

Changes

File(s) Change Summary
.github/pull_request_template.md, .github/workflows/maven-build.yml Added documentation for format checks and a new CI job for code formatting.
src/main/java/ai/elimu/dao/*.java, src/main/java/ai/elimu/util/*.java, src/main/java/ai/elimu/web/*.java, src/test/java/ai/elimu/dao/*.java, src/test/java/selenium/web/*.java Minor formatting changes, including whitespace adjustments and indentation corrections across various classes.

Assessment against linked issues

Objective Addressed Explanation
Configure spotless-maven-plugin (#1728) âś…
Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 835482e2f5bfb34d5d056d77a421c82bcc09deeb and 97aed9bba0d6d8b206660c492ada453188503131.
Files ignored due to path filters (1) * `pom.xml` is excluded by `!**/*.xml`
Files selected for processing (92) * .github/pull_request_template.md (1 hunks) * .github/workflows/maven-build.yml (1 hunks) * src/main/java/ai/elimu/dao/AudioDao.java (1 hunks) * src/main/java/ai/elimu/dao/ContributorDao.java (1 hunks) * src/main/java/ai/elimu/dao/DbMigrationDao.java (1 hunks) * src/main/java/ai/elimu/dao/DeviceDao.java (1 hunks) * src/main/java/ai/elimu/dao/ImageDao.java (1 hunks) * src/main/java/ai/elimu/dao/NumberDao.java (1 hunks) * src/main/java/ai/elimu/dao/SoundDao.java (1 hunks) * src/main/java/ai/elimu/dao/StoryBookChapterDao.java (1 hunks) * src/main/java/ai/elimu/dao/StoryBookDao.java (1 hunks) * src/main/java/ai/elimu/dao/StoryBookParagraphDao.java (1 hunks) * src/main/java/ai/elimu/dao/VideoDao.java (1 hunks) * src/main/java/ai/elimu/dao/WordDao.java (1 hunks) * src/main/java/ai/elimu/dao/jpa/GenericDaoJpa.java (1 hunks) * src/main/java/ai/elimu/util/LetterFrequencyHelper.java (1 hunks) * src/main/java/ai/elimu/util/SyllableFrequencyHelper.java (1 hunks) * src/main/java/ai/elimu/util/WordFrequencyHelper.java (1 hunks) * src/main/java/ai/elimu/web/CustomAuthenticationManager.java (1 hunks) * src/main/java/ai/elimu/web/SignOnController.java (2 hunks) * src/main/java/ai/elimu/web/SignOnControllerDiscord.java (1 hunks) * src/main/java/ai/elimu/web/SignOnControllerGitHub.java (1 hunks) * src/main/java/ai/elimu/web/SignOnControllerSelenium.java (2 hunks) * src/main/java/ai/elimu/web/SignOnControllerWeb3.java (1 hunks) * src/main/java/ai/elimu/web/WelcomeController.java (1 hunks) * src/main/java/ai/elimu/web/admin/MainAdminController.java (1 hunks) * src/main/java/ai/elimu/web/admin/application/ApplicationCreateController.java (2 hunks) * src/main/java/ai/elimu/web/admin/application/ApplicationEditController.java (2 hunks) * src/main/java/ai/elimu/web/admin/application/ApplicationListController.java (1 hunks) * src/main/java/ai/elimu/web/admin/application_version/ApplicationVersionCreateController.java (3 hunks) * src/main/java/ai/elimu/web/analytics/LetterLearningEventListController.java (1 hunks) * src/main/java/ai/elimu/web/analytics/MainAnalyticsController.java (1 hunks) * src/main/java/ai/elimu/web/analytics/StoryBookLearningEventListController.java (1 hunks) * src/main/java/ai/elimu/web/analytics/WordLearningEventListController.java (1 hunks) * src/main/java/ai/elimu/web/content/MainContentController.java (2 hunks) * src/main/java/ai/elimu/web/content/contributor/AddEmailController.java (3 hunks) * src/main/java/ai/elimu/web/content/contributor/ContributorController.java (1 hunks) * src/main/java/ai/elimu/web/content/contributor/ContributorListController.java (1 hunks) * src/main/java/ai/elimu/web/content/contributor/EditMotivationController.java (2 hunks) * src/main/java/ai/elimu/web/content/contributor/EditNameController.java (3 hunks) * src/main/java/ai/elimu/web/content/emoji/EmojiCreateController.java (2 hunks) * src/main/java/ai/elimu/web/content/emoji/EmojiEditController.java (4 hunks) * src/main/java/ai/elimu/web/content/emoji/EmojiListController.java (1 hunks) * src/main/java/ai/elimu/web/content/letter/LetterCreateController.java (2 hunks) * src/main/java/ai/elimu/web/content/letter/LetterEditController.java (2 hunks) * src/main/java/ai/elimu/web/content/letter/LetterListController.java (1 hunks) * src/main/java/ai/elimu/web/content/letter_sound/LetterSoundCreateController.java (2 hunks) * src/main/java/ai/elimu/web/content/letter_sound/LetterSoundEditController.java (2 hunks) * src/main/java/ai/elimu/web/content/letter_sound/LetterSoundListController.java (1 hunks) * src/main/java/ai/elimu/web/content/multimedia/audio/AudioCreateController.java (3 hunks) * src/main/java/ai/elimu/web/content/multimedia/audio/AudioEditController.java (4 hunks) * src/main/java/ai/elimu/web/content/multimedia/audio/AudioListController.java (1 hunks) * src/main/java/ai/elimu/web/content/multimedia/image/ImageCreateController.java (3 hunks) * src/main/java/ai/elimu/web/content/multimedia/image/ImageDeleteController.java (1 hunks) * src/main/java/ai/elimu/web/content/multimedia/image/ImageEditController.java (4 hunks) * src/main/java/ai/elimu/web/content/multimedia/image/ImageListController.java (1 hunks) * src/main/java/ai/elimu/web/content/multimedia/video/VideoCreateController.java (3 hunks) * src/main/java/ai/elimu/web/content/multimedia/video/VideoEditController.java (4 hunks) * src/main/java/ai/elimu/web/content/multimedia/video/VideoListController.java (1 hunks) * src/main/java/ai/elimu/web/content/number/NumberCreateController.java (2 hunks) * src/main/java/ai/elimu/web/content/number/NumberDeleteController.java (1 hunks) * src/main/java/ai/elimu/web/content/number/NumberEditController.java (2 hunks) * src/main/java/ai/elimu/web/content/number/NumberListController.java (1 hunks) * src/main/java/ai/elimu/web/content/peer_review/AudioPeerReviewEventCreateController.java (1 hunks) * src/main/java/ai/elimu/web/content/peer_review/LetterSoundPeerReviewEventCreateController.java (1 hunks) * src/main/java/ai/elimu/web/content/peer_review/NumberPeerReviewEventCreateController.java (1 hunks) * src/main/java/ai/elimu/web/content/peer_review/StoryBookPeerReviewEventCreateController.java (1 hunks) * src/main/java/ai/elimu/web/content/peer_review/WordPeerReviewEventCreateController.java (1 hunks) * src/main/java/ai/elimu/web/content/sound/SoundCreateController.java (2 hunks) * src/main/java/ai/elimu/web/content/sound/SoundEditController.java (2 hunks) * src/main/java/ai/elimu/web/content/sound/SoundListController.java (1 hunks) * src/main/java/ai/elimu/web/content/storybook/StoryBookCreateController.java (2 hunks) * src/main/java/ai/elimu/web/content/storybook/StoryBookCreateFromEPubController.java (3 hunks) * src/main/java/ai/elimu/web/content/storybook/StoryBookEditController.java (2 hunks) * src/main/java/ai/elimu/web/content/storybook/StoryBookListController.java (1 hunks) * src/main/java/ai/elimu/web/content/storybook/chapter/StoryBookChapterCreateController.java (2 hunks) * src/main/java/ai/elimu/web/content/storybook/chapter/StoryBookChapterDeleteController.java (1 hunks) * src/main/java/ai/elimu/web/content/storybook/paragraph/StoryBookParagraphCreateController.java (2 hunks) * src/main/java/ai/elimu/web/content/storybook/paragraph/StoryBookParagraphDeleteController.java (1 hunks) * src/main/java/ai/elimu/web/content/storybook/paragraph/StoryBookParagraphEditController.java (2 hunks) * src/main/java/ai/elimu/web/content/syllable/SyllableListController.java (1 hunks) * src/main/java/ai/elimu/web/content/word/WordCreateController.java (2 hunks) * src/main/java/ai/elimu/web/content/word/WordCreationsPendingController.java (1 hunks) * src/main/java/ai/elimu/web/content/word/WordEditController.java (2 hunks) * src/main/java/ai/elimu/web/content/word/WordListController.java (1 hunks) * src/main/java/ai/elimu/web/context/EnvironmentContextLoaderListener.java (4 hunks) * src/main/java/ai/elimu/web/contributions/MostRecentContributionsController.java (1 hunks) * src/main/java/ai/elimu/web/servlet/CustomDispatcherServlet.java (1 hunks) * src/test/java/ai/elimu/dao/BaseDaoTest.java (1 hunks) * src/test/java/ai/elimu/dao/ContributorDaoTest.java (1 hunks) * src/test/java/ai/elimu/dao/ImageDaoTest.java (1 hunks) * src/test/java/selenium/web/WelcomePageTest.java (1 hunks)
Files skipped from review due to trivial changes (91) * .github/pull_request_template.md * src/main/java/ai/elimu/dao/AudioDao.java * src/main/java/ai/elimu/dao/ContributorDao.java * src/main/java/ai/elimu/dao/DbMigrationDao.java * src/main/java/ai/elimu/dao/DeviceDao.java * src/main/java/ai/elimu/dao/ImageDao.java * src/main/java/ai/elimu/dao/NumberDao.java * src/main/java/ai/elimu/dao/SoundDao.java * src/main/java/ai/elimu/dao/StoryBookChapterDao.java * src/main/java/ai/elimu/dao/StoryBookDao.java * src/main/java/ai/elimu/dao/StoryBookParagraphDao.java * src/main/java/ai/elimu/dao/VideoDao.java * src/main/java/ai/elimu/dao/WordDao.java * src/main/java/ai/elimu/dao/jpa/GenericDaoJpa.java * src/main/java/ai/elimu/util/LetterFrequencyHelper.java * src/main/java/ai/elimu/util/SyllableFrequencyHelper.java * src/main/java/ai/elimu/util/WordFrequencyHelper.java * src/main/java/ai/elimu/web/CustomAuthenticationManager.java * src/main/java/ai/elimu/web/SignOnController.java * src/main/java/ai/elimu/web/SignOnControllerDiscord.java * src/main/java/ai/elimu/web/SignOnControllerGitHub.java * src/main/java/ai/elimu/web/SignOnControllerSelenium.java * src/main/java/ai/elimu/web/SignOnControllerWeb3.java * src/main/java/ai/elimu/web/WelcomeController.java * src/main/java/ai/elimu/web/admin/MainAdminController.java * src/main/java/ai/elimu/web/admin/application/ApplicationCreateController.java * src/main/java/ai/elimu/web/admin/application/ApplicationEditController.java * src/main/java/ai/elimu/web/admin/application/ApplicationListController.java * src/main/java/ai/elimu/web/admin/application_version/ApplicationVersionCreateController.java * src/main/java/ai/elimu/web/analytics/LetterLearningEventListController.java * src/main/java/ai/elimu/web/analytics/MainAnalyticsController.java * src/main/java/ai/elimu/web/analytics/StoryBookLearningEventListController.java * src/main/java/ai/elimu/web/analytics/WordLearningEventListController.java * src/main/java/ai/elimu/web/content/MainContentController.java * src/main/java/ai/elimu/web/content/contributor/AddEmailController.java * src/main/java/ai/elimu/web/content/contributor/ContributorController.java * src/main/java/ai/elimu/web/content/contributor/ContributorListController.java * src/main/java/ai/elimu/web/content/contributor/EditMotivationController.java * src/main/java/ai/elimu/web/content/contributor/EditNameController.java * src/main/java/ai/elimu/web/content/emoji/EmojiCreateController.java * src/main/java/ai/elimu/web/content/emoji/EmojiEditController.java * src/main/java/ai/elimu/web/content/emoji/EmojiListController.java * src/main/java/ai/elimu/web/content/letter/LetterCreateController.java * src/main/java/ai/elimu/web/content/letter/LetterEditController.java * src/main/java/ai/elimu/web/content/letter/LetterListController.java * src/main/java/ai/elimu/web/content/letter_sound/LetterSoundCreateController.java * src/main/java/ai/elimu/web/content/letter_sound/LetterSoundEditController.java * src/main/java/ai/elimu/web/content/letter_sound/LetterSoundListController.java * src/main/java/ai/elimu/web/content/multimedia/audio/AudioCreateController.java * src/main/java/ai/elimu/web/content/multimedia/audio/AudioEditController.java * src/main/java/ai/elimu/web/content/multimedia/audio/AudioListController.java * src/main/java/ai/elimu/web/content/multimedia/image/ImageCreateController.java * src/main/java/ai/elimu/web/content/multimedia/image/ImageDeleteController.java * src/main/java/ai/elimu/web/content/multimedia/image/ImageEditController.java * src/main/java/ai/elimu/web/content/multimedia/image/ImageListController.java * src/main/java/ai/elimu/web/content/multimedia/video/VideoCreateController.java * src/main/java/ai/elimu/web/content/multimedia/video/VideoEditController.java * src/main/java/ai/elimu/web/content/multimedia/video/VideoListController.java * src/main/java/ai/elimu/web/content/number/NumberCreateController.java * src/main/java/ai/elimu/web/content/number/NumberDeleteController.java * src/main/java/ai/elimu/web/content/number/NumberEditController.java * src/main/java/ai/elimu/web/content/number/NumberListController.java * src/main/java/ai/elimu/web/content/peer_review/AudioPeerReviewEventCreateController.java * src/main/java/ai/elimu/web/content/peer_review/LetterSoundPeerReviewEventCreateController.java * src/main/java/ai/elimu/web/content/peer_review/NumberPeerReviewEventCreateController.java * src/main/java/ai/elimu/web/content/peer_review/StoryBookPeerReviewEventCreateController.java * src/main/java/ai/elimu/web/content/peer_review/WordPeerReviewEventCreateController.java * src/main/java/ai/elimu/web/content/sound/SoundCreateController.java * src/main/java/ai/elimu/web/content/sound/SoundEditController.java * src/main/java/ai/elimu/web/content/sound/SoundListController.java * src/main/java/ai/elimu/web/content/storybook/StoryBookCreateController.java * src/main/java/ai/elimu/web/content/storybook/StoryBookCreateFromEPubController.java * src/main/java/ai/elimu/web/content/storybook/StoryBookEditController.java * src/main/java/ai/elimu/web/content/storybook/StoryBookListController.java * src/main/java/ai/elimu/web/content/storybook/chapter/StoryBookChapterCreateController.java * src/main/java/ai/elimu/web/content/storybook/chapter/StoryBookChapterDeleteController.java * src/main/java/ai/elimu/web/content/storybook/paragraph/StoryBookParagraphCreateController.java * src/main/java/ai/elimu/web/content/storybook/paragraph/StoryBookParagraphDeleteController.java * src/main/java/ai/elimu/web/content/storybook/paragraph/StoryBookParagraphEditController.java * src/main/java/ai/elimu/web/content/syllable/SyllableListController.java * src/main/java/ai/elimu/web/content/word/WordCreateController.java * src/main/java/ai/elimu/web/content/word/WordCreationsPendingController.java * src/main/java/ai/elimu/web/content/word/WordEditController.java * src/main/java/ai/elimu/web/content/word/WordListController.java * src/main/java/ai/elimu/web/context/EnvironmentContextLoaderListener.java * src/main/java/ai/elimu/web/contributions/MostRecentContributionsController.java * src/main/java/ai/elimu/web/servlet/CustomDispatcherServlet.java * src/test/java/ai/elimu/dao/BaseDaoTest.java * src/test/java/ai/elimu/dao/ContributorDaoTest.java * src/test/java/ai/elimu/dao/ImageDaoTest.java * src/test/java/selenium/web/WelcomePageTest.java
Additional comments not posted (1)
.github/workflows/maven-build.yml (1)
`33-48`: **Integration of `code_format_check` job is well-structured.** The addition of the `code_format_check` job is well-integrated into the existing workflow. It correctly depends on the `build` job and uses consistent setup steps for Java and Maven. The use of `spotless:check` ensures that code formatting is verified before the build process is finalized. This enhances the quality assurance process by maintaining code consistency.
--- 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.