Issues in TransformerAbstractTest.php - Fixed Issues - Inspection of "clean up php code sniffer violations and update co..." - thephpleague/fractal - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ebc071...9dcd83 )

by Tobias

created 2022-03-07 19:53 UTC

test/TransformerAbstractTest.php (26 issues)

Labels

Severity

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php namespace League\Fractal\Test;

use League\Fractal\Manager;
use League\Fractal\Resource\Collection;
use League\Fractal\Resource\Item;
use League\Fractal\Scope;
use Mockery as m;
use PHPUnit\Framework\TestCase;

class TransformerAbstractTest extends TestCase
{
    /**
     * @covers \League\Fractal\TransformerAbstract::setAvailableIncludes
     */
    public function testSetAvailableIncludes()
    {
        $transformer = m::mock('League\Fractal\TransformerAbstract')->makePartial();
        $this->assertInstanceOf('League\Fractal\TransformerAbstract', $transformer->setAvailableIncludes(['foo']));
    }

    /**
     * @covers \League\Fractal\TransformerAbstract::getAvailableIncludes
     */
    public function testGetAvailableIncludes()

    {
        $transformer = m::mock('League\Fractal\TransformerAbstract')->makePartial();

        $transformer->setAvailableIncludes(['foo', 'bar']);
        $this->assertSame(['foo', 'bar'], $transformer->getAvailableIncludes());
    }

    /**
     * @covers \League\Fractal\TransformerAbstract::setDefaultIncludes
     */
    public function testSetDefaultIncludes()
    {
        $transformer = m::mock('League\Fractal\TransformerAbstract')->makePartial();
        $this->assertInstanceOf('League\Fractal\TransformerAbstract', $transformer->setDefaultIncludes(['foo']));
    }

    /**
     * @covers \League\Fractal\TransformerAbstract::getDefaultIncludes
     */
    public function testGetDefaultIncludes()

    {
        $transformer = m::mock('League\Fractal\TransformerAbstract')->makePartial();

        $transformer->setDefaultIncludes(['foo', 'bar']);
        $this->assertSame(['foo', 'bar'], $transformer->getDefaultIncludes());
    }

    /**
     * @covers \League\Fractal\TransformerAbstract::setCurrentScope
     */
    public function testSetCurrentScope()

    {
        $transformer = $this->getMockForAbstractClass('League\Fractal\TransformerAbstract');
        $manager = new Manager();
        $scope = new Scope($manager, m::mock('League\Fractal\Resource\ResourceAbstract'));
        $this->assertInstanceOf('League\Fractal\TransformerAbstract', $transformer->setCurrentScope($scope));
    }

    /**
     * @covers \League\Fractal\TransformerAbstract::getCurrentScope
     */
    public function testGetCurrentScope()

    {
        $transformer = m::mock('League\Fractal\TransformerAbstract')->makePartial();
        $manager = new Manager();
        $scope = new Scope($manager, m::mock('League\Fractal\Resource\ResourceAbstract'));
        $transformer->setCurrentScope($scope);
        $this->assertSame($transformer->getCurrentScope(), $scope);
    }

    public function testProcessEmbeddedResourcesNoAvailableIncludes()

    {
        $transformer = m::mock('League\Fractal\TransformerAbstract')->makePartial();

        $manager = new Manager();
        $manager->parseIncludes('foo');

        $scope = new Scope($manager, m::mock('League\Fractal\Resource\ResourceAbstract'));
        $this->assertFalse($transformer->processIncludedResources($scope, ['some' => 'data']));
    }

    public function testProcessEmbeddedResourcesNoDefaultIncludes()

    {
        $transformer = m::mock('League\Fractal\TransformerAbstract')->makePartial();

        $manager = new Manager();
        $manager->parseIncludes('foo');

        $scope = new Scope($manager, m::mock('League\Fractal\Resource\ResourceAbstract'));
        $this->assertFalse($transformer->processIncludedResources($scope, ['some' => 'data']));
    }

