DirectoryConverter::cleanDestinationDirectory() - Code Metrics - Inspection of "Clean destination directory before code conversion" - spatie/7to5 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#38)

by Andrey

created 2018-04-08 13:29 UTC

DirectoryConverter::cleanDestinationDirectory() A

↳ Parent: DirectoryConverter

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	0

<?php

namespace Spatie\Php7to5;

use Spatie\Php7to5\Exceptions\InvalidParameter;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Finder\Finder;

class DirectoryConverter
{
    /** @var string */
    protected $sourceDirectory;
    /** @var string */
    protected $copyNonPhpFiles = true;
    /** @var bool */
    protected $cleanDestinationDirectory = false;
    /** @var string[] */
    protected $extensions;
    /** @var null|string[] */
    protected $excludes;
    protected $logger;

    /**
     * DirectoryConverter constructor.
     *
     * @param string $sourceDirectory
     * @param string[] $extensions
     * @param string[]|null $excludes
     *
     * @throws \Spatie\Php7to5\Exceptions\InvalidParameter
     */
    public function __construct($sourceDirectory, array $extensions, array $excludes = null)
    {
        if (!file_exists($sourceDirectory)) {
            throw InvalidParameter::directoryDoesNotExist($sourceDirectory);
        }

        $this->sourceDirectory = $sourceDirectory;
        $this->extensions = array_map('mb_strtolower', $extensions);
        $this->excludes = $excludes;
    }

    public function setLogger(OutputInterface $output)
    {
        $this->logger = $output;
    }

    public function log($sourceItem, $target)
    {
        if (is_null($this->logger)) {
            return;
        }
        $targetRealPath = realpath($target);

        $this->logger->writeln("<comment>Converting {$sourceItem} to {$targetRealPath}...</comment>");
    }

    /**
     * @return $this
     */
    public function alsoCopyNonPhpFiles()
    {
        $this->copyNonPhpFiles = true;
$answer = 42;

$correct = false;

$correct = (bool) $answer;

        return $this;
    }

    /**
     * @return $this
     */
    public function cleanDestinationDirectory()
    {
        $this->cleanDestinationDirectory = true;

        return $this;
    }

    /**
     * @return $this
     */
    public function doNotCopyNonPhpFiles()
    {
        $this->copyNonPhpFiles = false;
$answer = 42;

$correct = false;

$correct = (bool) $answer;

        return $this;
    }

    /**
     * @param string $destinationDirectory
     *
     * @throws \Spatie\Php7to5\Exceptions\InvalidParameter
     */
    public function savePhp5FilesTo($destinationDirectory)
    {
        if ($destinationDirectory === '') {
            throw InvalidParameter::directoryIsRequired();
        }

        if($this->cleanDestinationDirectory){
            $this->removeDirectory($destinationDirectory);
        }

        $this->copyDirectory($this->sourceDirectory, $destinationDirectory);
    }

    /**
     * @param string $sourceDirectory
     * @param string $destinationDirectory
     */
    protected function copyDirectory($sourceDirectory, $destinationDirectory)
    {
        if (!is_dir($destinationDirectory)) {
            mkdir($destinationDirectory);
        }

        $finder = new Finder();
        $finder->in($sourceDirectory);
        if (!$this->copyNonPhpFiles) {
            foreach ($this->extensions as $extension) {
                $finder->name('*.'.$extension);
            }
        }

        if ($this->excludes) {
            foreach ($this->excludes as $exclude) {
                $finder->notPath('/^'.preg_quote($exclude, '/').'/');
            }
        }

        foreach ($finder as $item) {
            $target = $destinationDirectory.'/'.$item->getRelativePathname();

            if ($item->isFile()) {
                $isPhpFile = $this->isPhpFile($target);
                if ($isPhpFile || $this->copyNonPhpFiles) {
                    $targetDir = dirname($target);
                    if ($targetDir && !is_dir($targetDir)) {
                        mkdir($targetDir, 0755, true);
                    }
                    copy($item->getRealPath(), $target);

                    $this->log($item->getRelativePath(), $target);

                    if ($isPhpFile) {
                        $this->convertToPhp5($target);
                    }
                }
            }
        }
    }

    /**
     * @param string $path
     */
    protected function removeDirectory($path)
    {
        if (PHP_OS === 'Windows') {
            $command = 'rd /s /q %s';
        } else {
            $command = 'rm -rf %s';
        }

        exec(sprintf($command, escapeshellarg($path)));
    }

    /**
     * @param string $filePath
     */
    protected function convertToPhp5($filePath)
    {
        $converter = new Converter($filePath);

        $converter->saveAsPhp5($filePath);
    }

    /**
     * @param string $filePath
     *
     * @return bool
     */
    protected function isPhpFile($filePath)
    {
        return in_array(strtolower(pathinfo($filePath, PATHINFO_EXTENSION)), $this->extensions, true);
    }
}


