PackPhar::progressIndicatorSteps() - Code Metrics - consolidation/robo - Measure and Improve Code Quality continuously with Scrutinizer

PackPhar::progressIndicatorSteps() A
last analyzed 2020-08-27 17:44 UTC

↳ Parent: PackPhar

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace Robo\Task\Development;

use Robo\Contract\ProgressIndicatorAwareInterface;
use Robo\Contract\PrintedInterface;
use Robo\Result;
use Robo\Task\BaseTask;

/**
 * Creates Phar.
 *
 * ``` php
 * <?php
 * $pharTask = $this->taskPackPhar('package/codecept.phar')
 *   ->compress()
 *   ->stub('package/stub.php');
 *
 *  $finder = Finder::create()
 *      ->name('*.php')
 *        ->in('src');
 *
 *    foreach ($finder as $file) {
 *        $pharTask->addFile('src/'.$file->getRelativePathname(), $file->getRealPath());
 *    }
 *
 *    $finder = Finder::create()->files()
 *        ->name('*.php')
 *        ->in('vendor');
 *
 *    foreach ($finder as $file) {
 *        $pharTask->addStripped('vendor/'.$file->getRelativePathname(), $file->getRealPath());
 *    }
 *    $pharTask->run();
 *
 *    // verify Phar is packed correctly
 *    $code = $this->_exec('php package/codecept.phar');
 * ?>
 * ```
 */
class PackPhar extends BaseTask implements PrintedInterface, ProgressIndicatorAwareInterface
{
    /**
     * @var \Phar
     */
    protected $phar;

    /**
     * @var null|string
     */
    protected $compileDir = null;

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

    /**
     * @var bool
     */
    protected $compress = false;

    protected $stub;

    protected $bin;

    /**
     * @var string
     */
    protected $stubTemplate = <<<EOF
#!/usr/bin/env php
<?php
Phar::mapPhar();
%s
__HALT_COMPILER();
EOF;

    /**
     * @var string[]
     */
    protected $files = [];

    /**
     * {@inheritdoc}
     */
    public function getPrinted()
    {
        return true;
    }

    /**
     * @param string $filename
     */
    public function __construct($filename)
    {
        $file = new \SplFileInfo($filename);
        $this->filename = $filename;
        if (file_exists($file->getRealPath())) {
            @unlink($file->getRealPath());
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
        }
        $this->phar = new \Phar($file->getPathname(), 0, $file->getFilename());
    }

    /**
     * @param bool $compress
     *
     * @return $this
     */
    public function compress($compress = true)
    {
        $this->compress = $compress;
        return $this;
    }

