PagerfantaViewSubscriberTest::testApiWithHateoas() - Code Metrics - Inspection of "[Resource] Move pagerfanta configuration in the su..." - php-lug/lug - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#64)

by Eric

created 2016-07-19 08:47 UTC

PagerfantaViewSubscriberTest::testApiWithHateoas() B

↳ Parent: PagerfantaViewSubscriberTest

Complexity

Conditions	3
Paths	1

Size

Total Lines	81
Code Lines	63

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	81
rs	8.8076
cc	3
eloc	63
nc	1
nop	0

How to fix Long Method

<?php

/*
 * This file is part of the Lug package.
 *
 * (c) Eric GELOEN <[email protected]>
 *
 * For the full copyright and license information, please read the LICENSE
 * file that was distributed with this source code.
 */

namespace Lug\Bundle\ResourceBundle\Tests\Rest\View;

use FOS\RestBundle\View\View;
use Hateoas\Configuration\Route;
use Hateoas\Representation\Factory\PagerfantaFactory;
use Lug\Bundle\ResourceBundle\Rest\RestEvents;
use Lug\Bundle\ResourceBundle\Rest\View\EventSubscriber\PagerfantaViewSubscriber;
use Lug\Bundle\ResourceBundle\Rest\View\ViewEvent;
use Lug\Bundle\ResourceBundle\Routing\ParameterResolverInterface;
use Lug\Component\Resource\Model\ResourceInterface;
use Pagerfanta\Pagerfanta;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\Form\FormRendererInterface;
use Symfony\Component\HttpFoundation\ParameterBag;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RequestStack;

/**
 * @author GeLo <[email protected]>
 */
class PagerfantaViewSubscriberTest extends \PHPUnit_Framework_TestCase
{
    /**
     * @var PagerfantaViewSubscriber
     */
    private $subscriber;

    /**
     * @var \PHPUnit_Framework_MockObject_MockObject|ParameterResolverInterface
     */
    private $parameterResolver;

    /**
     * @var \PHPUnit_Framework_MockObject_MockObject|FormRendererInterface
     */
    private $pagerfantaFactory;

    /**
     * @var \PHPUnit_Framework_MockObject_MockObject|RequestStack
     */
    private $requestStack;

    /**
     * {@inheritdoc}
     */
    protected function setUp()
    {
        $this->parameterResolver = $this->createParameterResolverMock();
        $this->pagerfantaFactory = $this->createPagerfantaFactoryMock();
        $this->requestStack = $this->createRequestStackMock();

        $this->subscriber = new PagerfantaViewSubscriber(
            $this->parameterResolver,
            $this->pagerfantaFactory,
            $this->requestStack
        );
    }

    public function testInheritance()
    {
        $this->assertInstanceOf(EventSubscriberInterface::class, $this->subscriber);
    }

    public function testSubscribedEvents()

    {
        $this->assertSame(
            [RestEvents::VIEW => [
                ['onApi', -3000],
                ['onView', -3000],
            ]],
            $this->subscriber->getSubscribedEvents()
        );
    }

    public function testApiWithoutApi()

    {
        $this->parameterResolver
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->expects($this->once())
            ->method('resolveApi')
            ->will($this->returnValue(false));

        $event = $this->createViewEventMock();
        $event
            ->expects($this->never())
            ->method('getView');

        $this->subscriber->onApi($event);
    }

    public function testApiWithoutPagerfanta()

    {
        $this->parameterResolver
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->expects($this->once())
            ->method('resolveApi')
            ->will($this->returnValue(true));

        $event = $this->createViewEventMock();
        $event
            ->expects($this->once())
            ->method('getView')
            ->will($this->returnValue($view = $this->createViewMock()));

        $view
            ->expects($this->once())
            ->method('getData')
            ->will($this->returnValue('data'));

        $view
            ->expects($this->never())
            ->method('setData');

        $this->subscriber->onApi($event);
    }

    public function testApiWithPagerfanta()
    {
        $this->parameterResolver
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->expects($this->once())
            ->method('resolveApi')
            ->will($this->returnValue(true));

        $event = $this->createViewEventMock();
        $event
            ->expects($this->once())
            ->method('getView')
            ->will($this->returnValue($view = $this->createViewMock()));

        $view
            ->expects($this->once())
            ->method('getData')
            ->will($this->returnValue($pagerfanta = $this->createPagerfantaMock()));

        $this->parameterResolver
            ->expects($this->once())
            ->method('resolveCurrentPage')
            ->will($this->returnValue($currentPage = 2));

        $pagerfanta
            ->expects($this->once())
            ->method('setCurrentPage')
            ->with($this->identicalTo($currentPage));

        $this->parameterResolver
            ->expects($this->once())
            ->method('resolveMaxPerPage')
            ->will($this->returnValue($maxPerPage = 20));

        $pagerfanta
            ->expects($this->once())
            ->method('setMaxPerPage')
            ->with($this->identicalTo($maxPerPage));

        $pagerfanta
            ->expects($this->once())
            ->method('getIterator')
            ->will($this->returnValue(new \ArrayIterator($values = ['value'])));

        $view
            ->expects($this->once())
            ->method('setData')
            ->with($this->identicalTo($values));

        $this->subscriber->onApi($event);
    }

