All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org_scala_tools_maven.ScalaGenJsonMojo Maven / Gradle / Ivy

Go to download

The maven-scala-plugin is used for compiling/testing/running/documenting scala code in maven.

The newest version!
/*
 * Copyright 2007 scala-tools.org
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 */
package org_scala_tools_maven;

import java.io.File;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;

import org.apache.maven.artifact.Artifact;
import org.apache.maven.model.License;
import org.apache.maven.project.MavenProject;
import org.apache.maven.project.MavenProjectHelper;
import org.codehaus.jackson.JsonEncoding;
import org.codehaus.jackson.JsonFactory;
import org.codehaus.jackson.JsonGenerator;
import org.codehaus.jackson.JsonNode;
import org.codehaus.jackson.map.ObjectMapper;
import org.codehaus.jackson.node.ObjectNode;
import org.codehaus.plexus.util.StringUtils;
import org_scala_tools_maven_executions.JavaMainCaller;

import edu.emory.mathcs.backport.java.util.Arrays;

/**
 * Produces Scala API documentation in Json (use vscaladoc2_genjson).
 *
 * @goal genjson
 * @requiresDependencyResolution compile
 * @execute phase="generate-sources"
 * @since 2.15.0
 */
public class ScalaGenJsonMojo extends ScalaSourceMojoSupport {

  /**
   * Define the html fragment for logo.
   *
   * @parameter expression="${genjson.logo}"
   *            default-value="${project.name}"
   */
  protected String logo;

  /**
   * Define the html fragment for license (default : use info of the first entry of pom.xml/project/licenses).
   *
   * @parameter expression="${genjson.license}"
   */
  protected String license;

  /**
   * Define the artifact's tags (space separator).
   *
   * @parameter expression="${genjson.tags}" default-value=""
   */
  protected String tags = "";

  // /**
  // * Generate source in HTML (not yet supported by vscaladoc2)
  // *
  // *
  // * @parameter expression="${linksource}" default-value="true"
  // */
  // protected boolean linksource;

  /**
   * Define the html fragment for description (use in overview page).
   *
   * @parameter expression="${genjson.description}"
   *            default-value="${project.description}"
   */
  private String description;

  /**
   * Define the html fragment for description (use in overview page).
   *
   * @parameter expression="${genjson.linksources}"
   *            default-value=""
   */
  private String linksources;

  /**
   * Allow to override the artifactId used to generated json doc. Can be need sometimes (eg : for parent/group of projects)
   *
   * @parameter expression="${genjson.artifactId}"
   *            default-value="${project.artifactId}"
   */
  private String artifactId;

  /**
   * An optional json object as string used to override base configuration generated
   * (useful for additional, not yet supported, entry)
   *
   * @parameter expression="${genjson.override}"
   */
  private String overrideJson;

  /**
   * Define the version of vscaladoc2_genjson to use.
   *
   * @parameter expression="${genjson.version}"
   *            default-value="0.3"
   */
  protected String vscaladoc2Version;

  /**
   * The directory which contains scala/java source files
   *
   * @parameter expression="${project.build.sourceDirectory}/../scala"
   */
  protected File sourceDir;

  /**
   * Maven ProjectHelper.
   * 
   * @component
   */
  private MavenProjectHelper projectHelper;
  
  protected String _mainClass = "net_alchim31_vscaladoc2_genjson.Main";
  protected boolean _prettyPrint = true;

  public ScalaGenJsonMojo() throws Exception {
    super();
  }

  @Override
  @SuppressWarnings("unchecked")
  protected List getSourceDirectories() throws Exception {
    List sources = project.getCompileSourceRoots();
    // Quick fix in case the user has not added the "add-source" goal.
    String scalaSourceDir = sourceDir.getCanonicalPath();
    if (!sources.contains(scalaSourceDir)) {
      sources.add(scalaSourceDir);
    }
    return normalize(sources);
  }

  @Override
  protected void doExecute() throws Exception {
    if (StringUtils.isNotEmpty(_mainClass)) {
      Cfg cfg = new Cfg(this);
      File cfgFile = makeJsonCfg(cfg);
      setDependenciesForJcmd();
      JavaMainCaller jcmd = getEmptyScalaCommand(_mainClass);
      jcmd.addJvmArgs(jvmArgs);
      jcmd.addArgs(cfgFile.getCanonicalPath());
      jcmd.run(displayCmd);
      registerApidocArchiveForInstall(cfg);
    } else {
      getLog().warn("Not mainClass or valid launcher found/define");
    }
  }

  private void setDependenciesForJcmd() {
    BasicArtifact artifact = new BasicArtifact();
    artifact.artifactId = "vscaladoc2_genjson";
    artifact.groupId = "net.alchim31.vscaladoc2";
    artifact.version = vscaladoc2Version;
    dependencies = new BasicArtifact[] { artifact };
  }

