Convenience class for rule sets which may have a parent, but no bases.
Convenience trait to mix into subclasses of RuleSet for rule sets which only have one parent.
This trait abstracts over the various ways how the laws of a type class can depend on the laws of other type classes.
This trait abstracts over the various ways how the laws of a type class can depend on the laws of other type classes. An instance of this trait is called a rule set.
For that matter, we divide type classes into kinds, where the classes
of one kind share the number of operations and meaning. For example,
Semigroup
, Monoid
and Group
all belong to the same kind. On the
other hand, their additive variants also belong to a common kind, but to
a different one.
Users of this trait should extend the outer trait Laws and create specialized subtypes for each kind of type class. (See DefaultRuleSet for an example.)
Consider this example hierarchy:
Semigroup | \ Monoid AdditiveSemigroup | \ | Group AdditiveMonoid \ | AdditiveGroupThey all define their own laws, as well as a couple of parent classes. If we want to check the laws of
AdditiveGroup
, we want to avoid checking
properties twice, i.e. do not want to check Monoid
laws via Group
and
also via AdditiveMonoid
.To address this problem, we define the parent in the same kind as
parent, and other parents as bases. In this example, the parent of
AdditiveGroup
is AdditiveMonoid
, and its only basis is Group
. On the other
hand, the parent of Group
is Monoid
, and it does not have any bases.
The set of all properties of a certain class is now defined as union of these sets:
Looking at our example, that means that AdditiveGroup
includes the
Monoid
law only once, because it is the parent of its basis. The
same laws are ignored by its parent AdditiveMonoid
, hence no redundant
checks occur.
Of course, classes can have multiple parents and multiple (named) bases. The only requirement here is that inside one kind, the identifier of a property is unique, since duplicates are eliminated. To avoid name clashes between different kinds, the names of properties pulled in via a basis are prefixed with the name of the basis.
For better type-safety, parents are only allowed to come from the same outer instance of Laws, whereas bases are allowed to come from anywhere.
Convenience class for rule sets without parents and bases.
Empty rule set.
Root trait of the law cake.
Defines a wrapper around scalacheck's
Properties
(RuleSet), and some default implementations.Extend this trait if you want to define a set of laws.