DbDumper::Bzip2Compression() - Code Metrics - Inspection of "Add compression strategy" - spatie/db-dumper - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#81)

unknown

created 2018-09-17 15:37 UTC

DbDumper::Bzip2Compression() A

↳ Parent: DbDumper

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace Spatie\DbDumper;

use Symfony\Component\Process\Process;
use Spatie\DbDumper\Exceptions\DumpFailed;
use Spatie\DbDumper\Compressors\GzipCompressor;
use Spatie\DbDumper\Compressors\Bzip2Compressor;
use Spatie\DbDumper\Exceptions\CannotSetParameter;

abstract class DbDumper
{
    /** @var string */
    protected $dbName;

    /** @var string */
    protected $userName;

    /** @var string */
    protected $password;

    /** @var string */
    protected $host = 'localhost';

    /** @var int */
    protected $port = 5432;

    /** @var string */
    protected $socket = '';

    /** @var int */
    protected $timeout = 0;

    /** @var string */
    protected $dumpBinaryPath = '';

    /** @var array */
    protected $includeTables = [];

    /** @var array */
    protected $excludeTables = [];

    /** @var array */
    protected $extraOptions = [];

    /** @var string */
    protected $compressor = null;

    public static function create()
    {
        return new static();
    }

    public function getDbName(): string
    {
        return $this->dbName;
    }

    /**
     * @param string $dbName
     *
     * @return $this
     */
    public function setDbName(string $dbName)
    {
        $this->dbName = $dbName;

        return $this;
    }

    /**
     * @param string $userName
     *
     * @return $this
     */
    public function setUserName(string $userName)
    {
        $this->userName = $userName;

        return $this;
    }

    /**
     * @param string $password
     *
     * @return $this
     */
    public function setPassword(string $password)
    {
        $this->password = $password;

        return $this;
    }

    /**
     * @param string $host
     *
     * @return $this
     */
    public function setHost(string $host)
    {
        $this->host = $host;

        return $this;
    }

    public function getHost(): string
    {
        return $this->host;
    }

    /**
     * @param int $port
     *
     * @return $this
     */
    public function setPort(int $port)
    {
        $this->port = $port;

        return $this;
    }

    /**
     * @param string $socket
     *
     * @return $this
     */
    public function setSocket(string $socket)
    {
        $this->socket = $socket;

        return $this;
    }

    /**
     * @param int $timeout
     *
     * @return $this
     */
    public function setTimeout(int $timeout)
    {
        $this->timeout = $timeout;

        return $this;
    }

    /**
     * @param string $dumpBinaryPath
     *
     * @return $this
     */
    public function setDumpBinaryPath(string $dumpBinaryPath)
    {
        if ($dumpBinaryPath !== '' && substr($dumpBinaryPath, -1) !== '/') {
            $dumpBinaryPath .= '/';
        }

        $this->dumpBinaryPath = $dumpBinaryPath;

        return $this;
    }

    public function enableCompression()
    {
        return $this->GzipCompression();
    }

    /**
     * @param string $level
     *
     * @return $this
     *
     */
    public function GzipCompression(string $level = '9')
    {
        $this->compressor = new GzipCompressor;


        $this->compressor->setLevel($level);

        return $this;
    }

    /**
     * @param string $level
     *
     * @return $this
     *
     */
    public function Bzip2Compression(string $level = '9')
    {
        $this->compressor = new Bzip2Compressor;


        $this->compressor->setLevel($level);

        return $this;
    }

    /**
     * @param string|array $includeTables
     *
     * @return $this
     *
     * @throws \Spatie\DbDumper\Exceptions\CannotSetParameter
     */
    public function includeTables($includeTables)

    {
        if (! empty($this->excludeTables)) {
            throw CannotSetParameter::conflictingParameters('includeTables', 'excludeTables');
        }

        if (! is_array($includeTables)) {
            $includeTables = explode(', ', $includeTables);
        }

        $this->includeTables = $includeTables;

        return $this;
    }

    /**
     * @param string|array $excludeTables
     *
     * @return $this
     *
     * @throws \Spatie\DbDumper\Exceptions\CannotSetParameter
     */
    public function excludeTables($excludeTables)