    public function testApiWithHateoas()
    {
        $this->parameterResolver
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->expects($this->once())
            ->method('resolveApi')
            ->will($this->returnValue(true));

        $this->parameterResolver
            ->expects($this->once())
            ->method('resolveHateoas')
            ->will($this->returnValue(true));

        $event = $this->createViewEventMock();
        $event
            ->expects($this->once())
            ->method('getView')
            ->will($this->returnValue($view = $this->createViewMock()));

        $view
            ->expects($this->once())
            ->method('getData')
            ->will($this->returnValue($pagerfanta = $this->createPagerfantaMock()));

        $this->parameterResolver
            ->expects($this->once())
            ->method('resolveCurrentPage')
            ->will($this->returnValue($currentPage = 2));

        $pagerfanta
            ->expects($this->once())
            ->method('setCurrentPage')
            ->with($this->identicalTo($currentPage));

        $this->parameterResolver
            ->expects($this->once())
            ->method('resolveMaxPerPage')
            ->will($this->returnValue($maxPerPage = 20));

        $pagerfanta
            ->expects($this->once())
            ->method('setMaxPerPage')
            ->with($this->identicalTo($maxPerPage));

        $this->requestStack
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->expects($this->once())
            ->method('getMasterRequest')
            ->will($this->returnValue($request = $this->createRequestMock()));

        $request->attributes
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
            ->expects($this->exactly(2))
            ->method('get')
            ->will($this->returnValueMap([
                ['_route', null, false, $route = 'route'],
                ['_route_params', [], false, $routeParameters = ['foo' => 'bar']],
            ]));

        $request->query
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
            ->expects($this->once())
            ->method('all')
            ->will($this->returnValue($queryParameters = ['baz' => 'bat']));

        $this->pagerfantaFactory
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->expects($this->once())
            ->method('createRepresentation')
            ->with(
                $this->identicalTo($pagerfanta),
                $this->callback(function ($config) use ($route, $routeParameters, $queryParameters) {
                    return $config instanceof Route
                        && $config->getName() === $route
                        && $config->getParameters() === array_merge($routeParameters, $queryParameters);
                })
            )
            ->will($this->returnValue($representation = 'representation'));

        $view
            ->expects($this->once())
            ->method('setData')
            ->with($this->identicalTo($representation));

        $this->subscriber->onApi($event);
    }

    /**
     * @expectedException \Lug\Bundle\ResourceBundle\Exception\RequestNotFoundException
     * @expectedExceptionMessage The request could not be found.
     */
    public function testApiWithHateoasButWithoutRequest()
    {
        $this->parameterResolver
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->expects($this->once())
            ->method('resolveApi')
            ->will($this->returnValue(true));

        $this->parameterResolver
            ->expects($this->once())
            ->method('resolveHateoas')
            ->will($this->returnValue(true));

        $event = $this->createViewEventMock();
        $event
            ->expects($this->once())
            ->method('getView')
            ->will($this->returnValue($view = $this->createViewMock()));

        $view
            ->expects($this->once())
            ->method('getData')
            ->will($this->returnValue($pagerfanta = $this->createPagerfantaMock()));

        $this->requestStack
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->expects($this->once())
            ->method('getMasterRequest')
            ->will($this->returnValue(null));

        $this->subscriber->onApi($event);
    }

    public function testViewWithApi()

    {
        $this->parameterResolver
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->expects($this->once())
            ->method('resolveApi')
            ->will($this->returnValue(true));

        $event = $this->createViewEventMock();
        $event
            ->expects($this->never())
            ->method('getView');

        $this->subscriber->onView($event);
    }

    public function testViewWithoutPagerfanta()

    {
        $this->parameterResolver
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->expects($this->once())
            ->method('resolveApi')
            ->will($this->returnValue(false));

        $event = $this->createViewEventMock();
        $event
            ->expects($this->once())
            ->method('getView')
            ->will($this->returnValue($view = $this->createViewMock()));

        $view
            ->expects($this->once())
            ->method('getData')
            ->will($this->returnValue('data'));

        $view
            ->expects($this->never())
            ->method('setTemplateVar');

        $this->subscriber->onView($event);
    }

