ArgumentOrganiserTest - Code Metrics - Inspection of "wip: Decoupling argument injection from store busi..." - gorghoa/ScenarioStateBehatExtension - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#31)

by Rodrigue

created 2017-07-27 19:33 UTC

ArgumentOrganiserTest A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	93
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

Metric	Value
wmc	3
lcom	1
cbo	4
dl	0
loc	93
rs	10
c	0
b	0
f	0

3 Methods

Rating	Name	Size	Complexity
A	setUp()	13	1
A	annotationMockFactory()	4	1
B	testOrganiseArguments()	38	1

<?php

/*
 * This file is part of the StepArgumentInjectorBehatExtension project.
 *
 * (c) Rodrigue Villetard <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Gorghoa\StepArgumentInjectorBehatExtension\Argument;

use Doctrine\Common\Annotations\Reader;
use Gorghoa\StepArgumentInjectorBehatExtension\Annotation\StepInjectorArgument;
use Prophecy\Prophecy\ObjectProphecy;
use Behat\Testwork\Argument\ArgumentOrganiser as BehatArgumentOrganiser;

/**
 * @author Vincent Chalamon <[email protected]>
 * @author Rodrigue Villetard <[email protected]>
 */
class ArgumentOrganiserTest extends \PHPUnit_Framework_TestCase
{
    /**
     * @var ArgumentOrganiser
     */
    private $organiser;

    /**
     * @var ObjectProphecy|ArgumentOrganiser
     */
    private $organiserMock;

    /**
     * @var ObjectProphecy
     */
    private $initializerMock;


    /**
     * @var ObjectProphecy|\ReflectionMethod
     */
    private $functionMock;

    /**
     * @var ObjectProphecy|Reader
     */
    private $readerMock;

    /**
     * @var StepArgumentHolder
     */
    private $holderMock;

    protected function setUp()
    {
        $this->organiserMock = $this->prophesize(BehatArgumentOrganiser::class);
        $this->functionMock = $this->prophesize(\ReflectionMethod::class);
        $this->readerMock = $this->prophesize(Reader::class);
        $this->holderMock = $this->prophesize(StepArgumentHolder::class);


        $this->organiser = new ArgumentOrganiser(
            $this->organiserMock->reveal(),
            [$this->holderMock->reveal()],
            $this->readerMock->reveal()
        );
    }

    /**
     * @return ObjectProphecy
     */
    private function annotationMockFactory()
    {
        return $this->prophesize(StepInjectorArgument::class);
    }

    public function testOrganiseArguments()
    {
        $this->functionMock->getParameters()->willReturn([
            (object) ['name' => 'scenarioBanana'], // argument with injector annotation and **a service hold** value
            (object) ['name' => 'gorilla'], // argument with injector annotation but **no service hold** value
            (object) ['name' => 'foo'], // argument not handled by this extension
        ])->shouldBeCalledTimes(1);

        $annot1 = $this->annotationMockFactory();
        $annot1->getArgument()->willReturn('scenarioBanana')->shouldBeCalledTimes(1);
        $annot1->reveal();

        $annot2 = $this->annotationMockFactory();
        $annot2->getArgument()->willReturn('gorilla')->shouldBeCalledTimes(1);
        $annot2->reveal();

        $this->readerMock->getMethodAnnotations($this->functionMock->reveal())->willReturn([
            $annot1,
            $annot2,
        ])->shouldBeCalledTimes(1);

        $this->holderMock->doesHandleStepArgument($annot1)->willReturn(true);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $this->holderMock->doesHandleStepArgument($annot2)->willReturn(false);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        $this->holderMock->getStepArgumentValueFor($annot1)->willReturn('yammyBanana')->shouldBeCalledTimes(1);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $this->holderMock->getStepArgumentValueFor($annot2)->shouldNotBeCalled();
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        $this->holderMock->getStepArgumentValueFor($annot2);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        $this->organiserMock->organiseArguments($this->functionMock->reveal(), [
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.
}
            0 => 'scenarioBanana',
            1 => 'gorilla',
            'scenarioBanana' => 'yammyBanana',
            2 => 'yammyBanana',
        ])->shouldBeCalledTimes(1);

        $this->organiser->organiseArguments($this->functionMock->reveal(), ['scenarioBanana', 'gorilla']);
    }
}


