EntityContext::thereIs() - Code Metrics - Inspection of "Merge pull request #186 from vincentchalamon/featu..." - KnpLabs/FriendlyContexts - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 013e02...ed6f1d )

by Maxime

created 2017-04-19 20:40 UTC

EntityContext::thereIs() A

↳ Parent: EntityContext

Complexity

Conditions	2
Paths	2

Size

Total Lines	21
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	21
rs	9.3142
c	0
b	0
f	0
cc	2
eloc	13
nc	2
nop	2

<?php

namespace Knp\FriendlyContexts\Context;

use Behat\Gherkin\Node\TableNode;
use Doctrine\ORM\EntityManager;
use Doctrine\ORM\Tools\SchemaTool;

class EntityContext extends Context
{
    /**
     * @Given /^the following ([\w ]+):?$/
     */
    public function theFollowing($name, TableNode $table)
    {
        $entityName = $this->resolveEntity($name)->getName();

        $rows = $table->getRows();
$a = "a";
$ab = "ab";
$abc = "abc";
        $headers = array_shift($rows);

        foreach ($rows as $row) {
            $values     = array_combine($headers, $row);
            $entity     = new $entityName;
            $reflection = new \ReflectionClass($entity);

            do {

                $this
                    ->getRecordBag()
                    ->getCollection($reflection->getName())
                    ->attach($entity, $values)
                ;
                $reflection = $reflection->getParentClass();
            } while (false !== $reflection);

            $this
                ->getEntityHydrator()
                ->hydrate($this->getEntityManager(), $entity, $values)
                ->completeRequired($this->getEntityManager(), $entity)
            ;

            $this->getEntityManager()->persist($entity);
        }

        $this->getEntityManager()->flush();
    }

    /**
     * @Given /^there (?:is|are) (\d+) ((?!\w* like)\w*)$/
     */
    public function thereIs($nbr, $name)
    {
        $entityName = $this->resolveEntity($name)->getName();

        for ($i = 0; $i < $nbr; $i++) {
            $entity = new $entityName;
            $this
                ->getRecordBag()
                ->getCollection($entityName)
                ->attach($entity)
            ;
            $this
                ->getEntityHydrator()
                ->completeRequired($this->getEntityManager(), $entity)
            ;

            $this->getEntityManager()->persist($entity);
        }

        $this->getEntityManager()->flush();
    }

    /**
     * @Given /^there (?:is|are) (\d+) (.*) like:?$/
     */
    public function thereIsLikeFollowing($nbr, $name, TableNode $table)
    {
        $entityName = $this->resolveEntity($name)->getName();

        $rows = $table->getRows();
$a = "a";
$ab = "ab";
$abc = "abc";
        $headers = array_shift($rows);

        for ($i = 0; $i < $nbr; $i++) {
            $row = $rows[$i % count($rows)];
$a = "a";
$ab = "ab";
$abc = "abc";
            $values = array_combine($headers, $row);
            $entity = new $entityName;
            $this
                ->getRecordBag()
                ->getCollection($entityName)
                ->attach($entity, $values)
            ;
            $this
                ->getEntityHydrator()
                ->hydrate($this->getEntityManager(), $entity, $values)
                ->completeRequired($this->getEntityManager(), $entity)
            ;

            $this->getEntityManager()->persist($entity);
        }

        $this->getEntityManager()->flush();
    }

