path: root/stage2/BasicBuild.scala

package cbt

import java.io._
import java.net._
import java.nio.file._

class BasicBuild(final val context: Context) extends BaseBuild
trait BaseBuild extends BuildInterface with DependencyImplementation with TriggerLoop with SbtDependencyDsl{
  //* DO NOT OVERRIDE CONTEXT in non-idempotent ways, because .copy and new Build
  // will create new instances given the context, which means operations in the
  // overrides will happen multiple times and if they are not idempotent stuff likely breaks
  def context: Context
  def moduleKey: String = "BaseBuild("+target.string+")"
  implicit def transientCache: java.util.Map[AnyRef,AnyRef] = context.transientCache

  object libraries{
    private def dep(name: String) = DirectoryDependency( context.cbtHome / "libraries" / name )
    def captureArgs = dep( "capture_args" )
    def eval = dep( "eval" )
    def proguard = dep( "proguard" )
  }

  // library available to builds
  implicit protected final val logger: Logger = context.logger
  implicit protected final val classLoaderCache: ClassLoaderCache = context.classLoaderCache
  implicit protected final val _context = context
  override protected final val lib: Lib = new Lib(logger)

  // ========== general stuff ==========

  def enableConcurrency = false
  def projectDirectory: File = lib.realpath(context.workingDirectory)
  assert( projectDirectory.exists, "projectDirectory does not exist: " ++ projectDirectory.string )
  assert(
    projectDirectory.getName =!= lib.buildDirectoryName ||
    {
      def transitiveInterfaces(cls: Class[_]): Vector[Class[_]] = cls.getInterfaces.toVector.flatMap(i => i +: transitiveInterfaces(i))
      transitiveInterfaces(this.getClass).contains(classOf[BuildBuildWithoutEssentials])
    },
    s"You need to extend ${lib.buildBuildClassName} in: " + projectDirectory + "/" ++ lib.buildDirectoryName
  )

  final def help: String = lib.usage(this.getClass, show)

  final def taskNames: String = lib.taskNames(this.getClass).sorted.mkString("\n")

  // ========== meta data ==========

  def defaultScalaVersion: String = constants.scalaVersion
  final def scalaVersion = context.scalaVersion getOrElse defaultScalaVersion
  final def scalaMajorVersion: String = lib.libMajorVersion(scalaVersion)
  def name = projectDirectory.getName

  // TODO: get rid of this in favor of newBuild.
  // currently blocked on DynamicOverride being not parts
  // of core but being part of plugin essentials while
  // callNullary in lib needing .copy .
  def copy(context: Context): BuildInterface =
    this.getClass
      .getConstructor(classOf[Context])
      .newInstance(context)
      .asInstanceOf[BuildInterface]

  def zincVersion = constants.zincVersion

  def dependencies: Seq[Dependency] =
    // FIXME: this should probably be removed
    Resolver( mavenCentral ).bind(
      "org.scala-lang" % "scala-library" % scalaVersion
    ) ++ ( if(localJars.nonEmpty) Seq( BinaryDependency(localJars, Nil) ) else Nil )

  // ========== paths ==========
  final private val defaultSourceDirectory = projectDirectory ++ "/src"

  /** base directory where stuff should be generated */
  def target: File = projectDirectory ++ "/target"
  /** base directory where stuff should be generated for this scala version*/
  def scalaTarget: File = target ++ s"/scala-$scalaMajorVersion"
  /** directory where jars (and the pom file) should be put */
  def jarTarget: File = scalaTarget
  /** directory where the scaladoc should be put */
  def docTarget: File = scalaTarget ++ "/api"
  /** directory where the class files should be put (in package directories) */
  def compileTarget: File = scalaTarget ++ "/classes"
  /**
  File which cbt uses to determine if it needs to trigger an incremental re-compile.
  Last modified date is the time when the last successful compilation started.
  Contents is the cbt version git hash.
  */
  def compileStatusFile: File = compileTarget ++ ".last-success"

  def generatedSources: Seq[File] = Seq( projectDirectory / "src_generated" ).filter( _.exists )
  /** Source directories and files. Defaults to .scala and .java files in src/ and top-level. */
  def sources: Seq[File] = (
    Seq(defaultSourceDirectory)
    ++ generatedSources
    ++ projectDirectory.listFiles.toVector.filter(sourceFileFilter)
  )

