Add OpenCourseWare metadata preprocessing for 'subjects' field #155
Conversation
This file contains hidden or 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
Pull Request Test Coverage Report for Build 13552141628Details
💛 - Coveralls |
jonavellecuerdo
force-pushed
the
IN-1186-simplecsv-fix-item-identifiers
branch
from
dc19443 to
e0e138e
Compare
Base automatically changed from
IN-1186-simplecsv-fix-item-identifiers
to
main
February 25, 2025 18:48
Why these changes are being introduced:
* For OCW source metadata JSON files ('data.json', the 'topics' property
is structured as an array of arrays containing string values. For each
array of strings, the topic terms need to be concatenated to match the
expected format set by stakeholders: "<topic term> - ... - <topic term n>".
Additionally, an update to Workflow.create_dspace_metadata was implemented
to allow handling of list field values.
How this addresses that need:
* Update Workflow.create_dspace_metadata to check for and handle
list field values
* Refactor '_get_instructors_delimited_string' to return list
of formatted instructor names (instead of delimited string)
* Add '_get_topics_list' method to return list of formatted topics
* Update 123.zip fixture to include 'topics' property
* Add and update unit tests
Side effects of this change:
* None
Relevant ticket(s):
* https://mitlibraries.atlassian.net/browse/IN-1176
* https://mitlibraries.atlassian.net/browse/IN-1159
jonavellecuerdo
force-pushed
the
IN-1176-opencourseware-subjects-field
branch
from
0d0b909 to
0e97f92
Compare
ghukill
approved these changes
Feb 25, 2025
ghukill
left a comment
ghukill
left a comment
There was a problem hiding this comment.
Approved! Changes make sense to me.
Offered up a possible refactoring of the Workflow.create_dspace_metadata() now that the pathways are taking shape more, but purely optional; some conciseness but potentially at the expense of readability.
ghukill
approved these changes
Feb 26, 2025
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.
Purpose and background context
This PR updates the
OpenCourseWare(OCW) workflow to derived formatted values from thetopicsproperty included in the source metadata files (thedata.jsonfiles in OCW zip files) that get mapped todc.subjectelements in the generated DSpace metadata. Additionally, this PR includes an update to the baseWorkflow.create_dspace_metadatamethod to handlelistfield values.How can a reviewer manually see the effects of these changes?
Review of the updated unit tests should be sufficient.
Includes new or updated dependencies?
NO
Changes expectations for external applications?
NO
What are the relevant tickets?
Developer
Code Reviewer(s)