Merge pull request #34 from propensive/additional-derivation-help

Include warnings if `combine` or `dispatch` methods are missing

2 files changed, 22 insertions, 6 deletions

diff --git a/core/src/main/scala/magnolia.scala b/core/src/main/scala/magnolia.scala
index 31ae745..de5f187 100644
--- a/core/src/main/scala/magnolia.scala
+++ b/core/src/main/scala/magnolia.scala
@@ -74,7 +74,7 @@ object Magnolia {
     val prefixType = c.prefix.tree.tpe
 
     def companionRef(tpe: Type): Tree = {
-      val global = c.universe.asInstanceOf[scala.tools.nsc.Global]
+      val global = c.universe match { case global: scala.tools.nsc.Global => global }
       val globalTpe = tpe.asInstanceOf[global.Type]
       val companion = globalTpe.typeSymbol.companionSymbol
       if(companion != NoSymbol) global.gen.mkAttributedRef(globalTpe.prefix, companion).asInstanceOf[Tree]
@@ -86,7 +86,7 @@ object Magnolia {
         tpe.asType.toType.asSeenFrom(prefixType, cls)
       }
     }
-
+    
     val typeConstructorOpt =
       typeDefs.headOption.map(_.typeConstructor)
 
@@ -95,6 +95,22 @@ object Magnolia {
               "magnolia: the derivation object does not define the Typeclass type constructor")
     }
 
+    def checkMethod(termName: String, category: String, expected: String) = {
+      val term = TermName(termName)
+      val combineClass = c.prefix.tree.tpe.baseClasses.find { cls =>
+        cls.asType.toType.decl(term) != NoSymbol
+      }.getOrElse {
+        c.abort(c.enclosingPosition, s"magnolia: the method `$termName` must be defined on the derivation object to derive typeclasses for $category")
+      }
+      val firstParamBlock = combineClass.asType.toType.decl(term).asTerm.asMethod.paramLists.head
+      if(firstParamBlock.length != 1) c.abort(c.enclosingPosition,
+          s"magnolia: the method `combine` should take a single parameter of type $expected")
+    }
+    
+    // FIXME: Only run these methods if they're used, particularly `dispatch`
+    checkMethod("combine", "case classes", "CaseClass[Typeclass, _]")
+    checkMethod("dispatch", "sealed traits", "SealedTrait[Typeclass, _]")
+
     def findType(key: Type): Option[TermName] =
       recursionStack(c.enclosingPosition).frames.find(_.genericType == key).map(_.termName(c))
 
@@ -193,11 +209,11 @@ object Magnolia {
 
       val resultType = appliedType(typeConstructor, genericType)
 
-      // FIXME: Handle AnyVals
       val result = if (isCaseObject) {
         // FIXME: look for an alternative which isn't deprecated on Scala 2.12+
         val obj = companionRef(genericType)
         val className = genericType.typeSymbol.name.decodedName.toString
+        
         val impl = q"""
           ${c.prefix}.combine($magnoliaObj.caseClass[$typeConstructor, $genericType](
             $className, true, false, new $arrayCls(0), _ => $obj)
@@ -271,7 +287,7 @@ object Magnolia {
             ${param.name.decodedName.toString}, $ref, $defaultVal, _.${param.name}
           )"""
         }
-
+        
         Some(
           Typeclass(
             genericType,
@@ -331,7 +347,7 @@ object Magnolia {
             (t: $genericType) => t.asInstanceOf[$typ]
           )"""
         }
-
+        
         Some {
           Typeclass(
             genericType,
diff --git a/tests/src/main/scala/tests.scala b/tests/src/main/scala/tests.scala
index 242bd41..e453502 100644
--- a/tests/src/main/scala/tests.scala
+++ b/tests/src/main/scala/tests.scala
@@ -136,7 +136,7 @@ object Tests extends TestApp {
     }.assert(_ == "Blue()")
 
     test("decode a company") {
-      implicitly[Decoder[Company]].decode("""Company(name=Acme Inc)""")
+      Decoder.gen[Company].decode("""Company(name=Acme Inc)""")
     }.assert(_ == Company("Acme Inc"))
 
     test("decode a Person as an Entity") {