Deployer::__construct() - Code Metrics - Inspection of "create objects only when necessary (#1528)" - deployphp/deployer - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 971843...0fc630 )

by Anton

created 2018-01-30 13:08 UTC

Deployer::__construct() B

↳ Parent: Deployer

Complexity

Conditions	4
Paths	1

Size

Total Lines	95
Code Lines	48

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	43
CRAP Score	4.0293

Importance

Changes

Metric	Value
cc	4
eloc	48
nc	1
nop	1
dl	0
loc	95
ccs	43
cts	49
cp	0.8776
crap	4.0293
rs	8.2763
c	0
b	0
f	0

How to fix Long Method

<?php
/* (c) Anton Medvedev <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Deployer;

use Deployer\Collection\Collection;
use Deployer\Console\Application;
use Deployer\Console\AutocompleteCommand;
use Deployer\Console\CommandEvent;
use Deployer\Console\InitCommand;
use Deployer\Console\Output\Informer;
use Deployer\Console\Output\OutputWatcher;
use Deployer\Console\RunCommand;
use Deployer\Console\SshCommand;
use Deployer\Console\TaskCommand;
use Deployer\Console\WorkerCommand;
use Deployer\Executor\ParallelExecutor;
use Deployer\Executor\SeriesExecutor;
use Deployer\Logger\Handler\FileHandler;
use Deployer\Logger\Handler\NullHandler;
use Deployer\Logger\Logger;
use Deployer\Task;
use Deployer\Utility\ProcessOutputPrinter;
use Deployer\Utility\ProcessRunner;
use Deployer\Utility\Reporter;
use Deployer\Utility\Rsync;
use Pimple\Container;
use Symfony\Component\Console;
use Symfony\Component\Console\Input\ArgvInput;
use Symfony\Component\Console\Output\ConsoleOutput;
use Symfony\Component\Console\Style\SymfonyStyle;
use function Deployer\Support\array_merge_alternate;

/**
 * Deployer class represents DI container for configuring
 *
 * @property Application console
 * @property Task\TaskCollection|Task\Task[] tasks
 * @property Host\HostCollection|Collection|Host\Host[] hosts
 * @property Collection config
 * @property Rsync rsync
 * @property Ssh\Client sshClient
 * @property ProcessRunner processRunner
 * @property Task\ScriptManager scriptManager
 * @property Host\HostSelector hostSelector
 * @property SeriesExecutor seriesExecutor
 * @property ParallelExecutor parallelExecutor
 * @property Informer informer
 * @property Logger logger
 * @property ProcessOutputPrinter pop
 * @property Collection fail
 */
class Deployer extends Container
{
    /**
     * Global instance of deployer. It's can be accessed only after constructor call.
     * @var Deployer
     */
    private static $instance;

    /**
     * @param Application $console
     */
    public function __construct(Application $console)
    {
        parent::__construct();

        /******************************
         *           Console          *
         ******************************/

        $this['console'] = function () use ($console) {
            $console->catchIO(function ($input, $output) {
                $this['input'] = $input;
                $this['output'] =  new OutputWatcher($output);
                return [$this['input'], $this['output']];
            });
            return $console;
        };

        /******************************
         *           Config           *
         ******************************/

        $this['config'] = function () {
            return new Collection();
        };
        $this->config['ssh_multiplexing'] = true;
        $this->config['default_stage'] = null;

        /******************************
         *            Core            *
         ******************************/

        $this['pop'] = function ($c) {
            return new ProcessOutputPrinter($c['output'], $c['logger']);
        };
        $this['sshClient'] = function ($c) {
            return new Ssh\Client($c['output'], $c['pop'], $c['config']['ssh_multiplexing']);
        };
        $this['rsync'] = function ($c) {
            return new Rsync($c['pop']);
        };
        $this['processRunner'] = function ($c) {
            return new ProcessRunner($c['pop']);
        };
        $this['tasks'] = function () {
            return new Task\TaskCollection();
        };
        $this['hosts'] = function () {
            return new Host\HostCollection();
        };
        $this['scriptManager'] = function ($c) {
            return new Task\ScriptManager($c['tasks']);
        };
        $this['hostSelector'] = function ($c) {
            $defaultStage = $c['config']['default_stage'];
            if (is_object($defaultStage) && ($defaultStage instanceof \Closure)) {
                $defaultStage = call_user_func($defaultStage);
            }
            return new Host\HostSelector($c['hosts'], $defaultStage);
        };
        $this['fail'] = function () {
            return new Collection();
        };
        $this['informer'] = function ($c) {
            return new Informer($c['output']);
        };
        $this['seriesExecutor'] = function ($c) {
            return new SeriesExecutor($c['input'], $c['output'], $c['informer']);
        };
        $this['parallelExecutor'] = function ($c) {
            return new ParallelExecutor($c['input'], $c['output'], $c['informer'], $c['console']);
        };

        /******************************
         *           Logger           *
         ******************************/

        $this['log_handler'] = function () {
            return !empty($this->config['log_file'])
                ? new FileHandler($this->config['log_file'])
                : new NullHandler();
        };
        $this['logger'] = function () {
            return new Logger($this['log_handler']);
        };

        /******************************
         *        Init command        *
         ******************************/

        $this['init_command'] = function () {
            return new InitCommand();
        };

        self::$instance = $this;
    }

