elimu-ai / webapp

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

refactor(dao): Rename `letterSoundCorrespondences` #1713

Closed jo-elimu closed 3 weeks ago

jo-elimu commented 3 weeks ago

Rename Word's property letterSoundCorrespondences to letterSounds.

refs #1677

[!WARNING] The schema export's foreign key constraint value is not identical to the one in the production database, so I'm not sure if the DROP FOREIGN KEY FKf6r3yfdc6quwa0b13mln5uuc8 will work.

coderabbitai[bot] commented 3 weeks ago

Walkthrough

The changes primarily involve renaming variables and methods related to letter sound correspondences across multiple Java and JSP files. The letterSoundCorrespondences variable is renamed to letterSounds, and associated getter and setter methods, as well as loop iterations and method calls, are updated accordingly. Additionally, SQL migration scripts are modified to reflect these changes in the database schema.

Changes

File(s) Change Summary
src/main/java/ai/elimu/model/content/Word.java Renamed letterSoundCorrespondences variable to letterSounds and updated getter/setter methods.
src/main/java/ai/elimu/rest/v2/JpaToGsonConverter.java Updated method to iterate over word.getLetterSounds() instead of word.getLetterSoundCorrespondences().
src/main/java/ai/elimu/tasks/LetterSoundCorrespondenceUsageCountScheduler.java Changed loop iteration from letterSoundCorrespondences to letterSounds.
src/main/java/ai/elimu/tasks/SoundUsageCountScheduler.java Updated variable names and method calls related to letter sounds.
src/main/java/ai/elimu/tasks/WordUsageCountScheduler.java Renamed method call from getLetterSoundCorrespondences() to getLetterSounds().
src/main/java/ai/elimu/util/csv/CsvContentExtractionHelper.java Renamed list and method calls related to letter sounds.
src/main/java/ai/elimu/web/content/word/WordCreateController.java Modified assignment from word.setLetterSoundCorrespondences to word.setLetterSounds.
src/main/java/ai/elimu/web/content/word/WordCsvExportController.java Renamed variables within a loop from letterSoundCorrespondences to letterSounds.
src/main/java/ai/elimu/web/content/word/WordEditController.java Changed method to use letterSounds instead of letterSoundCorrespondences.
src/main/resources/META-INF/jpa-schema-export.sql Renamed columns and constraints related to letter sound correspondences.
src/main/resources/db/migration/2004006.sql Renamed columns and reset primary keys in the Word_LetterSoundCorrespondence table.
src/main/resources/db/migration/2004007.sql Renamed columns, altered column types, reset primary keys, and deleted an obsolete foreign key constraint.
src/main/webapp/WEB-INF/jsp/content/contributor/contributor-words.jsp Renamed variable within a loop from ${word.letterSoundCorrespondences} to ${word.letterSounds}.
src/main/webapp/WEB-INF/jsp/content/letter-sound/edit.jsp Replaced references to ${word.letterSoundCorrespondences} with ${word.letterSounds}.
src/main/webapp/WEB-INF/jsp/content/number/list.jsp Updated iteration variable from ${word.letterSoundCorrespondences} to ${word.letterSounds}.
src/main/webapp/WEB-INF/jsp/content/number/peer-reviews/pending.jsp Changed variable name from ${word.letterSoundCorrespondences} to ${word.letterSounds} in JSP.
src/main/webapp/WEB-INF/jsp/content/storybook/edit.jsp Renamed iteration variable in loop from ${word.letterSoundCorrespondences} to ${word.letterSounds}.
src/main/webapp/WEB-INF/jsp/content/word/create.jsp Renamed variables related to letter sound correspondences from letterSoundCorrespondences to letterSounds.
src/main/webapp/WEB-INF/jsp/content/word/edit.jsp Updated variables related to letter sound correspondences from ${word.letterSoundCorrespondences} to ${word.letterSounds}.
src/main/webapp/WEB-INF/jsp/content/word/list.jsp Changed items attribute in a loop from ${word.letterSoundCorrespondences} to ${word.letterSounds}.
src/main/webapp/WEB-INF/jsp/content/word/peer-reviews/pending.jsp Updated iteration variable from ${word.letterSoundCorrespondences} to ${word.letterSounds} in JSP.
src/main/webapp/WEB-INF/jsp/contributions/most-recent.jsp Renamed variable from ${word.letterSoundCorrespondences} to ${word.letterSounds} in JSP.

Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 071901b302ff6d0e4c8f166e2db3a1ffc9be9d49 and f98bd4e3f715d013c055e3fb83045adaeabf9d1a.
Files selected for processing (1) * src/main/resources/db/migration/2004007.sql (1 hunks)
Additional context used
Learnings (1)
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. ```
Additional comments not posted (6)
src/main/resources/db/migration/2004007.sql (6)
`5-5`: **Verify the necessity of dropping the `letterSounds_id` column.** Dropping a column can lead to data loss. Ensure that this column is no longer needed and that any necessary data migration has been performed. --- `8-8`: **Verify the necessity of dropping the `letterSounds_ORDER` column.** Dropping a column can lead to data loss. Ensure that this column is no longer needed and that any necessary data migration has been performed. --- `12-12`: **LGTM! Ensure the appropriateness of the new primary key combination.** Resetting the primary key is necessary to reflect the column renaming. Ensure that the new primary key combination of `Word_id` and `letterSounds_ORDER` is appropriate and does not lead to any issues. --- `6-6`: **LGTM! Ensure consistent usage of the new column name.** The column renaming aligns with the objective of renaming `letterSoundCorrespondences` to `letterSounds`. Ensure that the new column name `letterSounds_id` is used consistently across the codebase. --- `9-9`: **LGTM! Ensure consistent usage of the new column name.** The column renaming aligns with the objective of renaming `letterSoundCorrespondences` to `letterSounds`. Ensure that the new column name `letterSounds_ORDER` is used consistently across the codebase.
Verification successful --- **Verified: Consistent usage of the new column name `letterSounds_ORDER`** The new column name `letterSounds_ORDER` is used consistently across the codebase, including in the migration script and the JPA schema export file. - `src/main/resources/db/migration/2004007.sql` - `src/main/resources/META-INF/jpa-schema-export.sql`
Scripts executed The following scripts were executed for the analysis: Script: ```shell #!/bin/bash # Description: Verify consistent usage of the new column name `letterSounds_ORDER`. # Test: Search for the new column name. Expect: Consistent usage across the codebase. rg --type sql --type java --type jsp 'letterSounds_ORDER' ``` Length of output: 85 --- Script: ```shell #!/bin/bash # Description: Verify consistent usage of the new column name `letterSounds_ORDER`. # Test: Search for the new column name. Expect: Consistent usage across the codebase. rg --type sql --type java 'letterSounds_ORDER' ``` Length of output: 687
--- `15-15`: **LGTM! Ensure the presence of new foreign key constraints if needed.** Dropping the obsolete foreign key constraint is necessary to reflect the column renaming. Ensure that new foreign key constraints are in place if needed.
--- 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 3 weeks ago

Codecov Report

Attention: Patch coverage is 0% with 25 lines in your changes missing coverage. Please review.

Project coverage is 15.26%. Comparing base (b17dc6c) to head (f98bd4e).

Files Patch % Lines
...limu/web/content/word/WordCsvExportController.java 0.00% 7 Missing :warning:
.../ai/elimu/web/content/word/WordEditController.java 0.00% 4 Missing :warning:
.../LetterSoundCorrespondenceUsageCountScheduler.java 0.00% 3 Missing :warning:
.../java/ai/elimu/tasks/SoundUsageCountScheduler.java 0.00% 3 Missing :warning:
.../ai/elimu/util/csv/CsvContentExtractionHelper.java 0.00% 3 Missing :warning:
src/main/java/ai/elimu/model/content/Word.java 0.00% 2 Missing :warning:
...main/java/ai/elimu/rest/v2/JpaToGsonConverter.java 0.00% 1 Missing :warning:
...n/java/ai/elimu/tasks/WordUsageCountScheduler.java 0.00% 1 Missing :warning:
...i/elimu/web/content/word/WordCreateController.java 0.00% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #1713 +/- ## ========================================= 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.