TableContext - Code Metrics - KnpLabs/FriendlyContexts - Measure and Improve Code Quality continuously with Scrutinizer

TableContext B
last analyzed 2017-07-04 16:51 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	232
Duplicated Lines	12.07 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes

Metric	Value
wmc	42
lcom	1
cbo	7
dl	28
loc	232
rs	8.295
c	0
b	0
f	0

12 Methods

Rating	Name	Duplication	Size	Complexity
B	iShouldSeeTheFollowingTable()	14	30	5
B	iShouldSeeTheFollowingTablePortion()	14	30	5
B	iShouldSeeATableWithRows()	0	25	4
A	iShouldSeeATable()	0	10	2
D	extractColumns()	0	34	10
A	extractDataFromRow()	0	11	2
A	reorderArrayKeys()	0	14	3
A	getAsserter()	0	4	1
A	getFormater()	0	4	1
A	iShouldSeeATableWithInTheNamedColumn()	0	7	1
B	findTables()	0	22	5
A	extractDataFromPart()	0	11	3

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like TableContext often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use TableContext, and based on these observations, apply Extract Interface, too.

<?php

namespace Knp\FriendlyContexts\Context;

use Behat\Gherkin\Node\TableNode;
use Knp\FriendlyContexts\Utils\Asserter;
use Knp\FriendlyContexts\Utils\TextFormater;

class TableContext extends RawMinkContext
{
    /**
     * @Then /^I should see a table with "([^"]*)" in the "([^"]*)" column$/
     */
    public function iShouldSeeATableWithInTheNamedColumn($list, $column)
    {
        $cells = array_merge(array($column), $this->getFormater()->listToArray($list));
$a = "a";
$ab = "ab";
$abc = "abc";
        $expected = new TableNode(array_map(function($cell) { return [$cell]; }, $cells));
// Bad
$a = 5; $b = 6; $c = 7;

// Good
$a = 5;
$b = 6;
$c = 7;

        $this->iShouldSeeTheFollowingTable($expected);
    }

    /**
     * @Given /^I should see the following table:?$/
     */
    public function iShouldSeeTheFollowingTable($expected)
    {
        if ($expected instanceof TableNode) {
            $expected = $expected->getTable();
        }

        $this->iShouldSeeATable();

        $tables = $this->findTables();
$a = "a";
$ab = "ab";
$abc = "abc";
        $exceptions = array();

        foreach ($tables as $table) {

            try {
                if (false === $extraction = $this->extractColumns(current($expected), $table)) {
                    $this->getAsserter()->assertArrayEquals($expected, $table, true);

                    return;
                }
                $this->getAsserter()->assertArrayEquals($expected, $extraction, true);

                return;
            } catch (\Exception $e) {
                $exceptions[] = $e;
            }
        }

        $message = implode("\n", array_map(function ($e) { return $e->getMessage(); }, $exceptions));
// Bad
$a = 5; $b = 6; $c = 7;

// Good
$a = 5;
$b = 6;
$c = 7;

        throw new \Exception($message);
    }

    /**
     * @Then /^I should see the following table portion:?$/
     */
    public function iShouldSeeTheFollowingTablePortion($expected)
    {
        if ($expected instanceof TableNode) {
            $expected = $this->reorderArrayKeys($expected->getTable());
        }

        $this->iShouldSeeATable();

        $tables = $this->findTables();
$a = "a";
$ab = "ab";
$abc = "abc";
        $exceptions = array();

        foreach ($tables as $table) {

            try {
                if (false === $extraction = $this->extractColumns(current($expected), $table)) {
                    $this->getAsserter()->assertArrayContains($expected, $table);

                    return;
                }
                $this->getAsserter()->assertArrayContains($expected, $extraction);

                return;
            } catch (\Exception $e) {
                $exceptions[] = $e;
            }
        }

        $message = implode("\n", array_map(function ($e) { return $e->getMessage(); }, $exceptions));
// Bad
$a = 5; $b = 6; $c = 7;

// Good
$a = 5;
$b = 6;
$c = 7;

        throw new \Exception($message);
    }

    /**
     * @Then /^I should see a table with ([^"]*) rows$/
     * @Then /^I should see a table with ([^"]*) row$/
     */
    public function iShouldSeeATableWithRows($nbr)
    {
        $nbr = (int) $nbr;

        $this->iShouldSeeATable();
        $exceptions = array();
        $tables = $this->getSession()->getPage()->findAll('css', 'table');
$a = "a";
$ab = "ab";
$abc = "abc";

        foreach ($tables as $table) {
            try {
                if (null !== $body = $table->find('css', 'tbody')) {
                    $table = $body;
                }
                $rows = $table->findAll('css', 'tr');
                $this->getAsserter()->assertEquals($nbr, count($rows), sprintf('Table with %s rows expected, table with %s rows found.', $nbr, count($rows)));
                return;
            } catch (\Exception $e) {
                $exceptions[] = $e;
            }
        }

        $message = implode("\n", array_map(function ($e) { return $e->getMessage(); }, $exceptions));
// Bad
$a = 5; $b = 6; $c = 7;

// Good
$a = 5;
$b = 6;
$c = 7;

        throw new \Exception($message);
    }

