BaseCommand::getCLIConfigs() - Code Metrics - Inspection of "Merge pull request #100 from Vivalldi/patch-1" - matteosister/GitElephant - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 5f7df1...9cb564 )

by Matteo

created 2016-05-27 07:37 UTC

BaseCommand::getCLIConfigs() A

↳ Parent: BaseCommand

Complexity

Conditions	3
Paths	2

Size

Total Lines	16
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	14
CRAP Score	3

Importance

Changes	2
Bugs	1	Features	0

Metric	Value
c	2
b	1
f	0
dl	0
loc	16
ccs	14
cts	14
cp	1
rs	9.4285
cc	3
eloc	11
nc	2
nop	0
crap	3

<?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\Command;

use \GitElephant\Repository;
use \PhpCollection\Map;

/**
 * BaseCommand
 *
 * The base class for all the command generators
 *
 * @author Matteo Giachino <[email protected]>
 */
class BaseCommand
{
    /**
     * the command name
     *
     * @var string
     */
    private $commandName = null;

    /**
     * config options
     *
     * @var array
     */
    private $configs = array();

    /**
     * global configs
     *
     * @var array
     */
    private $globalConfigs = array();

    /**
     * global options
     *
     * @var array
     */
    private $globalOptions = array();

    /**
     * the command arguments
     *
     * @var array
     */
    private $commandArguments = array();

    /**
     * the global command arguments
     *
     * @var array
     */
    private $globalCommandArguments = array();

    /**
     * the command subject
     *
     * @var string|SubCommandCommand
     */
    private $commandSubject = null;

    /**
     * the command second subject (i.e. for branch)
     *
     * @var string|SubCommandCommand
     */
    private $commandSubject2 = null;

    /**
     * the path
     *
     * @var string
     */
    private $path = null;

    /**
     * constructor
     *
     * should be called by all child classes' constructors to permit use of 
     * global configs, options and command arguments
     *
     * @param null|\GitElephant\Repository $repo The repo object to read
     */
    public function __construct(Repository $repo = null)
    {
        if (!is_null($repo)) {
            $this->addGlobalConfigs($repo->getGlobalConfigs());
            $this->addGlobalOptions($repo->getGlobalOptions());
            
            $arguments = $repo->getGlobalCommandArguments();
            if (!empty($arguments)) {
                foreach ($arguments as $argument) {
                    $this->addGlobalCommandArgument($argument);
                }
            }
        }
    }

    /**
     * Clear all previous variables
     */
    public function clearAll()
    {
        $this->commandName            = null;
        $this->configs                = array();
        $this->commandArguments       = array();
        $this->commandSubject         = null;
        $this->commandSubject2        = null;
        $this->path                   = null;
    }

    public static function getInstance(Repository $repo = null)
    {
        return new static($repo);
    }

    /**
     * Add the command name
     *
     * @param string $commandName the command name
     */
    protected function addCommandName($commandName)
    {
        $this->commandName = $commandName;
    }

    /**
     * Get command name
     *
     * @return string
     */
    protected function getCommandName()
    {
        return $this->commandName;
    }

    /**
     * Set Configs
     *
     * @param array|Map $configs the config variable. i.e. { "color.status" => "false", "color.diff" => "true" }
     */
    public function addConfigs($configs)
    {
        foreach ($configs as $config => $value) {
            $this->configs[$config] = $value;
        }
    }

    /**
     * Set global configs
     *
     * @param array|Map $configs the config variable. i.e. { "color.status" => "false", "color.diff" => "true" }
     */
    protected function addGlobalConfigs($configs)
    {
        if (!empty($configs)) {
            foreach ($configs as $config => $value) {
                $this->globalConfigs[$config] = $value;
            }
        }
    }

    /**
     * Set global option
     *
     * @param array|Map $options a global option
     */
    protected function addGlobalOptions($options)
    {
        if (!empty($options)) {
            foreach ($options as $name => $value) {
                $this->globalOptions[$name] = $value;
            }
        }
    }

    /**
     * Get Configs
     *
     * @return array
     */
    public function getConfigs()
    {
        return $this->configs;
    }

    /**
     * Add a command argument
     *
     * @param string $commandArgument the command argument
     */
    protected function addCommandArgument($commandArgument)
    {
        $this->commandArguments[] = $commandArgument;
    }

