ListDiff::buildDiffList() - Code Metrics - Inspection of "Merge pull request #43 from caxy/misc-clean-up" - caxy/php-htmldiff - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( e1019e...256f03 )

by Josh

created 2016-04-10 04:07 UTC

ListDiff::buildDiffList() C

↳ Parent: ListDiff

Complexity

Conditions	13
Paths	13

Size

Total Lines	75
Code Lines	56

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	55
CRAP Score	13.0073

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	75
ccs	55
cts	57
cp	0.9649
rs	5.3314
cc	13
eloc	56
nc	13
nop	1
crap	13.0073

How to fix Long Method Complexity

<?php

namespace Caxy\HtmlDiff;

use Caxy\HtmlDiff\ListDiff\DiffList;
use Caxy\HtmlDiff\ListDiff\DiffListItem;

class ListDiff extends AbstractDiff
{
    protected static $listTypes = array('ul', 'ol', 'dl');

    /**
     * @param string              $oldText
     * @param string              $newText
     * @param HtmlDiffConfig|null $config
     *
     * @return ListDiff
     */
    public static function create($oldText, $newText, HtmlDiffConfig $config = null)

    {
        $diff = new self($oldText, $newText);

        if (null !== $config) {
            $diff->setConfig($config);
        }

        return $diff;
    }

    public function build()

    {
        if ($this->hasDiffCache() && $this->getDiffCache()->contains($this->oldText, $this->newText)) {
            $this->content = $this->getDiffCache()->fetch($this->oldText, $this->newText);

            return $this->content;
        }

        $this->splitInputsToWords();

        $this->content = $this->diffLists(
            $this->buildDiffList($this->oldWords),
            $this->buildDiffList($this->newWords)
        );

        if ($this->hasDiffCache()) {
            $this->getDiffCache()->save($this->oldText, $this->newText, $this->content);
        }

        return $this->content;
    }

