Repository::getCommitMsg() - Code Metrics - sebastianfeldmann/git - Measure and Improve Code Quality continuously with Scrutinizer

Repository::getCommitMsg() A
last analyzed 2020-10-21 13:55 UTC

↳ Parent: Repository

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	2

Importance

Changes	2
Bugs	0	Features	0

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

<?php

/**
 * This file is part of SebastianFeldmann\Git.
 *
 * (c) Sebastian Feldmann <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace SebastianFeldmann\Git;

use SebastianFeldmann\Cli\Command\Runner;

/**
 * Class Repository
 *
 * @package SebastianFeldmann\Git
 * @author  Sebastian Feldmann <[email protected]>
 * @link    https://github.com/sebastianfeldmann/git
 * @since   Class available since Release 0.9.0
 */
class Repository
{
    /**
     * Path to git repository root
     *
     * @var string
     */
    private $root;

    /**
     * Path to .git directory
     *
     * @var string
     */
    private $dotGitDir;

    /**
     * Commit message.
     *
     * @var \SebastianFeldmann\Git\CommitMessage
     */
    private $commitMsg;

    /**
     * Executes cli commands
     *
     * @var \SebastianFeldmann\Cli\Command\Runner
     */
    private $runner;

    /**
     * Map of operators
     *
     * @var array
     */
    private $operator = [];

    /**
     * Repository constructor
     *
     * @param string                                $root
     * @param \SebastianFeldmann\Cli\Command\Runner $runner
     */
    public function __construct(string $root = '', Runner $runner = null)
    {
        $path            = empty($root) ? getcwd() : $root;
        $this->root      = $path;
        $this->dotGitDir = $this->root . '/.git';
        $this->runner    = null == $runner ? new Runner\Simple() : $runner;
    }

    /**
     * Root path getter
     *
     * @return string
     */
    public function getRoot(): string
    {
        return $this->root;
    }

    /**
     * Returns the path to the hooks directory
     *
     * @return string
     */
    public function getHooksDir(): string
    {
        return $this->dotGitDir . DIRECTORY_SEPARATOR . 'hooks';
    }

    /**
     * Check for a hook file.
     *
     * @param  string $hook
     * @return bool
     */
    public function hookExists($hook): bool
    {
        return file_exists($this->getHooksDir() . DIRECTORY_SEPARATOR . $hook);
    }

    /**
     * CommitMessage setter.
     *
     * @param  \SebastianFeldmann\Git\CommitMessage $commitMsg
     * @return void
     */
    public function setCommitMsg(CommitMessage $commitMsg): void
    {
        $this->commitMsg = $commitMsg;
    }

    /**
     * CommitMessage getter.
     *
     * @return \SebastianFeldmann\Git\CommitMessage
     */
    public function getCommitMsg(): CommitMessage
    {
        if (null === $this->commitMsg) {
            throw new \RuntimeException('No commit message available');
        }
        return $this->commitMsg;
    }

    /**
     * Is there a merge in progress.
     *
     * @return bool
     */
    public function isMerging(): bool
    {
        foreach (['MERGE_MSG', 'MERGE_HEAD', 'MERGE_MODE'] as $fileName) {
            if (file_exists($this->dotGitDir . DIRECTORY_SEPARATOR . $fileName)) {
                return true;
            }
        }
        return false;
    }

    /**
     * Get index operator.
     *
     * @return \SebastianFeldmann\Git\Operator\Index
     */
    public function getIndexOperator(): Operator\Index
    {
        return $this->getOperator('Index');
    }

    /**
     * Get info operator.
     *
     * @return \SebastianFeldmann\Git\Operator\Info
     */
    public function getInfoOperator(): Operator\Info
    {
        return $this->getOperator('Info');
    }

    /**
     * Get log operator.
     *
     * @return \SebastianFeldmann\Git\Operator\Log
     */
    public function getLogOperator(): Operator\Log
    {
        return $this->getOperator('Log');
    }

    /**
     * Get config operator.
     *
     * @return \SebastianFeldmann\Git\Operator\Config
     */
    public function getConfigOperator(): Operator\Config
    {
        return $this->getOperator('Config');
    }

    /**
     * Get diff operator.
     *
     * @return \SebastianFeldmann\Git\Operator\Diff
     */
    public function getDiffOperator(): Operator\Diff
    {
        return $this->getOperator('Diff');
    }

    /**
     * Return requested operator.
     *
     * @param  string $name
     * @return mixed
     */
    private function getOperator(string $name)
    {
        if (!isset($this->operator[$name])) {
            $class                 = '\\SebastianFeldmann\\Git\\Operator\\' . $name;
            $this->operator[$name] = new $class($this->runner, $this);
        }
        return $this->operator[$name];
    }

    /**
     * Creates a Repository but makes sure the repository exists
     *
     * @param  string                                     $root
     * @param  \SebastianFeldmann\Cli\Command\Runner|null $runner
     * @return \SebastianFeldmann\Git\Repository
     */
    public static function createVerified(string $root, Runner $runner = null): Repository
    {
        if (!self::isGitRepository($root)) {
            throw new \RuntimeException(sprintf('Invalid git repository: %s', $root));
        }
        return new Repository($root, $runner);
    }

    /**
     * @param  string $root
     * @return bool
     */
    public static function isGitRepository(string $root): bool
    {
        return is_dir($root . '/.git');
    }
}


