Fixes #43, Adds check for deprecated @subpackage tag

NielsdeBlaauw · Feb 13, 2019 · 14aa355 · 14aa355
1 parent 65c19f6
commit 14aa355
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -48,7 +48,9 @@ Options:
                                             [default: text]
   -o, --reportFile <arg>                    Send report output to a file
   -m, --metric <arg>                        Metric to use for determining
-                                            complexity [cognitive, cyclomatic]
+                                            complexity [cognitive, cyclomatic,
+                                            metrics.deprecated.category,
+                                            metrics.deprecated.subpackage]
                                             [default: cognitive]
   -w, --complexity-warning-threshold <arg>  Cyclomatic complexity score which
                                             is the lower bound for a warning

diff --git a/src/AnalysableFile.php b/src/AnalysableFile.php
@@ -13,6 +13,7 @@ class AnalysableFile implements \JsonSerializable
     protected $metrics = array(
         'cognitive'  => '\NdB\PhpDocCheck\Metrics\CognitiveComplexity',
         'metrics.deprecated.category'  => '\NdB\PhpDocCheck\Metrics\CategoryDeprecated',
+        'metrics.deprecated.subpackage'  => '\NdB\PhpDocCheck\Metrics\SubpackageDeprecated',
         'cyclomatic' => '\NdB\PhpDocCheck\Metrics\CyclomaticComplexity'
     );
 

diff --git a/src/ApplicationArgumentsProvider.php b/src/ApplicationArgumentsProvider.php
@@ -18,7 +18,9 @@ public function __construct()
                 ->setDefaultValue(''),
             \GetOpt\Option::create('m', 'metric', \GetOpt\GetOpt::REQUIRED_ARGUMENT)
                 ->setDescription(
-                    'Metric to use for determining complexity [cognitive, cyclomatic] [default: cognitive]'
+                    'Metric to use for determining complexity [cognitive, cyclomatic, '.
+                    'metrics.deprecated.category, metrics.deprecated.subpackage] '.
+                    '[default: cognitive]'
                 )
                 ->setDefaultValue('cognitive'),
             \GetOpt\Option::create('w', 'complexity-warning-threshold', \GetOpt\GetOpt::REQUIRED_ARGUMENT)

diff --git a/src/Metrics/SubpackageDeprecated.php b/src/Metrics/SubpackageDeprecated.php
@@ -0,0 +1,37 @@
+<?php
+
+namespace NdB\PhpDocCheck\Metrics;
+
+final class SubpackageDeprecated implements Metric
+{
+    public $value = 0;
+
+    public function getMessage():string
+    {
+        return '%1$s has a @subpackage tag, which is deprecated. '.
+        'It is recommended to use the @package tag\'s ability '.
+        'to provide multiple levels.';
+    }
+
+    public function getName():string
+    {
+        return 'metrics.deprecated.subpackage';
+    }
+
+    public function getValue(\PhpParser\Node $node):int
+    {
+        $docBlock = $node->getAttribute('DocBlock');
+        if (!empty($docBlock) && $docBlock->hasTag('subpackage')) {
+            return 4;
+        }
+        return 0;
+    }
+
+    public function jsonSerialize() : array
+    {
+        return array(
+            'name'=>$this->getName(),
+            'value'=>$this->value
+        );
+    }
+}