    protected function diffLists(DiffList $oldList, DiffList $newList)
    {
        $oldMatchData = array();
        $newMatchData = array();
        $oldListIndices = array();
        $newListIndices = array();
        $oldListItems = array();
        $newListItems = array();

        foreach ($oldList->getListItems() as $oldIndex => $oldListItem) {
            if ($oldListItem instanceof DiffListItem) {
                $oldListItems[$oldIndex] = $oldListItem;

                $oldListIndices[] = $oldIndex;
                $oldMatchData[$oldIndex] = array();

                // Get match percentages
                foreach ($newList->getListItems() as $newIndex => $newListItem) {
                    if ($newListItem instanceof DiffListItem) {
                        if (!in_array($newListItem, $newListItems)) {
                            $newListItems[$newIndex] = $newListItem;
                        }
                        if (!in_array($newIndex, $newListIndices)) {
                            $newListIndices[] = $newIndex;
                        }
                        if (!array_key_exists($newIndex, $newMatchData)) {
                            $newMatchData[$newIndex] = array();
                        }

                        $oldText = implode('', $oldListItem->getText());
                        $newText = implode('', $newListItem->getText());

                        // similar_text
                        $percentage = null;
                        similar_text($oldText, $newText, $percentage);

                        $oldMatchData[$oldIndex][$newIndex] = $percentage;
                        $newMatchData[$newIndex][$oldIndex] = $percentage;
                    }
                }
            }
        }

        $currentIndexInOld = 0;
        $currentIndexInNew = 0;
        $oldCount = count($oldListIndices);
        $newCount = count($newListIndices);
        $difference = max($oldCount, $newCount) - min($oldCount, $newCount);

        $diffOutput = '';

        foreach ($newList->getListItems() as $newIndex => $newListItem) {
            if ($newListItem instanceof DiffListItem) {
                $operation = null;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

                $oldListIndex = array_key_exists($currentIndexInOld, $oldListIndices) ? $oldListIndices[$currentIndexInOld] : null;

                $class = 'normal';
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

                if (null !== $oldListIndex && array_key_exists($oldListIndex, $oldMatchData)) {
                    // Check percentage matches of upcoming list items in old.
                    $matchPercentage = $oldMatchData[$oldListIndex][$newIndex];

                    // does the old list item match better?
                    $otherMatchBetter = false;
                    foreach ($oldMatchData[$oldListIndex] as $index => $percentage) {
                        if ($index > $newIndex && $percentage > $matchPercentage) {
                            $otherMatchBetter = $index;
                        }
                    }

                    if (false !== $otherMatchBetter && $newCount > $oldCount && $difference > 0) {
                        $diffOutput .= sprintf('%s', $newListItem->getHtml('normal new', 'ins'));
                        ++$currentIndexInNew;
                        --$difference;

                        continue;
                    }

                    $nextOldListIndex = array_key_exists($currentIndexInOld + 1, $oldListIndices) ? $oldListIndices[$currentIndexInOld + 1] : null;


                    $replacement = false;

                    if ($nextOldListIndex !== null && $oldMatchData[$nextOldListIndex][$newIndex] > $matchPercentage && $oldMatchData[$nextOldListIndex][$newIndex] > $this->config->getMatchThreshold()) {

                        // Following list item in old is better match, use that.
                        $diffOutput .= sprintf('%s', $oldListItems[$oldListIndex]->getHtml('removed', 'del'));

                        ++$currentIndexInOld;
                        $oldListIndex = $nextOldListIndex;
                        $matchPercentage = $oldMatchData[$oldListIndex];
                        $replacement = true;
                    }

                    if ($matchPercentage > $this->config->getMatchThreshold() || $currentIndexInNew === $currentIndexInOld) {

                        // Diff the two lists.
                        $htmlDiff = HtmlDiff::create(
                            $oldListItems[$oldListIndex]->getInnerHtml(),
                            $newListItem->getInnerHtml(),
                            $this->config
                        );
                        $diffContent = $htmlDiff->build();

                        $diffOutput .= sprintf('%s%s%s', $newListItem->getStartTagWithDiffClass($replacement ? 'replacement' : 'normal'), $diffContent, $newListItem->getEndTag());

                    } else {
                        $diffOutput .= sprintf('%s', $oldListItems[$oldListIndex]->getHtml('removed', 'del'));
                        $diffOutput .= sprintf('%s', $newListItem->getHtml('replacement', 'ins'));
                    }
                    ++$currentIndexInOld;
                } else {
                    $diffOutput .= sprintf('%s', $newListItem->getHtml('normal new', 'ins'));
                }

                ++$currentIndexInNew;
            }
        }

        // Output any additional list items
        while (array_key_exists($currentIndexInOld, $oldListIndices)) {
            $oldListIndex = $oldListIndices[$currentIndexInOld];
            $diffOutput .= sprintf('%s', $oldListItems[$oldListIndex]->getHtml('removed', 'del'));
            ++$currentIndexInOld;
        }

        return sprintf('%s%s%s', $newList->getStartTagWithDiffClass(), $diffOutput, $newList->getEndTag());
    }

    protected function buildDiffList($words)
    {
        $listType = null;
        $listStartTag = null;
        $listEndTag = null;
        $attributes = array();
        $openLists = 0;
        $openListItems = 0;
        $list = array();
        $currentListItem = null;
        $listItemType = null;
        $listItemStart = null;
        $listItemEnd = null;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        foreach ($words as $i => $word) {
            if ($this->isOpeningListTag($word, $listType)) {
                if ($openLists > 0) {
                    if ($openListItems > 0) {
                        $currentListItem[] = $word;
                    } else {
                        $list[] = $word;
                    }
                } else {
                    $listType = substr($word, 1, 2);
                    $listStartTag = $word;
                }

                ++$openLists;
            } elseif ($this->isClosingListTag($word, $listType)) {
                if ($openLists > 1) {
                    if ($openListItems > 0) {
                        $currentListItem[] = $word;
                    } else {
                        $list[] = $word;
                    }
                } else {
                    $listEndTag = $word;
                }

                --$openLists;
            } elseif ($this->isOpeningListItemTag($word, $listItemType)) {
                if ($openListItems === 0) {
                    // New top-level list item
                    $currentListItem = array();
                    $listItemType = substr($word, 1, 2);
                    $listItemStart = $word;
                } else {
                    $currentListItem[] = $word;
                }

                ++$openListItems;
            } elseif ($this->isClosingListItemTag($word, $listItemType)) {
                if ($openListItems === 1) {
                    $listItemEnd = $word;
                    $listItem = new DiffListItem($currentListItem, array(), $listItemStart, $listItemEnd);
                    $list[] = $listItem;
                    $currentListItem = null;
                } else {
                    $currentListItem[] = $word;
                }

                --$openListItems;
            } else {
                if ($openListItems > 0) {
                    $currentListItem[] = $word;
                } else {
                    $list[] = $word;
                }
            }
        }

        $diffList = new DiffList($listType, $listStartTag, $listEndTag, $list, $attributes);

        return $diffList;
    }

