Add support for sub in JatsContentBundle (#42)

* Add support for sub in JatsContentBundle

* Update patterns

* Introduce patterns at the moment that sub template was merged

* Update vendor-extra/JatsContentBundle/src/Resources/config/services.xml

Co-Authored-By: nlisgo <[email protected]>

Author: nlisgo

vendor-extra/JatsContentBundle/src/Resources/config/services.xml

@@ -100,6 +100,12 @@
             <tag name="libero.view_converter"/>
         </service>
 
+        <service id="Libero\JatsContentBundle\ViewConverter\SubVisitor"
+            class="Libero\JatsContentBundle\ViewConverter\SubVisitor">
+            <argument type="service" id="Libero\ViewsBundle\Views\ViewConverter"/>
+            <tag name="libero.view_converter"/>
+        </service>
+
     </services>
 
 </container>

vendor-extra/JatsContentBundle/src/ViewConverter/SubVisitor.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Libero\JatsContentBundle\ViewConverter;
+
+use FluentDOM\DOM\Element;
+use Libero\ViewsBundle\Views\ConvertsChildren;
+use Libero\ViewsBundle\Views\SimplifiedChildVisitor;
+use Libero\ViewsBundle\Views\View;
+use Libero\ViewsBundle\Views\ViewConverter;
+use Libero\ViewsBundle\Views\ViewConverterVisitor;
+
+final class SubVisitor implements ViewConverterVisitor
+{
+    use ConvertsChildren;
+    use SimplifiedChildVisitor;
+
+    public function __construct(ViewConverter $converter)
+    {
+        $this->converter = $converter;
+    }
+
+    protected function doVisit(Element $object, View $view, array &$context = []) : View
+    {
+        return $view->withArgument('text', $this->convertChildren($object, $context));
+    }
+
+    protected function possibleTemplate() : string
+    {
+        return '@LiberoPatterns/sub.html.twig';
+    }
+
+    protected function expectedElement() : string
+    {
+        return '{http://jats.nlm.nih.gov}sub';
+    }
+
+    protected function unexpectedArguments() : array
+    {
+        return ['text'];
+    }
+}

vendor-extra/JatsContentBundle/tests/ViewConverter/SubVisitorTest.php

@@ -0,0 +1,116 @@
+<?php
+
+declare(strict_types=1);
+
+namespace tests\Libero\JatsContentBundle\ViewConverter;
+
+use Libero\JatsContentBundle\ViewConverter\SubVisitor;
+use Libero\ViewsBundle\Views\View;
+use PHPUnit\Framework\TestCase;
+use tests\Libero\ContentPageBundle\ViewConvertingTestCase;
+use tests\Libero\ContentPageBundle\XmlTestCase;
+
+final class SubVisitorTest extends TestCase
+{
+    use ViewConvertingTestCase;
+    use XmlTestCase;
+
+    /**
+     * @test
+     * @dataProvider nodeProvider
+     */
+    public function it_does_nothing_if_it_is_not_a_jats_sub_element(string $xml) : void
+    {
+        $visitor = new SubVisitor($this->createFailingConverter());
+
+        $element = $this->loadElement($xml);
+
+        $newContext = [];
+        $view = $visitor->visit($element, new View(null), $newContext);
+
+        $this->assertNull($view->getTemplate());
+        $this->assertEmpty($view->getArguments());
+        $this->assertEmpty($newContext);
+    }
+
+    public function nodeProvider() : iterable
+    {
+        yield 'different namespace' => ['<sub xmlns="http://example.com">foo</sub>'];
+        yield 'different element' => ['<bold xmlns="http://jats.nlm.nih.gov">foo</bold>'];
+    }
+
+    /**
+     * @test
+     */
+    public function it_does_nothing_if_is_not_the_sub_template() : void
+    {
+        $visitor = new SubVisitor($this->createFailingConverter());
+
+        $element = $this->loadElement('<sub xmlns="http://jats.nlm.nih.gov">foo</sub>');
+
+        $newContext = [];
+        $view = $visitor->visit($element, new View('template'), $newContext);
+
+        $this->assertSame('template', $view->getTemplate());
+        $this->assertEmpty($view->getArguments());
+        $this->assertEmpty($newContext);
+    }
+
+    /**
+     * @test
+     */
+    public function it_does_nothing_if_there_is_already_text_set() : void
+    {
+        $visitor = new SubVisitor($this->createFailingConverter());
+
+        $element = $this->loadElement('<sub xmlns="http://jats.nlm.nih.gov">foo</sub>');
+
+        $newContext = [];
+        $view = $visitor->visit($element, new View(null, ['text' => 'bar']), $newContext);
+
+        $this->assertNull($view->getTemplate());
+        $this->assertSame(['text' => 'bar'], $view->getArguments());
+        $this->assertEmpty($newContext);
+    }
+
+    /**
+     * @test
+     */
+    public function it_sets_the_template_and_text_argument() : void
+    {
+        $visitor = new SubVisitor($this->createDumpingConverter());
+
+        $element = $this->loadElement(
+            <<<XML
+<jats:sub xmlns:jats="http://jats.nlm.nih.gov">
+    foo <jats:bold>bar</jats:bold> baz
+</jats:sub>
+XML
+        );
+
+        $newContext = ['qux' => 'quux'];
+        $view = $visitor->visit($element, new View(null), $newContext);
+
+        $this->assertSame('@LiberoPatterns/sub.html.twig', $view->getTemplate());
+        $this->assertEquals(
+            [
+                'text' => [
+                    new View(
+                        null,
+                        ['node' => '/jats:sub/text()[1]', 'template' => null, 'context' => ['qux' => 'quux']]
+                    ),
+                    new View(
+                        null,
+                        ['node' => '/jats:sub/jats:bold', 'template' => null, 'context' => ['qux' => 'quux']]
+                    ),
+                    new View(
+                        null,
+                        ['node' => '/jats:sub/text()[2]', 'template' => null, 'context' => ['qux' => 'quux']]
+                    ),
+                ],
+            ],
+            $view->getArguments()
+        );
+        $this->assertSame(['qux' => 'quux'], $newContext);
+    }
+}

vendor-extra/LiberoPatternsBundle/src/Resources/public/css/all.css

@@ -0,0 +1,9 @@
+{% spaceless %}
+
+  <sub {%- include '@LiberoPatterns/attributes.html.twig' %}>
+
+    {%- include '@LiberoPatterns/text.html.twig' with {nodes: text} only -%}
+
+  </sub>
+
+{% endspaceless %}