com.theoryinpractise.clojure.ClojureAutodocMojo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of clojure-maven-plugin Show documentation
Maven plugin for compiling clojure source files
There is a newer version: 1.9.3
/*
 * Copyright (c) Mark Derricutt 2010.
 *
 * The use and distribution terms for this software are covered by the Eclipse Public License 1.0
 * (http://opensource.org/licenses/eclipse-1.0.php) which can be found in the file epl-v10.html
 * at the root of this distribution.
 *
 * By using this software in any fashion, you are agreeing to be bound by the terms of this license.
 *
 * You must not remove this notice, or any other, from this software.
 */

package com.theoryinpractise.clojure;

import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;

import java.io.File;
import java.io.IOException;
import java.io.PrintWriter;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;

@Mojo(name = "autodoc", defaultPhase = LifecyclePhase.PACKAGE, requiresDependencyResolution = ResolutionScope.TEST)
public class ClojureAutodocMojo extends AbstractClojureCompilerMojo {

  @Parameter(property = "project.name")
  private String projectName;

  @Parameter(property = "project.description")
  private String projectDescription;

  @Parameter(property = "project.build.directory")
  private String projectBuildDir;

  @Parameter(defaultValue = "${project.build.directory}/autodoc")
  private String autodocTargetDirectory;

  @Parameter private Map autodoc;

  @Override
  public void execute() throws MojoExecutionException {
    for (String sourceDirectory : sourceDirectories) {
      generateAutodocForDir(sourceDirectory);
    }
  }

  private void generateAutodocForDir(String sourceDirectory) throws MojoExecutionException {
    Map effectiveProps = new HashMap<>();
    effectiveProps.put("name", projectName);
    effectiveProps.put("description", projectDescription);
    effectiveProps.put("param-dir", "src/main/autodoc");
    effectiveProps.put("root", new File(".").getAbsoluteFile().getParent());
    effectiveProps.put("source-path", sourceDirectory);
    effectiveProps.put("output-path", new File(autodocTargetDirectory).getAbsolutePath());
    effectiveProps.put("page-title", projectName);

    // Not implemented with defaults:
    //effectiveProps.put("web-src-dir", "");
    //effectiveProps.put("external-doc-tmpdir", "");
    //effectiveProps.put("load-classpath", "");
    //effectiveProps.put("load-jar-dirs", "");
    //effectiveProps.put("namespaces-to-document", "");
    //effectiveProps.put("trim-prefix", "");
    //effectiveProps.put("load-except-list", "");
    //effectiveProps.put("copyright", null);

    if (autodoc != null) {
      effectiveProps.putAll(autodoc);
    }

    StringBuilder sb = new StringBuilder();
    sb.append("(use 'autodoc.autodoc)\n");
    sb.append("(autodoc {\n");
    for (Map.Entry entry : effectiveProps.entrySet()) {
      String key = entry.getKey();
      String value = entry.getValue();
      sb.append(" :" + key);
      if (value != null) {
        // TODO: Handle possible newlines, etc.
        sb.append(" \"" + value.replace("\\", "\\\\") + "\"");
      } else {
        sb.append(" nil");
      }
      sb.append("\n");
    }
    sb.append("})\n");

    try {
      File autodocClj = File.createTempFile("autodoc", ".clj");
      final PrintWriter pw = new PrintWriter(autodocClj);
      pw.print(sb.toString());
      pw.close();

      getLog().info("Generating docs to " + effectiveProps.get("output-path") + " with " + autodocClj.getPath());
      getLog().debug(sb.toString());

      callClojureWith(
          getSourceDirectories(SourceDirectory.COMPILE, SourceDirectory.TEST),
          outputDirectory,
          testClasspathElements,
          "clojure.main",
          new String[] {autodocClj.getPath()});

    } catch (IOException e) {
      throw new MojoExecutionException(e.getMessage());
    }
  }

  private static String quoted(Object value) {
    return Objects.toString(value, "").replace("\\", "\\\\");
  }
}