├── .gitignore
├── Composer
    └── ScriptHandler.php
├── Config
    ├── Phpcs
    │   ├── laravel.xml
    │   └── ruleset.xml
    ├── Phpmd
    │   ├── laravel.xml
    │   └── ruleset.xml
    └── tools.yml
├── File
    └── FileLocator.php
├── LICENSE
├── README.md
├── Tool
    ├── Phpcpd.php
    ├── Phpcs.php
    ├── Phpdcd.php
    ├── Phpmd.php
    └── Tool.php
└── composer.json


/.gitignore:
--------------------------------------------------------------------------------
1 | /vendor/
2 | 


--------------------------------------------------------------------------------
/Composer/ScriptHandler.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace piotrpasich\CodeQualityThreshold\Composer;
  4 | 
  5 | use piotrpasich\CodeQualityThreshold\File\FileLocator;
  6 | use piotrpasich\CodeQualityThreshold\Tool\Tool;
  7 | use Symfony\Component\Process\Process;
  8 | use Composer\Script\CommandEvent;
  9 | use Symfony\Component\Yaml\Parser;
 10 | 
 11 | 
 12 | class ScriptHandler
 13 | {
 14 | 
 15 |     private static $defaultOptions = [
 16 |         'default-file' => 'Config/tools.yml',
 17 |         'file'         => []
 18 |     ];
 19 | 
 20 |     /**
 21 |      * @param $event CommandEvent A instance
 22 |      */
 23 |     public static function checkThresholds(CommandEvent $event)
 24 |     {
 25 |         $options = static::loadConfiguration($event);
 26 |         $tools = static::getTools($options);
 27 | 
 28 |         foreach ($tools as $toolName => $toolConfiguration) {
 29 |             /** @var \piotrpasich\CodeQualityThreshold\Tool\Tool $tool */
 30 |             $tool = new $toolConfiguration['class']($toolConfiguration);
 31 | 
 32 |             if (! $tool instanceof Tool) {
 33 |                 throw new \RuntimeException('The tool should implement Tool abstract class');
 34 |             }
 35 | 
 36 |             $process = static::runCommand($event, $tool, $tool->composeCommand());
 37 | 
 38 |             if (!$process->isSuccessful()) {
 39 |                 throw new \RuntimeException(sprintf("[%s] %s: %s", $toolName, $process->getErrorOutput(), $process->getOutput()));
 40 |             }
 41 | 
 42 |             if ((int)$process->getOutput() > $tool->getThreshold()) {
 43 |                 static::runCommand($event, $tool, $tool->composeReportCommand());
 44 | 
 45 |                 throw new \RuntimeException(sprintf("[%s] %s: %s", $toolName, $tool->getErrorMessage(), $process->getOutput()));
 46 |             }
 47 | 
 48 |             $event->getIO()->write("<info>[{$toolName}] {$tool->getSuccessMessage()}</info>");
 49 |         }
 50 |     }
 51 | 
 52 |     protected static function loadConfiguration(CommandEvent $event)
 53 |     {
 54 |         $composerConfiguration = $event->getComposer()->getPackage()->getExtra();
 55 | 
 56 |         return static::getOptions(isset($composerConfiguration['cqt-parameters']) ? $composerConfiguration['cqt-parameters'] : []);
 57 |     }
 58 | 
 59 |     protected static function runCommand(CommandEvent $event, Tool $tool, $command)
 60 |     {
 61 |         if ($event->getIO()->isVerbose()) {
 62 |             $event->getIO()->write($command);
 63 |         }
 64 | 
 65 |         $process = new Process($command, getcwd(), null, null, $tool->getTimeout());
 66 |         $process->run(function ($type, $buffer) use ($event) {
 67 |             if ($event->getIO()->isVerbose()) {
 68 |                 $event->getIO()->write($buffer, false);
 69 |             }
 70 |         });
 71 | 
 72 |         return $process;
 73 |     }
 74 | 
 75 |     protected static function getOptions(array $options)
 76 |     {
 77 |         return array_merge(static::$defaultOptions, $options);
 78 |     }
 79 | 
 80 |     protected static function getTools(array $options)
 81 |     {
 82 |         $tools = static::loadFile($options['default-file']);
 83 | 
 84 |         if (isset($options['file']) && is_array($options['file'])) {
 85 |             foreach ($options['file'] as $file) {
 86 |                 $tools = array_merge($tools, static::loadFile($file));
 87 |             }
 88 |         } else if (isset($options['file']) && is_string($options['file'])) {
 89 |             $tools = array_merge($tools, static::loadFile($options['file']));
 90 |         }
 91 | 
 92 |         return $tools;
 93 |     }
 94 | 
 95 |     protected static function loadFile($filePath)
 96 |     {
 97 |         $filePath = (new FileLocator())->locateFile($filePath);
 98 | 
 99 |         return (new Parser())->parse(file_get_contents($filePath));
100 |     }
101 | }
102 | 


