Refactor IOMatchers to add Generic #707
Merged
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
We split the IOMatchers trait to make it independent from IO. - We extract a generic `RuntimedMatchers` trait, which is generic on the effect type `F[_]`, and has most methods from `IOMatchers`. - The generic `RuntimedMatchers` defines two methods, that act as placeholders for `IO.timeout` and `IO.unsafeRunSync`. - To the `RunTimedMatchers` trait, we add an inner `TimedMatcher` class, that has most of the logic from the `IOMatcher` class. This class has methods, akin to `checkIOWithDuration` and `checkIO`, but with different names. Having moved most of the logic to `RuntimedMatchers`, the `IOMatcher` becomes just a specific instance of `RunTimedMatchers[IO]`, and the two methods just call the IO methods. - We keep an `IOMatcher` inner class inside `IOMatchers`, for compatibility. This class keeps the two `check` methods above.
|
This makes sense, thanks. |
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.
Description of changes
We split the IOMatchers trait to make it independent from IO.
RuntimedMatcherstrait, which is generic on the effect typeF[_], and has most methods fromIOMatchers.RuntimedMatchersdefines two methods, that act as placeholders forIO.timeoutandIO.unsafeRunSync.RunTimedMatcherstrait, we add an innerTimedMatcherclass, that has most of the logic from theIOMatcherclass. This class has methods, akin tocheckIOWithDurationandcheckIO, but with different names.Having moved most of the logic to
RuntimedMatchers, theIOMatcherbecomes just a specific instance ofRunTimedMatchers[IO], and the two methods just call the IO methods.IOMatcherinner class insideIOMatchers, for compatibility. This class keeps the twocheckIOWithDurationandcheckIOmethods above.Related tickets
http4s, which contains a copy ofIOMatchers.cats.effect.IOwas made and discussed in this issue. Nevertheless, since no appropriate type-class at present, declaring abstract methods inRuntimedMatchersis the next best.