    /**
     * @param string $stub
     *
     * @return $this
     */
    public function stub($stub)
    {
        $this->phar->setStub(file_get_contents($stub));
        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function progressIndicatorSteps()
    {
        // run() will call advanceProgressIndicator() once for each
        // file, one after calling stopBuffering, and again after compression.
        return count($this->files) + 2;
    }

    /**
     * {@inheritdoc}
     */
    public function run()
    {
        $this->printTaskInfo('Creating {filename}', ['filename' => $this->filename]);
        $this->phar->setSignatureAlgorithm(\Phar::SHA1);
        $this->phar->startBuffering();

        $this->printTaskInfo('Packing {file-count} files into phar', ['file-count' => count($this->files)]);

        $this->startProgressIndicator();
        foreach ($this->files as $path => $content) {
            $this->phar->addFromString($path, $content);
            $this->advanceProgressIndicator();
        }
        $this->phar->stopBuffering();
        $this->advanceProgressIndicator();

        if ($this->compress and in_array('GZ', \Phar::getSupportedCompression())) {
            if (count($this->files) > 1000) {
                $this->printTaskInfo('Too many files. Compression DISABLED');
            } else {
                $this->printTaskInfo('{filename} compressed', ['filename' => $this->filename]);
                $this->phar = $this->phar->compressFiles(\Phar::GZ);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
            }
        }
        $this->advanceProgressIndicator();
        $this->stopProgressIndicator();
        $this->printTaskSuccess('{filename} produced', ['filename' => $this->filename]);
        return Result::success($this, '', ['time' => $this->getExecutionTime()]);
    }

    /**
     * @param string $path
     * @param string $file
     *
     * @return $this
     */
    public function addStripped($path, $file)
    {
        $this->files[$path] = $this->stripWhitespace(file_get_contents($file));
        return $this;
    }

    /**
     * @param string $path
     * @param string $file
     *
     * @return $this
     */
    public function addFile($path, $file)
    {
        $this->files[$path] = file_get_contents($file);
        return $this;
    }

    /**
     * @param \Symfony\Component\Finder\SplFileInfo[] $files
     */
    public function addFiles($files)
    {
        foreach ($files as $file) {
            $this->addFile($file->getRelativePathname(), $file->getRealPath());
        }
    }

    /**
     * @param string $file
     *
     * @return $this
     */
    public function executable($file)
    {
        $source = file_get_contents($file);
        if (strpos($source, '#!/usr/bin/env php') === 0) {
            $source = substr($source, strpos($source, '<?php') + 5);
        }
        $this->phar->setStub(sprintf($this->stubTemplate, $source));
        return $this;
    }

    /**
     * Strips whitespace from source. Taken from composer
     *
     * @param string $source
     *
     * @return string
     */
    private function stripWhitespace($source)
    {
        if (!function_exists('token_get_all')) {
            return $source;
        }

        $output = '';
        foreach (token_get_all($source) as $token) {
            if (is_string($token)) {
                $output .= $token;
            } elseif (in_array($token[0], array(T_COMMENT, T_DOC_COMMENT))) {
                // $output .= $token[1];
                $output .= str_repeat("\n", substr_count($token[1], "\n"));
            } elseif (T_WHITESPACE === $token[0]) {
                // reduce wide spaces
                $whitespace = preg_replace('{[ \t]+}', ' ', $token[1]);
                // normalize newlines to \n
                $whitespace = preg_replace('{(?:\r\n|\r|\n)}', "\n", $whitespace);
                // trim leading spaces
                $whitespace = preg_replace('{\n +}', "\n", $whitespace);
                $output .= $whitespace;
            } else {
                $output .= $token[1];
            }
        }

        return $output;
    }
}


1			<?php
2
3			namespace Robo\Task\Development;
4
5			use Robo\Contract\ProgressIndicatorAwareInterface;
6			use Robo\Contract\PrintedInterface;
7			use Robo\Result;
8			use Robo\Task\BaseTask;
9
10			/**
11			* Creates Phar.
12			*
13			* ``` php
14			* <?php
15			* $pharTask = $this->taskPackPhar('package/codecept.phar')
16			* ->compress()
17			* ->stub('package/stub.php');
18			*
19			* $finder = Finder::create()
20			* ->name('*.php')
21			* ->in('src');
22			*
23			* foreach ($finder as $file) {
24			* $pharTask->addFile('src/'.$file->getRelativePathname(), $file->getRealPath());
25			* }
26			*
27			* $finder = Finder::create()->files()
28			* ->name('*.php')
29			* ->in('vendor');
30			*
31			* foreach ($finder as $file) {
32			* $pharTask->addStripped('vendor/'.$file->getRelativePathname(), $file->getRealPath());
33			* }
34			* $pharTask->run();
35			*
36			* // verify Phar is packed correctly
37			* $code = $this->_exec('php package/codecept.phar');
38			* ?>
39			* ```
40			*/
41			class PackPhar extends BaseTask implements PrintedInterface, ProgressIndicatorAwareInterface
42			{
43			/**
44			* @var \Phar
45			*/
46			protected $phar;
47
48			/**
49			* @var null\|string
50			*/
51			protected $compileDir = null;
52
53			/**
54			* @var string
55			*/
56			protected $filename;
57
58			/**
59			* @var bool
60			*/
61			protected $compress = false;
62
63			protected $stub;
64
65			protected $bin;
66
67			/**
68			* @var string
69			*/
70			protected $stubTemplate = <<<EOF
71			#!/usr/bin/env php
72			<?php
73			Phar::mapPhar();
74			%s
75			__HALT_COMPILER();
76			EOF;
77
78			/**
79			* @var string[]
80			*/
81			protected $files = [];
82
83			/**
84			* {@inheritdoc}
85			*/
86			public function getPrinted()
87			{
88			return true;
89			}
90
91			/**
92			* @param string $filename
93			*/
94			public function __construct($filename)
95			{
96			$file = new \SplFileInfo($filename);
97			$this->filename = $filename;
98			if (file_exists($file->getRealPath())) {
99			@unlink($file->getRealPath());
			0 ignored issues – show Security Best Practice introduced 2016-09-13 23:40 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
100			}
101			$this->phar = new \Phar($file->getPathname(), 0, $file->getFilename());
102			}
103
104			/**
105			* @param bool $compress
106			*
107			* @return $this
108			*/
109			public function compress($compress = true)
110			{
111			$this->compress = $compress;
112			return $this;
113			}
114
115			/**
116			* @param string $stub
117			*
118			* @return $this
119			*/
120			public function stub($stub)
121			{
122			$this->phar->setStub(file_get_contents($stub));
123			return $this;
124			}
125
126			/**
127			* {@inheritdoc}
128			*/
129			public function progressIndicatorSteps()
130			{
131			// run() will call advanceProgressIndicator() once for each
132			// file, one after calling stopBuffering, and again after compression.
133			return count($this->files) + 2;
134			}
135
136			/**
137			* {@inheritdoc}
138			*/
139			public function run()
140			{
141			$this->printTaskInfo('Creating {filename}', ['filename' => $this->filename]);
142			$this->phar->setSignatureAlgorithm(\Phar::SHA1);
143			$this->phar->startBuffering();
144
145			$this->printTaskInfo('Packing {file-count} files into phar', ['file-count' => count($this->files)]);
146
147			$this->startProgressIndicator();
148			foreach ($this->files as $path => $content) {
149			$this->phar->addFromString($path, $content);
150			$this->advanceProgressIndicator();
151			}
152			$this->phar->stopBuffering();
153			$this->advanceProgressIndicator();
154
155			if ($this->compress and in_array('GZ', \Phar::getSupportedCompression())) {
156			if (count($this->files) > 1000) {
157			$this->printTaskInfo('Too many files. Compression DISABLED');
158			} else {
159			$this->printTaskInfo('{filename} compressed', ['filename' => $this->filename]);
160			$this->phar = $this->phar->compressFiles(\Phar::GZ);
			0 ignored issues – show Bug introduced 2016-09-13 23:40 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$this->phar` is correct as `$this->phar->compressFiles(\Phar::GZ)` (which targets `Phar::compressFiles()`) seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
161			}
162			}
163			$this->advanceProgressIndicator();
164			$this->stopProgressIndicator();
165			$this->printTaskSuccess('{filename} produced', ['filename' => $this->filename]);
166			return Result::success($this, '', ['time' => $this->getExecutionTime()]);
167			}
168
169			/**
170			* @param string $path
171			* @param string $file
172			*
173			* @return $this
174			*/
175			public function addStripped($path, $file)
176			{
177			$this->files[$path] = $this->stripWhitespace(file_get_contents($file));
178			return $this;
179			}
180
181			/**
182			* @param string $path
183			* @param string $file
184			*
185			* @return $this
186			*/
187			public function addFile($path, $file)
188			{
189			$this->files[$path] = file_get_contents($file);
190			return $this;
191			}
192
193			/**
194			* @param \Symfony\Component\Finder\SplFileInfo[] $files
195			*/
196			public function addFiles($files)
197			{
198			foreach ($files as $file) {
199			$this->addFile($file->getRelativePathname(), $file->getRealPath());
200			}
201			}
202
203			/**
204			* @param string $file
205			*
206			* @return $this
207			*/
208			public function executable($file)
209			{
210			$source = file_get_contents($file);
211			if (strpos($source, '#!/usr/bin/env php') === 0) {
212			$source = substr($source, strpos($source, '<?php') + 5);
213			}
214			$this->phar->setStub(sprintf($this->stubTemplate, $source));
215			return $this;
216			}
217
218			/**
219			* Strips whitespace from source. Taken from composer
220			*
221			* @param string $source
222			*
223			* @return string
224			*/
225			private function stripWhitespace($source)
226			{
227			if (!function_exists('token_get_all')) {
228			return $source;
229			}
230
231			$output = '';
232			foreach (token_get_all($source) as $token) {
233			if (is_string($token)) {
234			$output .= $token;
235			} elseif (in_array($token[0], array(T_COMMENT, T_DOC_COMMENT))) {
236			// $output .= $token[1];
237			$output .= str_repeat("\n", substr_count($token[1], "\n"));
238			} elseif (T_WHITESPACE === $token[0]) {
239			// reduce wide spaces
240			$whitespace = preg_replace('{[ \t]+}', ' ', $token[1]);
241			// normalize newlines to \n
242			$whitespace = preg_replace('{(?:\r\n\|\r\|\n)}', "\n", $whitespace);
243			// trim leading spaces
244			$whitespace = preg_replace('{\n +}', "\n", $whitespace);
245			$output .= $whitespace;
246			} else {
247			$output .= $token[1];
248			}
249			}
250
251			return $output;
252			}
253			}
254

consolidation / robo

PackPhar::progressIndicatorSteps() A last analyzed 2020-08-27 17:44 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

PackPhar::progressIndicatorSteps() A
last analyzed 2020-08-27 17:44 UTC