  /** Which file endings to consider being source files. */
  def sourceFileFilter(file: File) = lib.sourceFileFilter(file)

  /** Absolute path names for all individual files found in sources directly or contained in directories. */
  final def sourceFiles: Seq[File] = lib.sourceFiles(sources, sourceFileFilter)
  final def nonEmptySourceFiles: Seq[File] =
    if(sourceFiles.isEmpty) {
      throw new RuntimeException( "no source files found" )
    } else sourceFiles

  {
    val nonExisting = sources.filterNot( _.exists ).diff( Seq(defaultSourceDirectory) )
    if( nonExisting.nonEmpty )
      logger.stage2("Some sources do not exist: \n"++nonExisting.mkString("\n"))
  }

  def Resolver( urls: URL* ) = MavenResolver( context.cbtLastModified, context.paths.mavenCache, urls: _* )

  def ScalaDependency(
    groupId: String, artifactId: String, version: String, classifier: Classifier = Classifier.none,
    scalaVersion: String = scalaMajorVersion, verifyHash: Boolean = true
  ) = lib.ScalaDependency( groupId, artifactId, version, classifier, scalaVersion, verifyHash )

  final def DirectoryDependency(path: File, pathToNestedBuild: String*) = cbt.DirectoryDependency(
    context.copy( workingDirectory = path ),
    pathToNestedBuild: _*
  )

  def triggerLoopFiles: Set[File] = (
    context.triggerLoopFiles
    ++ sources
    ++ transitiveDependencies.collect{ case b: TriggerLoop => b.triggerLoopFiles }.flatten
  )

  def localJars: Seq[File] =
    Seq(projectDirectory ++ "/lib")
      .filter(_.exists)
      .flatMap(_.listFiles)
      .filter(_.toString.endsWith(".jar"))

  override def dependencyClasspath : ClassPath = super.dependencyClasspath

  protected def compileDependencies: Seq[Dependency] = dependencies
  final def compileClasspath : ClassPath = Dependencies(compileDependencies).classpath

  def resourceClasspath: ClassPath = {
    val resourcesDirectory = projectDirectory ++ "/resources"
    ClassPath(Seq(resourcesDirectory).filter(_.exists))
  }
  def exportedClasspath: ClassPath = {
    compile
    ClassPath(Seq(compileTarget).filter(_.exists)) ++ resourceClasspath
  }
  def targetClasspath = ClassPath(Seq(compileTarget))
  // ========== compile, run, test ==========

  /** scalac options used for zinc and scaladoc */
  def scalacOptions: Seq[String] = Seq(
    "-feature",
    "-deprecation",
    "-unchecked"
  )

  final def lastModified: Long = compile.getOrElse(0L)

  def compile: Option[Long] = taskCache[BaseBuild]("_compile").memoize{
    lib.compile(
      context.cbtLastModified,
      sourceFiles, compileTarget, compileStatusFile, compileDependencies,
      context.paths.mavenCache, scalacOptions,
      zincVersion = zincVersion, scalaVersion = scalaVersion
    )
  }

  def scaladoc = taskCache[BaseBuild]("scaladoc").memoize{
    lib.scaladoc(
      context.cbtLastModified,
      scalaVersion, sourceFiles, compileClasspath, docTarget,
      scalacOptions, context.paths.mavenCache
    )
  }

  def cleanFiles: Seq[File] = Seq( target )

  def clean: ExitCode = {
    lib.clean(
      cleanFiles,
      context.args.contains("force"),
      context.args.contains("dry-run"),
      context.args.contains("list"),
      context.args.contains("help")
    )
  }

  def repl: ExitCode = {
    lib.consoleOrFail("Use `cbt direct repl` instead")

    val colorized = "scala.color"
    if(Option(System.getProperty(colorized)).isEmpty) {
      // set colorized REPL, if user didn't pass own value
      System.setProperty(colorized, "true")
    }

    val scalac = new ScalaCompilerDependency(context.cbtLastModified, context.paths.mavenCache, scalaVersion)
    scalac.runMain(
      "scala.tools.nsc.MainGenericRunner",
      Seq(
        "-bootclasspath",
        scalac.classpath.string,
        "-classpath",
        classpath.string
      ) ++ context.args
    )
  }

