SakeTest\HtmlElement\View\Helper\HtmlElementTest

Complexity

Total Complexity

23

Size/Duplication

Total Lines	506
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes

0

20 Methods

Rating	Name	Duplication	Size	Complexity
A	errorHandler()	0	4	1
A	hasError()	0	10	4
A	testSetTag()	0	9	1
A	testSetId()	0	9	1
A	testSetClass()	0	9	1
A	testAppendClass()	0	14	1
A	testSetText()	0	9	1
A	testAppendText()	0	14	1
A	testSetAttributes()	0	20	1
A	testToggleHtmlRendering()	0	12	1
A	testSetEscapeText()	0	11	1
A	testSetEscapeHtmlAttributes()	0	11	1
A	testSetEscaper()	0	11	1
A	testInvokeShouldReturnObjectWithSpecifiedOptions()	0	20	1
B	testToStringShouldTriggerErrorIfExceptionOccurs()	0	41	1
B	testRender()	0	26	1
A	testRenderWithSelfClosingTag()	0	19	1
A	getStubWithEscaper()	0	23	1
A	dataProviderForTestRenderWithSelfClosingTag()	0	53	1
A	getMock()	0	6	1

<?php
/**
 * Sake
 *
 * @link      http://github.com/sandrokeil/HtmlElement for the canonical source repository
 * @copyright Copyright (c) 2014-2017 Sandro Keil
 * @license   http://github.com/sandrokeil/HtmlElement/blob/master/LICENSE.txt New BSD License
 */

namespace SakeTest\HtmlElement\View\Helper;

use Sake\HtmlElement\View\Helper\HtmlElement;
use PHPUnit\Framework\TestCase;
use Zend\Escaper\Escaper;

/**
 * Class HtmlElementTest
 *
 * Tests integrity of \SakeTest\HtmlElement\View\Helper\HtmlElement
 */
class HtmlElementTest extends TestCase
{
    /**
     * PHP errors
     *
     * @var array
     */
    protected $errors = array();

    /**
     * Test error handler to get php errors
     *
     * @param int $errno
     * @param string $errstr
     * @param string $errfile
     * @param string $errline
     * @param string $errcontext
     */
    public function errorHandler($errno, $errstr, $errfile, $errline, $errcontext)
    {
        $this->errors[] = compact("errno", "errstr", "errfile", "errline", "errcontext");
    }

    /**
     * Checks if php error was occured
     *
     * @param int $errno
     * @param string $errstr
     * @return bool True if exists, otherwise false
     */
    public function hasError($errno, $errstr)
    {
        foreach ($this->errors as $error) {
            if (false !== strpos($error["errstr"], $errstr)
                && $error["errno"] === $errno) {
                return false;
            }
        }
        return true;
    }

    /**
     * Tests setTag
     *
     * @covers \Sake\HtmlElement\View\Helper\HtmlElement::setTag
     * @covers \Sake\HtmlElement\View\Helper\HtmlElement::getTag
     * @group view
     */
    public function testSetTag()
    {
        $cut = new HtmlElement();
        $tag = 'div';

        $cut->setTag($tag);

        $this->assertEquals($tag, $cut->getTag());
    }

    /**
     * Tests setId
     *
     * @covers \Sake\HtmlElement\View\Helper\HtmlElement::setId
     * @covers \Sake\HtmlElement\View\Helper\HtmlElement::getId
     * @group view
     */
    public function testSetId()
    {
        $cut = new HtmlElement();
        $id = 'unique';

        $cut->setId($id);

        $this->assertEquals($id, $cut->getId());
    }

    /**
     * Tests setClass
     *
     * @covers \Sake\HtmlElement\View\Helper\HtmlElement::setClass
     * @covers \Sake\HtmlElement\View\Helper\HtmlElement::getClass
     * @group view
     */
    public function testSetClass()
    {
        $cut = new HtmlElement();
        $class = 'box shadow';

        $cut->setClass($class);

        $this->assertEquals($class, $cut->getClass());
    }

