Repository::getInfoOperator() - Code Metrics - Inspection of "Add feature to list all config settings" - sebastianfeldmann/git - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e90908...51f84f )

by Sebastian

created 2018-08-03 12:51 UTC

Repository::getInfoOperator() A

↳ Parent: Repository

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
/**
 * 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() : realpath($root);
        // check for existing .git dir
        if (!is_dir($path . DIRECTORY_SEPARATOR . '.git')) {
            throw new \RuntimeException(sprintf('Invalid git repository: %s', $root));
        }
        $this->root      = $path;
        $this->dotGitDir = $this->root . DIRECTORY_SEPARATOR . '.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
     */
    public function setCommitMsg(CommitMessage $commitMsg)
    {
        $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');
    }

    /**
     * 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];
    }
}


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

sebastianfeldmann / git

Push — master ( e90908...51f84f )

Repository::getInfoOperator() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like