feat: Upgrades for codemeta v3 support #24
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
progval
reviewed
Oct 13, 2023
Comment on lines
+35
to
+61
| const directCodemetaFieldsV2 = { | ||
| 'codeRepository': '#codeRepository', | ||
| 'contIntegration': '#contIntegration', | ||
| 'dateCreated': '#dateCreated', | ||
| 'datePublished': '#datePublished', | ||
| 'dateModified': '#dateModified', | ||
| 'downloadUrl': '#downloadUrl', | ||
| 'issueTracker': '#issueTracker', | ||
| 'name': '#name', | ||
| 'version': '#version', | ||
| 'identifier': '#identifier', | ||
| 'description': '#description', | ||
| 'applicationCategory': '#applicationCategory', | ||
| 'releaseNotes': '#releaseNotes', | ||
| 'funding': '#funding', | ||
| 'developmentStatus': '#funding', | ||
| 'isPartOf': '#isPartOf', | ||
| 'referencePublication': '#referencePublication' | ||
| }; | ||
|
|
||
| const directCodemetaFieldsV3 = { | ||
| ...directCodemetaFieldsV2, | ||
| // 'hasSourceCode': '#hasSourceCode', -> Generator is for SoftwareSource code not SoftwareApplication | ||
| 'isSourceCodeOf': '#isSourceCodeOf', | ||
| 'continuousIntegration': '#contIntegration', | ||
| // 'embargoEndDate': '#embargoDate' -> Not in use for v2. Not required for v3 either. | ||
| }; |
There was a problem hiding this comment.
I think we can do better than this, by generating fields unconditionally so produced documents will work regardless of Codemeta version the reader's expects. See #25
Comment on lines
+245
to
+247
| if (doc['@type'] === 'Role') { | ||
| return; | ||
| } |
| for (const doc of docs) { | ||
| if (doc['@type'] === 'Role') { | ||
| let authorId = doc['author']['@id']; | ||
| authorId = isBlankNodeId(authorId) ? authorId.substring(2) : authorId; |
There was a problem hiding this comment.
As far as I can tell, there is nothing preventing a document to have both https://example.org/ as IRI and _:https://example.org/ as blank node identifier. Stripping _: would make them collide. Why do you need to strip the prefix?
Comment on lines
+126
to
+127
| for (let role of roles.split(",")) { | ||
| const [roleName, startDate, endDate] = role.split(":"); |
There was a problem hiding this comment.
That's user input, you need to validate it
Comment on lines
31
to
+32
| function validateUrl(fieldName, doc) { | ||
| if (!isUrl(doc)) { | ||
| if (!isBlankNodeId(doc) && !isUrl(doc)) { |
There was a problem hiding this comment.
You probably need to turn this into two functions: one for @id (which may be blank node identifiers or URIs) and one for actual URLs.
Comment on lines
+136
to
+137
| "SoftwareSourceCode": softwareFieldValidatorsV2, | ||
| "SoftwareApplication": softwareFieldValidatorsV2, |
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.
Upgrades for codemeta v3 support
Related to #23