1			<?php
2
3			namespace Spatie\Php7to5;
4
5			use Spatie\Php7to5\Exceptions\InvalidParameter;
6			use Symfony\Component\Console\Output\OutputInterface;
7			use Symfony\Component\Finder\Finder;
8
9			class DirectoryConverter
10			{
11			/** @var string */
12			protected $sourceDirectory;
13			/** @var string */
14			protected $copyNonPhpFiles = true;
15			/** @var bool */
16			protected $cleanDestinationDirectory = false;
17			/** @var string[] */
18			protected $extensions;
19			/** @var null\|string[] */
20			protected $excludes;
21			protected $logger;
22
23			/**
24			* DirectoryConverter constructor.
25			*
26			* @param string $sourceDirectory
27			* @param string[] $extensions
28			* @param string[]\|null $excludes
29			*
30			* @throws \Spatie\Php7to5\Exceptions\InvalidParameter
31			*/
32			public function __construct($sourceDirectory, array $extensions, array $excludes = null)
33			{
34			if (!file_exists($sourceDirectory)) {
35			throw InvalidParameter::directoryDoesNotExist($sourceDirectory);
36			}
37
38			$this->sourceDirectory = $sourceDirectory;
39			$this->extensions = array_map('mb_strtolower', $extensions);
40			$this->excludes = $excludes;
41			}
42
43			public function setLogger(OutputInterface $output)
44			{
45			$this->logger = $output;
46			}
47
48			public function log($sourceItem, $target)
49			{
50			if (is_null($this->logger)) {
51			return;
52			}
53			$targetRealPath = realpath($target);
54
55			$this->logger->writeln("<comment>Converting {$sourceItem} to {$targetRealPath}...</comment>");
56			}
57
58			/**
59			* @return $this
60			*/
61			public function alsoCopyNonPhpFiles()
62			{
63			$this->copyNonPhpFiles = true;
			0 ignored issues – show Documentation Bug introduced 2016-02-19 23:43 UTC by Report Bug Copy Issue Report The property `$copyNonPhpFiles` was declared of type `string`, but `true` is of type `boolean`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
64
65			return $this;
66			}
67
68			/**
69			* @return $this
70			*/
71			public function cleanDestinationDirectory()
72			{
73			$this->cleanDestinationDirectory = true;
74
75			return $this;
76			}
77
78			/**
79			* @return $this
80			*/
81			public function doNotCopyNonPhpFiles()
82			{
83			$this->copyNonPhpFiles = false;
			0 ignored issues – show Documentation Bug introduced 2016-02-19 23:43 UTC by Report Bug Copy Issue Report The property `$copyNonPhpFiles` was declared of type `string`, but `false` is of type `false`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
84
85			return $this;
86			}
87
88			/**
89			* @param string $destinationDirectory
90			*
91			* @throws \Spatie\Php7to5\Exceptions\InvalidParameter
92			*/
93			public function savePhp5FilesTo($destinationDirectory)
94			{
95			if ($destinationDirectory === '') {
96			throw InvalidParameter::directoryIsRequired();
97			}
98
99			if($this->cleanDestinationDirectory){
100			$this->removeDirectory($destinationDirectory);
101			}
102
103			$this->copyDirectory($this->sourceDirectory, $destinationDirectory);
104			}
105
106			/**
107			* @param string $sourceDirectory
108			* @param string $destinationDirectory
109			*/
110			protected function copyDirectory($sourceDirectory, $destinationDirectory)
111			{
112			if (!is_dir($destinationDirectory)) {
113			mkdir($destinationDirectory);
114			}
115
116			$finder = new Finder();
117			$finder->in($sourceDirectory);
118			if (!$this->copyNonPhpFiles) {
119			foreach ($this->extensions as $extension) {
120			$finder->name('*.'.$extension);
121			}
122			}
123
124			if ($this->excludes) {
125			foreach ($this->excludes as $exclude) {
126			$finder->notPath('/^'.preg_quote($exclude, '/').'/');
127			}
128			}
129
130			foreach ($finder as $item) {
131			$target = $destinationDirectory.'/'.$item->getRelativePathname();
132
133			if ($item->isFile()) {
134			$isPhpFile = $this->isPhpFile($target);
135			if ($isPhpFile \|\| $this->copyNonPhpFiles) {
136			$targetDir = dirname($target);
137			if ($targetDir && !is_dir($targetDir)) {
138			mkdir($targetDir, 0755, true);
139			}
140			copy($item->getRealPath(), $target);
141
142			$this->log($item->getRelativePath(), $target);
143
144			if ($isPhpFile) {
145			$this->convertToPhp5($target);
146			}
147			}
148			}
149			}
150			}
151
152			/**
153			* @param string $path
154			*/
155			protected function removeDirectory($path)
156			{
157			if (PHP_OS === 'Windows') {
158			$command = 'rd /s /q %s';
159			} else {
160			$command = 'rm -rf %s';
161			}
162
163			exec(sprintf($command, escapeshellarg($path)));
164			}
165
166			/**
167			* @param string $filePath
168			*/
169			protected function convertToPhp5($filePath)
170			{
171			$converter = new Converter($filePath);
172
173			$converter->saveAsPhp5($filePath);
174			}
175
176			/**
177			* @param string $filePath
178			*
179			* @return bool
180			*/
181			protected function isPhpFile($filePath)
182			{
183			return in_array(strtolower(pathinfo($filePath, PATHINFO_EXTENSION)), $this->extensions, true);
184			}
185			}
186

spatie / 7to5

Pull Request — master (#38)

DirectoryConverter::cleanDestinationDirectory() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like