aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJon Pretty <jon.pretty@propensive.com>2017-11-08 11:17:53 +0000
committerJon Pretty <jon.pretty@propensive.com>2017-11-08 11:17:53 +0000
commit3f23cb5bca4ea8be889b714008a85141fe5e213c (patch)
tree8ba57fbf39c8f1892fc6b7adaf7810665e86de6c
parent1207383551b429560ac05e124349b24ff8b6dfda (diff)
downloadmagnolia-3f23cb5bca4ea8be889b714008a85141fe5e213c.tar.gz
magnolia-3f23cb5bca4ea8be889b714008a85141fe5e213c.tar.bz2
magnolia-3f23cb5bca4ea8be889b714008a85141fe5e213c.zip
Added better scaladocs and provide default values
-rw-r--r--core/src/main/scala/interface.scala149
-rw-r--r--core/src/main/scala/magnolia.scala179
-rw-r--r--examples/src/main/scala/decode.scala7
-rw-r--r--examples/src/main/scala/default.scala8
-rw-r--r--examples/src/main/scala/eq.scala6
-rw-r--r--examples/src/main/scala/show.scala6
-rw-r--r--tests/src/main/scala/tests.scala30
7 files changed, 291 insertions, 94 deletions
diff --git a/core/src/main/scala/interface.scala b/core/src/main/scala/interface.scala
new file mode 100644
index 0000000..ed5fa37
--- /dev/null
+++ b/core/src/main/scala/interface.scala
@@ -0,0 +1,149 @@
+package magnolia
+
+import language.higherKinds
+
+/** represents a subtype of a sealed trait
+ *
+ * @tparam Typeclass type constructor for the typeclass being derived
+ * @tparam Type generic type of this parameter */
+trait Subtype[Typeclass[_], Type] {
+
+ /** the type of subtype */
+ type SType <: Type
+
+ /** the name of the subtype
+ *
+ * This is the fully-qualified name of the type of subclass. */
+ def label: String
+
+ /** the typeclass instance associated with this subtype
+ *
+ * This is the instance of the type `Typeclass[SType]` which will have been discovered by
+ * implicit search, or derived by Magnolia. */
+ def typeclass: Typeclass[SType]
+
+ /** partial function defined the subset of values of `Type` which have the type of this subtype */
+ def cast: PartialFunction[Type, SType]
+}
+
+/** represents a parameter of a case class
+ *
+ * @tparam Typeclass type constructor for the typeclass being derived
+ * @tparam Type generic type of this parameter */
+trait Param[Typeclass[_], Type] {
+
+ /** the type of the parameter being represented
+ *
+ * For exmaple, for a case class,
+ * <pre>
+ * case class Person(name: String, age: Int)
+ * </pre>
+ * the [[Param]] instance corresponding to the `age` parameter would have a [[PType]] equal to
+ * the type [[Int]]. However, in practice, this type will never be universally quantified. */
+ type PType
+
+ /** the name of the parameter */
+ def label: String
+
+ /** the typeclass instance associated with this parameter
+ *
+ * This is the instance of the type `Typeclass[PType]` which will have been discovered by
+ * implicit search, or derived by Magnolia.
+ *
+ * Its type is existentially quantified on this [[Param]] instance, and depending on the
+ * nature of the particular typeclass, it may either accept or produce types which are also
+ * existentially quantified on this same [[Param]] instance. */
+ def typeclass: Typeclass[PType]
+
+ /** provides the default value for this parameter, as defined in the case class constructor */
+ def default: Option[PType]
+
+ /** dereferences a value of the case class type, `Type`, to access the value of the parameter
+ * being represented
+ *
+ * When programming generically, against an unknown case class, with unknown parameter names
+ * and types, it is not possible to directly access the parameter values without reflection,
+ * which is undesirable. This method, whose implementation is provided by the Magnolia macro,
+ * will dereference a case class instance to access the parameter corresponding to this
+ * [[Param]].
+ *
+ * Whilst the type of the resultant parameter value cannot be universally known at the use, its
+ * type will be existentially quantified on this [[Param]] instance, and the return type of the
+ * corresponding `typeclass` method will be existentially quantified on the same value. This is
+ * sufficient for the compiler to determine that the two values are compatible, and the value may
+ * be applied to the typeclass (in whatever way that particular typeclass provides).
+ *
+ * @param param the instance of the case class to be dereferenced
+ * @return the parameter value */
+ def dereference(param: Type): PType
+}
+
+/** represents a case class or case object and the context required to construct a new typeclass
+ * instance corresponding to it
+ *
+ * Instances of [[CaseClass]] provide access to all of the parameters of the case class, the full
+ * name of the case class type, and a boolean to determine whether the type is a case class or case
+ * object.
+ *
+ * @param typeName the name of the case class
+ * @param isObject true only if this represents a case object rather than a case class
+ * @param parametersArray an array of [[Param]] values for this case class
+ * @tparam Typeclass type constructor for the typeclass being derived
+ * @tparam Type generic type of this parameter */
+abstract class CaseClass[Typeclass[_], Type] private[magnolia](
+ val typeName: String,
+ val isObject: Boolean,
+ parametersArray: Array[Param[Typeclass, Type]]) {
+
+ /** constructs a new instance of the case class type
+ *
+ * This method will be implemented by the Magnolia macro to make it possible to construct
+ * instances of case classes generically in user code, that is, without knowing their type
+ * concretely.
+ *
+ * To construct a new case class instance, the method takes a lambda which defines how each
+ * parameter in the new case class should be constructed. See the [[Param]] class for more
+ * information on constructing parameter values from a [[Param]] instance.
+ *
+ * @param makeParam lambda for converting a generic [[Param]] into the value to be used for
+ * this parameter in the construction of a new instance of the case class
+ * @return a new instance of the case class */
+ def construct[Return](makeParam: Param[Typeclass, Type] => Return): Type
+
+ /** a sequence of [[Param]] objects representing all of the parameters in the case class
+ *
+ * For efficiency, this sequence is implemented by an `Array`, but upcast to a [[Seq]] to hide
+ * the mutable collection API. */
+ def parameters: Seq[Param[Typeclass, Type]] = parametersArray
+}
+
+/** represents a sealed trait and the context required to construct a new typeclass instance
+ * corresponding to it
+ *
+ * Instances of `SealedTrait` provide access to all of the component subtypes of the sealed trait
+ * which form a coproduct, and to the fully-qualified name of the sealed trait.
+ *
+ * @param typeName the name of the sealed trait
+ * @param subtypesArray an array of [[Subtype]] instances for each subtype in the sealed trait
+ * @tparam Typeclass type constructor for the typeclass being derived
+ * @tparam Type generic type of this parameter */
+final class SealedTrait[Typeclass[_], Type](val typeName: String,
+ subtypesArray: Array[Subtype[Typeclass, Type]]) {
+
+ /** a sequence of all the subtypes of this sealed trait */
+ def subtypes: Seq[Subtype[Typeclass, Type]] = subtypesArray
+
+ /** convenience method for delegating typeclass application to the typeclass corresponding to the
+ * subtype of the sealed trait which matches the type of the `value`
+ *
+ * @tparam Return the return type of the lambda, which should be inferred
+ * @param value the instance of the generic type whose value should be used to match on a
+ * particular subtype of the sealed trait
+ * @param handle lambda for applying the value to the typeclass for the particular subtype which
+ * matches
+ * @return the result of applying the `handle` lambda to subtype of the sealed trait which
+ * matches the parameter `value` */
+ def dispatch[Return](value: Type)(handle: Subtype[Typeclass, Type] => Return): Return =
+ subtypes.map { sub => sub.cast.andThen { v => handle(sub) } }.reduce(_ orElse _)(value)
+}
+
diff --git a/core/src/main/scala/magnolia.scala b/core/src/main/scala/magnolia.scala
index 1ad919f..a2c164e 100644
--- a/core/src/main/scala/magnolia.scala
+++ b/core/src/main/scala/magnolia.scala
@@ -4,68 +4,65 @@ import scala.reflect._, macros._
import scala.collection.immutable.ListMap
import language.existentials
import language.higherKinds
-import language.experimental.macros
-
-trait Subtype[Tc[_], T] {
- type S <: T
- def label: String
- def typeclass: Tc[S]
- def cast: PartialFunction[T, S]
-}
-
-object Subtype {
- def apply[Tc[_], T, S1 <: T](name: String, tc: => Tc[S1], isType: T => Boolean, asType: T => S1) = new Subtype[Tc, T] {
- type S = S1
- def label: String = name
- def typeclass: Tc[S] = tc
- def cast: PartialFunction[T, S] = new PartialFunction[T, S] {
- def isDefinedAt(t: T) = isType(t)
- def apply(t: T): S = asType(t)
- }
- }
-}
-
-object Param {
- def apply[Tc[_], T, S1](name: String, tc: Tc[S1], deref: T => S1) = new Param[Tc, T] {
- type S = S1
- def label = name
- def typeclass: Tc[S] = tc
- def dereference(t: T): S = deref(t)
- }
-}
-
-trait Param[Tc[_], T] {
- type S
- def label: String
- def typeclass: Tc[S]
- def dereference(param: T): S
-}
-
-object JoinContext {
- def apply[Tc[_], T](name: String, obj: Boolean, params: Array[Param[Tc, T]], constructor: (Param[Tc, T] => Any) => T) =
- new JoinContext[Tc, T](name, obj, params) {
- def construct(param: Param[Tc, T] => Any): T = constructor(param)
- }
-}
-
-abstract class JoinContext[Tc[_], T](val typeName: String, val isObject: Boolean, params: Array[Param[Tc, T]]) {
- def construct(param: ((Param[Tc, T]) => Any)): T
- def parameters: Seq[Param[Tc, T]] = params
-}
-
-class DispatchContext[Tc[_], T](val typeName: String, subs: Array[Subtype[Tc, T]]) {
- def subtypes: Seq[Subtype[Tc, T]] = subs
- def dispatch[R](value: T)(fn: Subtype[Tc, T] => R): R =
- subtypes.map { sub => sub.cast.andThen { v =>
- fn(sub)
- } }.reduce(_ orElse _)(value)
-
-}
+/** the object which defines the Magnolia macro */
object Magnolia {
import CompileTimeState._
- def generic[T: c.WeakTypeTag](c: whitebox.Context): c.Tree = {
+ /** derives a generic typeclass instance for the type `T`
+ *
+ * This is a macro definition method which should be bound to a method defined inside a Magnolia
+ * generic derivation object, that is, one which defines the methods `combine`, `dispatch` and
+ * the type constructor, `Typeclass[_]`. This will typically look like,
+ * <pre>
+ * object Derivation {
+ * // other definitions
+ * implicit def gen[T]: Typeclass[T] = Magnolia.gen[T]
+ * }
+ * </pre>
+ * which would support automatic derivation of typeclass instances by calling `Derivation.gen[T]`
+ * or with `implicitly[Typeclass[T]]`, if the implicit method is imported into the current scope.
+ *
+ * The definition expects a type constructor called `Typeclass`, taking one *-kinded type
+ * parameter to be defined on the same object as a means of determining how the typeclass should
+ * be genericized. While this may be obvious for typeclasses like `Show[T]` which take only a
+ * single type parameter, Magnolia can also derive typeclass instances for types such as
+ * `Decoder[Format, Type]` which would typically fix the `Format` parameter while varying the
+ * `Type` parameter.
+ *
+ * While there is no "interface" for a derivation, in the object-oriented sense, the Magnolia
+ * macro expects to be able to call certain methods on the object within which it is bound to a
+ * method.
+ *
+ * Specifically, for deriving case classes (product types), the macro will attempt to call the
+ * `combine` method with an instance of [[CaseClass]], like so,
+ * <pre>
+ * &lt;derivation&gt;.combine(&lt;caseClass&gt;): Typeclass[T]
+ * </pre>
+ * That is to say, the macro expects there to exist a method called `combine` on the derivation
+ * object, which may be called with the code above, and for it to return a type which conforms to
+ * the type `Typeclass[T]`. The implementation of `combine` will therefore typically look like
+ * this,
+ * <pre>
+ * def combine[T](caseClass: CaseClass[Typeclass, T]): Typeclass[T] = ...
+ * </pre>
+ * however, there is the flexibility to provide additional type parameters or additional implicit
+ * parameters to the definition, provided these do not affect its ability to be invoked as
+ * described above.
+ *
+ * Likewise, for deriving sealed traits (coproduct or sum types), the macro will attempt to call
+ * the `dispatch` method with an instance of [[SealedTrait]], like so,
+ * <pre>
+ * &lt;derivation&gt;.dispatch(&lt;sealedTrait&gt;): Typeclass[T]
+ * </pre>
+ * so a definition such as,
+ * <pre>
+ * def dispatch[T](sealedTrait: SealedTrait[Typeclass, T]): Typeclass[T] = ...
+ * </pre>
+ * will suffice, however the qualifications regarding additional type parameters and implicit
+ * parameters apply equally to `dispatch` as to `combine`.
+ * */
+ def gen[T: c.WeakTypeTag](c: whitebox.Context): c.Tree = {
import c.universe._
import scala.util.{Try, Success, Failure}
@@ -152,16 +149,18 @@ object Magnolia {
val result = if(isCaseObject) {
// FIXME: look for an alternative which isn't deprecated on Scala 2.12+
val obj = genericType.typeSymbol.companionSymbol.asTerm
- val className = obj.name.toString
+ val className = obj.fullName
val impl = q"""
- ${c.prefix}.join(_root_.magnolia.JoinContext[$typeConstructor, $genericType]($className, true, new _root_.scala.Array(0), _ => $obj))
+ ${c.prefix}.combine(_root_.magnolia.Magnolia.caseClass[$typeConstructor, $genericType](
+ $className, true, new _root_.scala.Array(0), _ => $obj)
+ )
"""
Some(Typeclass(genericType, impl))
} else if(isCaseClass) {
val caseClassParameters = genericType.decls.collect {
case m: MethodSymbol if m.isCaseAccessor => m.asMethod
}
- val className = genericType.toString
+ val className = genericType.typeSymbol.fullName
case class CaseParam(sym: c.universe.MethodSymbol, typeclass: c.Tree, paramType: c.Type, ref: c.TermName)
@@ -188,9 +187,15 @@ object Magnolia {
val preAssignments = caseParams.map(_.typeclass)
- val assignments = caseParams.zipWithIndex.map { case (CaseParam(param, typeclass, paramType, ref), idx) =>
- q"""$paramsVal($idx) = _root_.magnolia.Param[$typeConstructor, $genericType, $paramType](
- ${param.name.toString}, $ref, _.${TermName(param.name.toString)}
+ val caseClassCompanion = genericType.companion
+ val defaults = caseClassCompanion.decl(TermName("apply")).asMethod.paramLists.head.map(_.asTerm).zipWithIndex.map { case (p, idx) =>
+ if(p.isParamWithDefault) q"_root_.scala.Some(${genericType.typeSymbol.companionSymbol.asTerm}.${TermName("apply$default$"+(idx + 1))})"
+ else q"_root_.scala.None"
+ }
+
+ val assignments = caseParams.zip(defaults).zipWithIndex.map { case ((CaseParam(param, typeclass, paramType, ref), defaultVal), idx) =>
+ q"""$paramsVal($idx) = _root_.magnolia.Magnolia.param[$typeConstructor, $genericType, $paramType](
+ ${param.name.toString}, $ref, $defaultVal, _.${TermName(param.name.toString)}
)"""
}
@@ -201,7 +206,7 @@ object Magnolia {
new _root_.scala.Array(${assignments.length})
..$assignments
- ${c.prefix}.join(_root_.magnolia.JoinContext[$typeConstructor, $genericType](
+ ${c.prefix}.combine(_root_.magnolia.Magnolia.caseClass[$typeConstructor, $genericType](
$className,
false,
$paramsVal,
@@ -237,8 +242,8 @@ object Magnolia {
c.abort(c.enclosingPosition, s"failed to get implicit for type $searchType")
}
}.zipWithIndex.map { case ((typ, typeclass), idx) =>
- q"""$subtypesVal($idx) = _root_.magnolia.Subtype[$typeConstructor, $genericType, $typ](
- ${typ.typeSymbol.name.toString},
+ q"""$subtypesVal($idx) = _root_.magnolia.Magnolia.subtype[$typeConstructor, $genericType, $typ](
+ ${typ.typeSymbol.fullName},
$typeclass,
(t: $genericType) => t.isInstanceOf[$typ],
(t: $genericType) => t.asInstanceOf[$typ]
@@ -252,7 +257,10 @@ object Magnolia {
..$assignments
- ${c.prefix}.dispatch(new _root_.magnolia.DispatchContext($genericTypeName, $subtypesVal: _root_.scala.Array[_root_.magnolia.Subtype[$typeConstructor, $genericType]])): $resultType
+ ${c.prefix}.dispatch(new _root_.magnolia.SealedTrait(
+ $genericTypeName,
+ $subtypesVal: _root_.scala.Array[_root_.magnolia.Subtype[$typeConstructor, $genericType]])
+ ): $resultType
}""")
}
} else None
@@ -305,6 +313,41 @@ object Magnolia {
c.abort(c.enclosingPosition, s"magnolia: could not infer typeclass for type $genericType")
}
}
+
+ /** constructs a new [[Subtype]] instance
+ *
+ * This method is intended to be called only from code generated by the Magnolia macro, and
+ * should not be called directly from users' code. */
+ def subtype[Tc[_], T, S <: T](name: String, tc: => Tc[S], isType: T => Boolean, asType: T => S) = new Subtype[Tc, T] {
+ type SType = S
+ def label: String = name
+ def typeclass: Tc[SType] = tc
+ def cast: PartialFunction[T, SType] = new PartialFunction[T, S] {
+ def isDefinedAt(t: T) = isType(t)
+ def apply(t: T): SType = asType(t)
+ }
+ }
+
+ /** constructs a new [[Param]] instance
+ *
+ * This method is intended to be called only from code generated by the Magnolia macro, and
+ * should not be called directly from users' code. */
+ def param[Tc[_], T, P](name: String, typeclassParam: Tc[P], defaultVal: => Option[P], deref: T => P) = new Param[Tc, T] {
+ type PType = P
+ def label: String = name
+ def default: Option[PType] = defaultVal
+ def typeclass: Tc[PType] = typeclassParam
+ def dereference(t: T): PType = deref(t)
+ }
+
+ /** constructs a new [[CaseClass]] instance
+ *
+ * This method is intended to be called only from code generated by the Magnolia macro, and
+ * should not be called directly from users' code. */
+ def caseClass[Tc[_], T](name: String, obj: Boolean, params: Array[Param[Tc, T]], constructor: (Param[Tc, T] => Any) => T) =
+ new CaseClass[Tc, T](name, obj, params) {
+ def construct[R](param: Param[Tc, T] => R): T = constructor(param)
+ }
}
private[magnolia] case class DirectlyReentrantException() extends
diff --git a/examples/src/main/scala/decode.scala b/examples/src/main/scala/decode.scala
index 1cc8a12..a5d1d67 100644
--- a/examples/src/main/scala/decode.scala
+++ b/examples/src/main/scala/decode.scala
@@ -12,18 +12,18 @@ object Decoder {
implicit val string: Decoder[String] = new Decoder[String] { def decode(str: String): String = str }
implicit val int: Decoder[Int] = new Decoder[Int] { def decode(str: String): Int = str.toInt }
- implicit def generic[T]: Decoder[T] = macro Magnolia.generic[T]
+ implicit def gen[T]: Decoder[T] = macro Magnolia.gen[T]
type Typeclass[T] = Decoder[T]
- def join[T](ctx: JoinContext[Decoder, T]): Decoder[T] = new Decoder[T] {
+ def combine[T](ctx: CaseClass[Decoder, T]): Decoder[T] = new Decoder[T] {
def decode(value: String) = {
val (name, values) = parse(value)
ctx.construct { param => param.typeclass.decode(values(param.label)) }
}
}
- def dispatch[T](ctx: DispatchContext[Decoder, T]): Decoder[T] = new Decoder[T] {
+ def dispatch[T](ctx: SealedTrait[Decoder, T]): Decoder[T] = new Decoder[T] {
def decode(param: String) = {
val (name, values) = parse(param)
val subtype = ctx.subtypes.find(_.label == name).get
@@ -60,6 +60,5 @@ object Decoder {
(name, parts(value.substring(end + 1, value.length - 1)).map(keyValue).toMap)
}
-
}
diff --git a/examples/src/main/scala/default.scala b/examples/src/main/scala/default.scala
index 1f602f9..55b0753 100644
--- a/examples/src/main/scala/default.scala
+++ b/examples/src/main/scala/default.scala
@@ -10,15 +10,15 @@ trait Default[T] { def default: T }
object Default {
type Typeclass[T] = Default[T]
- def join[T](ctx: JoinContext[Default, T]): Default[T] = new Default[T] {
- def default = ctx.construct { param => param.typeclass.default }
+ def combine[T](ctx: CaseClass[Default, T]): Default[T] = new Default[T] {
+ def default = ctx.construct { param => param.default.getOrElse(param.typeclass.default) }
}
- def dispatch[T](ctx: DispatchContext[Default, T])(): Default[T] = new Default[T] {
+ def dispatch[T](ctx: SealedTrait[Default, T])(): Default[T] = new Default[T] {
def default: T = ctx.subtypes.head.typeclass.default
}
implicit val string: Default[String] = new Default[String] { def default = "" }
implicit val int: Default[Int] = new Default[Int] { def default = 0 }
- implicit def generic[T]: Default[T] = macro Magnolia.generic[T]
+ implicit def gen[T]: Default[T] = macro Magnolia.gen[T]
}
diff --git a/examples/src/main/scala/eq.scala b/examples/src/main/scala/eq.scala
index ec9be14..408f287 100644
--- a/examples/src/main/scala/eq.scala
+++ b/examples/src/main/scala/eq.scala
@@ -9,17 +9,17 @@ trait Eq[T] { def equal(value: T, value2: T): Boolean }
object Eq {
type Typeclass[T] = Eq[T]
- def join[T](ctx: JoinContext[Eq, T]): Eq[T] = new Eq[T] {
+ def combine[T](ctx: CaseClass[Eq, T]): Eq[T] = new Eq[T] {
def equal(value1: T, value2: T) =
ctx.parameters.forall { param => param.typeclass.equal(param.dereference(value1), param.dereference(value2)) }
}
- def dispatch[T](ctx: DispatchContext[Eq, T]): Eq[T] = new Eq[T] {
+ def dispatch[T](ctx: SealedTrait[Eq, T]): Eq[T] = new Eq[T] {
def equal(value1: T, value2: T): Boolean =
ctx.dispatch(value1) { case sub => sub.typeclass.equal(sub.cast(value1), sub.cast(value2)) }
}
implicit val string: Eq[String] = new Eq[String] { def equal(v1: String, v2: String) = v1 == v2 }
implicit val int: Eq[Int] = new Eq[Int] { def equal(v1: Int, v2: Int) = v1 == v2 }
- implicit def generic[T]: Eq[T] = macro Magnolia.generic[T]
+ implicit def gen[T]: Eq[T] = macro Magnolia.gen[T]
}
diff --git a/examples/src/main/scala/show.scala b/examples/src/main/scala/show.scala
index 9af828e..4594bff 100644
--- a/examples/src/main/scala/show.scala
+++ b/examples/src/main/scala/show.scala
@@ -10,17 +10,17 @@ trait Show[Out, T] { def show(value: T): Out }
object Show {
type Typeclass[T] = Show[String, T]
- def join[T](ctx: JoinContext[Typeclass, T]): Show[String, T] = new Show[String, T] {
+ def combine[T](ctx: CaseClass[Typeclass, T]): Show[String, T] = new Show[String, T] {
def show(value: T) = ctx.parameters.map { param =>
s"${param.label}=${param.typeclass.show(param.dereference(value))}"
}.mkString(s"${ctx.typeName.split("\\.").last}(", ",", ")")
}
- def dispatch[T](ctx: DispatchContext[Typeclass, T]): Show[String, T] = new Show[String, T] {
+ def dispatch[T](ctx: SealedTrait[Typeclass, T]): Show[String, T] = new Show[String, T] {
def show(value: T): String = ctx.dispatch(value) { sub => sub.typeclass.show(sub.cast(value)) }
}
implicit val string: Show[String, String] = new Show[String, String] { def show(s: String): String = s }
implicit val int: Show[String, Int] = new Show[String, Int] { def show(s: Int): String = s.toString }
- implicit def generic[T]: Show[String, T] = macro Magnolia.generic[T]
+ implicit def gen[T]: Show[String, T] = macro Magnolia.gen[T]
}
diff --git a/tests/src/main/scala/tests.scala b/tests/src/main/scala/tests.scala
index 06ccd30..14345af 100644
--- a/tests/src/main/scala/tests.scala
+++ b/tests/src/main/scala/tests.scala
@@ -18,6 +18,8 @@ case class Company(name: String) extends Entity
case class Person(name: String, age: Int) extends Entity
case class Address(line1: String, occupant: Person)
+case class Item(name: String, quantity: Int = 1, price: Int)
+
sealed trait Color
case object Red extends Color
case object Green extends Color
@@ -25,41 +27,41 @@ case object Blue extends Color
object Tests extends TestApp {
- def tests() = for(i <- 1 to 10000) {
+ def tests() = for(i <- 1 to 1000) {
import examples._
test("construct a Show product instance") {
import examples._
- Show.generic[Person].show(Person("John Smith", 34))
+ Show.gen[Person].show(Person("John Smith", 34))
}.assert(_ == """Person(name=John Smith,age=34)""")
test("construct a Show coproduct instance") {
import examples._
- Show.generic[Person].show(Person("John Smith", 34))
+ Show.gen[Person].show(Person("John Smith", 34))
}.assert(_ == "Person(name=John Smith,age=34)")
test("serialize a Branch") {
import magnolia.examples._
implicitly[Show[String, Branch[String]]].show(Branch(Leaf("LHS"), Leaf("RHS")))
- }.assert(_ == "Branch[String](left=Leaf[String](value=LHS),right=Leaf[String](value=RHS))")
+ }.assert(_ == "Branch(left=Leaf(value=LHS),right=Leaf(value=RHS))")
test("test equality false") {
import examples._
- Eq.generic[Entity].equal(Person("John Smith", 34), Person("", 0))
+ Eq.gen[Entity].equal(Person("John Smith", 34), Person("", 0))
}.assert(_ == false)
test("test equality true") {
import examples._
- Eq.generic[Entity].equal(Person("John Smith", 34), Person("John Smith", 34))
+ Eq.gen[Entity].equal(Person("John Smith", 34), Person("John Smith", 34))
}.assert(_ == true)
test("test branch equality true") {
import examples._
- Eq.generic[Tree[String]].equal(Branch(Leaf("one"), Leaf("two")), Branch(Leaf("one"), Leaf("two")))
+ Eq.gen[Tree[String]].equal(Branch(Leaf("one"), Leaf("two")), Branch(Leaf("one"), Leaf("two")))
}.assert(_ == true)
test("construct a default value") {
- Default.generic[Entity].default
+ Default.gen[Entity].default
}.assert(_ == Company(""))
test("construction of Show instance for Leaf") {
@@ -78,16 +80,20 @@ object Tests extends TestApp {
test("serialize a Leaf") {
implicitly[Show[String, Leaf[String]]].show(Leaf("testing"))
- }.assert(_ == "Leaf[String](value=testing)")
+ }.assert(_ == "Leaf(value=testing)")
test("serialize a Branch as a Tree") {
implicitly[Show[String, Tree[String]]].show(Branch(Leaf("LHS"), Leaf("RHS")))
- }.assert(_ == "Branch[String](left=Leaf[String](value=LHS),right=Leaf[String](value=RHS))")
+ }.assert(_ == "Branch(left=Leaf(value=LHS),right=Leaf(value=RHS))")
test("serialize case object") {
implicitly[Show[String, Red.type]].show(Red)
}.assert(_ == "Red()")
+ test("access default constructor values") {
+ implicitly[Default[Item]].default
+ }.assert(_ == Item("", 1, 0))
+
test("serialize case object as a sealed trait") {
implicitly[Show[String, Color]].show(Blue)
}.assert(_ == "Blue()")
@@ -97,7 +103,7 @@ object Tests extends TestApp {
}.assert(_ == Company("Acme Inc"))
test("decode a Person as an Entity") {
- implicitly[Decoder[Entity]].decode("""Person(name=John Smith,age=32)""")
+ implicitly[Decoder[Entity]].decode("""magnolia.tests.Person(name=John Smith,age=32)""")
}.assert(_ == Person("John Smith", 32))
test("decode a nested product") {
@@ -109,7 +115,7 @@ object Tests extends TestApp {
import magnolia.examples._
case class Alpha(integer: Double)
case class Beta(alpha: Alpha)
- Show.generic[Beta]
+ Show.gen[Beta]
"""
}.assert(_ == TypecheckError(txt"""magnolia: could not find typeclass for type Double
| in parameter 'integer' of product type Alpha