SiteProcess::setTransport() - Code Metrics - Inspection of "Require clients use the Transport manager to get a..." - consolidation/site-process - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#21)

by Greg

created 2019-01-04 02:10 UTC

SiteProcess::setTransport() A

↳ Parent: SiteProcess

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1

<?php
namespace Consolidation\SiteProcess;

use Consolidation\SiteAlias\AliasRecord;
use Consolidation\SiteProcess\Transport\DockerComposeTransport;
use Consolidation\SiteProcess\Util\ArgumentProcessor;
use Consolidation\SiteProcess\Transport\LocalTransport;
use Consolidation\SiteProcess\Transport\SshTransport;
use Consolidation\SiteProcess\Transport\TransportInterface;
use Consolidation\Config\Util\Interpolator;
use Consolidation\SiteProcess\Util\ShellOperatorInterface;
use Consolidation\SiteProcess\Util\Escape;

/**
 * A wrapper around Symfony Process that uses site aliases
 * (https://github.com/consolidation/site-alias)
 *
 * - Interpolate arguments using values from the alias
 *   e.g. `$process = new SiteProcess($alias, ['git', '-C', '{{root}}']);`
 * - Make remote calls via ssh as if they were local.
 */
class SiteProcess extends ProcessBase
{
    /** @var AliasRecord */
    protected $siteAlias;
    /** @var string[] */
    protected $args;
    /** @var string[] */
    protected $options;
    /** @var string[] */
    protected $optionsPassedAsArgs;
    /** @var string */
    protected $cd;
    /** @var TransportInterface */
    protected $transport;

    /**
     * Process arguments and options per the site alias and build the
     * actual command to run.
     */
    public function __construct(AliasRecord $siteAlias, TransportInterface $transport, $args, $options = [], $optionsPassedAsArgs = [])
    {
        $this->siteAlias = $siteAlias;
        $this->transport = $transport;
        $this->args = $args;
        $this->options = $options;
        $this->optionsPassedAsArgs = $optionsPassedAsArgs;

        parent::__construct([]);
    }

    /**
     * @inheritdoc
     */
    public function setWorkingDirectory($cwd)
    {
        $this->cd = $cwd;
        return parent::setWorkingDirectory($cwd);
    }

    public function chdirToSiteRoot($shouldUseSiteRoot = true)
    {
        if (!$shouldUseSiteRoot || !$this->siteAlias->hasRoot()) {
            return $this;
        }

        return $this->setWorkingDirectory($this->siteAlias->root());
    }

    /**
     * Take all of our individual arguments and process them for use.
     */
    protected function processArgs()
    {
        $transport = $this->getTransport($this->siteAlias);
        $transport->configure($this);

        $processor = new ArgumentProcessor();
        $selectedArgs = $processor->selectArgs(
            $this->siteAlias,
            $this->args,
            $this->options,
            $this->optionsPassedAsArgs
        );

        // Ask the transport to drop in a 'cd' if needed.
        if ($this->cd) {
            $selectedArgs = $transport->addChdir($this->cd, $selectedArgs);
        }

        // Do any necessary interpolation on the selected arguments.
        $processedArgs = $this->interpolate($selectedArgs);

        // Wrap the command with 'ssh' or some other transport if this is
        // a remote command; otherwise, leave it as-is.
        return $transport->wrap($processedArgs);
    }

    public function setTransport($transport)
    {
        $this->transport = $transport;
    }

    /**
     * Ask the transport manager for the correct transport for the
     * provided alias.
     */
    protected function getTransport(AliasRecord $siteAlias)

    {
        return $this->transport;
    }

    /**
     * @inheritDoc
     */
    public function getCommandLine()
    {
        $commandLine = parent::getCommandLine();
        if (empty($commandLine)) {
            $processedArgs = $this->processArgs();
            $commandLine = Escape::argsForSite($this->siteAlias, $processedArgs);
            $commandLine = implode(' ', $commandLine);
            $this->setCommandLine($commandLine);
        }
        return $commandLine;
    }

    /**
     * @inheritDoc
     */
    public function start(callable $callback = null)
    {
        $cmd = $this->getCommandLine();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        parent::start($callback);
    }

    /**
     * @inheritDoc
     */
    public function wait(callable $callback = null)
    {
        $return = parent::wait($callback);
        return $return;
    }

    /**
     * interpolate examines each of the arguments in the provided argument list
     * and replaces any token found therein with the value for that key as
     * pulled from the given site alias.
     *
     * Example: "git -C {{root}} status"
     *
     * The token "{{root}}" will be converted to a value via $siteAlias->get('root').
     * The result will replace the token.
     *
     * It is possible to use dot notation in the keys to access nested elements
     * within the site alias record.
     *
     * @param AliasRecord $siteAlias
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param type $args
     * @return type
     */
    protected function interpolate($args)
    {
        $interpolator = new Interpolator();
        return array_map(
            function ($arg) use ($interpolator) {
                if ($arg instanceof ShellOperatorInterface) {
                    return $arg;
                }
                return $interpolator->interpolate($this->siteAlias, $arg, false);
            },
            $args
        );
    }
}


