Add generic type for unknown nodes (fixes #41)

meyfa · Mar 25, 2018 · 5677a18 · 5677a18
1 parent 48c3980
commit 5677a18
Show file tree

Hide file tree

Showing 3 changed files with 55 additions and 15 deletions.
diff --git a/src/Nodes/SVGGenericNodeType.php b/src/Nodes/SVGGenericNodeType.php
@@ -0,0 +1,31 @@
+<?php
+
+namespace SVG\Nodes;
+
+use SVG\Nodes\SVGNodeContainer;
+use SVG\Rasterization\SVGRasterizer;
+
+/**
+ * NOT INTENDED FOR USER ACCESS. This is the class that gets instantiated for
+ * unknown nodes in input SVG.
+ */
+class SVGGenericNodeType extends SVGNodeContainer
+{
+    private $tagName;
+
+    public function __construct($tagName)
+    {
+        parent::__construct();
+        $this->tagName = $tagName;
+    }
+
+    public function getName()
+    {
+        return $this->tagName;
+    }
+
+    public function rasterize(SVGRasterizer $rasterizer)
+    {
+        // do nothing
+    }
+}
diff --git a/src/Reading/SVGReader.php b/src/Reading/SVGReader.php
@@ -5,6 +5,7 @@
 use SVG\SVGImage;
 use SVG\Nodes\SVGNode;
 use SVG\Nodes\SVGNodeContainer;
+use SVG\Nodes\SVGGenericNodeType;
 use SVG\Utilities\SVGStyleParser;
 
 /**
@@ -207,33 +208,32 @@ private function addChildren(SVGNodeContainer $node, \SimpleXMLElement $xml,
         array $namespaces)
     {
         foreach ($xml->children() as $child) {
-            $childNode = $this->parseNode($child, $namespaces);
-            if ($childNode) {
-                $node->addChild($childNode);
-            }
+            $node->addChild($this->parseNode($child, $namespaces));
         }
     }
 
     /**
      * Parses the given XML element into an instance of a SVGNode subclass.
-     * Passing an element of unknown type will return false.
+     * Unknown node types use a generic implementation.
      *
      * @param \SimpleXMLElement $xml        The XML element to parse.
      * @param string[]          $namespaces Array of allowed namespace prefixes.
      *
-     * @return SVGNode|false The parsed node, or false if type unknown.
+     * @return SVGNode The parsed node.
+     *
+     * @SuppressWarnings(PHPMD.ElseExpression)
      */
     private function parseNode(\SimpleXMLElement $xml, array $namespaces)
     {
         $type = $xml->getName();
 
-        if (!isset(self::$nodeTypes[$type])) {
-            return false;
+        if (isset(self::$nodeTypes[$type])) {
+            $call = array(self::$nodeTypes[$type], 'constructFromAttributes');
+            $node = call_user_func($call, $xml);
+        } else {
+            $node = new SVGGenericNodeType($type);
         }
 
-        $call = array(self::$nodeTypes[$type], 'constructFromAttributes');
-        $node = call_user_func($call, $xml);
-
         $this->applyAttributes($node, $xml, $namespaces);
         $this->applyStyles($node, $xml);
         $node->setValue($xml);

diff --git a/tests/Reading/SVGReaderTest.php b/tests/Reading/SVGReaderTest.php
@@ -158,15 +158,24 @@ public function testShouldRecursivelyAddChildren()
         ), $ellipse->getSerializableAttributes());
     }
 
-    public function testShouldIgnoreUnknownNodes()
+    public function testShouldRetrieveUnknownNodes()
     {
-        // should skip unknown node types without failing
         $svgReader = new SVGReader();
         $result = $svgReader->parseString($this->xmlUnknown);
         $doc = $result->getDocument();
-        $this->assertSame(2, $doc->countChildren());
+
+        // should include unknown nodes
+        $this->assertSame(3, $doc->countChildren());
         $this->assertSame('circle', $doc->getChild(0)->getName());
-        $this->assertSame('ellipse', $doc->getChild(1)->getName());
+        $this->assertSame('unknown', $doc->getChild(1)->getName());
+        $this->assertSame('ellipse', $doc->getChild(2)->getName());
+
+        // should set attributes on unknown nodes
+        $this->assertSame('bar', $doc->getChild(1)->getAttribute('foo'));
+
+        // should include children of unknown nodes
+        $this->assertSame(1, $doc->getChild(1)->countChildren());
+        $this->assertSame('baz', $doc->getChild(1)->getChild(0)->getName());
     }
 
     public function testShouldSetValue()