Deployer::getDefault() - Code Metrics - Inspection of "Feature: add function." - deployphp/deployer - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 15ad93...82a2dc )

by Anton

created 2016-11-07 05:47 UTC

Deployer::getDefault() A

↳ Parent: Deployer

Complexity

Conditions	2
Paths	2

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	1
CRAP Score	2

Importance

Changes

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

<?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\Console\InitCommand;
use Deployer\Console\WorkerCommand;
use Deployer\Console\Application;
use Deployer\Server;
use Deployer\Stage\StageStrategy;
use Deployer\Task;
use Deployer\Console\TaskCommand;
use Deployer\Type\DotArray;
use Monolog\Handler\StreamHandler;
use Monolog\Logger;
use Pimple\Container;
use Symfony\Component\Console;
use Symfony\Component\EventDispatcher\EventDispatcher;

/**
 * @property Task\TaskCollection|Task\Task[] tasks
 * @property Task\Scenario\ScenarioCollection|Task\Scenario\Scenario[] scenarios
 * @property Server\ServerCollection|Server\ServerInterface[] servers
 * @property Server\EnvironmentCollection|Server\Environment[] environments
 * @property DotArray config
 */
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
     * @param Console\Input\InputInterface $input
     * @param Console\Output\OutputInterface $output
     */
    public function __construct(Application $console, Console\Input\InputInterface $input, Console\Output\OutputInterface $output)
    {
        parent::__construct();

        /******************************
         *         Dispatcher         *
         ******************************/

        $this['dispatcher'] = function () {
            return new EventDispatcher();
        };


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

        $this['console'] = function () use ($console) {
            return $console;
        };
        $this['input'] = function () use ($input) {
            return $input;
        };
        $this['output'] = function () use ($output) {
            return $output;
        };

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

        $this['config'] = function () {
            return new DotArray();
        };
        $this->config['ssh_type'] = 'phpseclib';
        $this->config['default_stage'] = null;


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

        $this['tasks'] = function () {
            return new Task\TaskCollection();
        };
        $this['scenarios'] = function () {
            return new Task\Scenario\ScenarioCollection();
        };
        $this['servers'] = function () {
            return new Server\ServerCollection();
        };
        $this['environments'] = function () {
            return new Server\EnvironmentCollection();
        };
        $this['stageStrategy'] = function ($c) {
            return new StageStrategy($c['servers'], $c['environments'], $c['config']['default_stage']);
        };

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

        $this['log_level'] = function ($c) {
            $parameters = $c['parameters'];
            return isset($parameters['log_level']) ? $parameters['log_level'] : Logger::ERROR;
        };
        $this['log_handler'] = function ($c) {
            $parameters = $c['parameters'];
            return new StreamHandler($parameters['log_file'], $parameters['log_level']);
        };
        $this['log'] = function ($c) {
            $parameters = $c['parameters'];
            $name = isset($parameters['log_name']) ? $parameters['log_name'] : 'Deployer';
            return new Logger($name);
        };

        self::$instance = $this;
        $this->getDispatcher()->dispatch('init');
    }

    /**
     * @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($config, $array));
        } else {
            self::setDefault($name, $array);
        }
    }

    /**
     * Run console application.
     */
    public function run()
    {
        $this->addConsoleCommands();

        $this->getConsole()->add(new WorkerCommand($this));
        $this->getConsole()->add(new InitCommand());

        $this->getConsole()->run($this->input, $this->output);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    /**
     * 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 EventDispatcher
     */
    public function getDispatcher()
    {
        return $this['dispatcher'];
    }

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

    /**
     * @return StageStrategy
     */
    public function getStageStrategy()
    {
        return $this['stageStrategy'];
    }
}


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\Console\InitCommand;
11		use Deployer\Console\WorkerCommand;
12		use Deployer\Console\Application;
13		use Deployer\Server;
14		use Deployer\Stage\StageStrategy;
15		use Deployer\Task;
16		use Deployer\Console\TaskCommand;
17		use Deployer\Type\DotArray;
18		use Monolog\Handler\StreamHandler;
19		use Monolog\Logger;
20		use Pimple\Container;
21		use Symfony\Component\Console;
22		use Symfony\Component\EventDispatcher\EventDispatcher;
23
24		/**
25		* @property Task\TaskCollection\|Task\Task[] tasks
26		* @property Task\Scenario\ScenarioCollection\|Task\Scenario\Scenario[] scenarios
27		* @property Server\ServerCollection\|Server\ServerInterface[] servers
28		* @property Server\EnvironmentCollection\|Server\Environment[] environments
29		* @property DotArray config
30		*/
31		class Deployer extends Container
32		{
33		/**
34		* Global instance of deployer. It's can be accessed only after constructor call.
35		* @var Deployer
36		*/
37		private static $instance;
38
39		/**
40		* @param Application $console
41		* @param Console\Input\InputInterface $input
42		* @param Console\Output\OutputInterface $output
43		*/
44		public function __construct(Application $console, Console\Input\InputInterface $input, Console\Output\OutputInterface $output)
45		{
46		parent::__construct();
47
48		/******************************
49		* Dispatcher *
50		******************************/
51
52		$this['dispatcher'] = function () {
53		return new EventDispatcher();
54		};
55
56
57		/******************************
58		* Console *
59		******************************/
60
61		$this['console'] = function () use ($console) {
62		return $console;
63		};
64		$this['input'] = function () use ($input) {
65	35	return $input;
66		};
67	35	$this['output'] = function () use ($output) {
68	35	return $output;
69	35	};
70
71	35	/******************************
72	35	* Config *
73	35	******************************/
74	35
75	35	$this['config'] = function () {
76	35	return new DotArray();
77		};
78	35	$this->config['ssh_type'] = 'phpseclib';
79		$this->config['default_stage'] = null;
80	35
81	35
82		/******************************
83		* Core *
84		******************************/
85
86	22	$this['tasks'] = function () {
87		return new Task\TaskCollection();
88	22	};
89		$this['scenarios'] = function () {
90		return new Task\Scenario\ScenarioCollection();
91		};
92		$this['servers'] = function () {
93		return new Server\ServerCollection();
94		};
95		$this['environments'] = function () {
96		return new Server\EnvironmentCollection();
97		};
98		$this['stageStrategy'] = function ($c) {
99		return new StageStrategy($c['servers'], $c['environments'], $c['config']['default_stage']);
100		};
101
102		/******************************
103		* Logger *
104		******************************/
105
106		$this['log_level'] = function ($c) {
107	14	$parameters = $c['parameters'];
108		return isset($parameters['log_level']) ? $parameters['log_level'] : Logger::ERROR;
109	14	};
110		$this['log_handler'] = function ($c) {
111	14	$parameters = $c['parameters'];
112	14	return new StreamHandler($parameters['log_file'], $parameters['log_level']);
113	14	};
114		$this['log'] = function ($c) {
115		$parameters = $c['parameters'];
116	14	$name = isset($parameters['log_name']) ? $parameters['log_name'] : 'Deployer';
117	14	return new Logger($name);
118	14	};
119
120		self::$instance = $this;
121		$this->getDispatcher()->dispatch('init');
122		}
123
124		/**
125		* @return Deployer
126		*/
127		public static function get()
128		{
129		return self::$instance;
130		}
131
132		/**
133		* @param string $name
134		* @param mixed $value
135		*/
136		public static function setDefault($name, $value)
137		{
138		Deployer::get()->config[$name] = $value;
139		}
140
141	35	/**
142		* @param string $name
143	35	* @param mixed $default
144	35	* @return mixed
145		*/
146	1	public static function getDefault($name, $default = null)
147		{
148		return self::hasDefault($name) ? Deployer::get()->config[$name] : $default;
149		}
150
151		/**
152		* @param string $name
153		* @return boolean
154		*/
155		public static function hasDefault($name)
156		{
157		return isset(Deployer::get()->config[$name]);
158		}
159
160		/**
161		* @param string $name
162	14	* @param array $array
163		*/
164	14	public static function addDefault($name, $array)
165		{
166		if (self::hasDefault($name)) {
167		$config = self::getDefault($name);
168		if (!is_array($config)) {
169		throw new \RuntimeException("Configuration parameter `$name` isn't array.");
170	15	}
171		self::setDefault($name, array_merge($config, $array));
172	15	} else {
173		self::setDefault($name, $array);
174		}
175		}
176
177		/**
178		* Run console application.
179		*/
180		public function run()
181		{
182		$this->addConsoleCommands();
183
184		$this->getConsole()->add(new WorkerCommand($this));
185		$this->getConsole()->add(new InitCommand());
186
187		$this->getConsole()->run($this->input, $this->output);
		0 ignored issues – show Documentation introduced 2016-10-21 14:31 UTC by Report Bug Copy Issue Report The property `input` does not exist on `object<Deployer\Deployer>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text / class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history... Documentation introduced 2016-10-21 14:31 UTC by Report Bug Copy Issue Report The property `output` does not exist on `object<Deployer\Deployer>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /* * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
188		}
189
190		/**
191		* Transform tasks to console commands.
192		*/
193		public function addConsoleCommands()
194		{
195		$this->getConsole()->addUserArgumentsAndOptions();
196
197		foreach ($this->tasks as $name => $task) {
198		if ($task->isPrivate()) {
199		continue;
200		}
201
202		$this->getConsole()->add(new TaskCommand($name, $task->getDescription(), $this));
203		}
204		}
205
206		/**
207		* @param string $name
208		* @return mixed
209		* @throws \InvalidArgumentException
210		*/
211		public function __get($name)
212		{
213		if (isset($this[$name])) {
214		return $this[$name];
215		} else {
216		throw new \InvalidArgumentException("Property \"$name\" does not exist.");
217		}
218		}
219
220		/**
221		* @return EventDispatcher
222		*/
223		public function getDispatcher()
224		{
225		return $this['dispatcher'];
226		}
227
228		/**
229		* @return Application
230		*/
231		public function getConsole()
232		{
233		return $this['console'];
234		}
235
236		/**
237		* @return Console\Input\InputInterface
238		*/
239		public function getInput()
240		{
241		return $this['input'];
242		}
243
244		/**
245		* @return Console\Output\OutputInterface
246		*/
247		public function getOutput()
248		{
249		return $this['output'];
250		}
251
252		/**
253		* @param string $name
254		* @return Console\Helper\HelperInterface
255		*/
256		public function getHelper($name)
257		{
258		return $this->getConsole()->getHelperSet()->get($name);
259		}
260
261		/**
262		* @return StageStrategy
263		*/
264		public function getStageStrategy()
265		{
266		return $this['stageStrategy'];
267		}
268		}
269

deployphp / deployer

GitHub Access Token became invalid

Push — master ( 15ad93...82a2dc )

Deployer::getDefault() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like