    {
        if (! empty($this->includeTables)) {
            throw CannotSetParameter::conflictingParameters('excludeTables', 'includeTables');
        }

        if (! is_array($excludeTables)) {
            $excludeTables = explode(', ', $excludeTables);
        }

        $this->excludeTables = $excludeTables;

        return $this;
    }

    /**
     * @param string $extraOption
     *
     * @return $this
     */
    public function addExtraOption(string $extraOption)
    {
        if (! empty($extraOption)) {
            $this->extraOptions[] = $extraOption;
        }

        return $this;
    }

    abstract public function dumpToFile(string $dumpFile);

    protected function checkIfDumpWasSuccessFul(Process $process, string $outputFile)
    {
        if (! $process->isSuccessful()) {
            throw DumpFailed::processDidNotEndSuccessfully($process);
        }

        if (! file_exists($outputFile)) {
            throw DumpFailed::dumpfileWasNotCreated();
        }

        if (filesize($outputFile) === 0) {
            throw DumpFailed::dumpfileWasEmpty();
        }
    }

    protected function echoToFile(string $command, string $dumpFile): string
    {
        $compression = $this->compressor ? ' | ' . $this->compressor->getCompressorCommand() : '';

        $dumpFile = '"'.addcslashes($dumpFile, '\\"').'"';

        return $command.$compression.' > '.$dumpFile;
    }
}