    public function testViewWithPagerfanta()
    {
        $this->parameterResolver
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            ->expects($this->once())
            ->method('resolveApi')
            ->will($this->returnValue(false));

        $event = $this->createViewEventMock();
        $event
            ->expects($this->once())
            ->method('getView')
            ->will($this->returnValue($view = $this->createViewMock()));

        $view
            ->expects($this->once())
            ->method('getData')
            ->will($this->returnValue($this->createPagerfantaMock()));

        $event
            ->expects($this->once())
            ->method('getResource')
            ->will($this->returnValue($resource = $this->createResourceMock()));

        $resource
            ->expects($this->once())
            ->method('getName')
            ->will($this->returnValue($name = 'name'));

        $view
            ->expects($this->once())
            ->method('setTemplateVar')
            ->with($this->identicalTo($name.'s'));

        $this->subscriber->onView($event);
    }

    /**
     * @return \PHPUnit_Framework_MockObject_MockObject|ParameterResolverInterface
     */
    private function createParameterResolverMock()
    {
        return $this->createMock(ParameterResolverInterface::class);
    }

    /**
     * @return \PHPUnit_Framework_MockObject_MockObject|PagerfantaFactory
     */
    private function createPagerfantaFactoryMock()
    {
        return $this->createMock(PagerfantaFactory::class);
    }

    /**
     * @return \PHPUnit_Framework_MockObject_MockObject|RequestStack
     */
    private function createRequestStackMock()
    {
        return $this->createMock(RequestStack::class);
    }

    /**
     * @return \PHPUnit_Framework_MockObject_MockObject|ViewEvent
     */
    private function createViewEventMock()
    {
        return $this->createMock(ViewEvent::class);
    }

    /**
     * @return \PHPUnit_Framework_MockObject_MockObject|View
     */
    private function createViewMock()
    {
        return $this->createMock(View::class);
    }

    /**
     * @return \PHPUnit_Framework_MockObject_MockObject|Pagerfanta
     */
    private function createPagerfantaMock()
    {
        return $this->createMock(Pagerfanta::class);
    }

    /**
     * @return \PHPUnit_Framework_MockObject_MockObject|Request
     */
    private function createRequestMock()

    {
        $request = $this->createMock(Request::class);

        $request->attributes = $this->createParameterBagMock();
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        $request->query = $this->createParameterBagMock();
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}

        return $request;
    }

    /**
     * @return \PHPUnit_Framework_MockObject_MockObject|ParameterBag
     */
    private function createParameterBagMock()
    {
        return $this->createMock(ParameterBag::class);
    }

    /**
     * @return \PHPUnit_Framework_MockObject_MockObject|ResourceInterface
     */
    private function createResourceMock()
    {
        return $this->createMock(ResourceInterface::class);
    }
}


Pull Request — master (#64)

PagerfantaViewSubscriberTest::testApiWithHateoas() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

1			<?php
2
3			/*
4			* This file is part of the Lug package.
5			*
6			* (c) Eric GELOEN <[email protected]>
7			*
8			* For the full copyright and license information, please read the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Lug\Bundle\ResourceBundle\Tests\Rest\View;
13
14			use FOS\RestBundle\View\View;
15			use Hateoas\Configuration\Route;
16			use Hateoas\Representation\Factory\PagerfantaFactory;
17			use Lug\Bundle\ResourceBundle\Rest\RestEvents;
18			use Lug\Bundle\ResourceBundle\Rest\View\EventSubscriber\PagerfantaViewSubscriber;
19			use Lug\Bundle\ResourceBundle\Rest\View\ViewEvent;
20			use Lug\Bundle\ResourceBundle\Routing\ParameterResolverInterface;
21			use Lug\Component\Resource\Model\ResourceInterface;
22			use Pagerfanta\Pagerfanta;
23			use Symfony\Component\EventDispatcher\EventSubscriberInterface;
24			use Symfony\Component\Form\FormRendererInterface;
25			use Symfony\Component\HttpFoundation\ParameterBag;
26			use Symfony\Component\HttpFoundation\Request;
27			use Symfony\Component\HttpFoundation\RequestStack;
28
29			/**
30			* @author GeLo <[email protected]>
31			*/
32			class PagerfantaViewSubscriberTest extends \PHPUnit_Framework_TestCase
33			{
34			/**
35			* @var PagerfantaViewSubscriber
36			*/
37			private $subscriber;
38
39			/**
40			* @var \PHPUnit_Framework_MockObject_MockObject\|ParameterResolverInterface

php-lug / lug

Pull Request — master (#64)

PagerfantaViewSubscriberTest::testApiWithHateoas() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like