[FEATURE] Rst File Exporter

.gitignore

@@ -1,7 +1,10 @@
 composer.lock
+vendor/
 public/*
 !public/.keep
 cache/*
 !cache/.keep
 schemas/*
 !schemas/.keep
+build/logs/
+.idea/

.travis.yml

@@ -0,0 +1,19 @@
+language: php
+
+sudo: false
+
+php:
+- "7.1"
+- "7.2"
+
+cache:
+  directories:
+  - $HOME/.composer/cache
+
+install: composer install
+
+script:
+- vendor/bin/phpunit
+
+after_script:
+- travis_retry php vendor/bin/php-coveralls -v

README.md

@@ -1,3 +1,7 @@
+[![Build Status](https://travis-ci.com/maddy2101/fluid-documentation-generator.svg?branch=master)](https://travis-ci.com/maddy2101/fluid-documentation-generator)
+[![Coverage Status](https://coveralls.io/repos/github/maddy2101/fluid-documentation-generator/badge.svg?branch=master)](https://coveralls.io/github/maddy2101/fluid-documentation-generator?branch=master)
+[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/maddy2101/fluid-documentation-generator/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/maddy2101/fluid-documentation-generator/?branch=master)
+
 Fluid (ViewHelper) Documentation Generator
 ==========================================
 

bin/generate-fluid-documentation

@@ -9,6 +9,7 @@ require_once $pwd . DIRECTORY_SEPARATOR . 'vendor/autoload.php';
 use NamelessCoder\FluidDocumentationGenerator\Data\DataFileResolver;
 use NamelessCoder\FluidDocumentationGenerator\Export\HtmlExporter;
 use NamelessCoder\FluidDocumentationGenerator\Export\JsonExporter;
+use NamelessCoder\FluidDocumentationGenerator\Export\RstExporter;
 use NamelessCoder\FluidDocumentationGenerator\Export\XsdExporter;
 use NamelessCoder\FluidDocumentationGenerator\Entity\Schema;
 use NamelessCoder\FluidDocumentationGenerator\SchemaDocumentationGenerator;
@@ -22,6 +23,7 @@ $exporters = [
     new XsdExporter($publicUrlPrefix),
     new JsonExporter($publicUrlPrefix),
     new HtmlExporter($publicUrlPrefix),
+    new RstExporter($publicUrlPrefix)
 ];
 $generator = SchemaDocumentationGenerator::getInstance($exporters, $force);
 $generator->generateFilesForRoot();

composer.json

@@ -22,7 +22,9 @@
     "bin/generate-fluid-documentation.php"
   ],
   "require-dev": {
+    "ext-json": "*",
     "phpunit/phpunit": "^7.1",
-    "mikey179/vfsStream": "^1.6"
+    "mikey179/vfsstream": "^1.6",
+    "php-coveralls/php-coveralls": "^2.1"
   }
 }

phpunit.xml.dist

@@ -1,25 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
 <phpunit bootstrap="vendor/autoload.php"
-        backupGlobals="false"
-        backupStaticAttributes="false"
-        colors="false"
-        convertErrorsToExceptions="false"
-        convertWarningsToExceptions="false"
-        forceCoversAnnotation="false"
-        processIsolation="false"
-        stopOnError="true"
-        stopOnFailure="true"
-        stopOnIncomplete="false"
-        stopOnSkipped="false"
-        verbose="false">
+         backupGlobals="false"
+         backupStaticAttributes="false"
+         colors="false"
+         convertErrorsToExceptions="true"
+         convertWarningsToExceptions="true"
+         forceCoversAnnotation="false"
+         processIsolation="false"
+         stopOnError="false"
+         stopOnFailure="false"
+         stopOnIncomplete="false"
+         stopOnSkipped="false"
+         verbose="false">
 
-        <testsuites>
-                <testsuite name="FluidDocumentationGenerator">
-                        <directory>tests/</directory>
-                </testsuite>
-        </testsuites>
-		<filter>
-				<whitelist>
-						<directory>src/</directory>
-				</whitelist>
-		</filter>
+    <testsuites>
+        <testsuite name="FluidDocumentationGenerator">
+            <directory>tests/</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist>
+            <directory>src/</directory>
+        </whitelist>
+    </filter>
+    <logging>
+        <log type="coverage-clover" target="build/logs/clover.xml"/>
+    </logging>
 </phpunit>

resources/templates/Default/Root.rst

@@ -0,0 +1,31 @@
+.. include:: Includes.txt
+
+.. _start:
+
+==============================
+Fluid ViewHelper Documentation
+==============================
+
+:Rendered: |today|
+
+This is a complete reference of all available Fluid ViewHelper within TYPO3 CMS.
+This documentation is generated from PHP Source code of TYPO3 CMS.
+
+This reference is auto generated from TYPO3 CMS 9.5 source code. Right now there is no
+auto generation for TYPO3 versions below 9.5. You can find a hand written reference
+for 6.2 at https://docs.typo3.org/typo3cms/ExtbaseGuide/6.2/Fluid/ViewHelper/Index.html.
+
+Right now this might look ugly in some places, e.g. ``= EXAMPLE =`` and rendered
+HTML markup like ``<code>``. This will be polished in the future.  The current
+state still is much better then nothing.
+
+Also notice that package names are not 1:1 Composer packages. ``cms-`` is
+striped.
+
+Content
+-------
+
+.. toctree::
+   :titlesonly:
+
+<f:for each="{tocTree}" as="line">{line}</f:for>

resources/templates/Default/Schema.rst

@@ -0,0 +1,14 @@
+.. include:: {rootPath}Includes.txt
+
+{headlineDecoration}
+{headline}
+{headlineDecoration}
+
+* {viewHelpers} ViewHelpers documented
+* {subGroups} Sub namespaces
+
+.. toctree::
+   :titlesonly:
+   :glob:
+
+<f:for each="{tocTree}" as="line">{line}</f:for>

resources/templates/Default/ViewHelper.rst

@@ -0,0 +1,35 @@
+.. include:: {rootPath}Includes.txt
+
+.. _{headlineIdentifier}:
+
+{headlineDecoration}
+{headline}
+{headlineDecoration}
+
+
+{viewHelper.description -> f:format.raw()}
+
+Arguments
+=========
+
+
+<f:spaceless>
+<f:if condition="{arguments -> f:count()} == 0">This ViewHelper has no arguments.</f:if>
+
+<f:for each="{arguments}" as="argumentData">
+.. _{argumentData.headlineIdentifier}:
+{argumentData.headline}
+{argumentData.headlineDecoration}
+<f:if condition="{argumentData.dataType}">
+:aspect:`DataType`
+   {argumentData.dataType}
+</f:if><f:if condition="{argumentData.default}">
+:aspect:`Default`
+   {argumentData.default -> f:format.raw()}
+</f:if>
+:aspect:`Required`
+   {argumentData.isRequired ? 'true' : 'false'}
+:aspect:`Description`
+   {argumentData.description -> f:format.raw()}
+</f:for>
+</f:spaceless>

resources/templates/Default/ViewHelperGroup.rst

@@ -0,0 +1,19 @@
+.. include:: {rootPath}Includes.txt
+
+{headlineDecoration}
+{headline}
+{headlineDecoration}
+
+
+<f:spaceless>
+* {viewHelpers} ViewHelpers documented
+<f:if condition="{subGroups} > 0">* {subGroups} Sub namespaces</f:if>
+</f:spaceless>
+
+.. toctree::
+   :titlesonly:
+   :glob:
+
+<f:for each="{tocTree}" as="line">{line}</f:for>
+
+

src/Export/ExporterInterface.php

@@ -3,9 +3,9 @@
 
 namespace NamelessCoder\FluidDocumentationGenerator\Export;
 
-use NamelessCoder\FluidDocumentationGenerator\ProcessedSchema;
 use NamelessCoder\FluidDocumentationGenerator\Entity\SchemaPackage;
 use NamelessCoder\FluidDocumentationGenerator\Entity\SchemaVendor;
+use NamelessCoder\FluidDocumentationGenerator\ProcessedSchema;
 use NamelessCoder\FluidDocumentationGenerator\SchemaDocumentationGenerator;
 use NamelessCoder\FluidDocumentationGenerator\ViewHelperDocumentation;
 use NamelessCoder\FluidDocumentationGenerator\ViewHelperDocumentationGroup;
@@ -14,7 +14,8 @@ interface ExporterInterface
 {
     public function getIdentifier(): string;
     public function setGenerator(SchemaDocumentationGenerator $generator): void;
-    public function exportRoot(): void;
+
+    public function exportRoot(bool $forceUpdate): void;
     public function exportVendor(SchemaVendor $vendor): void;
     public function exportPackage(SchemaPackage $package): void;
     public function exportSchema(ProcessedSchema $processedSchema, bool $forceUpdate = false): void;

src/Export/JsonExporter.php

@@ -6,9 +6,9 @@
 use NamelessCoder\FluidDocumentationGenerator\Data\DataFileResolver;
 use NamelessCoder\FluidDocumentationGenerator\Data\GraphDataHandler;
 use NamelessCoder\FluidDocumentationGenerator\Entity\Schema;
-use NamelessCoder\FluidDocumentationGenerator\ProcessedSchema;
 use NamelessCoder\FluidDocumentationGenerator\Entity\SchemaPackage;
 use NamelessCoder\FluidDocumentationGenerator\Entity\SchemaVendor;
+use NamelessCoder\FluidDocumentationGenerator\ProcessedSchema;
 use NamelessCoder\FluidDocumentationGenerator\SchemaDocumentationGenerator;
 use NamelessCoder\FluidDocumentationGenerator\ViewHelperDocumentation;
 use NamelessCoder\FluidDocumentationGenerator\ViewHelperDocumentationGroup;
@@ -53,7 +53,7 @@ public function createAdditionalSchemaResources(ProcessedSchema $schema, ?string
         ];
     }
 
-    public function exportRoot(): void
+    public function exportRoot(bool $forceUpdate): void
     {
         $resolver = DataFileResolver::getInstance();
         $index = [];