NodeObject::__construct() - Code Metrics - Inspection of "- merging develop branch into master" - matteosister/GitElephant - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#139)

unknown

created 2018-04-30 12:39 UTC

NodeObject::__construct() A

↳ Parent: NodeObject

Complexity

Conditions	1
Paths	1

Size

Total Lines	10
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	1

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	10
ccs	9
cts	9
cp	1
rs	9.4285
cc	1
eloc	8
nc	1
nop	7
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;

use \GitElephant\Command\RevParseCommand;
use \GitElephant\Repository;

/**
 * A Object instance represents a node in the git tree repository
 * It could be a file or a folder, as well as a submodule (a "link" in the git language)
 *
 * @author Matteo Giachino <[email protected]>
 */
class NodeObject implements TreeishInterface
{
    const TYPE_BLOB = 'blob';
    const TYPE_TREE = 'tree';
    const TYPE_LINK = 'commit';

    /**
     * @var \GitElephant\Repository
     */
    protected $repository;

    /**
     * permissions
     *
     * @var string
     */
    private $permissions;

    /**
     * type
     *
     * @var string
     */
    private $type;

    /**
     * sha
     *
     * @var string
     */
    private $sha;

    /**
     * size
     *
     * @var string
     */
    private $size;

    /**
     * name
     *
     * @var string
     */
    private $name;

    /**
     * path
     *
     * @var string
     */
    private $path;

    /**
     * create a Object from a single outputLine of the git ls-tree command
     *
     * @param \GitElephant\Repository $repository repository instance
     * @param string                  $outputLine output from ls-tree command
     *
     * @see LsTreeCommand::tree
     * @return NodeObject
     */
    public static function createFromOutputLine(Repository $repository, $outputLine)
    {
        $slices = static::getLineSlices($outputLine);
        $fullPath = $slices['fullPath'];
        if (false === $pos = mb_strrpos($fullPath, '/')) {
            // repository root
            $path = '';
            $name = $fullPath;
        } else {
            $path = substr($fullPath, 0, $pos);
            $name = substr($fullPath, $pos + 1);
        }

        return new static(
            $repository,
            $slices['permissions'],
            $slices['type'],
            $slices['sha'],
            $slices['size'],
            $name,
            $path
        );
    }

    /**
     * Take a line and turn it in slices
     *
     * @param string $line a single line output from the git binary
     *
     * @return array
     */
    public static function getLineSlices($line)
    {
        preg_match('/^(\d+) (\w+) ([a-z0-9]+) +(\d+|-)\t(.*)$/', $line, $matches);
        $permissions = $matches[1];
        $type        = null;
        switch ($matches[2]) {
            case NodeObject::TYPE_TREE:
                $type = NodeObject::TYPE_TREE;
                break;
            case NodeObject::TYPE_BLOB:
                $type = NodeObject::TYPE_BLOB;
                break;
            case NodeObject::TYPE_LINK:
                $type = NodeObject::TYPE_LINK;
                break;
        }
        $sha      = $matches[3];
        $size     = $matches[4];
        $fullPath = $matches[5];

        return array(
            'permissions' => $permissions,
            'type'        => $type,
            'sha'         => $sha,
            'size'        => $size,
            'fullPath'    => $fullPath
        );
    }

    /**
     * Class constructor
     *
     * @param \GitElephant\Repository $repository  repository instance
     * @param string                  $permissions node permissions
     * @param string                  $type        node type
     * @param string                  $sha         node sha
     * @param string                  $size        node size in bytes
     * @param string                  $name        node name
     * @param string                  $path        node path
     */
    public function __construct(Repository $repository, $permissions, $type, $sha, $size, $name, $path)
    {
        $this->repository  = $repository;
        $this->permissions = $permissions;
        $this->type        = $type;
        $this->sha         = $sha;
        $this->size        = $size;
        $this->name        = $name;
        $this->path        = $path;
    }

    /**
     * toString magic method
     *
     * @return string
     */
    public function __toString()
    {
        return (string) $this->name;
    }

