Move grammar2uml to separate repository

- also use mkdocs for pages, include ragdoc

grammar2uml/src/main/java/de/tudresden/inf/st/jastadd/grammar2uml/compiler/Utils.java

-package de.tudresden.inf.st.jastadd.grammar2uml.compiler;
-
-import java.util.*;
-import java.util.function.Predicate;
-
-import static java.util.stream.Collectors.toList;
-
-public class Utils {
-  public static <T> List<T> filterToList(Collection<T> collection, Predicate<T> predicate) {
-    return collection.stream().filter(predicate).collect(toList());
-  }
-
-  public static <T> Set<T> asSet(T... t) {
-    return new HashSet<T>(Arrays.asList(t));
-  }
-}

grammar2uml/src/main/resources/Containment.mustache

-{{typeName}} *-- {{{modifier}}} {{componentName}} {{#Label}}: {{Label}}{{/Label}}

grammar2uml/src/main/resources/Folder.mustache

-package {{name}} <<Folder>> {
-{{#InnerTypeDecls}}  {{> TypeDecl}}{{/InnerTypeDecls}}
-}

grammar2uml/src/main/resources/Inheritance.mustache

-{{superClassName}} <|-- {{subClassName}}

grammar2uml/src/main/resources/Relation.mustache

-{{leftName}} {{{leftModifier}}} {{#isBidirectional}}<{{/isBidirectional}}--> {{{rightModifier}}} {{rightName}} {{#Label}}: {{Label}}{{/Label}}

grammar2uml/src/main/resources/TypeDecl.mustache

-{{=<% %>=}}<%#isAbstract%>abstract <%/isAbstract%>class <%name%><%#InnerTokenComponents%><%#first%> {
-<%/first%>
-  <%name%>
-<%#last%>
-}<%/last%><%/InnerTokenComponents%><%={{ }}=%>

grammar2uml/src/main/resources/grammar2uml.mustache

-```plantuml
-@startuml
-hide circle
-hide methods
-{{#Folders}}{{> Folder}}{{/Folders}}
-{{#OtherTypes}}{{> TypeDecl}}{{/OtherTypes}}
-{{#Containments}}{{> Containment}}{{/Containments}}
-{{#Relations}}{{> Relation}}{{/Relations}}
-{{#Inheritances}}{{> Inheritance}}{{/Inheritances}}
-@enduml
-```

grammar2uml/src/main/resources/grammar2umlVersion.properties

-#Fri Jan 15 20:11:10 CET 2021
-version=0.1.1

grammar2uml/src/main/resources/log4j2.xml

-<?xml version="1.0" encoding="UTF-8"?>
-<Configuration status="INFO">
-    <Appenders>
-        <Console name="Console" target="SYSTEM_OUT">
-            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
-        </Console>
-    </Appenders>
-    <Loggers>
-        <Root level="info">
-            <AppenderRef ref="Console"/>
-        </Root>
-    </Loggers>
-</Configuration>
\ No newline at end of file

grammar2uml/src/test/java/de/tudresden/inf/st/jastadd/grammar2uml/test/CompilerTest.java

-package de.tudresden.inf.st.jastadd.grammar2uml.test;
-
-import org.jastadd.relast.compiler.CompilerException;
-import de.tudresden.inf.st.jastadd.grammar2uml.compiler.Compiler;
-import org.junit.jupiter.api.Test;
-
-import java.io.File;
-import java.nio.file.Paths;
-
-import static org.junit.jupiter.api.Assertions.assertFalse;
-import static org.junit.jupiter.api.Assertions.assertTrue;
-
-/**
- * TODO: Add description.
- *
- * @author rschoene - Initial contribution
- */
-public class CompilerTest {
-
-  @SuppressWarnings("SameParameterValue")
-  void transform(String inputGrammar, String inputGrammar2Uml, String output) throws CompilerException {
-
-    System.out.println("Running test in directory '" + Paths.get(".").toAbsolutePath() + "'.");
-    assertTrue(Paths.get(inputGrammar).toFile().exists(), "input grammar does not exist");
-    assertTrue(Paths.get(inputGrammar2Uml).toFile().exists(), "input grammar2uml does not exist");
-    assertFalse(Paths.get(inputGrammar).toFile().isDirectory(), "input grammar is a directory");
-    assertFalse(Paths.get(inputGrammar2Uml).toFile().isDirectory(), "input grammar2uml is a directory");
-
-    File outputFile = Paths.get(output).toFile();
-    File outputDirFile = outputFile.getParentFile();
-    if (!outputDirFile.exists()) {
-      assertTrue(outputDirFile.mkdir());
-    }
-
-    String[] args = {
-        "--output=" + output,
-        "--inputGrammar2Uml=" + inputGrammar2Uml,
-        "--defaultFolders",
-        inputGrammar
-    };
-
-    new Compiler().run(args);
-  }
-
-  @Test
-  void transformMinimalExample() throws CompilerException {
-    transform("src/test/resources/Example.relast", "src/test/resources/Example.grammar2uml", "src/test/resources/uml.md");
-  }
-}

grammar2uml/src/test/resources/.gitignore

-uml.md

grammar2uml/src/test/resources/Example.grammar2uml

-folder Datenfluss: Prüfmethode, Funktionsprinzip, Datenausgangswert, Verarbeitungsschritt, Dateneingangswert, Wert, Datenquelle, Quelle
-folder Darstellung: DarstellungsElement, Dezimalwert, Auffälligkeitsmarkierung, Text
-

grammar2uml/src/test/resources/Example.relast

-Root ::= Prüfmethode* Wert*;
-
-// Beispiel für Prüfmethode: ReLiAbweichung
-Prüfmethode ::= Funktionsprinzip Zielobjekt*;
-Zielobjekt;
-
-rel Prüfmethode.Funktionsprinzip* -> Funktionsprinzip;
-
-// Beispiel Funktionsprinzip: Berechnungen innerhalb von ReLi-Abweichung für ist_diff und ist_diff < max_diff
-Funktionsprinzip ::= Dateneingangswert* Verarbeitungsschritt* Datenausgangswert*;
-
-abstract Datenquelle;
-// Beispiel für Wert: FB_links, ist_diff, max_diff
-Wert : Datenquelle ::= <Datentyp> <A> <B>;
-
-// Ein Wert, der bei "Dateneingang" steht, z.B. für ReLi: max_Diff oder FB,links
-// Beispiel für Dateneingangswert: Zuordnung, aus welcher Quelle der Wert ausgelesen werden soll
-Dateneingangswert ::= [Quelle];
-rel Dateneingangswert.Wert -> Wert;
-
-// Beispiel für Verarbeitungsschritt: ist_Diff = ..., oder ist_diff < max_diff
-Verarbeitungsschritt : Datenquelle ::= <Berechnungsvorschrift>;
-rel Verarbeitungsschritt.EingabeWert* -> Wert;
-
-// Ein Wert, der bei "Datenausgang" steht, z.B. für ReLi $ist_{Diff,Achse n}$
-Datenausgangswert ::= DarstellungsElement;
-rel Datenausgangswert.Wert -> Wert;
-
-// Beispiel für Quelle: Rollenbremsprüfstand
-Quelle;
-
-abstract DarstellungsElement ;
-Dezimalwert : DarstellungsElement;
-Auffälligkeitsmarkierung : DarstellungsElement;
-Text : DarstellungsElement;
-
-rel Auffälligkeitsmarkierung.Element <-> DarstellungsElement.Auffälligkeitsmarkierung;

grammar2uml/src/test/resources/log4j2.xml

-<?xml version="1.0" encoding="UTF-8"?>
-<Configuration status="INFO">
-    <Appenders>
-        <Console name="Console" target="SYSTEM_OUT">
-            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
-        </Console>
-    </Appenders>
-    <Loggers>
-        <Root level="info">
-            <AppenderRef ref="Console"/>
-        </Root>
-    </Loggers>
-</Configuration>
\ No newline at end of file

pages/.gitignore

-/public/
+/docs/ragdoc/
+__pycache__

pages/Makefile

-# Minimal makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line, and also
-# from the environment for the first two.
-SPHINXOPTS    ?=
-SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = .
-BUILDDIR      = public
-
-# Put it first so that "make" without argument is like "make help".
-help:
-	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-
-.PHONY: help Makefile
-
-# Catch-all target: route all unknown targets to Sphinx using the new
-# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

pages/conf.py

-# Configuration file for the Sphinx documentation builder.
-#
-# This file only contains a selection of the most common options. For a full
-# list see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
-
-# -- Path setup --------------------------------------------------------------
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
-import sphinx_rtd_theme
-
-
-# -- Project information -----------------------------------------------------
-
-project = 'Relast2Uml'
-copyright = '2021, René Schöne'
-author = 'René Schöne'
-
-
-# -- General configuration ---------------------------------------------------
-
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
-extensions = [
-    'sphinx_rtd_theme',
-    'recommonmark',
-    'sphinxemoji.sphinxemoji',
-    'sphinx_markdown_tables'
-]
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['public', 'Thumbs.db', '.DS_Store']
-
-
-# -- Options for HTML output -------------------------------------------------
-
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-#
-html_theme = 'sphinx_rtd_theme'
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
-
-sphinxemoji_style = 'twemoji'

pages/custom_theme/footer.html

+{% block footer %}
+<p>{% if config.copyright %}
+<small>{{ config.copyright }}<br></small>
+{% endif %}
+<hr>
+Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+{% if page and page.meta and page.meta.git_revision_date_localized %}
+<small><br><i>Last updated {{ page.meta.git_revision_date_localized }}</i></small>
+{% endif %}
+</p>
+{% endblock %}