Abstract creation of the patterns (#29)

* Abstract creation of the patterns

* Fix prioritisation

* NodeName includes the prefix

* Handle lang inheritance correctly

* Improve xpath and naming

* Support JATS articles directly

* Add helpers

* Restore method

* Not needed

* Treat template as nullable

* Keep it wrapped in a Libero item

* Make a dedicated bundle

* Cross bundle so create a function

* Test

* Avoid setting a fake argument

* Not meant

* Move Libero XML to its own bundle

* Not meant

* Revert patterns update

* No longer needed

* Add JATS italics

* Remove inline handling since that's a new feature

* Not needed

* Add missing tests

* Trigger Travis build

Author: thewilkybarkid

composer.json

@@ -13,7 +13,8 @@
             "tests\\Libero\\Browser\\": "tests/",
             "tests\\Libero\\ContentPageBundle\\": "vendor-extra/ContentPageBundle/tests/",
             "tests\\Libero\\JatsContentBundle\\": "vendor-extra/JatsContentBundle/tests/",
-            "tests\\Libero\\LiberoContentBundle\\": "vendor-extra/LiberoContentBundle/tests/"
+            "tests\\Libero\\LiberoContentBundle\\": "vendor-extra/LiberoContentBundle/tests/",
+            "tests\\Libero\\ViewsBundle\\": "vendor-extra/ViewsBundle/tests/"
         }
     },
     "require": {
@@ -25,6 +26,7 @@
         "libero/jats-content-bundle": "^1.0@dev",
         "libero/libero-content-bundle": "^1.0@dev",
         "libero/patterns-bundle": "^1.0@dev",
+        "libero/views-bundle": "^1.0@dev",
         "symfony/asset": "^4.1",
         "symfony/config": "^4.1",
         "symfony/console": "^4.1",

composer.lock

@@ -8,6 +8,7 @@
     Libero\JatsContentBundle\JatsContentBundle::class => ['all' => true],
     Libero\LiberoContentBundle\LiberoContentBundle::class => ['all' => true],
     Libero\LiberoPatternsBundle\LiberoPatternsBundle::class => ['all' => true],
+    Libero\ViewsBundle\ViewsBundle::class => ['all' => true],
     Symfony\Bundle\FrameworkBundle\FrameworkBundle::class => ['all' => true],
     Symfony\Bundle\MonologBundle\MonologBundle::class => ['all' => true],
     Symfony\Bundle\TwigBundle\TwigBundle::class => ['all' => true],

config/bundles.php

@@ -24,6 +24,9 @@
         <testsuite name="LiberoContentBundle">
             <directory suffix=".php">vendor-extra/LiberoContentBundle/tests</directory>
         </testsuite>
+        <testsuite name="ViewsBundle">
+            <directory suffix=".php">vendor-extra/ViewsBundle/tests</directory>
+        </testsuite>
     </testsuites>
 
     <filter>
@@ -32,6 +35,7 @@
             <directory>vendor-extra/ContentPageBundle/src</directory>
             <directory>vendor-extra/JatsContentBundle/src</directory>
             <directory>vendor-extra/LiberoContentBundle/src</directory>
+            <directory>vendor-extra/ViewsBundle/src</directory>
         </whitelist>
     </filter>
 

phpunit.xml.dist

@@ -56,6 +56,9 @@
     "libero/patterns-bundle": {
         "version": "1.0.x-dev"
     },
+    "libero/views-bundle": {
+        "version": "1.0.x-dev"
+    },
     "monolog/monolog": {
         "version": "1.24.0"
     },

symfony.lock

@@ -16,6 +16,7 @@
         "fluentdom/fluentdom": "^7.0",
         "guzzlehttp/guzzle": "^6.3",
         "libero/patterns-bundle": "^1.0@dev",
+        "libero/views-bundle": "^1.0@dev",
         "psr/http-message": "^1.0",
         "punic/punic": "^3.3",
         "symfony/config": "^4.1",

vendor-extra/ContentPageBundle/composer.json

@@ -6,6 +6,7 @@
 
 use Libero\ContentPageBundle\Controller\ContentController;
 use Libero\ContentPageBundle\Routing\ContentPageRouteLoader;
+use Libero\ViewsBundle\Views\ViewConverter;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -46,6 +47,7 @@ private function addPage(string $name, array $config, ContainerBuilder $containe
         $definition->setArgument(1, $config['service']);
         $definition->setArgument(2, new Reference('twig'));
         $definition->setArgument(3, $config['page_template']);
+        $definition->setArgument(4, new Reference(ViewConverter::class));
         $definition->addTag('controller.service_arguments');
         $definition->addTag('libero.content_page.controller', ['handler' => $config['handler']]);
 

vendor-extra/ContentPageBundle/src/DependencyInjection/ContentPageExtension.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace tests\Libero\ContentPageBundle;
+
+use FluentDOM\DOM\Element;
+use Libero\ViewsBundle\Views\CallbackViewConverter;
+use Libero\ViewsBundle\Views\View;
+use Libero\ViewsBundle\Views\ViewConverter;
+
+trait ViewConvertingTestCase
+{
+    final protected function createConverter() : ViewConverter
+    {
+        return new CallbackViewConverter(
+            function (Element $object, ?string $template, array $context) : View {
+                return new View($template, ['element' => $object->getNodePath(), 'context' => $context]);
+            }
+        );
+    }
+}

vendor-extra/ContentPageBundle/tests/ViewConvertingTestCase.php

@@ -12,6 +12,7 @@
         "php": "^7.2",
         "fluentdom/fluentdom": "^7.0",
         "libero/content-page-bundle": "^1.0@dev",
+        "libero/views-bundle": "^1.0@dev",
         "symfony/config": "^4.1",
         "symfony/dependency-injection": "^4.1",
         "symfony/http-kernel": "^4.1"

vendor-extra/JatsContentBundle/composer.json

@@ -4,17 +4,22 @@
 
 namespace Libero\JatsContentBundle\Handler;
 
-use FluentDOM\DOM\Attribute;
 use FluentDOM\DOM\Document;
 use FluentDOM\DOM\Element;
-use FluentDOM\DOM\Xpath;
 use Libero\ContentPageBundle\Handler\ContentHandler;
+use Libero\ViewsBundle\Views\ViewConverter;
 use UnexpectedValueException;
 use function array_merge;
-use function Libero\ContentPageBundle\text_direction;
 
 final class JatsContentHandler implements ContentHandler
 {
+    private $converter;
+
+    public function __construct(ViewConverter $converter)
+    {
+        $this->converter = $converter;
+    }
+
     public function handle(Element $documentElement, array $context) : array
     {
         /** @var Document $document */
@@ -39,60 +44,14 @@ public function handle(Element $documentElement, array $context) : array
             throw new UnexpectedValueException('Could not find a front');
         }
 
-        $title = $xpath->firstOf('jats:article-meta/jats:title-group/jats:article-title', $front);
-
-        if (!$title instanceof Element) {
-            throw new UnexpectedValueException('Could not find a title');
-        }
-
-        $contentHeader = [
-            'template' => '@LiberoPatterns/content-header.html.twig',
-            'arguments' => [
-                'attributes' => [],
-                'contentTitle' => [
-                    'attributes' => [],
-                    'text' => (string) $title,
-                ],
-            ],
-        ];
-
-        $contentHeader['arguments']['attributes'] += $this->determineLangAndDir($xpath, $front, $context);
-        $contentHeader['arguments']['contentTitle']['attributes'] += $this->determineLangAndDir(
-            $xpath,
-            $title,
-            array_merge(
-                $context,
-                $contentHeader['arguments']['attributes']
-            )
-        );
+        $contentHeader = $this->converter->convert($front, '@LiberoPatterns/content-header.html.twig', $context);
 
         return array_merge(
             $context,
             [
-                'title' => $contentHeader['arguments']['contentTitle']['text'],
+                'title' => $contentHeader->getArgument('contentTitle')['text'],
                 'content' => [$contentHeader],
             ]
         );
     }
-
-    private function determineLangAndDir(Xpath $xpath, Element $element, array $context) : array
-    {
-        $return = [];
-
-        $newLang = $xpath->firstOf('ancestor-or-self::*[@xml:lang][1]/@xml:lang', $element);
-
-        if (!$newLang instanceof Attribute) {
-            return $return;
-        }
-
-        if ($context['lang'] !== $newLang->nodeValue) {
-            $return['lang'] = $newLang->nodeValue;
-
-            if ($context['dir'] !== $newDir = text_direction($return['lang'])) {
-                $return['dir'] = $newDir;
-            }
-        }
-
-        return $return;
-    }
 }