restdocs.tool.export.ToolExportSnippet Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of restdocs-tool-export Show documentation
Generates AsciiDoc snippets via Spring Restdocs that are exports for Insomnia or Postman that can be download and imported.
The newest version!
package restdocs.tool.export;

import org.springframework.restdocs.RestDocumentationContext;
import org.springframework.restdocs.operation.Operation;
import org.springframework.restdocs.snippet.Snippet;
import org.springframework.util.Assert;
import restdocs.tool.export.common.ExportConstants;
import restdocs.tool.export.common.handler.ToolHandler;
import restdocs.tool.export.common.handler.ToolHandlers;

import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;

import static restdocs.tool.export.common.ExportConstants.APPLICATION_NAME;

public class ToolExportSnippet implements Snippet {

  private static final String INIT_PROPERTY = "restdocs.tool.export.initialized";

  private static ToolExportSnippet instance;
  private static Map properties = new HashMap<>();
  private static Set variables = new HashSet<>();

  private List toolHandlerImpls = new ArrayList<>();

  private ToolExportSnippet(ToolHandlers... toolHandlers)
      throws IllegalAccessException, InstantiationException {

    setDefaultProperties();
    for(ToolHandlers toolHandler : toolHandlers) {
      toolHandlerImpls.add(toolHandler.getHandlerClass().newInstance());
    }
  }

  public static ToolExportSnippet initInstance(String applicationName, ToolHandlers... toolHandlers)
      throws InstantiationException, IllegalAccessException {
    Assert.notNull(applicationName, "Application name is required to generate exports");
    setProperty(APPLICATION_NAME, applicationName);

    if(instance == null) {
      instance = new ToolExportSnippet(toolHandlers);
    }

    return instance;
  }

  public static ToolExportSnippet getInstance() {
    return instance;
  }

  protected static void resetInstance() {
    instance = null;
    System.clearProperty(INIT_PROPERTY);
    properties.clear();
    variables.clear();
  }

  @Override
  public void document(Operation operation) throws IOException {
    RestDocumentationContext context = (RestDocumentationContext) operation.getAttributes().get(RestDocumentationContext.class.getName());
    File outputDirectory = context.getOutputDirectory();
    init(outputDirectory);
    setAttributes(operation);

    for(ToolHandler toolHandler : getToolHandlers()) {
      toolHandler.handleOperation(operation);
    }
  }

  public static void setProperty(String propertyName, Object value) {
    properties.put(propertyName, value);
  }

  public static  T getProperty(String propertyName, Class type) {
    return (T) properties.get(propertyName);
  }

  public static void addVariable(String variable) {
    variables.add(variable);
  }

  protected void setDefaultProperties() {
    setProperty(ExportConstants.HOST_VARIABLE_ENABLED, true);
  }

  protected void setAttributes(Operation operation) {
    Map attributes = operation.getAttributes();
    attributes.putAll(properties);
    attributes.put(ExportConstants.VARIABLES, variables);
  }

  protected void init(File outputDirectory) throws IOException {
    if(System.getProperty(INIT_PROPERTY) == null) {
      System.setProperty(INIT_PROPERTY, "true");

      for(ToolHandler toolHandler : getToolHandlers()) {
        toolHandler.initialize(outputDirectory, getProperty(APPLICATION_NAME, String.class));
      }
    }
  }

  protected List getToolHandlers() {
    return toolHandlerImpls;
  }
}