Merge pull request #47 from exussum12/v1-prep

Start of v1

Author: exussum12

.travis.yml

@@ -6,15 +6,11 @@ cache:
     - $HOME/.cache/composer/files
 matrix:
   include:
-    - php: 5.6
     - php: 7.0
     - php: 7.1
-      env: UPDATE_COVERAGE=1
     - php: 7.2
-    - php: nightly
-    - php: hhvm
-  allow_failures:
-    - php: hhvm
+      env: UPDATE_COVERAGE=1
+    - php: 7.3
     - php: nightly
   fast_finish: true
 before_script:

GitHooks/pre-commit

@@ -0,0 +1,17 @@
+#!/bin/bash -e
+
+# This is a PSR-2 checking example for just the code about to be committed
+
+# Get the changes
+files=$(mktemp)
+diff=$(mktemp)
+
+git diff --cached --name-only --diff-filter=ACMR -- "*.php" > ${files}
+git diff --cached > ${diff}
+
+# Run the phpcs report
+phpcs=$(mktemp)
+./vendor/bin/phpcs --file-list=${files} --parallel=2 --standard=psr2 --report=json > ${phpcs} || true
+
+check for differences
+./vendor/bin/diffFilter --phpcs diff.txt phpcs.json

GitHooks/pre-receive

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+# This is a PSR-2 checking example for just the code about to be committed
+
+# Get the changes
+files=$(mktemp)
+diff=$(mktemp)
+
+git diff --name-only --diff-filter=ACMR -- "*.php" $1...$2 > ${files}
+git diff $1...$2 > ${diff}
+
+# Run the phpcs report
+phpcs=$(mktemp)
+./vendor/bin/phpcs --file-list=${files} --parallel=2 --standard=psr2 --report=json > ${phpcs} || true
+
+check for differences
+./vendor/bin/diffFilter --phpcs diff.txt phpcs.json

README.md

@@ -9,6 +9,8 @@ Coverage checker allows new standards to be implemented incrementally, by only e
 
 Tools like phpcs and phpmd are an all or nothing approach, coverage checker allows this to work with the diff i.e. enforce all of the pull request / change request.
 
+This is sometimes called "Baselining"
+
 Also working with PHPunit to allow, for example 90% of new/edited code to be covered. which will increase the overall coverage over time.
 
 # Installing
@@ -54,6 +56,12 @@ diffFilter will exit with a `0` status if the changed code passes the minimum co
 ## Extended guide
 A more in depth guide can be [found on the wiki](https://github.com/exussum12/coverageChecker/wiki) also some tips for speeding up the build.
 
+## Installing as a git hook
+
+There are 2 examples hooks in the GitHooks directory, if you symlink to these diffFilter will run locally.
+
+pre-commit is before the commit happens
+pre-receive will prevent you pushing
 
 # Full list of available diff filters
 

bin/phpcsDiffFilter

@@ -2,7 +2,7 @@
     "name": "exussum12/coverage-checker",
     "description": "Allows checking the code coverage of a single pull request",
     "require-dev": {
-        "phpunit/phpunit": "^5.7"
+        "phpunit/phpunit": "^6.5"
     },
     "license": "MIT",
     "authors": [
@@ -17,9 +17,11 @@
             "exussum12\\CoverageChecker\\tests\\": "tests/"
         }
     },
-    "bin": ["bin/phpunitDiffFilter","bin/phpcsDiffFilter", "bin/phpmdDiffFilter", "bin/diffFilter"],
+    "bin": ["bin/diffFilter"],
     "require": {
-        "php": ">=5.5",
+        "php": ">=7.0",
+        "ext-xmlreader": "*",
+        "ext-json": "*",
         "nikic/php-parser": "^3.1||^4.0"
     }
 }

bin/phpmdDiffFilter

@@ -6,12 +6,11 @@ set -e
 
 # Get the diff (changes since the branch was created
 git diff origin/master... > diff.txt
-git diff origin/master... --name-only -- '*.php' > files.txt
+git diff origin/master... --name-only --diff-filter=ACMR -- '*.php' > files.txt
 
 
 # Old versions of phpcs will need to use the syntax commented out.
 # Note the || true is important, Without this phpcs failing will fail the build!
-# ./vendor/bin/phpcs --standard=psr2 src > phpcs.json || true
 
 ./vendor/bin/phpcs --file-list=files.txt --parallel=2 --standard=psr2 --report=json > phpcs.json || true
 

bin/phpunitDiffFilter

@@ -1,6 +1,8 @@
 <?php
 namespace exussum12\CoverageChecker;
 
+use exussum12\CoverageChecker\Exceptions\ArgumentNotFound;
+
 class ArgParser
 {
     protected $args;
@@ -10,27 +12,31 @@ public function __construct(array $args)
         $this->args = $args;
     }
 
-    public function getArg($name)
+    /**
+     * @throws ArgumentNotFound
+     */
+    public function getArg(string $name): string
     {
         if (is_numeric($name)) {
+            $name = (int) $name;
             return $this->numericArg($name);
         }
 
         return $this->letterArg($name);
     }
 
-    protected function numericArg($position)
+    protected function numericArg(int $position): string
     {
         foreach ($this->args as $arg) {
             if ($arg{0} != '-' && $position-- == 0) {
                 return $arg;
             }
         }
 
-        return null;
+        throw new ArgumentNotFound();
     }
 
-    protected function letterArg($name)
+    protected function letterArg($name): string
     {
         $name = $this->getAdjustedArg($name);
         foreach ($this->args as $arg) {
@@ -41,24 +47,20 @@ protected function letterArg($name)
             }
         }
 
-        return false;
+        throw new ArgumentNotFound();
     }
 
-    protected function splitArg($arg)
+    protected function splitArg(string $arg): array
     {
-        $value = true;
-        if (strpos($arg, '=')) {
+        $value = '1';
+        if (strpos($arg, '=') > 0) {
             list($arg, $value) = explode('=', $arg, 2);
         }
 
         return array($value, $arg);
     }
 
-    /**
-     * @param string $name
-     * @return string
-     */
-    protected function getAdjustedArg($name)
+    protected function getAdjustedArg(string $name): string
     {
         $name = strlen($name) == 1 ?
             '-' . $name :