Burgomaster::debug() - Code Metrics - Inspection of "Skip build dir in scrutinizer" - thematicmedia/habrahabr_api - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( da4eab...706813 )

by dotzero

created 2016-06-06 12:50 UTC

Burgomaster::debug() A

↳ Parent: Project

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	10
rs	9.4285
cc	2
eloc	5
nc	2
nop	1

<?php

/**
 * Packages the zip and phar file using a staging directory.
 *
 * @license MIT, Michael Dowling https://github.com/mtdowling
 * @license https://github.com/mtdowling/Burgomaster/LICENSE
 */
class Burgomaster
{
    /** @var string Base staging directory of the project */
    public $stageDir;

    /** @var string Root directory of the project */
    public $projectRoot;

    /** @var array stack of sections */
    private $sections = array();

    /**
     * @param string $stageDir    Staging base directory where your packaging
     *                            takes place. This folder will be created for
     *                            you if it does not exist. If it exists, it
     *                            will be deleted and recreated to start fresh.
     * @param string $projectRoot Root directory of the project.
     *
     * @throws \InvalidArgumentException
     * @throws \RuntimeException
     */
    public function __construct($stageDir, $projectRoot = null)
    {
        $this->startSection('setting_up');
        $this->stageDir = $stageDir;
        $this->projectRoot = $projectRoot;

        if (!$this->stageDir || $this->stageDir == '/') {
            throw new \InvalidArgumentException('Invalid base directory');
        }

        if (is_dir($this->stageDir)) {
            $this->debug("Removing existing directory: $this->stageDir");
            echo $this->exec("rm -rf $this->stageDir");
        }

        $this->debug("Creating staging directory: $this->stageDir");

        if (!mkdir($this->stageDir, 0775, true)) {
            throw new \RuntimeException("Could not create {$this->stageDir}");
        }

        $this->stageDir = realpath($this->stageDir);
        $this->debug("Creating staging directory at: {$this->stageDir}");

        if (!is_dir($this->projectRoot)) {
            throw new \InvalidArgumentException(
                "Project root not found: $this->projectRoot"
            );
        }

        $this->endSection();
        $this->startSection('staging');

        chdir($this->projectRoot);
    }

    /**
     * Cleanup if the last section was not already closed.
     */
    public function __destruct()
    {
        if ($this->sections) {
            $this->endSection();
        }
    }

    /**
     * Call this method when starting a specific section of the packager.
     *
     * This makes the debug messages used in your script more meaningful and
     * adds context when things go wrong. Be sure to call endSection() when
     * you have finished a section of your packaging script.
     *
     * @param string $section Part of the packager that is running
     */
    public function startSection($section)
    {
        $this->sections[] = $section;
        $this->debug('Starting');
    }

    /**
     * Call this method when leaving the last pushed section of the packager.
     */
    public function endSection()
    {
        if ($this->sections) {
            $this->debug('Completed');
            array_pop($this->sections);
        }
    }

    /**
     * Prints a debug message to STDERR bound to the current section.
     *
     * @param string $message Message to echo to STDERR
     */
    public function debug($message)
    {
        $prefix = date('c') . ': ';

        if ($this->sections) {
            $prefix .= '[' . end($this->sections) . '] ';
        }

        fwrite(STDERR, $prefix . $message . "\n");
    }

    /**
     * Copies a file and creates the destination directory if needed.
     *
     * @param string $from File to copy
     * @param string $to   Destination to copy the file to, relative to the
     *                     base staging directory.
     * @throws \InvalidArgumentException if the file cannot be found
     * @throws \RuntimeException if the directory cannot be created.
     * @throws \RuntimeException if the file cannot be copied.
     */
    public function deepCopy($from, $to)
    {
        if (!is_file($from)) {
            throw new \InvalidArgumentException("File not found: {$from}");
        }

        $to = str_replace('//', '/', $this->stageDir . '/' . $to);
        $dir = dirname($to);

        if (!is_dir($dir)) {
            if (!mkdir($dir, 0777, true)) {
                throw new \RuntimeException("Unable to create directory: $dir");
            }
        }

        if (!copy($from, $to)) {
            throw new \RuntimeException("Unable to copy $from to $to");
        }
    }