    /**
     * @return Deployer
     */
    public static function get()
    {
        return self::$instance;
    }

    /**
     * @param string $name
     * @param mixed $value
     */
    public static function setDefault($name, $value)
    {
        Deployer::get()->config[$name] = $value;
    }

    /**
     * @param string $name
     * @param mixed $default
     * @return mixed
     */
    public static function getDefault($name, $default = null)
    {
        return self::hasDefault($name) ? Deployer::get()->config[$name] : $default;
    }

    /**
     * @param string $name
     * @return boolean
     */
    public static function hasDefault($name)
    {
        return isset(Deployer::get()->config[$name]);
    }

    /**
     * @param string $name
     * @param array $array
     */
    public static function addDefault($name, $array)
    {
        if (self::hasDefault($name)) {
            $config = self::getDefault($name);
            if (!is_array($config)) {
                throw new \RuntimeException("Configuration parameter `$name` isn't array.");
            }
            self::setDefault($name, array_merge_alternate($config, $array));
        } else {
            self::setDefault($name, $array);
        }
    }

    /**
     * Init console application
     */
    public function init()
    {
        $this->addConsoleCommands();
        $this->getConsole()->add(new WorkerCommand($this));
        $this->getConsole()->add($this['init_command']);
        $this->getConsole()->add(new SshCommand($this));
        $this->getConsole()->add(new RunCommand($this));
        $this->getConsole()->add(new AutocompleteCommand());
        $this->getConsole()->afterRun([$this, 'collectAnonymousStats']);
    }

    /**
     * Transform tasks to console commands.
     */
    public function addConsoleCommands()
    {
        $this->getConsole()->addUserArgumentsAndOptions();

        foreach ($this->tasks as $name => $task) {
            if ($task->isPrivate()) {
                continue;
            }

            $this->getConsole()->add(new TaskCommand($name, $task->getDescription(), $this));
        }
    }

    /**
     * @param string $name
     * @return mixed
     * @throws \InvalidArgumentException
     */
    public function __get($name)
    {
        if (isset($this[$name])) {
            return $this[$name];
        } else {
            throw new \InvalidArgumentException("Property \"$name\" does not exist.");
        }
    }

    /**
     * @return Application
     */
    public function getConsole()
    {
        return $this['console'];
    }

    /**
     * @return Console\Input\InputInterface
     */
    public function getInput()
    {
        return $this['input'];
    }

    /**
     * @return Console\Output\OutputInterface
     */
    public function getOutput()
    {
        return $this['output'];
    }

    /**
     * @param string $name
     * @return Console\Helper\HelperInterface
     */
    public function getHelper($name)
    {
        return $this->getConsole()->getHelperSet()->get($name);
    }

    /**
     * Run Deployer
     *
     * @param string $version
     * @param string $deployFile
     */
    public static function run($version, $deployFile)
    {
        // Init Deployer
        $console = new Application('Deployer', $version);
        $input = new ArgvInput();
        $output = new ConsoleOutput();
        $deployer = new self($console);

        // Pretty-print uncaught exceptions in symfony-console
        set_exception_handler(function ($e) use ($input, $output, $deployer) {
            $io = new SymfonyStyle($input, $output);
            $io->block($e->getMessage(), get_class($e), 'fg=white;bg=red', ' ', true);
            $io->block($e->getTraceAsString());

            $deployer->logger->log('['. get_class($e) .'] '. $e->getMessage());
            $deployer->logger->log($e->getTraceAsString());
            exit(1);
        });

        // Require deploy.php file
        if (is_readable($deployFile)) {
            // Prevent variable leak into deploy.php file
            call_user_func(function () use ($deployFile) {
                require $deployFile;
            });
        }

        // Run Deployer
        $deployer->init();
        $console->run($input, $output);
    }

