Fixes #32, Adds function length metric (#53)

* Fixes #32, Adds function length metric * Adds documentation
NielsdeBlaauw · May 12, 2019 · b60fcbf · b60fcbf
1 parent eda475d
commit b60fcbf
Show file tree

Hide file tree

Showing 5 changed files with 41 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -50,7 +50,8 @@ Options:
   -m, --metric <arg>                        Metric to use for determining
                                             complexity [cognitive, cyclomatic,
                                             metrics.deprecated.category,
-                                            metrics.deprecated.subpackage]
+                                            metrics.deprecated.subpackage,
+                                            metrics.complexity.length]
                                             [default: cognitive]
   -w, --complexity-warning-threshold <arg>  Cyclomatic complexity score which
                                             is the lower bound for a warning

diff --git a/bin/php-doc-check b/bin/php-doc-check
@@ -42,6 +42,7 @@ $lexer = new \PhpParser\Lexer\Emulative(
     array(
         'usedAttributes' => array(
             'startLine',
+            'endLine',
             'comments',
         ),
     )

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

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

diff --git a/src/Metrics/FunctionLength.php b/src/Metrics/FunctionLength.php
@@ -0,0 +1,36 @@
+<?php
+
+namespace NdB\PhpDocCheck\Metrics;
+
+final class FunctionLength implements Metric
+{
+    public $value = 0;
+
+    const LINES_PER_POINT = 5;
+
+    public function getMessage():string
+    {
+        return '%1$s has a length score of %2$d. It is recommended to document long functions.';
+    }
+
+    public function getName():string
+    {
+        return 'metrics.complexity.length';
+    }
+
+    public function getValue(\PhpParser\Node $node):int
+    {
+        if (!empty($node->getDocComment())) {
+            return 0;
+        }
+        return ( $node->getEndLine() - $node->getStartLine() ) / self::LINES_PER_POINT;
+    }
+
+    public function jsonSerialize() : array
+    {
+        return array(
+            'name'=>$this->getName(),
+            'value'=>$this->value
+        );
+    }
+}