    /**
     * @Given /^(\w+) (.+) should have been (created|deleted)$/
     */
    public function entitiesShouldHaveBeen($expected, $entity, $state)
    {
        $expected = (int) $expected;

        $entityName = $this->resolveEntity($entity)->getName();
        $collection = $this
            ->getRecordBag()
            ->getCollection($entityName)
        ;

        $records = array_map(function ($e) { return $e->getEntity(); }, $collection->all());
// Bad
$a = 5; $b = 6; $c = 7;

// Good
$a = 5;
$b = 6;
$c = 7;
        $entities = $this
            ->getEntityManager()
            ->getRepository($entityName)
            ->createQueryBuilder('o')
            ->resetDQLParts()
            ->select('o')
            ->from($entityName, ' o')
            ->getQuery()
            ->getResult()
        ;

        if ($state === 'created') {
            $diff = $this->compareArray($entities, $records);
            foreach ($diff as $e) {
                $collection->attach($e);
            }
        } else {
            $diff = $this->compareArray($records, $entities);
        }
        $real = count($diff);

        $this
            ->getAsserter()
            ->assertEquals(
                $real,
                $expected,
                sprintf('%s %s should have been %s, %s actually', $expected, $entity, $state, $real)
            )
        ;
    }

    /**
     * @Then /^should be (\d+) (.*) like:?$/
     */
    public function existLikeFollowing($nbr, $name, TableNode $table)
    {
        $entityName = $this->resolveEntity($name)->getName();

        $rows = $table->getRows();
$a = "a";
$ab = "ab";
$abc = "abc";
        $headers = array_shift($rows);

        for ($i = 0; $i < $nbr; $i++) {
            $row = $rows[$i % count($rows)];

            $values = array_map(array($this, 'clean'), array_combine($headers, $row));
            $object = $this->getEntityManager()
                ->getRepository($entityName)
                ->findOneBy($values);

            if (is_null($object)) {
                throw new \Exception(sprintf("There is no object for the following criteria: %s", json_encode($values)));
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
            }
            $this->getEntityManager()->refresh($object);
        }
    }

    /**
     * @BeforeScenario
     */
    public function beforeScenario($event)
    {
        $this->storeTags($event);

        if ($this->hasTags([ 'reset-schema', '~not-reset-schema' ])) {
            foreach ($this->getEntityManagers() as $entityManager) {
                $metadata = $this->getMetadata($entityManager);

                if (!empty($metadata)) {
                    $tool = new SchemaTool($entityManager);
                    $tool->dropSchema($metadata);
                    $tool->createSchema($metadata);
                }
            }
        }

    }

    /**
     * @AfterScenario
     */
    public function afterScenario($event)

    {
        $this->getRecordBag()->clear();
        $this->getUniqueCache()->clear();
        $this->getEntityManager()->clear();
    }

    protected function compareArray(array $a1, array $a2)
    {
        $diff = [];
        foreach ($a1 as $e) {
            if (!in_array($e, $a2)) {
                $diff[] = $e;
            }
        }

        return $diff;
    }

    protected function getMetadata(EntityManager $entityManager)

    {
        return $entityManager->getMetadataFactory()->getAllMetadata();
    }

    protected function getEntityManagers()

    {
        return $this->get('doctrine')->getManagers();
    }

    protected function getConnections()

    {
        return $this->get('doctrine')->getConnections();
    }

    protected function getDefaultOptions()
    {
        return [
            'Entities' => [''],
        ];
    }

    /**
     * @param mixed $value
     *
     * @return mixed
     */
    protected function clean($value)
    {
        return trim($value) === '' ? null : $value;
    }
}