    /**
     * Collect anonymous stats about Deployer usage for improving developer experience.
     * If you are not comfortable with this, you will always be able to disable this
     * by setting `allow_anonymous_stats` to false in your deploy.php file.
     *
     * @param CommandEvent $commandEvent
     * @codeCoverageIgnore
     */
    public function collectAnonymousStats(CommandEvent $commandEvent)
    {
        if ($this->config->has('allow_anonymous_stats') && $this->config['allow_anonymous_stats'] === false) {
            return;
        }

        $stats = [
            'status' => 'success',
            'command_name' => $commandEvent->getCommand()->getName(),
            'project_hash' => empty($this->config['repository']) ? null : sha1($this->config['repository']),
            'hosts_count' => $this->hosts->count(),
            'deployer_version' => $this->getConsole()->getVersion(),
            'deployer_phar' => $this->getConsole()->isPharArchive(),
            'php_version' => phpversion(),
            'extension_pcntl' => extension_loaded('pcntl'),
            'extension_curl' => extension_loaded('curl'),
            'os' => defined('PHP_OS_FAMILY') ? PHP_OS_FAMILY : (stristr(PHP_OS, 'DAR') ? 'OSX' : (stristr(PHP_OS, 'WIN') ? 'WIN' : (stristr(PHP_OS, 'LINUX') ? 'LINUX' : PHP_OS))),
            'exception' => null,
        ];

        if ($commandEvent->getException() !== null) {
            $stats['status'] = 'error';
            $stats['exception'] = get_class($commandEvent->getException());
        }

        if ($stats['command_name'] === 'init') {
            $stats['allow_anonymous_stats'] = $GLOBALS['allow_anonymous_stats'] ?? false;
        }

        if (in_array($stats['command_name'], ['worker', 'list', 'help'], true)) {
            return;
        }

        Reporter::report($stats);
    }
}