--------------------------------------------------------------------------------
/Config/Phpcs/laravel.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <ruleset name="Custom">
 3 |     <description>Custom Coding Standards</description>
 4 | 
 5 |     <rule ref="Generic.CodeAnalysis.EmptyStatement" />
 6 |     <rule ref="Generic.CodeAnalysis.EmptyStatement.DetectedIF">
 7 |         <severity>0</severity>
 8 |     </rule>
 9 |     <rule ref="Generic.CodeAnalysis.ForLoopShouldBeWhileLoop" />
10 |     <rule ref="Generic.CodeAnalysis.ForLoopWithTestFunctionCall" />
11 |     <rule ref="Generic.CodeAnalysis.JumbledIncrementer" />
12 |     <rule ref="Generic.CodeAnalysis.UnconditionalIfStatement" />
13 |     <rule ref="Generic.CodeAnalysis.UnnecessaryFinalModifier" />
14 |     <rule ref="Generic.CodeAnalysis.UnusedFunctionParameter" />
15 |     <rule ref="Generic.CodeAnalysis.UselessOverridingMethod" />
16 | 
17 |     <rule ref="Generic.Classes.DuplicateClassName" />
18 |     <rule ref="Generic.Commenting.Todo" />
19 | 
20 |     <rule ref="Internal.LineEndings.Mixed">
21 |         <type>error</type>
22 |     </rule>
23 | 
24 |     <!-- When making a method or function call, there MUST NOT be a space between the method or function name and the opening parenthesis, there MUST NOT be a space after the opening parenthesis, and there MUST NOT be a space before the closing parenthesis. In the argument list, there MUST NOT be a space before each comma, and there MUST be one space after each comma.
25 |     Argument lists MAY be split across multiple lines, where each subsequent line is indented once. When doing so, the first item in the list MUST be on the next line, and there MUST be only one argument per line. -->
26 |     <rule ref="Generic.Functions.FunctionCallArgumentSpacing" />
27 | 
28 |     <rule ref="Generic.WhiteSpace.DisallowTabIndent" />
29 | 
30 |     <rule ref="Generic.NamingConventions.ConstructorName" />
31 |     <rule ref="Generic.NamingConventions.UpperCaseConstantName" />
32 | 
33 |     <rule ref="Generic.PHP.DeprecatedFunctions" />
34 |     <rule ref="Generic.PHP.DisallowShortOpenTag" />
35 |     <rule ref="Generic.PHP.LowerCaseConstant" /><!-- The PHP constants true, false, and null MUST be in lower case. -->
36 |     <rule ref="Generic.PHP.LowerCaseKeyword" /><!-- PHP keywords MUST be in lower case. -->
37 |     <rule ref="Generic.PHP.NoSilencedErrors" />
38 | 
39 |     <rule ref="PEAR.Functions.ValidDefaultValue" /><!-- Method arguments with default values MUST go at the end of the argument list. -->
40 |     <rule ref="PEAR.NamingConventions.ValidClassName" />
41 | 
42 |     <rule ref="Squiz.Arrays.ArrayBracketSpacing" />
43 |     <rule ref="Squiz.Strings.ConcatenationSpacing" />
44 | 
45 |     <rule ref="Squiz.ControlStructures.ControlSignature">
46 |         <severity>0</severity>
47 |     </rule>
48 |     <rule ref="Squiz.ControlStructures.ElseIfDeclaration" />
49 |     <rule ref="Squiz.ControlStructures.ForEachLoopDeclaration" />
50 |     <rule ref="Squiz.ControlStructures.ForLoopDeclaration" />
51 |     <rule ref="Squiz.ControlStructures.InlineIfDeclaration" />
52 |     <rule ref="Squiz.ControlStructures.LowercaseDeclaration" />
53 |     <rule ref="Squiz.ControlStructures.SwitchDeclaration" />
54 | 
55 |     <!-- In the argument list, there MUST NOT be a space before each comma, and there MUST be one space after each comma. -->
56 |     <rule ref="Squiz.Functions.FunctionDeclarationArgumentSpacing">
57 |         <properties>
58 |             <property name="equalsSpacing" value="1" />
59 |         </properties>
60 |     </rule>
61 |     <!-- Method names MUST NOT be declared with a space after the method name. The opening brace MUST go on its own line, and the closing brace MUST go on the next line following the body. There MUST NOT be a space after the opening parenthesis, and there MUST NOT be a space before the closing parenthesis. -->
62 |     <rule ref="Squiz.Functions.FunctionDeclaration" />
63 |     <rule ref="Squiz.Functions.LowercaseFunctionKeywords" />
64 | 
65 |     <rule ref="Squiz.Operators.IncrementDecrementUsage" />
66 | 
67 |     <rule ref="Squiz.WhiteSpace.LanguageConstructSpacing" />
68 |     <rule ref="Squiz.WhiteSpace.OperatorSpacing" />
69 |     <rule ref="Squiz.WhiteSpace.ScopeKeywordSpacing" /><!-- Visibility MUST be declared on all methods. -->
70 |     <rule ref="Squiz.WhiteSpace.SemicolonSpacing" />
71 |     <rule ref="Squiz.WhiteSpace.SuperfluousWhitespace" />
72 | 
73 |     <exclude-pattern>*/.git/*</exclude-pattern>
74 | </ruleset>


--------------------------------------------------------------------------------
/Config/Phpcs/ruleset.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <ruleset name="Symfony2">
 3 |     <description>The Symfony2 coding standard.</description>
 4 | 
 5 |     <!-- There should not be any code in the bundle Resources directory. -->
 6 |     <exclude-pattern>*/Resources/*</exclude-pattern>
 7 | 
 8 |     <!--
 9 | 
10 |     See the [documented coding standard](http://symfony.com/doc/current/contributing/code/standards.html)
11 | 
12 |     This CodeSniffer standard does not yet enforce the following:
13 | 
14 |     # Structure
15 | 
16 |     * Declare class properties before methods;
17 |     * Declare public methods first, then protected ones and finally private ones.
18 |     * Use namespaces for all classes;
19 |     * Add PHPDoc blocks for all classes, methods, and functions;
20 |     * The @package and @subpackage annotations are not used.
21 |     * Use uppercase strings for constants with words separated with underscores
22 | 
23 |     # Naming Conventions
24 | 
25 |     * Use underscores for option, argument, parameter names;
26 |     * Use Symfony as the first namespace level;
27 | 
28 |     -->
29 | 
30 |     <rule ref="Generic.ControlStructures.InlineControlStructure"/>
31 |     <rule ref="Generic.Formatting.SpaceAfterCast"/>
32 |     <rule ref="Generic.Functions.CallTimePassByReference"/>
33 |     <rule ref="Generic.NamingConventions.UpperCaseConstantName"/>
34 |     <rule ref="Generic.PHP.LowerCaseConstant"/>
35 |     <rule ref="Squiz.Arrays.ArrayBracketSpacing"/>
36 |     <rule ref="Squiz.ControlStructures.ControlSignature"/>
37 |     <rule ref="Squiz.ControlStructures.ForEachLoopDeclaration"/>
38 |     <rule ref="Squiz.ControlStructures.ForLoopDeclaration"/>
39 |     <rule ref="Squiz.ControlStructures.LowercaseDeclaration"/>
40 |     <rule ref="Squiz.PHP.LowercasePHPFunctions"/>
41 |     <rule ref="Squiz.Scope.MemberVarScope"/>
42 | 
43 |     <!-- We provide our own subclass of PEAR's ClassComment and FunctionComment sniff, but these will do: -->
44 |     <rule ref="PEAR.Commenting.InlineComment"/>
45 | 
46 |     <!-- Import Zend coding standard (which in turn imports PEAR) -->
47 |     <rule ref="Zend">
48 |         <!-- but exclude their code analyzer -->
49 |         <exclude name="Zend.Debug.CodeAnalyzer"/>
50 | 
51 |         <!-- covered by Squiz ControlSignature, which enforces try/catch as well -->
52 |         <exclude name="PEAR.ControlStructures.ControlSignature"/>
53 | 
54 |         <exclude name="PEAR.Commenting.FunctionComment.SpacingBeforeTags"/>
55 | 
56 |         <!-- do not check line length -->
57 |         <exclude name="Generic.Files.LineLength"/>
58 | 
59 |         <!-- exclude multiline method arguments opening bracket -->
60 |         <exclude name="Generic.Functions.OpeningFunctionBraceBsdAllman.BraceOnSameLine"/>
61 |     </rule>
62 | 
63 |     <!-- Don't enforce Zend's private member underscores -->
64 |     <rule ref="Zend.NamingConventions.ValidVariableName.PrivateNoUnderscore">
65 |         <severity>0</severity>
66 |     </rule>
67 | 
68 |     <!-- Ignore variables that contains numbers -->
69 |     <rule ref="Zend.NamingConventions.ValidVariableName.ContainsNumbers">
70 |         <severity>0</severity>
71 |     </rule>
72 | 
73 |     <!-- In practice, Symfony2 spaces multiline function calls differently than Zend -->
74 |     <rule ref="PEAR.Functions.FunctionCallSignature.ContentAfterOpenBracket">
75 |         <severity>0</severity>
76 |     </rule>
77 |     <rule ref="PEAR.Functions.FunctionCallSignature.CloseBracketLine">
78 |         <severity>0</severity>
79 |     </rule>
80 | </ruleset>


--------------------------------------------------------------------------------
/Config/Phpmd/laravel.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <ruleset name="PHPMD Ruleset"
 3 |          xmlns="http://pmd.sf.net/ruleset/1.0.0"
 4 |          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 5 |          xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 http://pmd.sf.net/ruleset_xml_schema.xsd"
 6 |          xsi:noNamespaceSchemaLocation="http://pmd.sf.net/ruleset_xml_schema.xsd">
 7 | 
 8 |     <description>PHPMD ruleset</description>
 9 | 
10 |     <rule ref="rulesets/codesize.xml" />
11 | 
12 |     <rule ref="rulesets/design.xml"/>
13 | 
14 |     <rule ref="rulesets/naming.xml">
15 |         <exclude name="ShortMethodName" />
16 |         <exclude name="ShortVariable" />
17 |         <property name="checkParameterizedMethods" value="true" />
18 |     </rule>
19 | 
20 |     <rule ref="rulesets/naming.xml/ShortVariable">
21 |         <properties>
22 |             <property name="exceptions" value="id" />
23 |             <property name="minimum" value="3" />
24 |         </properties>
25 |     </rule>
26 | 
27 |     <rule ref="rulesets/unusedcode.xml" />
28 | 
29 | </ruleset>


--------------------------------------------------------------------------------
/Config/Phpmd/ruleset.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | 
 3 | <ruleset name="PHP Mess Detector rules"
 4 |          xmlns="http://pmd.sf.net/ruleset/1.0.0"
 5 |          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 6 |          xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 http://pmd.sf.net/ruleset_xml_schema.xsd"
 7 |          xsi:noNamespaceSchemaLocation="http://pmd.sf.net/ruleset_xml_schema.xsd">
 8 | 
 9 |     <description>Piotr Pasich PHP MD Code Quality Threshold Ruleset</description>
10 | 
11 |     <rule ref="rulesets/codesize.xml/CyclomaticComplexity" />
12 |     <rule ref="rulesets/codesize.xml/NPathComplexity" />
13 |     <rule ref="rulesets/codesize.xml/ExcessiveClassComplexity" />
14 |     <rule ref="rulesets/codesize.xml/ExcessiveClassLength" />
15 |     <rule ref="rulesets/codesize.xml/ExcessivePublicCount" />
16 |     <rule ref="rulesets/codesize.xml/ExcessiveMethodLength" />
17 |     <rule ref="rulesets/codesize.xml/ExcessiveParameterList" />
18 |     <rule ref="rulesets/codesize.xml/TooManyFields" />
19 |     <rule ref="rulesets/codesize.xml/TooManyMethods" />
20 | 
21 |     <rule ref="rulesets/controversial.xml/CamelCaseClassName" />
22 |     <rule ref="rulesets/controversial.xml/CamelCasePropertyName" />
23 |     <rule ref="rulesets/controversial.xml/CamelCaseMethodName" />
24 |     <rule ref="rulesets/controversial.xml/CamelCaseParameterName" />
25 |     <rule ref="rulesets/controversial.xml/CamelCaseVariableName" />
26 | 
27 |     <rule ref="rulesets/design.xml/EvalExpression" />
28 |     <rule ref="rulesets/design.xml/ExitExpression" />
29 |     <rule ref="rulesets/design.xml/GotoStatement" />
30 | 
31 |     <rule ref="rulesets/naming.xml/ConstructorWithNameAsEnclosingClass" />
32 |     <rule ref="rulesets/naming.xml/ConstantNamingConventions" />
33 |     <rule ref="rulesets/naming.xml/BooleanGetMethodName" />
34 | 
35 |     <rule ref="rulesets/unusedcode.xml/UnusedPrivateField" />
36 |     <rule ref="rulesets/unusedcode.xml/UnusedPrivateMethod" />
37 | 
38 | 
39 | </ruleset>


--------------------------------------------------------------------------------
/Config/tools.yml:
--------------------------------------------------------------------------------
 1 | phpmd:
 2 |     class: piotrpasich\CodeQualityThreshold\Tool\Phpmd
 3 | 
 4 | phpcs:
 5 |     class: piotrpasich\CodeQualityThreshold\Tool\Phpcs
 6 | 
 7 | phpcpd:
 8 |     class: piotrpasich\CodeQualityThreshold\Tool\Phpcpd
 9 | 
10 | phpdcd:
11 |     class: piotrpasich\CodeQualityThreshold\Tool\Phpdcd
12 | 


--------------------------------------------------------------------------------
/File/FileLocator.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace piotrpasich\CodeQualityThreshold\File;
 4 | 
 5 | use Symfony\Component\Config\FileLocator as SymfonyFileLocator;
 6 | 
 7 | class FileLocator
 8 | {
 9 | 
10 |     public function locateFile($filePath)
11 |     {
12 |         $fileLocator = new SymfonyFileLocator(['.', __DIR__ . '/..']);
13 | 
14 |         return $fileLocator->locate($filePath);
15 |     }
16 | 
17 | }
18 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | The MIT License (MIT)
 2 | 
 3 | Copyright (c) 2015 Piotr Pasich
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 
23 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Code Quality Threshold
 2 | 
 3 | This extension is purposed to run every necessary tool to check the code against violation from composer 
 4 | (ex. tools - PHP Mess Detector, PHP Code Sniffer, PHP Dead Code Detector, PHP Copy Paste).
 5 | 
 6 | ## Installation
 7 | 
 8 |     composer require piotrpasich/code-quality-threshold:dev-master --dev
 9 |    
10 | ## Configuration
11 | 
12 | To your composer.json file you might add 
13 | 
14 |     "scripts": {
15 |         "quality-test": [
16 |             "piotrpasich\\CodeQualityThreshold\\Composer\\ScriptHandler::checkThresholds"
17 |         ]
18 |     },
19 |     
20 | And execute the command
21 | 
22 |     composer quality-test
23 |     
24 | You can also add this script to already existing scripts like `post-update-cmd`.
25 | 
26 | ## Reports
27 | 
28 | If the test throws an exception you can always ask for the report:
29 | 
30 |     composer quality-test -v
31 | 
32 | ## Advanced configuration
33 | 
34 | This plugin checks the app folder by default, but you can always change this behavior by creating yml file. This might be
35 | placed wherever you want, ex. app/Config/cqt.yml
36 | 
37 | Then you need to add to your composer.json file the extra option:
38 | 
39 |     "extra": {
40 |         "cqt-parameters": {
41 |             "file": "app/Config/cqt.yml"
42 |         }
43 |     }
44 |  
45 | The example yml file might look like:
46 | 
47 |     phpmd:
48 |         class: piotrpasich\CodeQualityThreshold\Tool\Phpmd
49 |         options:
50 |             threshold: 42
51 |             directory: src
52 |             rules: Config/Phpmd/ruleset.xml
53 |     
54 |     phpcs:
55 |         class: piotrpasich\CodeQualityThreshold\Tool\Phpcs
56 |         options:
57 |             threshold: 42
58 |             rules: Config/Phpcs/ruleset.xml
59 |             directory: src
60 |     
61 |     phpcpd:
62 |         class: piotrpasich\CodeQualityThreshold\Tool\Phpcpd
63 |         options:
64 |             threshold: 42
65 |             directory: src
66 |     
67 |     Phpdcd:
68 |         class: piotrpasich\CodeQualityThreshold\Tool\Phpdcd
69 |         options:
70 |             directory: src
71 |             threshold: 21
72 |             
73 | ## Adding new tools
74 | 
75 | To add new tool you need to specify new record in yml file (look at the Advanced configuration chapter) and create a class
76 | extending Tool abstract class from the plugin.
77 | 


--------------------------------------------------------------------------------
/Tool/Phpcpd.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace piotrpasich\CodeQualityThreshold\Tool;
 4 | 
 5 | use piotrpasich\CodeQualityThreshold\Tool\Tool;
 6 | use Symfony\Component\OptionsResolver\OptionsResolver;
 7 | 
 8 | class Phpcpd extends Tool
 9 | {
10 | 
11 |     protected  $defaultOptions = [
12 |         'directory' => 'app',
13 |         'command'   => 'php vendor/sebastian/phpcpd/composer/bin/phpcpd',
14 |         'threshold' => 0,
15 |         'timeout'   => 1200
16 |     ];
17 | 
18 |     public function composeCommand()
19 |     {
20 |         return "{$this->composeReportCommand()} | egrep 'Found [0-9]+ exact clones' -o  | egrep [0-9]+ -o || echo 0";
21 |     }
22 | 
23 |     public function composeReportCommand()
24 |     {
25 |         return "{$this->configuration['command']} {$this->configuration['directory']}";
26 |     }
27 | 
28 |     public function getThreshold()
29 |     {
30 |         return isset($this->configuration['threshold']) ? $this->configuration['threshold'] : 0;
31 |     }
32 | 
33 |     public function getErrorMessage()
34 |     {
35 |         return 'The PHP Copy Paste Detector threshold is exceeded';
36 |     }
37 | 
38 |     public function getSuccessMessage()
39 |     {
40 |         return 'The PHP Copy Paste Detector threshold passed';
41 |     }
42 | }
43 | 


--------------------------------------------------------------------------------
/Tool/Phpcs.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace piotrpasich\CodeQualityThreshold\Tool;
 4 | 
 5 | use piotrpasich\CodeQualityThreshold\File\FileLocator;
 6 | use piotrpasich\CodeQualityThreshold\Tool\Tool;
 7 | use Symfony\Component\OptionsResolver\OptionsResolver;
 8 | 
 9 | class Phpcs extends Tool
10 | {
11 | 
12 |     protected  $defaultOptions = [
13 |         'directory' => 'app',
14 |         'command'   => 'php vendor/squizlabs/php_codesniffer/scripts/phpcs',
15 |         'rules'     => 'Config/Phpcs/ruleset.xml',
16 |         'threshold' => 0,
17 |         'timeout'   => 1200
18 |     ];
19 |     
20 |     public function composeCommand()
21 |     {
22 | 
23 |         return "{$this->composeReportCommand()} --report=csv | tail -n +2 | wc -l";
24 |     }
25 | 
26 |     public function composeReportCommand()
27 |     {
28 |         $rules = (new FileLocator())->locateFile($this->configuration['rules']);
29 | 
30 |         return "{$this->configuration['command']} {$this->configuration['directory']} --standard={$rules}";
31 |     }
32 | 
33 |     public function getThreshold()
34 |     {
35 |         return isset($this->configuration['threshold']) ? $this->configuration['threshold'] : 0;
36 |     }
37 | 
38 |     public function getErrorMessage()
39 |     {
40 |         return 'The PHP Code Sniffer threshold is exceeded';
41 |     }
42 | 
43 |     public function getSuccessMessage()
44 |     {
45 |         return 'The PHP Code Sniffer threshold passed';
46 |     }
47 | }
48 | 


--------------------------------------------------------------------------------
/Tool/Phpdcd.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace piotrpasich\CodeQualityThreshold\Tool;
 4 | 
 5 | use piotrpasich\CodeQualityThreshold\Tool\Tool;
 6 | use Symfony\Component\OptionsResolver\OptionsResolver;
 7 | 
 8 | class Phpdcd extends Tool
 9 | {
10 | 
11 |     protected  $defaultOptions = [
12 |         'directory' => 'app',
13 |         'command'   => 'php vendor/sebastian/phpdcd/phpdcd',
14 |         'threshold' => 0,
15 |         'timeout'   => 1200
16 |     ];
17 | 
18 |     public function composeCommand()
19 |     {
20 |         return "{$this->composeReportCommand()} | grep LOC | wc -l";
21 |     }
22 | 
23 |     public function composeReportCommand()
24 |     {
25 |         return "{$this->configuration['command']} {$this->configuration['directory']}";
26 |     }
27 | 
28 |     public function getThreshold()
29 |     {
30 |         return isset($this->configuration['threshold']) ? $this->configuration['threshold'] : 0;
31 |     }
32 | 
33 |     public function getErrorMessage()
34 |     {
35 |         return 'The PHP Dead Code Detector threshold is exceeded';
36 |     }
37 | 
38 |     public function getSuccessMessage()
39 |     {
40 |         return 'The PHP Dead Code Detector threshold passed';
41 |     }
42 | }
43 | 


--------------------------------------------------------------------------------
/Tool/Phpmd.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace piotrpasich\CodeQualityThreshold\Tool;
 4 | 
 5 | use piotrpasich\CodeQualityThreshold\File\FileLocator;
 6 | use piotrpasich\CodeQualityThreshold\Tool\Tool;
 7 | use Symfony\Component\OptionsResolver\OptionsResolver;
 8 | 
 9 | class Phpmd extends Tool
10 | {
11 | 
12 |     protected  $defaultOptions = [
13 |         'directory' => 'app',
14 |         'rules'     => 'cleancode,codesize,unusedcode',
15 |         'command'   => 'php vendor/phpmd/phpmd/src/bin/phpmd',
16 |         'threshold' => 0,
17 |         'timeout'   => 1200
18 |     ];
19 | 
20 |     public function composeCommand()
21 |     {
22 |         return "{$this->composeReportCommand()} | wc -l";
23 |     }
24 | 
25 |     public function composeReportCommand()
26 |     {
27 |         $rules = $this->configuration['rules'];
28 |         if ('xml' == pathinfo($rules, PATHINFO_EXTENSION)) {
29 |             $rules = (new FileLocator())->locateFile($rules);
30 |         }
31 | 
32 |         return "{$this->configuration['command']} {$this->configuration['directory']} text {$rules}";
33 |     }
34 | 
35 |     public function getThreshold()
36 |     {
37 |         return isset($this->configuration['threshold']) ? $this->configuration['threshold'] : 0;
38 |     }
39 | 
40 |     public function getErrorMessage()
41 |     {
42 |         return 'The PHP MD threshold is exceeded';
43 |     }
44 | 
45 |     public function getSuccessMessage()
46 |     {
47 |         return 'The PHP MD threshold passed';
48 |     }
49 | }
50 | 


--------------------------------------------------------------------------------
/Tool/Tool.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace piotrpasich\CodeQualityThreshold\Tool;
 4 | 
 5 | use Symfony\Component\OptionsResolver\OptionsResolver;
 6 | 
 7 | abstract class Tool
 8 | {
 9 | 
10 |     /**
11 |      * @var array
12 |      */
13 |     protected $configuration;
14 | 
15 |     protected $defaultOptions = [];
16 | 
17 |     public function __construct(array $configuration = [])
18 |     {
19 |         $this->configuration = $this->resolveConfigurationOptions(isset($configuration['options']) ? $configuration['options'] : []);
20 |     }
21 | 
22 |     /**
23 |      * Returns a string with bash command
24 |      *
25 |      * @return string
26 |      */
27 |     abstract public function composeCommand();
28 | 
29 |     /**
30 |      * Creates a command to return full report
31 |      *
32 |      * @return string
33 |      */
34 |     abstract public function composeReportCommand();
35 | 
36 |     /**
37 |      * Returns an integer with the threshold
38 |      *
39 |      * @return Integer
40 |      */
41 |     abstract public function getThreshold();
42 | 
43 |     /**
44 |      * Returns error message if exception occurs
45 |      *
46 |      * @return string
47 |      */
48 |     abstract public function getErrorMessage();
49 | 
50 |     /**
51 |      * Returns a message when succeed
52 |      *
53 |      * @return string
54 |      */
55 |     abstract public function getSuccessMessage();
56 | 
57 |     /**
58 |      * Return timeout for the command
59 |      *
60 |      * @return int
61 |      */
62 |     public function getTimeout()
63 |     {
64 |         return $this->configuration['timeout'];
65 |     }
66 | 
67 |     /**
68 |      * Resolves options
69 |      *
70 |      * @param array $options
71 |      * @return array
72 |      */
73 |     protected function resolveConfigurationOptions(array $configurationOptions)
74 |     {
75 |         $optionsResolver = new OptionsResolver();
76 |         $optionsResolver->setDefaults($this->defaultOptions);
77 |         $optionsResolver->setRequired(array_keys($this->defaultOptions));
78 | 
79 |         return $optionsResolver->resolve($configurationOptions);
80 |     }
81 | }
82 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "piotrpasich/code-quality-threshold",
 3 |     "license": "MIT",
 4 |     "authors": [
 5 |         {
 6 |             "name": "Piotr Pasich",
 7 |             "email": "piotr.pasich@x-team.com"
 8 |         }
 9 |     ],
10 |     "require": {
11 |         "symfony/process": "2.*",
12 |         "symfony/yaml": "2.*",
13 |         "symfony/options-resolver": "2.*",
14 |         "phpmd/phpmd": "@stable",
15 |         "squizlabs/php_codesniffer": "2.*",
16 |         "sebastian/phpcpd": "*",
17 |         "sebastian/phpdcd": "*"
18 |     },
19 |     "minimum-stability": "dev",
20 |     "extra": {
21 |         "cqt-parameters": {
22 |             "file": "appa/config/parameters.yml"
23 |         }
24 |     },
25 |     "scripts": {
26 |         "test": [
27 |             "piotrpasich\\CodeQualityThreshold\\Composer\\ScriptHandler::checkThresholds"
28 |         ]
29 |     },
30 |     "target-dir": "piotrpasich/CodeQualityThreshold",
31 |     "autoload": {
32 |         "psr-0": { "piotrpasich\\CodeQualityThreshold": "" }
33 |     }
34 | }
35 | 


--------------------------------------------------------------------------------