1		<?php
2
3		namespace Spatie\DbDumper;
4
5		use Symfony\Component\Process\Process;
6		use Spatie\DbDumper\Exceptions\DumpFailed;
7		use Spatie\DbDumper\Compressors\GzipCompressor;
8		use Spatie\DbDumper\Compressors\Bzip2Compressor;
9		use Spatie\DbDumper\Exceptions\CannotSetParameter;
10
11		abstract class DbDumper
12		{
13		/** @var string */
14		protected $dbName;
15
16		/** @var string */
17		protected $userName;
18
19		/** @var string */
20		protected $password;
21
22		/** @var string */
23		protected $host = 'localhost';
24
25		/** @var int */
26		protected $port = 5432;
27
28		/** @var string */
29		protected $socket = '';
30
31		/** @var int */
32		protected $timeout = 0;
33
34		/** @var string */
35		protected $dumpBinaryPath = '';
36
37		/** @var array */
38		protected $includeTables = [];
39
40		/** @var array */
41		protected $excludeTables = [];
42
43		/** @var array */
44		protected $extraOptions = [];
45
46		/** @var string */
47		protected $compressor = null;
48
49		public static function create()
50		{
51		return new static();
52		}
53
54		public function getDbName(): string
55		{
56		return $this->dbName;
57		}
58
59		/**
60		* @param string $dbName
61		*
62		* @return $this
63		*/
64		public function setDbName(string $dbName)
65		{
66		$this->dbName = $dbName;
67
68		return $this;
69		}
70
71		/**
72		* @param string $userName
73		*
74		* @return $this
75		*/
76		public function setUserName(string $userName)
77		{
78		$this->userName = $userName;
79
80		return $this;
81		}
82
83		/**
84		* @param string $password
85		*
86		* @return $this
87		*/
88		public function setPassword(string $password)
89		{
90		$this->password = $password;
91
92		return $this;
93		}
94
95		/**
96		* @param string $host
97		*
98		* @return $this
99		*/
100		public function setHost(string $host)
101		{
102		$this->host = $host;
103
104		return $this;
105		}
106
107		public function getHost(): string
108		{
109		return $this->host;
110		}
111
112		/**
113		* @param int $port
114		*
115		* @return $this
116		*/
117		public function setPort(int $port)
118		{
119		$this->port = $port;
120
121		return $this;
122		}
123
124		/**
125		* @param string $socket
126		*
127		* @return $this
128		*/
129		public function setSocket(string $socket)
130		{
131		$this->socket = $socket;
132
133		return $this;
134		}
135
136		/**
137		* @param int $timeout
138		*
139		* @return $this
140		*/
141		public function setTimeout(int $timeout)
142		{
143		$this->timeout = $timeout;
144
145		return $this;
146		}
147
148		/**
149		* @param string $dumpBinaryPath
150		*
151		* @return $this
152		*/
153		public function setDumpBinaryPath(string $dumpBinaryPath)
154		{
155		if ($dumpBinaryPath !== '' && substr($dumpBinaryPath, -1) !== '/') {
156		$dumpBinaryPath .= '/';
157		}
158
159		$this->dumpBinaryPath = $dumpBinaryPath;
160
161		return $this;
162		}
163
164		public function enableCompression()
165		{
166		return $this->GzipCompression();
167		}
168
169		/**
170		* @param string $level
171		*
172		* @return $this
173		*
174		*/
175		public function GzipCompression(string $level = '9')
176		{
177		$this->compressor = new GzipCompressor;
		0 ignored issues – show Documentation Bug introduced 2018-09-17 15:39 UTC by Report Bug Copy Issue Report It seems like `new \Spatie\DbDumper\Compressors\GzipCompressor()` of type `object<Spatie\DbDumper\C...ressors\GzipCompressor>` is incompatible with the declared type `string` of property `$compressor`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
178
179		$this->compressor->setLevel($level);
180
181		return $this;
182		}
183
184		/**
185		* @param string $level
186		*
187		* @return $this
188		*
189		*/
190		public function Bzip2Compression(string $level = '9')
191		{
192		$this->compressor = new Bzip2Compressor;
		0 ignored issues – show Documentation Bug introduced 2018-09-17 15:39 UTC by Report Bug Copy Issue Report It seems like `new \Spatie\DbDumper\Compressors\Bzip2Compressor()` of type `object<Spatie\DbDumper\C...essors\Bzip2Compressor>` is incompatible with the declared type `string` of property `$compressor`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
193
194		$this->compressor->setLevel($level);
195
196		return $this;
197		}
198
199		/**
200		* @param string\|array $includeTables
201		*
202		* @return $this
203		*
204		* @throws \Spatie\DbDumper\Exceptions\CannotSetParameter
205		*/
206	View Code Duplication	public function includeTables($includeTables)
		0 ignored issues – show Duplication introduced 2017-08-18 11:29 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
207		{
208		if (! empty($this->excludeTables)) {
209		throw CannotSetParameter::conflictingParameters('includeTables', 'excludeTables');
210		}
211
212		if (! is_array($includeTables)) {
213		$includeTables = explode(', ', $includeTables);
214		}
215
216		$this->includeTables = $includeTables;
217
218		return $this;
219		}
220
221		/**
222		* @param string\|array $excludeTables
223		*
224		* @return $this
225		*
226		* @throws \Spatie\DbDumper\Exceptions\CannotSetParameter
227		*/
228	View Code Duplication	public function excludeTables($excludeTables)
		0 ignored issues – show Duplication introduced 2017-08-18 11:29 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
229		{
230		if (! empty($this->includeTables)) {
231		throw CannotSetParameter::conflictingParameters('excludeTables', 'includeTables');
232		}
233
234		if (! is_array($excludeTables)) {
235		$excludeTables = explode(', ', $excludeTables);
236		}
237
238		$this->excludeTables = $excludeTables;
239
240		return $this;
241		}
242
243		/**
244		* @param string $extraOption
245		*
246		* @return $this
247		*/
248		public function addExtraOption(string $extraOption)
249		{
250		if (! empty($extraOption)) {
251		$this->extraOptions[] = $extraOption;
252		}
253
254		return $this;
255		}
256
257		abstract public function dumpToFile(string $dumpFile);
258
259		protected function checkIfDumpWasSuccessFul(Process $process, string $outputFile)
260		{
261		if (! $process->isSuccessful()) {
262		throw DumpFailed::processDidNotEndSuccessfully($process);
263		}
264
265		if (! file_exists($outputFile)) {
266		throw DumpFailed::dumpfileWasNotCreated();
267		}
268
269		if (filesize($outputFile) === 0) {
270		throw DumpFailed::dumpfileWasEmpty();
271		}
272		}
273
274		protected function echoToFile(string $command, string $dumpFile): string
275		{
276		$compression = $this->compressor ? ' \| ' . $this->compressor->getCompressorCommand() : '';
		0 ignored issues – show Bug introduced 2018-09-17 15:39 UTC by Report Bug Copy Issue Report The method `getCompressorCommand` cannot be called on `$this->compressor` (of type `string`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
277		$dumpFile = '"'.addcslashes($dumpFile, '\\"').'"';
278
279		return $command.$compression.' > '.$dumpFile;
280		}
281		}
282

spatie / db-dumper

Pull Request — master (#81)

DbDumper::Bzip2Compression() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like