    /**
     * @covers \League\Fractal\TransformerAbstract::processIncludedResources
     * @covers \League\Fractal\TransformerAbstract::callIncludeMethod
     * @expectedException \BadMethodCallException
     */
    public function testProcessEmbeddedResourcesInvalidAvailableEmbed()
    {
        $transformer = m::mock('League\Fractal\TransformerAbstract')->makePartial();

        $manager = new Manager();
        $manager->parseIncludes('book');

        $scope = new Scope($manager, m::mock('League\Fractal\Resource\ResourceAbstract'));
        $transformer->setCurrentScope($scope);

        $transformer->setAvailableIncludes(['book']);
        $transformer->processIncludedResources($scope, []);
    }

    /**
     * @covers \League\Fractal\TransformerAbstract::processIncludedResources
     * @covers \League\Fractal\TransformerAbstract::callIncludeMethod
     * @expectedException \BadMethodCallException
     */
    public function testProcessEmbeddedResourcesInvalidDefaultEmbed()

    {
        $transformer = m::mock('League\Fractal\TransformerAbstract')->makePartial();

        $manager = new Manager();

        $scope = new Scope($manager, m::mock('League\Fractal\Resource\ResourceAbstract'));

        $transformer->setDefaultIncludes(['book']);
        $transformer->processIncludedResources($scope, []);
    }

    /**
     * @covers \League\Fractal\TransformerAbstract::processIncludedResources
     * @covers \League\Fractal\TransformerAbstract::callIncludeMethod
     */
    public function testProcessIncludedAvailableResources()

    {
        $manager = new Manager();
        $manager->parseIncludes('book');
        $transformer = m::mock('League\Fractal\TransformerAbstract[transform]');

        $transformer->shouldReceive('includeBook')->once()->andReturnUsing(function ($data) {
            return new Item(['included' => 'thing'], function ($data) {
                return $data;
            });
        });

        $transformer->setAvailableIncludes(['book', 'publisher']);
        $scope = new Scope($manager, new Item([], $transformer));
        $included = $transformer->processIncludedResources($scope, ['meh']);
        $this->assertSame(['book' => ['data' => ['included' => 'thing']]], $included);
    }

    /**
     * @covers \League\Fractal\TransformerAbstract::processIncludedResources
     * @covers \League\Fractal\TransformerAbstract::figureOutWhichIncludes
     */
    public function testProcessExcludedAvailableResources()

    {
        $manager = new Manager();
        $transformer = m::mock('League\Fractal\TransformerAbstract[transform]');
        $scope = new Scope($manager, new Item([], $transformer));

        $transformer->shouldReceive('includeBook')->never();

        $transformer->shouldReceive('includePublisher')->once()->andReturnUsing(function ($data) {
            return new Item(['another' => 'thing'], function ($data) {
                return $data;
            });
        });

        // available includes that have been requested are excluded
        $manager->parseIncludes('book,publisher');
        $manager->parseExcludes('book');

        $transformer->setAvailableIncludes(['book', 'publisher']);


        $included = $transformer->processIncludedResources($scope, ['meh']);

        $this->assertSame(['publisher' => ['data' => ['another' => 'thing']]], $included);
    }

    /**
     * @covers \League\Fractal\TransformerAbstract::processIncludedResources
     * @covers \League\Fractal\TransformerAbstract::figureOutWhichIncludes
     */
    public function testProcessExcludedDefaultResources()

    {
        $manager = new Manager();
        $transformer = m::mock('League\Fractal\TransformerAbstract[transform]');
        $scope = new Scope($manager, new Item([], $transformer));

        $transformer->shouldReceive('includeBook')->never();

        $transformer->shouldReceive('includePublisher')->once()->andReturnUsing(function ($data) {
            return new Item(['another' => 'thing'], function ($data) {
                return $data;
            });
        });

        $manager->parseIncludes('book,publisher');
        $manager->parseExcludes('book');

        $transformer->setDefaultIncludes(['book', 'publisher']);


        $included = $transformer->processIncludedResources($scope, ['meh']);

        $this->assertSame(['publisher' => ['data' => ['another' => 'thing']]], $included);
    }