    /**
     * Tests appendClass
     *
     * @covers \Sake\HtmlElement\View\Helper\HtmlElement::appendClass
     * @depends testSetClass
     * @group view
     */
    public function testAppendClass()
    {
        $cut = new HtmlElement();
        $class = 'box';
        $append = 'shadow';

        $cut->appendClass($append);
        $this->assertEquals($append, $cut->getClass());

        $cut->setClass($class);
        $cut->appendClass($append);

        $this->assertEquals($class . ' ' . $append, $cut->getClass());
    }

    /**
     * Tests setText
     *
     * @covers \Sake\HtmlElement\View\Helper\HtmlElement::setText
     * @covers \Sake\HtmlElement\View\Helper\HtmlElement::getText
     * @group view
     */
    public function testSetText()
    {
        $cut = new HtmlElement();
        $test = 'my text';

        $cut->setText($test);

        $this->assertEquals($test, $cut->getText());
    }

    /**
     * Tests appendText
     *
     * @covers \Sake\HtmlElement\View\Helper\HtmlElement::appendText
     * @depends testSetText
     * @group view
     */
    public function testAppendText()
    {
        $cut = new HtmlElement();
        $text = 'my text';
        $append = 'another text';

        $cut->appendText($append);
        $this->assertEquals($append, $cut->getText());

        $cut->setText($text);
        $cut->appendText($append);

        $this->assertEquals($text . $append, $cut->getText());
    }

    /**
     * Tests setAttributes
     *
     * @covers \Sake\HtmlElement\View\Helper\HtmlElement::setAttributes
     * @covers \Sake\HtmlElement\View\Helper\HtmlElement::getAttributes
     * @group view
     */
    public function testSetAttributes()
    {
        $cut = new HtmlElement();

        $id = 'my id';
        $class = 'box';

        $cut->setId($id);
        $cut->setClass($class);

        $this->assertEquals(array('id' => $id, 'class' => $class), $cut->getAttributes());

        $attributes = array(
            'id' => 'unique',
            'class' => 'box shadow',
        );
        $cut->setAttributes($attributes);

        $this->assertEquals($attributes, $cut->getAttributes());
    }

    /**
     * Tests if html rendering can be enabled / disabled
     *
     * @covers \Sake\HtmlElement\View\Helper\HtmlElement::enableHtml
     * @covers \Sake\HtmlElement\View\Helper\HtmlElement::useHtml
     * @group view
     */
    public function testToggleHtmlRendering()
    {
        $cut = new HtmlElement();

        $this->assertEquals(false, $cut->useHtml(), 'Html rendering is not disabled at default');

        $cut->enableHtml(true);
        $this->assertEquals(true, $cut->useHtml(), 'Html rendering can not be enabled');

        $cut->enableHtml(false);
        $this->assertEquals(false, $cut->useHtml(), 'Html rendering can not be disabled');
    }

    /**
     * Tests setEscapeText
     *
     * @covers \Sake\HtmlElement\View\Helper\HtmlElement::setEscapeText
     * @covers \Sake\HtmlElement\View\Helper\HtmlElement::isEscapeText
     * @group view
     */
    public function testSetEscapeText()
    {
        $cut = new HtmlElement();
        $test = false;

        $this->assertEquals(true, $cut->isEscapeText());

        $cut->setEscapeText($test);

        $this->assertEquals($test, $cut->isEscapeText());
    }

    /**
     * Tests setEscapeHtmlAttributes
     *
     * @covers \Sake\HtmlElement\View\Helper\HtmlElement::setEscapeHtmlAttribute
     * @covers \Sake\HtmlElement\View\Helper\HtmlElement::isEscapeHtmlAttribute
     * @group view
     */
    public function testSetEscapeHtmlAttributes()
    {
        $cut = new HtmlElement();
        $test = false;

        $this->assertEquals(true, $cut->isEscapeHtmlAttribute());

        $cut->setEscapeHtmlAttribute($test);

        $this->assertEquals($test, $cut->isEscapeHtmlAttribute());
    }


