Test and refactor csvtojson #133
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Each discipline's CSV is parsed in the same way, but has its own implementation. This introduces the possibility of errors when adding new scales. Factor out all the parsing.
The grade bands are defined in `src/GradeBands.ts`. They don't need to appear in the JSON files or `src/scales/index.ts`. Removing them simplifies parsing the CSVs.
`src/data/csvtojson.ts` is a script used to convert CSV tables of grades to JSON files used by sandbag at run time. The script is not tested in CI, so it is not obvious if it is broken or if someone forgot to run it while changing grade tables. Add tests of this script. Also check that it does not change the corresponding JSON files during testing. Fixes: OpenBeta#120
musoke
force-pushed
the
test-csv
branch
2 times, most recently
from
fb24f8e
to
c7546d9
Compare
musoke
commented
Jun 28, 2023
Comment on lines
+32
to
+33
| - name: Check if JSON conversions changed by running tests | ||
| run: git diff --exit-code "src/data/*.json" |
There was a problem hiding this comment.
I verified this change to the action here: https://github.com/OpenBeta/sandbag/actions/runs/5406330482/jobs/9823085987
|
@actuallyyun, could you review this since you made the most recent changes to |
There is redundant information in the mappings from column titles in our CSVs to field names of the corresponding interfaces. Simplify this by renaming the columns to match the fields they are written to.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
src/data/csvtojson.tsis a script used to convert CSV tables of gradesto JSON files used by sandbag at run time. The script is not tested in
CI, so it is not obvious if it is broken or if someone forgot to run it
while changing grade tables.
Add tests of this script.
Also check that it does not change the correspondning JSON files during
testing.
Fixes: #120
In addition, refactor
csvtojson.tsto make tests straightforward and improve future maintainability bycsvtojson.tsso they can be testedsandbag/src/scales/index.ts
Lines 16 to 43 in 9c33cab