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

refactor(dao): LetterSoundCorrespondenceContributionEvent#letterSounds #1717

Closed jo-elimu closed 1 month ago

jo-elimu commented 1 month ago

refs #1677

[!WARNING] Includes DB migration script for renaming a column in production from letterSoundCorrespondence_id to letterSound_id.

Current structure in the production database:

MariaDB [webapp-HIN]> SHOW CREATE TABLE LetterSoundCorrespondenceContributionEvent;
| LetterSoundCorrespondenceContributionEvent | CREATE TABLE `LetterSoundCorrespondenceContributionEvent` (
  `id` bigint(20) NOT NULL AUTO_INCREMENT,
  `comment` varchar(1000) DEFAULT NULL,
  `revisionNumber` int(11) NOT NULL,
  `time` datetime NOT NULL,
  `timeSpentMs` bigint(20) NOT NULL,
  `contributor_id` bigint(20) NOT NULL,
  `letterSoundCorrespondence_id` bigint(20) NOT NULL,
  PRIMARY KEY (`id`),
  KEY `FKouellxtx1de1wpddv5x72h9jn` (`contributor_id`),
  KEY `FKm1rttrlv6gxibd85a5sc3c4js` (`letterSoundCorrespondence_id`)
) ENGINE=MyISAM AUTO_INCREMENT=91 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_bin |
coderabbitai[bot] commented 1 month ago

Walkthrough

This update renames various entities and methods from LetterSoundCorrespondence to LetterSound across multiple files for consistency and clarity. This involves changes in Java classes, SQL schema, controller methods, queries, and JSP files, ensuring the codebase uses the more concise term LetterSound.

Changes

Files / Group of Files Change Summary
.../LetterSoundCorrespondenceContributionEvent.java Renamed letterSoundCorrespondence to letterSound.
.../DbContentImportHelper.java Updated method call from setLetterSoundCorrespondence to setLetterSound within LetterSoundContributionEvent class.
.../LetterSoundCreateController.java, .../LetterSoundEditController.java Modified method setLetterSoundCorrespondence to setLetterSound.
.../LetterSoundPeerReviewEventCreateController.java Updated various method calls and URL constructions from letterSoundCorrespondence to letterSound.
.../META-INF/jpa-schema-export.sql, .../db/migration/2004008.sql Renamed column letterSoundCorrespondence_id to letterSound_id and updated related foreign key constraints.
.../LetterSoundContributionEventDaoJpa.java, .../LetterSoundPeerReviewEventDaoJpa.java Modified query conditions and parameter settings to use letterSound instead of letterSoundCorrespondence.
.../content/letter-sound/peer-reviews/pending.jsp Updated variable assignment from ${letterSoundContributionEvent.letterSoundCorrespondence} to ${letterSoundContributionEvent.letterSound}.