    /**
     * @covers \League\Fractal\TransformerAbstract::processIncludedResources
     * @covers \League\Fractal\TransformerAbstract::callIncludeMethod
     */
    public function testProcessIncludedAvailableResourcesEmptyEmbed()
    {
        $manager = new Manager();
        $manager->parseIncludes(['book']);
        $transformer = m::mock('League\Fractal\TransformerAbstract[transform]');

        $transformer->shouldReceive('includeBook')->once()->andReturn(null);

        $transformer->setAvailableIncludes(['book']);
        $scope = new Scope($manager, new Item([], $transformer));
        $included = $transformer->processIncludedResources($scope, ['meh']);

        $this->assertFalse($included);
    }

    /**
     * @covers \League\Fractal\TransformerAbstract::callIncludeMethod
     * @expectedException \Exception
     * @expectedExceptionMessage Invalid return value from League\Fractal\TransformerAbstract::includeBook().
     */
    public function testCallEmbedMethodReturnsCrap()

    {
        $manager = new Manager();
        $manager->parseIncludes('book');
        $transformer = m::mock('League\Fractal\TransformerAbstract[transform]');

        $transformer->shouldReceive('includeBook')->once()->andReturn(new \stdClass());

        $transformer->setAvailableIncludes(['book']);
        $scope = new Scope($manager, new Item([], $transformer));
        $transformer->processIncludedResources($scope, ['meh']);
    }

    /**
     * @covers \League\Fractal\TransformerAbstract::processIncludedResources
     * @covers \League\Fractal\TransformerAbstract::callIncludeMethod
     */
    public function testProcessEmbeddedDefaultResources()

    {
        $manager = new Manager();
        $transformer = m::mock('League\Fractal\TransformerAbstract[transform]');

        $transformer->shouldReceive('includeBook')->once()->andReturnUsing(function ($data) {
            return new Item(['included' => 'thing'], function ($data) {
                return $data;
            });
        });

        $transformer->setDefaultIncludes(['book']);

        $scope = new Scope($manager, new Item([], $transformer));
        $included = $transformer->processIncludedResources($scope, ['meh']);

        $this->assertSame(['book' => ['data' => ['included' => 'thing']]], $included);
    }

    /**
     * @covers \League\Fractal\TransformerAbstract::processIncludedResources
     * @covers \League\Fractal\TransformerAbstract::callIncludeMethod
     */
    public function testIncludedItem()

    {
        $manager = new Manager();
        $manager->parseIncludes('book');

        $transformer = m::mock('League\Fractal\TransformerAbstract[transform]');
        $transformer->shouldReceive('includeBook')->once()->andReturnUsing(function ($data) {
            return new Item(['included' => 'thing'], function ($data) {
                return $data;
            });
        });

        $transformer->setAvailableIncludes(['book']);

        $scope = new Scope($manager, new Item([], $transformer));
        $included = $transformer->processIncludedResources($scope, ['meh']);

        $this->assertSame(['book' => ['data' => ['included' => 'thing']]], $included);
    }

    public function testParamBagIsProvidedForIncludes()
    {
        $manager = new Manager();
        $manager->parseIncludes('book:foo(bar)');

        $transformer = m::mock('League\Fractal\TransformerAbstract')->makePartial();

        $transformer->shouldReceive('includeBook')
            ->with(m::any(), m::type('\League\Fractal\ParamBag'))
            ->once();

        $transformer->setAvailableIncludes(['book']);
        $scope = new Scope($manager, new Item([], $transformer));

        $this->assertFalse($transformer->processIncludedResources($scope, []));
    }

