skinny.Skinny.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of skinny-framework_2.10 Show documentation
skinny-framework
There is a newer version: 2.5.2
Show newest version
package skinny

import skinny.micro.context.SkinnyContext
import skinny.micro.routing.Route
import skinny.micro.util.UrlGenerator

/**
 * Global object for accessing Skinny common APIs & request scope attributes in views.
 */
case class Skinny(
    context: SkinnyContext,
    requestScope: collection.mutable.Map[String, Any]
) {

  import skinny.controller.feature.RequestScopeFeature._

  def getAs[A](key: String): Option[A] = requestScope.get(key).map(_.asInstanceOf[A])

  def set(key: String, value: Any): Unit = requestScope.update(key, value)

  // getters are required for OGNL support (e.g. Thymeleaf template engine)

  def env: String = SkinnyEnv.get().orNull
  def getEnv = env

  def params: Params = getAs[Params](ATTR_PARAMS).orNull
  def getParams = params

  def multiParams: MultiParams = getAs[MultiParams](ATTR_MULTI_PARAMS).orNull
  def getMultiParams = multiParams

  def flash: Flash = getAs[Flash](ATTR_FLASH).orNull
  def getFlash = flash

  def errorMessages: Seq[String] = getAs[Seq[String]](ATTR_ERROR_MESSAGES).getOrElse(Nil)
  def getErrorMessages = errorMessages

  def keyAndErrorMessages: Map[String, Seq[String]] = getAs[Map[String, Seq[String]]](ATTR_KEY_AND_ERROR_MESSAGES).getOrElse(Map())
  def getKeyAndErrorMessages = keyAndErrorMessages

  def contextPath: String = getAs[String](ATTR_CONTEXT_PATH).orNull
  def getContextPath = contextPath

  def requestPath: String = getAs[String](ATTR_REQUEST_PATH).orNull
  def getRequestPath = requestPath

  def requestPathWithQueryString: String = getAs[String](ATTR_REQUEST_PATH_WITH_QUERY_STRING).orNull
  def getRequestPathWithQueryString = requestPathWithQueryString

  def csrfKey: String = getAs[String](ATTR_CSRF_KEY).orNull
  def getCsrfKey = csrfKey

  def csrfToken: String = getAs[String](ATTR_CSRF_TOKEN).orNull
  def getCsrfToken = csrfToken

  def csrfMetaTag: String = s""""""
  def csrfMetaTags: String = csrfMetaTag // Rails compatible
  def getCsrfMetaTag = csrfMetaTag

  def csrfHiddenInputTag: String = s""""""
  def getCsrfHiddenInputTag = csrfHiddenInputTag

  def i18n: I18n = getAs[I18n](ATTR_I18N).getOrElse(I18n())
  def getI18n = i18n

  /**
   * Skinny's utility for Scalatra reverse routing.
   * This method will make your view template simpler because
   * - no need to call #toString for params
   * - extract value from Option automatically
   */
  def url(route: Route, params: (String, Any)*): String = {
    // extract Option's raw value (basically Scalatra params returns Option value)
    def convertOptionalValue(v: Any): String = v match {
      case null => "" // Scalatra's UrlGenerator doesn't expect null value at least in Scalatra 2.2
      case None => ""
      case Some(v) => convertOptionalValue(v)
      case _ => v.toString
    }
    try {
      UrlGenerator.url(
        route,
        params
        .map { case (k, v) => k -> convertOptionalValue(v) }
        .filter { case (k, v) => k != null && v != null }
        .toMap[String, String],
        Nil
      )(context)
    } catch {
      case e: NullPointerException =>
        // work around for Scalatra issue 
        if (SkinnyEnv.isTest()) "[work around] see https://github.com/scalatra/scalatra/issues/368"
        else throw e
    }
  }

}