  def run: ExitCode = run( context.args: _* )
  def test: Dependency = {
    val testDirectory = projectDirectory / "test"
    if( (testDirectory / lib.buildDirectoryName / lib.buildFileName).exists ){
      // FIYME: maybe we can make loadRoot(...).finalBuild an Option some
      DirectoryDependency( testDirectory )
    } else {
      new BasicBuild( context.copy(workingDirectory = testDirectory) ){
        override def dependencies = Seq(
          DirectoryDependency(projectDirectory++"/..")
        )
        def apply = run
      }
    }
  }
  def t: Any = lib.callReflective( test, Some("run"), context )
  def rt = recursiveUnsafe(Some("test.run"))

  def recursiveSafe(_run: BuildInterface => Any): ExitCode = {
    val builds = (this +: transitiveDependencies).collect{
      case b: BuildInterface => b
    }
    val results = builds.map(_run)
    if(
      results.forall{
        case Some(_:ExitCode) => true
        case None => true
        case _:ExitCode => true
        case other => false
      }
    ){
      if(
        results.collect{
          case Some(c:ExitCode) => c
          case c:ExitCode => c
        }.filter(_ != 0)
         .nonEmpty
      ) ExitCode.Failure
      else ExitCode.Success
    } else ExitCode.Success
  }

  def recursive: ExitCode = {
    recursiveUnsafe(context.args.lift(1))
  }

  def recursiveUnsafe(code: Option[String]): ExitCode = {
    recursiveSafe{
      b =>
      System.err.println(b.show)
      lib.trapExitCode{ // FIXME: trapExitCode does not seem to work here
        try{
          lib.callReflective(b,code,context)
          ExitCode.Success
        } catch {
          case e: Throwable => println(e.getClass); throw e
        }
      }
      ExitCode.Success
    }
  }

  def c = compile
  def r = run

  /*
  context.logger.composition(">"*80)
  context.logger.composition("class   " ++ this.getClass.toString)
  context.logger.composition("dir     " ++ projectDirectory.string)
  context.logger.composition("sources " ++ sources.toList.mkString(" "))
  context.logger.composition("target  " ++ target.string)
  context.logger.composition("context " ++ context.toString)
  context.logger.composition("dependencyTree\n" ++ dependencyTree)
  context.logger.composition("<"*80)
  */

  // ========== cbt internals ==========
  @deprecated("use finalbuild(File)","")
  def finalBuild: BuildInterface = this
  override def finalBuild( current: File ): BuildInterface = {
    //assert( current.getCanonicalFile == projectDirectory.getCanonicalFile, s"$current == $projectDirectory" )
    this
  }
  override def show = this.getClass.getSimpleName ++ "(" ++ projectDirectory.string ++ ")"

  override def toString = show
  // a method that can be called only to trigger any side-effects
  final def void = ""

  final override def transitiveDependencies: Seq[Dependency] =
    taskCache[BaseBuild]( "transitiveDependencies" ).memoize{
      val res = super.transitiveDependencies
      val duplicateBuilds = res.collect{
        case b: BaseBuild => b
      }.groupBy(
        b => ( b.projectDirectory, b.moduleKey )
      ).filter( _._2.size > 1 ).mapValues(_.map(_.getClass))
      duplicateBuilds.foreach{ case ((projectDirectory, moduleKey), classes) =>
        assert(
          classes.distinct.size == 1,
          "multiple builds found for\nprojectDirectory: $projectDirectory\nmoduleKey: $moduleKey\nbut different classes: " + classes.mkString(", ")
        )
      }
      res
    }


  @deprecated("use the MultipleScalaVersions plugin instead","")
  final def crossScalaVersionsArray = Array(scalaVersion)

  def publish: Seq[URL] = Seq()

  def loop = {
    lib.callReflective(this, context.args.headOption, context.copy(args=context.args.drop(1)))
    val files = triggerLoopFiles
    lib.watch{ () =>
      logger.loop("Looping change detection over:\n - "++files.mkString("\n - "))
      files
    }()
    context.loopFile.getParentFile.mkdirs
    lib.write( context.loopFile, files.mkString("\n"), StandardOpenOption.CREATE )

    ExitCode(253) // signal bash script to restart
  }
}