Merge pull request #84 from AVSystem/adt-metadata

ADT metadata & OpenAPI generation for REST

Author: ghik

build.sbt

@@ -175,11 +175,13 @@ def sourceDirsSettings(baseMapper: File => File) = Seq(
 )
 
 lazy val `commons-annotations` = project
+  .dependsOn(`commons-macros`)
   .settings(jvmCommonSettings)
 
 lazy val `commons-annotations-js` = project.in(`commons-annotations`.base / "js")
   .enablePlugins(ScalaJSPlugin)
   .configure(p => if (forIdeaImport) p.dependsOn(`commons-annotations`) else p)
+  .dependsOn(`commons-macros`)
   .settings(
     jsCommonSettings,
     name := (name in `commons-annotations`).value,

commons-akka/src/main/scala/com/avsystem/commons/rpc/akka/AkkaRPCFramework.scala

@@ -5,9 +5,10 @@ import java.io.{DataInputStream, DataOutputStream}
 
 import akka.actor.{ActorRef, ActorSystem}
 import akka.util.ByteString
+import com.avsystem.commons.meta._
+import com.avsystem.commons.rpc._
 import com.avsystem.commons.rpc.akka.client.ClientRawRPC
 import com.avsystem.commons.rpc.akka.server.ServerActor
-import com.avsystem.commons.rpc.{FunctionRPCFramework, GetterRPCFramework, MetadataAnnotation, ProcedureRPCFramework, RpcMetadataCompanion, TypedMetadata, infer, multi, reifyAnnot, reifyName, verbatim}
 import com.avsystem.commons.serialization.{GenCodec, StreamInput, StreamOutput}
 import monix.reactive.Observable
 
@@ -31,10 +32,10 @@ object AkkaRPCFramework extends GetterRPCFramework with ProcedureRPCFramework wi
   case class RPCMetadata[T](
     @reifyName name: String,
     @reifyAnnot @multi annotations: List[MetadataAnnotation],
-    @multi @verbatim procedureSignatures: Map[String, ProcedureSignature],
-    @multi functionSignatures: Map[String, FunctionSignature[_]],
-    @multi observeSignatures: Map[String, ObserveSignature[_]],
-    @multi getterSignatures: Map[String, GetterSignature[_]]
+    @multi @verbatim @rpcMethodMetadata procedureSignatures: Map[String, ProcedureSignature],
+    @multi @rpcMethodMetadata functionSignatures: Map[String, FunctionSignature[_]],
+    @multi @rpcMethodMetadata observeSignatures: Map[String, ObserveSignature[_]],
+    @multi @rpcMethodMetadata getterSignatures: Map[String, GetterSignature[_]]
   )
   object RPCMetadata extends RpcMetadataCompanion[RPCMetadata]
 

commons-akka/src/main/scala/com/avsystem/commons/rpc/akka/MonixRPCFramework.scala

@@ -1,6 +1,7 @@
 package com.avsystem.commons
 package rpc.akka
 
+import com.avsystem.commons.meta._
 import com.avsystem.commons.rpc._
 import monix.reactive.Observable
 

commons-annotations/src/main/scala/com/avsystem/commons/annotation/NotInheritedFromSealedTypes.scala

@@ -0,0 +1,11 @@
+package com.avsystem.commons
+package annotation
+
+import scala.annotation.StaticAnnotation
+
+/**
+  * Marker trait for annotations which don't want to be inherited by subtypes
+  * of a sealed trait or class that has this annotation applied. Intended for annotations that should apply
+  * only to the sealed trait itself.
+  */
+trait NotInheritedFromSealedTypes extends StaticAnnotation

commons-annotations/src/main/scala/com/avsystem/commons/annotation/positioned.scala

@@ -0,0 +1,16 @@
+package com.avsystem.commons
+package annotation
+
+import scala.annotation.StaticAnnotation
+
+/**
+  * Annotate a symbol (i.e. class, method, parameter, etc.) with `@positioned(positioned.here)` to retain source
+  * position information for that symbol to be available in macro implementations which inspect that symbol.
+  * This is necessary e.g. for determining declaration order of subtypes of sealed hierarchies in macro implementations.
+  * This annotation is only needed when macro is invoked in a different source file than the source file of inspected
+  * symbol. If macro is invoked in the same file, source position is always available.
+  */
+class positioned(val point: Int) extends StaticAnnotation
+object positioned {
+  def here: Int = macro macros.misc.MiscMacros.posPoint
+}

commons-annotations/src/main/scala/com/avsystem/commons/meta/metaAnnotations.scala

@@ -1,6 +1,8 @@
 package com.avsystem.commons
 package serialization
 
+import com.avsystem.commons.annotation.NotInheritedFromSealedTypes
+
 import scala.annotation.StaticAnnotation
 
 /**
@@ -24,4 +26,5 @@ import scala.annotation.StaticAnnotation
   * For instance, if a case class field overrides a method of some base trait, the `@name` annotation may
   * be used on that method and will affect the case class field.
   */
-class name(val name: String) extends StaticAnnotation
+class name(val name: String) extends StaticAnnotation with NotInheritedFromSealedTypes
+

commons-annotations/src/main/scala/com/avsystem/commons/rpc/rpcAnnotations.scala

@@ -176,12 +176,35 @@ object SharedExtensions extends SharedExtensions {
     def optRef: OptRef[A] = OptRef(a)
   }
 
+  private val RemovableLineBreak = "\\n+".r
+
   class StringOps(private val str: String) extends AnyVal {
     def ensureSuffix(suffix: String): String =
       if (str.endsWith(suffix)) str else str + suffix
 
     def ensurePrefix(prefix: String): String =
       if (str.startsWith(prefix)) str else prefix + str
+
+    def uncapitalize: String =
+      if (str.isEmpty || str.charAt(0).isLower) str
+      else str.charAt(0).toLower + str.substring(1)
+
+    /**
+      * Removes a newline character from every sequence of consecutive newline characters. If the sequence contained
+      * just one newline character without any whitespace before and after it, a space is inserted.
+      *
+      * e.g. `My hovercraft\nis full of eels.\n\nMy hovercraft is\n full of eels.` becomes
+      * `My hovercraft is full of eels.\nMy hovercraft is full of eels.`
+      *
+      * Useful for multi-line string literals with lines wrapped in source code but without intention of including
+      * these line breaks in actual runtime string.
+      */
+    def unwrapLines: String =
+      RemovableLineBreak.replaceAllIn(str, { m =>
+        val insertSpace = m.end == m.start + 1 && m.start - 1 >= 0 && m.end < str.length &&
+          !Character.isWhitespace(str.charAt(m.start - 1)) && !Character.isWhitespace(str.charAt(m.end))
+        if (insertSpace) " " else m.matched.substring(1)
+      })
   }
 
   class IntOps(private val int: Int) extends AnyVal {

commons-annotations/src/main/scala/com/avsystem/commons/serialization/name.scala

@@ -0,0 +1,11 @@
+package com.avsystem.commons
+package meta
+
+import com.avsystem.commons.macros.meta.AdtMetadataMacros
+import com.avsystem.commons.misc.MacroGenerated
+
+trait AdtMetadataCompanion[M[_]] extends MetadataCompanion[M] {
+  def materialize[T]: M[T] = macro AdtMetadataMacros.materialize[T]
+
+  implicit def materializeMacroGenerated[T]: MacroGenerated[M[T]] = macro AdtMetadataMacros.materializeMacroGenerated[T]
+}