  private void toJson(Object pojo, boolean prettyPrint, File f) throws Exception {
    ObjectMapper m = new ObjectMapper();
    JsonFactory jf = new JsonFactory();
    JsonGenerator jg = jf.createJsonGenerator(f, JsonEncoding.UTF8);
    if (prettyPrint) {
      jg.useDefaultPrettyPrinter();
    }
    ObjectNode tree = m.valueToTree(pojo);

    if (StringUtils.isNotEmpty(overrideJson)) {
      JsonNode overrideTree = m.readValue(overrideJson, JsonNode.class);
      Iterator  ks = overrideTree.getFieldNames();
      while( ks.hasNext()) {
        String k = ks.next();
        JsonNode v = overrideTree.get(k);
        tree.put(k, v);
      }
    }

    m.writeTree(jg, tree);
  }

  private File makeJsonCfg(Cfg cfg) throws Exception {
    initFilters();
    File dir = new File(project.getBuild().getDirectory());
    dir.mkdirs();
    File f = new File(dir, "vscaladoc2_cfg.json");
    toJson(cfg, _prettyPrint, f);
    return f;
  }

  private void registerApidocArchiveForInstall(Cfg cfg) throws Exception {
    File apidocArchiveFile = new File(System.getProperty("user.home"), ".config/vscaladoc2/apis/" + cfg.artifactId + "/" + cfg.version + "-apidoc.jar.gz").getCanonicalFile();
    if (apidocArchiveFile.exists()) {
      projectHelper.attachArtifact(project, "jar.gz", "apidoc", apidocArchiveFile);
    } else {
      getLog().warn("archive of apidoc not found : " + apidocArchiveFile);
    }
  }

  protected static class Cfg {
    public String groupId = "";
    public String artifactId = "undef";
    public String version = "0.0.0";
    public String description = "";
    public String logo = "";
    public String license = "";
    public String kind = "";
    public String tags = "";
    public String linksources = "";
    public List> dependencies = Collections.emptyList();
    public List> sources = Collections.emptyList();
    public List artifacts = Collections.emptyList();
    public List additionnalArgs = Collections.emptyList();

    @SuppressWarnings("unchecked")
    protected Cfg(ScalaGenJsonMojo data) throws Exception {
      groupId = data.project.getGroupId();
      artifactId = data.artifactId;
      version = data.project.getVersion();
      logo = data.logo;
      license = data.license;
      description = data.description;
      tags = data.tags;
      linksources = data.linksources;
      if (StringUtils.isBlank(license) && !data.project.getLicenses().isEmpty()) {
        License lic = (License) data.project.getLicenses().get(0);
        license = String.format("%s", lic.getUrl(), lic.getName());
      }
      dependencies = makeDependencies(data);
      sources = makeSources(data);
      artifacts = makeArtifacts(data);
      if (data.args != null && data.args.length > 0) {
        additionnalArgs = Arrays.asList(data.args);
      }
      kind = makeKind(data);
    }

    private String makeKind(ScalaGenJsonMojo data) {
      String back = null;
      String pkg = data.project.getPackaging();
      if ("pom".equals(pkg)) {
        back = "group";
      } else {
        back = pkg;
      }
      return back;
    }

    protected List> makeDependencies(ScalaGenJsonMojo data) throws Exception {
      List> back = new ArrayList>();
      @SuppressWarnings("unchecked")
      List deps = data.project.getCompileArtifacts();
      for (Artifact dep : deps) {
        List e = new ArrayList(3);
        e.add(dep.getFile().getCanonicalPath());
        e.add(dep.getArtifactId() + "/" + dep.getVersion());
        back.add(e);
      }
      return back;
    }

    protected List> makeSources(ScalaGenJsonMojo data) throws Exception {
      List> back = new ArrayList>();
      List dirs = data.getSourceDirectories();
      List includes = new ArrayList(data.includes);
      List excludes = new ArrayList(data.excludes);
      for (File dir : dirs) {
        List e = new ArrayList(3);
        e.add(dir.getCanonicalPath());
        e.add(excludes);
        e.add(includes);
        back.add(e);
      }
      return back;
    }

    protected List makeArtifacts(ScalaGenJsonMojo data) throws Exception {
      List back = new ArrayList();
      @SuppressWarnings("unchecked")
      List modules = data.project.getCollectedProjects();
      for (MavenProject module : modules) {
        back.add(module.getArtifactId() + "/" + module.getVersion());
      }
      return back;
    }
  }
}
    

    

    

                
 
            

    

                
 
            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy