PHPLocTask::isFileSuffixSet() - Code Metrics - Inspection of "Require PHP 7.3+" - phingofficial/phing - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( fedd27...f10ad5 )

by Michiel

created 2020-03-17 12:11 UTC

PHPLocTask::isFileSuffixSet() A

↳ Parent: PHPLocTask

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	1
dl	0
loc	3
ccs	0
cts	2
cp	0
crap	2
rs	10
c	0
b	0
f	0

<?php
/**
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the LGPL. For more information please see
 * <http://phing.info>.
 */

/**
 * Runs phploc a tool for quickly measuring the size of PHP projects.
 *
 * @package phing.tasks.ext.phploc
 * @author  Raphael Stolt <[email protected]>
 */
class PHPLocTask extends Task
{
    use FileSetAware;

    /**
     * @var array
     */
    protected $suffixesToCheck = ['php'];

    /**
     * @var array
     */
    protected $acceptedReportTypes = ['cli', 'txt', 'xml', 'csv'];

    /**
     * @var null
     */
    protected $reportDirectory = null;

    /**
     * @var string
     */
    protected $reportType = 'cli';

    /**
     * @var string
     */
    protected $reportFileName = 'phploc-report';

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

    /**
     * @var null|PhingFile
     */
    protected $fileToCheck = null;

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

    /**
     * @var PHPLocFormatterElement[]
     */
    protected $formatterElements = [];

    /**
     * @var string
     */
    private $pharLocation = "";

    /**
     * @param string $suffixListOrSingleSuffix
     */
    public function setSuffixes($suffixListOrSingleSuffix)
    {
        if (strpos($suffixListOrSingleSuffix, ',')) {
            $suffixes = explode(',', $suffixListOrSingleSuffix);
            $this->suffixesToCheck = array_map('trim', $suffixes);
        } else {
            $this->suffixesToCheck[] = trim($suffixListOrSingleSuffix);
        }
    }

    /**
     * @param PhingFile $file
     */
    public function setFile(PhingFile $file)
    {
        $this->fileToCheck = trim($file);

    }

    /**
     * @param boolean $countTests
     */
    public function setCountTests($countTests)
    {
        $this->countTests = StringHelper::booleanValue($countTests);
    }

    /**
     * @param string $type
     */
    public function setReportType($type)
    {
        $this->reportType = trim($type);
    }

    /**
     * @param string $name
     */
    public function setReportName($name)
    {
        $this->reportFileName = trim($name);
    }

    /**
     * @param string $directory
     */
    public function setReportDirectory($directory)
    {
        $this->reportDirectory = trim($directory);

    }

    /**
     * @param string $pharLocation
     */
    public function setPharLocation($pharLocation)
    {
        $this->pharLocation = $pharLocation;
    }

    /**
     * @param PHPLocFormatterElement $formatterElement
     */
    public function addFormatter(PHPLocFormatterElement $formatterElement)
    {
        $this->formatterElements[] = $formatterElement;
    }

    /**
     * @throws BuildException
     */
    protected function loadDependencies()
    {
        if (!empty($this->pharLocation)) {
            // hack to prevent PHPLOC from starting in CLI mode and halting Phing
            eval(

                "namespace SebastianBergmann\PHPLOC\CLI;
class Application
{
    public function run() {}
}"
            );

            ob_start();
            include $this->pharLocation;
            ob_end_clean();
        }

        if (!class_exists('\SebastianBergmann\PHPLOC\Analyser')) {
            if (!@include_once 'SebastianBergmann/PHPLOC/autoload.php') {
                throw new BuildException(
                    'PHPLocTask depends on PHPLoc being installed and on include_path.',
                    $this->getLocation()
                );
            }
        }
    }

    public function main()
    {
        $this->loadDependencies();

        $this->validateProperties();

        if (count($this->filesets) > 0) {
            foreach ($this->filesets as $fileSet) {
                $directoryScanner = $fileSet->getDirectoryScanner($this->project);
                $files = $directoryScanner->getIncludedFiles();
                $directory = $fileSet->getDir($this->project)->getPath();

                foreach ($files as $file) {
                    if ($this->isFileSuffixSet($file)) {
                        $this->filesToCheck[] = $directory . DIRECTORY_SEPARATOR . $file;
                    }
                }
            }

            $this->filesToCheck = array_unique($this->filesToCheck);
        }

        $this->runPhpLocCheck();
    }

    /**
     * @throws BuildException
     */
    private function validateProperties()
    {
        if ($this->fileToCheck === null && count($this->filesets) === 0) {
            throw new BuildException('Missing either a nested fileset or the attribute "file" set.');
        }

        if ($this->fileToCheck !== null) {
            if (!file_exists($this->fileToCheck)) {
                throw new BuildException("File to check doesn't exist.");
            }

            if (!$this->isFileSuffixSet($this->fileToCheck)) {
                throw new BuildException('Suffix of file to check is not defined in "suffixes" attribute.');
            }

            if (count($this->filesets) > 0) {
                throw new BuildException('Either use a nested fileset or "file" attribute; not both.');
            }
        }

        if (count($this->suffixesToCheck) === 0) {
            throw new BuildException('No file suffix defined.');
        }

        if (count($this->formatterElements) == 0) {
            if ($this->reportType === null) {
                throw new BuildException('No report type or formatters defined.');
            }

            if ($this->reportType !== null && !in_array($this->reportType, $this->acceptedReportTypes)) {
                throw new BuildException('Unaccepted report type defined.');
            }

            if ($this->reportType !== 'cli' && $this->reportDirectory === null) {
                throw new BuildException('No report output directory defined.');
            }

            if ($this->reportDirectory !== null && !is_dir($this->reportDirectory)) {
                $reportOutputDir = new PhingFile($this->reportDirectory);

                $logMessage = "Report output directory doesn't exist, creating: "
                    . $reportOutputDir->getAbsolutePath() . '.';

                $this->log($logMessage);
                $reportOutputDir->mkdirs();
            }

            if ($this->reportType !== 'cli') {
                $this->reportFileName .= '.' . $this->reportType;
            }

            $formatterElement = new PHPLocFormatterElement();
            $formatterElement->setType($this->reportType);
            $formatterElement->setUseFile($this->reportDirectory !== null);
            $formatterElement->setToDir($this->reportDirectory);
            $formatterElement->setOutfile($this->reportFileName);
            $this->formatterElements[] = $formatterElement;
        }
    }

    /**
     * @param string $filename
     *
     * @return boolean
     */
    protected function isFileSuffixSet($filename)
    {
        return in_array(pathinfo($filename, PATHINFO_EXTENSION), $this->suffixesToCheck);
    }

    protected function runPhpLocCheck()
    {
        $files = $this->getFilesToCheck();
        $count = $this->getCountForFiles($files);

        foreach ($this->formatterElements as $formatterElement) {
            $formatter = PHPLocFormatterFactory::createFormatter($formatterElement);

            if ($formatterElement->getType() != 'cli') {
                $logMessage = 'Writing report to: '
                    . $formatterElement->getToDir() . DIRECTORY_SEPARATOR . $formatterElement->getOutfile();

                $this->log($logMessage);
            }

            $formatter->printResult($count, $this->countTests);
        }
    }

    /**
     * @return SplFileInfo[]
     */
    protected function getFilesToCheck()
    {
        $files = [];

        if (count($this->filesToCheck) > 0) {
            foreach ($this->filesToCheck as $file) {
                $files[] = new SplFileInfo($file);
            }
        } elseif ($this->fileToCheck !== null) {
            $files = [new SplFileInfo($this->fileToCheck)];
        }

        return $files;
    }

    /**
     * @param SplFileInfo[] $files
     *
     * @return array
     */
    protected function getCountForFiles(array $files)
    {
        $analyserClass = '\\SebastianBergmann\\PHPLOC\\Analyser';
        $analyser = new $analyserClass();

        return $analyser->countFiles($files, $this->countTests);
    }
}