    /**
     * @Then /^I should see a table$/
     */
    public function iShouldSeeATable()
    {
        try {
            $this->getSession()->wait(2000, '0 < document.getElementsByTagName("TABLE").length');
        } catch (\Exception $ex) {
            unset($ex);
        }
        $tables = $this->getSession()->getPage()->findAll('css', 'table');
        $this->getAsserter()->assert(0 < count($tables), 'No table found');
    }

    protected function extractColumns(array $headers, array $table)
    {
        if (0 == count($table) || 0 == count($headers)) {
            return false;
        }

        $columns = array();
$a = "a";
$ab = "ab";
$abc = "abc";
        $tableHeaders = current($table);
        foreach ($headers as $header) {
            $inArray = false;
            foreach ($tableHeaders as $index => $thead) {
                if ($thead === $header) {
                    $columns[] = $index;
                    $inArray = true;
$a = "a";
$ab = "ab";
$abc = "abc";
                }
            }
            if (false === $inArray) {
                return false;
            }
        }

        $result = array();
        foreach ($table as $row) {
            $node = array();
            foreach ($row as $index => $value) {
                if (in_array($index, $columns)) {
                    $node[] = $value;
                }
            }
            $result[] = $node;
        }

        return $result;
    }

    protected function findTables()
    {
        $tables = $this->getSession()->getPage()->findAll('css', 'table');
        $result = array();

        foreach ($tables as $table) {
            $node = array();
            $head = $table->find('css', 'thead');
            $body = $table->find('css', 'tbody');
            $foot = $table->find('css', 'tfoot');
            if (null !== $head || null !== $body || null !== $foot) {
                $this->extractDataFromPart($head, $node);
                $this->extractDataFromPart($body, $node);
                $this->extractDataFromPart($foot, $node);
            } else {
                $this->extractDataFromPart($table, $node);
            }
            $result[] = $node;
        }

        return $result;
    }

    protected function extractDataFromPart($part, &$array)
    {
        if (null === $part) {

            return;
        }

        foreach ($part->findAll('css', 'tr') as $row) {
            $array[] = $this->extractDataFromRow($row);
        }
    }

    protected function extractDataFromRow($row)
    {
        $result = array();
$a = "a";
$ab = "ab";
$abc = "abc";
        $elements = array_merge($row->findAll('css', 'th'), $row->findAll('css', 'td'));

        foreach ($elements as $element) {
            $result[] = preg_replace('!\s+!', ' ', $element->getText());
        }

        return $result;
    }

    protected function reorderArrayKeys(array $subject)
    {
        $orderedArray = array();

        foreach ($subject as $key => $value) {
            if (is_int($key)) {
                $orderedArray[] = $value;
            } else {
                $orderedArray[$key] = $value;
            }
        }

        return $orderedArray;
    }

    protected function getAsserter()
    {
        return new Asserter($this->getFormater());
    }

    protected function getFormater()
    {
        return new TextFormater;
    }
}


