Trait

bricks.laws

LawChecks

Related Doc: package laws

Permalink

trait LawChecks extends Discipline

Trait that facilitates law checks

LawChecks adds some helper methods to Discipline's extension of FunSuiteLike.

Self Type
LawChecks with FunSuiteLike
See also

Original issue in Algebra, Original implementation in Algebra

Linear Supertypes
Discipline, Checkers, Configuration, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. LawChecks
  2. Discipline
  3. Checkers
  4. Configuration
  5. AnyRef
  6. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Type Members

  1. case class LawChecker[L <: Laws](name: String, laws: L) extends Product with Serializable

    Permalink

    Check the laws using name as the base name for the tests.

  2. case class MaxDiscardedFactor extends PropertyCheckConfigParam with Product with Serializable

    Permalink
    Definition Classes
    Configuration
  3. case class MinSize extends PropertyCheckConfigParam with Product with Serializable

    Permalink
    Definition Classes
    Configuration
  4. case class MinSuccessful extends PropertyCheckConfigParam with Product with Serializable

    Permalink
    Definition Classes
    Configuration
  5. sealed abstract class PropertyCheckConfigParam extends AnyRef

    Permalink
    Definition Classes
    Configuration
  6. case class PropertyCheckConfiguration extends PropertyCheckConfigurable with Product with Serializable

    Permalink
    Definition Classes
    Configuration
  7. case class SizeRange extends PropertyCheckConfigParam with Product with Serializable

    Permalink
    Definition Classes
    Configuration
  8. case class Workers extends PropertyCheckConfigParam with Product with Serializable

    Permalink
    Definition Classes
    Configuration
  9. case class MaxDiscarded extends PropertyCheckConfigParam with Product with Serializable

    Permalink
    Definition Classes
    Configuration
    Annotations
    @deprecated
    Deprecated
  10. case class MaxSize extends PropertyCheckConfigParam with Product with Serializable

    Permalink
    Definition Classes
    Configuration
    Annotations
    @deprecated
    Deprecated

    use SizeRange instead

  11. case class PropertyCheckConfig extends PropertyCheckConfigurable with Product with Serializable

    Permalink
    Definition Classes
    Configuration
    Annotations
    @deprecated
    Deprecated

    Use PropertyCheckConfiguration instead

  12. trait PropertyCheckConfigurable extends AnyRef

    Permalink
    Definition Classes
    Configuration
    Annotations
    @deprecated
    Deprecated

    Use PropertyCheckConfiguration directly instead.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. implicit def PropertyCheckConfig2PropertyCheckConfiguration(p: (LawChecks.this)#PropertyCheckConfig): (LawChecks.this)#PropertyCheckConfiguration

    Permalink
    Definition Classes
    Configuration
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def check(p: Prop, configParams: (LawChecks.this)#PropertyCheckConfigParam*)(implicit config: (LawChecks.this)#PropertyCheckConfigurable): Unit

    Permalink
    Definition Classes
    Checkers
  7. def check(p: Prop, prms: Parameters): Unit

    Permalink
    Definition Classes
    Checkers
  8. def check[A1, A2, A3, A4, A5, A6, P](f: (A1, A2, A3, A4, A5, A6) ⇒ P, configParams: (LawChecks.this)#PropertyCheckConfigParam*)(implicit config: (LawChecks.this)#PropertyCheckConfigurable, p: (P) ⇒ Prop, a1: Arbitrary[A1], s1: Shrink[A1], pp1: (A1) ⇒ Pretty, a2: Arbitrary[A2], s2: Shrink[A2], pp2: (A2) ⇒ Pretty, a3: Arbitrary[A3], s3: Shrink[A3], pp3: (A3) ⇒ Pretty, a4: Arbitrary[A4], s4: Shrink[A4], pp4: (A4) ⇒ Pretty, a5: Arbitrary[A5], s5: Shrink[A5], pp5: (A5) ⇒ Pretty, a6: Arbitrary[A6], s6: Shrink[A6], pp6: (A6) ⇒ Pretty): Unit

    Permalink
    Definition Classes
    Checkers
  9. def check[A1, A2, A3, A4, A5, P](f: (A1, A2, A3, A4, A5) ⇒ P, configParams: (LawChecks.this)#PropertyCheckConfigParam*)(implicit config: (LawChecks.this)#PropertyCheckConfigurable, p: (P) ⇒ Prop, a1: Arbitrary[A1], s1: Shrink[A1], pp1: (A1) ⇒ Pretty, a2: Arbitrary[A2], s2: Shrink[A2], pp2: (A2) ⇒ Pretty, a3: Arbitrary[A3], s3: Shrink[A3], pp3: (A3) ⇒ Pretty, a4: Arbitrary[A4], s4: Shrink[A4], pp4: (A4) ⇒ Pretty, a5: Arbitrary[A5], s5: Shrink[A5], pp5: (A5) ⇒ Pretty): Unit

    Permalink
    Definition Classes
    Checkers
  10. def check[A1, A2, A3, A4, P](f: (A1, A2, A3, A4) ⇒ P, configParams: (LawChecks.this)#PropertyCheckConfigParam*)(implicit config: (LawChecks.this)#PropertyCheckConfigurable, p: (P) ⇒ Prop, a1: Arbitrary[A1], s1: Shrink[A1], pp1: (A1) ⇒ Pretty, a2: Arbitrary[A2], s2: Shrink[A2], pp2: (A2) ⇒ Pretty, a3: Arbitrary[A3], s3: Shrink[A3], pp3: (A3) ⇒ Pretty, a4: Arbitrary[A4], s4: Shrink[A4], pp4: (A4) ⇒ Pretty): Unit

    Permalink
    Definition Classes
    Checkers
  11. def check[A1, A2, A3, P](f: (A1, A2, A3) ⇒ P, configParams: (LawChecks.this)#PropertyCheckConfigParam*)(implicit config: (LawChecks.this)#PropertyCheckConfigurable, p: (P) ⇒ Prop, a1: Arbitrary[A1], s1: Shrink[A1], pp1: (A1) ⇒ Pretty, a2: Arbitrary[A2], s2: Shrink[A2], pp2: (A2) ⇒ Pretty, a3: Arbitrary[A3], s3: Shrink[A3], pp3: (A3) ⇒ Pretty): Unit

    Permalink
    Definition Classes
    Checkers
  12. def check[A1, A2, P](f: (A1, A2) ⇒ P, configParams: (LawChecks.this)#PropertyCheckConfigParam*)(implicit config: (LawChecks.this)#PropertyCheckConfigurable, p: (P) ⇒ Prop, a1: Arbitrary[A1], s1: Shrink[A1], pp1: (A1) ⇒ Pretty, a2: Arbitrary[A2], s2: Shrink[A2], pp2: (A2) ⇒ Pretty): Unit

    Permalink
    Definition Classes
    Checkers
  13. def check[A1, P](f: (A1) ⇒ P, configParams: (LawChecks.this)#PropertyCheckConfigParam*)(implicit config: (LawChecks.this)#PropertyCheckConfigurable, p: (P) ⇒ Prop, a1: Arbitrary[A1], s1: Shrink[A1], pp1: (A1) ⇒ Pretty): Unit

    Permalink
    Definition Classes
    Checkers
  14. def checkAll(name: String, ruleSet: RuleSet): Unit

    Permalink
    Definition Classes
    Discipline
  15. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  16. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  18. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. implicit val generatorDrivenConfig: (LawChecks.this)#PropertyCheckConfiguration

    Permalink
    Definition Classes
    Configuration
  20. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  21. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  23. def laws[L[_] <: Laws, A](implicit laws: L[A], tag: TypeTagM[A]): (LawChecks.this)#LawChecker[L[A]]

    Permalink

    Check the laws for some type A, using the full name of A as the base name for the tests.

    Check the laws for some type A, using the full name of A as the base name for the tests.

    implicit def orderLaws[A: Eq: Arbitrary] = OrderLaws[A]
    implicit def groupLaws[A: Eq: Arbitrary] = GroupLaws[A]
    
    laws[OrderLaws, String].check(_.order)
    laws[GroupLaws, String].check(_.monoid)
    L

    the type of laws

    A

    the type to run the laws on

    laws

    the laws to use

    tag

    the tag associated with type to test

    returns

    the LawChecker to check the law

  24. def maxDiscardedFactor(value: PosZDouble): (LawChecks.this)#MaxDiscardedFactor

    Permalink
    Definition Classes
    Configuration
  25. def minSize(value: PosZInt): (LawChecks.this)#MinSize

    Permalink
    Definition Classes
    Configuration
  26. def minSuccessful(value: PosInt): (LawChecks.this)#MinSuccessful

    Permalink
    Definition Classes
    Configuration
  27. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  28. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  29. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  30. def sizeRange(value: PosZInt): (LawChecks.this)#SizeRange

    Permalink
    Definition Classes
    Configuration
  31. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  32. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  33. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. def workers(value: PosInt): (LawChecks.this)#Workers

    Permalink
    Definition Classes
    Configuration

Deprecated Value Members

  1. def maxDiscarded(value: Int): (LawChecks.this)#MaxDiscarded

    Permalink
    Definition Classes
    Configuration
    Annotations
    @deprecated
    Deprecated

    use maxDiscardedFactor instead

  2. def maxSize(value: Int): (LawChecks.this)#MaxSize

    Permalink
    Definition Classes
    Configuration
    Annotations
    @deprecated
    Deprecated

    use SizeRange instead

Inherited from Discipline

Inherited from Checkers

Inherited from Configuration

Inherited from AnyRef

Inherited from Any

Ungrouped