Add string-info wrapper for info messages #27
Conversation
Allows check infos to print like messages instead of quoted strings.
|
Pinging @rmculpepper for review, on recommendation of @stamourv |
There was a problem hiding this comment.
Two thoughts about this:
1
Could you implement what you want outside of rackunit by:
- making a value like
(check-info (foo "hello")) - where
foois a struct that implementsgen:custom-write - and displays
helloin write-mode
How awkward would that be for your use-case?
2
IMO, I think it'd be better to expose a flag or parameter than add the string-info struct
|
|
||
| A check-info structure stores information associated | ||
| with the context of execution of a check.} | ||
| A check-info structure stores information associated with the context of |
There was a problem hiding this comment.
should say "the context of the" ?
|
That could work fine for this use case, but I don't think it would work as a solution to #10 and I was hoping to add a very similar feature like I'm not yet sure if that's necessary for the extension library I'm making, but it definitely isn't possible to do with |
|
Ok that makes more sense (Does scribble have a text back-end we could re-use?) |
|
Do you mean some sort of Scribble subsystem for handling how Rackunit prints check info? I don't know much about Scribble's internals but it sounds unlikely. |
|
I mean, a Scribble renderer that will convert |
|
There might be something like that in Scribble, but I wouldn't want to hold up this PR on figuring that out. |
|
I think this should be merged. |
|
Alas I don't have merge powers |
This adds a private `location-info` struct alongside `string-info` from #27 to encapsulate rendering a source location with a relative directory path. This obsoletes the logic in both `rackunit/private/format` and `rackunit/text-ui` for handling a check info with key `'location` specially. This is not technically backwards compatible as it changes the observable behavior of `make-check-location`, but it does so in a way that's highly unlikely to affect existing users. See below for details. * Remove unnecessary check-name? clause of run-tests The `else` branch at the end of `check-name?` handles this already. * Change check-info to use struct instead of define-struct The latter is deprecated. Existing behavior is preserved with #:constructor-name. * Allow define-check-type to wrap info values Needed for a future commit that adds a location-info struct. * Add an internal location-info struct This reproduces the behavior that `run-tests` and the default check handler provide for the `location` info. It changes `check-location` to automatically wrap the location value in the struct so `define-check` doesn’t need to change. This breaks clients that construct a check info with `check-location` and immediately extract the info value field expecting it to be a `location/c`, but I don’t think anyone does that. Future work could expose this to rack unit users, but it should probably be done in terms of the `srcloc` structure instead. * Bump version number * Remove text-ui-util-test This is now an internal implementation detail of rackunit/private/check-info. Future work might test `location-info` and `info-value->string` more thoroughly. * Fix test-test w.r.t. location-info Also trims some whitespace (auto formatted by Atom) * Fix bug in prop:exn:srclocs * Re-add tests for trim-current-directory in check-info tests * Simplify default info-value printing logic
Closes #26
With this change, it’s now possible for a check info value to print a message without quotes by wrapping the value string in a call to
string-info. See the example added to the docs.