DocumentationProcessor.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2022 Lluis Turró Cutiller <http://www.turro.org/>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
package org.turro.parser.processor;
 
import java.util.List;
import java.util.stream.Collectors;
import org.turro.action.Secrets;
import org.turro.action.content.ContentProviders;
import org.turro.annotation.ExternalParser;
import org.turro.emoji.EmojiMap;
import org.turro.html.Colors;
import org.turro.icon.IconSet;
import org.turro.indicator.IElephantIndicator;
import org.turro.indicator.Indicators;
import org.turro.marker.ElephantMarker;
import org.turro.parser.AbstractParser;
import org.turro.parser.IParser;
import org.turro.parser.MacroMap;
import org.turro.parser.MacroParameter;
import org.turro.reflection.Instances;
import org.turro.security.Permissions;
import org.turro.security.SecurityGroups;
 
public class DocumentationProcessor extends AbstractMacroProcessor {
 
  @Override
  public String getName() {
    return "Documentation";
  }
 
  @Override
  protected void doProcess(MacroProcessorContext context) {
    final MacroAdapter macro = context.getMacro();
    switch(macro.getName()) {
      case "provider-macros" -> {
        ElephantMarker marker = context.getMarker();
        marker.put("providers", ContentProviders.getProviders());
        prepareProperties(marker, macro.get("doc-properties"));
        marker.process(context.getTemplateRoot(), context.getTemplate(), context.getWriter());
      }
      case "social-groups" -> {
        ElephantMarker marker = context.getMarker();
        marker.put("socialGroups", SecurityGroups.getAll().stream().sorted().toList());
        marker.put("roles", Permissions.permissionStringMap());
        prepareProperties(marker, macro.get("doc-properties"));
        marker.process(context.getTemplateRoot(), context.getTemplate(), context.getWriter());
      }
      case "elephant-macros" -> {
        ElephantMarker marker = context.getMarker();
        marker.put("elephantParsers", 
                Instances.cached().byAnnotation(ExternalParser.class, IParser.class)
                .stream().filter((p) -> {
                  return "all".equals(macro.get("parser")) || 
                          ((p instanceof AbstractParser) && 
                          ((AbstractParser) p).getParserName().equals(macro.get("parser")));
                }).collect(Collectors.toList()));
        marker.put("headers", "true".equals(macro.get("headers")));
        prepareProperties(marker, macro.get("doc-properties"));
        marker.process(context.getTemplateRoot(), context.getTemplate(), context.getWriter());
      }
      case "elephant-macro-processors" -> {
        ElephantMarker marker = context.getMarker();
        marker.put("elephantProcessors", 
                Instances.cached().bySuper(AbstractMacroProcessor.class, IMacroProcessor.class)
                .stream().filter((p) -> {
                  return "all".equals(macro.get("processor")) || 
                          ((p instanceof AbstractMacroProcessor) && 
                          ((AbstractMacroProcessor) p).getName().equals(macro.get("processor")));
                }).collect(Collectors.toList()));
        marker.put("headers", "true".equals(macro.get("headers")));
        prepareProperties(marker, macro.get("doc-properties"));
        marker.process(context.getTemplateRoot(), context.getTemplate(), context.getWriter());
      }
      case "elephant-emojis" -> {
        ElephantMarker marker = context.getMarker();
        marker.put("emojimap", EmojiMap.getInstance());
        marker.process(context.getTemplateRoot(), context.getTemplate(), context.getWriter());
      }
      case "elephant-icons" -> {
        ElephantMarker marker = context.getMarker();
        marker.put("iconset", IconSet.getInstance());
        marker.process(context.getTemplateRoot(), context.getTemplate(), context.getWriter());
      }
      case "elephant-colors" -> {
        ElephantMarker marker = context.getMarker();
        marker.put("colors", Colors.getHueList());
        marker.process(context.getTemplateRoot(), context.getTemplate(), context.getWriter());
      }
      case "elephant-indicators" -> {
        ElephantMarker marker = context.getMarker();
        marker.put("elephantIndicators", Indicators.getIndicators().stream().filter((i) -> {
                  return "all".equals(macro.get("indicator")) || 
                          ((i instanceof IElephantIndicator) && 
                          ((IElephantIndicator) i).getRoot().equals(macro.get("indicator")));
                }).toList());
        marker.put("headers", "true".equals(macro.get("headers")));
        prepareProperties(marker, macro.get("doc-properties"));
        marker.process(context.getTemplateRoot(), context.getTemplate(), context.getWriter());
      }
      case "notice" -> {
        ElephantMarker marker = context.getMarker();
        marker.put("notice", Secrets.<List<String>>getObject("key=notice;show=false"));
        marker.process(context.getTemplateRoot(), context.getTemplate(), context.getWriter());
      }
      case "licenses" -> {
        ElephantMarker marker = context.getMarker();
        marker.put("licenses", Secrets.<List<String>>getObject("key=licenses;show=false"));
        marker.process(context.getTemplateRoot(), context.getTemplate(), context.getWriter());
      }
      case "libraries" -> {
        ElephantMarker marker = context.getMarker();
        marker.put("libraries", Secrets.<List<String>>getObject("key=libraries;show=false"));
        marker.process(context.getTemplateRoot(), context.getTemplate(), context.getWriter());
      }
    }
  }
 
  @Override
  protected void explainMacros(MacroMap macros) {
    macros.addSecret("provider-macros")
            .addParameter(MacroParameter.optional("doc-properties", "*/documentation"))
            .addTemplate("documentation", "providerMacros");
    macros.addSecret("social-groups")
            .addParameter(MacroParameter.optional("doc-properties", "*/documentation"))
            .addTemplate("documentation", "socialGroups");
    macros.addSecret("elephant-macros")
            .addParameter(MacroParameter.optional("parser", "all"))
            .addParameter(MacroParameter.optional("headers", "true"))
            .addParameter(MacroParameter.optional("doc-properties", "*/documentation"))
            .addTemplate("documentation", "elephantMacros");
    macros.addSecret("elephant-macro-processors")
            .addParameter(MacroParameter.optional("processor", "all"))
            .addParameter(MacroParameter.optional("headers", "true"))
            .addParameter(MacroParameter.optional("doc-properties", "*/documentation"))
            .addTemplate("documentation", "elephantMacroProcessors");
    macros.addSecret("elephant-emojis")
            .addParameter(MacroParameter.optional("tmpl-root", "documentation"))
            .addTemplate("documentation", "providerEmojis");
    macros.addSecret("elephant-icons")
            .addTemplate("documentation", "providerIcons");
    macros.addSecret("elephant-colors")
            .addTemplate("documentation", "elephantColors");
    macros.addSecret("elephant-indicators")
            .addParameter(MacroParameter.optional("indicator", "all"))
            .addParameter(MacroParameter.optional("headers", "true"))
            .addParameter(MacroParameter.optional("doc-properties", "*/documentation"))
            .addTemplate("documentation", "elephantIndicators");
    macros.addSecret("notice")
            .addTemplate("widgets/licenses", "notice");
    macros.addSecret("licenses")
            .addTemplate("widgets/licenses", "licenses");
    macros.addSecret("libraries")
            .addTemplate("widgets/licenses", "libraries");
  }
  
}