Merge pull request #156 from lightbend/fixDispatcherSelector

Fix creating static forwarders for inherited methods

Author: raboof

plugin/src/main/scala/com/typesafe/genjavadoc/BasicTransform.scala

@@ -17,7 +17,7 @@ trait BasicTransform { this: TransformCake ⇒
 
   def newTransformUnit(unit: CompilationUnit): Unit = {
     superTransformUnit(unit)
-    for (c ← flatten(classes.flatMap(liftInterface))) {
+    for (c ← flattenObjects(classes.flatMap(liftInterface))) {
       val out = file(c.file)
       try {
         if (c.pckg != "<empty>") out.println(s"package ${c.pckg};")

plugin/src/main/scala/com/typesafe/genjavadoc/Output.scala

@@ -88,7 +88,7 @@ trait Output { this: TransformCake ⇒
    *
    * The first two parts are to be applied recursively to nested objects.
    */
-  def flatten(c: Vector[ClassInfo], forwarders: Boolean = true, staticScope: Boolean = true): Vector[ClassInfo] = {
+  def flattenObjects(c: Vector[ClassInfo], forwarders: Boolean = true, staticScope: Boolean = true): Vector[ClassInfo] = {
     val (obj: Vector[ClassInfo], cls: Vector[ClassInfo]) = c collect PreFilter partition (_.module)
     val classes = cls.map(c ⇒ c.name -> c).toMap
     val objects = obj.map(o ⇒ o.name -> o).toMap
@@ -99,7 +99,7 @@ trait Output { this: TransformCake ⇒
         case (Some(o), Some(c))            ⇒ merge(o, c, forwarders, staticScope)
         case (Some(o), None) if forwarders ⇒ merge(o, fabricateCompanion(o), forwarders, staticScope)
         case (Some(o), None)               ⇒ Vector(mangleModule(o, addMODULE = forwarders, pruneClasses = false))
-        case (None, Some(c))               ⇒ Vector(c.copy(members = flatten(c.classMembers) ++ c.methodMembers.sortBy(_.name)))
+        case (None, Some(c))               ⇒ Vector(c.copy(members = flattenObjects(c.classMembers) ++ c.methodMembers.sortBy(_.name)))
         case (None, None)                  ⇒ ???
       }
     }
@@ -131,7 +131,7 @@ trait Output { this: TransformCake ⇒
 
     val members = moduleInstance ++: (
       if (pruneClasses) obj.methodMembers
-      else flatten(obj.classMembers) ++ obj.methodMembers
+      else flattenObjects(obj.classMembers) ++ obj.methodMembers
       )
 
     val (com: Seq[String], moduleMembers: Vector[Templ]) = members.foldLeft((obj.comment, Vector.empty[Templ]))((p, mem) ⇒ mem match {
@@ -163,11 +163,11 @@ trait Output { this: TransformCake ⇒
           case m: MethodInfo if !(m.name == obj.name) && !cls.members.exists(_.name == m.name) ⇒
             m.copy(pattern = n ⇒ "static " + m.pattern(n))
         }
-        val exclude = (direct.iterator ++ methods.iterator).map(_.name).toSet ++ this.javaKeywords
-        direct ++ inheritedMethods(cls.sym, exclude)
+        val exclude = (direct.iterator ++ methods.iterator).map(_.name).toSet ++ this.javaKeywords ++ excludedForwarders
+        direct ++ inheritedMethods(obj.sym, exclude)
       }
-    val nestedClasses = flatten(classes, forwarders = false, staticScope = false)
-    val nestedStaticClasses = flatten(staticClasses, forwarders = false, staticScope = staticScope)
+    val nestedClasses = flattenObjects(classes, forwarders = false, staticScope = false)
+    val nestedStaticClasses = flattenObjects(staticClasses, forwarders = false, staticScope = staticScope)
     if (forwarders) {
       val base = cls.copy(members = nestedClasses ++ nestedStaticClasses ++ staticMethods ++ methods)
       val mod = mangleModule(obj, addMODULE = forwarders, pruneClasses = true)
@@ -179,6 +179,13 @@ trait Output { this: TransformCake ⇒
     }
   }
 
+  private val excludedForwarders =
+    // For case classes, there is a generated companion object that
+    // implements `AbstractFunctionN`, but static forwarders are not created
+    // on the class for the methods on the companion object inherited from
+    // that:
+    Seq("curried", "tupled", "compose", "andThen")
+
   private def inheritedMethods(sym: global.Symbol, exclude: Set[String]): Seq[MethodInfo] = {
     import global._
     sym.ancestors.reverse

plugin/src/test/resources/expected_output/basic/akka/actor/Identify$.java

@@ -0,0 +1,12 @@
+package akka.actor;
+public  class Identify$ extends scala.runtime.AbstractFunction1<java.lang.Object, akka.actor.Identify> implements scala.Serializable {
+  /**
+   * Static reference to the singleton instance of this Scala object.
+   */
+  public static final Identify$ MODULE$ = null;
+  public   Identify$ ()  { throw new RuntimeException(); }
+  public final  java.lang.String toString ()  { throw new RuntimeException(); }
+  public  akka.actor.Identify apply (Object messageId)  { throw new RuntimeException(); }
+  public  scala.Option<java.lang.Object> unapply (akka.actor.Identify x$0)  { throw new RuntimeException(); }
+  private  java.lang.Object readResolve ()  { throw new RuntimeException(); }
+}

plugin/src/test/resources/expected_output/basic/akka/actor/Identify.java

@@ -0,0 +1,20 @@
+package akka.actor;
+public final class Identify implements scala.Product, scala.Serializable {
+  static public  akka.actor.Identify apply (Object messageId)  { throw new RuntimeException(); }
+  static public  scala.Option<java.lang.Object> unapply (akka.actor.Identify x$0)  { throw new RuntimeException(); }
+  static private  java.lang.Object readResolve ()  { throw new RuntimeException(); }
+  public  Object messageId ()  { throw new RuntimeException(); }
+  // not preceding
+  public   Identify (Object messageId)  { throw new RuntimeException(); }
+  public  akka.actor.Identify copy (Object messageId)  { throw new RuntimeException(); }
+  public  Object copy$default$1 ()  { throw new RuntimeException(); }
+  // not preceding
+  public  java.lang.String productPrefix ()  { throw new RuntimeException(); }
+  public  int productArity ()  { throw new RuntimeException(); }
+  public  Object productElement (int x$1)  { throw new RuntimeException(); }
+  public  scala.collection.Iterator<java.lang.Object> productIterator ()  { throw new RuntimeException(); }
+  public  boolean canEqual (Object x$1)  { throw new RuntimeException(); }
+  public  int hashCode ()  { throw new RuntimeException(); }
+  public  java.lang.String toString ()  { throw new RuntimeException(); }
+  public  boolean equals (Object x$1)  { throw new RuntimeException(); }
+}

plugin/src/test/resources/expected_output/basic/akka/actor/typed/DispatcherSelector$.java

@@ -0,0 +1,9 @@
+package akka.actor.typed;
+public  class DispatcherSelector$ implements scala.Serializable {
+  /**
+   * Static reference to the singleton instance of this Scala object.
+   */
+  public static final DispatcherSelector$ MODULE$ = null;
+  public   DispatcherSelector$ ()  { throw new RuntimeException(); }
+  private  java.lang.Object readResolve ()  { throw new RuntimeException(); }
+}

plugin/src/test/resources/expected_output/basic/akka/actor/typed/DispatcherSelector.java

@@ -0,0 +1,5 @@
+package akka.actor.typed;
+public abstract class DispatcherSelector extends akka.actor.typed.Props {
+  static private  java.lang.Object readResolve ()  { throw new RuntimeException(); }
+  public   DispatcherSelector ()  { throw new RuntimeException(); }
+}

plugin/src/test/resources/expected_output/basic/akka/actor/typed/Props.java

@@ -0,0 +1,5 @@
+package akka.actor.typed;
+public abstract class Props implements scala.Product, scala.Serializable {
+  public   Props ()  { throw new RuntimeException(); }
+  public abstract  akka.actor.typed.Props next ()  ;
+}

plugin/src/test/resources/input/basic/akka/actor/Actor.scala

@@ -0,0 +1,5 @@
+package akka.actor
+
+@SerialVersionUID(1L)
+final case class Identify(messageId: Any) // extends AutoReceivedMessage with NotInfluenceReceiveTimeout
+

plugin/src/test/resources/input/basic/akka/actor/typed/Props.scala

@@ -0,0 +1,9 @@
+package akka.actor.typed
+
+abstract class Props private[akka] () extends Product with Serializable {
+  private[akka] def next: Props
+}
+
+sealed abstract class DispatcherSelector extends Props
+
+object DispatcherSelector

plugin/src/test/resources/patches/2.12.0.patch

@@ -51,3 +51,36 @@
 -   */
 -  public  akka.rk.buh.is.it.A.D$ D ()  { throw new RuntimeException(); }
  }
+--- target/expected_output/basic/akka/actor/Identify.java
++++ target/expected_output/basic/akka/actor/Identify.java
+@@ -3,6 +3,30 @@
+   static public  akka.actor.Identify apply (Object messageId)  { throw new RuntimeException(); }
+   static public  scala.Option<java.lang.Object> unapply (akka.actor.Identify x$0)  { throw new RuntimeException(); }
+   static private  java.lang.Object readResolve ()  { throw new RuntimeException(); }
++  static public  boolean apply$mcZD$sp (double v1)  { throw new RuntimeException(); }
++  static public  double apply$mcDD$sp (double v1)  { throw new RuntimeException(); }
++  static public  float apply$mcFD$sp (double v1)  { throw new RuntimeException(); }
++  static public  int apply$mcID$sp (double v1)  { throw new RuntimeException(); }
++  static public  long apply$mcJD$sp (double v1)  { throw new RuntimeException(); }
++  static public  void apply$mcVD$sp (double v1)  { throw new RuntimeException(); }
++  static public  boolean apply$mcZF$sp (float v1)  { throw new RuntimeException(); }
++  static public  double apply$mcDF$sp (float v1)  { throw new RuntimeException(); }
++  static public  float apply$mcFF$sp (float v1)  { throw new RuntimeException(); }
++  static public  int apply$mcIF$sp (float v1)  { throw new RuntimeException(); }
++  static public  long apply$mcJF$sp (float v1)  { throw new RuntimeException(); }
++  static public  void apply$mcVF$sp (float v1)  { throw new RuntimeException(); }
++  static public  boolean apply$mcZI$sp (int v1)  { throw new RuntimeException(); }
++  static public  double apply$mcDI$sp (int v1)  { throw new RuntimeException(); }
++  static public  float apply$mcFI$sp (int v1)  { throw new RuntimeException(); }
++  static public  int apply$mcII$sp (int v1)  { throw new RuntimeException(); }
++  static public  long apply$mcJI$sp (int v1)  { throw new RuntimeException(); }
++  static public  void apply$mcVI$sp (int v1)  { throw new RuntimeException(); }
++  static public  boolean apply$mcZJ$sp (long v1)  { throw new RuntimeException(); }
++  static public  double apply$mcDJ$sp (long v1)  { throw new RuntimeException(); }
++  static public  float apply$mcFJ$sp (long v1)  { throw new RuntimeException(); }
++  static public  int apply$mcIJ$sp (long v1)  { throw new RuntimeException(); }
++  static public  long apply$mcJJ$sp (long v1)  { throw new RuntimeException(); }
++  static public  void apply$mcVJ$sp (long v1)  { throw new RuntimeException(); }
+   public  Object messageId ()  { throw new RuntimeException(); }
+   // not preceding
+   public   Identify (Object messageId)  { throw new RuntimeException(); }