1			<?php
2
3			/*
4			* This file is part of the StepArgumentInjectorBehatExtension project.
5			*
6			* (c) Rodrigue Villetard <[email protected]>
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 Gorghoa\StepArgumentInjectorBehatExtension\Argument;
13
14			use Doctrine\Common\Annotations\Reader;
15			use Gorghoa\StepArgumentInjectorBehatExtension\Annotation\StepInjectorArgument;
16			use Prophecy\Prophecy\ObjectProphecy;
17			use Behat\Testwork\Argument\ArgumentOrganiser as BehatArgumentOrganiser;
18
19			/**
20			* @author Vincent Chalamon <[email protected]>
21			* @author Rodrigue Villetard <[email protected]>
22			*/
23			class ArgumentOrganiserTest extends \PHPUnit_Framework_TestCase
24			{
25			/**
26			* @var ArgumentOrganiser
27			*/
28			private $organiser;
29
30			/**
31			* @var ObjectProphecy\|ArgumentOrganiser
32			*/
33			private $organiserMock;
34
35			/**
36			* @var ObjectProphecy
37			*/
38			private $initializerMock;
			0 ignored issues – show Unused Code introduced 2017-07-27 15:54 UTC by Report Bug Copy Issue Report The property `$initializerMock` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
39
40			/**
41			* @var ObjectProphecy\|\ReflectionMethod
42			*/
43			private $functionMock;
44
45			/**
46			* @var ObjectProphecy\|Reader
47			*/
48			private $readerMock;
49
50			/**
51			* @var StepArgumentHolder
52			*/
53			private $holderMock;
54
55			protected function setUp()
56			{
57			$this->organiserMock = $this->prophesize(BehatArgumentOrganiser::class);
58			$this->functionMock = $this->prophesize(\ReflectionMethod::class);
59			$this->readerMock = $this->prophesize(Reader::class);
60			$this->holderMock = $this->prophesize(StepArgumentHolder::class);
			0 ignored issues – show Documentation Bug introduced 2017-07-27 15:54 UTC by Report Bug Copy Issue Report It seems like `$this->prophesize(\Gorgh...pArgumentHolder::class)` of type `object<Prophecy\Prophecy\ObjectProphecy>` is incompatible with the declared type `object<Gorghoa\StepArgum...ent\StepArgumentHolder>` of property `$holderMock`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
61
62			$this->organiser = new ArgumentOrganiser(
63			$this->organiserMock->reveal(),
64			[$this->holderMock->reveal()],
65			$this->readerMock->reveal()
66			);
67			}
68
69			/**
70			* @return ObjectProphecy
71			*/
72			private function annotationMockFactory()
73			{
74			return $this->prophesize(StepInjectorArgument::class);
75			}
76
77			public function testOrganiseArguments()
78			{
79			$this->functionMock->getParameters()->willReturn([
80			(object) ['name' => 'scenarioBanana'], // argument with injector annotation and a service hold value
81			(object) ['name' => 'gorilla'], // argument with injector annotation but no service hold value
82			(object) ['name' => 'foo'], // argument not handled by this extension
83			])->shouldBeCalledTimes(1);
84
85			$annot1 = $this->annotationMockFactory();
86			$annot1->getArgument()->willReturn('scenarioBanana')->shouldBeCalledTimes(1);
87			$annot1->reveal();
88
89			$annot2 = $this->annotationMockFactory();
90			$annot2->getArgument()->willReturn('gorilla')->shouldBeCalledTimes(1);
91			$annot2->reveal();
92
93			$this->readerMock->getMethodAnnotations($this->functionMock->reveal())->willReturn([
94			$annot1,
95			$annot2,
96			])->shouldBeCalledTimes(1);
97
98			$this->holderMock->doesHandleStepArgument($annot1)->willReturn(true);
			0 ignored issues – show Documentation introduced 2017-07-27 19:35 UTC by Report Bug Copy Issue Report `$annot1` is of type `object<Prophecy\Prophecy\ObjectProphecy>`, but the function expects a `object<Gorghoa\StepArgum...n\StepInjectorArgument>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history... Bug introduced 2017-07-27 15:54 UTC by Report Bug Copy Issue Report The method `willReturn` cannot be called on `$this->holderMock->doesH...leStepArgument($annot1)` (of type `boolean`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
99			$this->holderMock->doesHandleStepArgument($annot2)->willReturn(false);
			0 ignored issues – show Documentation introduced 2017-07-27 19:35 UTC by Report Bug Copy Issue Report `$annot2` is of type `object<Prophecy\Prophecy\ObjectProphecy>`, but the function expects a `object<Gorghoa\StepArgum...n\StepInjectorArgument>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history... Bug introduced 2017-07-27 15:54 UTC by Report Bug Copy Issue Report The method `willReturn` cannot be called on `$this->holderMock->doesH...leStepArgument($annot2)` (of type `boolean`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
100
101			$this->holderMock->getStepArgumentValueFor($annot1)->willReturn('yammyBanana')->shouldBeCalledTimes(1);
			0 ignored issues – show Documentation introduced 2017-07-27 19:35 UTC by Report Bug Copy Issue Report `$annot1` is of type `object<Prophecy\Prophecy\ObjectProphecy>`, but the function expects a `object<Gorghoa\StepArgum...n\StepInjectorArgument>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
102			$this->holderMock->getStepArgumentValueFor($annot2)->shouldNotBeCalled();
			0 ignored issues – show Documentation introduced 2017-07-27 19:35 UTC by Report Bug Copy Issue Report `$annot2` is of type `object<Prophecy\Prophecy\ObjectProphecy>`, but the function expects a `object<Gorghoa\StepArgum...n\StepInjectorArgument>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
103
104			$this->holderMock->getStepArgumentValueFor($annot2);
			0 ignored issues – show Documentation introduced 2017-07-27 19:35 UTC by Report Bug Copy Issue Report `$annot2` is of type `object<Prophecy\Prophecy\ObjectProphecy>`, but the function expects a `object<Gorghoa\StepArgum...n\StepInjectorArgument>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
105
106			$this->organiserMock->organiseArguments($this->functionMock->reveal(), [
			0 ignored issues – show Bug introduced 2017-07-27 15:54 UTC by Report Bug Copy Issue Report The method `organiseArguments` does only exist in `Gorghoa\StepArgumentInje...ument\ArgumentOrganiser`, but not in `Prophecy\Prophecy\ObjectProphecy`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: 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. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
107			0 => 'scenarioBanana',
108			1 => 'gorilla',
109			'scenarioBanana' => 'yammyBanana',
110			2 => 'yammyBanana',
111			])->shouldBeCalledTimes(1);
112
113			$this->organiser->organiseArguments($this->functionMock->reveal(), ['scenarioBanana', 'gorilla']);
114			}
115			}
116

gorghoa / ScenarioStateBehatExtension

GitHub Access Token became invalid

Pull Request — master (#31)

ArgumentOrganiserTest A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

3 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like