Task::local() - Code Metrics - deployphp/deployer - Measure and Improve Code Quality continuously with Scrutinizer

Task::local() A
last analyzed 2020-10-04 00:18 UTC

↳ Parent: Task

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

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

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

use Deployer\Selector\Selector;

class Task
{
    private $name;
    private $callback;
    private $description;

    /**
     * Task source file location.
     *
     * @var string
     */
    private $sourceLocation = '';

    /**
     * Should we run this task locally?
     *
     * @var bool
     */
    private $local = false;

    /**
     * List of task names to run before.
     *
     * @var string[]
     */
    private $before = [];

    /**
     * List of task names to run after.
     *
     * @var string[]
     */
    private $after = [];

    /**
     * Make task internal and not visible in CLI.
     *
     * @var bool
     */
    private $hidden = false;

    /**
     * Run task only once on one of hosts.
     *
     * @var bool
     */
    private $once = false;

    /**
     * Shallow task will not print execution message/finish messages.
     * Useful for success messages and info printing.
     *
     * @var bool
     */
    private $shallow = false;

    /**
     * Limit parallel execution of the task.
     *
     * @var int|null
     */
    private $limit = null;

    /**
     * @var array
     */
    private $selector;

    public function __construct($name, callable $callback = null)
    {
        $this->name = $name;
        $this->callback = $callback;
        $this->selector = Selector::parse('all');
    }

    public function run(Context $context)
    {
        Context::push($context);

        try {
            call_user_func($this->callback); // call task
        } finally {
            if ($context->getConfig() !== null) {
                $context->getConfig()->set('working_path', null);
            }

            Context::pop();
        }
    }

    public function getName()
    {
        return $this->name;
    }

    public function __toString()
    {
        return $this->getName();
    }

    public function getDescription()
    {
        return $this->description;
    }

    public function desc(string $description)
    {
        $this->description = $description;
        return $this;
    }

    public function getSourceLocation(): string
    {
        return $this->sourceLocation;
    }

    public function saveSourceLocation()
    {
        if (function_exists('debug_backtrace')) {
            $trace = debug_backtrace();
            $this->sourceLocation = $trace[1]['file'];
        }
    }

    /**
     * Mark this task local.
     */
    public function local()
    {
        $this->local = true;
        return $this;
    }

    public function isLocal()
    {
        return $this->local;
    }

    /**
     * Mark this task to run only once on one of hosts.
     */
    public function once()
    {
        $this->once = true;
        return $this;
    }

    public function isOnce()
    {
        return $this->once;
    }

    /**
     * Mark task as hidden and not accessible from CLI.
     *
     * @return $this
     */
    public function hidden()
    {
        $this->hidden = true;
        return $this;
    }

    public function isHidden()
    {
        return $this->hidden;
    }

    public function addBefore(string $task)
    {
        array_unshift($this->before, $task);
        return $this;
    }

    public function addAfter(string $task)
    {
        array_push($this->after, $task);
        return $this;
    }

    public function getBefore()
    {
        return $this->before;
    }

    public function getAfter()
    {
        return $this->after;
    }

    /**
     * Sets task as shallow. Shallow task will not print execution message/finish messages.
     */
    public function shallow()
    {
        $this->shallow = true;
        return $this;
    }

    public function isShallow()
    {
        return $this->shallow;
    }

    /**
     * @return int|null
     */
    public function getLimit(): ?int
    {
        return $this->limit;
    }

    /**
     * @param int|null $limit
     * @return Task
     */
    public function limit(?int $limit)
    {
        $this->limit = $limit;
        return $this;
    }

    /**
     * @param string $selector
     * @return Task
     */
    public function select(string $selector)
    {
        $this->selector = Selector::parse($selector);
        return $this;
    }

    /**
     * @return array
     */
    public function getSelector(): ?array
    {
        return $this->selector;
    }