1			<?php
2			namespace Consolidation\SiteProcess;
3
4			use Consolidation\SiteAlias\AliasRecord;
5			use Consolidation\SiteProcess\Transport\DockerComposeTransport;
6			use Consolidation\SiteProcess\Util\ArgumentProcessor;
7			use Consolidation\SiteProcess\Transport\LocalTransport;
8			use Consolidation\SiteProcess\Transport\SshTransport;
9			use Consolidation\SiteProcess\Transport\TransportInterface;
10			use Consolidation\Config\Util\Interpolator;
11			use Consolidation\SiteProcess\Util\ShellOperatorInterface;
12			use Consolidation\SiteProcess\Util\Escape;
13
14			/**
15			* A wrapper around Symfony Process that uses site aliases
16			* (https://github.com/consolidation/site-alias)
17			*
18			* - Interpolate arguments using values from the alias
19			* e.g. `$process = new SiteProcess($alias, ['git', '-C', '{{root}}']);`
20			* - Make remote calls via ssh as if they were local.
21			*/
22			class SiteProcess extends ProcessBase
23			{
24			/** @var AliasRecord */
25			protected $siteAlias;
26			/** @var string[] */
27			protected $args;
28			/** @var string[] */
29			protected $options;
30			/** @var string[] */
31			protected $optionsPassedAsArgs;
32			/** @var string */
33			protected $cd;
34			/** @var TransportInterface */
35			protected $transport;
36
37			/**
38			* Process arguments and options per the site alias and build the
39			* actual command to run.
40			*/
41			public function __construct(AliasRecord $siteAlias, TransportInterface $transport, $args, $options = [], $optionsPassedAsArgs = [])
42			{
43			$this->siteAlias = $siteAlias;
44			$this->transport = $transport;
45			$this->args = $args;
46			$this->options = $options;
47			$this->optionsPassedAsArgs = $optionsPassedAsArgs;
48
49			parent::__construct([]);
50			}
51
52			/**
53			* @inheritdoc
54			*/
55			public function setWorkingDirectory($cwd)
56			{
57			$this->cd = $cwd;
58			return parent::setWorkingDirectory($cwd);
59			}
60
61			public function chdirToSiteRoot($shouldUseSiteRoot = true)
62			{
63			if (!$shouldUseSiteRoot \|\| !$this->siteAlias->hasRoot()) {
64			return $this;
65			}
66
67			return $this->setWorkingDirectory($this->siteAlias->root());
68			}
69
70			/**
71			* Take all of our individual arguments and process them for use.
72			*/
73			protected function processArgs()
74			{
75			$transport = $this->getTransport($this->siteAlias);
76			$transport->configure($this);
77
78			$processor = new ArgumentProcessor();
79			$selectedArgs = $processor->selectArgs(
80			$this->siteAlias,
81			$this->args,
82			$this->options,
83			$this->optionsPassedAsArgs
84			);
85
86			// Ask the transport to drop in a 'cd' if needed.
87			if ($this->cd) {
88			$selectedArgs = $transport->addChdir($this->cd, $selectedArgs);
89			}
90
91			// Do any necessary interpolation on the selected arguments.
92			$processedArgs = $this->interpolate($selectedArgs);
93
94			// Wrap the command with 'ssh' or some other transport if this is
95			// a remote command; otherwise, leave it as-is.
96			return $transport->wrap($processedArgs);
97			}
98
99			public function setTransport($transport)
100			{
101			$this->transport = $transport;
102			}
103
104			/**
105			* Ask the transport manager for the correct transport for the
106			* provided alias.
107			*/
108			protected function getTransport(AliasRecord $siteAlias)
			0 ignored issues – show Unused Code introduced 2019-01-04 02:11 UTC by Report Bug Copy Issue Report The parameter `$siteAlias` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
109			{
110			return $this->transport;
111			}
112
113			/**
114			* @inheritDoc
115			*/
116			public function getCommandLine()
117			{
118			$commandLine = parent::getCommandLine();
119			if (empty($commandLine)) {
120			$processedArgs = $this->processArgs();
121			$commandLine = Escape::argsForSite($this->siteAlias, $processedArgs);
122			$commandLine = implode(' ', $commandLine);
123			$this->setCommandLine($commandLine);
124			}
125			return $commandLine;
126			}
127
128			/**
129			* @inheritDoc
130			*/
131			public function start(callable $callback = null)
132			{
133			$cmd = $this->getCommandLine();
			0 ignored issues – show Unused Code introduced 2018-10-27 17:58 UTC by Report Bug Copy Issue Report `$cmd` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
134			parent::start($callback);
135			}
136
137			/**
138			* @inheritDoc
139			*/
140			public function wait(callable $callback = null)
141			{
142			$return = parent::wait($callback);
143			return $return;
144			}
145
146			/**
147			* interpolate examines each of the arguments in the provided argument list
148			* and replaces any token found therein with the value for that key as
149			* pulled from the given site alias.
150			*
151			* Example: "git -C {{root}} status"
152			*
153			* The token "{{root}}" will be converted to a value via $siteAlias->get('root').
154			* The result will replace the token.
155			*
156			* It is possible to use dot notation in the keys to access nested elements
157			* within the site alias record.
158			*
159			* @param AliasRecord $siteAlias
			0 ignored issues – show Bug introduced 2018-10-28 01:00 UTC by Report Bug Copy Issue Report There is no parameter named `$siteAlias`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
160			* @param type $args
161			* @return type
162			*/
163			protected function interpolate($args)
164			{
165			$interpolator = new Interpolator();
166			return array_map(
167			function ($arg) use ($interpolator) {
168			if ($arg instanceof ShellOperatorInterface) {
169			return $arg;
170			}
171			return $interpolator->interpolate($this->siteAlias, $arg, false);
172			},
173			$args
174			);
175			}
176			}
177

consolidation / site-process

Pull Request — master (#21)

SiteProcess::setTransport() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like