1		<?php
2
3		namespace Knp\FriendlyContexts\Context;
4
5		use Behat\Gherkin\Node\TableNode;
6		use Doctrine\ORM\EntityManager;
7		use Doctrine\ORM\Tools\SchemaTool;
8
9		class EntityContext extends Context
10		{
11		/**
12		* @Given /^the following ([\w ]+):?$/
13		*/
14		public function theFollowing($name, TableNode $table)
15		{
16		$entityName = $this->resolveEntity($name)->getName();
17
18		$rows = $table->getRows();
		0 ignored issues – show Coding Style introduced 2016-04-17 17:46 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 4 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
19		$headers = array_shift($rows);
20
21		foreach ($rows as $row) {
22		$values = array_combine($headers, $row);
23		$entity = new $entityName;
24		$reflection = new \ReflectionClass($entity);
25
26	View Code Duplication	do {
		0 ignored issues – show Duplication introduced 2015-12-02 11:45 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
27		$this
28		->getRecordBag()
29		->getCollection($reflection->getName())
30		->attach($entity, $values)
31		;
32		$reflection = $reflection->getParentClass();
33		} while (false !== $reflection);
34
35		$this
36		->getEntityHydrator()
37		->hydrate($this->getEntityManager(), $entity, $values)
38		->completeRequired($this->getEntityManager(), $entity)
39		;
40
41		$this->getEntityManager()->persist($entity);
42		}
43
44		$this->getEntityManager()->flush();
45		}
46
47		/**
48		* @Given /^there (?:is\|are) (\d+) ((?!\w* like)\w*)$/
49		*/
50		public function thereIs($nbr, $name)
51		{
52		$entityName = $this->resolveEntity($name)->getName();
53
54		for ($i = 0; $i < $nbr; $i++) {
55		$entity = new $entityName;
56		$this
57		->getRecordBag()
58		->getCollection($entityName)
59		->attach($entity)
60		;
61		$this
62		->getEntityHydrator()
63		->completeRequired($this->getEntityManager(), $entity)
64		;
65
66		$this->getEntityManager()->persist($entity);
67		}
68
69		$this->getEntityManager()->flush();
70		}
71
72		/**
73		* @Given /^there (?:is\|are) (\d+) (.*) like:?$/
74		*/
75		public function thereIsLikeFollowing($nbr, $name, TableNode $table)
76		{
77		$entityName = $this->resolveEntity($name)->getName();
78
79		$rows = $table->getRows();
		0 ignored issues – show Coding Style introduced 2016-09-02 14:35 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 4 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
80		$headers = array_shift($rows);
81
82		for ($i = 0; $i < $nbr; $i++) {
83		$row = $rows[$i % count($rows)];
		0 ignored issues – show Coding Style introduced 2015-12-02 11:45 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 4 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
84		$values = array_combine($headers, $row);
85		$entity = new $entityName;
86		$this
87		->getRecordBag()
88		->getCollection($entityName)
89		->attach($entity, $values)
90		;
91		$this
92		->getEntityHydrator()
93		->hydrate($this->getEntityManager(), $entity, $values)
94		->completeRequired($this->getEntityManager(), $entity)
95		;
96
97		$this->getEntityManager()->persist($entity);
98		}
99
100		$this->getEntityManager()->flush();
101		}
102
103		/**
104		* @Given /^(\w+) (.+) should have been (created\|deleted)$/
105		*/
106		public function entitiesShouldHaveBeen($expected, $entity, $state)
107		{
108		$expected = (int) $expected;
109
110		$entityName = $this->resolveEntity($entity)->getName();
111		$collection = $this
112		->getRecordBag()
113		->getCollection($entityName)
114		;
115
116		$records = array_map(function ($e) { return $e->getEntity(); }, $collection->all());
		0 ignored issues – show Coding Style introduced 2016-12-16 10:02 UTC by Report Bug Copy Issue Report It is generally recommended to place each PHP statement on a line by itself. Let’s take a look at an example: // Bad $a = 5; $b = 6; $c = 7; // Good $a = 5; $b = 6; $c = 7; Loading history...
117		$entities = $this
118		->getEntityManager()
119		->getRepository($entityName)
120		->createQueryBuilder('o')
121		->resetDQLParts()
122		->select('o')
123		->from($entityName, ' o')
124		->getQuery()
125		->getResult()
126		;
127
128		if ($state === 'created') {
129		$diff = $this->compareArray($entities, $records);
130		foreach ($diff as $e) {
131		$collection->attach($e);
132		}
133		} else {
134		$diff = $this->compareArray($records, $entities);
135		}
136		$real = count($diff);
137
138		$this
139		->getAsserter()
140		->assertEquals(
141		$real,
142		$expected,
143		sprintf('%s %s should have been %s, %s actually', $expected, $entity, $state, $real)
144		)
145		;
146		}
147
148		/**
149		* @Then /^should be (\d+) (.*) like:?$/
150		*/
151		public function existLikeFollowing($nbr, $name, TableNode $table)
152		{
153		$entityName = $this->resolveEntity($name)->getName();
154
155		$rows = $table->getRows();
		0 ignored issues – show Coding Style introduced 2015-12-02 11:45 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 4 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
156		$headers = array_shift($rows);
157
158		for ($i = 0; $i < $nbr; $i++) {
159		$row = $rows[$i % count($rows)];
160
161		$values = array_map(array($this, 'clean'), array_combine($headers, $row));
162		$object = $this->getEntityManager()
163		->getRepository($entityName)
164		->findOneBy($values);
165
166		if (is_null($object)) {
167		throw new \Exception(sprintf("There is no object for the following criteria: %s", json_encode($values)));
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-01-13 16:13 UTC by Report Bug Copy Issue Report The string literal `There is no object for the following criteria: %s` does not require double quotes, as per coding-style, please use single quotes. PHP provides two ways to mark string literals. Either with single quotes `'literal'` or with double quotes `"literal"`. The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences. String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (`\'`) and the backslash (`\\`). Every other character is displayed as is. Double quoted string literals may contain other variables or more complex escape sequences. <?php $singleQuoted = 'Value'; $doubleQuoted = "\tSingle is $singleQuoted"; print $doubleQuoted; will print an indented: `Single is Value` If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear. For more information on PHP string literals and available escape sequences see the PHP core documentation. Loading history...
168		}
169		$this->getEntityManager()->refresh($object);
170		}
171		}
172
173		/**
174		* @BeforeScenario
175		*/
176		public function beforeScenario($event)
177		{
178		$this->storeTags($event);
179
180		if ($this->hasTags([ 'reset-schema', '~not-reset-schema' ])) {
181		foreach ($this->getEntityManagers() as $entityManager) {
182		$metadata = $this->getMetadata($entityManager);
183
184		if (!empty($metadata)) {
185		$tool = new SchemaTool($entityManager);
186		$tool->dropSchema($metadata);
187		$tool->createSchema($metadata);
188		}
189		}
190		}
191
192		}
193
194		/**
195		* @AfterScenario
196		*/
197		public function afterScenario($event)
		0 ignored issues – show Unused Code introduced 2015-12-02 11:45 UTC by Report Bug Copy Issue Report The parameter `$event` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
198		{
199		$this->getRecordBag()->clear();
200		$this->getUniqueCache()->clear();
201		$this->getEntityManager()->clear();
202		}
203
204		protected function compareArray(array $a1, array $a2)
205		{
206		$diff = [];
207		foreach ($a1 as $e) {
208		if (!in_array($e, $a2)) {
209		$diff[] = $e;
210		}
211		}
212
213		return $diff;
214		}
215
216		protected function getMetadata(EntityManager $entityManager)
		0 ignored issues – show Documentation introduced 2015-12-02 11:45 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
217		{
218		return $entityManager->getMetadataFactory()->getAllMetadata();
219		}
220
221		protected function getEntityManagers()
		0 ignored issues – show Documentation introduced 2015-12-02 11:45 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
222		{
223		return $this->get('doctrine')->getManagers();
224		}
225
226		protected function getConnections()
		0 ignored issues – show Documentation introduced 2015-12-02 11:45 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
227		{
228		return $this->get('doctrine')->getConnections();
229		}
230
231		protected function getDefaultOptions()
232		{
233		return [
234		'Entities' => [''],
235		];
236		}
237
238		/**
239		* @param mixed $value
240		*
241		* @return mixed
242		*/
243		protected function clean($value)
244		{
245		return trim($value) === '' ? null : $value;
246		}
247		}
248

KnpLabs / FriendlyContexts

Push — master ( 013e02...ed6f1d )

EntityContext::thereIs() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like