    public function addSelector(?array $newSelector)
    {
        if ($newSelector !== null) {

            if ($this->selector === null) {
                $this->selector = $newSelector;
            } else {
                $this->selector = array_merge($this->selector, $newSelector);
            }
        }
    }
}


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\Task;
9
10		use Deployer\Selector\Selector;
11
12		class Task
13		{
14		private $name;
15		private $callback;
16		private $description;
17
18		/**
19		* Task source file location.
20		*
21		* @var string
22		*/
23		private $sourceLocation = '';
24
25		/**
26		* Should we run this task locally?
27		*
28		* @var bool
29		*/
30		private $local = false;
31
32		/**
33		* List of task names to run before.
34		*
35		* @var string[]
36		*/
37		private $before = [];
38
39		/**
40		* List of task names to run after.
41		*
42		* @var string[]
43		*/
44		private $after = [];
45
46		/**
47		* Make task internal and not visible in CLI.
48		*
49		* @var bool
50		*/
51		private $hidden = false;
52
53		/**
54		* Run task only once on one of hosts.
55		*
56		* @var bool
57		*/
58		private $once = false;
59
60		/**
61		* Shallow task will not print execution message/finish messages.
62		* Useful for success messages and info printing.
63		*
64		* @var bool
65		*/
66		private $shallow = false;
67
68		/**
69		* Limit parallel execution of the task.
70		*
71		* @var int\|null
72		*/
73		private $limit = null;
74
75		/**
76		* @var array
77		*/
78		private $selector;
79
80	19	public function __construct($name, callable $callback = null)
81		{
82	19	$this->name = $name;
83	19	$this->callback = $callback;
84	19	$this->selector = Selector::parse('all');
85	19	}
86
87	10	public function run(Context $context)
88		{
89	10	Context::push($context);
90
91		try {
92	10	call_user_func($this->callback); // call task
93	10	} finally {
94	10	if ($context->getConfig() !== null) {
95	8	$context->getConfig()->set('working_path', null);
96		}
97
98	10	Context::pop();
99		}
100	10	}
101
102	16	public function getName()
103		{
104	16	return $this->name;
105		}
106
107	5	public function __toString()
108		{
109	5	return $this->getName();
110		}
111
112	13	public function getDescription()
113		{
114	13	return $this->description;
115		}
116
117	9	public function desc(string $description)
118		{
119	9	$this->description = $description;
120	9	return $this;
121		}
122
123	8	public function getSourceLocation(): string
124		{
125	8	return $this->sourceLocation;
126		}
127
128	15	public function saveSourceLocation()
129		{
130	15	if (function_exists('debug_backtrace')) {
131	15	$trace = debug_backtrace();
132	15	$this->sourceLocation = $trace[1]['file'];
133		}
134	15	}
135
136		/**
137		* Mark this task local.
138		*/
139	1	public function local()
140		{
141	1	$this->local = true;
142	1	return $this;
143		}
144
145	13	public function isLocal()
146		{
147	13	return $this->local;
148		}
149
150		/**
151		* Mark this task to run only once on one of hosts.
152		*/
153	9	public function once()
154		{
155	9	$this->once = true;
156	9	return $this;
157		}
158
159	13	public function isOnce()
160		{
161	13	return $this->once;
162		}
163
164		/**
165		* Mark task as hidden and not accessible from CLI.
166		*
167		* @return $this
168		*/
169	9	public function hidden()
170		{
171	9	$this->hidden = true;
172	9	return $this;
173		}
174
175	13	public function isHidden()
176		{
177	13	return $this->hidden;
178		}
179
180	2	public function addBefore(string $task)
181		{
182	2	array_unshift($this->before, $task);
183	2	return $this;
184		}
185
186	13	public function addAfter(string $task)
187		{
188	13	array_push($this->after, $task);
189	13	return $this;
190		}
191
192	15	public function getBefore()
193		{
194	15	return $this->before;
195		}
196
197	15	public function getAfter()
198		{
199	15	return $this->after;
200		}
201
202		/**
203		* Sets task as shallow. Shallow task will not print execution message/finish messages.
204		*/
205	8	public function shallow()
206		{
207	8	$this->shallow = true;
208	8	return $this;
209		}
210
211	12	public function isShallow()
212		{
213	12	return $this->shallow;
214		}
215
216		/**
217		* @return int\|null
218		*/
219	12	public function getLimit(): ?int
220		{
221	12	return $this->limit;
222		}
223
224		/**
225		* @param int\|null $limit
226		* @return Task
227		*/
228		public function limit(?int $limit)
229		{
230		$this->limit = $limit;
231		return $this;
232		}
233
234		/**
235		* @param string $selector
236		* @return Task
237		*/
238		public function select(string $selector)
239		{
240		$this->selector = Selector::parse($selector);
241		return $this;
242		}
243
244		/**
245		* @return array
246		*/
247	13	public function getSelector(): ?array
248		{
249	13	return $this->selector;
250		}
251
252	5	public function addSelector(?array $newSelector)
253		{
254	5	if ($newSelector !== null) {
		0 ignored issues – show introduced 2020-09-29 21:09 UTC by Report Bug Copy Issue Report The condition `$newSelector !== null` is always `true`. Loading history...
255	5	if ($this->selector === null) {
256		$this->selector = $newSelector;
257		} else {
258	5	$this->selector = array_merge($this->selector, $newSelector);
259		}
260		}
261	5	}
262		}
263

deployphp / deployer

GitHub Access Token became invalid

Task::local() A last analyzed 2020-10-04 00:18 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Task::local() A
last analyzed 2020-10-04 00:18 UTC