Check for named constants

README.md

@@ -115,7 +115,9 @@ The ``--strings`` option will include strings literal search in code analysis.
 
 The ``--suffixes`` option will configure a comma separated list of valid source code filename extensions.
 
-The ``--whitelist`` option will only process the files listed in the file specified. This is useful for incremental anaysis.
+The ``--whitelist`` option will only process the files listed in the file specified. This is useful for incremental analysis.
+
+The ``--check-naming`` option will check for names for numbers being used, eg `$six = 6`; You also need to pass in a csv of supported languages you wish to check (e.g. en)
 
 The ``--xml-output`` option will generate an report in an Xml format to the path specified by the option.
 **By default it analyses conditions, return statements, and switch cases.**

appveyor.yml

@@ -35,6 +35,7 @@ install:
     - IF %PHP%==1 echo extension_dir=ext >> php.ini
     - IF %PHP%==1 echo extension=php_openssl.dll >> php.ini
     - IF %PHP%==1 echo extension=php_mbstring.dll >> php.ini
+    - IF %PHP%==1 echo extension=php_intl.dll >> php.ini
     - IF %PHP%==1 echo @php %%~dp0composer.phar %%* > composer.bat
     # Install composer and update per matrix
     - appveyor-retry appveyor DownloadFile https://getcomposer.org/composer.phar

composer.json

@@ -18,7 +18,8 @@
     "symfony/finder": "^4.0",
     "nikic/php-parser": "^4.0",
     "jakub-onderka/php-console-highlighter": "^0.4",
-    "phpunit/php-timer": "^2.0"
+    "phpunit/php-timer": "^2.0",
+    "ext-intl": "*"
   },
   "require-dev": {
     "phpunit/phpunit": "^7.0",

src/Console/Command.php

@@ -138,6 +138,14 @@ protected function configure(): void
                 'Link to a file containing filenames to search',
                 ''
             )
+            ->addOption(
+                'check-naming',
+                null,
+                InputOption::VALUE_REQUIRED,
+                'Check the names of variables to ensure they are not numeric,' .
+                ' accepts a comma separated list of languages eg en or en_GB',
+                ''
+            )
         ;
     }
 
@@ -211,6 +219,7 @@ private function createOption(InputInterface $input): Option
         $option = new Option;
         $option->setIgnoreNumbers(array_map([$this, 'castToNumber'], $this->getCSVOption($input, 'ignore-numbers')));
         $option->setIgnoreFuncs($this->getCSVOption($input, 'ignore-funcs'));
+        $option->setCheckNaming($this->getCSVOption($input, 'check-naming'));
         $option->setIncludeStrings($input->getOption('strings'));
         $option->setIncludeNumericStrings($input->getOption('include-numeric-string'));
         $option->setIgnoreStrings($this->getCSVOption($input, 'ignore-strings'));

src/Console/Option.php

@@ -3,6 +3,8 @@
 namespace Povils\PHPMND\Console;
 
 use Povils\PHPMND\Extension\Extension;
+use Povils\PHPMND\GenericLanguage;
+use Povils\PHPMND\Language;
 
 /**
  * @package Povils\PHPMND\Console
@@ -53,6 +55,11 @@ class Option
      */
     private $allowArrayMapping = false;
 
+    /**
+     * @var array
+     */
+    private $checkNaming = [];
+
     public function setExtensions(array $extensions)
     {
         $this->extensions = $extensions;
@@ -132,4 +139,38 @@ public function setAllowArrayMapping(?bool $allowArrayMapping)
     {
         $this->allowArrayMapping = $allowArrayMapping;
     }
+
+    /**
+     * @return Language[]
+     */
+    public function checkNaming(): array
+    {
+        return $this->checkNaming;
+    }
+
+    public function setCheckNaming(array $checkNaming)
+    {
+        $languages = [];
+        foreach ($checkNaming as $language) {
+            $languages[] = $this->findLanguage($language);
+        }
+        $this->checkNaming = $languages;
+    }
+
+    protected function findLanguage($language): Language
+    {
+        foreach (scandir(__DIR__ . '/../Languages/') as $class) {
+            $class = basename($class, '.php');
+            $class = "Povils\PHPMND\Languages\\$class";
+            if ((
+                class_exists($class) &&
+                is_subclass_of($class, Language::class) &&
+                in_array($language, $class::providesLanguages())
+            )) {
+                return new $class($language);
+            }
+        }
+
+        return new GenericLanguage($language);
+    }
 }

src/GenericLanguage.php

@@ -0,0 +1,17 @@
+<?php
+namespace Povils\PHPMND;
+
+class GenericLanguage extends Language
+{
+    public static function providesLanguages(): array
+    {
+        return [
+            'all'
+        ];
+    }
+
+    public function specialNumbers(): array
+    {
+        return [];
+    }
+}

src/Language.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace Povils\PHPMND;
+
+use NumberFormatter;
+
+abstract class Language
+{
+    /**
+     * @var NumberFormatter
+     */
+    protected $formatter;
+
+    public function __construct($language)
+    {
+        $this->formatter = new NumberFormatter($language, NumberFormatter::SPELLOUT);
+    }
+
+    /*
+     * Returns an array of words which
+     */
+    public function parse(int $number): array
+    {
+        $words = $this->specialNumbers()[$number] ?? [];
+        $formatted = $this->formatter->format($number);
+
+        $formatted = str_replace(['-', ','], ' ', $formatted);
+        $formatted = explode(' ', $formatted);
+
+        return array_merge($words, $formatted);
+    }
+
+    abstract public static function providesLanguages(): array;
+
+    abstract public function specialNumbers(): array;
+}

