Merge pull request #38 from SethTisue/issue-36

in class mode, collapse Module/ModuleClass distinction

Author: SethTisue

README.md

@@ -133,12 +133,10 @@ generates this `classes.json` file:
 
     [
       {"sym": ["o:Dep1"], "uses": ["o:Dep2"]},
-      {"sym": ["o:Dep1"], "uses": ["ov:Dep2"]},
       {"sym": ["o:Dep1"], "uses": ["pkt:java", "pkt:lang", "cl:Object"]},
       {"sym": ["o:Dep1"], "uses": ["pkt:scala", "cl:Int"]},
       {"sym": ["o:Dep1"], "uses": ["pkt:scala", "tp:AnyRef"]},
       {"sym": ["o:Dep2"], "uses": ["o:Dep1"]},
-      {"sym": ["o:Dep2"], "uses": ["ov:Dep1"]},
       {"sym": ["o:Dep2"], "uses": ["pkt:java", "pkt:lang", "cl:Object"]},
       {"sym": ["o:Dep2"], "uses": ["pkt:scala", "cl:Int"]},
       {"sym": ["o:Dep2"], "uses": ["pkt:scala", "tp:AnyRef"]}
@@ -227,11 +225,9 @@ And here's the layers report for the same code:
     scala> println(res2.layersString)
     layers =
       """|[1] o:Dep1 o:Dep2
-         |[0] ov:Dep1
          |[0] cl:java.lang.Object
          |[0] cl:scala.Int
          |[0] tp:scala.AnyRef
-         |[0] ov:Dep2
 
 The numbers are layer numbers, defined as follows:
 

src/main/scala/com/typesafe/tools/sculpt/model/ClassMode.scala

@@ -7,6 +7,7 @@ object ClassMode {
   // promotes all of the dependencies to class level:
   // * discarding self-dependencies
   // * collapsing the uses/extends distinction
+  // * collapsing the Module/ModuleClass distinction
   // * ignoring irrelevant pseudo-dependencies
   // * setting all counts to 1
   //   (real counts handling is possible future work)
@@ -34,6 +35,9 @@ object ClassMode {
         next.kind match {
           case k if isClassKind(k) =>
             Some(Path(packages :+ next))
+          // collapse Module/ModuleClass distinction
+          case EntityKind.Module =>
+            Some(Path(packages :+ next.copy(kind = EntityKind.ModuleClass)))
           // ignore strange dependencies on bare terms;
           // see https://github.com/typesafehub/scala-sculpt/issues/28
           case EntityKind.Term if packages.isEmpty =>
@@ -56,7 +60,6 @@ object ClassMode {
   private val isClassKind: EntityKind => Boolean =
     Set[EntityKind](
       EntityKind.Trait, EntityKind.Class,
-      EntityKind.Module, EntityKind.ModuleClass,
-      EntityKind.Type)
+      EntityKind.ModuleClass, EntityKind.Type)
 
 }

src/main/scala/com/typesafe/tools/sculpt/model/Cycles.scala

@@ -53,6 +53,7 @@ object Cycles {
         layer.map(cycleString)
           .filter(_.nonEmpty) // omit empty package
           .map(s => s"[$n] $s\n")
+          .sorted
           .mkString}
       .mkString
 

src/test/scala/com/typesafe/tools/sculpt/Samples.scala

@@ -429,7 +429,7 @@ object Samples {
     classJson =
       """|[
          |  {"sym": ["o:O"], "uses": ["pkt:java", "pkt:lang", "cl:Object"]},
-         |  {"sym": ["o:O"], "uses": ["pkt:scala", "ov:None"]},
+         |  {"sym": ["o:O"], "uses": ["pkt:scala", "o:None"]},
          |  {"sym": ["o:O"], "uses": ["pkt:scala", "tp:AnyRef"]}
          |]""".stripMargin,
     tree =
@@ -445,7 +445,7 @@ object Samples {
     layers =
       """|[1] o:O
          |[0] cl:java.lang.Object
-         |[0] ov:scala.None
+         |[0] o:scala.None
          |[0] tp:scala.AnyRef
          |""".stripMargin)
 
@@ -576,12 +576,10 @@ object Samples {
     classJson =
       """|[
          |  {"sym": ["o:Dep1"], "uses": ["o:Dep2"]},
-         |  {"sym": ["o:Dep1"], "uses": ["ov:Dep2"]},
          |  {"sym": ["o:Dep1"], "uses": ["pkt:java", "pkt:lang", "cl:Object"]},
          |  {"sym": ["o:Dep1"], "uses": ["pkt:scala", "cl:Int"]},
          |  {"sym": ["o:Dep1"], "uses": ["pkt:scala", "tp:AnyRef"]},
          |  {"sym": ["o:Dep2"], "uses": ["o:Dep1"]},
-         |  {"sym": ["o:Dep2"], "uses": ["ov:Dep1"]},
          |  {"sym": ["o:Dep2"], "uses": ["pkt:java", "pkt:lang", "cl:Object"]},
          |  {"sym": ["o:Dep2"], "uses": ["pkt:scala", "cl:Int"]},
          |  {"sym": ["o:Dep2"], "uses": ["pkt:scala", "tp:AnyRef"]}
@@ -599,11 +597,9 @@ object Samples {
       """|[2] o:Dep1 o:Dep2""".stripMargin,
     layers =
       """|[1] o:Dep1 o:Dep2
-         |[0] ov:Dep1
          |[0] cl:java.lang.Object
          |[0] cl:scala.Int
          |[0] tp:scala.AnyRef
-         |[0] ov:Dep2
          |""".stripMargin)
 
 }