improve unit and coverage testing

Author: xalopp

.travis.yml

@@ -13,5 +13,5 @@ before_script:
   - composer install
 
 script:
-  - vendor/bin/phpunit --filter MO4
+  - vendor/bin/phpunit
   - vendor/bin/phpcs

CONTRIBUTING.md

@@ -1,5 +1,9 @@
 # Contributing
 
+If you contribute code, please make sure it conforms to the
+[PHPCS coding standard](https://github.com/squizlabs/PHP_CodeSniffer/blob/master/phpcs.xml.dist)
+and that the unit tests still pass.
+
 ## Setup
 
 We do recommend the following setup:
@@ -12,17 +16,42 @@ We do recommend the following setup:
 * install all required dependencies
 
         composer install
+        
+* be sure that [Xdebug](https://xdebug.org/) is installed, if you like to check code coverage.
+
+
+## Coding Standard
+
+To check the coding standard, execute in the repository root:
+
+    ./vendor/bin/phpcs
+
+`phpcs` might report that some coding standard issues can be fixed automatically.
+So give `phpcbf` a try and let it fix the issues for you:
+
+    ./vendor/bin/phpcbf
+
+## Tests
+
+To run the unit tests, execute in the repository root:
+
+    ./vendor/bin/phpunit
+
+## Code Coverage
+
+Make sure, that you write tests for your code.
 
+Testing code coverage with [PHPUnit](https://phpunit.de/) requires [Xdebug](https://xdebug.org/) to be enabled.
 
-## Coding Standard and Tests
+You can generate a simple code coverage report by running in the repository root:
 
-If you contribute code, please make sure it conforms to the PHPCS coding standard and that the unit tests still pass.
+    ./vendor/bin/phpunit --coverage-text
 
-1. To check the coding standard, execute in the repository root:
+In the case that Xdebug is disabled by default
 
-        ./vendor/bin/phpcs
+     php -d zend_extension=xdebug.so vendor/bin/phpunit --coverage-text
 
-2. To run the unit tests, execute in the repository root:
+will do the trick.
 
-        ./vendor/bin/phpunit --filter MO4
+Please refer to the [PHPUnit Manual](https://phpunit.de/documentation.html) for further information about code coverage.
 

MO4/Tests/Formatting/AlphabeticalUseStatementsUnitTest.fail.1.inc

@@ -6,7 +6,7 @@ use A;
 
 use A\B\C as CC;
 use A\B\B as BB;
-use A\B\A as AA;
+   use A\B\A as AA;
 
 use Z;
 use X;

MO4/Tests/Formatting/ArrayAlignmentUnitTest.fail.inc

@@ -150,3 +150,6 @@ $values  = [
         'object_name'       => 'TestObject',
         'id'                => 'Test:2', ], ];
 
+
+$fail = array(
+    1);

MO4/Tests/Formatting/ArrayAlignmentUnitTest.php

@@ -82,6 +82,7 @@ protected function getErrorList($testFile='')
                     136 => 2,
                     145 => 1,
                     151 => 2,
+                    155 => 1,
                    );
         }//end switch
 

MO4/Tests/Formatting/UnnecessaryNamespaceUsageUnitTest.fail.3.inc

@@ -11,7 +11,7 @@ class MyFixtures
 {
     /**
      * Inserts data into database.
-     *
+     * @throws
      * @param Doctrine\ORM\EntityManager|\Something\ObjectManager $manager Entity Manager
      * @throws MyApp\OmgException
      * @throws \MyApp\FatalException

MO4/Tests/Formatting/UnnecessaryNamespaceUsageUnitTest.fail.3.inc.fixed

@@ -11,7 +11,7 @@ class MyFixtures
 {
     /**
      * Inserts data into database.
-     *
+     * @throws
      * @param EntityManager|\Something\ObjectManager $manager Entity Manager
      * @throws OmgException
      * @throws FatalException

README.md

@@ -78,7 +78,7 @@ Using [Composer](https://getcomposer.org/) is the preferred way.
 
 1. Add the MO4 coding standard to `composer.json`
 
-        composer require --dev mayflower/mo4-coding-standard:dev-master
+        composer require --dev mayflower/mo4-coding-standard
 
 2. Profit
 

phpcs.mo4.xml

@@ -4,6 +4,7 @@
 
     <!-- Sensible default configuration settings for coding standard checking of MO4. -->
     <file>MO4</file>
+    <file>tests</file>
 
     <exclude-pattern>*/Tests/*\.(inc|css|js)</exclude-pattern>
     <exclude-pattern>vendor/*</exclude-pattern>

phpunit.xml.dist

@@ -1,8 +1,17 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit backupGlobals="true" beStrictAboutTestsThatDoNotTestAnything="false" bootstrap="vendor/squizlabs/php_codesniffer/tests/bootstrap.php">
+<phpunit
+        backupGlobals="true"
+        beStrictAboutTestsThatDoNotTestAnything="false"
+        bootstrap="tests/bootstrap.php"
+>
     <testsuites>
-        <testsuite name="PHP_CodeSniffer Test Suite">
+        <testsuite name="MO4 Ruleset Test Suite">
             <file>vendor/squizlabs/php_codesniffer/tests/Standards/AllSniffs.php</file>
         </testsuite>
     </testsuites>
+    <filter>
+        <whitelist processUncoveredFilesFromWhitelist="false">
+            <directory suffix=".php">./MO4/Sniffs</directory>
+        </whitelist>
+    </filter>
 </phpunit>

tests/bootstrap.php

@@ -0,0 +1,37 @@
+<?php
+/**
+ * Bootstrap file for PHP_CodeSniffer MO4 Coding Standard unit tests.
+ *
+ * @category PHP
+ * @package  PHP_CodeSniffer-MO4
+ * @author   Xaver Loppenstedt <[email protected]>
+ * @license  http://spdx.org/licenses/MIT MIT License
+ * @link     https://github.com/mayflower/mo4-coding-standard
+ */
+
+$myStandardName = 'MO4';
+
+require_once __DIR__.'/../vendor/squizlabs/php_codesniffer/tests/bootstrap.php';
+
+// Add this Standard.
+PHP_CodeSniffer\Config::setConfigData(
+    'installed_paths',
+    __DIR__.DIRECTORY_SEPARATOR.'..'.DIRECTORY_SEPARATOR.$myStandardName,
+    true
+);
+
+// Ignore all other Standards in tests.
+$standards   = PHP_CodeSniffer\Util\Standards::getInstalledStandards();
+$standards[] = 'Generic';
+
+$ignoredStandardsStr = implode(
+    ',',
+    array_filter(
+        $standards,
+        function ($v) use ($myStandardName) {
+            return $v !== $myStandardName;
+        }
+    )
+);
+
+putenv("PHPCS_IGNORE_TESTS={$ignoredStandardsStr}");