TechnicalDebt::getErrorList() - Code Metrics - corretgecom/PHPCI - Measure and Improve Code Quality continuously with Scrutinizer

TechnicalDebt::getErrorList() C
last analyzed 2016-03-21 16:45 UTC

↳ Parent: TechnicalDebt

Complexity

Conditions	9
Paths	52

Size

Total Lines	62
Code Lines	39

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	90

Importance

Changes	3
Bugs	2	Features	0

Metric	Value
c	3
b	2
f	0
dl	0
loc	62
ccs	0
cts	46
cp	0
rs	6.6867
cc	9
eloc	39
nc	52
nop	0
crap	90

How to fix Long Method

<?php
/**
 * PHPCI - Continuous Integration for PHP.
 *
 * @copyright    Copyright 2014, Block 8 Limited.
 * @license      https://github.com/Block8/PHPCI/blob/master/LICENSE.md
 *
 * @link         https://www.phptesting.org/
 */

namespace PHPCI\Plugin;

use PHPCI;
use PHPCI\Builder;
use PHPCI\Model\Build;

/**
 * Technical Debt Plugin - Checks for existence of "TODO", "FIXME", etc.
 *
 * @author       James Inman <[email protected]>
 */
class TechnicalDebt implements PHPCI\Plugin, PHPCI\ZeroConfigPlugin
{
    /**
     * @var \PHPCI\Builder
     */
    protected $phpci;

    /**
     * @var array
     */
    protected $suffixes;

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

    /**
     * @var int
     */
    protected $allowed_errors;

    /**
     * @var string, based on the assumption the root may not hold the code to be
     *              tested, extends the base path
     */
    protected $path;

    /**
     * @var array - paths to ignore
     */
    protected $ignore;

    /**
     * @var array - terms to search for
     */
    protected $searches;

    /**
     * @var Build
     */
    protected $build;

    /**
     * Check if this plugin can be executed.
     *
     * @param $stage
     * @param Builder $builder
     * @param Build   $build
     *
     * @return bool
     */
    public static function canExecute($stage, Builder $builder, Build $build)
    {
        if ($stage == 'test') {
            return true;
        }

        return false;
    }

    /**
     * @param \PHPCI\Builder     $phpci
     * @param \PHPCI\Model\Build $build
     * @param array              $options
     */
    public function __construct(Builder $phpci, Build $build, array $options = array())
    {
        $this->phpci = $phpci;
        $this->build = $build;
        $this->suffixes = array('php');
        $this->directory = $phpci->buildPath;
        $this->path = '';
        $this->ignore = $this->phpci->ignore;
        $this->allowed_errors = 0;
        $this->searches = array('TODO', 'FIXME', 'TO DO', 'FIX ME');

        if (isset($options['searches']) && is_array($options['searches'])) {
            $this->searches = $options['searches'];
        }

        if (isset($options['zero_config']) && $options['zero_config']) {
            $this->allowed_errors = -1;
        }

        $this->setOptions($options);
    }

    /**
     * Handle this plugin's options.
     *
     * @param $options
     */
    protected function setOptions($options)
    {
        foreach (array('directory', 'path', 'ignore', 'allowed_errors') as $key) {
            if (array_key_exists($key, $options)) {
                $this->{$key} = $options[$key];
            }
        }
    }

    /**
     * Runs the plugin.
     */
    public function execute()
    {
        $success = true;
        $this->phpci->logExecOutput(false);

        $errorCount = $this->getErrorList();

        $this->phpci->log("Found $errorCount instances of ".implode(', ', $this->searches));

        $this->build->storeMeta('technical_debt-warnings', $errorCount);

        if ($this->allowed_errors != -1 && $errorCount > $this->allowed_errors) {
            $success = false;
        }

        return $success;
    }

    /**
     * Gets the number and list of errors returned from the search.
     *
     * @return array
     */
    public function getErrorList()
    {
        $dirIterator = new \RecursiveDirectoryIterator($this->directory);
        $iterator = new \RecursiveIteratorIterator($dirIterator, \RecursiveIteratorIterator::SELF_FIRST);
        $files = array();

        $ignores = $this->ignore;
        $ignores[] = 'phpci.yml';
        $ignores[] = '.phpci.yml';

        foreach ($iterator as $file) {
            $filePath = $file->getRealPath();
            $skipFile = false;
            foreach ($ignores as $ignore) {
                if (stripos($filePath, $ignore) !== false) {
                    $skipFile = true;
                    break;
                }
            }

            // Ignore hidden files, else .git, .sass_cache, etc. all get looped over
            if (stripos($filePath, DIRECTORY_SEPARATOR.'.') !== false) {
                $skipFile = true;
            }

            if ($skipFile == false) {

                $files[] = $file->getRealPath();
            }
        }

        $files = array_filter(array_unique($files));
        $errorCount = 0;

        foreach ($files as $file) {
            foreach ($this->searches as $search) {
                $fileContent = file_get_contents($file);
                $allLines = explode(PHP_EOL, $fileContent);
                $beforeString = strstr($fileContent, $search, true);

                if (false !== $beforeString) {
                    $lines = explode(PHP_EOL, $beforeString);
                    $lineNumber = count($lines);
                    $content = trim($allLines[$lineNumber - 1]);

                    ++$errorCount;

                    $fileName = str_replace($this->directory, '', $file);

                    $this->build->reportError(
                        $this->phpci,
                        'technical_debt',
                        $content,
                        PHPCI\Model\BuildError::SEVERITY_LOW,
                        $fileName,
                        $lineNumber
                    );
                }
            }
        }

        return $errorCount;
    }
}


1			<?php
2			/**
3			* PHPCI - Continuous Integration for PHP.
4			*
5			* @copyright Copyright 2014, Block 8 Limited.
6			* @license https://github.com/Block8/PHPCI/blob/master/LICENSE.md
7			*
8			* @link https://www.phptesting.org/
9			*/
10
11			namespace PHPCI\Plugin;
12
13			use PHPCI;
14			use PHPCI\Builder;
15			use PHPCI\Model\Build;
16
17			/**
18			* Technical Debt Plugin - Checks for existence of "TODO", "FIXME", etc.
19			*
20			* @author James Inman <[email protected]>
21			*/
22			class TechnicalDebt implements PHPCI\Plugin, PHPCI\ZeroConfigPlugin
23			{
24			/**
25			* @var \PHPCI\Builder
26			*/
27			protected $phpci;
28
29			/**
30			* @var array
31			*/
32			protected $suffixes;
33
34			/**
35			* @var string
36			*/
37			protected $directory;
38
39			/**
40			* @var int
41			*/
42			protected $allowed_errors;
43
44			/**
45			* @var string, based on the assumption the root may not hold the code to be
46			* tested, extends the base path
47			*/
48			protected $path;
49
50			/**
51			* @var array - paths to ignore
52			*/
53			protected $ignore;
54
55			/**
56			* @var array - terms to search for
57			*/
58			protected $searches;
59
60			/**
61			* @var Build
62			*/
63			protected $build;
64
65			/**
66			* Check if this plugin can be executed.
67			*
68			* @param $stage
69			* @param Builder $builder
70			* @param Build $build
71			*
72			* @return bool
73			*/
74			public static function canExecute($stage, Builder $builder, Build $build)
75			{
76			if ($stage == 'test') {
77			return true;
78			}
79
80			return false;
81			}
82
83			/**
84			* @param \PHPCI\Builder $phpci
85			* @param \PHPCI\Model\Build $build
86			* @param array $options
87			*/
88			public function __construct(Builder $phpci, Build $build, array $options = array())
89			{
90			$this->phpci = $phpci;
91			$this->build = $build;
92			$this->suffixes = array('php');
93			$this->directory = $phpci->buildPath;
94			$this->path = '';
95			$this->ignore = $this->phpci->ignore;
96			$this->allowed_errors = 0;
97			$this->searches = array('TODO', 'FIXME', 'TO DO', 'FIX ME');
98
99			if (isset($options['searches']) && is_array($options['searches'])) {
100			$this->searches = $options['searches'];
101			}
102
103			if (isset($options['zero_config']) && $options['zero_config']) {
104			$this->allowed_errors = -1;
105			}
106
107			$this->setOptions($options);
108			}
109
110			/**
111			* Handle this plugin's options.
112			*
113			* @param $options
114			*/
115			protected function setOptions($options)
116			{
117			foreach (array('directory', 'path', 'ignore', 'allowed_errors') as $key) {
118			if (array_key_exists($key, $options)) {
119			$this->{$key} = $options[$key];
120			}
121			}
122			}
123
124			/**
125			* Runs the plugin.
126			*/
127			public function execute()
128			{
129			$success = true;
130			$this->phpci->logExecOutput(false);
131
132			$errorCount = $this->getErrorList();
133
134			$this->phpci->log("Found $errorCount instances of ".implode(', ', $this->searches));
135
136			$this->build->storeMeta('technical_debt-warnings', $errorCount);
137
138			if ($this->allowed_errors != -1 && $errorCount > $this->allowed_errors) {
139			$success = false;
140			}
141
142			return $success;
143			}
144
145			/**
146			* Gets the number and list of errors returned from the search.
147			*
148			* @return array
149			*/
150			public function getErrorList()
151			{
152			$dirIterator = new \RecursiveDirectoryIterator($this->directory);
153			$iterator = new \RecursiveIteratorIterator($dirIterator, \RecursiveIteratorIterator::SELF_FIRST);
154			$files = array();
155
156			$ignores = $this->ignore;
157			$ignores[] = 'phpci.yml';
158			$ignores[] = '.phpci.yml';
159
160			foreach ($iterator as $file) {
161			$filePath = $file->getRealPath();
162			$skipFile = false;
163			foreach ($ignores as $ignore) {
164			if (stripos($filePath, $ignore) !== false) {
165			$skipFile = true;
166			break;
167			}
168			}
169
170			// Ignore hidden files, else .git, .sass_cache, etc. all get looped over
171			if (stripos($filePath, DIRECTORY_SEPARATOR.'.') !== false) {
172			$skipFile = true;
173			}
174
175			if ($skipFile == false) {
			0 ignored issues – show Coding Style Best Practice introduced 2016-03-16 21:14 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing two booleans. Considering using the strict comparison `===` instead. When comparing two booleans, it is generally considered safer to use the strict comparison operator. Loading history...
176			$files[] = $file->getRealPath();
177			}
178			}
179
180			$files = array_filter(array_unique($files));
181			$errorCount = 0;
182
183			foreach ($files as $file) {
184			foreach ($this->searches as $search) {
185			$fileContent = file_get_contents($file);
186			$allLines = explode(PHP_EOL, $fileContent);
187			$beforeString = strstr($fileContent, $search, true);
188
189			if (false !== $beforeString) {
190			$lines = explode(PHP_EOL, $beforeString);
191			$lineNumber = count($lines);
192			$content = trim($allLines[$lineNumber - 1]);
193
194			++$errorCount;
195
196			$fileName = str_replace($this->directory, '', $file);
197
198			$this->build->reportError(
199			$this->phpci,
200			'technical_debt',
201			$content,
202			PHPCI\Model\BuildError::SEVERITY_LOW,
203			$fileName,
204			$lineNumber
205			);
206			}
207			}
208			}
209
210			return $errorCount;
211			}
212			}
213

corretgecom / PHPCI

TechnicalDebt::getErrorList() C last analyzed 2016-03-21 16:45 UTC

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like

TechnicalDebt::getErrorList() C
last analyzed 2016-03-21 16:45 UTC