CenterForOpenScience / SHARE / 12472219314

84%

Build Type

push

github

Committed by web-flow

Commit Message

[ENG-6284] render tsv/csv (#834)

allow rendering search responses as lines of tab-separated or comma-separated values

main point:

- add simple_tsv and simple_csv renderers in trove.render
- - can be seen with query param acceptMediatype=text/tab-separated-values or acceptMediatype=text/csv
- - get default columns from static DEFAULT_TABULAR_SEARCH_COLUMN_PATHS in trove.vocab.osfmap
- allow "download" responses -- add withFileName=foo query param to get a response with Content-Disposition: attachment and a filename based on "foo"
- allow absurd page sizes

changes made along the way:

- introduce ProtoRendering as renderer output type, to better decouple rendering from view logic
- - include StreamableRendering for responses that might could be streamed, like csv/tsv (tho it's not currently handled any differently from SimpleRendering)
- - reshape BaseRenderer (and each existing renderer) to have a consistent call signature (and return ProtoRendering)
- - - replace trove.render.get_renderer with trove.render.get_renderer_type -- instantiate the renderer with response data
- add trove.views._responder with common logic for building a django HttpResponse for a ProtoRendering
- - consistently handles withFileName/Content-Disposition
- move some osf-specific constants to trove.vocab.osfmap for easier reuse
- pull out some abstractable logic:
- - from existing trove.render.simple_json into trove.render._simple_trovesearch (for renderers that include only the list of search results)
- - from existing tests.trove.derive._base into tests.trove._input_output_tests (for tests following the same simple input/output pattern as deriver and renderer tests)
- add tests.trove.render to cover the new renderers simple_tsv and simple_csv, as well as the existing renderers jsonapi, simple_json, jsonld, and turtle
- - minimally update existing renderers to create consistent output

Run Details

1205 of 1310 new or added lines in 42 files covered. (91.98%)

22 existing lines in 4 files now uncovered.

26582 of 28944 relevant lines covered (91.84%)

1.84 hits per line