play.routes.compiler.RoutesCompiler.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of play-routes-compiler_3 Show documentation
Play-Routes-Compiler
There is a newer version: 3.0.6
Show newest version
/*
 * Copyright (C) from 2022 The Play Framework Contributors , 2011-2021 Lightbend Inc. 
 */

package play.routes.compiler

import java.io.File
import java.nio.charset.Charset
import java.nio.charset.MalformedInputException
import java.nio.file.Files

import scala.collection.JavaConverters._
import scala.io.Codec

/**
 * provides a compiler for routes
 */
object RoutesCompiler {
  private val LineMarker = "\\s*// @LINE:\\s*(\\d+)\\s*".r

  /**
   * A source file that's been generated by the routes compiler
   */
  trait GeneratedSource {

    /**
     * The original source file associated with this generated source file, if known
     */
    def source: Option[File]

    /**
     * Map the generated line to the original source file line, if known
     */
    def mapLine(generatedLine: Int): Option[Int]
  }

  object GeneratedSource {
    def unapply(file: File): Option[GeneratedSource] = {
      val lines: Array[String] = if (file.exists) {
        try {
          Files.readAllLines(file.toPath, Charset.forName(implicitly[Codec].name)).asScala.toArray[String]
        } catch {
          // We can't read the file with the given charset: That means the file was definitely not generated by the
          // routes compiler - which uses exactly the same charset to write the file like we just used to read the file.
          // (Using the same charset for writing and reading will never throw a MalformedInputException)
          // And because we are looking for a line inside the file (see below) that only the routes compiler generates,
          // we don't even need to process the file to look for that line (...because we now already know that
          // the generator of the file definitely wasn't the routes compiler, otherwise the charsets would match...)
          case _: MalformedInputException => Array.empty[String]
        }
      } else {
        Array.empty[String]
      }

      if (lines.contains("// @GENERATOR:play-routes-compiler")) {
        Some(new GeneratedSource {
          val source: Option[File] =
            lines.find(_.startsWith("// @SOURCE:")).map(m => new File(m.trim.drop(11)))

          def mapLine(generatedLine: Int): Option[Int] = {
            lines.view.take(generatedLine).reverse.collectFirst {
              case LineMarker(line) => Integer.parseInt(line)
            }
          }
        })
      } else {
        None
      }
    }
  }

  /**
   * A routes compiler task.
   *
   * @param file The routes file to compile.
   * @param additionalImports The additional imports.
   * @param forwardsRouter Whether a forwards router should be generated.
   * @param reverseRouter Whether a reverse router should be generated.
   * @param jsReverseRouter Whether a JavaScript reverse router should be generated.
   * @param namespaceReverseRouter Whether the reverse router should be namespaced.
   */
  case class RoutesCompilerTask(
      file: File,
      additionalImports: Seq[String],
      forwardsRouter: Boolean,
      reverseRouter: Boolean,
      jsReverseRouter: Boolean,
      namespaceReverseRouter: Boolean
  ) {
    def this(
        file: File,
        additionalImports: Seq[String],
        forwardsRouter: Boolean,
        reverseRouter: Boolean,
        namespaceReverseRouter: Boolean
    ) = this(file, additionalImports, forwardsRouter, reverseRouter, true, namespaceReverseRouter)
  }

  /**
   * Compile the given routes file
   *
   * @param task The routes compilation task
   * @param generator The routes generator
   * @param generatedDir The directory to place the generated source code in
   * @return Either the list of files that were generated (right) or the routes compilation errors (left)
   */
  def compile(
      task: RoutesCompilerTask,
      generator: RoutesGenerator,
      generatedDir: File
  ): Either[Seq[RoutesCompilationError], Seq[File]] = {
    val namespace = Option(task.file.getName)
      .filter(_.endsWith(".routes"))
      .map(_.dropRight(".routes".size))
      .orElse(Some("router"))

    val routeFile = task.file.getAbsoluteFile

    RoutesFileParser.parse(routeFile).map { rules =>
      val generated = generator.generate(task, namespace, rules)
      generated.map {
        case (filename, content) =>
          val file = new File(generatedDir, filename)
          if (!file.exists()) {
            file.getParentFile.mkdirs()
            file.createNewFile()
          }
          Files.write(file.toPath, content.getBytes(implicitly[Codec].name))
          file
      }
    }
  }
}