Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
8 changed files
with
161 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| from coalib.settings.Setting import typed_list | ||
| from coalib.bearlib.abstractions.Linter import linter | ||
| from dependency_management.requirements.DistributionRequirement import \ | ||
| DistributionRequirement | ||
|
|
||
|
|
||
| @linter(executable='phpmd', | ||
| output_format='regex', | ||
| output_regex=r'(?P<filename>.*):(?P<line>\d+)(?P<message>.*)') | ||
| class PHPMessDetectorBear: | ||
| """ | ||
| The bear takes a given PHP source code base and looks for several | ||
| potential problems within that source. These problems can be things like: | ||
| - Possible bugs | ||
| - Suboptimal code | ||
| - Overcomplicated expressions | ||
| - Unused parameters, methods, properties | ||
| """ | ||
|
|
||
| LANGUAGES = {'PHP'} | ||
| REQUIREMENTS = {DistributionRequirement(apt_get='phpmd')} | ||
| AUTHORS = {'The coala developers'} | ||
| AUTHORS_EMAILS = {'coala-devel@googlegroups.com'} | ||
| LICENSE = 'AGPL-3.0' | ||
| CAN_DETECT = {'Formatting', 'Complexity', 'Unused Code', 'Redundancy', | ||
| 'Variable Misuse'} | ||
| SEE_MORE = 'https://phpmd.org/about.html' | ||
|
|
||
| @staticmethod | ||
| def create_arguments(filename, file, config_file, | ||
| phpmd_ruleset: typed_list(str)=''): | ||
| """ | ||
| :param phpmd_ruleset: | ||
| A ruleset filename or a comma-separated string of rulesetfilenames. | ||
| Available rulesets: cleancode, codesize, controversial, design, | ||
| naming, unusedcode. | ||
| """ | ||
| if phpmd_ruleset == '': # pragma: no cover | ||
| raise ValueError( | ||
| 'The `phpmd_ruleset` is a mandatory argument.' | ||
| ) | ||
| return filename, 'text', ','.join(phpmd_ruleset) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| import os | ||
| from queue import Queue | ||
|
|
||
| from bears.php.PHPMessDetectorBear import PHPMessDetectorBear | ||
| from coalib.testing.LocalBearTestHelper import LocalBearTestHelper | ||
| from coalib.testing.BearTestHelper import generate_skip_decorator | ||
| from coalib.results.Result import Result | ||
| from coalib.settings.Section import Section | ||
|
|
||
|
|
||
| def get_testfile_path(name): | ||
| return os.path.join(os.path.dirname(__file__), | ||
| 'phpmessdetector_test_files', | ||
| name) | ||
|
|
||
|
|
||
| def load_testfile(name): | ||
| return open(get_testfile_path(name)).readlines() | ||
|
|
||
|
|
||
| @generate_skip_decorator(PHPMessDetectorBear) | ||
| class PHPMessDetectorBearTest(LocalBearTestHelper): | ||
|
|
||
| def setUp(self): | ||
| self.uut = PHPMessDetectorBear(Section('name'), Queue()) | ||
|
|
||
| def test_cleancode_violation(self): | ||
| file_contents = load_testfile('cleancode_violation.php') | ||
| self.check_results( | ||
| self.uut, | ||
| file_contents, | ||
| [Result.from_values('PHPMessDetectorBear', | ||
| 'The method bar uses an else expression. Else ' | ||
| 'is never necessary and you can simplify the ' | ||
| 'code to work without else.', | ||
| file=get_testfile_path( | ||
| 'cleancode_violation.php'), | ||
| line=8)], | ||
| filename=get_testfile_path('cleancode_violation.php'), | ||
| settings={'phpmd_ruleset': ['cleancode']}) | ||
|
|
||
| def test_codesize_violation(self): | ||
| file_contents = load_testfile('codesize_violation.php') | ||
| self.check_results( | ||
| self.uut, | ||
| file_contents, | ||
| [Result.from_values('PHPMessDetectorBear', | ||
| 'The method example() has a Cyclomatic ' | ||
| 'Complexity of 11. The configured cyclomatic ' | ||
| 'complexity threshold is 10.', | ||
| file=get_testfile_path( | ||
| 'codesize_violation.php'), | ||
| line=4)], | ||
| filename=get_testfile_path('codesize_violation.php'), | ||
| settings={'phpmd_ruleset': ['codesize']}) |
Empty file.
13 changes: 13 additions & 0 deletions
13
tests/php/phpmessdetector_test_files/cleancode_violation.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| <? | ||
| class Foo | ||
| { | ||
| public function bar($flag) | ||
| { | ||
| if ($flag) { | ||
| // one branch | ||
| } else { | ||
| // another branch | ||
| } | ||
| } | ||
| } | ||
| ?> |
39 changes: 39 additions & 0 deletions
39
tests/php/phpmessdetector_test_files/codesize_violation.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| <? | ||
| // Cyclomatic Complexity = 11 | ||
| class Foo { | ||
| public function example() { | ||
| if ($a == $b) { | ||
| if ($a1 == $b1) { | ||
| fiddle(); | ||
| } elseif ($a2 == $b2) { | ||
| fiddle(); | ||
| } else { | ||
| fiddle(); | ||
| } | ||
| } elseif ($c == $d) { | ||
| while ($c == $d) { | ||
| fiddle(); | ||
| } | ||
| } elseif ($e == $f) { | ||
| for ($n = 0; $n < $h; $n++) { | ||
| fiddle(); | ||
| } | ||
| } else { | ||
| switch ($z) { | ||
| case 1: | ||
| fiddle(); | ||
| break; | ||
| case 2: | ||
| fiddle(); | ||
| break; | ||
| case 3: | ||
| fiddle(); | ||
| break; | ||
| default: | ||
| fiddle(); | ||
| break; | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ?> |