    /**
     * Tests setEscaper
     *
     * @covers \Sake\HtmlElement\View\Helper\HtmlElement::setEscaper
     * @covers \Sake\HtmlElement\View\Helper\HtmlElement::getEscaper
     * @group view
     */
    public function testSetEscaper()
    {
        $class = new \ReflectionClass('\Sake\HtmlElement\View\Helper\HtmlElement');
        $method = $class->getMethod('getEscaper');
        $method->setAccessible(true);

        $cut = new HtmlElement();
        $cut->setEscaper(new Escaper());

        $this->assertInstanceOf('\Zend\Escaper\Escaper', $method->invoke($cut));
    }

    /**
     * Tests if call of view helper return new html element object with specified objects
     *
     * @covers \Sake\HtmlElement\View\Helper\HtmlElement::__invoke
     * @depends testSetText
     * @depends testSetClass
     * @depends testToggleHtmlRendering
     * @group view
     */
    public function testInvokeShouldReturnObjectWithSpecifiedOptions()
    {
        $cut = $this->getStubWithEscaper();

        $text = 'my text';
        $tag = 'div';
        $id = 'unique';
        $class = 'box shadow';
        $attributes = array('id' => $id, 'class' => $class);

        /* @var $element HtmlElement */
        $element = $cut($tag, $text, $attributes, true);

        $this->assertInstanceOf('\Sake\HtmlElement\View\Helper\HtmlElement', $element, "Invocation doesn't work");

        $this->assertEquals(true, $element->useHtml(), 'Html rendering was not enabled');
        $this->assertEquals($attributes, $element->getAttributes(), 'Html attributes were not set');
        $this->assertEquals($id, $element->getId(), 'Id attribute was not set');
        $this->assertEquals($class, $element->getClass(), 'Css class was not set');
    }

    /**
     * Tests if html element rendered successfully
     *
     * @covers \Sake\HtmlElement\View\Helper\HtmlElement::render
     * @covers \Sake\HtmlElement\View\Helper\HtmlElement::buildAttributes
     * @covers \Sake\HtmlElement\View\Helper\HtmlElement::__toString
     * @covers \Sake\HtmlElement\View\Helper\HtmlElement::toString
     * @depends testInvokeShouldReturnObjectWithSpecifiedOptions
     * @group view
     */
    public function testToStringShouldTriggerErrorIfExceptionOccurs()
    {
        $this->errors = array();
        set_error_handler(array($this, "errorHandler"));

        $stub = $this->getStubWithEscaper(array('render'));

        $stub->expects($this->any())
            ->method('render')
            ->will(
                $this->throwException(
                    new \Exception(
                        'Exception occurred',
                        0,
                        new \Exception('Previous Exception occurred')
                    )
                )
            );

        $text = 'my text';
        $tag = 'div';
        $id = 'unique';
        $class = 'box shadow';
        $attributes = array(array('id' => $id, 'class' => $class));

        /* @var $element HtmlElement */
        $element = $stub($tag, $text, $attributes);
        $html = (string) $element;

        $this->assertEquals('', $html);

        $this->assertFalse(
            $this->hasError(E_USER_WARNING, 'Exception occurred'),
            sprintf('Error "%s" with message "%s" was not found', E_USER_WARNING, 'Exception occurred')
        );

        $this->assertFalse(
            $this->hasError(E_USER_WARNING, 'Previous Exception occurred'),
            sprintf('Error "%s" with message "%s" was not found', E_USER_WARNING, 'Previous Exception occurred')
        );
    }

    /**
     * Tests if html element rendered successfully
     *
     * @covers \Sake\HtmlElement\View\Helper\HtmlElement::render
     * @covers \Sake\HtmlElement\View\Helper\HtmlElement::buildAttributes
     * @covers \Sake\HtmlElement\View\Helper\HtmlElement::__toString
     * @covers \Sake\HtmlElement\View\Helper\HtmlElement::toString
     * @covers \Sake\HtmlElement\View\Helper\HtmlElement::escapeHtmlAttribute
     * @covers \Sake\HtmlElement\View\Helper\HtmlElement::escapeText
     * @depends testInvokeShouldReturnObjectWithSpecifiedOptions
     * @group view
     */
    public function testRender()
    {
        $stub = $this->getStubWithEscaper();

        $text = 'my text';
        $tag = 'div';
        $id = 'unique';
        $class = 'box shadow';
        $attributes = array('id' => $id, 'class' => $class);

        $expectedHtml = '<div id="unique" class="box shadow">my text</div>';

        /* @var $element HtmlElement */
        $element = $stub($tag, $text, $attributes);

        $this->assertEquals($expectedHtml, $element->render(), 'Html element rendering failed');
        $this->assertEquals($expectedHtml, $element->__toString(), 'Html element rendering failed');
        $this->assertEquals($expectedHtml, $element->toString(), 'Html element rendering failed');

        $element->setEscapeText(false);
        $element->setEscapeHtmlAttribute(false);
        $this->assertEquals($expectedHtml, $element->render(), 'Html element rendering failed');

        $element->enableHtml(true);
        $this->assertEquals($expectedHtml, $element->render(), 'Html element rendering failed');
    }

