diff --git a/README.md b/README.md index 5bca331..f0a78d8 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,7 @@ This tool uses [a php parser written in php](https://github.com/nikic/PHP-Parser - Find Classes/Functions with the highest cyclomatic complexity - Halstead-Metrics - Most Used Constants (Order by name or value) +- IDE-Integration (PHPStorm) ## Contributing Please see [CONTRIBUTING.md](CONTRIBUTING.md) for more information. diff --git a/src/Console/AbstractCommand.php b/src/Console/AbstractCommand.php index fba6be8..e5b2ad7 100644 --- a/src/Console/AbstractCommand.php +++ b/src/Console/AbstractCommand.php @@ -141,19 +141,19 @@ abstract class AbstractCommand extends Command private const FORMAT_PATH_LINE = '%s:%s'; /** @var string */ - protected const FORMAT_PROCESSORS_DONE_MESSAGE = 'Processors processed magic numbers. Magic numbers found: %d'; + protected const FORMAT_PROCESSORS_DONE_MESSAGE = ''; /** @var string */ - protected const FORMAT_PROCESSORS_PROGRESS_MESSAGE = 'Processor %d is processing magic numbers. Magic numbers found: %d'; // phpcs:ignore Generic.Files.LineLength.MaxExceeded + protected const FORMAT_PROCESSORS_PROGRESS_MESSAGE = ''; /** @var string */ - private const FORMAT_TO_LINE = '%s%s'; // phpcs:ignore Generic.Files.LineLength.MaxExceeded + private const FORMAT_TO_LINE = '%s%s'; /** @var string */ - private const FORMAT_VISITORS_DONE_MESSAGE = 'Visitors checked magic numbers in %d files. Magic numbers found: %d'; + protected const FORMAT_VISITORS_DONE_MESSAGE = ''; /** @var string */ - private const FORMAT_VISITORS_PROGRESS_MESSAGE = 'Visitors are checking for magic numbers in files. Magic numbers found: %d'; // phpcs:ignore Generic.Files.LineLength.MaxExceeded + protected const FORMAT_VISITORS_PROGRESS_MESSAGE = ''; /** @var string */ private const LINE_SEPARATOR = '-'; // phpcs:ignore Generic.Files.LineLength.MaxExceeded @@ -431,7 +431,7 @@ protected function parseFiles(array $files, Traverser $traverser, ProgressBar $t $traverser->setFile($file); $traverser->traverse($ast); $traverserProgressBar->setMessage(sprintf( - self::FORMAT_VISITORS_PROGRESS_MESSAGE, + static::FORMAT_VISITORS_PROGRESS_MESSAGE, $traverser->getNodeOccurrencesCount() )); } @@ -501,7 +501,7 @@ protected function processOccurrences( foreach ($this->processorRunner->process($occurrenceList) as $processorsDone) { $processorsProgressBar->setMessage(sprintf( - self::FORMAT_PROCESSORS_PROGRESS_MESSAGE, + static::FORMAT_PROCESSORS_PROGRESS_MESSAGE, $processorsDone, count($occurrenceList->getOccurrences()) )); @@ -509,7 +509,7 @@ protected function processOccurrences( } $processorsProgressBar->setMessage(sprintf( - self::FORMAT_PROCESSORS_DONE_MESSAGE, + static::FORMAT_PROCESSORS_DONE_MESSAGE, count($occurrenceList->getOccurrences()) )); $this->finishProgressBar($processorsProgressBar, $output); @@ -564,7 +564,7 @@ protected function traverseFiles( $this->parseFiles($files, $traverser, $traverserProgressBar); $traverserProgressBar->setMessage(sprintf( - self::FORMAT_VISITORS_DONE_MESSAGE, + static::FORMAT_VISITORS_DONE_MESSAGE, count($files), $traverser->getNodeOccurrencesCount() )); diff --git a/src/Console/Application.php b/src/Console/Application.php index b6704f2..48fd955 100644 --- a/src/Console/Application.php +++ b/src/Console/Application.php @@ -22,7 +22,7 @@ class Application extends BaseApplication private const APPLICATION_NAME = 'php-analyzer'; /** @var string */ - private const APPLICATION_VERSION = '1.2.4'; + private const APPLICATION_VERSION = '1.2.5'; /** @var string */ private const ARGUMENT_HELP = 'help'; diff --git a/src/Console/Command/MagicNumberDetectorCommand.php b/src/Console/Command/MagicNumberDetectorCommand.php index d59ac48..3f500fb 100644 --- a/src/Console/Command/MagicNumberDetectorCommand.php +++ b/src/Console/Command/MagicNumberDetectorCommand.php @@ -39,6 +39,18 @@ class MagicNumberDetectorCommand extends AbstractCommand /** @var string */ private const DEFAULT_VISITORS = 'Argument,Array,Assign,Condition,DefaultParameter,Operation,Property,Return,SwitchCase,Ternary'; // phpcs:ignore Generic.Files.LineLength.MaxExceeded + /** @var string */ + protected const FORMAT_PROCESSORS_DONE_MESSAGE = 'Processors processed magic numbers. Magic numbers found: %d'; + + /** @var string */ + protected const FORMAT_PROCESSORS_PROGRESS_MESSAGE = 'Processor %d is processing magic numbers. Magic numbers found: %d'; // phpcs:ignore Generic.Files.LineLength.MaxExceeded + + /** @var string */ + protected const FORMAT_VISITORS_DONE_MESSAGE = 'Visitors checked magic numbers in %d files. Magic numbers found: %d'; // phpcs:ignore Generic.Files.LineLength.MaxExceeded + + /** @var string */ + protected const FORMAT_VISITORS_PROGRESS_MESSAGE = 'Visitors are checking for magic numbers in files. Magic numbers found: %d'; // phpcs:ignore Generic.Files.LineLength.MaxExceeded + /** @var string */ private const HEADER_NUMBER = 'Number'; diff --git a/src/Console/Command/MagicStringDetectorCommand.php b/src/Console/Command/MagicStringDetectorCommand.php index f30dd4e..eff92a8 100644 --- a/src/Console/Command/MagicStringDetectorCommand.php +++ b/src/Console/Command/MagicStringDetectorCommand.php @@ -38,6 +38,18 @@ class MagicStringDetectorCommand extends AbstractCommand /** @var string */ private const DEFAULT_VISITORS = 'Argument,Array,Assign,Condition,DefaultParameter,Operation,Property,Return,SwitchCase,Ternary'; // phpcs:ignore Generic.Files.LineLength.MaxExceeded + /** @var string */ + protected const FORMAT_PROCESSORS_DONE_MESSAGE = 'Processors processed magic strings. Magic strings found: %d'; + + /** @var string */ + protected const FORMAT_PROCESSORS_PROGRESS_MESSAGE = 'Processor %d is processing magic strings. Magic strings found: %d'; // phpcs:ignore Generic.Files.LineLength.MaxExceeded + + /** @var string */ + protected const FORMAT_VISITORS_DONE_MESSAGE = 'Visitors checked magic strings in %d files. Magic strings found: %d'; // phpcs:ignore Generic.Files.LineLength.MaxExceeded + + /** @var string */ + protected const FORMAT_VISITORS_PROGRESS_MESSAGE = 'Visitors are checking for magic strings in files. Magic strings found: %d'; // phpcs:ignore Generic.Files.LineLength.MaxExceeded + /** @var string */ private const HEADER_OCCURRENCE = 'Occurrence'; diff --git a/src/Console/Command/MostUsedConditionsCommand.php b/src/Console/Command/MostUsedConditionsCommand.php index 9000789..e1e72f8 100644 --- a/src/Console/Command/MostUsedConditionsCommand.php +++ b/src/Console/Command/MostUsedConditionsCommand.php @@ -123,6 +123,12 @@ class MostUsedConditionsCommand extends AbstractCommand /** @var string */ private const FORMAT_OCCURRENCE = '%s %s%s'; + /** @var string */ + protected const FORMAT_PROCESSORS_DONE_MESSAGE = 'Processors processed conditions. Conditions found: %d'; + + /** @var string */ + protected const FORMAT_PROCESSORS_PROGRESS_MESSAGE = 'Processor %d is processing conditions. Conditions found: %d'; //phpcs:ignore Generic.Files.LineLength.MaxExceeded + /** @var string */ private const FORMAT_TABLE_INFO_MAX_ENTRIES = 'Showing maximum %d conditions.'; @@ -132,6 +138,12 @@ class MostUsedConditionsCommand extends AbstractCommand /** @var string */ private const FORMAT_TABLE_INFO_SORT_BY = 'Sort Conditions by number of occurrences %s.'; + /** @var string */ + protected const FORMAT_VISITORS_DONE_MESSAGE = 'Visitors checked conditions in %d files. Conditions found: %d'; //phpcs:ignore Generic.Files.LineLength.MaxExceeded + + /** @var string */ + protected const FORMAT_VISITORS_PROGRESS_MESSAGE = 'Visitors are checking for conditions in files. Conditions found: %d'; // phpcs:ignore Generic.Files.LineLength.MaxExceeded + /** @var string */ private const HEADER_CONDITION = 'Condition'; diff --git a/tests/Integration/Console/ApplicationTest.php b/tests/Integration/Console/ApplicationTest.php index 431446c..5aeba20 100644 --- a/tests/Integration/Console/ApplicationTest.php +++ b/tests/Integration/Console/ApplicationTest.php @@ -14,7 +14,7 @@ class ApplicationTest extends TestCase { /** @var string */ - private const APPLICATION_INFO = 'php-analyzer 1.2.4 by Christopher Stenke ' . \PHP_EOL; + private const APPLICATION_INFO = 'php-analyzer 1.2.5 by Christopher Stenke ' . \PHP_EOL; /** @var Application */ private $application; diff --git a/tests/Integration/Console/Command/MagicNumberDetectorCommandTest.php b/tests/Integration/Console/Command/MagicNumberDetectorCommandTest.php index b895bfd..c59f095 100644 --- a/tests/Integration/Console/Command/MagicNumberDetectorCommandTest.php +++ b/tests/Integration/Console/Command/MagicNumberDetectorCommandTest.php @@ -73,6 +73,7 @@ public function testRun(): void 'Starting magic-number-detector command', $outputText ); + $this->assertStringContainsString('Processors processed magic numbers. Magic numbers found:', $outputText); $expectedOutput = <<Starting magic-string-detector command', $outputText ); + $this->assertStringContainsString('Processors processed magic strings. Magic strings found:', $outputText); $expectedOutput = <<Starting most-used-conditions command', $outputText ); + $this->assertStringContainsString('Processors processed conditions. Conditions found:', $outputText); $expectedOutput = <<