org.raml.jaxrs.emitters.ExampleEmitter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of raml-generator-api Show documentation
There is a newer version: 3.0.7
/*
 * Copyright 2013-2017 (c) MuleSoft, Inc.
 *
 * 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.raml.jaxrs.emitters;

import com.google.common.base.Optional;
import org.raml.api.RamlResourceMethod;
import org.raml.jaxrs.common.Example;
import org.raml.jaxrs.common.ExampleCases;
import org.raml.jaxrs.common.Examples;
import org.raml.jaxrs.types.RamlProperty;
import org.raml.jaxrs.types.RamlType;
import org.raml.utilities.IndentedAppendable;

import java.io.IOException;
import java.util.HashSet;
import java.util.Set;

/**
 * Created by Jean-Philippe Belanger on 4/16/17. Just potential zeroes and ones
 */
public class ExampleEmitter implements LocalEmitter {


  private final IndentedAppendable writer;
  private boolean headerDone = false;

  private String currentCaseName;
  private Set seenTypeNames = new HashSet<>();

  public ExampleEmitter(IndentedAppendable writer) {
    this.writer = writer;
  }

  @Override
  public void emit(RamlType ramlType) throws IOException {


    if (seenTypeNames.contains(ramlType.getTypeName())) {

      return;
    } else {

      seenTypeNames.add(ramlType.getTypeName());
    }

    if (!headerDone) {

      Optional examplesAnnotation = ramlType.getAnnotation(ExampleCases.class);
      if (examplesAnnotation.isPresent()) {

        String[] examples = examplesAnnotation.get().value();
        writer.appendLine("examples:");
        for (String caseName : examples) {
          if (caseName.isEmpty()) {
            throw new IOException("@ExampleCases case on type " + ramlType.getTypeName() + " is empty");
          }

          currentCaseName = caseName;

          writer.indent();
          writer.appendLine(caseName + ":");
          writer.indent();
          writer.appendLine("strict: false");
          writer.appendLine("value:");
          writer.indent();

          if (hasAnExample(ramlType)) {

            emitOneExample(ramlType);
          }

          writer.outdent();
          writer.outdent();
          writer.outdent();
        }
      } else {

        currentCaseName = "";

        if (!hasAnExample(ramlType)) {

          return;
        }


        boolean currentHeaderDone = headerDone;

        writer.appendLine("example:");
        writer.indent();
        writer.appendLine("strict: false");
        writer.appendLine("value:");
        writer.indent();
        headerDone = true;

        emitOneExample(ramlType);
        if (!currentHeaderDone) {
          writer.outdent();
          writer.outdent();
        }
      }
    } else {

      emitOneExample(ramlType);
    }
  }

  private void emitOneExample(RamlType ramlType) throws IOException {

    for (RamlProperty ramlProperty : ramlType.getProperties()) {
      ramlProperty.emit(this);
    }
  }

  @Override
  public void emit(RamlProperty ramlProperty) throws IOException {

    RamlType ramlType = ramlProperty.getRamlType();
    if (!ramlType.isRamlScalarType()) {

      writer.appendLine(ramlProperty.getName() + ":");
      writer.indent();

      ramlType.emit(this);

      writer.outdent();
    } else {

      Optional e = ramlProperty.getAnnotation(Example.class);
      if (e.isPresent()) {

        if (e.get().useCase().equals(currentCaseName)) {
          writer.appendLine(ramlProperty.getName() + ": " + e.get().value());
          return;
        }
      }

      Optional examplesAnnotation = ramlProperty.getAnnotation(Examples.class);
      if (examplesAnnotation.isPresent()) {
        for (Example example : examplesAnnotation.get().value()) {
          if (example.useCase().equals(currentCaseName)) {
            writer.appendLine(ramlProperty.getName() + ": " + example.value());
            return;
          }
        }
      }
    }
  }

  private boolean hasAnExample(RamlType type) {

    for (RamlProperty ramlProperty : type.getProperties()) {
      Optional annotation = ramlProperty.getAnnotation(Example.class);
      if (annotation.isPresent()) {
        return annotation.get().useCase().equals(currentCaseName);
      }

      Optional examplesAnnotation = ramlProperty.getAnnotation(Examples.class);
      if (examplesAnnotation.isPresent()) {
        for (Example example : examplesAnnotation.get().value()) {
          if (example.useCase().equals(currentCaseName)) {
            return true;
          }
        }
      }
    }

    return false;
  }

  @Override
  public void emit(RamlResourceMethod method) throws IOException {

  }
}