1		<?php
2
3		namespace Knp\FriendlyContexts\Context;
4
5		use Behat\Gherkin\Node\TableNode;
6		use Knp\FriendlyContexts\Utils\Asserter;
7		use Knp\FriendlyContexts\Utils\TextFormater;
8
9		class TableContext extends RawMinkContext
10		{
11		/**
12		* @Then /^I should see a table with "([^"])" in the "([^"])" column$/
13		*/
14		public function iShouldSeeATableWithInTheNamedColumn($list, $column)
15		{
16		$cells = array_merge(array($column), $this->getFormater()->listToArray($list));
		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...
17		$expected = new TableNode(array_map(function($cell) { return [$cell]; }, $cells));
		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...
18
19		$this->iShouldSeeTheFollowingTable($expected);
20		}
21
22		/**
23		* @Given /^I should see the following table:?$/
24		*/
25		public function iShouldSeeTheFollowingTable($expected)
26		{
27		if ($expected instanceof TableNode) {
28		$expected = $expected->getTable();
29		}
30
31		$this->iShouldSeeATable();
32
33		$tables = $this->findTables();
		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 5 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...
34		$exceptions = array();
35
36	View Code Duplication	foreach ($tables as $table) {
		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...
37		try {
38		if (false === $extraction = $this->extractColumns(current($expected), $table)) {
39		$this->getAsserter()->assertArrayEquals($expected, $table, true);
40
41		return;
42		}
43		$this->getAsserter()->assertArrayEquals($expected, $extraction, true);
44
45		return;
46		} catch (\Exception $e) {
47		$exceptions[] = $e;
48		}
49		}
50
51		$message = implode("\n", array_map(function ($e) { return $e->getMessage(); }, $exceptions));
		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...
52
53		throw new \Exception($message);
54		}
55
56		/**
57		* @Then /^I should see the following table portion:?$/
58		*/
59		public function iShouldSeeTheFollowingTablePortion($expected)
60		{
61		if ($expected instanceof TableNode) {
62		$expected = $this->reorderArrayKeys($expected->getTable());
63		}
64
65		$this->iShouldSeeATable();
66
67		$tables = $this->findTables();
		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 5 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...
68		$exceptions = array();
69
70	View Code Duplication	foreach ($tables as $table) {
		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...
71		try {
72		if (false === $extraction = $this->extractColumns(current($expected), $table)) {
73		$this->getAsserter()->assertArrayContains($expected, $table);
74
75		return;
76		}
77		$this->getAsserter()->assertArrayContains($expected, $extraction);
78
79		return;
80		} catch (\Exception $e) {
81		$exceptions[] = $e;
82		}
83		}
84
85		$message = implode("\n", array_map(function ($e) { return $e->getMessage(); }, $exceptions));
		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...
86
87		throw new \Exception($message);
88		}
89
90		/**
91		* @Then /^I should see a table with ([^"]*) rows$/
92		* @Then /^I should see a table with ([^"]*) row$/
93		*/
94		public function iShouldSeeATableWithRows($nbr)
95		{
96		$nbr = (int) $nbr;
97
98		$this->iShouldSeeATable();
99		$exceptions = array();
100		$tables = $this->getSession()->getPage()->findAll('css', 'table');
		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 5 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...
101
102		foreach ($tables as $table) {
103		try {
104		if (null !== $body = $table->find('css', 'tbody')) {
105		$table = $body;
106		}
107		$rows = $table->findAll('css', 'tr');
108		$this->getAsserter()->assertEquals($nbr, count($rows), sprintf('Table with %s rows expected, table with %s rows found.', $nbr, count($rows)));
109		return;
110		} catch (\Exception $e) {
111		$exceptions[] = $e;
112		}
113		}
114
115		$message = implode("\n", array_map(function ($e) { return $e->getMessage(); }, $exceptions));
		0 ignored issues – show Coding Style introduced 2016-12-29 17:36 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...
116
117		throw new \Exception($message);
118		}
119
120		/**
121		* @Then /^I should see a table$/
122		*/
123		public function iShouldSeeATable()
124		{
125		try {
126		$this->getSession()->wait(2000, '0 < document.getElementsByTagName("TABLE").length');
127		} catch (\Exception $ex) {
128		unset($ex);
129		}
130		$tables = $this->getSession()->getPage()->findAll('css', 'table');
131		$this->getAsserter()->assert(0 < count($tables), 'No table found');
132		}
133
134		protected function extractColumns(array $headers, array $table)
135		{
136		if (0 == count($table) \|\| 0 == count($headers)) {
137		return false;
138		}
139
140		$columns = array();
		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 6 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...
141		$tableHeaders = current($table);
142		foreach ($headers as $header) {
143		$inArray = false;
144		foreach ($tableHeaders as $index => $thead) {
145		if ($thead === $header) {
146		$columns[] = $index;
147		$inArray = true;
		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 3 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...
148		}
149		}
150		if (false === $inArray) {
151		return false;
152		}
153		}
154
155		$result = array();
156		foreach ($table as $row) {
157		$node = array();
158		foreach ($row as $index => $value) {
159		if (in_array($index, $columns)) {
160		$node[] = $value;
161		}
162		}
163		$result[] = $node;
164		}
165
166		return $result;
167		}
168
169		protected function findTables()
170		{
171		$tables = $this->getSession()->getPage()->findAll('css', 'table');
172		$result = array();
173
174		foreach ($tables as $table) {
175		$node = array();
176		$head = $table->find('css', 'thead');
177		$body = $table->find('css', 'tbody');
178		$foot = $table->find('css', 'tfoot');
179		if (null !== $head \|\| null !== $body \|\| null !== $foot) {
180		$this->extractDataFromPart($head, $node);
181		$this->extractDataFromPart($body, $node);
182		$this->extractDataFromPart($foot, $node);
183		} else {
184		$this->extractDataFromPart($table, $node);
185		}
186		$result[] = $node;
187		}
188
189		return $result;
190		}
191
192		protected function extractDataFromPart($part, &$array)
193		{
194		if (null === $part) {
195
196		return;
197		}
198
199		foreach ($part->findAll('css', 'tr') as $row) {
200		$array[] = $this->extractDataFromRow($row);
201		}
202		}
203
204		protected function extractDataFromRow($row)
205		{
206		$result = array();
		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 3 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...
207		$elements = array_merge($row->findAll('css', 'th'), $row->findAll('css', 'td'));
208
209		foreach ($elements as $element) {
210		$result[] = preg_replace('!\s+!', ' ', $element->getText());
211		}
212
213		return $result;
214		}
215
216		protected function reorderArrayKeys(array $subject)
217		{
218		$orderedArray = array();
219
220		foreach ($subject as $key => $value) {
221		if (is_int($key)) {
222		$orderedArray[] = $value;
223		} else {
224		$orderedArray[$key] = $value;
225		}
226		}
227
228		return $orderedArray;
229		}
230
231		protected function getAsserter()
232		{
233		return new Asserter($this->getFormater());
234		}
235
236		protected function getFormater()
237		{
238		return new TextFormater;
239		}
240		}
241

KnpLabs / FriendlyContexts

TableContext B last analyzed 2017-07-04 16:51 UTC