    /**
     * Add a global command argument
     *
     * @param string $commandArgument the command argument
     */
    protected function addGlobalCommandArgument($commandArgument)
    {
        if (!empty($commandArgument)) {
            $this->globalCommandArguments[] = $commandArgument;
        }
    }

    /**
     * Get all added command arguments
     *
     * @return array
     */
    protected function getCommandArguments()
    {
        return ($this->commandArguments) ? $this->commandArguments: array();
    }

    /**
     * Add a command subject
     *
     * @param string $commandSubject the command subject
     */
    protected function addCommandSubject($commandSubject)
    {
        $this->commandSubject = $commandSubject;
    }

    /**
     * Add a second command subject
     *
     * @param string $commandSubject2 the second command subject
     */
    protected function addCommandSubject2($commandSubject2)
    {
        $this->commandSubject2 = $commandSubject2;
    }

    /**
     * Add a path to the git command
     *
     * @param string $path path
     */
    protected function addPath($path)
    {
        $this->path = $path;
    }

    /**
     * Normalize any valid option to its long name
     * an provide a structure that can be more intelligently
     * handled by other routines
     *
     * @param array $options       command options
     * @param array $switchOptions list of valid options that are switch like
     * @param array $valueOptions  list of valid options that must have a value assignment
     *
     * @return array Associative array of valid, normalized command options
     */
    public function normalizeOptions(Array $options = array(), Array $switchOptions = array(), $valueOptions = array())

    {
        $normalizedOptions = array();

        foreach ($options as $option) {
            if (array_key_exists($option, $switchOptions)) {
                $normalizedOptions[$switchOptions[$option]] = $switchOptions[$option];
            } else {
                $parts = preg_split('/([\s=])+/', $option, 2, PREG_SPLIT_DELIM_CAPTURE);
                if (count($parts)) {
                    $optionName = $parts[0];
                    if (in_array($optionName, $valueOptions)) {
                        $value = ($parts[1] == '=') ? $option : array($parts[0], $parts[2]);
                        $normalizedOptions[$optionName] = $value;
                    }
                }
            }
        }

        return $normalizedOptions;
    }

    /**
     * Get the current command
     *
     * @return string
     * @throws \RuntimeException
     */
    public function getCommand()
    {
        if (is_null($this->commandName)) {
            throw new \RuntimeException("You should pass a commandName to execute a command");
        }

        $command  = '';
        $command .= $this->getCLIConfigs();
        $command .= $this->getCLIGlobalOptions();
        $command .= $this->getCLICommandName();
        $command .= $this->getCLICommandArguments();
        $command .= $this->getCLISubjects();
        $command .= $this->getCLIPath();

        $command = preg_replace('/\\s{2,}/', ' ', $command);

        return trim($command);
    }

    /**
     * get a string of CLI-formatted command arguments
     *
     * @return string The command argument string
     */
    private function getCLICommandArguments()
    {
        $command = '';
        $combinedArguments = array_merge($this->globalCommandArguments, $this->commandArguments);
        if (count($combinedArguments) > 0) {
            $command .= ' ' . implode(' ', array_map('escapeshellarg', $combinedArguments));
        }
        return $command;
    }

    /**
     * get a string of CLI-formatted command name
     *
     * @return string The command name string
     */
    private function getCLICommandName()
    {
        return ' ' . $this->commandName;
    }

    /**
     * get a string of CLI-formatted configs
     *
     * @return string The config string
     */
    private function getCLIConfigs()
    {
        $command = '';
        $combinedConfigs = array_merge($this->globalConfigs, $this->configs);
        if (count($combinedConfigs)) {
            foreach ($combinedConfigs as $config => $value) {
                $command .= sprintf(
                    ' %s %s=%s',
                    escapeshellarg('-c'),
                    escapeshellarg($config),
                    escapeshellarg($value)
                );
            }
        }
        return $command;
    }

    /**
     * get a string of CLI-formatted global options
     *
     * @return string The global options string
     */
    private function getCLIGlobalOptions()
    {
        $command = '';
        if (count($this->globalOptions) > 0) {
            foreach ($this->globalOptions as $name => $value) {
                $command .= sprintf(' %s=%s', escapeshellarg($name), escapeshellarg($value));
            }
        }
        return $command;
    }

