-
-
Notifications
You must be signed in to change notification settings - Fork 25
Add an Arbitrary[Random[F]] instance #364
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
bpholt
wants to merge
1
commit into
typelevel:main
Choose a base branch
from
Dwolla:random
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
39 changes: 39 additions & 0 deletions
39
cats-effect/shared/src/main/scala/cats/effect/std/ArbitraryRandom.scala
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| /* | ||
| * Copyright 2021 Typelevel | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package cats.effect.std | ||
|
|
||
| import cats.effect.* | ||
| import cats.effect.std.Random.ScalaRandom | ||
| import cats.syntax.all.* | ||
| import org.scalacheck.{Arbitrary, Gen, Shrink} | ||
|
|
||
| trait ArbitraryRandom { | ||
|
|
||
| /** Generates a `Random[F]` instance seeded by a generated long value, so that the "randomness" | ||
| * will be repeatable given the same ScalaCheck seed. | ||
| */ | ||
| def genRandom[F[_]: Sync]: Gen[Random[F]] = | ||
| Gen.long | ||
| .map(new scala.util.Random(_).pure[F]) | ||
| .map(new ScalaRandom[F](_) {}) | ||
|
|
||
| implicit def arbRandom[F[_]: Sync]: Arbitrary[Random[F]] = Arbitrary(genRandom[F]) | ||
|
|
||
| implicit def shrinkRandom[F[_]]: Shrink[Random[F]] = Shrink.shrinkAny | ||
| } | ||
|
|
||
| object ArbitraryRandom extends ArbitraryRandom | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To be honest, it looks a bit "hacky" to me:
ArbitraryRandomis placed intocats.effect.stdto let it access theScalaRandom's private constructor. Whereas the otherscalacheck-effectcode lives inorg.scalacheck.effect.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, that's true, but I did ask about this implementation in Discord and got an initial thumbs up from @djspiewak. (Although to be fair, I’m not sure he was thinking about it from this specific angle.) I suppose if Cats Effect could be persuaded to open up one of those constructors, we could move this somewhere else.
Really the problem is that the
Random.scalaUtilRandomSeedLongreturnsF[Random[F]]and not justRandom[F]. I don’t think that’s necessary for this particular case, but I’m not sure whether that’s true in general. If introducing a new constructor inRandomis a better option, then we could use that here instead.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In regards to constructors safety, there are a couple of classes in Cats-Effect that got "unsafe" constructor counterparts:
RefandDeferred. Both are in "kernel" though. However, I don't think that it would hurt much ifRandomcould get a couple ofunsafeconstructors too. At least to me it seems like a more viable solution comparing to tuning package names in order to access private constructors.For example,
Random.javaUtilRandom[F[_]](random: java.util.Random): F[Random[F]]is not fully referentially transparent, apparently. So, it wouldn't seem too bad if there wasunsafeJavaUtilRandom[F[_]](random: java.util.Random): Random[F]counterpart.