    /**
     * Recursively copy one folder to another.
     *
     * Any LICENSE file is automatically copied.
     *
     * @param string $sourceDir  Source directory to copy from
     * @param string $destDir    Directory to copy the files to that is relative
     *                           to the the stage base directory.
     * @param array  $extensions File extensions to copy from the $sourceDir.
     *                           Defaults to "php" files only (e.g., ['php']).
     * @throws \InvalidArgumentException if the source directory is invalid.
     */
    function recursiveCopy(
        $sourceDir,
        $destDir,
        $extensions = array('php')
    ) {
        if (!realpath($sourceDir)) {
            throw new \InvalidArgumentException("$sourceDir not found");
        }

        if (!$extensions) {
            throw new \InvalidArgumentException('$extensions is empty!');
        }

        $sourceDir = realpath($sourceDir);
        $exts = array_fill_keys($extensions, true);
        $iter = new \RecursiveDirectoryIterator($sourceDir);
        $iter = new \RecursiveIteratorIterator($iter);
        $total = 0;

        $this->startSection('copy');
        $this->debug("Starting to copy files from $sourceDir");

        foreach ($iter as $file) {
            if (isset($exts[$file->getExtension()])
                || $file->getBaseName() == 'LICENSE'
            ) {
                // Remove the source directory from the destination path
                $toPath = str_replace($sourceDir, '', (string) $file);
                $toPath = $destDir . '/' . $toPath;
                $toPath = str_replace('//', '/', $toPath);
                $this->deepCopy((string) $file, $toPath);
                $total++;
            }
        }

        $this->debug("Copied $total files from $sourceDir");
        $this->endSection();
    }

    /**
     * Execute a command and throw an exception if the return code is not 0.
     *
     * @param string $command Command to execute
     *
     * @return string Returns the output of the command as a string
     * @throws \RuntimeException on error.
     */
    public function exec($command)
    {
        $this->debug("Executing: $command");
        $output = $returnValue = null;
        exec($command, $output, $returnValue);

        if ($returnValue != 0) {
            throw new \RuntimeException('Error executing command: '
                . $command . ' : ' . implode("\n", $output));
        }

        return implode("\n", $output);
    }

    /**
     * Creates a class-map autoloader to the staging directory in a file
     * named autoloader.php
     *
     * @param array $files Files to explicitly require in the autoloader. This
     *                     is similar to Composer's "files" "autoload" section.
     * @param string $filename Name of the autoloader file.
     * @throws \RuntimeException if the file cannot be written
     */
    function createAutoloader($files = array(), $filename = 'autoloader.php') {
        $sourceDir = realpath($this->stageDir);
        $iter = new \RecursiveDirectoryIterator($sourceDir);
        $iter = new \RecursiveIteratorIterator($iter);

        $this->startSection('autoloader');
        $this->debug('Creating classmap autoloader');
        $this->debug("Collecting valid PHP files from {$this->stageDir}");

        $classMap = array();
        foreach ($iter as $file) {
            if ($file->getExtension() == 'php') {
                $location = str_replace($this->stageDir . '/', '', (string) $file);
                $className = str_replace('/', '\\', $location);
                $className = substr($className, 0, -4);

                // Remove "src\" or "lib\"
                if (strpos($className, 'src\\') === 0
                    || strpos($className, 'lib\\') === 0
                ) {
                    $className = substr($className, 4);
                }

                $classMap[$className] = "__DIR__ . '/$location'";
                $this->debug("Found $className");
            }
        }

        $destFile = $this->stageDir . '/' . $filename;
        $this->debug("Writing autoloader to {$destFile}");

        if (!($h = fopen($destFile, 'w'))) {
            throw new \RuntimeException('Unable to open file for writing');
        }

        $this->debug('Writing classmap files');
        fwrite($h, "<?php\n\n");
        fwrite($h, "\$mapping = array(\n");
        foreach ($classMap as $c => $f) {
            fwrite($h, "    '$c' => $f,\n");
        }
        fwrite($h, ");\n\n");
        fwrite($h, <<<EOT
spl_autoload_register(function (\$class) use (\$mapping) {
    if (isset(\$mapping[\$class])) {
        require \$mapping[\$class];
    }
}, true);

EOT
        );

        fwrite($h, "\n");

        $this->debug('Writing automatically included files');
        foreach ($files as $file) {
            fwrite($h, "require __DIR__ . '/$file';\n");
        }

        fclose($h);

        $this->endSection();
    }