    /**
     * Mime Type getter
     *
     * @param string $basePath the base path of the repository
     *
     * @return string
     */
    public function getMimeType($basePath)
    {
        return mime_content_type($basePath . DIRECTORY_SEPARATOR . $this->path);
    }

    /**
     * get extension if it's a blob
     *
     * @return string|null
     */
    public function getExtension()
    {
        $pos = strrpos($this->name, '.');
        if ($pos === false) {
            return null;
        } else {
            return substr($this->name, $pos+1);
        }
    }

    /**
     * whether the node is a tree
     *
     * @return bool
     */
    public function isTree()
    {
        return self::TYPE_TREE == $this->getType();
    }

    /**
     * whether the node is a link
     *
     * @return bool
     */
    public function isLink()
    {
        return self::TYPE_LINK == $this->getType();
    }

    /**
     * whether the node is a blob
     *
     * @return bool
     */
    public function isBlob()
    {
        return self::TYPE_BLOB == $this->getType();
    }

    /**
     * Full path getter
     *
     * @return string
     */
    public function getFullPath()
    {
        return rtrim(
            '' == $this->path ? $this->name : $this->path.DIRECTORY_SEPARATOR.$this->name,
            DIRECTORY_SEPARATOR
        );
    }

    /**
     * permissions getter
     *
     * @return string
     */
    public function getPermissions()
    {
        return $this->permissions;
    }

    /**
     * sha getter
     *
     * @return string
     */
    public function getSha()
    {
        return $this->sha;
    }

    /**
     * type getter
     *
     * @return string
     */
    public function getType()
    {
        return $this->type;
    }

    /**
     * name getter
     *
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * path getter
     *
     * @return string
     */
    public function getPath()
    {
        return $this->path;
    }

    /**
     * size getter
     *
     * @return string
     */
    public function getSize()
    {
        return $this->size;
    }

    /**
     * gets the last commit in this object
     *
     * @return Commit
     */
    public function getLastCommit()
    {
        $log = $this->repository->getLog('HEAD', $this->getFullPath(), 1);
        return $log[0];
    }

    /**
     * rev-parse command - often used to return a commit tag.
     *
     * @param array         $options the options to apply to rev-parse
     *
     * @throws \RuntimeException
     * @throws \InvalidArgumentException
     * @throws \Symfony\Component\Process\Exception\RuntimeException
     * @return array
     */
    public function revParse(Array $options = array())

    {
        $c = RevParseCommand::getInstance()->revParse($this, $options);
        $caller = $this->repository->getCaller();
        $caller->execute($c);

        return array_map('trim', $caller->getOutputLines(true));
    }

    /*
     * Repository setter
     *
     * @param \GitElephant\Repository $repository the repository variable
     */
    public function setRepository(Repository $repository)
    {
        $this->repository = $repository;
    }

    /**
     * Repository getter
     *
     * @return \GitElephant\Repository
     */
    public function getRepository()
    {
        return $this->repository;
    }
}


