FilesystemDataSourceTest::tearDown() - Code Metrics - Inspection of "Fixed bug #107: ".htaccess not being included in b..." - spress/spress - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed
Push — master ( 215d68...967d39 )

by Yo!
created 2017-04-09 08:14 UTC
FilesystemDataSourceTest::tearDown() A

↳ Parent: FilesystemDataSourceTest
Complexity

Conditions	1
Paths	1
Size

Total Lines	5
Code Lines	3
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	4
CRAP Score	1
Importance

Changes
Metric	Value
c	0
b	0
f	0
dl	0
loc	5
ccs	4
cts	4
cp	1
rs	9.4285
cc	1
eloc	3
nc	1
nop	0
crap	1
<?php

/*
 * This file is part of the Yosymfony\Spress.
 *
 * (c) YoSymfony <http://github.com/yosymfony>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Yosymfony\Spress\Core\Tests\DataSource\Filesystem;

use PHPUnit\Framework\TestCase;
use Symfony\Component\Filesystem\Filesystem;
use Yosymfony\Spress\Core\DataSource\Filesystem\FilesystemDataSource;
use Yosymfony\Spress\Core\DataSource\ItemInterface;

class FilesystemDataSourceTest extends TestCase
{
    protected $sourcePath;
    protected $extraPagesPath;
    protected $textExtensions;

    public function setUp()
    {
        $this->sourcePath = sys_get_temp_dir().'/spress-tests';

        $fs = new FileSystem();
        $fs->mirror(__dir__.'/../../fixtures/project/src', $this->sourcePath);

        $this->extraPagesPath = __dir__.'/../../fixtures/extra_pages';
        $this->textExtensions = ['htm', 'html', 'html.twig', 'twig,html', 'js', 'less', 'markdown', 'md', 'mkd', 'mkdn', 'coffee', 'css', 'erb', 'haml', 'handlebars', 'hb', 'ms', 'mustache', 'php', 'rb', 'sass', 'scss', 'slim', 'txt', 'xhtml', 'xml'];
    }

    public function tearDown()
    {
        $fs = new FileSystem();
        $fs->remove($this->sourcePath);
    }

    public function testProcessItems()
    {
        $fsDataSource = new FilesystemDataSource([
            'source_root' => $this->sourcePath,
            'text_extensions' => $this->textExtensions,
        ]);

        $fsDataSource->load();

        $items = $fsDataSource->getItems();
        $layouts = $fsDataSource->getLayouts();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        $includes = $fsDataSource->getIncludes();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        $itemAttributes = $items['about/index.html']->getAttributes();
        $this->assertCount(4, $itemAttributes);
        $this->assertEquals('default', $itemAttributes['layout']);

        $itemAttributes = $items['posts/2016-02-02-spress-2.1.1-released.md']->getAttributes();
        $this->assertArrayHasKey('title_path', $itemAttributes);
        $this->assertEquals('spress-2.1.1-released', $itemAttributes['title_path']);

        $itemAttributes = $items['posts/2013-08-12-post-example-1.md']->getAttributes();
        $this->assertCount(10, $itemAttributes);
        $this->assertArrayNotHasKey('meta_filename', $itemAttributes);
        $this->assertStringStartsWith('Post example 1', $items['posts/2013-08-12-post-example-1.md']->getContent());

        $itemAttributes = $items['posts/books/2013-08-11-best-book.md']->getAttributes();
        $this->assertArrayHasKey('categories', $itemAttributes);
        $this->assertCount(1, $itemAttributes['categories']);

        $itemAttributes = $items['posts/2013-08-12-post-example-2.mkd']->getAttributes();
        $this->assertArrayHasKey('title', $itemAttributes);
        $this->assertArrayHasKey('title_path', $itemAttributes);
        $this->assertArrayHasKey('date', $itemAttributes);
        $this->assertEquals('post example 2', $itemAttributes['title']);
        $this->assertEquals('2013-08-12', $itemAttributes['date']);

        $itemAttributes = $items['sitemap.xml']->getAttributes();
        $this->assertEquals('sitemap', $itemAttributes['name']);
    }

    public function testGetItemsMustReturnTheItemsOfASite()
    {
        $fsDataSource = new FilesystemDataSource([
            'source_root' => $this->sourcePath,
            'text_extensions' => $this->textExtensions,
        ]);

        $fsDataSource->load();
        $items = $fsDataSource->getItems();

        $this->assertCount(15, $items);
        $this->assertArrayHasKey('index.html', $items);
        $this->assertArrayHasKey('LICENSE', $items);
        $this->assertArrayHasKey('about/index.html', $items);
        $this->assertArrayHasKey('about/me/index.html', $items);
        $this->assertArrayHasKey('pages/index.html', $items);
        $this->assertArrayHasKey('projects/index.md', $items);
        $this->assertArrayHasKey('robots.txt', $items);
        $this->assertArrayHasKey('sitemap.xml', $items);
        $this->assertArrayHasKey('posts/2013-08-12-post-example-1.md', $items);
        $this->assertArrayHasKey('posts/2013-08-12-post-example-2.mkd', $items);
        $this->assertArrayHasKey('posts/2016-02-02-spress-2.1.1-released.md', $items);
        $this->assertArrayHasKey('posts/books/2013-08-11-best-book.md', $items);
        $this->assertArrayHasKey('posts/books/2013-09-19-new-book.md', $items);
        $this->assertArrayHasKey('assets/style.css', $items);
        $this->assertArrayHasKey('.htaccess', $items);
    }

    public function testGetLayoutsMustReturnTheLayoutsOfASite()

    {
        $fsDataSource = new FilesystemDataSource([
            'source_root' => $this->sourcePath,
            'text_extensions' => $this->textExtensions,
        ]);

        $fsDataSource->load();
        $layouts = $fsDataSource->getLayouts();

        $this->assertCount(1, $layouts);
        $this->assertArrayHasKey('default.html', $layouts);
    }

    public function testGetIncludesMustReturnTheLayoutsOfASite()

    {
        $fsDataSource = new FilesystemDataSource([
            'source_root' => $this->sourcePath,
            'text_extensions' => $this->textExtensions,
        ]);

        $fsDataSource->load();
        $includes = $fsDataSource->getIncludes();

        $this->assertCount(1, $includes);
        $this->assertArrayHasKey('test.html', $includes);
    }

    public function testGetLayoutsMustReturnsAnArrayOfItemInterface()

    {
        $fsDataSource = new FilesystemDataSource([
            'source_root' => $this->sourcePath,
            'text_extensions' => $this->textExtensions,
        ]);

        $fsDataSource->load();
        $layouts = $fsDataSource->getLayouts();

        $this->assertTrue(is_array($layouts), 'getLayouts must return an array');
        $this->assertContainsOnlyInstancesOf(
            ItemInterface::class,
            $layouts,
            'getLayouts can only returns elements of ItemInterface type'
        );
    }

    public function testGetIncludesMustReturnsAnArrayOfItemInterface()

    {
        $fsDataSource = new FilesystemDataSource([
            'source_root' => $this->sourcePath,
            'text_extensions' => $this->textExtensions,
        ]);

        $fsDataSource->load();
        $includes = $fsDataSource->getIncludes();

        $this->assertTrue(is_array($includes), 'getIncludes must return an array');
        $this->assertContainsOnlyInstancesOf(
            ItemInterface::class,
            $includes,
            'getIncludes can only returns elements of ItemInterface type'
        );
    }

    public function testGetItemsMustReturnsAnArrayOfItemInterface()

    {
        $fsDataSource = new FilesystemDataSource([
            'source_root' => $this->sourcePath,
            'text_extensions' => $this->textExtensions,
        ]);

        $fsDataSource->load();
        $items = $fsDataSource->getItems();

        $this->assertTrue(is_array($items), 'getItems must return an array');
        $this->assertContainsOnlyInstancesOf(
            ItemInterface::class,
            $items,
            'getItems can only returns elements of ItemInterface type'
        );
    }

    public function testGetTypeOfAnIncludeItemMustBeInclude()

    {
        $fsDataSource = new FilesystemDataSource([
            'source_root' => $this->sourcePath,
            'text_extensions' => $this->textExtensions,
        ]);

        $fsDataSource->load();
        $includes = $fsDataSource->getIncludes();

        $this->assertEquals(
            'include',
            $includes['test.html']->getType(),
            'The type of an include item must be "include"'
        );
    }

    public function testGetContentOfAnIncludeItemMustBeRight()

    {
        $fsDataSource = new FilesystemDataSource([
            'source_root' => $this->sourcePath,
            'text_extensions' => $this->textExtensions,
        ]);

        $fsDataSource->load();
        $includes = $fsDataSource->getIncludes();

        $this->assertRegExp(
            '/Include test/',
            $includes['test.html']->getContent(),
            'The content of the include item must contains the text "Include test"'
        );
    }

    public function testGetTypeOfAnLayoutItemMustBeLayout()

    {
        $fsDataSource = new FilesystemDataSource([
            'source_root' => $this->sourcePath,
            'text_extensions' => $this->textExtensions,
        ]);

        $fsDataSource->load();
        $layouts = $fsDataSource->getLayouts();

        $this->assertEquals(
            'layout',
            $layouts['default.html']->getType(),
            'The type of a layout item must be "layout"'
        );
    }

    public function testGetContentOfALayoutItemMustBeRight()

    {
        $fsDataSource = new FilesystemDataSource([
            'source_root' => $this->sourcePath,
            'text_extensions' => $this->textExtensions,
        ]);

        $fsDataSource->load();
        $layouts = $fsDataSource->getLayouts();

        $this->assertRegExp(
            '/Welcome to my site/',
            $layouts['default.html']->getContent(),
            'The content of the layout item must contains the text "Welcome to my site"'
        );
    }

    public function testGetBinaryOfAnItemMustReturnTrueIfThereIsNotFilenameExtension()

    {
        $fsDataSource = new FilesystemDataSource([
            'source_root' => $this->sourcePath,
            'text_extensions' => $this->textExtensions,
        ]);

        $fsDataSource->load();
        $items = $fsDataSource->getItems();

        $this->assertTrue(
            $items['LICENSE']->isBinary(),
            'An item without a filename extension must be treated as a binary item'
        );
    }

    public function testGetBinaryOfAnItemMustReturnFalseIfTheFilenameExtensionBelongsToTextExtensions()

    {
        $fsDataSource = new FilesystemDataSource([
            'source_root' => $this->sourcePath,
            'text_extensions' => $this->textExtensions,
        ]);

        $fsDataSource->load();
        $items = $fsDataSource->getItems();

        $this->assertFalse(
            $items['posts/2013-08-12-post-example-1.md']->isBinary(),
            'An item with a filename extension included in the text extension list must be treated as a text item'
        );
    }

    public function testGetBinaryOfAnItemMustReturnTrueIfTheFilenameExtensionDoesNotBelongsToTextExtensions()
    {
        $fsDataSource = new FilesystemDataSource([
            'source_root' => $this->sourcePath,
            'text_extensions' => ['html'],
        ]);

        $fsDataSource->load();
        $items = $fsDataSource->getItems();

        $this->assertTrue(
            $items['posts/2013-08-12-post-example-1.md']->isBinary(),
            'An item with a filename extension not included in the text extension list must be treated as a binary item'
        );
    }

    public function testGetPathOfABinaryItemMustHasSourceAndRelativePaths()

    {
        $fsDataSource = new FilesystemDataSource([
            'source_root' => $this->sourcePath,
            'text_extensions' => $this->textExtensions,
        ]);

        $fsDataSource->load();
        $items = $fsDataSource->getItems();
        $item = $items['LICENSE'];

        $this->assertTrue(
            strlen($item->getPath('source')) > 0,
            'A binary item must have a source path'
        );
        $this->assertTrue(
            strlen($item->getPath('relative')) > 0,
            'A binary item must have a relative path'
        );
    }

    public function testGetPathOfATextItemMustHasOnlyARelativePaths()

    {
        $fsDataSource = new FilesystemDataSource([
            'source_root' => $this->sourcePath,
            'text_extensions' => $this->textExtensions,
        ]);

        $fsDataSource->load();
        $items = $fsDataSource->getItems();
        $item = $items['index.html'];

        $this->assertTrue(
            strlen($item->getPath('relative')) > 0,
            'A text item must have a relative path'
        );
        $this->assertFalse(
            strlen($item->getPath('source')) > 0,
            'A text item must not have a source path'
        );
    }

    public function testGetAttributesMustReturnsTheBasicAttributes()
    {
        $fsDataSource = new FilesystemDataSource([
            'source_root' => $this->sourcePath,
            'text_extensions' => $this->textExtensions,
        ]);

        $fsDataSource->load();
        $items = $fsDataSource->getItems();
        $item = $items['index.html'];
        $itemAttributes = $item->getAttributes();

        $this->assertArrayHasKey('mtime', $itemAttributes);
        $this->assertArrayHasKey('filename', $itemAttributes);
        $this->assertArrayHasKey('extension', $itemAttributes);
    }

    public function testGetLayoutsMustGivesPreferenceSiteLayoutsOverThemeLayoutsWhenThereIsAEnabledTheme()

    {
        $fsDataSource = new FilesystemDataSource([
            'source_root' => $this->sourcePath,
            'text_extensions' => $this->textExtensions,
            'theme_name' => 'theme01',
        ]);

        $fsDataSource->load();
        $layouts = $fsDataSource->getLayouts();

        $this->assertCount(2, $layouts);
        $this->assertRegExp('/Welcome to my site/', $layouts['default.html']->getContent());
    }

    public function testGetIncludesMustGivesPreferenceSiteIncludesOverThemeIncludesWhenThereIsAEnabledTheme()

    {
        $fsDataSource = new FilesystemDataSource([
            'source_root' => $this->sourcePath,
            'text_extensions' => $this->textExtensions,
            'theme_name' => 'theme01',
        ]);

        $fsDataSource->load();
        $includes = $fsDataSource->getIncludes();

        $this->assertCount(2, $includes);
        $this->assertRegExp('/Include test/', $includes['test.html']->getContent());
    }

    public function testGetItemsMustGivesPreferenceSiteAssetsOverThemeAssetsWhenThereIsAEnabledTheme()

    {
        $fsDataSource = new FilesystemDataSource([
            'source_root' => $this->sourcePath,
            'text_extensions' => $this->textExtensions,
            'theme_name' => 'theme01',
        ]);

        $fsDataSource->load();
        $items = $fsDataSource->getItems();
        $this->assertRegExp('/styles of the site/', $items['assets/style.css']->getContent());
    }

    public function testGetItemsMustReturnThemeAssetsIfItDoesNotExistsInTheSiteAssetsWhenThereIsAEnabledTheme()
    {
        $fsDataSource = new FilesystemDataSource([
            'source_root' => $this->sourcePath,
            'text_extensions' => $this->textExtensions,
            'theme_name' => 'theme01',
        ]);

        $fsDataSource->load();
        $items = $fsDataSource->getItems();

        $this->assertArrayHasKey('assets/extra.css', $items);
        $this->assertRegExp('/extra styles of the theme/', $items['assets/extra.css']->getContent());
    }

    public function testGetIncludesMustReturnThemeIncludesIfItDoesNotExistsInTheSiteIncludesWhenThereIsAEnabledTheme()

    {
        $fsDataSource = new FilesystemDataSource([
            'source_root' => $this->sourcePath,
            'text_extensions' => $this->textExtensions,
            'theme_name' => 'theme01',
        ]);

        $fsDataSource->load();
        $includes = $fsDataSource->getIncludes();

        $this->assertCount(2, $includes);
        $this->assertRegExp('/Include theme 01 - test2/', $includes['test2.html']->getContent());
    }

    public function testGetLayoutsMustReturnThemeLayoutsIfItDoesNotExistsInTheSiteLayoutsWhenThereIsAEnabledTheme()

    {
        $fsDataSource = new FilesystemDataSource([
            'source_root' => $this->sourcePath,
            'text_extensions' => $this->textExtensions,
            'theme_name' => 'theme01',
        ]);

        $fsDataSource->load();
        $layouts = $fsDataSource->getLayouts();

        $this->assertCount(2, $layouts);
        $this->assertRegExp('/Theme 01 layout/', $layouts['page.html']->getContent());
    }

    public function testGetItemsMustReturnAnExtraItemWhenIncludeOptionIsSetWithAFile()

    {
        $fsDataSource = new FilesystemDataSource([
            'source_root' => $this->sourcePath,
            'include' => [$this->extraPagesPath.'/extra-page1.html'],
            'text_extensions' => $this->textExtensions,
        ]);
        $fsDataSource->load();
        $items = $fsDataSource->getItems();

        $this->assertCount(16, $items);
        $this->assertArrayHasKey('extra-page1.html', $items);
    }

    public function testGetItemsMustReturnDotItemsWhenThereAreDotFiles()

    {
        $fsDataSource = new FilesystemDataSource([
            'source_root' => $this->sourcePath,
            'text_extensions' => $this->textExtensions,
        ]);
        $fsDataSource->load();
        $items = $fsDataSource->getItems();

        $this->assertArrayHasKey('.htaccess', $items);
    }

    public function testGetItemsMustNotReturnItemsInVCSFolders()
    {
        $gitDir = $this->sourcePath.'/.git';
        $fs = new FileSystem();
        $fs->dumpFile($gitDir.'/HEAD', '');
        $fsDataSource = new FilesystemDataSource([
            'source_root' => $this->sourcePath,
            'text_extensions' => $this->textExtensions,
        ]);
        $fsDataSource->load();
        $items = $fsDataSource->getItems();

        $this->assertArrayNotHasKey('HEAD', $items);
    }

    public function testGetItemsMustReturnItemsOfIncludedFolderWhenIncludeOptionIsUsedWithAFolder()

    {
        $fsDataSource = new FilesystemDataSource([
            'source_root' => $this->sourcePath,
            'include' => [$this->extraPagesPath],
            'text_extensions' => $this->textExtensions,
        ]);
        $fsDataSource->load();

        $this->assertCount(17, $fsDataSource->getItems());
    }

    public function testGetItemMustNotContainExcludedItemWhenExcludeOptionIsSetWithAFile()

    {
        $fsDataSource = new FilesystemDataSource([
            'source_root' => $this->sourcePath,
            'exclude' => ['robots.txt'],
            'text_extensions' => $this->textExtensions,
        ]);
        $fsDataSource->load();

        $this->assertCount(14, $fsDataSource->getItems());
    }

    public function testExcludeFolder()

    {
        $fsDataSource = new FilesystemDataSource([
            'source_root' => $this->sourcePath,
            'exclude' => ['about'],
            'text_extensions' => $this->textExtensions,
        ]);
        $fsDataSource->load();

        $this->assertCount(13, $fsDataSource->getItems());
    }

    public function testAvoidRenderizerPath()

    {
        $fsDataSource = new FilesystemDataSource([
            'source_root' => $this->sourcePath,
            'text_extensions' => $this->textExtensions,
            'avoid_renderizer_path' => ['projects'],
        ]);

        $fsDataSource->load();

        $items = $fsDataSource->getItems();

        $this->assertCount(15, $items);

        $itemAttributes = $items['projects/index.md']->getAttributes();
        $this->assertArrayHasKey('avoid_renderizer', $itemAttributes);

        $itemAttributes = $items['posts/books/2013-08-11-best-book.md']->getAttributes();
        $this->assertArrayNotHasKey('avoid_renderizer', $itemAttributes);
    }

    public function testAvoidRenderizerFilenameExtension()

    {
        $fsDataSource = new FilesystemDataSource([
            'source_root' => $this->sourcePath,
            'text_extensions' => $this->textExtensions,
            'avoid_renderizer_extension' => ['mkd'],
        ]);

        $fsDataSource->load();

        $items = $fsDataSource->getItems();

        $this->assertCount(15, $items);

        $itemAttributes = $items['posts/2013-08-12-post-example-2.mkd']->getAttributes();
        $this->assertArrayHasKey('avoid_renderizer', $itemAttributes);

        $itemAttributes = $items['posts/books/2013-08-11-best-book.md']->getAttributes();
        $this->assertArrayNotHasKey('avoid_renderizer', $itemAttributes);
    }

    /**
     * @expectedException Yosymfony\Spress\Core\ContentManager\Exception\MissingAttributeException
     */
    public function testConfigNoParams()
    {
        $fsDataSource = new FilesystemDataSource([]);
        $fsDataSource->load();
    }

    /**
     * @expectedException \Yosymfony\Spress\Core\ContentManager\Exception\MissingAttributeException
     */
    public function testNoParamTextExtensions()
    {
        $fsDataSource = new FilesystemDataSource([
            'source_root' => $this->sourcePath,
        ]);
        $fsDataSource->load();
    }

    /**
     * @expectedException Yosymfony\Spress\Core\ContentManager\Exception\AttributeValueException
     */
    public function testBadParamSourceRoot()
    {
        $fsDataSource = new FilesystemDataSource([
            'source_root' => [],
            'text_extensions' => $this->textExtensions,
        ]);
        $fsDataSource->load();
    }

    /**
     * @expectedException Yosymfony\Spress\Core\ContentManager\Exception\AttributeValueException
     */
    public function testBadParamInclude()

    {
        $fsDataSource = new FilesystemDataSource([
            'source_root' => $this->sourcePath,
            'include' => './',
            'text_extensions' => $this->textExtensions,
        ]);
        $fsDataSource->load();
    }

    /**
     * @expectedException Yosymfony\Spress\Core\ContentManager\Exception\AttributeValueException
     */
    public function testBadParamExclude()

    {
        $fsDataSource = new FilesystemDataSource([
            'source_root' => $this->sourcePath,
            'exclude' => './',
            'text_extensions' => $this->textExtensions,
        ]);
        $fsDataSource->load();
    }
}

