Merge pull request #4 from clue-labs/tests

Improve test suite

Author: clue

composer.json

@@ -17,8 +17,7 @@
         "php": ">=5.3",
         "react/event-loop": "~0.4.0|~0.3.0",
         "clue/buzz-react": "~0.2.0",
-        "ext-simplexml": "*",
-        "ext-tidy": "*"
+        "ext-simplexml": "*"
     },
     "require-dev": {
         "clue/block-react": "~0.1.0"

src/Client.php

@@ -9,17 +9,22 @@
 use Clue\React\Buzz\Browser;
 use Clue\React\Buzz\Message\Response;
 use React\Promise\Deferred;
+use Clue\React\ViewVcApi\Io\Parser;
+use Clue\React\ViewVcApi\Io\Loader;
 
 class Client
 {
     private $url;
     private $brower;
 
-    public function __construct($url, Browser $browser, Parser $parser = null)
+    public function __construct($url, Browser $browser, Parser $parser = null, Loader $loader = null)
     {
         if ($parser === null) {
             $parser = new Parser();
         }
+        if ($loader === null) {
+            $loader = new Loader();
+        }
 
         // TODO: do not follow redirects
 //         $browser = $this->browser->withOptions(array(
@@ -29,6 +34,7 @@ public function __construct($url, Browser $browser, Parser $parser = null)
         $this->url = $url;
         $this->browser = $browser;
         $this->parser = $parser;
+        $this->loader = $loader;
     }
 
     public function fetchFile($path, $revision = null)
@@ -105,18 +111,7 @@ private function fetchLogXml($path)
 
     private function fetchXml($url)
     {
-        return $this->fetch($url)->then(function ($html) {
-            // clean up HTML to safe XML
-            $html = tidy_repair_string($html, array(
-                'output-xml' => true,
-                'input-xml'  => true,
-            ));
-
-            // clean up namespace declaration
-            $html = str_replace('xmlns=', 'ns=', $html);
-
-            return new SimpleXMLElement($html);
-        });
+        return $this->fetch($url)->then(array($this->loader, 'loadXmlString'));
     }
 
     private function fetch($url)

src/Io/Loader.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Clue\React\ViewVcApi\Io;
+
+use SimpleXMLElement;
+
+class Loader
+{
+    public function loadXmlFile($path)
+    {
+        return $this->loadXmlString(file_get_contents($path));
+    }
+
+    public function loadXmlString($html)
+    {
+        // fix invalid markup of help link in footer of outdated ViewVC versions
+        $html = str_replace('Help</strong></td>', 'Help</a></strong></td>', $html);
+
+        // replace unneeded HTML entities
+        $html = str_replace('&nbsp;', ' ', $html);
+
+        // clean up namespace declaration
+        $html = str_replace('xmlns="', 'ns="', $html);
+
+        return new SimpleXMLElement($html);
+    }
+}

src/Parser.php renamed to src/Io/Parser.php

@@ -1,10 +1,12 @@
 <?php
 
-namespace Clue\React\ViewVcApi;
+namespace Clue\React\ViewVcApi\Io;
+
+use SimpleXMLElement;
 
 class Parser
 {
-    public function parseDirectoryListing($xml)
+    public function parseDirectoryListing(SimpleXMLElement $xml)
     {
         $files = array();
 
@@ -24,7 +26,7 @@ public function parseDirectoryListing($xml)
         return $files;
     }
 
-    public function parseLogRevisions($xml)
+    public function parseLogRevisions(SimpleXMLElement $xml)
     {
         $revisions = array();
 

tests/FunctionalClientTest.php

@@ -14,7 +14,7 @@ class FunctionalClientTest extends TestCase
 
     public function setUp()
     {
-        $url = 'https://svn.apache.org/viewvc/';
+        $url = 'http://svn.apache.org/viewvc/';
 
         $this->loop = LoopFactory::create();
         $this->blocker = new Blocker($this->loop);

tests/Io/LoaderTest.php

@@ -0,0 +1,32 @@
+<?php
+
+use Clue\React\ViewVcApi\Io\Loader;
+
+class LoaderTest extends TestCase
+{
+    private $loader;
+
+    public function setUp()
+    {
+        $this->loader = new Loader();
+    }
+
+    /**
+     * @dataProvider xmlFiles
+     * @param string $path
+     */
+    public function testValidXmlFixtures($path)
+    {
+        $xml = $this->loader->loadXmlFile(__DIR__ . '/../fixtures/' . $path);
+    }
+
+    public function xmlFiles()
+    {
+        return array_filter(array_map(
+            function ($path) {
+                return (substr($path, -5) === '.html') ? array($path) : null;
+            },
+            scandir(__DIR__ . '/../fixtures/')
+        ));
+    }
+}

tests/Io/ParserTest.php

@@ -0,0 +1,39 @@
+<?php
+
+use Clue\React\ViewVcApi\Io\Parser;
+use Clue\React\ViewVcApi\Io\Loader;
+
+class ParserTest extends TestCase
+{
+    private $loader;
+    private $parser;
+
+    public function setUp()
+    {
+        $this->loader = new Loader();
+        $this->parser = new Parser();
+    }
+
+    public function testLogRevisions()
+    {
+        $xml = $this->loadXml('is-a-file.html');
+
+        $revisions = $this->parser->parseLogRevisions($xml);
+
+        $this->assertEquals(array('168703' => '168695', '168695' => '168694'), $revisions);
+    }
+
+    public function testDirectoryListing()
+    {
+        $xml = $this->loadXml('listing.html');
+
+        $files = $this->parser->parseDirectoryListing($xml);
+
+        $this->assertEquals(array('images/', 'stylesheets/', 'index.xml', 'velocity.properties'), $files);
+    }
+
+    private function loadXml($file)
+    {
+        return $this->loader->loadXmlFile(__DIR__ . '/../fixtures/' . $file);
+    }
+}