    /**
     * Creates a default stub for the phar that includeds the generated
     * autoloader.
     *
     * This phar also registers a constant that can be used to check if you
     * are running the phar. The constant is the basename of the $dest variable
     * without the extension, with "_PHAR" appended, then converted to all
     * caps (e.g., "/foo/guzzle.phar" gets a contant defined as GUZZLE_PHAR.
     *
     * @param $dest
     * @param string $autoloaderFilename Name of the autoloader file.
     * @param string $alias The phar alias to use
     *
     * @return string
     */
    private function createStub($dest, $autoloaderFilename = 'autoloader.php', $alias = null)
    {
        $this->startSection('stub');
        $this->debug("Creating phar stub at $dest");

        $alias = $alias ?: basename($dest);
        $constName = strtoupper(str_replace('.phar', '', $alias)) . '_PHAR';
        $stub  = "<?php\n";
        $stub .= "define('$constName', true);\n";
        $stub .= "Phar::mapPhar('$alias');\n";
        $stub .= "require 'phar://$alias/{$autoloaderFilename}';\n";
        $stub .= "__HALT_COMPILER();\n";
        $this->endSection();

        return $stub;
    }

    /**
     * Creates a phar that automatically registers an autoloader.
     *
     * Call this only after your staging directory is built.
     *
     * @param string $dest Where to save the file. The basename of the file
     *     is also used as the alias name in the phar
     *     (e.g., /path/to/guzzle.phar => guzzle.phar).
     * @param string|bool|null $stub The path to the phar stub file. Pass or
     *      leave null to automatically have one created for you. Pass false
     *      to no use a stub in the generated phar.
     * @param string $autoloaderFilename Name of the autolaoder filename.
     */
    public function createPhar(
        $dest,
        $stub = null,
        $autoloaderFilename = 'autoloader.php',
        $alias = null
    ) {
        $this->startSection('phar');
        $this->debug("Creating phar file at $dest");
        $this->createDirIfNeeded(dirname($dest));
        $phar = new \Phar($dest, 0, $alias ?: basename($dest));
        $phar->buildFromDirectory($this->stageDir);

        if ($stub !== false) {
            if (!$stub) {
                $stub = $this->createStub($dest, $autoloaderFilename, $alias);
            }
            $phar->setStub($stub);
        }

        $this->debug("Created phar at $dest");
        $this->endSection();
    }

    /**
     * Creates a zip file containing the staged files of your project.
     *
     * Call this only after your staging directory is built.
     *
     * @param string $dest Where to save the zip file
     */
    public function createZip($dest)
    {
        $this->startSection('zip');
        $this->debug("Creating a zip file at $dest");
        $this->createDirIfNeeded(dirname($dest));
        chdir($this->stageDir);
        $this->exec("zip -r $dest ./");
        $this->debug("  > Created at $dest");
        chdir(__DIR__);
        $this->endSection();
    }

    private function createDirIfNeeded($dir)
    {
        if (!is_dir($dir) && !mkdir($dir, 0755, true)) {
            throw new \RuntimeException("Could not create dir: $dir");
        }
    }
}


