Added tests

Author: sprain

.gitignore

@@ -1,3 +1,4 @@
 vendor
 composer.lock
-example/cache/*
+example/cache/*
+phpunit.xml

README.md

@@ -35,7 +35,7 @@ $ php composer.phar update sprain/newsparser
 See [example.php](example/example.php).
 
 ## Todos
-* Write unit tests
+* Improve unit tests (e.q. test caching of fetched articles)
 * Add more news platforms
 * Add functionality to get latest articles
 * Add functionality to get details of fetched articles

Tests/NewsParser/Cache/CacheTest.php

@@ -0,0 +1,75 @@
+<?php
+
+namespace Sprain\NewsParser\Test\NewsParser\Cache;
+
+use Doctrine\Common\Cache\FilesystemCache;
+use Sprain\NewsParser\Cache\Cache;
+
+class CacheTest extends \PHPUnit_Framework_TestCase
+{
+    protected $cacheDir = '../../testcache';
+
+    public function setUp()
+    {
+        $this->cache = new Cache();
+        $this->cache->setCacheDir(__DIR__ . DIRECTORY_SEPARATOR . $this->cacheDir);
+    }
+
+    public function tearDown()
+    {
+        $this->rrmdir(__DIR__ . DIRECTORY_SEPARATOR . $this->cacheDir);
+    }
+
+    public function testGetCache()
+    {
+        $this->assertTrue($this->cache->getCache() instanceof FilesystemCache);
+    }
+
+    public function testGetCacheFailsWithoutCacheDir()
+    {
+        $this->cache->setCacheDir(null);
+        $this->assertFalse($this->cache->getCache() instanceof FilesystemCache);
+    }
+
+    public function testDisableCache()
+    {
+        $this->cache->disable();
+        $this->assertFalse($this->cache->getCache() instanceof FilesystemCache);
+    }
+
+    public function testSaveAndFetch()
+    {
+        $this->cache->save('foo', 'bar');
+        $this->assertSame('bar', $this->cache->fetch('foo'));
+    }
+
+    public function testClearCache()
+    {
+        $this->cache->save('foo', 'bar');
+        $this->cache->clear();
+        $this->assertFalse($this->cache->fetch('foo'));
+    }
+
+    public function testSetLifetime()
+    {
+        $this->cache->setCacheLifetime(1);
+        $this->assertSame(1, $this->cache->getCacheLifetime());
+        $this->cache->save('foo', 'bar');
+        $this->assertSame('bar', $this->cache->fetch('foo'));
+        sleep(2);
+        $this->assertFalse($this->cache->fetch('foo'));
+    }
+
+    protected function rrmdir($dir) {
+        if (is_dir($dir)) {
+            $objects = scandir($dir);
+            foreach ($objects as $object) {
+                if ($object != "." && $object != "..") {
+                    if (filetype($dir."/".$object) == "dir") $this->rrmdir($dir."/".$object); else unlink($dir."/".$object);
+                }
+            }
+            reset($objects);
+            rmdir($dir);
+        }
+    }
+}

Tests/NewsParser/NewsParserTest.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Sprain\NewsParser\Test\NewsParser;
+
+use Sprain\NewsParser\Cache\Cache;
+use Sprain\NewsParser\NewsParser;
+use Sprain\NewsParser\Parser\Platforms\CH\NzzParser;
+
+class NewsParserTest extends \PHPUnit_Framework_TestCase
+{
+    public function setUp()
+    {
+        $this->newsParser = new NewsParser();
+    }
+
+    public function testGetPlatform()
+    {
+        $this->assertTrue($this->newsParser->getPlatform('ch-nzz') instanceof NzzParser);
+    }
+
+    public function testGetCache()
+    {
+        $this->assertTrue($this->newsParser->getCache() instanceof Cache);
+    }
+
+    public function testSetCacheDir()
+    {
+        $this->newsParser->setCacheDir('foo');
+        $this->assertSame('foo', $this->newsParser->getCache()->getCacheDir());
+    }
+}

Tests/NewsParser/Parser/Platforms/PlatformParserTest.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace Sprain\NewsParser\Test\NewsParser\Parser\Platforms;
+
+require_once(__DIR__ . '/../../../TestData/Platforms/FOO/BarParser.php');
+use Sprain\NewsParser\Cache\Cache;
+use Sprain\NewsParser\Test\TestData\Platforms\FOO\BarParser;
+
+class PlatformParserTest extends \PHPUnit_Framework_TestCase
+{
+    public function setUp()
+    {
+        $this->parser = new BarParser();
+    }
+
+    public function testGetMostReadArticles()
+    {
+        $this->assertSame('5 most read', $this->parser->getMostReadArticles(5));
+    }
+
+    public function testGetRecommendedArticles()
+    {
+        $this->assertSame('5 recommended', $this->parser->getRecommendedArticles(5));
+    }
+
+    public function testGetMostCommentedArticles()
+    {
+        $this->assertSame('5 most commented', $this->parser->getMostCommentedArticles(5));
+    }
+
+    public function testSetGetCache()
+    {
+        $this->parser->setCache(new Cache());
+        $this->assertTrue($this->parser->getCache() instanceof Cache);
+    }
+
+    public function testGetRootUrl()
+    {
+        $this->assertSame('http://www.bar.com', $this->parser->getRootUrl());
+    }
+
+    public function testGetIconUrl()
+    {
+        $this->assertSame('http://www.google.com/s2/favicons?domain=http://www.bar.com', $this->parser->getIconUrl());
+    }
+}

Tests/TestData/Platforms/FOO/BarParser.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Sprain\NewsParser\Test\TestData\Platforms\FOO;
+
+use Sprain\NewsParser\Parser\Platforms\PlatformParser;
+use Sunra\PhpSimple\HtmlDomParser;
+
+class BarParser extends PlatformParser
+{
+    protected $rootUrl = 'http://www.bar.com';
+
+    /**
+     * @inherit
+     */
+    public  function doGetMostReadArticles($limit = null)
+    {
+        return $limit . ' most read';
+    }
+
+    /**
+     * @inherit
+     */
+    public function doGetRecommendedArticles($limit = null)
+    {
+        return $limit . ' recommended';
+    }
+
+    /**
+     * @inherit
+     */
+    public function doGetMostCommentedArticles($limit = null)
+    {
+        return $limit . ' most commented';
+    }
+}

phpunit.xml.dist

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit colors="true" bootstrap="vendor/autoload.php">
+    <testsuites>
+        <testsuite name="NewsParser">
+            <directory>./Tests</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist>
+            <directory>./Tests</directory>
+        </whitelist>
+    </filter>
+</phpunit>