DiffChunk::valid() - Code Metrics - Inspection of "Merge pull request #170 from matteosister/develop" - matteosister/GitElephant - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c1a738...2c88a4 )

unknown

created 2020-05-01 05:16 UTC

DiffChunk::valid() A

↳ Parent: DiffChunk

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0
crap	1

<?php

/**
 * GitElephant - An abstraction layer for git written in PHP
 * Copyright (C) 2013  Matteo Giachino
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see [http://www.gnu.org/licenses/].
 */

namespace GitElephant\Objects\Diff;

/**
 * A single portion of a file changed in a diff
 *
 * @author Matteo Giachino <[email protected]>
 */
class DiffChunk implements \ArrayAccess, \Countable, \Iterator
{
    /**
     * the cursor position
     *
     * @var int
     */
    private $position;

    /**
     * diff start line from original file
     *
     * @var int
     */
    private $originStartLine;

    /**
     * diff end line from original file
     *
     * @var int
     */
    private $originEndLine;

    /**
     * diff start line from destination file
     *
     * @var int
     */
    private $destStartLine;

    /**
     * diff end line from destination file
     *
     * @var int
     */
    private $destEndLine;

    /**
     * hunk header line
     *
     * @var string
     */
    private $headerLine;

    /**
     * array of lines
     *
     * @var array<DiffChunkLine>
     */
    private $lines = [];

    /**
     * Class constructor
     *
     * @param array $lines output lines from git binary
     *
     * @throws \Exception
     */
    public function __construct(array $lines)
    {
        $this->position = 0;

        $this->getLinesNumbers($lines[0]);
        $this->parseLines(array_slice($lines, 1));
    }

    /**
     * Parse lines
     *
     * @param array $lines output lines
     *
     * @throws \Exception
     */
    private function parseLines(array $lines): void
    {
        $originUnchanged = $this->originStartLine;
        $destUnchanged = $this->destStartLine;

        $deleted = $this->originStartLine;
        $new = $this->destStartLine;
        foreach ($lines as $line) {
            if (preg_match('/^\+(.*)/', $line)) {
                $this->lines[] = new DiffChunkLineAdded($new++, preg_replace('/\+(.*)/', ' $1', $line));
                $destUnchanged++;
            } elseif (preg_match('/^-(.*)/', $line)) {
                $this->lines[] = new DiffChunkLineDeleted($deleted++, preg_replace('/-(.*)/', ' $1', $line));
                $originUnchanged++;
            } elseif (preg_match('/^ (.*)/', $line) || $line == '') {
                $this->lines[] = new DiffChunkLineUnchanged($originUnchanged++, $destUnchanged++, $line);
                $deleted++;
                $new++;
            } elseif (!preg_match('/\\ No newline at end of file/', $line)) {
                throw new \Exception(sprintf('GitElephant was unable to parse the line %s', $line));
            }
        }
    }

    /**
     * Get line numbers
     *
     * @param string $line a single line
     */
    private function getLinesNumbers(string $line): void
    {
        $matches = [];
        preg_match('/@@ -(.*) \+(.*) @@?(.*)/', $line, $matches);
        if (!strpos($matches[1], ',')) {
            // one line
            $this->originStartLine = $matches[1];
$answer = 42;

$correct = false;

$correct = (bool) $answer;
            $this->originEndLine = $matches[1];
$answer = 42;

$correct = false;

$correct = (bool) $answer;
        } else {
            [$this->originStartLine, $this->originEndLine] = explode(',', $matches[1]);
        }

        if (!strpos($matches[2], ',')) {
            // one line
            $this->destStartLine = $matches[2];
$answer = 42;

$correct = false;

$correct = (bool) $answer;
            $this->destEndLine = $matches[2];
$answer = 42;

$correct = false;

$correct = (bool) $answer;
        } else {
            [$this->destStartLine, $this->destEndLine] = explode(',', $matches[2]);
        }
    }

