Rsync::createCommandLine() - Code Metrics - Inspection of "Make sure ci build uses latest phpunit version" - sebastianfeldmann/phpbu - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6a1fad...afb84c )

by Sebastian

created 2017-02-03 20:58 UTC

Rsync::createCommandLine() B

↳ Parent: Rsync

Complexity

Conditions	5
Paths	5

Size

Total Lines	27
Code Lines	18

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	15
CRAP Score	5

Importance

Changes

Metric	Value
dl	0
loc	27
ccs	15
cts	15
cp	1
rs	8.439
c	0
b	0
f	0
cc	5
eloc	18
nc	5
nop	0
crap	5

<?php
namespace phpbu\App\Cli\Executable;

use phpbu\App\Cli\Executable;
use phpbu\App\Cli\Process;
use phpbu\App\Exception;
use SebastianFeldmann\Cli\CommandLine;
use SebastianFeldmann\Cli\Command\Executable as Cmd;

/**
 * Rsync executable class.
 *
 * @package    phpbu
 * @subpackage Backup
 * @author     Sebastian Feldmann <[email protected]>
 * @copyright  Sebastian Feldmann <[email protected]>
 * @license    https://opensource.org/licenses/MIT The MIT License (MIT)
 * @link       http://phpbu.de/
 * @since      Class available since Release 2.1.0
 */
class Rsync extends Abstraction implements Executable
{
    /**
     * Source
     *
     * @var \phpbu\App\Cli\Executable\Rsync\Location
     */
    private $source;

    /**
     * Target
     *
     * @var \phpbu\App\Cli\Executable\Rsync\Location
     */
    private $target;

    /**
     * Raw args
     *
     * @var string
     */
    protected $args;

    /**
     * Files to ignore, extracted from config string separated by ":"
     *
     * @var array
     */
    protected $excludes = [];

    /**
     * Remove deleted files remotely as well
     *
     * @var boolean
     */
    protected $delete;

    /**
     * Compress data.
     *
     * @var boolean
     */
    protected $compressed = false;

    /**
     * Constructor.
     *
     * @param string $path
     */
    public function __construct(string $path = '')
    {
        $this->setup('rsync', $path);
        $this->source = new Rsync\Location();
        $this->target = new Rsync\Location();
    }

    /**
     * Set custom args
     *
     * @param  string $args
     * @return \phpbu\App\Cli\Executable\Rsync
     */
    public function useArgs(string $args) : Rsync
    {
        $this->args = $args;
        return $this;
    }

    /**
     * Set source user.
     *
     * @param  string $user
     * @return \phpbu\App\Cli\Executable\Rsync
     */
    public function fromUser(string $user) : Rsync
    {
        $this->source->setUser($user);
        return $this;
    }

    /**
     * Set source host.
     *
     * @param  string $host
     * @return \phpbu\App\Cli\Executable\Rsync
     */
    public function fromHost(string $host) : Rsync
    {
        $this->source->setHost($host);
        return $this;
    }

    /**
     * Set source path.
     *
     * @param  string $path
     * @return \phpbu\App\Cli\Executable\Rsync
     */
    public function fromPath(string $path) : Rsync
    {
        $this->source->setPath($path);
        return $this;
    }

    /**
     * Use compression.
     *
     * @param  bool $bool
     * @return \phpbu\App\Cli\Executable\Rsync
     */
    public function compressed(bool $bool) : Rsync
    {
        $this->compressed = $bool;
        return $this;
    }

    /**
     * Sync to host.
     *
     * @param  string $host
     * @return \phpbu\App\Cli\Executable\Rsync
     */
    public function toHost(string $host) : Rsync
    {
        $this->target->setHost($host);
        return $this;
    }

    /**
     * Set path to sync to.
     *
     * @param  string $path
     * @return \phpbu\App\Cli\Executable\Rsync
     */
    public function toPath(string $path) : Rsync
    {
        $this->target->setPath($path);
        return $this;
    }

    /**
     * Set user to connect as.
     *
     * @param  string $user
     * @return \phpbu\App\Cli\Executable\Rsync
     */
    public function toUser(string $user) : Rsync
    {
        $this->target->setUser($user);
        return $this;
    }