    /**
     * Tests if html element rendered self closing tag successfully
     *
     * @depends testInvokeShouldReturnObjectWithSpecifiedOptions
     * @dataProvider dataProviderForTestRenderWithSelfClosingTag
     * @covers \Sake\HtmlElement\View\Helper\HtmlElement::render
     * @covers \Sake\HtmlElement\View\Helper\HtmlElement::buildAttributes
     * @covers \Sake\HtmlElement\View\Helper\HtmlElement::__toString
     * @covers \Sake\HtmlElement\View\Helper\HtmlElement::toString
     * @group view
     */
    public function testRenderWithSelfClosingTag($tag)
    {
        $stub = $this->getStubWithEscaper();

        // text should not be rendered
        $text = 'my text';
        $id = 'unique';
        $class = 'full';
        $attributes = array('id' => $id, 'class' => $class);

        $expectedHtml = '<' . $tag . ' id="unique" class="full" />';

        /* @var $element HtmlElement */
        $element = $stub($tag, $text, $attributes);

        $this->assertEquals($expectedHtml, $element->render(), 'Html element rendering failed');
        $this->assertEquals($expectedHtml, $element->__toString(), 'Html element rendering failed');
        $this->assertEquals($expectedHtml, $element->toString(), 'Html element rendering failed');
    }

    /**
     * Returns stub with mocked view plugin manager
     *
     * @return \PHPUnit_Framework_MockObject_MockObject
     */
    protected function getStubWithEscaper(array $methods = array())
    {
        $stub = $this->getMock(
            'Sake\HtmlElement\View\Helper\HtmlElement',
            array_merge(array('getView', 'getEscaper'), $methods)
        );

        $stubEscaper = $this->getMock('Zend\Escaper\Escaper', array('escapeHtml', 'escapeHtmlAttr'));

        $stubEscaper->expects($this->any())
            ->method('escapeHtml')
            ->will($this->returnArgument(0));

        $stubEscaper->expects($this->any())
            ->method('escapeHtmlAttr')
            ->will($this->returnArgument(0));

        $stub->expects($this->any())
            ->method('getEscaper')
            ->will($this->returnValue($stubEscaper));

        return $stub;
    }

    /**
     * data provider for the test method testRenderWithSelfClosingTag()
     *
     * @return array
     */
    public function dataProviderForTestRenderWithSelfClosingTag()
    {
        return array(
            array(
                'tag' => 'area',
            ),
            array(
                'tag' => 'base',
            ),
            array(
                'tag' => 'br',
            ),
            array(
                'tag' => 'col',
            ),
            array(
                'tag' => 'command',
            ),
            array(
                'tag' => 'embed',
            ),
            array(
                'tag' => 'hr',
            ),
            array(
                'tag' => 'img',
            ),
            array(
                'tag' => 'input',
            ),
            array(
                'tag' => 'keygen',
            ),
            array(
                'tag' => 'link',
            ),
            array(
                'tag' => 'meta',
            ),
            array(
                'tag' => 'param',
            ),
            array(
                'tag' => 'source',
            ),
            array(
                'tag' => 'track',
            ),
            array(
                'tag' => 'wbr',
            ),
        );
    }

    private function getMock($class, $methods)
    {
        return $this->getMockBuilder($class)
            ->setMethods($methods)
            ->getMock();
    }
}