    protected function isOpeningListTag($word, $type = null)
    {
        $filter = $type !== null ? array('<'.$type) : array('<ul', '<ol', '<dl');

        return in_array(substr($word, 0, 3), $filter);
    }

    protected function isClosingListTag($word, $type = null)
    {
        $filter = $type !== null ? array('</'.$type) : array('</ul', '</ol', '</dl');

        return in_array(substr($word, 0, 4), $filter);
    }

    protected function isOpeningListItemTag($word, $type = null)
    {
        $filter = $type !== null ? array('<'.$type) : array('<li', '<dd', '<dt');

        return in_array(substr($word, 0, 3), $filter);
    }

    protected function isClosingListItemTag($word, $type = null)
    {
        $filter = $type !== null ? array('</'.$type) : array('</li', '</dd', '</dt');

        return in_array(substr($word, 0, 4), $filter);
    }
}


1			<?php
2
3			namespace Caxy\HtmlDiff;
4
5			use Caxy\HtmlDiff\ListDiff\DiffList;
6			use Caxy\HtmlDiff\ListDiff\DiffListItem;
7
8			class ListDiff extends AbstractDiff
9			{
10			protected static $listTypes = array('ul', 'ol', 'dl');
11
12			/**
13			* @param string $oldText
14			* @param string $newText
15			* @param HtmlDiffConfig\|null $config
16			*
17			* @return ListDiff
18			*/
19	7	View Code Duplication	public static function create($oldText, $newText, HtmlDiffConfig $config = null)
			0 ignored issues – show Duplication introduced 2016-04-10 04:07 UTC by Report Bug Copy Issue Report 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...
20			{
21	7		$diff = new self($oldText, $newText);
22
23	7		if (null !== $config) {
24	7		$diff->setConfig($config);
25	7		}
26
27	7		return $diff;
28			}
29
30	7	View Code Duplication	public function build()
			0 ignored issues – show Duplication introduced 2016-04-10 04:07 UTC by Report Bug Copy Issue Report 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...
31			{
32	7		if ($this->hasDiffCache() && $this->getDiffCache()->contains($this->oldText, $this->newText)) {
33			$this->content = $this->getDiffCache()->fetch($this->oldText, $this->newText);
34
35			return $this->content;
36			}
37
38	7		$this->splitInputsToWords();
39
40	7		$this->content = $this->diffLists(
41	7		$this->buildDiffList($this->oldWords),
42	7		$this->buildDiffList($this->newWords)
43	7		);
44
45	7		if ($this->hasDiffCache()) {
46			$this->getDiffCache()->save($this->oldText, $this->newText, $this->content);
47			}
48
49	7		return $this->content;
50			}
51
52	7		protected function diffLists(DiffList $oldList, DiffList $newList)
53			{
54	7		$oldMatchData = array();
55	7		$newMatchData = array();
56	7		$oldListIndices = array();
57	7		$newListIndices = array();
58	7		$oldListItems = array();
59	7		$newListItems = array();
60
61	7		foreach ($oldList->getListItems() as $oldIndex => $oldListItem) {
62	7		if ($oldListItem instanceof DiffListItem) {
63	7		$oldListItems[$oldIndex] = $oldListItem;
64
65	7		$oldListIndices[] = $oldIndex;
66	7		$oldMatchData[$oldIndex] = array();
67
68			// Get match percentages
69	7		foreach ($newList->getListItems() as $newIndex => $newListItem) {
70	7		if ($newListItem instanceof DiffListItem) {
71	7		if (!in_array($newListItem, $newListItems)) {
72	7		$newListItems[$newIndex] = $newListItem;
73	7		}
74	7		if (!in_array($newIndex, $newListIndices)) {
75	7		$newListIndices[] = $newIndex;
76	7		}
77	7		if (!array_key_exists($newIndex, $newMatchData)) {
78	7		$newMatchData[$newIndex] = array();
79	7		}
80
81	7		$oldText = implode('', $oldListItem->getText());
82	7		$newText = implode('', $newListItem->getText());
83
84			// similar_text
85	7		$percentage = null;
86	7		similar_text($oldText, $newText, $percentage);
87
88	7		$oldMatchData[$oldIndex][$newIndex] = $percentage;
89	7		$newMatchData[$newIndex][$oldIndex] = $percentage;
90	7		}
91	7		}
92	7		}
93	7		}
94
95	7		$currentIndexInOld = 0;
96	7		$currentIndexInNew = 0;
97	7		$oldCount = count($oldListIndices);
98	7		$newCount = count($newListIndices);
99	7		$difference = max($oldCount, $newCount) - min($oldCount, $newCount);
100
101	7		$diffOutput = '';
102
103	7		foreach ($newList->getListItems() as $newIndex => $newListItem) {
104	7		if ($newListItem instanceof DiffListItem) {
105	7		$operation = null;
			0 ignored issues – show Unused Code introduced 2016-04-10 04:07 UTC by Report Bug Copy Issue Report `$operation` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
106
107	7		$oldListIndex = array_key_exists($currentIndexInOld, $oldListIndices) ? $oldListIndices[$currentIndexInOld] : null;
			0 ignored issues – show Coding Style introduced 2016-02-09 16:38 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 131 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
108	7		$class = 'normal';
			0 ignored issues – show Unused Code introduced 2016-04-10 04:07 UTC by Report Bug Copy Issue Report `$class` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
109
110	7		if (null !== $oldListIndex && array_key_exists($oldListIndex, $oldMatchData)) {
111			// Check percentage matches of upcoming list items in old.
112	7		$matchPercentage = $oldMatchData[$oldListIndex][$newIndex];
113
114			// does the old list item match better?
115	7		$otherMatchBetter = false;
116	7		foreach ($oldMatchData[$oldListIndex] as $index => $percentage) {
117	7		if ($index > $newIndex && $percentage > $matchPercentage) {
118	4		$otherMatchBetter = $index;
119	4		}
120	7		}
121
122	7		if (false !== $otherMatchBetter && $newCount > $oldCount && $difference > 0) {
123	2		$diffOutput .= sprintf('%s', $newListItem->getHtml('normal new', 'ins'));
124	2		++$currentIndexInNew;
125	2		--$difference;
126
127	2		continue;
128			}
129
130	7		$nextOldListIndex = array_key_exists($currentIndexInOld + 1, $oldListIndices) ? $oldListIndices[$currentIndexInOld + 1] : null;
			0 ignored issues – show Coding Style introduced 2016-02-09 16:38 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 147 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
131
132	7		$replacement = false;
133
134	7		if ($nextOldListIndex !== null && $oldMatchData[$nextOldListIndex][$newIndex] > $matchPercentage && $oldMatchData[$nextOldListIndex][$newIndex] > $this->config->getMatchThreshold()) {
			0 ignored issues – show Coding Style introduced 2016-02-09 16:38 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 203 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
135			// Following list item in old is better match, use that.
136	1		$diffOutput .= sprintf('%s', $oldListItems[$oldListIndex]->getHtml('removed', 'del'));
137
138	1		++$currentIndexInOld;
139	1		$oldListIndex = $nextOldListIndex;
140	1		$matchPercentage = $oldMatchData[$oldListIndex];
141	1		$replacement = true;
142	1		}
143
144	7		if ($matchPercentage > $this->config->getMatchThreshold() \|\| $currentIndexInNew === $currentIndexInOld) {
			0 ignored issues – show Coding Style introduced 2016-04-10 04:07 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 125 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
145			// Diff the two lists.
146	7		$htmlDiff = HtmlDiff::create(
147	7		$oldListItems[$oldListIndex]->getInnerHtml(),
148	7		$newListItem->getInnerHtml(),
149	7		$this->config
150	7		);
151	7		$diffContent = $htmlDiff->build();
152
153	7		$diffOutput .= sprintf('%s%s%s', $newListItem->getStartTagWithDiffClass($replacement ? 'replacement' : 'normal'), $diffContent, $newListItem->getEndTag());
			0 ignored issues – show Coding Style introduced 2016-02-09 16:38 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 179 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
154	7		} else {
155			$diffOutput .= sprintf('%s', $oldListItems[$oldListIndex]->getHtml('removed', 'del'));
156			$diffOutput .= sprintf('%s', $newListItem->getHtml('replacement', 'ins'));
157			}
158	7		++$currentIndexInOld;
159	7		} else {
160			$diffOutput .= sprintf('%s', $newListItem->getHtml('normal new', 'ins'));
161			}
162
163	7		++$currentIndexInNew;
164	7		}
165	7		}
166
167			// Output any additional list items
168	7		while (array_key_exists($currentIndexInOld, $oldListIndices)) {
169	2		$oldListIndex = $oldListIndices[$currentIndexInOld];
170	2		$diffOutput .= sprintf('%s', $oldListItems[$oldListIndex]->getHtml('removed', 'del'));
171	2		++$currentIndexInOld;
172	2		}
173
174	7		return sprintf('%s%s%s', $newList->getStartTagWithDiffClass(), $diffOutput, $newList->getEndTag());
175			}
176
177	7		protected function buildDiffList($words)
178			{
179	7		$listType = null;
180	7		$listStartTag = null;
181	7		$listEndTag = null;
182	7		$attributes = array();
183	7		$openLists = 0;
184	7		$openListItems = 0;
185	7		$list = array();
186	7		$currentListItem = null;
187	7		$listItemType = null;
188	7		$listItemStart = null;
189	7		$listItemEnd = null;
			0 ignored issues – show Unused Code introduced 2016-04-10 04:07 UTC by Report Bug Copy Issue Report `$listItemEnd` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
190
191	7		foreach ($words as $i => $word) {
192	7		if ($this->isOpeningListTag($word, $listType)) {
193	7		if ($openLists > 0) {
194	2		if ($openListItems > 0) {
195	2		$currentListItem[] = $word;
196	2		} else {
197			$list[] = $word;
198			}
199	2		} else {
200	7		$listType = substr($word, 1, 2);
201	7		$listStartTag = $word;
202			}
203
204	7		++$openLists;
205	7		} elseif ($this->isClosingListTag($word, $listType)) {
206	7		if ($openLists > 1) {
207	2		if ($openListItems > 0) {
208	2		$currentListItem[] = $word;
209	2		} else {
210			$list[] = $word;
211			}
212	2		} else {
213	7		$listEndTag = $word;
214			}
215
216	7		--$openLists;
217	7		} elseif ($this->isOpeningListItemTag($word, $listItemType)) {
218	7		if ($openListItems === 0) {
219			// New top-level list item
220	7		$currentListItem = array();
221	7		$listItemType = substr($word, 1, 2);
222	7		$listItemStart = $word;
223	7		} else {
224	4		$currentListItem[] = $word;
225			}
226
227	7		++$openListItems;
228	7		} elseif ($this->isClosingListItemTag($word, $listItemType)) {
229	7		if ($openListItems === 1) {
230	7		$listItemEnd = $word;
231	7		$listItem = new DiffListItem($currentListItem, array(), $listItemStart, $listItemEnd);
232	7		$list[] = $listItem;
233	7		$currentListItem = null;
234	7		} else {
235	4		$currentListItem[] = $word;
236			}
237
238	7		--$openListItems;
239	7		} else {
240	7		if ($openListItems > 0) {
241	7		$currentListItem[] = $word;
242	7		} else {
243	7		$list[] = $word;
244			}
245			}
246	7		}
247
248	7		$diffList = new DiffList($listType, $listStartTag, $listEndTag, $list, $attributes);
249
250	7		return $diffList;
251			}
252
253	7		protected function isOpeningListTag($word, $type = null)
254			{
255	7		$filter = $type !== null ? array('<'.$type) : array('<ul', '<ol', '<dl');
256
257	7		return in_array(substr($word, 0, 3), $filter);
258			}
259
260	7		protected function isClosingListTag($word, $type = null)
261			{
262	7		$filter = $type !== null ? array('</'.$type) : array('</ul', '</ol', '</dl');
263
264	7		return in_array(substr($word, 0, 4), $filter);
265			}
266
267	7		protected function isOpeningListItemTag($word, $type = null)
268			{
269	7		$filter = $type !== null ? array('<'.$type) : array('<li', '<dd', '<dt');
270
271	7		return in_array(substr($word, 0, 3), $filter);
272			}
273
274	7		protected function isClosingListItemTag($word, $type = null)
275			{
276	7		$filter = $type !== null ? array('</'.$type) : array('</li', '</dd', '</dt');
277
278	7		return in_array(substr($word, 0, 4), $filter);
279			}
280			}
281

caxy / php-htmldiff

Push — master ( e1019e...256f03 )

ListDiff::buildDiffList() C

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like