1		<?php
2		/* (c) Anton Medvedev <[email protected]>
3		*
4		* For the full copyright and license information, please view the LICENSE
5		* file that was distributed with this source code.
6		*/
7
8		namespace Deployer;
9
10		use Deployer\Collection\Collection;
11		use Deployer\Console\Application;
12		use Deployer\Console\AutocompleteCommand;
13		use Deployer\Console\CommandEvent;
14		use Deployer\Console\InitCommand;
15		use Deployer\Console\Output\Informer;
16		use Deployer\Console\Output\OutputWatcher;
17		use Deployer\Console\RunCommand;
18		use Deployer\Console\SshCommand;
19		use Deployer\Console\TaskCommand;
20		use Deployer\Console\WorkerCommand;
21		use Deployer\Executor\ParallelExecutor;
22		use Deployer\Executor\SeriesExecutor;
23		use Deployer\Logger\Handler\FileHandler;
24		use Deployer\Logger\Handler\NullHandler;
25		use Deployer\Logger\Logger;
26		use Deployer\Task;
27		use Deployer\Utility\ProcessOutputPrinter;
28		use Deployer\Utility\ProcessRunner;
29		use Deployer\Utility\Reporter;
30		use Deployer\Utility\Rsync;
31		use Pimple\Container;
32		use Symfony\Component\Console;
33		use Symfony\Component\Console\Input\ArgvInput;
34		use Symfony\Component\Console\Output\ConsoleOutput;
35		use Symfony\Component\Console\Style\SymfonyStyle;
36		use function Deployer\Support\array_merge_alternate;
37
38		/**
39		* Deployer class represents DI container for configuring
40		*
41		* @property Application console
42		* @property Task\TaskCollection\|Task\Task[] tasks
43		* @property Host\HostCollection\|Collection\|Host\Host[] hosts
44		* @property Collection config
45		* @property Rsync rsync
46		* @property Ssh\Client sshClient
47		* @property ProcessRunner processRunner
48		* @property Task\ScriptManager scriptManager
49		* @property Host\HostSelector hostSelector
50		* @property SeriesExecutor seriesExecutor
51		* @property ParallelExecutor parallelExecutor
52		* @property Informer informer
53		* @property Logger logger
54		* @property ProcessOutputPrinter pop
55		* @property Collection fail
56		*/
57		class Deployer extends Container
58		{
59		/**
60		* Global instance of deployer. It's can be accessed only after constructor call.
61		* @var Deployer
62		*/
63		private static $instance;
64
65		/**
66		* @param Application $console
67		*/
68	29	public function __construct(Application $console)
69		{
70	29	parent::__construct();
71
72		/******************************
73		* Console *
74		******************************/
75
76		$this['console'] = function () use ($console) {
77	14	$console->catchIO(function ($input, $output) {
78	14	$this['input'] = $input;
79	14	$this['output'] = new OutputWatcher($output);
80	14	return [$this['input'], $this['output']];
81	14	});
82	14	return $console;
83		};
84
85		/******************************
86		* Config *
87		******************************/
88
89	29	$this['config'] = function () {
90	29	return new Collection();
91		};
92	29	$this->config['ssh_multiplexing'] = true;
93	29	$this->config['default_stage'] = null;
94
95		/******************************
96		* Core *
97		******************************/
98
99	10	$this['pop'] = function ($c) {
100	10	return new ProcessOutputPrinter($c['output'], $c['logger']);
101		};
102		$this['sshClient'] = function ($c) {
103		return new Ssh\Client($c['output'], $c['pop'], $c['config']['ssh_multiplexing']);
104		};
105		$this['rsync'] = function ($c) {
106		return new Rsync($c['pop']);
107		};
108	10	$this['processRunner'] = function ($c) {
109	10	return new ProcessRunner($c['pop']);
110		};
111	18	$this['tasks'] = function () {
112	18	return new Task\TaskCollection();
113		};
114	18	$this['hosts'] = function () {
115	18	return new Host\HostCollection();
116		};
117	16	$this['scriptManager'] = function ($c) {
118	16	return new Task\ScriptManager($c['tasks']);
119		};
120	14	$this['hostSelector'] = function ($c) {
121	14	$defaultStage = $c['config']['default_stage'];
122	14	if (is_object($defaultStage) && ($defaultStage instanceof \Closure)) {
123		$defaultStage = call_user_func($defaultStage);
124		}
125	14	return new Host\HostSelector($c['hosts'], $defaultStage);
126		};
127	9	$this['fail'] = function () {
128	9	return new Collection();
129		};
130	14	$this['informer'] = function ($c) {
131	14	return new Informer($c['output']);
132		};
133	11	$this['seriesExecutor'] = function ($c) {
134	11	return new SeriesExecutor($c['input'], $c['output'], $c['informer']);
135		};
136	3	$this['parallelExecutor'] = function ($c) {
137	3	return new ParallelExecutor($c['input'], $c['output'], $c['informer'], $c['console']);
138		};
139
140		/******************************
141		* Logger *
142		******************************/
143
144	11	$this['log_handler'] = function () {
145	11	return !empty($this->config['log_file'])
146		? new FileHandler($this->config['log_file'])
147	11	: new NullHandler();
148		};
149	11	$this['logger'] = function () {
150	11	return new Logger($this['log_handler']);
151		};
152
153		/******************************
154		* Init command *
155		******************************/
156
157	14	$this['init_command'] = function () {
158	14	return new InitCommand();
159		};
160
161	29	self::$instance = $this;
162	29	}
163
164		/**
165		* @return Deployer
166		*/
167	31	public static function get()
168		{
169	31	return self::$instance;
170		}
171
172		/**
173		* @param string $name
174		* @param mixed $value
175		*/
176	13	public static function setDefault($name, $value)
177		{
178	13	Deployer::get()->config[$name] = $value;
179	13	}
180
181		/**
182		* @param string $name
183		* @param mixed $default
184		* @return mixed
185		*/
186	15	public static function getDefault($name, $default = null)
187		{
188	15	return self::hasDefault($name) ? Deployer::get()->config[$name] : $default;
189		}
190
191		/**
192		* @param string $name
193		* @return boolean
194		*/
195	15	public static function hasDefault($name)
196		{
197	15	return isset(Deployer::get()->config[$name]);
198		}
199
200		/**
201		* @param string $name
202		* @param array $array
203		*/
204	2	public static function addDefault($name, $array)
205		{
206	2	if (self::hasDefault($name)) {
207	2	$config = self::getDefault($name);
208	2	if (!is_array($config)) {
209	1	throw new \RuntimeException("Configuration parameter `$name` isn't array.");
210		}
211	1	self::setDefault($name, array_merge_alternate($config, $array));
212		} else {
213		self::setDefault($name, $array);
214		}
215	1	}
216
217		/**
218		* Init console application
219		*/
220	14	public function init()
221		{
222	14	$this->addConsoleCommands();
223	14	$this->getConsole()->add(new WorkerCommand($this));
224	14	$this->getConsole()->add($this['init_command']);
225	14	$this->getConsole()->add(new SshCommand($this));
226	14	$this->getConsole()->add(new RunCommand($this));
227	14	$this->getConsole()->add(new AutocompleteCommand());
228	14	$this->getConsole()->afterRun([$this, 'collectAnonymousStats']);
229	14	}
230
231		/**
232		* Transform tasks to console commands.
233		*/
234	14	public function addConsoleCommands()
235		{
236	14	$this->getConsole()->addUserArgumentsAndOptions();
237
238	14	foreach ($this->tasks as $name => $task) {
239	14	if ($task->isPrivate()) {
240	9	continue;
241		}
242
243	14	$this->getConsole()->add(new TaskCommand($name, $task->getDescription(), $this));
244		}
245	14	}
246
247		/**
248		* @param string $name
249		* @return mixed
250		* @throws \InvalidArgumentException
251		*/
252	34	public function __get($name)
253		{
254	34	if (isset($this[$name])) {
255	34	return $this[$name];
256		} else {
257	1	throw new \InvalidArgumentException("Property \"$name\" does not exist.");
258		}
259		}
260
261		/**
262		* @return Application
263		*/
264	14	public function getConsole()
265		{
266	14	return $this['console'];
267		}
268
269		/**
270		* @return Console\Input\InputInterface
271		*/
272		public function getInput()
273		{
274		return $this['input'];
275		}
276
277		/**
278		* @return Console\Output\OutputInterface
279		*/
280		public function getOutput()
281		{
282		return $this['output'];
283		}
284
285		/**
286		* @param string $name
287		* @return Console\Helper\HelperInterface
288		*/
289		public function getHelper($name)
290		{
291		return $this->getConsole()->getHelperSet()->get($name);
292		}
293
294		/**
295		* Run Deployer
296		*
297		* @param string $version
298		* @param string $deployFile
299		*/
300		public static function run($version, $deployFile)
301		{
302		// Init Deployer
303		$console = new Application('Deployer', $version);
304		$input = new ArgvInput();
305		$output = new ConsoleOutput();
306		$deployer = new self($console);
307
308		// Pretty-print uncaught exceptions in symfony-console
309		set_exception_handler(function ($e) use ($input, $output, $deployer) {
310		$io = new SymfonyStyle($input, $output);
311		$io->block($e->getMessage(), get_class($e), 'fg=white;bg=red', ' ', true);
312		$io->block($e->getTraceAsString());
313
314		$deployer->logger->log('['. get_class($e) .'] '. $e->getMessage());
315		$deployer->logger->log($e->getTraceAsString());
316		exit(1);
317		});
318
319		// Require deploy.php file
320		if (is_readable($deployFile)) {
321		// Prevent variable leak into deploy.php file
322		call_user_func(function () use ($deployFile) {
323		require $deployFile;
324		});
325		}
326
327		// Run Deployer
328		$deployer->init();
329		$console->run($input, $output);
330		}
331
332		/**
333		* Collect anonymous stats about Deployer usage for improving developer experience.
334		* If you are not comfortable with this, you will always be able to disable this
335		* by setting `allow_anonymous_stats` to false in your deploy.php file.
336		*
337		* @param CommandEvent $commandEvent
338		* @codeCoverageIgnore
339		*/
340		public function collectAnonymousStats(CommandEvent $commandEvent)
341		{
342		if ($this->config->has('allow_anonymous_stats') && $this->config['allow_anonymous_stats'] === false) {
343		return;
344		}
345
346		$stats = [
347		'status' => 'success',
348		'command_name' => $commandEvent->getCommand()->getName(),
349		'project_hash' => empty($this->config['repository']) ? null : sha1($this->config['repository']),
350		'hosts_count' => $this->hosts->count(),
351		'deployer_version' => $this->getConsole()->getVersion(),
352		'deployer_phar' => $this->getConsole()->isPharArchive(),
353		'php_version' => phpversion(),
354		'extension_pcntl' => extension_loaded('pcntl'),
355		'extension_curl' => extension_loaded('curl'),
356		'os' => defined('PHP_OS_FAMILY') ? PHP_OS_FAMILY : (stristr(PHP_OS, 'DAR') ? 'OSX' : (stristr(PHP_OS, 'WIN') ? 'WIN' : (stristr(PHP_OS, 'LINUX') ? 'LINUX' : PHP_OS))),
357		'exception' => null,
358		];
359
360		if ($commandEvent->getException() !== null) {
361		$stats['status'] = 'error';
362		$stats['exception'] = get_class($commandEvent->getException());
363		}
364
365		if ($stats['command_name'] === 'init') {
366		$stats['allow_anonymous_stats'] = $GLOBALS['allow_anonymous_stats'] ?? false;
367		}
368
369		if (in_array($stats['command_name'], ['worker', 'list', 'help'], true)) {
370		return;
371		}
372
373		Reporter::report($stats);
374		}
375		}
376

deployphp / deployer

GitHub Access Token became invalid

Push — master ( 971843...0fc630 )

Deployer::__construct() B

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like