com.carrotgarden.maven.scalor.DocumentMojo.scala Maven / Gradle / Ivy

Go to download
package com.carrotgarden.maven.scalor

import org.apache.maven.plugin.AbstractMojo
import org.apache.maven.plugins.annotations._
import org.apache.maven.execution.MavenSession
import org.apache.maven.project.MavenProject
import org.apache.maven.plugin.BuildPluginManager
import org.apache.maven.plugin.MojoFailureException
import org.sonatype.plexus.build.incremental.BuildContext

import com.carrotgarden.maven.tools.Description

import A.mojo._
import org.apache.maven.reporting.MavenReport
import java.io.File
import java.util.Locale
import org.codehaus.doxia.sink.Sink

import util.Folder._
import org.apache.maven.archiver.MavenArchiver
import java.nio.file.Paths
import org.codehaus.plexus.archiver.jar.JarArchiver

/**
 *  Shared interface for site report mojo.
 */
trait ReportAnyMojo extends AbstractMojo
  with base.Mojo
  with base.Params
  with base.Logging
  with base.SkipMojo
  //
  with MavenReport
  with document.ReportAny {

  @Description( """
  Flag to skip document execution: report-*.
  """ )
  @Parameter(
    property     = "scalor.skipReport", //
    defaultValue = "false"
  )
  var skipReport : Boolean = _

  def performReport() : Unit = {
    logger.info( s"TODO TODO TODO" )
  }

  override def perform() : Unit = {
    if ( skipReport || hasSkipMojo ) {
      reportSkipReason( "Skipping disabled goal execution." )
      return
    }
    performReport
  }

}

@Description( """
Produce Scaladoc site report for all compilation scopes.
Invokes goals: report-*
""" )
@Mojo(
  name                         = A.mojo.`report`,
  defaultPhase                 = LifecyclePhase.PACKAGE,
  requiresDependencyResolution = ResolutionScope.TEST
)
class ReportArkonMojo extends ReportAnyMojo
  with document.ReportMain {

  override def mojoName = A.mojo.`report`

  override def performReport() : Unit = {
    executeSelfMojo( A.mojo.`report-main` )
    executeSelfMojo( A.mojo.`report-test` )
  }

}

@Description( """
Produce Scaladoc site report for compilation scope=[macro,main].
A member of goal=report.
""" )
@Mojo(
  name                         = A.mojo.`report-main`,
  defaultPhase                 = LifecyclePhase.PACKAGE,
  requiresDependencyResolution = ResolutionScope.COMPILE
)
class ReportMainMojo extends ReportAnyMojo
  with document.ReportMain {

  override def mojoName = A.mojo.`report-main`

  @Description( """
  Flag to skip goal execution: report-main.
  """ )
  @Parameter(
    property     = "scalor.skipReportMain", //
    defaultValue = "false"
  )
  var skipReportMain : Boolean = _

  override def hasSkipMojo = skipReportMain

}

@Description( """
Produce Scaladoc site report for compilation scope=[test].
A member of goal=report.
""" )
@Mojo(
  name                         = A.mojo.`report-test`,
  defaultPhase                 = LifecyclePhase.PACKAGE,
  requiresDependencyResolution = ResolutionScope.TEST
)
class ReportTestMojo extends ReportAnyMojo
  with document.ReportTest {

  override def mojoName = A.mojo.`report-test`

  @Description( """
  Flag to skip goal execution: report-test.
  """ )
  @Parameter(
    property     = "scalor.skipReportTest", //
    defaultValue = "false"
  )
  var skipReportTest : Boolean = _

  override def hasSkipMojo = skipReportTest

}

/**
 *  Shared interface for Scaladoc mojo.
 */
