Bibliography API and listing functionality #320
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
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #320 +/- ##
==========================================
- Coverage 60.29% 59.53% -0.76%
==========================================
Files 29 29
Lines 4181 4298 +117
Branches 491 497 +6
==========================================
+ Hits 2521 2559 +38
- Misses 1169 1242 +73
- Partials 491 497 +6 ☔ View full report in Codecov by Sentry. |
|
I bumped the version to 1.5.9.0, so I expect this to be merged in after #318. |
nevrome
reviewed
Dec 20, 2024
There was a problem hiding this comment.
The code looks great and trident list --bibliography behaves as expected. I think, though, that the default table output is too wide. Maybe some columns can be omitted here (Journal? Author?).
I'll later test the server-client interaction with this new API feature.
| @@ -1,5 +1,5 @@ | |||
| name: poseidon-hs | |||
| version: 1.5.7.4 | |||
| version: 1.5.9.0 | |||
There was a problem hiding this comment.
Probably 1.6.1.0 as things stand right now on the master branch.
| "Bibliography field " ++ bibFieldKey ++ "is not present in any bibliography entry" | ||
| _ -> return () | ||
|
|
||
| let tableH = ["BibKey", "Title", "Author", "Year", "Journal", "Doi", |
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.
This PR finally adds a new Server API
/bibliographyas well as a new command-line optiontrident list --bibliographyto gather bibliography information.The feature is straight-forward in terms of usability.
In terms of implementation, I have made some additional changes to the Aeson interface specifically for the Server Communication. Specifically I looked a bit closer how Aeson encodes for
Nothings inMaybetypes, and found out that by default these get encoded asnullin objects. This is slightly wasteful, as null-fields can also simply be omitted in a given object. When decoding into Haskell types again, we anyway use the operator.:?, which takes care of interpreting missing keys in objects asNothings. I have therefore added a small function calledremoveNullsinServerClient.hsto remove null-fields from objects. Not sure how big the effect is, but it was simple enough and I'm glad I now understandMaybe-encoding in Aeson better. The newest version of Aeson (>2.2.2.0) actually adds an encoding operator to remove null-values, which will eventually make my function redundant, but that latest version isn't even in the latest LTS, so it'll be some time.Running the new bibliography function on the Community-Archive reveals some gaps in our bibliography records, which we can easily fix with a bit of curation work.