1			<?php
2
3			/**
4			* Packages the zip and phar file using a staging directory.
5			*
6			* @license MIT, Michael Dowling https://github.com/mtdowling
7			* @license https://github.com/mtdowling/Burgomaster/LICENSE
8			*/
9			class Burgomaster
10			{
11			/** @var string Base staging directory of the project */
12			public $stageDir;
13
14			/** @var string Root directory of the project */
15			public $projectRoot;
16
17			/** @var array stack of sections */
18			private $sections = array();
19
20			/**
21			* @param string $stageDir Staging base directory where your packaging
22			* takes place. This folder will be created for
23			* you if it does not exist. If it exists, it
24			* will be deleted and recreated to start fresh.
25			* @param string $projectRoot Root directory of the project.
26			*
27			* @throws \InvalidArgumentException
28			* @throws \RuntimeException
29			*/
30			public function __construct($stageDir, $projectRoot = null)
31			{
32			$this->startSection('setting_up');
33			$this->stageDir = $stageDir;
34			$this->projectRoot = $projectRoot;
35
36			if (!$this->stageDir \|\| $this->stageDir == '/') {
37			throw new \InvalidArgumentException('Invalid base directory');
38			}
39
40			if (is_dir($this->stageDir)) {
41			$this->debug("Removing existing directory: $this->stageDir");
42			echo $this->exec("rm -rf $this->stageDir");
43			}
44
45			$this->debug("Creating staging directory: $this->stageDir");
46
47			if (!mkdir($this->stageDir, 0775, true)) {
48			throw new \RuntimeException("Could not create {$this->stageDir}");
49			}
50
51			$this->stageDir = realpath($this->stageDir);
52			$this->debug("Creating staging directory at: {$this->stageDir}");
53
54			if (!is_dir($this->projectRoot)) {
55			throw new \InvalidArgumentException(
56			"Project root not found: $this->projectRoot"
57			);
58			}
59
60			$this->endSection();
61			$this->startSection('staging');
62
63			chdir($this->projectRoot);
64			}
65
66			/**
67			* Cleanup if the last section was not already closed.
68			*/
69			public function __destruct()
70			{
71			if ($this->sections) {
72			$this->endSection();
73			}
74			}
75
76			/**
77			* Call this method when starting a specific section of the packager.
78			*
79			* This makes the debug messages used in your script more meaningful and
80			* adds context when things go wrong. Be sure to call endSection() when
81			* you have finished a section of your packaging script.
82			*
83			* @param string $section Part of the packager that is running
84			*/
85			public function startSection($section)
86			{
87			$this->sections[] = $section;
88			$this->debug('Starting');
89			}
90
91			/**
92			* Call this method when leaving the last pushed section of the packager.
93			*/
94			public function endSection()
95			{
96			if ($this->sections) {
97			$this->debug('Completed');
98			array_pop($this->sections);
99			}
100			}
101
102			/**
103			* Prints a debug message to STDERR bound to the current section.
104			*
105			* @param string $message Message to echo to STDERR
106			*/
107			public function debug($message)
108			{
109			$prefix = date('c') . ': ';
110
111			if ($this->sections) {
112			$prefix .= '[' . end($this->sections) . '] ';
113			}
114
115			fwrite(STDERR, $prefix . $message . "\n");
116			}
117
118			/**
119			* Copies a file and creates the destination directory if needed.
120			*
121			* @param string $from File to copy
122			* @param string $to Destination to copy the file to, relative to the
123			* base staging directory.
124			* @throws \InvalidArgumentException if the file cannot be found
125			* @throws \RuntimeException if the directory cannot be created.
126			* @throws \RuntimeException if the file cannot be copied.
127			*/
128			public function deepCopy($from, $to)
129			{
130			if (!is_file($from)) {
131			throw new \InvalidArgumentException("File not found: {$from}");
132			}
133
134			$to = str_replace('//', '/', $this->stageDir . '/' . $to);
135			$dir = dirname($to);
136
137			if (!is_dir($dir)) {
138			if (!mkdir($dir, 0777, true)) {
139			throw new \RuntimeException("Unable to create directory: $dir");
140			}
141			}
142
143			if (!copy($from, $to)) {
144			throw new \RuntimeException("Unable to copy $from to $to");
145			}
146			}
147
148			/**
149			* Recursively copy one folder to another.
150			*
151			* Any LICENSE file is automatically copied.
152			*
153			* @param string $sourceDir Source directory to copy from
154			* @param string $destDir Directory to copy the files to that is relative
155			* to the the stage base directory.
156			* @param array $extensions File extensions to copy from the $sourceDir.
157			* Defaults to "php" files only (e.g., ['php']).
158			* @throws \InvalidArgumentException if the source directory is invalid.
159			*/
160			function recursiveCopy(
161			$sourceDir,
162			$destDir,
163			$extensions = array('php')
164			) {
165			if (!realpath($sourceDir)) {
166			throw new \InvalidArgumentException("$sourceDir not found");
167			}
168
169			if (!$extensions) {
170			throw new \InvalidArgumentException('$extensions is empty!');
171			}
172
173			$sourceDir = realpath($sourceDir);
174			$exts = array_fill_keys($extensions, true);
175			$iter = new \RecursiveDirectoryIterator($sourceDir);
176			$iter = new \RecursiveIteratorIterator($iter);
177			$total = 0;
178
179			$this->startSection('copy');
180			$this->debug("Starting to copy files from $sourceDir");
181
182			foreach ($iter as $file) {
183			if (isset($exts[$file->getExtension()])
184			\|\| $file->getBaseName() == 'LICENSE'
185			) {
186			// Remove the source directory from the destination path
187			$toPath = str_replace($sourceDir, '', (string) $file);
188			$toPath = $destDir . '/' . $toPath;
189			$toPath = str_replace('//', '/', $toPath);
190			$this->deepCopy((string) $file, $toPath);
191			$total++;
192			}
193			}
194
195			$this->debug("Copied $total files from $sourceDir");
196			$this->endSection();
197			}
198
199			/**
200			* Execute a command and throw an exception if the return code is not 0.
201			*
202			* @param string $command Command to execute
203			*
204			* @return string Returns the output of the command as a string
205			* @throws \RuntimeException on error.
206			*/
207			public function exec($command)
208			{
209			$this->debug("Executing: $command");
210			$output = $returnValue = null;
211			exec($command, $output, $returnValue);
212
213			if ($returnValue != 0) {
214			throw new \RuntimeException('Error executing command: '
215			. $command . ' : ' . implode("\n", $output));
216			}
217
218			return implode("\n", $output);
219			}
220
221			/**
222			* Creates a class-map autoloader to the staging directory in a file
223			* named autoloader.php
224			*
225			* @param array $files Files to explicitly require in the autoloader. This
226			* is similar to Composer's "files" "autoload" section.
227			* @param string $filename Name of the autoloader file.
228			* @throws \RuntimeException if the file cannot be written
229			*/
230			function createAutoloader($files = array(), $filename = 'autoloader.php') {
231			$sourceDir = realpath($this->stageDir);
232			$iter = new \RecursiveDirectoryIterator($sourceDir);
233			$iter = new \RecursiveIteratorIterator($iter);
234
235			$this->startSection('autoloader');
236			$this->debug('Creating classmap autoloader');
237			$this->debug("Collecting valid PHP files from {$this->stageDir}");
238
239			$classMap = array();
240			foreach ($iter as $file) {
241			if ($file->getExtension() == 'php') {
242			$location = str_replace($this->stageDir . '/', '', (string) $file);
243			$className = str_replace('/', '\\', $location);
244			$className = substr($className, 0, -4);
245
246			// Remove "src\" or "lib\"
247			if (strpos($className, 'src\\') === 0
248			\|\| strpos($className, 'lib\\') === 0
249			) {
250			$className = substr($className, 4);
251			}
252
253			$classMap[$className] = "__DIR__ . '/$location'";
254			$this->debug("Found $className");
255			}
256			}
257
258			$destFile = $this->stageDir . '/' . $filename;
259			$this->debug("Writing autoloader to {$destFile}");
260
261			if (!($h = fopen($destFile, 'w'))) {
262			throw new \RuntimeException('Unable to open file for writing');
263			}
264
265			$this->debug('Writing classmap files');
266			fwrite($h, "<?php\n\n");
267			fwrite($h, "\$mapping = array(\n");
268			foreach ($classMap as $c => $f) {
269			fwrite($h, " '$c' => $f,\n");
270			}
271			fwrite($h, ");\n\n");
272			fwrite($h, <<<EOT
273			spl_autoload_register(function (\$class) use (\$mapping) {
274			if (isset(\$mapping[\$class])) {
275			require \$mapping[\$class];
276			}
277			}, true);
278
279			EOT
280			);
281
282			fwrite($h, "\n");
283
284			$this->debug('Writing automatically included files');
285			foreach ($files as $file) {
286			fwrite($h, "require __DIR__ . '/$file';\n");
287			}
288
289			fclose($h);
290
291			$this->endSection();
292			}
293
294			/**
295			* Creates a default stub for the phar that includeds the generated
296			* autoloader.
297			*
298			* This phar also registers a constant that can be used to check if you
299			* are running the phar. The constant is the basename of the $dest variable
300			* without the extension, with "_PHAR" appended, then converted to all
301			* caps (e.g., "/foo/guzzle.phar" gets a contant defined as GUZZLE_PHAR.
302			*
303			* @param $dest
304			* @param string $autoloaderFilename Name of the autoloader file.
305			* @param string $alias The phar alias to use
306			*
307			* @return string
308			*/
309			private function createStub($dest, $autoloaderFilename = 'autoloader.php', $alias = null)
310			{
311			$this->startSection('stub');
312			$this->debug("Creating phar stub at $dest");
313
314			$alias = $alias ?: basename($dest);
315			$constName = strtoupper(str_replace('.phar', '', $alias)) . '_PHAR';
316			$stub = "<?php\n";
317			$stub .= "define('$constName', true);\n";
318			$stub .= "Phar::mapPhar('$alias');\n";
319			$stub .= "require 'phar://$alias/{$autoloaderFilename}';\n";
320			$stub .= "__HALT_COMPILER();\n";
321			$this->endSection();
322
323			return $stub;
324			}
325
326			/**
327			* Creates a phar that automatically registers an autoloader.
328			*
329			* Call this only after your staging directory is built.
330			*
331			* @param string $dest Where to save the file. The basename of the file
332			* is also used as the alias name in the phar
333			* (e.g., /path/to/guzzle.phar => guzzle.phar).
334			* @param string\|bool\|null $stub The path to the phar stub file. Pass or
335			* leave null to automatically have one created for you. Pass false
336			* to no use a stub in the generated phar.
337			* @param string $autoloaderFilename Name of the autolaoder filename.
338			*/
339			public function createPhar(
340			$dest,
341			$stub = null,
342			$autoloaderFilename = 'autoloader.php',
343			$alias = null
344			) {
345			$this->startSection('phar');
346			$this->debug("Creating phar file at $dest");
347			$this->createDirIfNeeded(dirname($dest));
348			$phar = new \Phar($dest, 0, $alias ?: basename($dest));
349			$phar->buildFromDirectory($this->stageDir);
350
351			if ($stub !== false) {
352			if (!$stub) {
353			$stub = $this->createStub($dest, $autoloaderFilename, $alias);
354			}
355			$phar->setStub($stub);
356			}
357
358			$this->debug("Created phar at $dest");
359			$this->endSection();
360			}
361
362			/**
363			* Creates a zip file containing the staged files of your project.
364			*
365			* Call this only after your staging directory is built.
366			*
367			* @param string $dest Where to save the zip file
368			*/
369			public function createZip($dest)
370			{
371			$this->startSection('zip');
372			$this->debug("Creating a zip file at $dest");
373			$this->createDirIfNeeded(dirname($dest));
374			chdir($this->stageDir);
375			$this->exec("zip -r $dest ./");
376			$this->debug(" > Created at $dest");
377			chdir(__DIR__);
378			$this->endSection();
379			}
380
381			private function createDirIfNeeded($dir)
382			{
383			if (!is_dir($dir) && !mkdir($dir, 0755, true)) {
384			throw new \RuntimeException("Could not create dir: $dir");
385			}
386			}
387			}
388

thematicmedia / habrahabr_api

Push — master ( da4eab...706813 )

Burgomaster::debug() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like