1		<?php
2
3		/**
4		* This file is part of SebastianFeldmann\Git.
5		*
6		* (c) Sebastian Feldmann <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace SebastianFeldmann\Git;
13
14		use SebastianFeldmann\Cli\Command\Runner;
15
16		/**
17		* Class Repository
18		*
19		* @package SebastianFeldmann\Git
20		* @author Sebastian Feldmann <[email protected]>
21		* @link https://github.com/sebastianfeldmann/git
22		* @since Class available since Release 0.9.0
23		*/
24		class Repository
25		{
26		/**
27		* Path to git repository root
28		*
29		* @var string
30		*/
31		private $root;
32
33		/**
34		* Path to .git directory
35		*
36		* @var string
37		*/
38		private $dotGitDir;
39
40		/**
41		* Commit message.
42		*
43		* @var \SebastianFeldmann\Git\CommitMessage
44		*/
45		private $commitMsg;
46
47		/**
48		* Executes cli commands
49		*
50		* @var \SebastianFeldmann\Cli\Command\Runner
51		*/
52		private $runner;
53
54		/**
55		* Map of operators
56		*
57		* @var array
58		*/
59		private $operator = [];
60
61		/**
62		* Repository constructor
63		*
64		* @param string $root
65	11	* @param \SebastianFeldmann\Cli\Command\Runner $runner
66		*/
67	11	public function __construct(string $root = '', Runner $runner = null)
68	11	{
69	11	$path = empty($root) ? getcwd() : $root;
70	11	$this->root = $path;
71	11	$this->dotGitDir = $this->root . '/.git';
72		$this->runner = null == $runner ? new Runner\Simple() : $runner;
73		}
74
75		/**
76		* Root path getter
77		*
78	1	* @return string
79		*/
80	1	public function getRoot(): string
81		{
82		return $this->root;
83		}
84
85		/**
86		* Returns the path to the hooks directory
87		*
88	2	* @return string
89		*/
90	2	public function getHooksDir(): string
91		{
92		return $this->dotGitDir . DIRECTORY_SEPARATOR . 'hooks';
93		}
94
95		/**
96		* Check for a hook file.
97		*
98		* @param string $hook
99	1	* @return bool
100		*/
101	1	public function hookExists($hook): bool
102		{
103		return file_exists($this->getHooksDir() . DIRECTORY_SEPARATOR . $hook);
104		}
105
106		/**
107		* CommitMessage setter.
108		*
109		* @param \SebastianFeldmann\Git\CommitMessage $commitMsg
110	1	* @return void
111		*/
112	1	public function setCommitMsg(CommitMessage $commitMsg): void
113	1	{
114		$this->commitMsg = $commitMsg;
115		}
116
117		/**
118		* CommitMessage getter.
119		*
120	2	* @return \SebastianFeldmann\Git\CommitMessage
121		*/
122	2	public function getCommitMsg(): CommitMessage
123	1	{
124		if (null === $this->commitMsg) {
125	1	throw new \RuntimeException('No commit message available');
126		}
127		return $this->commitMsg;
128		}
129
130		/**
131		* Is there a merge in progress.
132		*
133	2	* @return bool
134		*/
135	2	public function isMerging(): bool
136	2	{
137	2	foreach (['MERGE_MSG', 'MERGE_HEAD', 'MERGE_MODE'] as $fileName) {
138		if (file_exists($this->dotGitDir . DIRECTORY_SEPARATOR . $fileName)) {
139		return true;
140	1	}
141		}
142		return false;
143		}
144
145		/**
146		* Get index operator.
147		*
148	1	* @return \SebastianFeldmann\Git\Operator\Index
149		*/
150	1	public function getIndexOperator(): Operator\Index
151		{
152		return $this->getOperator('Index');
153		}
154
155		/**
156		* Get info operator.
157		*
158	1	* @return \SebastianFeldmann\Git\Operator\Info
159		*/
160	1	public function getInfoOperator(): Operator\Info
161		{
162		return $this->getOperator('Info');
163		}
164
165		/**
166		* Get log operator.
167		*
168	1	* @return \SebastianFeldmann\Git\Operator\Log
169		*/
170	1	public function getLogOperator(): Operator\Log
171		{
172		return $this->getOperator('Log');
173		}
174
175		/**
176		* Get config operator.
177		*
178	1	* @return \SebastianFeldmann\Git\Operator\Config
179		*/
180	1	public function getConfigOperator(): Operator\Config
181		{
182		return $this->getOperator('Config');
183		}
184
185		/**
186		* Get diff operator.
187		*
188	1	* @return \SebastianFeldmann\Git\Operator\Diff
189		*/
190	1	public function getDiffOperator(): Operator\Diff
191		{
192		return $this->getOperator('Diff');
193		}
194
195		/**
196		* Return requested operator.
197		*
198		* @param string $name
199	5	* @return mixed
200		*/
201	5	private function getOperator(string $name)
202	5	{
203	5	if (!isset($this->operator[$name])) {
204		$class = '\\SebastianFeldmann\\Git\\Operator\\' . $name;
205	5	$this->operator[$name] = new $class($this->runner, $this);
206		}
207		return $this->operator[$name];
208		}
209
210		/**
211		* Creates a Repository but makes sure the repository exists
212		*
213		* @param string $root
214		* @param \SebastianFeldmann\Cli\Command\Runner\|null $runner
215	2	* @return \SebastianFeldmann\Git\Repository
216		*/
217	2	public static function createVerified(string $root, Runner $runner = null): Repository
218	1	{
219		if (!self::isGitRepository($root)) {
220	1	throw new \RuntimeException(sprintf('Invalid git repository: %s', $root));
221		}
222		return new Repository($root, $runner);
223		}
224
225		/**
226		* @param string $root
227	2	* @return bool
228		*/
229	2	public static function isGitRepository(string $root): bool
230		{
231		return is_dir($root . '/.git');
232		}
233		}
234

sebastianfeldmann / git

Repository::getCommitMsg() A last analyzed 2020-10-21 13:55 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Repository::getCommitMsg() A
last analyzed 2020-10-21 13:55 UTC