src/Languages/En.php

@@ -0,0 +1,49 @@
+<?php
+namespace Povils\PHPMND\Languages;
+
+use Povils\PHPMND\Language;
+
+class En extends Language
+{
+    public static function providesLanguages(): array
+    {
+        return [
+            'en',
+            'en_GB',
+            'en_US'
+        ];
+    }
+
+    public function specialNumbers(): array
+    {
+        return [
+            2 => [
+                'half',
+            ],
+            3 => [
+                'third',
+            ],
+            7 => [
+                'week',
+            ],
+            10 => [
+                'tenth',
+                'decile',
+            ],
+            24 => [
+                'hours',
+            ],
+            28 => [
+                'February',
+            ],
+            60 => [
+                'second',
+                'minute',
+            ],
+            100 => [
+                'percent',
+                'centile'
+            ],
+        ];
+    }
+}

src/Visitor/DetectorVisitor.php

@@ -44,19 +44,33 @@ public function __construct(FileReport $fileReport, Option $option)
     public function enterNode(Node $node): ?int
     {
         if ($this->isIgnoreableConst($node)) {
+            if ($this->checkNameContainsLanguage(
+                $node->name->name,
+                $node->value->value ?? 0
+            )) {
+                $this->fileReport->addEntry($node->getLine(), $node->value->value);
+            }
+
             return NodeTraverser::DONT_TRAVERSE_CHILDREN;
         }
 
         /** @var LNumber|DNumber|String_ $scalar */
         $scalar = $node;
-        if ($this->hasSign($node)) {
-            $node = $node->getAttribute('parent');
-            if ($this->isMinus($node)) {
+        if ($this->hasSign($scalar)) {
+            $node = $scalar->getAttribute('parent');
+            if ($this->isMinus($node) && isset($scalar->value)) {
                 $scalar->value = -$scalar->value;
             }
         }
 
         if ($this->isNumber($scalar) || $this->isString($scalar)) {
+            if ($this->checkNameContainsLanguage(
+                $scalar->getAttribute('parent')->var->name ?? '',
+                $scalar->value
+            )) {
+                $this->fileReport->addEntry($node->getLine(), $scalar->value);
+            }
+
             foreach ($this->option->getExtensions() as $extension) {
                 $extension->setOption($this->option);
                 if ($extension->extend($node)) {
@@ -120,4 +134,26 @@ private function isValidNumeric(Node $node): bool
         is_numeric($node->value) &&
         false === $this->ignoreString($node);
     }
+
+    private function checkNameContainsLanguage(string $name, $value): bool
+    {
+        $value = (int) $value;
+        foreach ($this->option->checkNaming() as $language) {
+            $generatedNumbers = $language->parse($value);
+
+            $regex = '/(?<name>';
+            foreach ($generatedNumbers as $word) {
+                $regex .= "(?:{$word}[\s_-]*)?";
+            }
+
+            $regex .= ')/i';
+            preg_match($regex, $name, $matches);
+
+            if (strlen($matches['name']) > 0) {
+                return true;
+            }
+        }
+
+        return false;
+    }
 }

tests/Console/CommandTest.php

@@ -36,12 +36,18 @@ public function testExecuteWithHintOption(): void
     {
         $input = $this->createInput('assign', null, true, true);
         $output = $this->createOutput();
+        $textOutput = '';
         $output
-            ->expects($this->at(9))
             ->method('writeln')
-            ->with('Suggestions:');
+            ->will($this->returnCallback(
+                function ($string) use (&$textOutput) {
+                    $textOutput .= $string;
+                }
+            ));
 
         $this->execute([$input, $output]);
+
+        $this->assertTrue(strpos($textOutput, 'Suggestions:') > 1);
     }
 
     private function execute(array $args): int

tests/DetectorTest.php

@@ -277,6 +277,35 @@ public function testDetectReadingNumber(): void
         );
     }
 
+    public function testNamesCorrectlyFound()
+    {
+
+        $option = $this->createOption();
+        $option->setCheckNaming(['en']);
+        $detector = $this->createDetector($option);
+
+        $fileReport = $detector->detect(FileReportTest::getTestFile('check_naming'));
+
+        $this->assertSame(
+            [
+                [
+                    'line' => 4,
+                    'value' => 27,
+                ],
+                [
+                    'line' => 8,
+                    'value' => 98,
+                ],
+                [
+                    'line' => 9,
+                    'value' => 7,
+                ],
+
+            ],
+            $fileReport->getEntries()
+        );
+    }
+
     public function testAllowArrayMappingWithArrayExtension(): void
     {
         $option = $this->createOption();

tests/files/check_naming.php

@@ -0,0 +1,11 @@
+<?php
+class a
+{
+    const TWENTY_SEVEN = 27;
+
+    public function testVariables()
+    {
+        $ninetyEight = 98;
+        $week = 7;
+    }
+}