scalaprops / scalaprops-shapeless

Generation of arbitrary case classes / ADTs instances with scalaprops and shapeless

Version Matrix

scalaprops-shapeless

Generation of arbitrary case classes / ADTs instances with scalaprops and shapeless ported from alexarchambault/scalacheck-shapeless.

Maven Central scaladoc Scala.js

Usage

Add to your build.sbt

libraryDependencies += "com.github.scalaprops" %% "scalaprops-shapeless" % "0.4.4"

scalaprops-shapeless depends on shapeless 2.3.

Import the content of scalaprops.ScalapropsShapeless close to where you want scalaprops.Gen type classes to be automatically available for case classes / sealed hierarchies,

import scalaprops.ScalapropsShapeless._

//  If you defined:

// case class Foo(i: Int, s: String, blah: Boolean)
// case class Bar(foo: Foo, other: String)

// sealed trait Base
// case class BaseIntString(i: Int, s: String) extends Base
// case class BaseDoubleBoolean(d: Double, b: Boolean) extends Base

//  then you can now do

Gen[Foo]
Gen[Bar]
Gen[Base]

and in particular, while writing property-based tests,

val `some property about Foo` = Property.forAll {
  (foo: Foo) =>
    // Ensure foo has the required property
}

without having to define yourself a scalaprops.Gen for Foo.

Credits

scalaprops-shapeless ported from alexarchambault/scalacheck-shapeless

License

Released under the Apache 2 license. See LICENSE file for more details.