    /**
     * destStartLine getter
     *
     * @return int
     */
    public function getDestStartLine(): int
    {
        return $this->destStartLine;
    }

    /**
     * destEndLine getter
     *
     * @return int
     */
    public function getDestEndLine(): int
    {
        return $this->destEndLine;
    }

    /**
     * originStartLine getter
     *
     * @return int
     */
    public function getOriginStartLine(): int
    {
        return $this->originStartLine;
    }

    /**
     * originEndLine getter
     *
     * @return int
     */
    public function getOriginEndLine(): int
    {
        return $this->originEndLine;
    }

    /**
     * Get hunk header line
     *
     * @return string
     */
    public function getHeaderLine(): string
    {
        if (null === $this->headerLine) {
            $line = '@@';
            $line .= ' -' . $this->getOriginStartLine() . ',' . $this->getOriginEndLine();
            $line .= ' +' . $this->getDestStartLine() . ',' . $this->getDestEndLine();
            $line .= ' @@';

            $this->headerLine = $line;
        }

        return $this->headerLine;
    }

    /**
     * Get Lines
     *
     * @return array
     */
    public function getLines(): array
    {
        return $this->lines;
    }

    /**
     * ArrayAccess interface
     *
     * @param int $offset offset
     *
     * @return bool
     */
    public function offsetExists($offset): bool
    {
        return isset($this->lines[$offset]);
    }

    /**
     * ArrayAccess interface
     *
     * @param int $offset offset
     *
     * @return DiffChunkLine|null
     */
    public function offsetGet($offset)
    {
        return isset($this->lines[$offset]) ? $this->lines[$offset] : null;
    }

    /**
     * ArrayAccess interface
     *
     * @param int|null   $offset offset
     * @param mixed $value  value
     */
    public function offsetSet($offset, $value): void
    {
        if (is_null($offset)) {
            $this->lines[] = $value;
        } else {
            $this->lines[$offset] = $value;
        }
    }

    /**
     * ArrayAccess interface
     *
     * @param int $offset offset
     */
    public function offsetUnset($offset): void
    {
        unset($this->lines[$offset]);
    }

    /**
     * Countable interface
     *
     * @return int
     */
    public function count(): int
    {
        return count($this->lines);
    }

    /**
     * Iterator interface
     *
     * @return mixed
     */
    public function current()
    {
        return $this->lines[$this->position];
    }

    /**
     * Iterator interface
     */
    public function next(): void
    {
        ++$this->position;
    }

    /**
     * Iterator interface
     *
     * @return int
     */
    public function key(): int
    {
        return $this->position;
    }

    /**
     * Iterator interface
     *
     * @return bool
     */
    public function valid(): bool
    {
        return isset($this->lines[$this->position]);
    }

    /**
     * Iterator interface
     */
    public function rewind(): void
    {
        $this->position = 0;
    }
}


