in project/StreamOperatorsIndexGenerator.scala [48:243]
def categoryId(name: String): String = name.toLowerCase.replace(' ', '-')
val pendingSourceOrFlow = Seq(
"to",
"toMat",
"via",
"viaMat",
"async",
"upcast",
"shape",
"run",
"runWith",
"traversalBuilder",
"runFold",
"runFoldAsync",
"runForeach",
"runReduce",
"named",
"throttleEven",
"actorPublisher",
"addAttributes",
"mapMaterializedValue",
// *Graph:
"concatGraph",
"prependGraph",
"mergeSortedGraph",
"fromGraph",
"interleaveGraph",
"zipGraph",
"mergeGraph",
"wireTapGraph",
"alsoToGraph",
"orElseGraph",
"divertToGraph",
"zipWithGraph")
// FIXME document these methods as well
val pendingTestCases = Map(
"Source" -> pendingSourceOrFlow,
"Flow" -> (pendingSourceOrFlow ++ Seq(
"lazyInit",
"fromProcessorMat",
"toProcessor",
"fromProcessor",
"of",
"join",
"joinMat",
"fromFunction")),
"Sink" -> Seq(
"lazyInit",
"contramap",
"named",
"addAttributes",
"async",
"mapMaterializedValue",
"runWith",
"shape",
"traversalBuilder",
"fromGraph",
"actorSubscriber",
"foldAsync",
"newOnCompleteStage"))
val ignore =
Set("equals", "hashCode", "notify", "notifyAll", "wait", "toString", "getClass") ++
Set("productArity", "canEqual", "productPrefix", "copy", "productIterator", "productElement") ++
Set(
"create",
"apply",
"ops",
"appendJava",
"andThen",
"andThenMat",
"isIdentity",
"withAttributes",
"transformMaterializing") ++
Set("asScala", "asJava", "deprecatedAndThen", "deprecatedAndThenMat") ++
Set("++", "onPush", "onPull", "actorRefWithAck")
def isPending(element: String, opName: String) =
pendingTestCases.get(element).exists(_.contains(opName))
val noElement = " "
def generateAlphabeticalIndex(dir: SettingKey[File], locate: File => File) = Def.task[Seq[File]] {
val file = locate(dir.value)
val defs =
List(
"stream/src/main/scala/org/apache/pekko/stream/scaladsl/Source.scala",
"stream/src/main/scala/org/apache/pekko/stream/javadsl/Source.scala",
// "stream/src/main/scala/org/apache/pekko/stream/scaladsl/SubSource.scala",
// "stream/src/main/scala/org/apache/pekko/stream/javadsl/SubSource.scala",
"stream/src/main/scala/org/apache/pekko/stream/scaladsl/Flow.scala",
"stream/src/main/scala/org/apache/pekko/stream/javadsl/Flow.scala",
// "stream/src/main/scala/org/apache/pekko/stream/scaladsl/SubFlow.scala",
// "stream/src/main/scala/org/apache/pekko/stream/javadsl/SubFlow.scala",
// "stream/src/main/scala/org/apache/pekko/stream/scaladsl/RunnableFlow.scala",
// "stream/src/main/scala/org/apache/pekko/stream/javadsl/RunnableFlow.scala",
"stream/src/main/scala/org/apache/pekko/stream/scaladsl/Sink.scala",
"stream/src/main/scala/org/apache/pekko/stream/javadsl/Sink.scala",
"stream/src/main/scala/org/apache/pekko/stream/scaladsl/StreamConverters.scala",
"stream/src/main/scala/org/apache/pekko/stream/javadsl/StreamConverters.scala",
"stream/src/main/scala/org/apache/pekko/stream/scaladsl/FileIO.scala",
"stream/src/main/scala/org/apache/pekko/stream/javadsl/FileIO.scala",
"stream/src/main/scala/org/apache/pekko/stream/scaladsl/RestartSource.scala",
"stream/src/main/scala/org/apache/pekko/stream/javadsl/RestartSource.scala",
"stream/src/main/scala/org/apache/pekko/stream/scaladsl/RestartFlow.scala",
"stream/src/main/scala/org/apache/pekko/stream/javadsl/RestartFlow.scala",
"stream/src/main/scala/org/apache/pekko/stream/scaladsl/RestartSink.scala",
"stream/src/main/scala/org/apache/pekko/stream/javadsl/RestartSink.scala",
"stream/src/main/scala/org/apache/pekko/stream/scaladsl/RetryFlow.scala",
"stream/src/main/scala/org/apache/pekko/stream/javadsl/RetryFlow.scala",
"stream/src/main/scala/org/apache/pekko/stream/scaladsl/Compression.scala",
"stream/src/main/scala/org/apache/pekko/stream/javadsl/Compression.scala",
// stream-typed
"stream-typed/src/main/scala/org/apache/pekko/stream/typed/javadsl/ActorSource.scala",
"stream-typed/src/main/scala/org/apache/pekko/stream/typed/scaladsl/ActorSource.scala",
"stream-typed/src/main/scala/org/apache/pekko/stream/typed/javadsl/ActorFlow.scala",
"stream-typed/src/main/scala/org/apache/pekko/stream/typed/scaladsl/ActorFlow.scala",
"stream-typed/src/main/scala/org/apache/pekko/stream/typed/scaladsl/ActorSink.scala",
"stream-typed/src/main/scala/org/apache/pekko/stream/typed/javadsl/ActorSink.scala",
"stream-typed/src/main/scala/org/apache/pekko/stream/typed/scaladsl/PubSub.scala",
"stream-typed/src/main/scala/org/apache/pekko/stream/typed/javadsl/PubSub.scala").flatMap { f =>
val slashesNr = f.count(_ == '/')
val element = f.split("/")(slashesNr).split("\\.")(0)
IO.read(new File(f))
.split("\n")
.map(_.trim)
.filter(_.startsWith("def "))
.map(_.drop(4).takeWhile(c => c != '[' && c != '(' && c != ':'))
.filter(op => !isPending(element, op))
.filter(op => !ignore.contains(op))
.map(_.replaceAll("Mat$", ""))
.map(method => (element, method))
} ++ List(
(noElement, "Partition"),
(noElement, "MergeSequence"),
(noElement, "Broadcast"),
(noElement, "Balance"),
(noElement, "Unzip"),
(noElement, "UnzipWith"))
val sourceAndFlow =
defs.collect { case ("Source", method) => method }.intersect(defs.collect { case ("Flow", method) => method })
val groupedDefs =
defs.map {
case (element @ ("Source" | "Flow"), method) if sourceAndFlow.contains(method) =>
("Source/Flow", method, s"Source-or-Flow/$method.md")
case (`noElement`, method) =>
(noElement, method, s"$method.md")
case (element, method) =>
(element, method, s"$element/$method.md")
}.distinct
val tablePerCategory = groupedDefs
.map {
case (element, method, md) =>
val (description, category) = getDetails(file.getParentFile / md)
category -> (element, method, md, description)
}
.groupBy(_._1)
.mapValues(lines =>
"| |Operator|Description|\n" ++ // TODO mini images here too
"|--|--|--|\n" ++
lines
.map(_._2)
.sortBy(_._2)
.map {
case (element, method, md, description) =>
s"""|$element|<a name="${method.toLowerCase}"></a>@ref[${methodToShow(method)}]($md)|$description|"""
}
.mkString("\n"))
val tables = categories
.map { category =>
s"## $category\n\n" ++
IO.read(dir.value / "categories" / (categoryId(category) + ".md")) ++ "\n\n" ++
tablePerCategory(category)
}
.mkString("\n\n")
val content =
"<!-- DO NOT EDIT DIRECTLY: This file is generated by `project/StreamOperatorsIndexGenerator`. See CONTRIBUTING.md for details. -->\n" +
"# Operators\n\n" +
tables +
"\n\n@@@ index\n\n" +
groupedDefs
.sortBy { case (_, method, _) => method.toLowerCase }
.map { case (_, method, md) => s"* [$method]($md)" }
.mkString("\n") + "\n\n@@@\n"
if (!file.exists || IO.read(file) != content) IO.write(file, content)
Seq(file)
}