refactor(dao): Rename letterSoundCorrespondences
#1713
Conversation
Rename Word's property `letterSoundCorrespondences` to `letterSounds`. refs #1677
WalkthroughThe changes primarily involve renaming variables and methods related to letter sound correspondences across multiple Java and JSP files. The Changes
Recent review detailsConfiguration used: CodeRabbit UI Files selected for processing (1)
Additional context usedLearnings (1)
Additional comments not posted (6)
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configration File (
|
| add constraint FKf6r3yfdc6quwa0b13mln5uuc8 | ||
| foreign key (letterSoundCorrespondences_id) |
There was a problem hiding this comment.
There is a mismatch between the jpa-schema-export.sql and the production database:
MariaDB [webapp-HIN]> SHOW CREATE TABLE Word_LetterSoundCorrespondence;| Word_LetterSoundCorrespondence | CREATE TABLE `Word_LetterSoundCorrespondence` (
`Word_id` bigint(20) NOT NULL,
`letterSoundCorrespondences_id` bigint(20) NOT NULL,
`letterSoundCorrespondences_ORDER` int(11) NOT NULL,
PRIMARY KEY (`Word_id`,`letterSoundCorrespondences_ORDER`),
KEY `FK_aegghkhls25m6pr0e42f1csvi` (`letterSoundCorrespondences_id`)
) ENGINE=MyISAM DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_bin |There was a problem hiding this comment.
The foreign key remained the same after the DB migration:
MariaDB [webapp-HIN]> SHOW CREATE TABLE Word_LetterSoundCorrespondence;| Word_LetterSoundCorrespondence | CREATE TABLE `Word_LetterSoundCorrespondence` (
`Word_id` bigint(20) NOT NULL,
`letterSounds_id` bigint(20) NOT NULL,
`letterSounds_ORDER` int(11) NOT NULL,
PRIMARY KEY (`Word_id`,`letterSounds_ORDER`),
KEY `FK_aegghkhls25m6pr0e42f1csvi` (`letterSounds_id`)
) ENGINE=MyISAM DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_bin |There was a problem hiding this comment.
Removed the DROP FOREIGN KEY from the migration script: aafe7dd
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (7)
src/main/resources/db/migration/2004006.sql (1)
5-6: Inconsistent column renaming detected.The old column name
letterSoundCorrespondences_idstill exists in2001230.sqland2004006.sql. The new column nameletterSounds_idappears in2004006.sqlandjpa-schema-export.sql. This indicates that the renaming might not be consistent across all SQL files. Please review and update the following files to ensure consistency:
src/main/resources/db/migration/2001230.sqlsrc/main/resources/db/migration/2004006.sqlAnalysis chain
Ensure column rename is correct and consistent.
The column
letterSoundCorrespondences_idis renamed toletterSounds_id. Verify that this change is consistent across all related SQL files and application code.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the column rename is consistent across all related SQL files. # Test: Search for the old and new column names. Expect: No occurrences of old column name, only new column name. rg --type sql 'letterSoundCorrespondences_id' rg --type sql 'letterSounds_id'Length of output: 1143
src/main/java/ai/elimu/model/content/Word.java (2)
51-52: Inconsistent Getter Method RenameThe getter method
getLetterSoundCorrespondenceshas not been renamed consistently across the codebase. The following files still contain references to the old method name and should be updated to usegetLetterSoundsif they refer to the same getter method inWord.java:
src/main/java/ai/elimu/util/csv/CsvContentExtractionHelper.javasrc/main/java/ai/elimu/util/db/DbContentImportHelper.javaPlease review and update these references as needed.
Analysis chain
Ensure getter rename is correct and consistent.
The getter method
getLetterSoundCorrespondencesis renamed togetLetterSounds. Verify that this change is consistent across all related code files and usage.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the getter method rename is consistent across all related code files. # Test: Search for the old and new getter method names. Expect: No occurrences of old getter method name, only new getter method name. rg --type java 'getLetterSoundCorrespondences' rg --type java 'getLetterSounds'Length of output: 1634
26-26: Inconsistent Property Rename DetectedThe property
letterSoundCorrespondenceswas not consistently renamed toletterSoundsacross the codebase. The following files still contain occurrences of the old property name:
src/main/java/ai/elimu/web/content/word/WordCsvExportController.javasrc/main/java/ai/elimu/web/content/word/WordEditController.javasrc/main/java/ai/elimu/web/content/word/WordCreateController.javasrc/main/java/ai/elimu/web/content/sound/SoundEditController.javasrc/main/java/ai/elimu/util/csv/CsvContentExtractionHelper.javasrc/main/webapp/WEB-INF/jsp/content/word/list.jspsrc/main/webapp/WEB-INF/jsp/content/word/peer-reviews/pending.jspsrc/main/webapp/WEB-INF/jsp/content/word/create.jspsrc/main/webapp/WEB-INF/jsp/content/letter-sound/edit.jspsrc/main/webapp/WEB-INF/jsp/contributions/most-recent.jspsrc/main/webapp/WEB-INF/jsp/content/word/edit.jspsrc/main/webapp/WEB-INF/jsp/content/storybook/edit.jspsrc/main/webapp/WEB-INF/jsp/content/sound/edit.jspsrc/main/webapp/WEB-INF/jsp/content/number/list.jspsrc/main/webapp/WEB-INF/jsp/content/number/peer-reviews/pending.jspsrc/main/webapp/WEB-INF/jsp/content/contributor/contributor-words.jspsrc/test/java/ai/elimu/rest/v2/crowdsource/WordContributionRestControllerTest.javaPlease update these occurrences to ensure consistency across the codebase.
Analysis chain
Ensure property rename is correct and consistent.
The property
letterSoundCorrespondencesis renamed toletterSounds. Verify that this change is consistent across all related code files and usage.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the property rename is consistent across all related code files. # Test: Search for the old and new property names. Expect: No occurrences of old property name, only new property name. rg --type java 'letterSoundCorrespondences' rg --type java 'letterSounds'Length of output: 15868
src/main/java/ai/elimu/tasks/SoundUsageCountScheduler.java (1)
50-52: Inconsistent variable renaming detected.The variable
letterSoundCorrespondenceshas not been consistently renamed toletterSoundsacross the codebase. The following files still contain the old variable name and need to be updated:
src/test/java/ai/elimu/rest/v2/crowdsource/WordContributionRestControllerTest.javasrc/main/java/ai/elimu/web/content/sound/SoundEditController.javasrc/main/java/ai/elimu/web/content/word/WordCsvExportController.javasrc/main/java/ai/elimu/web/content/word/WordCreateController.javasrc/main/java/ai/elimu/web/content/word/WordEditController.javasrc/main/java/ai/elimu/util/csv/CsvContentExtractionHelper.javasrc/main/webapp/WEB-INF/jsp/contributions/most-recent.jspsrc/main/webapp/WEB-INF/jsp/content/word/list.jspsrc/main/webapp/WEB-INF/jsp/content/word/peer-reviews/pending.jspsrc/main/webapp/WEB-INF/jsp/content/word/edit.jspsrc/main/webapp/WEB-INF/jsp/content/word/create.jspsrc/main/webapp/WEB-INF/jsp/content/number/list.jspsrc/main/webapp/WEB-INF/jsp/content/storybook/edit.jspsrc/main/webapp/WEB-INF/jsp/content/contributor/contributor-words.jspsrc/main/webapp/WEB-INF/jsp/content/sound/edit.jspsrc/main/webapp/WEB-INF/jsp/content/number/peer-reviews/pending.jspsrc/main/webapp/WEB-INF/jsp/content/letter-sound/edit.jspPlease update these instances to ensure consistency.
Analysis chain
Ensure variable rename is correct and consistent.
The variable
letterSoundCorrespondencesis renamed toletterSounds. Verify that this change is consistent across all related code files and usage.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the variable rename is consistent across all related code files. # Test: Search for the old and new variable names. Expect: No occurrences of old variable name, only new variable name. rg --type java 'letterSoundCorrespondences' rg --type java 'letterSounds'Length of output: 15868
src/main/java/ai/elimu/tasks/LetterSoundCorrespondenceUsageCountScheduler.java (1)
43-45: Ensure variable rename is correct and consistent.The variable
letterSoundCorrespondencesis still present in several files and needs to be updated toletterSoundsfor consistency. Please update the following files:
src/main/webapp/WEB-INF/jsp/content/word/edit.jspsrc/main/webapp/WEB-INF/jsp/content/word/peer-reviews/pending.jspsrc/main/webapp/WEB-INF/jsp/content/word/list.jspsrc/main/webapp/WEB-INF/jsp/content/word/create.jspsrc/main/webapp/WEB-INF/jsp/content/number/peer-reviews/pending.jspsrc/main/webapp/WEB-INF/jsp/content/number/list.jspsrc/main/webapp/WEB-INF/jsp/content/storybook/edit.jspsrc/main/webapp/WEB-INF/jsp/content/sound/edit.jspsrc/main/webapp/WEB-INF/jsp/content/letter-sound/edit.jspsrc/main/webapp/WEB-INF/jsp/contributions/most-recent.jspsrc/main/webapp/WEB-INF/jsp/content/contributor/contributor-words.jspsrc/main/java/ai/elimu/web/content/word/WordEditController.javasrc/main/java/ai/elimu/web/content/word/WordCsvExportController.javasrc/main/java/ai/elimu/web/content/word/WordCreateController.javasrc/main/java/ai/elimu/web/content/sound/SoundEditController.javasrc/main/java/ai/elimu/util/csv/CsvContentExtractionHelper.javasrc/test/java/ai/elimu/rest/v2/crowdsource/WordContributionRestControllerTest.javaPlease ensure these changes are made to maintain consistency across the codebase.
Analysis chain
Ensure variable rename is correct and consistent.
The variable
letterSoundCorrespondencesis renamed toletterSounds. Verify that this change is consistent across all related code files and usage.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the variable rename is consistent across all related code files. # Test: Search for the old and new variable names. Expect: No occurrences of old variable name, only new variable name. rg --type java 'letterSoundCorrespondences' rg --type java 'letterSounds'Length of output: 15868
src/main/java/ai/elimu/util/csv/CsvContentExtractionHelper.java (1)
161-161: Incomplete Renaming of Method and VariableThe method
getLetterSoundCorrespondencesFromCsvBackupinCsvContentExtractionHelper.javastill exists and has not been renamed togetLetterSoundsFromCsvBackup. To maintain consistency, please update the method name and all its references.
File:
src/main/java/ai/elimu/util/csv/CsvContentExtractionHelper.java
- Method:
getLetterSoundCorrespondencesFromCsvBackupFile:
src/main/java/ai/elimu/util/db/DbContentImportHelper.java
- References to the method
getLetterSoundCorrespondencesFromCsvBackupand variableletterSoundCorrespondencesshould be updated togetLetterSoundsFromCsvBackupandletterSounds.Analysis chain
LGTM! Ensure the method usage is updated.
The renaming from
letterSoundCorrespondencestoletterSoundsis consistent and correct.However, ensure that all method calls to
getWordsFromCsvBackupare updated to reflect this change.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify all method calls to `getWordsFromCsvBackup` are updated to reflect the renaming changes. # Test: Search for the method usage. Expect: Only occurrences of the new naming convention. rg --type java -A 5 $'getWordsFromCsvBackup'Length of output: 1648
Script:
#!/bin/bash # Description: Verify the usage of `letterSounds` and `letterSoundCorrespondences` in DbContentImportHelper.java # Test: Search for occurrences of `letterSounds` and `letterSoundCorrespondences` in DbContentImportHelper.java rg --type java 'letterSounds|letterSoundCorrespondences' src/main/java/ai/elimu/util/db/DbContentImportHelper.javaLength of output: 521
Script:
#!/bin/bash # Description: Verify the existence and usage of methods related to `letterSounds` and `letterSoundCorrespondences` in CsvContentExtractionHelper.java # Test: Search for method definitions of `getLetterSoundCorrespondencesFromCsvBackup` and `getLetterSoundsFromCsvBackup` in CsvContentExtractionHelper.java rg --type java 'getLetterSoundCorrespondencesFromCsvBackup|getLetterSoundsFromCsvBackup' src/main/java/ai/elimu/util/csv/CsvContentExtractionHelper.javaLength of output: 401
src/main/resources/META-INF/jpa-schema-export.sql (1)
1081-1082: Inconsistency in RenamingLetterSoundCorrespondencetoletterSoundsThe schema changes are not consistently applied across the codebase. The term
LetterSoundCorrespondenceis still widely used, whereasletterSoundsis used only in a limited context. This inconsistency could lead to schema-related issues.Please review and update the following files to ensure consistent naming:
src/main/resources/db/migration/2004006.sqlsrc/main/resources/META-INF/jpa-schema-export.sqlEnsure that all instances of
LetterSoundCorrespondenceare renamed toletterSoundsas intended.Analysis chain
LGTM! Ensure the schema changes are correctly applied.
The renaming from
letterSoundCorrespondencestoletterSoundsis consistent and correct.However, ensure that the schema changes are correctly applied and no other dependencies are affected.
Let's verify if
LetterSoundCorrespondenceandletterSoundsare used consistently in the SQL files.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify that the schema changes are correctly applied and no other dependencies are affected. # Test: Search for the constraint usage. Expect: Only occurrences of the new naming convention. rg --type sql -A 5 $'FK1ln49ylh4w15nddf9h41wjupt'Length of output: 587
Script:
#!/bin/bash # Search for all occurrences of 'LetterSoundCorrespondence' in SQL files rg --type sql 'LetterSoundCorrespondence' # Search for all occurrences of 'letterSounds' in SQL files rg --type sql 'letterSounds'Length of output: 8567
Should be `DROP FOREIGN KEY` refs #1677
…ub.com/elimu-ai/webapp into 1677-rename-letterSoundCorrespondences
Rename Word's property
letterSoundCorrespondencestoletterSounds.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 FKf6r3yfdc6quwa0b13mln5uuc8will work.