    /**
     * @covers \League\Fractal\TransformerAbstract::processIncludedResources
     * @covers \League\Fractal\TransformerAbstract::callIncludeMethod
     */
    public function testIncludedCollection()
    {
        $manager = new Manager();
        $manager->parseIncludes('book');

        $collectionData = [
            ['included' => 'thing'],
            ['another' => 'thing'],
        ];

        $transformer = m::mock('League\Fractal\TransformerAbstract[transform]');
        $transformer->shouldReceive('includeBook')->once()->andReturnUsing(function ($data) use ($collectionData) {
            return new Collection($collectionData, function ($data) {
                return $data;
            });
        });

        $transformer->setAvailableIncludes(['book']);

        $scope = new Scope($manager, new Collection([], $transformer));
        $included = $transformer->processIncludedResources($scope, ['meh']);

        $this->assertSame(['book' => ['data' => $collectionData]], $included);
    }

    /**
     * @covers \League\Fractal\TransformerAbstract::processIncludedResources
     * @covers \League\Fractal\TransformerAbstract::callIncludeMethod
     */
    public function testProcessEmbeddedDefaultResourcesEmptyEmbed()

    {
        $transformer = m::mock('League\Fractal\TransformerAbstract[transform]');
        $transformer->shouldReceive('includeBook')->once()->andReturn(null);

        $transformer->setDefaultIncludes(['book']);

        $scope = new Scope(new Manager(), new Item([], $transformer));
        $included = $transformer->processIncludedResources($scope, ['meh']);


        $this->assertFalse($included);
    }

    /**
     * @covers \League\Fractal\TransformerAbstract::item
     */
    public function testItem()
    {
        $mock = m::mock('League\Fractal\TransformerAbstract');
        $item = $mock->item([], function () {
        });
        $this->assertInstanceOf('League\Fractal\Resource\Item', $item);
    }

    /**
     * @covers \League\Fractal\TransformerAbstract::collection
     */
    public function testCollection()
    {
        $mock = m::mock('League\Fractal\TransformerAbstract');
        $collection = $mock->collection([], function () {
        });
        $this->assertInstanceOf('League\Fractal\Resource\Collection', $collection);
    }

    public function tearDown()
    {
        m::close();
    }
}


1		<?php namespace League\Fractal\Test;
2
3		use League\Fractal\Manager;
4		use League\Fractal\Resource\Collection;
5		use League\Fractal\Resource\Item;
6		use League\Fractal\Scope;
7		use Mockery as m;
8		use PHPUnit\Framework\TestCase;
9
10		class TransformerAbstractTest extends TestCase
11		{
12		/**
13		* @covers \League\Fractal\TransformerAbstract::setAvailableIncludes
14		*/
15		public function testSetAvailableIncludes()
16		{
17		$transformer = m::mock('League\Fractal\TransformerAbstract')->makePartial();
18		$this->assertInstanceOf('League\Fractal\TransformerAbstract', $transformer->setAvailableIncludes(['foo']));
19		}
20
21		/**
22		* @covers \League\Fractal\TransformerAbstract::getAvailableIncludes
23		*/
24	View Code Duplication	public function testGetAvailableIncludes()
		0 ignored issues – show Duplication introduced 2019-06-29 17:12 UTC by Report Bug Copy Issue Report Show Similar Issues like this This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
25		{
26		$transformer = m::mock('League\Fractal\TransformerAbstract')->makePartial();
27
28		$transformer->setAvailableIncludes(['foo', 'bar']);
29		$this->assertSame(['foo', 'bar'], $transformer->getAvailableIncludes());
30		}
31
32		/**
33		* @covers \League\Fractal\TransformerAbstract::setDefaultIncludes
34		*/
35		public function testSetDefaultIncludes()
36		{
37		$transformer = m::mock('League\Fractal\TransformerAbstract')->makePartial();
38		$this->assertInstanceOf('League\Fractal\TransformerAbstract', $transformer->setDefaultIncludes(['foo']));
39		}

thephpleague / fractal

Push — master ( ebc071...9dcd83 )

test/TransformerAbstractTest.php (26 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like