Merge pull request #13 from ircmaxell/encode_specials

Encode specials correctly.

Author: mvriel

src/phpDocumentor/GraphViz/Attribute.php

@@ -99,7 +99,9 @@ public function __toString()
         }
 
         $value = $this->getValue();
-        if (!$this->isValueInHtml() || $this->isValueContainingSpecials()) {
+        if ($this->isValueContainingSpecials()) {
+            $value = '"' . $this->encodeSpecials() . '"';
+        } elseif (!$this->isValueInHtml()) {
             $value = '"' . addslashes($value) . '"';
         }
         return $key . '=' . $value;
@@ -126,4 +128,17 @@ public function isValueContainingSpecials()
     {
         return strstr($this->getValue(), "\\") !== false;
     }
+
+    /**
+     * Encode special characters so the escape sequences aren't removed
+     *
+     * @see http://www.graphviz.org/doc/info/attrs.html#k:escString
+     * @return string
+     */
+    protected function encodeSpecials()
+    {
+        $value = $this->getValue();
+        $regex = '(\'|"|\\x00|\\\\(?![\\\\NGETHLnlr]))';
+        return preg_replace($regex, '\\\\$0', $value);
+    }
 }

tests/phpDocumentor/GraphViz/Test/AttributeTest.php

@@ -158,6 +158,35 @@ public function testToString()
         );
     }
 
+    /**
+     * Tests whether the toString provides a valid GraphViz attribute string.
+     *
+     * @covers \phpDocumentor\GraphViz\Attribute::__toString
+     * @covers \phpDocumentor\GraphViz\Attribute::encodeSpecials
+     *
+     * @return void
+     */
+    public function testToStringWithSpecials()
+    {
+        $this->fixture = new Attribute('a', 'b');
+
+        $this->fixture->setValue('a\la');
+        $this->assertSame(
+            'a="a\la"', (string)$this->fixture,
+            'Specials should not be escaped'
+        );
+        $this->fixture->setValue('a\l"a');
+        $this->assertSame(
+            'a="a\l\"a"', (string)$this->fixture,
+            'Specials should not be escaped, but quotes should'
+        );
+        $this->fixture->setValue('a\\\\l"a');
+        $this->assertSame(
+            'a="a\\\\l\"a"', (string)$this->fixture,
+            'Double backslashes should stay the same'
+        );
+    }
+
     /**
      * Tests whether the isValueContainingSpecials function
      *
@@ -173,4 +202,6 @@ public function testIsValueContainingSpecials()
         $this->fixture->setValue('+ ship(): boolean');
         $this->assertFalse($this->fixture->isValueContainingSpecials());
     }
+
+    
 }