    /**
     * get a string of CLI-formatted path
     *
     * @return string The path string
     */
    private function getCLIPath()
    {
        $command = '';
        if (!is_null($this->path)) {
            $command .= sprintf(' -- %s', escapeshellarg($this->path));
        }
        return $command;
    }

    /**
     * get a string of CLI-formatted subjects
     *
     * @throws \RuntimeException
     * @return string The subjects string
     */
    private function getCLISubjects()
    {
        $command = '';
        if (!is_null($this->commandSubject)) {
            $command .= ' ';
            if ($this->commandSubject instanceof SubCommandCommand) {
                $command .= $this->commandSubject->getCommand();
            } else {
                if (is_array($this->commandSubject)) {
                    $command .= implode(' ', array_map('escapeshellarg', $this->commandSubject));
                } else {
                    $command .= escapeshellarg($this->commandSubject);
                }
            }
        }
        if (!is_null($this->commandSubject2)) {
            $command .= ' ';
            if ($this->commandSubject2 instanceof SubCommandCommand) {
                $command .= $this->commandSubject2->getCommand();
            } else {
                if (is_array($this->commandSubject2)) {
                    $command .= implode(' ', array_map('escapeshellarg', $this->commandSubject2));
                } else {
                    $command .= escapeshellarg($this->commandSubject2);
                }
            }
        }
        return $command;
    }
}


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\Command;
21
22		use \GitElephant\Repository;
23		use \PhpCollection\Map;
24
25		/**
26		* BaseCommand
27		*
28		* The base class for all the command generators
29		*
30		* @author Matteo Giachino <[email protected]>
31		*/
32		class BaseCommand
33		{
34		/**
35		* the command name
36		*
37		* @var string
38		*/
39		private $commandName = null;
40
41		/**
42		* config options
43		*
44		* @var array
45		*/
46		private $configs = array();
47
48		/**
49		* global configs
50		*
51		* @var array
52		*/
53		private $globalConfigs = array();
54
55		/**
56		* global options
57		*
58		* @var array
59		*/
60		private $globalOptions = array();
61
62		/**
63		* the command arguments
64		*
65		* @var array
66		*/
67		private $commandArguments = array();
68
69		/**
70		* the global command arguments
71		*
72		* @var array
73		*/
74		private $globalCommandArguments = array();
75
76		/**
77		* the command subject
78		*
79		* @var string\|SubCommandCommand
80		*/
81		private $commandSubject = null;
82
83		/**
84		* the command second subject (i.e. for branch)
85		*
86		* @var string\|SubCommandCommand
87		*/
88		private $commandSubject2 = null;
89
90		/**
91		* the path
92		*
93		* @var string
94		*/
95		private $path = null;
96
97		/**
98		* constructor
99		*
100		* should be called by all child classes' constructors to permit use of
101		* global configs, options and command arguments
102		*
103		* @param null\|\GitElephant\Repository $repo The repo object to read
104		*/
105	118	public function __construct(Repository $repo = null)
106		{
107	118	if (!is_null($repo)) {
108	95	$this->addGlobalConfigs($repo->getGlobalConfigs());
109	95	$this->addGlobalOptions($repo->getGlobalOptions());
110
111	95	$arguments = $repo->getGlobalCommandArguments();
112	95	if (!empty($arguments)) {
113	1	foreach ($arguments as $argument) {
114	1	$this->addGlobalCommandArgument($argument);
115	1	}
116	1	}
117	95	}
118	118	}
119
120		/**
121		* Clear all previous variables
122		*/
123	104	public function clearAll()
124		{
125	104	$this->commandName = null;
126	104	$this->configs = array();
127	104	$this->commandArguments = array();
128	104	$this->commandSubject = null;
129	104	$this->commandSubject2 = null;
130	104	$this->path = null;
131	104	}
132
133	108	public static function getInstance(Repository $repo = null)
134		{
135	108	return new static($repo);
136		}
137
138		/**
139		* Add the command name
140		*
141		* @param string $commandName the command name
142		*/
143	105	protected function addCommandName($commandName)
144		{
145	105	$this->commandName = $commandName;
146	105	}
147
148		/**
149		* Get command name
150		*
151		* @return string
152		*/
153	11	protected function getCommandName()
154		{
155	11	return $this->commandName;
156		}
157
158		/**
159		* Set Configs
160		*
161		* @param array\|Map $configs the config variable. i.e. { "color.status" => "false", "color.diff" => "true" }
162		*/
163	3	public function addConfigs($configs)
164		{
165	3	foreach ($configs as $config => $value) {
166	3	$this->configs[$config] = $value;
167	3	}
168	3	}
169
170		/**
171		* Set global configs
172		*
173		* @param array\|Map $configs the config variable. i.e. { "color.status" => "false", "color.diff" => "true" }
174		*/
175	95	protected function addGlobalConfigs($configs)
176		{
177	95	if (!empty($configs)) {
178	1	foreach ($configs as $config => $value) {
179	1	$this->globalConfigs[$config] = $value;
180	1	}
181	1	}
182	95	}
183
184		/**
185		* Set global option
186		*
187		* @param array\|Map $options a global option
188		*/
189	95	protected function addGlobalOptions($options)
190		{
191	95	if (!empty($options)) {
192	1	foreach ($options as $name => $value) {
193	1	$this->globalOptions[$name] = $value;
194	1	}
195	1	}
196	95	}
197
198		/**
199		* Get Configs
200		*
201		* @return array
202		*/
203		public function getConfigs()
204		{
205		return $this->configs;
206		}
207
208		/**
209		* Add a command argument
210		*
211		* @param string $commandArgument the command argument
212		*/
213	101	protected function addCommandArgument($commandArgument)
214		{
215	101	$this->commandArguments[] = $commandArgument;
216	101	}
217
218		/**
219		* Add a global command argument
220		*
221		* @param string $commandArgument the command argument
222		*/
223	1	protected function addGlobalCommandArgument($commandArgument)
224		{
225	1	if (!empty($commandArgument)) {
226	1	$this->globalCommandArguments[] = $commandArgument;
227	1	}
228	1	}
229
230		/**
231		* Get all added command arguments
232		*
233		* @return array
234		*/
235	11	protected function getCommandArguments()
236		{
237	11	return ($this->commandArguments) ? $this->commandArguments: array();
238		}
239
240		/**
241		* Add a command subject
242		*
243		* @param string $commandSubject the command subject
244		*/
245	96	protected function addCommandSubject($commandSubject)
246		{
247	96	$this->commandSubject = $commandSubject;
248	96	}
249
250		/**
251		* Add a second command subject
252		*
253		* @param string $commandSubject2 the second command subject
254		*/
255	21	protected function addCommandSubject2($commandSubject2)
256		{
257	21	$this->commandSubject2 = $commandSubject2;
258	21	}
259
260		/**
261		* Add a path to the git command
262		*
263		* @param string $path path
264		*/
265	19	protected function addPath($path)
266		{
267	19	$this->path = $path;
268	19	}
269
270		/**
271		* Normalize any valid option to its long name
272		* an provide a structure that can be more intelligently
273		* handled by other routines
274		*
275		* @param array $options command options
276		* @param array $switchOptions list of valid options that are switch like
277		* @param array $valueOptions list of valid options that must have a value assignment
278		*
279		* @return array Associative array of valid, normalized command options
280		*/
281	15	public function normalizeOptions(Array $options = array(), Array $switchOptions = array(), $valueOptions = array())
		0 ignored issues – show Coding Style introduced 2016-03-02 13:00 UTC by Report Bug Copy Issue Report As per coding-style, PHP keywords should be in lowercase; expected `array`, but found `Array`. Loading history...
282		{
283	15	$normalizedOptions = array();
284
285	15	foreach ($options as $option) {
286	7	if (array_key_exists($option, $switchOptions)) {
287	7	$normalizedOptions[$switchOptions[$option]] = $switchOptions[$option];
288	7	} else {
289	1	$parts = preg_split('/([\s=])+/', $option, 2, PREG_SPLIT_DELIM_CAPTURE);
290	1	if (count($parts)) {
291	1	$optionName = $parts[0];
292	1	if (in_array($optionName, $valueOptions)) {
293	1	$value = ($parts[1] == '=') ? $option : array($parts[0], $parts[2]);
294	1	$normalizedOptions[$optionName] = $value;
295	1	}
296	1	}
297		}
298	15	}
299
300	15	return $normalizedOptions;
301		}
302
303		/**
304		* Get the current command
305		*
306		* @return string
307		* @throws \RuntimeException
308		*/
309	106	public function getCommand()
310		{
311	106	if (is_null($this->commandName)) {
312	1	throw new \RuntimeException("You should pass a commandName to execute a command");
313		}
314
315	105	$command = '';
316	105	$command .= $this->getCLIConfigs();
317	105	$command .= $this->getCLIGlobalOptions();
318	105	$command .= $this->getCLICommandName();
319	105	$command .= $this->getCLICommandArguments();
320	105	$command .= $this->getCLISubjects();
321	105	$command .= $this->getCLIPath();
322
323	105	$command = preg_replace('/\\s{2,}/', ' ', $command);
324
325	105	return trim($command);
326		}
327
328		/**
329		* get a string of CLI-formatted command arguments
330		*
331		* @return string The command argument string
332		*/
333	106	private function getCLICommandArguments()
334		{
335	106	$command = '';
336	106	$combinedArguments = array_merge($this->globalCommandArguments, $this->commandArguments);
337	106	if (count($combinedArguments) > 0) {
338	101	$command .= ' ' . implode(' ', array_map('escapeshellarg', $combinedArguments));
339	101	}
340	106	return $command;
341		}
342
343		/**
344		* get a string of CLI-formatted command name
345		*
346		* @return string The command name string
347		*/
348	106	private function getCLICommandName()
349		{
350	106	return ' ' . $this->commandName;
351		}
352
353		/**
354		* get a string of CLI-formatted configs
355		*
356		* @return string The config string
357		*/
358	106	private function getCLIConfigs()
359		{
360	106	$command = '';
361	106	$combinedConfigs = array_merge($this->globalConfigs, $this->configs);
362	106	if (count($combinedConfigs)) {
363	4	foreach ($combinedConfigs as $config => $value) {
364	4	$command .= sprintf(
365	4	' %s %s=%s',
366	4	escapeshellarg('-c'),
367	4	escapeshellarg($config),
368	4	escapeshellarg($value)
369	4	);
370	4	}
371	4	}
372	106	return $command;
373		}
374
375		/**
376		* get a string of CLI-formatted global options
377		*
378		* @return string The global options string
379		*/
380	106	private function getCLIGlobalOptions()
381		{
382	106	$command = '';
383	106	if (count($this->globalOptions) > 0) {
384	1	foreach ($this->globalOptions as $name => $value) {
385	1	$command .= sprintf(' %s=%s', escapeshellarg($name), escapeshellarg($value));
386	1	}
387	1	}
388	106	return $command;
389		}
390
391		/**
392		* get a string of CLI-formatted path
393		*
394		* @return string The path string
395		*/
396	106	private function getCLIPath()
397		{
398	106	$command = '';
399	106	if (!is_null($this->path)) {
400	17	$command .= sprintf(' -- %s', escapeshellarg($this->path));
401	17	}
402	106	return $command;
403		}
404
405		/**
406		* get a string of CLI-formatted subjects
407		*
408		* @throws \RuntimeException
409		* @return string The subjects string
410		*/
411	106	private function getCLISubjects()
412		{
413	106	$command = '';
414	106	if (!is_null($this->commandSubject)) {
415	97	$command .= ' ';
416	97	if ($this->commandSubject instanceof SubCommandCommand) {
417	10	$command .= $this->commandSubject->getCommand();
418	10	} else {
419	96	if (is_array($this->commandSubject)) {
420		$command .= implode(' ', array_map('escapeshellarg', $this->commandSubject));
421		} else {
422	96	$command .= escapeshellarg($this->commandSubject);
423		}
424		}
425	97	}
426	106	if (!is_null($this->commandSubject2)) {
427	22	$command .= ' ';
428	22	if ($this->commandSubject2 instanceof SubCommandCommand) {
429		$command .= $this->commandSubject2->getCommand();
430		} else {
431	22	if (is_array($this->commandSubject2)) {
432		$command .= implode(' ', array_map('escapeshellarg', $this->commandSubject2));
433		} else {
434	22	$command .= escapeshellarg($this->commandSubject2);
435		}
436		}
437	22	}
438	106	return $command;
439		}
440		}
441

matteosister / GitElephant

Push — develop ( 5f7df1...9cb564 )

BaseCommand::getCLIConfigs() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like