trait ScaladocAnyMojo extends AbstractMojo
  //
  with document.Params
  with document.ScaladocAny
  with document.ScaladocRegex
  //
  with base.Mojo
  with base.Params
  with base.Logging
  with base.SkipMojo
  //
  with base.Dir
  with base.Build
  with base.ParamsCompiler
  with resolve.Maven
  with zinc.Params
  with zinc.Compiler
  with zinc.Resolve {

  @Description( """
  Flag to skip document execution: scaladoc-*.
  """ )
  @Parameter(
    property     = "scalor.skipScaladoc", //
    defaultValue = "false"
  )
  var skipScaladoc : Boolean = _

  /**
   * Generate scaladoc content folder.
   */
  def performScaladoc() : Unit = {
    val folder = scaladocOutputFolder
    val options = Seq()
    logger.info( s"Generating Scaladoc: ${folder}" )
    ensureFolder( folder )
    zincPerformDocument( folder, options )
  }

  lazy val scaladocArchive : File = {
    val scaladocTarget = basedirOutput.toFile
    ensureFolder( scaladocTarget )
    new File( scaladocTarget, scaladocArchiveName )
  }

  /**
   * Package scaladoc content into an archive jar.
   */
  def performPackage() : Unit = {
    logger.info( s"Packaging Scaladoc: ${scaladocArchive}" )
    if ( scaladocArchive.exists ) { scaladocArchive.delete }
    val packager = new MavenArchiver()
    val archiveBuilder = new JarArchiver()
    packager.setArchiver( archiveBuilder )
    packager.setOutputFile( scaladocArchive )
    val includes = Array[ String ]( "**/**" ) // FIXME to config
    val excludes = Array[ String ]()
    packager.getArchiver.addDirectory( scaladocOutputFolder, includes, excludes )
    packager.createArchive( session, project, scaladocArchiveConfig )
  }

  /**
   * Attach Scaladoc artifact to the project as deployment artifact.
   */
  def performAttach() : Unit = {
    if ( scaladocHasAttach ) {
      logger.info( s"Attaching Scaladoc: ${scaladocArchive}" )
      projectHelper.attachArtifact( project, scaladocArchive, scaladocClassifier )
    }
  }

  def performGenerate() : Unit = {
    performScaladoc
    performPackage
    performAttach
  }

  override def perform() : Unit = {
    if ( skipScaladoc || hasSkipMojo ) {
      reportSkipReason( "Skipping disabled goal execution." )
      return
    }
    performGenerate()
  }

}

@Description( """
Produce project Scaladoc artifact for all compilation scopes.
Invokes goals: scaladoc-*.
""" )
@Mojo(
  name                         = A.mojo.`scaladoc`,
  defaultPhase                 = LifecyclePhase.PACKAGE,
  requiresDependencyResolution = ResolutionScope.TEST
)
class ScaladocArkonMojo extends ScaladocAnyMojo
  with document.ScaladocMacro
  with document.ScaladocMain
  with document.ScaladocTest
  with zinc.CompilerMacro
  with zinc.CompilerMain
  with zinc.CompilerTest {

  override def mojoName = A.mojo.`scaladoc`

  override def zincBuildCache = throwNotUsed

  override def performGenerate() : Unit = {
    executeSelfMojo( A.mojo.`scaladoc-macro` )
    executeSelfMojo( A.mojo.`scaladoc-main` )
    executeSelfMojo( A.mojo.`scaladoc-test` )
  }

}

@Description( """
Produce project Scaladoc artifact for compilation scope=macro.
A member of goal=scaladoc.
""" )
@Mojo(
  name                         = A.mojo.`scaladoc-macro`,
  defaultPhase                 = LifecyclePhase.PACKAGE,
  requiresDependencyResolution = ResolutionScope.COMPILE
)
class ScaladocMacroMojo extends ScaladocAnyMojo
  with document.ScaladocMacro
  with zinc.CompilerMacro {

  override def mojoName = A.mojo.`scaladoc-macro`

  @Description( """
  Flag to skip goal execution: scaladoc-macro.
  """ )
  @Parameter(
    property     = "scalor.skipScaladocMacro", //
    defaultValue = "false"
  )
  var skipScaladocMacro : Boolean = _

  override def hasSkipMojo = skipScaladocMacro

  override def performPackage = () // included in scope=main
  override def performAttach = () // included in scope=main

}

@Description( """
Produce project Scaladoc artifact for compilation scope=main.
A member of goal=scaladoc.
""" )
@Mojo(
  name                         = A.mojo.`scaladoc-main`,
  defaultPhase                 = LifecyclePhase.PACKAGE,
  requiresDependencyResolution = ResolutionScope.COMPILE
)
class ScaladocMainMojo extends ScaladocAnyMojo
  with document.ScaladocMain
  with zinc.CompilerMain {

  override def mojoName = A.mojo.`scaladoc-main`

  @Description( """
  Flag to skip goal execution: scaladoc-main.
  """ )
  @Parameter(
    property     = "scalor.skipScaladocMain", //
    defaultValue = "false"
  )
  var skipScaladocMain : Boolean = _

  override def hasSkipMojo = skipScaladocMain

}

@Description( """
Produce project Scaladoc artifact for compilation scope=test.
A member of goal=scaladoc.
""" )
@Mojo(
  name                         = A.mojo.`scaladoc-test`,
  defaultPhase                 = LifecyclePhase.PACKAGE,
  requiresDependencyResolution = ResolutionScope.TEST
)
class ScaladocTestMojo extends ScaladocAnyMojo
  with document.ScaladocTest
  with zinc.CompilerTest {

  override def mojoName = A.mojo.`scaladoc-test`

  @Description( """
  Flag to skip goal execution: scaladoc-test.
  """ )
  @Parameter(
    property     = "scalor.skipScaladocTest", //
    defaultValue = "false"
  )
  var skipScaladocTest : Boolean = _

  override def hasSkipMojo = skipScaladocTest

}