From 337508c82cbe598b8796fc532cd92e8230b099cb Mon Sep 17 00:00:00 2001 From: Li Haoyi Date: Fri, 10 Nov 2017 20:52:57 -0800 Subject: rename forge -> mill --- core/src/main/scala/forge/discover/Router.scala | 393 ------------------------ 1 file changed, 393 deletions(-) delete mode 100644 core/src/main/scala/forge/discover/Router.scala (limited to 'core/src/main/scala/forge/discover/Router.scala') diff --git a/core/src/main/scala/forge/discover/Router.scala b/core/src/main/scala/forge/discover/Router.scala deleted file mode 100644 index 1034b46e..00000000 --- a/core/src/main/scala/forge/discover/Router.scala +++ /dev/null @@ -1,393 +0,0 @@ -package forge.discover - -import ammonite.main.Compat -import forge.define.Task -import sourcecode.Compat.Context - -import scala.annotation.StaticAnnotation -import scala.collection.mutable -import scala.language.experimental.macros -/** - * More or less a minimal version of Autowire's Server that lets you generate - * a set of "routes" from the methods defined in an object, and call them - * using passing in name/args/kwargs via Java reflection, without having to - * generate/compile code or use Scala reflection. This saves us spinning up - * the Scala compiler and greatly reduces the startup time of cached scripts. - */ -object Router{ - class doc(s: String) extends StaticAnnotation - def generateRoutes[T]: Seq[Router.EntryPoint[T]] = macro generateRoutesImpl[T] - def generateRoutesImpl[T: c.WeakTypeTag](c: Context): c.Expr[Seq[EntryPoint[T]]] = { - import c.universe._ - val r = new Router(c) - val allRoutes = r.getAllRoutesForClass( - weakTypeOf[T].asInstanceOf[r.c.Type], - ).asInstanceOf[Iterable[c.Tree]] - - c.Expr[Seq[EntryPoint[T]]](q"_root_.scala.Seq(..$allRoutes)") - } - - /** - * Models what is known by the router about a single argument: that it has - * a [[name]], a human-readable [[typeString]] describing what the type is - * (just for logging and reading, not a replacement for a `TypeTag`) and - * possible a function that can compute its default value - */ - case class ArgSig[T](name: String, - typeString: String, - doc: Option[String], - default: Option[T => Any]) - - def stripDashes(s: String) = { - if (s.startsWith("--")) s.drop(2) - else if (s.startsWith("-")) s.drop(1) - else s - } - /** - * What is known about a single endpoint for our routes. It has a [[name]], - * [[argSignatures]] for each argument, and a macro-generated [[invoke0]] - * that performs all the necessary argument parsing and de-serialization. - * - * Realistically, you will probably spend most of your time calling [[invoke]] - * instead, which provides a nicer API to call it that mimmicks the API of - * calling a Scala method. - */ - case class EntryPoint[T](name: String, - argSignatures: Seq[ArgSig[T]], - doc: Option[String], - varargs: Boolean, - invoke0: (T, Map[String, String], Seq[String]) => Result[Task[Any]]){ - def invoke(target: T, groupedArgs: Seq[(String, Option[String])]): Result[Task[Any]] = { - var remainingArgSignatures = argSignatures.toList - - - val accumulatedKeywords = mutable.Map.empty[ArgSig[T], mutable.Buffer[String]] - val keywordableArgs = if (varargs) argSignatures.dropRight(1) else argSignatures - - for(arg <- keywordableArgs) accumulatedKeywords(arg) = mutable.Buffer.empty - - val leftoverArgs = mutable.Buffer.empty[String] - - val lookupArgSig = argSignatures.map(x => (x.name, x)).toMap - - var incomplete: Option[ArgSig[T]] = None - - for(group <- groupedArgs){ - - group match{ - case (value, None) => - if (value(0) == '-' && !varargs){ - lookupArgSig.get(stripDashes(value)) match{ - case None => leftoverArgs.append(value) - case Some(sig) => incomplete = Some(sig) - } - - } else remainingArgSignatures match { - case Nil => leftoverArgs.append(value) - case last :: Nil if varargs => leftoverArgs.append(value) - case next :: rest => - accumulatedKeywords(next).append(value) - remainingArgSignatures = rest - } - case (rawKey, Some(value)) => - val key = stripDashes(rawKey) - lookupArgSig.get(key) match{ - case Some(x) if accumulatedKeywords.contains(x) => - if (accumulatedKeywords(x).nonEmpty && varargs){ - leftoverArgs.append(rawKey, value) - }else{ - accumulatedKeywords(x).append(value) - remainingArgSignatures = remainingArgSignatures.filter(_.name != key) - } - case _ => - leftoverArgs.append(rawKey, value) - } - } - } - - val missing0 = remainingArgSignatures.filter(_.default.isEmpty) - val missing = if(varargs) { - missing0.filter(_ != argSignatures.last) - } else { - missing0.filter(x => incomplete != Some(x)) - } - val duplicates = accumulatedKeywords.toSeq.filter(_._2.length > 1) - - if ( - incomplete.nonEmpty || - missing.nonEmpty || - duplicates.nonEmpty || - (leftoverArgs.nonEmpty && !varargs) - ){ - Result.Error.MismatchedArguments( - missing = missing, - unknown = leftoverArgs, - duplicate = duplicates, - incomplete = incomplete - - ) - } else { - val mapping = accumulatedKeywords - .iterator - .collect{case (k, Seq(single)) => (k.name, single)} - .toMap - - try invoke0(target, mapping, leftoverArgs) - catch{case e: Throwable => - Result.Error.Exception(e) - } - } - } - } - - def tryEither[T](t: => T, error: Throwable => Result.ParamError) = { - try Right(t) - catch{ case e: Throwable => Left(error(e))} - } - def readVarargs[T](arg: ArgSig[_], - values: Seq[String], - thunk: String => T) = { - val attempts = - for(item <- values) - yield tryEither(thunk(item), Result.ParamError.Invalid(arg, item, _)) - - - val bad = attempts.collect{ case Left(x) => x} - if (bad.nonEmpty) Left(bad) - else Right(attempts.collect{case Right(x) => x}) - } - def read[T](dict: Map[String, String], - default: => Option[Any], - arg: ArgSig[_], - thunk: String => T): FailMaybe = { - dict.get(arg.name) match{ - case None => - tryEither(default.get, Result.ParamError.DefaultFailed(arg, _)).left.map(Seq(_)) - - case Some(x) => - tryEither(thunk(x), Result.ParamError.Invalid(arg, x, _)).left.map(Seq(_)) - } - } - - /** - * Represents what comes out of an attempt to invoke an [[EntryPoint]]. - * Could succeed with a value, but could fail in many different ways. - */ - sealed trait Result[+T] - object Result{ - - /** - * Invoking the [[EntryPoint]] was totally successful, and returned a - * result - */ - case class Success[T](value: T) extends Result[T] - - /** - * Invoking the [[EntryPoint]] was not successful - */ - sealed trait Error extends Result[Nothing] - object Error{ - - /** - * Invoking the [[EntryPoint]] failed with an exception while executing - * code within it. - */ - case class Exception(t: Throwable) extends Error - - /** - * Invoking the [[EntryPoint]] failed because the arguments provided - * did not line up with the arguments expected - */ - case class MismatchedArguments(missing: Seq[ArgSig[_]], - unknown: Seq[String], - duplicate: Seq[(ArgSig[_], Seq[String])], - incomplete: Option[ArgSig[_]]) extends Error - /** - * Invoking the [[EntryPoint]] failed because there were problems - * deserializing/parsing individual arguments - */ - case class InvalidArguments(values: Seq[ParamError]) extends Error - } - - sealed trait ParamError - object ParamError{ - /** - * Something went wrong trying to de-serialize the input parameter; - * the thrown exception is stored in [[ex]] - */ - case class Invalid(arg: ArgSig[_], value: String, ex: Throwable) extends ParamError - /** - * Something went wrong trying to evaluate the default value - * for this input parameter - */ - case class DefaultFailed(arg: ArgSig[_], ex: Throwable) extends ParamError - } - } - - - type FailMaybe = Either[Seq[Result.ParamError], Any] - type FailAll = Either[Seq[Result.ParamError], Seq[Any]] - - def validate(args: Seq[FailMaybe]): Result[Seq[Any]] = { - val lefts = args.collect{case Left(x) => x}.flatten - - if (lefts.nonEmpty) Result.Error.InvalidArguments(lefts) - else { - val rights = args.collect{case Right(x) => x} - Result.Success(rights) - } - } -} -class Router [C <: Context](val c: C) { - import c.universe._ - def getValsOrMeths(curCls: Type): Iterable[MethodSymbol] = { - def isAMemberOfAnyRef(member: Symbol) = { - weakTypeOf[AnyRef].members.exists(_.name == member.name) - } - val extractableMembers = for { - member <- curCls.members - if !isAMemberOfAnyRef(member) - if !member.isSynthetic - if member.isPublic - if member.isTerm - memTerm = member.asTerm - if memTerm.isMethod - } yield memTerm.asMethod - extractableMembers flatMap { case memTerm => - if (memTerm.isSetter || memTerm.isConstructor || memTerm.isGetter) Nil - else Seq(memTerm) - - } - } - - def extractMethod(meth: MethodSymbol, curCls: c.universe.Type): c.universe.Tree = { - val flattenedArgLists = meth.paramss.flatten - def hasDefault(i: Int) = { - val defaultName = s"${meth.name}$$default$$${i + 1}" - if (curCls.members.exists(_.name.toString == defaultName)) Some(defaultName) - else None - } - val argListSymbol = q"${c.fresh[TermName]("argsList")}" - val extrasSymbol = q"${c.fresh[TermName]("extras")}" - val defaults = for ((arg, i) <- flattenedArgLists.zipWithIndex) yield { - val arg = TermName(c.freshName()) - hasDefault(i).map(defaultName => q"($arg: $curCls) => $arg.${newTermName(defaultName)}") - } - - def getDocAnnotation(annotations: List[Annotation]) = { - val (docTrees, remaining) = annotations.partition(_.tpe =:= typeOf[Router.doc]) - val docValues = for { - doc <- docTrees - if doc.scalaArgs.head.isInstanceOf[Literal] - l = doc.scalaArgs.head.asInstanceOf[Literal] - if l.value.value.isInstanceOf[String] - } yield l.value.value.asInstanceOf[String] - (remaining, docValues.headOption) - } - - def unwrapVarargType(arg: Symbol) = { - val vararg = arg.typeSignature.typeSymbol == definitions.RepeatedParamClass - val unwrappedType = - if (!vararg) arg.typeSignature - else arg.typeSignature.asInstanceOf[TypeRef].args(0) - - (vararg, unwrappedType) - } - - - val (_, methodDoc) = getDocAnnotation(meth.annotations) - val readArgSigs = for( - ((arg, defaultOpt), i) <- flattenedArgLists.zip(defaults).zipWithIndex - ) yield { - - val (vararg, varargUnwrappedType) = unwrapVarargType(arg) - - val default = - if (vararg) q"scala.Some(scala.Nil)" - else defaultOpt match { - case Some(defaultExpr) => q"scala.Some($defaultExpr())" - case None => q"scala.None" - } - - val (docUnwrappedType, docOpt) = varargUnwrappedType match{ - case t: AnnotatedType => - - val (remaining, docValue) = getDocAnnotation(t.annotations) - if (remaining.isEmpty) (t.underlying, docValue) - else (Compat.copyAnnotatedType(c)(t, remaining), docValue) - - case t => (t, None) - } - - val docTree = docOpt match{ - case None => q"scala.None" - case Some(s) => q"scala.Some($s)" - } - val argSig = q""" - forge.discover.Router.ArgSig( - ${arg.name.toString}, - ${docUnwrappedType.toString + (if(vararg) "*" else "")}, - $docTree, - $defaultOpt - ) - """ - - val reader = - if(vararg) q""" - forge.discover.Router.readVarargs[$docUnwrappedType]( - $argSig, - $extrasSymbol, - implicitly[scopt.Read[$docUnwrappedType]].reads(_) - ) - """ else q""" - forge.discover.Router.read[$docUnwrappedType]( - $argListSymbol, - $default, - $argSig, - implicitly[scopt.Read[$docUnwrappedType]].reads(_) - ) - """ - (reader, argSig, vararg) - } - - val (readArgs, argSigs, varargs) = readArgSigs.unzip3 - val (argNames, argNameCasts) = flattenedArgLists.map { arg => - val (vararg, unwrappedType) = unwrapVarargType(arg) - ( - pq"${arg.name.toTermName}", - if (!vararg) q"${arg.name.toTermName}.asInstanceOf[$unwrappedType]" - else q"${arg.name.toTermName}.asInstanceOf[Seq[$unwrappedType]]: _*" - - ) - }.unzip - - val arg = TermName(c.freshName()) - q""" - forge.discover.Router.EntryPoint( - ${meth.name.toString}, - scala.Seq(..$argSigs), - ${methodDoc match{ - case None => q"scala.None" - case Some(s) => q"scala.Some($s)" - }}, - ${varargs.contains(true)}, - ($arg: $curCls, $argListSymbol: Map[String, String], $extrasSymbol: Seq[String]) => - forge.discover.Router.validate(Seq(..$readArgs)) match{ - case forge.discover.Router.Result.Success(List(..$argNames)) => - forge.discover.Router.Result.Success($arg.${meth.name.toTermName}(..$argNameCasts)) - case x: forge.discover.Router.Result.Error => x - } - ) - """ - } - - def getAllRoutesForClass(curCls: Type): Iterable[c.universe.Tree] = { - for{ - t <- getValsOrMeths(curCls) - if t.returnType <:< typeOf[forge.define.Command[_]] - } yield { - extractMethod(t, curCls) - } - } -} - -- cgit v1.2.3