1		<?php
2		/**
3		* GitElephant - An abstraction layer for git written in PHP
4		* Copyright (C) 2013 Matteo Giachino
5		*
6		* This program is free software: you can redistribute it and/or modify
7		* it under the terms of the GNU General Public License as published by
8		* the Free Software Foundation, either version 3 of the License, or
9		* (at your option) any later version.
10		*
11		* This program is distributed in the hope that it will be useful,
12		* but WITHOUT ANY WARRANTY; without even the implied warranty of
13		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14		* GNU General Public License for more details.
15		*
16		* You should have received a copy of the GNU General Public License
17		* along with this program. If not, see [http://www.gnu.org/licenses/].
18		*/
19
20		namespace GitElephant\Objects;
21
22		use \GitElephant\Command\RevParseCommand;
23		use \GitElephant\Repository;
24
25		/**
26		* A Object instance represents a node in the git tree repository
27		* It could be a file or a folder, as well as a submodule (a "link" in the git language)
28		*
29		* @author Matteo Giachino <[email protected]>
30		*/
31		class NodeObject implements TreeishInterface
32		{
33		const TYPE_BLOB = 'blob';
34		const TYPE_TREE = 'tree';
35		const TYPE_LINK = 'commit';
36
37		/**
38		* @var \GitElephant\Repository
39		*/
40		protected $repository;
41
42		/**
43		* permissions
44		*
45		* @var string
46		*/
47		private $permissions;
48
49		/**
50		* type
51		*
52		* @var string
53		*/
54		private $type;
55
56		/**
57		* sha
58		*
59		* @var string
60		*/
61		private $sha;
62
63		/**
64		* size
65		*
66		* @var string
67		*/
68		private $size;
69
70		/**
71		* name
72		*
73		* @var string
74		*/
75		private $name;
76
77		/**
78		* path
79		*
80		* @var string
81		*/
82		private $path;
83
84		/**
85		* create a Object from a single outputLine of the git ls-tree command
86		*
87		* @param \GitElephant\Repository $repository repository instance
88		* @param string $outputLine output from ls-tree command
89		*
90		* @see LsTreeCommand::tree
91		* @return NodeObject
92		*/
93	8	public static function createFromOutputLine(Repository $repository, $outputLine)
94		{
95	8	$slices = static::getLineSlices($outputLine);
96	8	$fullPath = $slices['fullPath'];
97	8	if (false === $pos = mb_strrpos($fullPath, '/')) {
98		// repository root
99	6	$path = '';
100	6	$name = $fullPath;
101		} else {
102	4	$path = substr($fullPath, 0, $pos);
103	4	$name = substr($fullPath, $pos + 1);
104		}
105
106	8	return new static(
107	8	$repository,
108	8	$slices['permissions'],
109	8	$slices['type'],
110	8	$slices['sha'],
111	8	$slices['size'],
112	8	$name,
113	8	$path
114		);
115		}
116
117		/**
118		* Take a line and turn it in slices
119		*
120		* @param string $line a single line output from the git binary
121		*
122		* @return array
123		*/
124	14	public static function getLineSlices($line)
125		{
126	14	preg_match('/^(\d+) (\w+) ([a-z0-9]+) +(\d+\|-)\t(.*)$/', $line, $matches);
127	14	$permissions = $matches[1];
128	14	$type = null;
129	14	switch ($matches[2]) {
130	14	case NodeObject::TYPE_TREE:
131	5	$type = NodeObject::TYPE_TREE;
132	5	break;
133	14	case NodeObject::TYPE_BLOB:
134	14	$type = NodeObject::TYPE_BLOB;
135	14	break;
136	1	case NodeObject::TYPE_LINK:
137	1	$type = NodeObject::TYPE_LINK;
138	1	break;
139		}
140	14	$sha = $matches[3];
141	14	$size = $matches[4];
142	14	$fullPath = $matches[5];
143
144		return array(
145	14	'permissions' => $permissions,
146	14	'type' => $type,
147	14	'sha' => $sha,
148	14	'size' => $size,
149	14	'fullPath' => $fullPath
150		);
151		}
152
153		/**
154		* Class constructor
155		*
156		* @param \GitElephant\Repository $repository repository instance
157		* @param string $permissions node permissions
158		* @param string $type node type
159		* @param string $sha node sha
160		* @param string $size node size in bytes
161		* @param string $name node name
162		* @param string $path node path
163		*/
164	14	public function __construct(Repository $repository, $permissions, $type, $sha, $size, $name, $path)
165		{
166	14	$this->repository = $repository;
167	14	$this->permissions = $permissions;
168	14	$this->type = $type;
169	14	$this->sha = $sha;
170	14	$this->size = $size;
171	14	$this->name = $name;
172	14	$this->path = $path;
173	14	}
174
175		/**
176		* toString magic method
177		*
178		* @return string
179		*/
180	1	public function __toString()
181		{
182	1	return (string) $this->name;
183		}
184
185		/**
186		* Mime Type getter
187		*
188		* @param string $basePath the base path of the repository
189		*
190		* @return string
191		*/
192		public function getMimeType($basePath)
193		{
194		return mime_content_type($basePath . DIRECTORY_SEPARATOR . $this->path);
195		}
196
197		/**
198		* get extension if it's a blob
199		*
200		* @return string\|null
201		*/
202		public function getExtension()
203		{
204		$pos = strrpos($this->name, '.');
205		if ($pos === false) {
206		return null;
207		} else {
208		return substr($this->name, $pos+1);
209		}
210		}
211
212		/**
213		* whether the node is a tree
214		*
215		* @return bool
216		*/
217	9	public function isTree()
218		{
219	9	return self::TYPE_TREE == $this->getType();
220		}
221
222		/**
223		* whether the node is a link
224		*
225		* @return bool
226		*/
227		public function isLink()
228		{
229		return self::TYPE_LINK == $this->getType();
230		}
231
232		/**
233		* whether the node is a blob
234		*
235		* @return bool
236		*/
237	1	public function isBlob()
238		{
239	1	return self::TYPE_BLOB == $this->getType();
240		}
241
242		/**
243		* Full path getter
244		*
245		* @return string
246		*/
247	12	public function getFullPath()
248		{
249	12	return rtrim(
250	12	'' == $this->path ? $this->name : $this->path.DIRECTORY_SEPARATOR.$this->name,
251	12	DIRECTORY_SEPARATOR
252		);
253		}
254
255		/**
256		* permissions getter
257		*
258		* @return string
259		*/
260		public function getPermissions()
261		{
262		return $this->permissions;
263		}
264
265		/**
266		* sha getter
267		*
268		* @return string
269		*/
270	6	public function getSha()
271		{
272	6	return $this->sha;
273		}
274
275		/**
276		* type getter
277		*
278		* @return string
279		*/
280	13	public function getType()
281		{
282	13	return $this->type;
283		}
284
285		/**
286		* name getter
287		*
288		* @return string
289		*/
290	5	public function getName()
291		{
292	5	return $this->name;
293		}
294
295		/**
296		* path getter
297		*
298		* @return string
299		*/
300		public function getPath()
301		{
302		return $this->path;
303		}
304
305		/**
306		* size getter
307		*
308		* @return string
309		*/
310		public function getSize()
311		{
312		return $this->size;
313		}
314
315		/**
316		* gets the last commit in this object
317		*
318		* @return Commit
319		*/
320	3	public function getLastCommit()
321		{
322	3	$log = $this->repository->getLog('HEAD', $this->getFullPath(), 1);
323	3	return $log[0];
324		}
325
326		/**
327		* rev-parse command - often used to return a commit tag.
328		*
329		* @param array $options the options to apply to rev-parse
330		*
331		* @throws \RuntimeException
332		* @throws \InvalidArgumentException
333		* @throws \Symfony\Component\Process\Exception\RuntimeException
334		* @return array
335		*/
336	1	public function revParse(Array $options = array())
		0 ignored issues – show Coding Style introduced 2017-11-01 09:27 UTC by Report Bug Copy Issue Report As per coding-style, PHP keywords should be in lowercase; expected `array`, but found `Array`. Loading history...
337		{
338	1	$c = RevParseCommand::getInstance()->revParse($this, $options);
339	1	$caller = $this->repository->getCaller();
340	1	$caller->execute($c);
341
342	1	return array_map('trim', $caller->getOutputLines(true));
343		}
344
345		/*
346		* Repository setter
347		*
348		* @param \GitElephant\Repository $repository the repository variable
349		*/
350	1	public function setRepository(Repository $repository)
351		{
352	1	$this->repository = $repository;
353	1	}
354
355		/**
356		* Repository getter
357		*
358		* @return \GitElephant\Repository
359		*/
360	59	public function getRepository()
361		{
362	59	return $this->repository;
363		}
364		}
365

matteosister / GitElephant

Pull Request — master (#139)

NodeObject::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like