PHPCodeBrowser\Tests\View\ViewReviewTest

Complexity

Total Complexity

10

Size/Duplication

Total Lines	222
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	testGenerateWithTextHighlighter()	0	33	2
A	testGenerateUnknownType()	0	16	1
A	setUp()	0	10	2
A	testGenerateMultiple()	0	20	1
A	testGenerateNoIssues()	0	16	1
A	testCopyResourceFolders()	0	10	1
A	testGenerate()	0	26	1
A	testGenerateIndex()	0	16	1

<?php

/**
 * Test case
 *
 * Copyright (c) 2007-2010, Mayflower GmbH
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in
 *     the documentation and/or other materials provided with the
 *     distribution.
 *
 *   * Neither the name of Mayflower GmbH nor the names of his
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * @category PHP_CodeBrowser
 *
 * @author Simon Kohlmeyer <simon.kohlmeyer@mayflower.de
 *
 * @copyright 2007-2010 Mayflower GmbH
 *
 * @license http://www.opensource.org/licenses/bsd-license.php  BSD License
 *
 * @version SVN: $Id$
 *
 * @link http://www.phpunit.de/
 *
 * @since File available since  0.1.0
 */

namespace PHPCodeBrowser\Tests\View;

use PHPCodeBrowser\File;
use PHPCodeBrowser\Helper\IOHelper;
use PHPCodeBrowser\Issue;
use PHPCodeBrowser\Tests\AbstractTestCase;
use PHPCodeBrowser\View\ViewReview;
use PHPUnit\Framework\MockObject\MockObject;

/**
 * ViewReviewTest
 *
 * @category PHP_CodeBrowser
 *
 * @author Simon Kohlmeyer <simon.kohlmeyer@mayflower.de>
 *
 * @copyright 2007-2010 Mayflower GmbH
 *
 * @license http://www.opensource.org/licenses/bsd-license.php  BSD License
 *
 * @version Release: @package_version@
 *
 * @link http://www.phpunit.de/
 *
 * @since Class available since  0.1.0
 */
class ViewReviewTest extends AbstractTestCase
{
    /**
     * The ViewReview object to test.
     *
     * @var ViewReview
     */
    protected $viewReview;

    /**
     * IOHelper mock to simulate filesystem interaction.
     *
     * @var MockObject
     */
    protected $ioMock;

    /**
     * (non-PHPDoc)
     *
     * @see tests/cbAbstractTests#setUp()
     */
    protected function setUp(): void
    {
        parent::setUp();

        $this->ioMock = $this->createMock(IOHelper::class);

        $this->viewReview = new ViewReview(
            \getenv('PHPCB_TEMPLATE_DIR') ? \getenv('PHPCB_TEMPLATE_DIR') : \dirname(__FILE__, 5).'/templates',
            self::$testOutputDir,
            $this->ioMock
        );
    }

    /**
     * Test the generate method without any issues
     *
     * @return void
     */
    public function testGenerateNoIssues(): void
    {
        $expectedFile = self::$testOutputDir.DIRECTORY_SEPARATOR.\basename(__FILE__).'.html';

        $this->ioMock->expects(static::once())
            ->method('loadFile')
            ->with(static::equalTo(__FILE__))
            ->willReturn(\file_get_contents(__FILE__));
        $this->ioMock->expects(static::once())
            ->method('createFile')
            ->with(static::equalTo($expectedFile));

        $this->viewReview->generate(
            [],
            __FILE__,
            __DIR__.DIRECTORY_SEPARATOR
        );
    }

    /**
     * Test the generate method with an issue
     *
     * @return void
     */
    public function testGenerate(): void
    {
        $issueList = [
            new Issue(
                __FILE__,
                80,
                85,
                'finder',
                'description',
                'severe'
            ),
        ];

        $expectedFile = self::$testOutputDir.DIRECTORY_SEPARATOR.\basename(__FILE__).'.html';
        $this->ioMock->expects(static::once())
            ->method('loadFile')
            ->with(static::equalTo(__FILE__))
            ->willReturn(\file_get_contents(__FILE__));
        $this->ioMock->expects(static::once())
            ->method('createFile')
            ->with(static::equalTo($expectedFile));

        $this->viewReview->generate(
            $issueList,
            __FILE__,
            __DIR__.DIRECTORY_SEPARATOR
        );
    }