    /**
     * Exclude files.
     *
     * @param  array $excludes
     * @return \phpbu\App\Cli\Executable\Rsync
     */
    public function exclude(array $excludes) : Rsync
    {
        $this->excludes = $excludes;
        return $this;
    }

    /**
     * Use --delete option.
     *
     * @param  bool $bool
     * @return \phpbu\App\Cli\Executable\Rsync
     */
    public function removeDeleted(bool $bool) : Rsync
    {
        $this->delete = $bool;
        return $this;
    }

    /**
     * Rsync CommandLine generator.
     *
     * @return \SebastianFeldmann\Cli\CommandLine
     * @throws \phpbu\App\Exception
     */
    protected function createCommandLine() : CommandLine
    {
        $process = new CommandLine();
        $cmd     = new Cmd($this->binary);
        $process->addCommand($cmd);

        if (!empty($this->args)) {
            $cmd->addOption($this->args);
        } else {
            if (!$this->source->isValid()) {
                throw new Exception('source path is missing');
            }
            if (!$this->target->isValid()) {
                throw new Exception('target path is missing');
            }

            // use archive mode, verbose and compress if not already done
            $options = '-av' . ($this->compressed ? 'z' : '');
            $cmd->addOption($options);
            $this->configureExcludes($cmd, $this->excludes);
            $cmd->addOptionIfNotEmpty('--delete', $this->delete, false);
            $cmd->addArgument($this->source->toString());
            $cmd->addArgument($this->target->toString());
        }

        return $process;
    }

    /**
     * Configure excludes.
     *
     * @param \SebastianFeldmann\Cli\Command\Executable $cmd
     * @param array                                     $excludes
     */
    protected function configureExcludes(Cmd $cmd, array $excludes)
    {
        foreach ($excludes as $ex) {
            $cmd->addOption('--exclude', $ex);
        }
    }
}


