Merge pull request #9 from zalando/#8-Configuration-in-controller

#8, refactor: Added configuration parameter to the controller

Author: slavaschmidt

api/src/main/scala/de/zalando/play/controllers/PlayBodyParsing.scala

@@ -91,8 +91,11 @@ object PlayBodyParsing extends PlayBodyParsing {
     bytes: ByteString, mediaType: Option[MediaType]
   )(implicit tag: ClassTag[T]): T = {
     val mimeTypeName = mimeType(mediaType)
-    val jacksonParser: Parser[T] =
-      byteString => jacksonMapper(mimeTypeName).readValue(bytes.toArray, tag.runtimeClass.asInstanceOf[Class[T]])
+    val jacksonParser: Parser[T] = byteString =>
+      if (tag.runtimeClass == classOf[String]) new String(byteString.toArray).asInstanceOf[T]
+      else if (tag.runtimeClass == classOf[BinaryString]) BinaryString.byteArray2binaryString(byteString.toArray).asInstanceOf[T]
+      else if (tag.runtimeClass == classOf[Base64String]) Base64String.fromBytes(byteString.toArray).asInstanceOf[T]
+      else jacksonMapper(mimeTypeName).readValue(bytes.toArray, tag.runtimeClass.asInstanceOf[Class[T]])
     // TODO default play parsers could be used here as well
     val parser = customParsers.find(_._1 == mimeTypeName).map(_._2).getOrElse {
       jacksonParser

api/src/main/scala/de/zalando/play/controllers/WriterFactories.scala

@@ -8,7 +8,6 @@ import com.fasterxml.jackson.dataformat.yaml.YAMLFactory
  */
 object WriterFactories {
   private val jsonFactory = new JsonFactory()
-
   /**
    * Contains proper Jackson Factories for different mime types
    * JsonFactory is a default

api/src/main/scala/de/zalando/play/controllers/stringWrappers.scala

@@ -13,9 +13,16 @@ case class Base64String(value: String) {
 
 object Base64String {
   implicit def string2base64string(s: String): Base64String =
-    Base64String(new String(Base64.getEncoder.encode(s.getBytes)))
+    fromBytes(s.getBytes)
+
   implicit def base64string2string(s: Base64String): String =
-    new String(Base64.getDecoder.decode(s.value))
+    new String(toBytes(s))
+
+  def toBytes(s: Base64String): Array[Byte] =
+    Base64.getDecoder.decode(s.value)
+
+  def fromBytes(b: Array[Byte]): Base64String =
+    Base64String(new String(Base64.getEncoder.encode(b)))
 }
 
 case class BinaryString(value: Array[Byte])

build.sbt

@@ -4,7 +4,7 @@ import sbt._
 val PlayVersion = "2.5.4"
 val Scala10 = "2.10.5"
 val Scala11 = "2.11.8"
-val ProjectVersion = "0.1.13"
+val ProjectVersion = "0.1.14"
 
 val deps = new Dependencies(PlayVersion, ProjectVersion)
 

play-scala-generator/src/main/resources/model.mustache

@@ -51,7 +51,7 @@ package {{main_package_suffix}} {
 {{/for}}
 
 {{for enum in enums}}
-    case class {{enum.name}}(value: {{enum.type_name}}) {
+    case class {{enum.name}}(value: {{enum.type_name}}) extends AnyVal {
         override def toString = value.toString
     }
 {{/for}}

play-scala-generator/src/main/resources/play_scala_controller.mustache

@@ -13,7 +13,10 @@ import {{import.name}}
 {{for controller in controllers}}
 package {{controller.effective_package}} {
 
-    class {{controller.controller}} extends {{controller.base}} {
+    class {{controller.controller}} @Inject() (lifecycle: ApplicationLifecycle, config: ConfigurationProvider) extends {{controller.base}} {
+        {{controller.start_comment}}
+{{controller.constructor_code}}
+        {{controller.end_comment}}
     {{for method in controller.methods}}
         val {{method.method}} = {{method.action}} { {{for sp in method.single_parameter}}({{sp.field_name}}: {{sp.type_name}}) =>{{/for}}{{if method.multiple_parameters}}input: ({{for p in method.multiple_parameters}}{{p.type_name}}{{if p.isNotLast}}, {{/if}}{{/for}}) =>
             val ({{for p in method.multiple_parameters}}{{p.field_name}}{{if p.isNotLast}}, {{/if}}{{/for}}) = input{{else}}{{if method.single_parameter}} {{else}} _ => {{/if}} {{/if}}

play-scala-generator/src/main/scala/de/zalando/apifirst/generators/controllersStep.scala

@@ -10,13 +10,14 @@ import de.zalando.apifirst.StringUtil._
 import de.zalando.apifirst.generators.DenotationNames._
 import de.zalando.apifirst.naming.Reference
 import org.slf4j.Logger
+import ControllersCommons._
 
 /**
  * @author slasch
  * @since 31.12.2015.
  */
 trait CallControllersStep extends EnrichmentStep[ApiCall]
-    with ControllersCommons with SecurityCommons with ActionResults with ParameterData {
+    with SecurityCommons with ActionResults with ParameterData {
 
   def log: Logger
 
@@ -183,17 +184,19 @@ trait CallControllersStep extends EnrichmentStep[ApiCall]
 
 }
 
-object PlayScalaControllerAnalyzer extends ControllersCommons {
+object PlayScalaControllerAnalyzer {
 
   case class UnmanagedPart(marker: ApiCall, relevantCode: Seq[String])
 
   val controllerImports = Seq(
     "play.api.mvc.{Action, Controller}",
     "play.api.data.validation.Constraint",
+    "play.api.inject.{ApplicationLifecycle,ConfigurationProvider}",
     "de.zalando.play.controllers._",
     "PlayBodyParsing._",
     "PlayValidations._",
-    "scala.util._"
+    "scala.util._",
+    "javax.inject._"
   )
 
   def analyzeController(calls: Seq[ApiCall], codeParts: Map[String, Seq[String]]): Map[ApiCall, UnmanagedPart] =
@@ -217,7 +220,9 @@ object PlayScalaControllerAnalyzer extends ControllersCommons {
     }.toSeq.flatten
 
   def collectImplementations(currentVersion: Seq[String], start: String, end: String): Map[String, Seq[String]] = {
-    val actionIndexes = currentVersion.zipWithIndex.filter(_._1.trim.startsWith(start)).map { case (line, idx) => line.replace(start, "") -> idx }
+    val actionIndexes = currentVersion.zipWithIndex.filter(_._1.trim.startsWith(start)).map {
+      case (line, idx) => line.replace(start, "") -> idx
+    }
     val codeParts = actionIndexes map {
       case (action, idx) =>
         val fromStart = currentVersion.drop(idx)
@@ -269,12 +274,15 @@ trait ParameterData {
 
 }
 
-trait ControllersCommons {
+object ControllersCommons {
 
   val controllersSuffix = "Action"
   val formParserSuffix = "ParseForm"
 
   val eof = "// ----- End of unmanaged code area for action "
   val sof = "// ----- Start of unmanaged code area for action "
 
+  val ceof = "// ----- End of unmanaged code area for constructor "
+  val csof = "// ----- Start of unmanaged code area for constructor "
+
 }

play-scala-generator/src/main/scala/de/zalando/apifirst/generators/playScala.scala

@@ -7,6 +7,7 @@ import de.zalando.apifirst.generators.DenotationNames.DenotationTable
 import PlayScalaControllerAnalyzer._
 import de.zalando.apifirst.StringUtil
 import org.slf4j.LoggerFactory
+import ControllersCommons._
 
 import scala.collection.Iterable
 
@@ -106,6 +107,7 @@ class ScalaGenerator(
     nonEmptyTemplate(fileName, packageName, templateName, currentController)
   }
 
+  //noinspection ScalaStyle
   private def nonEmptyTemplate(fileName: String, packageName: String, templateName: String, currentController: String): String = {
 
     assert(packageName.contains('-') == packageName.contains('`'), packageName)
@@ -144,7 +146,14 @@ class ScalaGenerator(
     val securityExtractors = ReShaper.filterByType("security_extractors", denotationTable)
     val extractors = ReShaper.groupByType(securityExtractors.toSeq).toMap
 
-    val codeParts = collectImplementations(currentController.split("\n"), sof, eof)
+    val controllerLines = currentController.split("\n")
+    val codeParts = collectImplementations(controllerLines, sof, eof)
+    val constructors = collectImplementations(controllerLines, csof, ceof)
+
+    val constructorCode = constructors map {
+      case (k, v) =>
+        k -> v.filterNot(l => l.trim.startsWith(csof) || l.trim.startsWith(ceof)).mkString("\n")
+    } withDefaultValue ""
 
     val unmanagedParts = analyzeController(modelCalls, codeParts)
 
@@ -169,7 +178,8 @@ class ScalaGenerator(
       "form_parsers_required" -> formParsersRequired
     )
 
-    val controllersList = PlayScalaControllersGenerator.controllers(modelCalls, unmanagedParts, pckg, deadCode)(denotationTable)
+    val controllersList = PlayScalaControllersGenerator.
+      controllers(modelCalls, unmanagedParts, pckg, deadCode, constructorCode)(denotationTable)
 
     val stdImports = standardImports(modelTypes).map(i => Map("name" -> i))
 
@@ -262,7 +272,7 @@ object PlayScalaControllersGenerator {
   val securityTraitSuffix = "Security"
 
   def controllers(allCalls: Seq[ApiCall], unmanagedParts: Map[ApiCall, UnmanagedPart], packageName: String,
-    deadCode: Map[String, String])(table: DenotationTable): Iterable[Map[String, Object]] = {
+    deadCode: Map[String, String], constructorCode: Map[String, String])(table: DenotationTable): Iterable[Map[String, Object]] = {
     allCalls groupBy { c =>
       (c.handler.packageName, c.handler.controller)
     } map {
@@ -280,13 +290,17 @@ object PlayScalaControllersGenerator {
           case (k, v) =>
             Map("name" -> k, "code" -> v)
         }
+        val controllerName = escape(controller._2)
         Map(
           "effective_package" -> packageName,
-          "controller" -> escape(controller._2),
+          "controller" -> controllerName,
           "base" -> escape(controller._2 + baseControllersSuffix),
           "methods" -> methods,
           "security_trait" -> securityTrait,
-          "dead_code" -> deadCodeParts
+          "dead_code" -> deadCodeParts,
+          "start_comment" -> (csof + controllerName),
+          "end_comment" -> (ceof + controllerName),
+          "constructor_code" -> constructorCode(controller._2)
         )
     }
   }

play-scala-generator/src/test/resources/expected_results/controllers/basic_auth_api_yaml.scala

@@ -3,6 +3,8 @@ import play.api.mvc.{Action, Controller}
 
 import play.api.data.validation.Constraint
 
+import play.api.inject.{ApplicationLifecycle,ConfigurationProvider}
+
 import de.zalando.play.controllers._
 
 import PlayBodyParsing._
@@ -11,6 +13,8 @@ import PlayValidations._
 
 import scala.util._
 
+import javax.inject._
+
 
 /**
  * This controller is re-generated after each change in the specification.
@@ -19,7 +23,9 @@ import scala.util._
 
 package basic.auth.api.yaml {
 
-    class BasicAuthApiYaml extends BasicAuthApiYamlBase {
+    class BasicAuthApiYaml @Inject() (lifecycle: ApplicationLifecycle, config: ConfigurationProvider) extends BasicAuthApiYamlBase {
+    // ----- Start of unmanaged code area for constructor BasicAuthApiYaml
+    // ----- End of unmanaged code area for constructor BasicAuthApiYaml
         val get = getAction {  _ =>  
             // ----- Start of unmanaged code area for action  BasicAuthApiYaml.get
             NotImplementedYet

play-scala-generator/src/test/resources/expected_results/controllers/basic_polymorphism_yaml.scala

@@ -3,6 +3,8 @@ import play.api.mvc.{Action, Controller}
 
 import play.api.data.validation.Constraint
 
+import play.api.inject.{ApplicationLifecycle,ConfigurationProvider}
+
 import de.zalando.play.controllers._
 
 import PlayBodyParsing._
@@ -11,6 +13,8 @@ import PlayValidations._
 
 import scala.util._
 
+import javax.inject._
+
 
 /**
  * This controller is re-generated after each change in the specification.
@@ -19,7 +23,12 @@ import scala.util._
 
 package basic_polymorphism.yaml {
 
-    class Basic_polymorphismYaml extends Basic_polymorphismYamlBase {
+    class Basic_polymorphismYaml @Inject() (lifecycle: ApplicationLifecycle, config: ConfigurationProvider) extends Basic_polymorphismYamlBase {
+        // ----- Start of unmanaged code area for constructor Basic_polymorphismYaml
+        lifecycle.addStopHook {() =>
+            Future.successful(println("Shutting down"))
+        }
+        // ----- End of unmanaged code area for constructor Basic_polymorphismYaml
         val put = putAction { (dummy: PutDummy) =>  
             // ----- Start of unmanaged code area for action  Basic_polymorphismYaml.put
             NotImplementedYet