    /**
     * Test the generate method with multiple errors on one line.
     *
     * @return void
     */
    public function testGenerateMultiple(): void
    {
        $issueList = [
            new Issue(__FILE__, 80, 80, 'finder', 'description', 'severe'),
            new Issue(__FILE__, 80, 80, 'other finder', 'other description', 'more severe'),
        ];

        $expectedFile = self::$testOutputDir.DIRECTORY_SEPARATOR.\basename(__FILE__).'.html';
        $this->ioMock->expects(static::once())
            ->method('loadFile')
            ->with(static::equalTo(__FILE__))
            ->willReturn(\file_get_contents(__FILE__));
        $this->ioMock->expects(static::once())
            ->method('createFile')
            ->with(static::equalTo($expectedFile));

        $this->viewReview->generate(
            $issueList,
            __FILE__,
            __DIR__.DIRECTORY_SEPARATOR
        );
    }

    /**
     * Try to test highlighting with Text_Highlighter
     *
     * @return void
     */
    public function testGenerateWithTextHighlighter(): void
    {
        if (!\class_exists('Text_Highlighter')) {
            static::markTestIncomplete();
        }

        $html     = <<< EOT
<html>
    <head>
        <title>Title</title>
    </head>
    <body>
        <p>Body</p>
    </body>
</html>
EOT;
        $prefix   = '/dir/';
        $fileName = $prefix.'file.html';

        $expectedFile = self::$testOutputDir.'/file.html.html';
        $this->ioMock->expects(static::once())
            ->method('loadFile')
            ->with(static::equalTo($fileName))
            ->willReturn($html);
        $this->ioMock->expects(static::once())
            ->method('createFile')
            ->with(static::equalTo($expectedFile));

        $issues = [
            new Issue($fileName, 5, 5, 'finder', 'description', 'severity'),
        ];

        $this->viewReview->generate($issues, $fileName, $prefix);
    }

    /**
     * Test highlighting of unknown code files.
     *
     * @return void
     */
    public function testGenerateUnknownType(): void
    {
        $expectedFile = self::$testOutputDir.DIRECTORY_SEPARATOR.\basename(self::$xmlBasic).'.html';

        $this->ioMock->expects(static::once())
            ->method('createFile')
            ->with(static::equalTo($expectedFile));

        $issueList = [
            new Issue(self::$xmlBasic, 5, 5, 'finder', 'description', 'severity'),
        ];

        $this->viewReview->generate(
            $issueList,
            self::$xmlBasic,
            \dirname(self::$xmlBasic).DIRECTORY_SEPARATOR
        );
    }

    /**
     * Test if the resource folders are copied.
     *
     * @return void
     */
    public function testCopyResourceFolders(): void
    {
        $this->ioMock->expects(static::exactly(3))
            ->method('copyDirectory')
            ->with(
                static::matchesRegularExpression(
                    '|^'.\realpath(__DIR__.'/../../../templates/').'|'
                )
            );
        $this->viewReview->copyResourceFolders();
    }

    /**
     * Test the generateIndex function
     *
     * @return void
     */
    public function testGenerateIndex(): void
    {
        $files = [
            's/A/somefile.php'    => new File('s/A/somefile.php'),
            's/file.php'          => new File('s/file.php'),
            's/B/anotherfile.php' => new File('s/B/anotherfile.php'),
        ];

        $this->ioMock->expects(static::once())
            ->method('createFile')
            ->with(
                static::logicalAnd(
                    static::stringEndsWith('index.html')
                )
            );
        $this->viewReview->generateIndex($files);
    }
}