clarify law testing's dependency on cats-testkit and scalatest #2245
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
tpolecat
reviewed
May 4, 2018
| @@ -7,23 +7,25 @@ section: "typeclasses" | |||
| # Law testing | |||
|
|
|||
| [Laws](https://typelevel.org/cats/typeclasses.html#laws) are an important part of cats. | |||
| Cats uses `catalysts` and `discipline` to help test instances with laws. | |||
| To make things easier, cats ships with `cats-testkit`, which makes use of `catalysts` and `discipline` and exposes `CatsSuite` based on ScalaTest. | |||
| Cats uses `catalysts` and [discipline](https://github.com/typelevel/discipline) to help test instances with laws. To test type class | |||
There was a problem hiding this comment.
Why is catalysts relevant here?
| Then we can begin to write our law tests. Start by creating a new class in your `test` folder and inheriting from `cats.tests.CatsSuite`. | ||
| `CatsSuite` extends the standard ScalaTest `FunSuite` as well as `Matchers`. | ||
| Then we can begin to write our law tests. If you are using `ScalaTest` you can inherit from `cats.tests.CatsSuite` | ||
| from `cats-testkit`. `CatsSuite` extends the standard ScalaTest `FunSuite` as well as `Matchers`. |
There was a problem hiding this comment.
What do you do if you're not using ScalaTest? Not sure this helps.
Codecov Report
@@ Coverage Diff @@
## master #2245 +/- ##
==========================================
+ Coverage 94.95% 94.96% +0.01%
==========================================
Files 333 333
Lines 5787 5799 +12
Branches 222 217 -5
==========================================
+ Hits 5495 5507 +12
Misses 292 292
Continue to review full report at Codecov.
|
|
@tpolecat how about now? |
tpolecat
previously approved these changes
May 7, 2018
LukaJCB
reviewed
May 8, 2018
| the [ScalaCheck](https://github.com/rickynils/scalacheck) tests based on them. | ||
|
|
||
| To test type class laws from Cats against your instances, you need to add a `cats-laws` dependency. | ||
| If you are using `ScalaTests`, Cats also ships with optional `cats-testkit`, which provites a convenient |
|
made some tut compilation corrections. need a quick re-review. |
rossabaker
reviewed
May 9, 2018
| ```tut:book | ||
| implicit def eqTree[A: Eq]: Eq[Tree[A]] = Eq.fromUniversalEquals | ||
| ```tut:invisible | ||
| import Tree._ //there is no real companion object is in REPL |
rossabaker
approved these changes
May 9, 2018
LukaJCB
approved these changes
May 10, 2018
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.
No description provided.