Possibly related issues

Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 05cc2b57712ff00546673221e28a2ec37434df50 and 613bfc7b012082f6d08585eba8d884cd797d87de.
Files selected for processing (3) * src/main/java/ai/elimu/dao/jpa/LetterSoundContributionEventDaoJpa.java (2 hunks) * src/main/java/ai/elimu/dao/jpa/LetterSoundPeerReviewEventDaoJpa.java (1 hunks) * src/main/webapp/WEB-INF/jsp/content/letter-sound/peer-reviews/pending.jsp (2 hunks)
Additional context used
Learnings (4)
Common learnings
``` Learnt from: venkatesh2k3 PR: elimu-ai/webapp#1682 File: src/main/java/ai/elimu/dao/LetterSoundContributionEventDao.java:13-13 Timestamp: 2024-07-06T17:37:44.413Z Learning: In the `LetterSoundContributionEventDao.java` file, the method signatures should use `LetterSoundContributionEvent` instead of `LetterSoundCorrespondenceContributionEvent` to maintain consistency with the renaming of entities. ```
src/main/java/ai/elimu/dao/jpa/LetterSoundContributionEventDaoJpa.java (1)
``` Learnt from: venkatesh2k3 PR: elimu-ai/webapp#1682 File: src/main/java/ai/elimu/dao/LetterSoundContributionEventDao.java:13-13 Timestamp: 2024-07-06T17:37:44.413Z Learning: In the `LetterSoundContributionEventDao.java` file, the method signatures should use `LetterSoundContributionEvent` instead of `LetterSoundCorrespondenceContributionEvent` to maintain consistency with the renaming of entities. ```
src/main/java/ai/elimu/dao/jpa/LetterSoundPeerReviewEventDaoJpa.java (1)
``` Learnt from: venkatesh2k3 PR: elimu-ai/webapp#1682 File: src/main/java/ai/elimu/dao/LetterSoundContributionEventDao.java:13-13 Timestamp: 2024-07-06T17:37:44.413Z Learning: In the `LetterSoundContributionEventDao.java` file, the method signatures should use `LetterSoundContributionEvent` instead of `LetterSoundCorrespondenceContributionEvent` to maintain consistency with the renaming of entities. ```
src/main/webapp/WEB-INF/jsp/content/letter-sound/peer-reviews/pending.jsp (1)
``` Learnt from: venkatesh2k3 PR: elimu-ai/webapp#1682 File: src/main/java/ai/elimu/dao/LetterSoundContributionEventDao.java:13-13 Timestamp: 2024-07-06T17:37:44.413Z Learning: In the `LetterSoundContributionEventDao.java` file, the method signatures should use `LetterSoundContributionEvent` instead of `LetterSoundCorrespondenceContributionEvent` to maintain consistency with the renaming of entities. ```
Additional comments not posted (5)
src/main/java/ai/elimu/dao/jpa/LetterSoundContributionEventDaoJpa.java (3)
`26-28`: **LGTM!** The method `readAll` has been correctly updated to use `letterSound` instead of `letterSoundCorrespondence`. --- `48-48`: **LGTM!** The query in `readMostRecentPerLetterSound` has been correctly updated to use `letterSound_id`. --- Line range hint `31-33`: **LGTM!** The method `readAll` has been correctly updated to use `letterSound` instead of `letterSoundCorrespondence`.
src/main/java/ai/elimu/dao/jpa/LetterSoundPeerReviewEventDaoJpa.java (1)
`31-33`: **LGTM!** The method `readAll` has been correctly updated to use `letterSound` instead of `letterSoundCorrespondence`.
src/main/webapp/WEB-INF/jsp/content/letter-sound/peer-reviews/pending.jsp (1)
`28-28`: **LGTM!** The variable assignment has been correctly updated to use `letterSound` instead of `letterSoundCorrespondence`.
--- 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 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](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 0% with 11 lines in your changes missing coverage. Please review.

Project coverage is 15.26%. Comparing base (a0d4964) to head (613bfc7).

Files Patch % Lines
...ew/LetterSoundPeerReviewEventCreateController.java 0.00% 4 Missing :warning:
...or/LetterSoundCorrespondenceContributionEvent.java 0.00% 2 Missing :warning:
...mu/dao/jpa/LetterSoundContributionEventDaoJpa.java 0.00% 1 Missing :warning:
...limu/dao/jpa/LetterSoundPeerReviewEventDaoJpa.java 0.00% 1 Missing :warning:
...n/java/ai/elimu/util/db/DbContentImportHelper.java 0.00% 1 Missing :warning:
...tent/letter_sound/LetterSoundCreateController.java 0.00% 1 Missing :warning:
...ontent/letter_sound/LetterSoundEditController.java 0.00% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #1717 +/- ## ========================================= Coverage 15.26% 15.26% Complexity 450 450 ========================================= Files 248 248 Lines 7584 7584 Branches 799 799 ========================================= Hits 1158 1158 Misses 6376 6376 Partials 50 50 ```

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