1		<?php
2
3		/*
4		* This file is part of the Yosymfony\Spress.
5		*
6		* (c) YoSymfony <http://github.com/yosymfony>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace Yosymfony\Spress\Core\Tests\DataSource\Filesystem;
13
14		use PHPUnit\Framework\TestCase;
15		use Symfony\Component\Filesystem\Filesystem;
16		use Yosymfony\Spress\Core\DataSource\Filesystem\FilesystemDataSource;
17		use Yosymfony\Spress\Core\DataSource\ItemInterface;
18
19		class FilesystemDataSourceTest extends TestCase
20		{
21		protected $sourcePath;
22	16	protected $extraPagesPath;
23		protected $textExtensions;
24	16
25	16	public function setUp()
26	16	{
27	16	$this->sourcePath = sys_get_temp_dir().'/spress-tests';
28
29	1	$fs = new FileSystem();
30		$fs->mirror(__dir__.'/../../fixtures/project/src', $this->sourcePath);
31	1
32	1	$this->extraPagesPath = __dir__.'/../../fixtures/extra_pages';
33	1	$this->textExtensions = ['htm', 'html', 'html.twig', 'twig,html', 'js', 'less', 'markdown', 'md', 'mkd', 'mkdn', 'coffee', 'css', 'erb', 'haml', 'handlebars', 'hb', 'ms', 'mustache', 'php', 'rb', 'sass', 'scss', 'slim', 'txt', 'xhtml', 'xml'];
34	1	}
35
36	1	public function tearDown()
37		{
38	1	$fs = new FileSystem();
39	1	$fs->remove($this->sourcePath);
40	1	}
spress / spress

Push — master ( 215d68...967d39 )

FilesystemDataSourceTest::tearDown() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