1			<?php
2			/**
3			* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
4			* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
5			* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
6			* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7			* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
8			* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
9			* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
10			* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
11			* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
12			* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
13			* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
14			*
15			* This software consists of voluntary contributions made by many individuals
16			* and is licensed under the LGPL. For more information please see
17			* <http://phing.info>.
18			*/
19
20			/**
21			* Runs phploc a tool for quickly measuring the size of PHP projects.
22			*
23			* @package phing.tasks.ext.phploc
24			* @author Raphael Stolt <[email protected]>
25			*/
26			class PHPLocTask extends Task
27			{
28			use FileSetAware;
29
30			/**
31			* @var array
32			*/
33			protected $suffixesToCheck = ['php'];
34
35			/**
36			* @var array
37			*/
38			protected $acceptedReportTypes = ['cli', 'txt', 'xml', 'csv'];
39
40			/**
41			* @var null
42			*/
43			protected $reportDirectory = null;
44
45			/**
46			* @var string
47			*/
48			protected $reportType = 'cli';
49
50			/**
51			* @var string
52			*/
53			protected $reportFileName = 'phploc-report';
54
55			/**
56			* @var bool
57			*/
58			protected $countTests = false;
59
60			/**
61			* @var null\|PhingFile
62			*/
63			protected $fileToCheck = null;
64
65			/**
66			* @var array
67			*/
68			protected $filesToCheck = [];
69
70			/**
71			* @var PHPLocFormatterElement[]
72			*/
73			protected $formatterElements = [];
74
75			/**
76			* @var string
77			*/
78			private $pharLocation = "";
79
80			/**
81			* @param string $suffixListOrSingleSuffix
82			*/
83			public function setSuffixes($suffixListOrSingleSuffix)
84			{
85			if (strpos($suffixListOrSingleSuffix, ',')) {
86			$suffixes = explode(',', $suffixListOrSingleSuffix);
87			$this->suffixesToCheck = array_map('trim', $suffixes);
88			} else {
89			$this->suffixesToCheck[] = trim($suffixListOrSingleSuffix);
90			}
91			}
92
93			/**
94			* @param PhingFile $file
95			*/
96			public function setFile(PhingFile $file)
97			{
98			$this->fileToCheck = trim($file);
			0 ignored issues – show Documentation Bug introduced 2019-07-31 09:36 UTC by Report Bug Copy Issue Report It seems like `trim($file)` of type `string` is incompatible with the declared type `PhingFile\|null` of property `$fileToCheck`. 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...
99			}
100
101			/**
102			* @param boolean $countTests
103			*/
104			public function setCountTests($countTests)
105			{
106			$this->countTests = StringHelper::booleanValue($countTests);
107			}
108
109			/**
110			* @param string $type
111			*/
112			public function setReportType($type)
113			{
114			$this->reportType = trim($type);
115			}
116
117			/**
118			* @param string $name
119			*/
120			public function setReportName($name)
121			{
122			$this->reportFileName = trim($name);
123			}
124
125			/**
126			* @param string $directory
127			*/
128			public function setReportDirectory($directory)
129			{
130			$this->reportDirectory = trim($directory);
			0 ignored issues – show Documentation Bug introduced 2019-07-31 09:36 UTC by Report Bug Copy Issue Report It seems like `trim($directory)` of type `string` is incompatible with the declared type `null` of property `$reportDirectory`. 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...
131			}
132
133			/**
134			* @param string $pharLocation
135			*/
136			public function setPharLocation($pharLocation)
137			{
138			$this->pharLocation = $pharLocation;
139			}
140
141			/**
142			* @param PHPLocFormatterElement $formatterElement
143			*/
144			public function addFormatter(PHPLocFormatterElement $formatterElement)
145			{
146			$this->formatterElements[] = $formatterElement;
147			}
148
149			/**
150			* @throws BuildException
151			*/
152			protected function loadDependencies()
153			{
154			if (!empty($this->pharLocation)) {
155			// hack to prevent PHPLOC from starting in CLI mode and halting Phing
156			eval(
			0 ignored issues – show introduced 2019-07-31 09:36 UTC by Report Bug Copy Issue Report The use of eval() is discouraged. Loading history...
157			"namespace SebastianBergmann\PHPLOC\CLI;
158			class Application
159			{
160			public function run() {}
161			}"
162			);
163
164			ob_start();
165			include $this->pharLocation;
166			ob_end_clean();
167			}
168
169			if (!class_exists('\SebastianBergmann\PHPLOC\Analyser')) {
170			if (!@include_once 'SebastianBergmann/PHPLOC/autoload.php') {
171			throw new BuildException(
172			'PHPLocTask depends on PHPLoc being installed and on include_path.',
173			$this->getLocation()
174			);
175			}
176			}
177			}
178
179			public function main()
180			{
181			$this->loadDependencies();
182
183			$this->validateProperties();
184
185			if (count($this->filesets) > 0) {
186			foreach ($this->filesets as $fileSet) {
187			$directoryScanner = $fileSet->getDirectoryScanner($this->project);
188			$files = $directoryScanner->getIncludedFiles();
189			$directory = $fileSet->getDir($this->project)->getPath();
190
191			foreach ($files as $file) {
192			if ($this->isFileSuffixSet($file)) {
193			$this->filesToCheck[] = $directory . DIRECTORY_SEPARATOR . $file;
194			}
195			}
196			}
197
198			$this->filesToCheck = array_unique($this->filesToCheck);
199			}
200
201			$this->runPhpLocCheck();
202			}
203
204			/**
205			* @throws BuildException
206			*/
207			private function validateProperties()
208			{
209			if ($this->fileToCheck === null && count($this->filesets) === 0) {
210			throw new BuildException('Missing either a nested fileset or the attribute "file" set.');
211			}
212
213			if ($this->fileToCheck !== null) {
214			if (!file_exists($this->fileToCheck)) {
215			throw new BuildException("File to check doesn't exist.");
216			}
217
218			if (!$this->isFileSuffixSet($this->fileToCheck)) {
219			throw new BuildException('Suffix of file to check is not defined in "suffixes" attribute.');
220			}
221
222			if (count($this->filesets) > 0) {
223			throw new BuildException('Either use a nested fileset or "file" attribute; not both.');
224			}
225			}
226
227			if (count($this->suffixesToCheck) === 0) {
228			throw new BuildException('No file suffix defined.');
229			}
230
231			if (count($this->formatterElements) == 0) {
232			if ($this->reportType === null) {
233			throw new BuildException('No report type or formatters defined.');
234			}
235
236			if ($this->reportType !== null && !in_array($this->reportType, $this->acceptedReportTypes)) {
237			throw new BuildException('Unaccepted report type defined.');
238			}
239
240			if ($this->reportType !== 'cli' && $this->reportDirectory === null) {
241			throw new BuildException('No report output directory defined.');
242			}
243
244			if ($this->reportDirectory !== null && !is_dir($this->reportDirectory)) {
245			$reportOutputDir = new PhingFile($this->reportDirectory);
246
247			$logMessage = "Report output directory doesn't exist, creating: "
248			. $reportOutputDir->getAbsolutePath() . '.';
249
250			$this->log($logMessage);
251			$reportOutputDir->mkdirs();
252			}
253
254			if ($this->reportType !== 'cli') {
255			$this->reportFileName .= '.' . $this->reportType;
256			}
257
258			$formatterElement = new PHPLocFormatterElement();
259			$formatterElement->setType($this->reportType);
260			$formatterElement->setUseFile($this->reportDirectory !== null);
261			$formatterElement->setToDir($this->reportDirectory);
262			$formatterElement->setOutfile($this->reportFileName);
263			$this->formatterElements[] = $formatterElement;
264			}
265			}
266
267			/**
268			* @param string $filename
269			*
270			* @return boolean
271			*/
272			protected function isFileSuffixSet($filename)
273			{
274			return in_array(pathinfo($filename, PATHINFO_EXTENSION), $this->suffixesToCheck);
275			}
276
277			protected function runPhpLocCheck()
278			{
279			$files = $this->getFilesToCheck();
280			$count = $this->getCountForFiles($files);
281
282			foreach ($this->formatterElements as $formatterElement) {
283			$formatter = PHPLocFormatterFactory::createFormatter($formatterElement);
284
285			if ($formatterElement->getType() != 'cli') {
286			$logMessage = 'Writing report to: '
287			. $formatterElement->getToDir() . DIRECTORY_SEPARATOR . $formatterElement->getOutfile();
288
289			$this->log($logMessage);
290			}
291
292			$formatter->printResult($count, $this->countTests);
293			}
294			}
295
296			/**
297			* @return SplFileInfo[]
298			*/
299			protected function getFilesToCheck()
300			{
301			$files = [];
302
303			if (count($this->filesToCheck) > 0) {
304			foreach ($this->filesToCheck as $file) {
305			$files[] = new SplFileInfo($file);
306			}
307			} elseif ($this->fileToCheck !== null) {
308			$files = [new SplFileInfo($this->fileToCheck)];
309			}
310
311			return $files;
312			}
313
314			/**
315			* @param SplFileInfo[] $files
316			*
317			* @return array
318			*/
319			protected function getCountForFiles(array $files)
320			{
321			$analyserClass = '\\SebastianBergmann\\PHPLOC\\Analyser';
322			$analyser = new $analyserClass();
323
324			return $analyser->countFiles($files, $this->countTests);
325			}
326			}
327

phingofficial / phing

Push — master ( fedd27...f10ad5 )

PHPLocTask::isFileSuffixSet() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like