1		<?php
2		namespace phpbu\App\Cli\Executable;
3
4		use phpbu\App\Cli\Executable;
5		use phpbu\App\Cli\Process;
6		use phpbu\App\Exception;
7		use SebastianFeldmann\Cli\CommandLine;
8		use SebastianFeldmann\Cli\Command\Executable as Cmd;
9
10		/**
11		* Rsync executable class.
12		*
13		* @package phpbu
14		* @subpackage Backup
15		* @author Sebastian Feldmann <[email protected]>
16		* @copyright Sebastian Feldmann <[email protected]>
17		* @license https://opensource.org/licenses/MIT The MIT License (MIT)
18		* @link http://phpbu.de/
19		* @since Class available since Release 2.1.0
20		*/
21		class Rsync extends Abstraction implements Executable
22		{
23		/**
24		* Source
25		*
26		* @var \phpbu\App\Cli\Executable\Rsync\Location
27		*/
28		private $source;
29
30		/**
31		* Target
32		*
33		* @var \phpbu\App\Cli\Executable\Rsync\Location
34		*/
35		private $target;
36
37		/**
38		* Raw args
39		*
40		* @var string
41		*/
42		protected $args;
43
44		/**
45		* Files to ignore, extracted from config string separated by ":"
46		*
47		* @var array
48		*/
49		protected $excludes = [];
50
51		/**
52		* Remove deleted files remotely as well
53		*
54		* @var boolean
55		*/
56		protected $delete;
57
58		/**
59		* Compress data.
60		*
61		* @var boolean
62		*/
63		protected $compressed = false;
64
65		/**
66		* Constructor.
67		*
68		* @param string $path
69		*/
70		public function __construct(string $path = '')
71		{
72		$this->setup('rsync', $path);
73		$this->source = new Rsync\Location();
74		$this->target = new Rsync\Location();
75		}
76
77		/**
78		* Set custom args
79		*
80		* @param string $args
81		* @return \phpbu\App\Cli\Executable\Rsync
82		*/
83	15	public function useArgs(string $args) : Rsync
84		{
85	15	$this->args = $args;
86	15	return $this;
87	15	}
88
89		/**
90		* Set source user.
91		*
92		* @param string $user
93		* @return \phpbu\App\Cli\Executable\Rsync
94		*/
95	2	public function fromUser(string $user) : Rsync
96		{
97	2	$this->source->setUser($user);
98	2	return $this;
99		}
100
101		/**
102		* Set source host.
103		*
104		* @param string $host
105		* @return \phpbu\App\Cli\Executable\Rsync
106		*/
107	8	public function fromHost(string $host) : Rsync
108		{
109	8	$this->source->setHost($host);
110	8	return $this;
111		}
112
113		/**
114		* Set source path.
115		*
116		* @param string $path
117		* @return \phpbu\App\Cli\Executable\Rsync
118		*/
119	4	public function fromPath(string $path) : Rsync
120		{
121	4	$this->source->setPath($path);
122	4	return $this;
123		}
124
125		/**
126		* Use compression.
127		*
128		* @param bool $bool
129		* @return \phpbu\App\Cli\Executable\Rsync
130		*/
131	5	public function compressed(bool $bool) : Rsync
132		{
133	5	$this->compressed = $bool;
134	5	return $this;
135		}
136
137		/**
138		* Sync to host.
139		*
140		* @param string $host
141		* @return \phpbu\App\Cli\Executable\Rsync
142		*/
143	10	public function toHost(string $host) : Rsync
144		{
145	10	$this->target->setHost($host);
146	10	return $this;
147		}
148
149		/**
150		* Set path to sync to.
151		*
152		* @param string $path
153		* @return \phpbu\App\Cli\Executable\Rsync
154		*/
155	5	public function toPath(string $path) : Rsync
156		{
157	5	$this->target->setPath($path);
158	5	return $this;
159		}
160
161		/**
162		* Set user to connect as.
163		*
164		* @param string $user
165		* @return \phpbu\App\Cli\Executable\Rsync
166		*/
167	4	public function toUser(string $user) : Rsync
168		{
169	4	$this->target->setUser($user);
170	4	return $this;
171		}
172
173		/**
174		* Exclude files.
175		*
176		* @param array $excludes
177		* @return \phpbu\App\Cli\Executable\Rsync
178		*/
179	4	public function exclude(array $excludes) : Rsync
180		{
181	4	$this->excludes = $excludes;
182	4	return $this;
183		}
184
185		/**
186		* Use --delete option.
187		*
188		* @param bool $bool
189		* @return \phpbu\App\Cli\Executable\Rsync
190		*/
191	11	public function removeDeleted(bool $bool) : Rsync
192		{
193	11	$this->delete = $bool;
194	11	return $this;
195	11	}
196
197	11	/**
198	2	* Rsync CommandLine generator.
199	2	*
200	9	* @return \SebastianFeldmann\Cli\CommandLine
201	1	* @throws \phpbu\App\Exception
202		*/
203	8	protected function createCommandLine() : CommandLine
204	1	{
205		$process = new CommandLine();
206		$cmd = new Cmd($this->binary);
207	7	$process->addCommand($cmd);
208
209		if (!empty($this->args)) {
210	7	$cmd->addOption($this->args);
211	7	} else {
212		if (!$this->source->isValid()) {
213	7	throw new Exception('source path is missing');
214	2	}
215	2	if (!$this->target->isValid()) {
216	2	throw new Exception('target path is missing');
217	2	}
218
219	7	// use archive mode, verbose and compress if not already done
220	7	$options = '-av' . ($this->compressed ? 'z' : '');
221		$cmd->addOption($options);
222		$this->configureExcludes($cmd, $this->excludes);
223		$cmd->addOptionIfNotEmpty('--delete', $this->delete, false);
224	7	$cmd->addArgument($this->source->toString());
225		$cmd->addArgument($this->target->toString());
226	7	}
227
228	7	return $process;
229		}
230
231	9	/**
232		* Configure excludes.
233		*
234		* @param \SebastianFeldmann\Cli\Command\Executable $cmd
235		* @param array $excludes
236		*/
237		protected function configureExcludes(Cmd $cmd, array $excludes)
238		{
239	11	foreach ($excludes as $ex) {
240		$cmd->addOption('--exclude', $ex);
241	11	}
242		}
243		}
244

sebastianfeldmann / phpbu

Push — master ( 6a1fad...afb84c )

Rsync::createCommandLine() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like