1		<?php
2
3		/**
4		* GitElephant - An abstraction layer for git written in PHP
5		* Copyright (C) 2013 Matteo Giachino
6		*
7		* This program is free software: you can redistribute it and/or modify
8		* it under the terms of the GNU General Public License as published by
9		* the Free Software Foundation, either version 3 of the License, or
10		* (at your option) any later version.
11		*
12		* This program is distributed in the hope that it will be useful,
13		* but WITHOUT ANY WARRANTY; without even the implied warranty of
14		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15		* GNU General Public License for more details.
16		*
17		* You should have received a copy of the GNU General Public License
18		* along with this program. If not, see [http://www.gnu.org/licenses/].
19		*/
20
21		namespace GitElephant\Objects\Diff;
22
23		/**
24		* A single portion of a file changed in a diff
25		*
26		* @author Matteo Giachino <[email protected]>
27		*/
28		class DiffChunk implements \ArrayAccess, \Countable, \Iterator
29		{
30		/**
31		* the cursor position
32		*
33		* @var int
34		*/
35		private $position;
36
37		/**
38		* diff start line from original file
39		*
40		* @var int
41		*/
42		private $originStartLine;
43
44		/**
45		* diff end line from original file
46		*
47		* @var int
48		*/
49		private $originEndLine;
50
51		/**
52		* diff start line from destination file
53		*
54		* @var int
55		*/
56		private $destStartLine;
57
58		/**
59		* diff end line from destination file
60		*
61		* @var int
62		*/
63		private $destEndLine;
64
65		/**
66		* hunk header line
67		*
68		* @var string
69		*/
70		private $headerLine;
71
72		/**
73		* array of lines
74		*
75		* @var array<DiffChunkLine>
76		*/
77		private $lines = [];
78
79		/**
80		* Class constructor
81		*
82		* @param array $lines output lines from git binary
83		*
84		* @throws \Exception
85		*/
86	2	public function __construct(array $lines)
87		{
88	2	$this->position = 0;
89
90	2	$this->getLinesNumbers($lines[0]);
91	2	$this->parseLines(array_slice($lines, 1));
92	2	}
93
94		/**
95		* Parse lines
96		*
97		* @param array $lines output lines
98		*
99		* @throws \Exception
100		*/
101	2	private function parseLines(array $lines): void
102		{
103	2	$originUnchanged = $this->originStartLine;
104	2	$destUnchanged = $this->destStartLine;
105
106	2	$deleted = $this->originStartLine;
107	2	$new = $this->destStartLine;
108	2	foreach ($lines as $line) {
109	2	if (preg_match('/^\+(.*)/', $line)) {
110	2	$this->lines[] = new DiffChunkLineAdded($new++, preg_replace('/\+(.*)/', ' $1', $line));
111	2	$destUnchanged++;
112	2	} elseif (preg_match('/^-(.*)/', $line)) {
113	1	$this->lines[] = new DiffChunkLineDeleted($deleted++, preg_replace('/-(.*)/', ' $1', $line));
114	1	$originUnchanged++;
115	2	} elseif (preg_match('/^ (.*)/', $line) \|\| $line == '') {
116	2	$this->lines[] = new DiffChunkLineUnchanged($originUnchanged++, $destUnchanged++, $line);
117	2	$deleted++;
118	2	$new++;
119	2	} elseif (!preg_match('/\\ No newline at end of file/', $line)) {
120		throw new \Exception(sprintf('GitElephant was unable to parse the line %s', $line));
121		}
122		}
123	2	}
124
125		/**
126		* Get line numbers
127		*
128		* @param string $line a single line
129		*/
130	2	private function getLinesNumbers(string $line): void
131		{
132	2	$matches = [];
133	2	preg_match('/@@ -(.) \+(.) @@?(.*)/', $line, $matches);
134	2	if (!strpos($matches[1], ',')) {
135		// one line
136		$this->originStartLine = $matches[1];
		0 ignored issues – show Documentation Bug introduced 2015-12-20 10:24 UTC by Report Bug Copy Issue Report The property `$originStartLine` was declared of type `integer`, but `$matches[1]` is of type `string`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
137		$this->originEndLine = $matches[1];
		0 ignored issues – show Documentation Bug introduced 2015-12-20 10:24 UTC by Report Bug Copy Issue Report The property `$originEndLine` was declared of type `integer`, but `$matches[1]` is of type `string`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
138		} else {
139	2	[$this->originStartLine, $this->originEndLine] = explode(',', $matches[1]);
140		}
141
142	2	if (!strpos($matches[2], ',')) {
143		// one line
144	1	$this->destStartLine = $matches[2];
		0 ignored issues – show Documentation Bug introduced 2015-12-20 10:24 UTC by Report Bug Copy Issue Report The property `$destStartLine` was declared of type `integer`, but `$matches[2]` is of type `string`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
145	1	$this->destEndLine = $matches[2];
		0 ignored issues – show Documentation Bug introduced 2015-12-20 10:24 UTC by Report Bug Copy Issue Report The property `$destEndLine` was declared of type `integer`, but `$matches[2]` is of type `string`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
146		} else {
147	1	[$this->destStartLine, $this->destEndLine] = explode(',', $matches[2]);
148		}
149	2	}
150
151		/**
152		* destStartLine getter
153		*
154		* @return int
155		*/
156		public function getDestStartLine(): int
157		{
158		return $this->destStartLine;
159		}
160
161		/**
162		* destEndLine getter
163		*
164		* @return int
165		*/
166		public function getDestEndLine(): int
167		{
168		return $this->destEndLine;
169		}
170
171		/**
172		* originStartLine getter
173		*
174		* @return int
175		*/
176		public function getOriginStartLine(): int
177		{
178		return $this->originStartLine;
179		}
180
181		/**
182		* originEndLine getter
183		*
184		* @return int
185		*/
186		public function getOriginEndLine(): int
187		{
188		return $this->originEndLine;
189		}
190
191		/**
192		* Get hunk header line
193		*
194		* @return string
195		*/
196		public function getHeaderLine(): string
197		{
198		if (null === $this->headerLine) {
199		$line = '@@';
200		$line .= ' -' . $this->getOriginStartLine() . ',' . $this->getOriginEndLine();
201		$line .= ' +' . $this->getDestStartLine() . ',' . $this->getDestEndLine();
202		$line .= ' @@';
203
204		$this->headerLine = $line;
205		}
206
207		return $this->headerLine;
208		}
209
210		/**
211		* Get Lines
212		*
213		* @return array
214		*/
215		public function getLines(): array
216		{
217		return $this->lines;
218		}
219
220		/**
221		* ArrayAccess interface
222		*
223		* @param int $offset offset
224		*
225		* @return bool
226		*/
227		public function offsetExists($offset): bool
228		{
229		return isset($this->lines[$offset]);
230		}
231
232		/**
233		* ArrayAccess interface
234		*
235		* @param int $offset offset
236		*
237		* @return DiffChunkLine\|null
238		*/
239	1	public function offsetGet($offset)
240		{
241	1	return isset($this->lines[$offset]) ? $this->lines[$offset] : null;
242		}
243
244		/**
245		* ArrayAccess interface
246		*
247		* @param int\|null $offset offset
248		* @param mixed $value value
249		*/
250		public function offsetSet($offset, $value): void
251		{
252		if (is_null($offset)) {
253		$this->lines[] = $value;
254		} else {
255		$this->lines[$offset] = $value;
256		}
257		}
258
259		/**
260		* ArrayAccess interface
261		*
262		* @param int $offset offset
263		*/
264		public function offsetUnset($offset): void
265		{
266		unset($this->lines[$offset]);
267		}
268
269		/**
270		* Countable interface
271		*
272		* @return int
273		*/
274	1	public function count(): int
275		{
276	1	return count($this->lines);
277		}
278
279		/**
280		* Iterator interface
281		*
282		* @return mixed
283		*/
284	1	public function current()
285		{
286	1	return $this->lines[$this->position];
287		}
288
289		/**
290		* Iterator interface
291		*/
292	1	public function next(): void
293		{
294	1	++$this->position;
295	1	}
296
297		/**
298		* Iterator interface
299		*
300		* @return int
301		*/
302		public function key(): int
303		{
304		return $this->position;
305		}
306
307		/**
308		* Iterator interface
309		*
310		* @return bool
311		*/
312	1	public function valid(): bool
313		{
314	1	return isset($this->lines[$this->position]);
315		}
316
317		/**
318		* Iterator interface
319		*/
320	1	public function rewind(): void
321		{
322	1	$this->position = 0;
323	1	}
324		}
325

matteosister / GitElephant

Push — master ( c1a738...2c88a4 )

DiffChunk::valid() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like