Closed jo-elimu closed 3 weeks ago
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.
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. |
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/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`--- `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.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
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
).
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
Rename Word's property
letterSoundCorrespondences
toletterSounds
.refs #1677