yosql-codegen/yosql-codegen-blocks/src/main/java/wtf/metio/yosql/codegen/blocks/DefaultJavadoc.java

   1 /*
   2  * This file is part of yosql. It is subject to the license terms in the LICENSE file found in the top-level
   3  * directory of this distribution and at http://creativecommons.org/publicdomain/zero/1.0/. No part of yosql,
   4  * including this file, may be copied, modified, propagated, or distributed except according to the terms contained
   5  * in the LICENSE file.
   6  */
   7
   8 package wtf.metio.yosql.codegen.blocks;
   9
  10 import com.squareup.javapoet.CodeBlock;
  11 import de.xn__ho_hia.javapoet.TypeGuesser;
  12 import wtf.metio.yosql.codegen.api.Javadoc;
  13 import wtf.metio.yosql.internals.jdk.Strings;
  14 import wtf.metio.yosql.models.immutables.FilesConfiguration;
  15 import wtf.metio.yosql.models.immutables.SqlConfiguration;
  16 import wtf.metio.yosql.models.immutables.SqlStatement;
  17 import wtf.metio.yosql.models.sql.ResultRowConverter;
  18
  19 import java.util.List;
  20 import java.util.Objects;
  21
  22 import static java.util.function.Predicate.not;
  23
  24 public final class DefaultJavadoc implements Javadoc {
  25
  26     private final FilesConfiguration files;
  27
  28     public DefaultJavadoc(final FilesConfiguration files) {
  29         this.files = files;
  30     }
  31
  32     @Override
  33     public CodeBlock repositoryJavadoc(final List<SqlStatement> statements) {
  34         final var builder = CodeBlock.builder()
  35                 .add("Generated based on the following file(s):\n")
  36                 .add("<ul>\n");
  37         final var input = files.inputBaseDirectory();
  38         statements.stream()
  39                 .map(SqlStatement::getSourcePath)
  40                 .distinct()
  41                 .map(input::relativize)
  42                 .forEach(path -> builder.add("<li>$L</li>\n", path));
  43         builder.add("</ul>\n");
  44         return builder.build();
  45     }
  46
  47     @Override
  48     public CodeBlock fieldJavaDoc(final SqlStatement statement) {
  49         final var input = files.inputBaseDirectory();
  50         final var builder = CodeBlock.builder()
  51                 .add("Generated based on the following file:\n")
  52                 .add("<ul>\n")
  53                 .add("<li>$L</li>\n", input.relativize(statement.getSourcePath()));
  54         builder.add("</ul>\n");
  55         return builder.build();
  56     }
  57
  58     @Override
  59     public CodeBlock methodJavadoc(final List<SqlStatement> statements) {
  60         final var builder = CodeBlock.builder();
  61         statements.stream()
  62                 .map(SqlStatement::getConfiguration)
  63                 .map(SqlConfiguration::description)
  64                 .filter(not(Strings::isBlank))
  65                 .forEach(description -> builder.add("<p>$L<p>\n", description));
  66         if (statements.size() > 1) {
  67             builder.add("<p>Executes one of the following statements:</p>");
  68         } else {
  69             builder.add("<p>Executes the following statement:</p>");
  70         }
  71         for (final var statement : statements) {
  72             if (Strings.isBlank(statement.getConfiguration().vendor())) {
  73                 if (statements.size() > 1) {
  74                     builder.add("\n\n<p>Fallback for other databases:</p>");
  75                 }
  76             } else {
  77                 builder.add("\n\n<p>Vendor: $N</p>", statement.getConfiguration().vendor());
  78             }
  79             builder.add("\n<pre>\n$L</pre>", statement.getRawStatement());
  80         }
  81         builder.add("\n\n<p>Generated based on the following file(s):</p>\n")
  82                 .add("<ul>\n");
  83         final var input = files.inputBaseDirectory();
  84         statements.stream()
  85                 .map(SqlStatement::getSourcePath)
  86                 .distinct()
  87                 .map(input::relativize)
  88                 .forEach(path -> builder.add("<li>$L</li>\n", path));
  89         builder.add("</ul>\n");
  90         statements.stream()
  91                 .map(SqlStatement::getConfiguration)
  92                 .flatMap(config -> config.resultRowConverter().stream())
  93                 .filter(Objects::nonNull)
  94                 .map(ResultRowConverter::resultType)
  95                 .filter(Objects::nonNull)
  96                 .filter(type -> !type.startsWith("java"))
  97                 .map(type -> type.substring(0, type.contains("<") ? type.indexOf("<") : type.length()))
  98                 .distinct()
  99                 .map(TypeGuesser::guessTypeName)
 100                 .filter(type -> !type.isPrimitive())
 101                 .filter(type -> !type.isBoxedPrimitive())
 102                 .forEach(type -> builder.add("\n@see $S", type));
 103         return builder.build();
 104     }
 105
 106 }